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
|
/* This file is part of the OpenLB library
*
* Copyright (C) 2006-2018 Jonas Latt, Adrian Kummerlaender
* 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.
*/
/** \file
* Dynamics for a generic 3D block structure -- header file.
*/
#ifndef BLOCK_LATTICE_STRUCTURE_3D_H
#define BLOCK_LATTICE_STRUCTURE_3D_H
#include <vector>
#include "cell.h"
#include "blockData3D.h"
#include "blockStructure3D.h"
#include "postProcessing.h"
#include "serializer.h"
#include "spatiallyExtendedObject3D.h"
#include "geometry/blockGeometryStructure3D.h"
#include "latticeStatistics.h"
#include "functors/analytical/analyticalF.h"
#include "functors/analytical/indicator/indicatorBaseF3D.h"
namespace olb {
template<typename T, typename S> class AnalyticalF3D;
template<typename T, typename DESCRIPTOR> struct Dynamics;
template<typename T, typename DESCRIPTOR> class Cell;
template<typename T, typename DESCRIPTOR> struct WriteCellFunctional;
template<typename T> class BlockIndicatorF3D;
template<typename T> class IndicatorSphere3D;
/** BlockLatticeStructure3D is a interface class for defining dynamics on a BlockStructure3D.
* The pure virtual methods are wrapped by generic methods.
*/
template<typename T, typename DESCRIPTOR>
class BlockLatticeStructure3D : public BlockStructure3D, public SpatiallyExtendedObject3D {
public:
BlockLatticeStructure3D(int nx, int ny, int nz) : BlockStructure3D(nx,ny,nz) {};
~BlockLatticeStructure3D() override { }
public:
/// Define rho on a domain described by an indicator
/**
* \param indicator Block indicator describing the target domain
* \param rho Analytical functor (global)
**/
virtual void defineRho(BlockIndicatorF3D<T>& indicator,
AnalyticalF3D<T,T>& rho);
/// Define rho on a domain with a particular material number
virtual void defineRho(BlockGeometryStructure3D<T>& blockGeometry, int material,
AnalyticalF3D<T,T>& rho);
/// Define u on a domain described by an indicator
/**
* \param indicator Block indicator describing the target domain
* \param u Analytical functor (global)
**/
virtual void defineU(BlockIndicatorF3D<T>& indicator,
AnalyticalF3D<T,T>& u);
/// Define u on a domain with a particular material number
virtual void defineU(BlockGeometryStructure3D<T>& blockGeometry, int material,
AnalyticalF3D<T,T>& u);
/// Define rho and u on a domain described by an indicator
/**
* \param indicator Block indicator describing the target domain
* \param rho Analytical functor (global)
* \param u Analytical functor (global)
**/
virtual void defineRhoU(BlockIndicatorF3D<T>& indicator,
AnalyticalF3D<T,T>& rho, AnalyticalF3D<T,T>& u);
/// Define rho and u on a domain with a particular material number
virtual void defineRhoU(BlockGeometryStructure3D<T>& blockGeometry, int material,
AnalyticalF3D<T,T>& rho, AnalyticalF3D<T,T>& u);
/// Define a population on a domain described by an indicator
/**
* \param indicator Block indicator describing the target domain
* \param Pop Analytical functor (global), target dimension DESCRIPTOR::q
**/
virtual void definePopulations(BlockIndicatorF3D<T>& indicator,
AnalyticalF3D<T,T>& Pop);
/// Define a population on a domain with a particular material number
virtual void definePopulations(BlockGeometryStructure3D<T>& blockGeometry, int material,
AnalyticalF3D<T,T>& Pop);
/**
* \param indicator Block indicator describing the target domain
* \param Pop Block functor, target dimension DESCRIPTOR::q
**/
virtual void definePopulations(BlockIndicatorF3D<T>& indicator,
BlockF3D<T>& Pop);
/// Define a population on a domain with a particular material number
virtual void definePopulations(BlockGeometryStructure3D<T>& blockGeometry, int material,
BlockF3D<T>& Pop);
/// Define a field on a domain described by an indicator
/**
* \param indicator Block indicator describing the target domain
* \param field Analytical functor (global)
**/
template <typename FIELD>
void defineField(BlockIndicatorF3D<T>& indicator,
AnalyticalF3D<T,T>& field);
/// Define a field on a domain with a particular material number
template <typename FIELD>
void defineField(BlockGeometryStructure3D<T>& blockGeometry, int material,
AnalyticalF3D<T,T>& field);
/// Define a field on a domain described by an analytical indicator
/**
* \param indicatorF Domain indicator to be reduced to BlockIndicatorFfromIndicatorF3D
**/
template <typename FIELD>
void defineField(BlockGeometryStructure3D<T>& blockGeometry,
IndicatorF3D<T>& indicatorF,
AnalyticalF3D<T,T>& field);
/// Initialize by equilibrium on a domain described by an indicator
/**
* \param indicator Block indicator describing the target domain
* \param rho Analytical functor (global)
* \param u Analytical functor (global)
**/
virtual void iniEquilibrium(BlockIndicatorF3D<T>& indicator,
AnalyticalF3D<T,T>& rho, AnalyticalF3D<T,T>& u);
/// Initialize by equilibrium on a domain with a particular material number
virtual void iniEquilibrium(BlockGeometryStructure3D<T>& blockGeometry, int material,
AnalyticalF3D<T,T>& rho, AnalyticalF3D<T,T>& u);
#ifndef OLB_PRECOMPILED
virtual void setExternalParticleField(BlockGeometryStructure3D<T>& blockGeometry,
AnalyticalF3D<T,T>& velocity,
SmoothIndicatorF3D<T,T,true>& sIndicator);
#endif
// pure virtual member functions
virtual Cell<T,DESCRIPTOR>& get(int iX, int iY, int iZ) =0;
virtual Cell<T,DESCRIPTOR>& get(const int latticeR[]) =0;
virtual Cell<T,DESCRIPTOR> const& get(int iX, int iY, int iZ) const =0;
virtual void initialize() =0;
/// Define the dynamics on a lattice site
virtual void defineDynamics(int iX, int iY, int iZ, Dynamics<T,DESCRIPTOR>* dynamics) = 0;
/// Define the dynamics on a 3D sub-box
virtual void defineDynamics(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
Dynamics<T,DESCRIPTOR>* dynamics) = 0;
/// Define the dynamics on a domain described by an indicator
virtual void defineDynamics(BlockIndicatorF3D<T>& indicator,
Dynamics<T,DESCRIPTOR>* dynamics) = 0;
/// Define the dynamics on a domain with a particular material number
virtual void defineDynamics(BlockGeometryStructure3D<T>& blockGeometry, int material,
Dynamics<T,DESCRIPTOR>* dynamics) = 0;
virtual Dynamics<T,DESCRIPTOR>* getDynamics(int iX, int iY, int iZ) = 0;
virtual void collide(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
virtual void collide() =0;
virtual void stream(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
virtual void stream(bool periodic=false) =0;
virtual void collideAndStream(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
virtual void collideAndStream(bool periodic=false) =0;
virtual T computeAverageDensity(int x0_, int x1_, int y0_, int y1_, int z0_,
int z1_) const =0;
virtual T computeAverageDensity() const =0;
virtual void computeStress(int iX, int iY, int iZ, T pi[util::TensorVal<DESCRIPTOR >::n]) = 0;
virtual void stripeOffDensityOffset(int x0_, int x1_, int y0_, int y1_, int z0_,
int z1_, T offset) =0;
virtual void stripeOffDensityOffset(T offset) =0;
virtual void forAll(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_,
WriteCellFunctional<T,DESCRIPTOR> const& application) =0;
virtual void forAll(WriteCellFunctional<T,DESCRIPTOR> const& application) =0;
virtual void addPostProcessor(PostProcessorGenerator3D<T,DESCRIPTOR> const& ppGen) =0;
virtual void resetPostProcessors() =0;
virtual void postProcess(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
virtual void postProcess() =0;
virtual void addLatticeCoupling(LatticeCouplingGenerator3D<T,DESCRIPTOR> const& lcGen,
std::vector<SpatiallyExtendedObject3D*> partners ) =0;
virtual void executeCoupling(int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) =0;
virtual void executeCoupling() =0;
virtual LatticeStatistics<T>& getStatistics() =0;
virtual LatticeStatistics<T> const& getStatistics() const =0;
};
} // namespace olb
#endif
|
