1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/* This file is part of the OpenLB library
*
* Copyright (C) 2018 Sam Avis, Robin Trunk
* E-mail contact: info@openlb.net
* The most recent release of OpenLB can be downloaded at
* <http://www.openlb.net/>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public
* License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef FREE_ENERGY_POST_PROCESSOR_3D_H
#define FREE_ENERGY_POST_PROCESSOR_3D_H
#include "core/spatiallyExtendedObject3D.h"
#include "core/postProcessing.h"
#include "core/blockLattice3D.h"
/* \file
* PostProcessor classes organising the coupling between the lattices for the free energy
* model. The PostProcessor for the calculation of the chemical potential needs to be
* applied first, as the force relies on its results.
*/
namespace olb {
/// This class calculates the chemical potential and stores it in the external field of
/// the respective lattice.
template<typename T, typename DESCRIPTOR>
class FreeEnergyChemicalPotentialCoupling3D : public LocalPostProcessor3D<T,DESCRIPTOR> {
public:
/// \param[in] alpha_ - Parameter related to the interface width. [lattice units]
/// \param[in] kappa1_ - Parameter related to the surface tension (needs to be >0). [lattice units]
/// \param[in] kappa2_ - Parameter related to the surface tension (needs to be >0). [lattice units]
/// \param[in] kappa3_ - Parameter related to the surface tension (needs to be >0). [lattice units]
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
FreeEnergyChemicalPotentialCoupling3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
T alpha_, T kappa1_, T kappa2_, T kappa3_,
std::vector<SpatiallyExtendedObject3D*> partners_);
/// \param[in] alpha_ - Parameter related to the interface width. [lattice units]
/// \param[in] kappa1_ - Parameter related to the surface tension (needs to be >0). [lattice units]
/// \param[in] kappa2_ - Parameter related to the surface tension (needs to be >0). [lattice units]
/// \param[in] kappa3_ - Parameter related to the surface tension (needs to be >0). [lattice units]
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
FreeEnergyChemicalPotentialCoupling3D(T alpha_, T kappa1_, T kappa2_, T kappa3_,
std::vector<SpatiallyExtendedObject3D*> partners_);
int extent() const override
{
return 1;
}
int extent(int whichDirection) const override
{
return 1;
}
void process(BlockLattice3D<T,DESCRIPTOR>& blockLattice) override;
void processSubDomain(BlockLattice3D<T,DESCRIPTOR>& blockLattice,
int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) override;
private:
int x0, x1, y0, y1, z0, z1;
T alpha, kappa1, kappa2, kappa3;
std::vector<SpatiallyExtendedObject3D*> partners;
};
/// PostProcessor calculating the interfacial force in the free energy model. On the fist
/// lattice the force is stored for the Guo forcing scheme. On the other lattices a velocity,
/// calculated from that force, is stored which is used in the equilibrium distribution function.
template<typename T, typename DESCRIPTOR>
class FreeEnergyForceCoupling3D : public LocalPostProcessor3D<T,DESCRIPTOR> {
public:
FreeEnergyForceCoupling3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
std::vector<SpatiallyExtendedObject3D*> partners_);
FreeEnergyForceCoupling3D(std::vector<SpatiallyExtendedObject3D*> partners_);
int extent() const override
{
return 1;
}
int extent(int whichDirection) const override
{
return 1;
}
void process(BlockLattice3D<T,DESCRIPTOR>& blockLattice) override;
void processSubDomain(BlockLattice3D<T,DESCRIPTOR>& blockLattice,
int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) override;
private:
int x0, x1, y0, y1, z0, z1;
std::vector<SpatiallyExtendedObject3D*> partners;
};
/// PostProcessor for assigning the velocity at inlet and outlets to lattice two and three.
/// This should be assigned to the second lattice after FreeEnergyForcePostProcessor.
/// The first lattice should be the first partner lattice.
template<typename T, typename DESCRIPTOR>
class FreeEnergyInletOutletCoupling3D : public LocalPostProcessor3D<T,DESCRIPTOR> {
public:
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
FreeEnergyInletOutletCoupling3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
std::vector<SpatiallyExtendedObject3D*> partners_);
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
FreeEnergyInletOutletCoupling3D(std::vector<SpatiallyExtendedObject3D*> partners_);
int extent() const override
{
return 0;
}
int extent(int whichDirection) const override
{
return 0;
}
void process(BlockLattice3D<T,DESCRIPTOR>& blockLattice) override;
void processSubDomain(BlockLattice3D<T,DESCRIPTOR>& blockLattice,
int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) override;
private:
int x0, x1, y0, y1, z0, z1;
std::vector<SpatiallyExtendedObject3D*> partners;
};
/// PostProcessor for setting a constant density outlet.
/// This should be used before the bulk chemical potential post-
/// processor because it depends upon the result of this.
template<typename T, typename DESCRIPTOR>
class FreeEnergyDensityOutletCoupling3D : public LocalPostProcessor3D<T,DESCRIPTOR> {
public:
/// \param[in] rho_ - Gives the value of the constraint.
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
FreeEnergyDensityOutletCoupling3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
T rho_, std::vector<SpatiallyExtendedObject3D*> partners_);
/// \param[in] rho_ - Gives the value of the constraint.
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
FreeEnergyDensityOutletCoupling3D(T rho_, std::vector<SpatiallyExtendedObject3D*> partners_);
int extent() const override
{
return 0;
}
int extent(int whichDirection) const override
{
return 0;
}
void process(BlockLattice3D<T,DESCRIPTOR>& blockLattice) override;
void processSubDomain(BlockLattice3D<T,DESCRIPTOR>& blockLattice,
int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) override;
private:
int x0, x1, y0, y1, z0, z1;
T rho;
std::vector<SpatiallyExtendedObject3D*> partners;
};
/// Generator class for the PostProcessors calculating the chemical potential.
template<typename T, typename DESCRIPTOR>
class FreeEnergyChemicalPotentialGenerator3D : public LatticeCouplingGenerator3D<T,DESCRIPTOR> {
public:
/// Two component free energy model
/// \param[in] alpha_ - Parameter related to the interface width. [lattice units]
/// \param[in] kappa1_ - Parameter related to the surface tension (need to be >0). [lattice units]
/// \param[in] kappa2_ - Parameter related to the surface tension (need to be >0). [lattice units]
FreeEnergyChemicalPotentialGenerator3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
T alpha_, T kappa1_, T kappa2_);
/// Two component free energy model
/// \param[in] alpha_ - Parameter related to the interface width. [lattice units]
/// \param[in] kappa1_ - Parameter related to the surface tension (need to be >0). [lattice units]
/// \param[in] kappa2_ - Parameter related to the surface tension (need to be >0). [lattice units]
FreeEnergyChemicalPotentialGenerator3D(T alpha_, T kappa1_, T kappa2_);
/// Three component free energy model
/// \param[in] alpha_ - Parameter related to the interface width. [lattice units]
/// \param[in] kappa1_ - Parameter related to the surface tension (need to be >0). [lattice units]
/// \param[in] kappa2_ - Parameter related to the surface tension (need to be >0). [lattice units]
/// \param[in] kappa3_ - Parameter related to the surface tension (need to be >0). [lattice units]
FreeEnergyChemicalPotentialGenerator3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
T alpha_, T kappa1_, T kappa2_, T kappa3_);
/// Three component free energy model
/// \param[in] alpha_ - Parameter related to the interface width. [lattice units]
/// \param[in] kappa1_ - Parameter related to the surface tension (need to be >0). [lattice units]
/// \param[in] kappa2_ - Parameter related to the surface tension (need to be >0). [lattice units]
/// \param[in] kappa3_ - Parameter related to the surface tension (need to be >0). [lattice units]
FreeEnergyChemicalPotentialGenerator3D(T alpha_, T kappa1_, T kappa2_, T kappa3_);
PostProcessor3D<T,DESCRIPTOR>* generate(std::vector<SpatiallyExtendedObject3D*> partners) const override;
LatticeCouplingGenerator3D<T,DESCRIPTOR>* clone() const override;
private:
T alpha, kappa1, kappa2, kappa3;
};
/// Generator class for the PostProcessors calculating the interfacial force.
template<typename T, typename DESCRIPTOR>
class FreeEnergyForceGenerator3D : public LatticeCouplingGenerator3D<T,DESCRIPTOR> {
public:
FreeEnergyForceGenerator3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_);
FreeEnergyForceGenerator3D( );
PostProcessor3D<T,DESCRIPTOR>* generate(std::vector<SpatiallyExtendedObject3D*> partners) const override;
LatticeCouplingGenerator3D<T,DESCRIPTOR>* clone() const override;
};
/// Generator class for the PostProcessors assigning the velocity at the outlet to lattice two and three.
template<typename T, typename DESCRIPTOR>
class FreeEnergyInletOutletGenerator3D : public LatticeCouplingGenerator3D<T,DESCRIPTOR> {
public:
FreeEnergyInletOutletGenerator3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_);
FreeEnergyInletOutletGenerator3D( );
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
PostProcessor3D<T,DESCRIPTOR>* generate(std::vector<SpatiallyExtendedObject3D*> partners) const override;
LatticeCouplingGenerator3D<T,DESCRIPTOR>* clone() const override;
};
/// Generator class for the PostProcessors assigning the density boundary condition at the outlet.
template<typename T, typename DESCRIPTOR>
class FreeEnergyDensityOutletGenerator3D : public LatticeCouplingGenerator3D<T,DESCRIPTOR> {
public:
/// \param[in] rho_ - Gives the value of the constraint.
FreeEnergyDensityOutletGenerator3D(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_, T rho_);
/// \param[in] rho_ - Gives the value of the constraint.
FreeEnergyDensityOutletGenerator3D(T rho_);
/// \param[in] partners_ - Contains one partner lattice for two fluid components, or two lattices for three components.
PostProcessor3D<T,DESCRIPTOR>*
|
