MRFZone.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::MRFZone
26 
27 Description
28  MRF zone definition based on cell zone and parameters
29  obtained from a control dictionary constructed from the given stream.
30 
31  The rotation of the MRF region is defined by an origin and axis of
32  rotation and an angular speed.
33 
34 SourceFiles
35  MRFZone.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef MRFZone_H
40 #define MRFZone_H
41 
42 #include "dictionary.H"
43 #include "wordList.H"
44 #include "labelList.H"
45 #include "dimensionedScalar.H"
46 #include "dimensionedVector.H"
47 #include "volFieldsFwd.H"
48 #include "surfaceFields.H"
49 #include "fvMatricesFwd.H"
50 #include "mapPolyMesh.H"
51 #include "Function1.H"
52 #include "autoPtr.H"
53 
54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
55 
56 namespace Foam
57 {
58 
59 // Forward declaration of classes
60 class fvMesh;
61 
62 /*---------------------------------------------------------------------------*\
63  Class MRFZone Declaration
64 \*---------------------------------------------------------------------------*/
65 
66 class MRFZone
67 {
68  // Private Data
69 
70  //- Reference to the mesh database
71  const fvMesh& mesh_;
72 
73  //- Name of the MRF region
74  const word name_;
75 
76  //- Coefficients dictionary
77  dictionary coeffs_;
78 
79  //- MRF region active flag
80  bool active_;
81 
82  //- Name of cell zone
83  word cellZoneName_;
84 
85  //- Cell zone ID
86  label cellZoneID_;
87 
88  const wordReList excludedPatchNames_;
89 
90  labelList excludedPatchLabels_;
91 
92  //- Internal faces that are part of MRF
93  labelList internalFaces_;
94 
95  //- Outside faces (per patch) that move with the MRF
96  labelListList includedFaces_;
97 
98  //- Excluded faces (per patch) that do not move with the MRF
99  labelListList excludedFaces_;
100 
101  //- Origin of the axis
102  const vector origin_;
103 
104  //- Axis vector
105  vector axis_;
106 
107  //- Angular velocty (rad/sec)
109 
110 
111  // Private Member Functions
112 
113  //- Divide faces in frame according to patch
114  void setMRFFaces();
115 
116  //- Make the given absolute mass/vol flux relative within the MRF region
117  template<class RhoFieldType>
118  void makeRelativeRhoFlux
119  (
120  const RhoFieldType& rho,
122  ) const;
123 
124  //- Make the given absolute mass/vol flux relative within the MRF region
125  template<class RhoFieldType>
126  void makeRelativeRhoFlux
127  (
128  const RhoFieldType& rho,
130  ) const;
131 
132  //- Make the given absolute mass/vol flux relative within the MRF region
133  template<class RhoFieldType>
134  void makeRelativeRhoFlux
135  (
136  const RhoFieldType& rho,
137  Field<scalar>& phi,
138  const label patchi
139  ) const;
140 
141  //- Make the given relative mass/vol flux absolute within the MRF region
142  template<class RhoFieldType>
143  void makeAbsoluteRhoFlux
144  (
145  const RhoFieldType& rho,
146  surfaceScalarField& phi
147  ) const;
148 
149 
150 public:
151 
152  // Declare name of the class and its debug switch
153  ClassName("MRFZone");
154 
155 
156  // Constructors
157 
158  //- Construct from fvMesh
159  MRFZone
160  (
161  const word& name,
162  const fvMesh& mesh,
163  const dictionary& dict,
164  const word& cellZoneName = word::null
165  );
166 
167  //- Disallow default bitwise copy construction
168  MRFZone(const MRFZone&) = delete;
169 
170  //- Return clone
171  autoPtr<MRFZone> clone() const
172  {
174  return autoPtr<MRFZone>(nullptr);
175  }
176 
177 
178  // Member Functions
179 
180  //- Return const access to the MRF region name
181  inline const word& name() const;
182 
183  //- Return const access to the MRF active flag
184  inline bool active() const;
185 
186  //- Return the current Omega vector
187  vector Omega() const;
188 
189  //- Update the mesh corresponding to given map
190  void updateMesh(const mapPolyMesh& mpm)
191  {
192  // Only updates face addressing
193  setMRFFaces();
194  }
195 
196  //- Add the Coriolis force contribution to the acceleration field
197  void addCoriolis
198  (
199  const volVectorField& U,
200  volVectorField& ddtU
201  ) const;
202 
203  //- Add the Coriolis force contribution to the momentum equation
204  // Adds to the lhs of the equation; optionally add to rhs
205  void addCoriolis
206  (
208  const bool rhs = false
209  ) const;
210 
211  //- Add the Coriolis force contribution to the momentum equation
212  // Adds to the lhs of the equation; optionally add to rhs
213  void addCoriolis
214  (
215  const volScalarField& rho,
216  fvVectorMatrix& UEqn,
217  const bool rhs = false
218  ) const;
219 
220  //- Make the given absolute velocity relative within the MRF region
221  void makeRelative(volVectorField& U) const;
222 
223  //- Make the given absolute flux relative within the MRF region
224  void makeRelative(surfaceScalarField& phi) const;
225 
226  //- Make the given absolute boundary flux relative
227  // within the MRF region
229 
230  //- Make the given absolute patch flux relative
231  // within the MRF region
232  void makeRelative(Field<scalar>& phi, const label patchi) const;
233 
234  //- Make the given absolute mass-flux relative within the MRF region
235  void makeRelative
236  (
237  const surfaceScalarField& rho,
238  surfaceScalarField& phi
239  ) const;
240 
241  //- Make the given relative velocity absolute within the MRF region
242  void makeAbsolute(volVectorField& U) const;
243 
244  //- Make the given relative flux absolute within the MRF region
245  void makeAbsolute(surfaceScalarField& phi) const;
246 
247  //- Make the given relative mass-flux absolute within the MRF region
248  void makeAbsolute
249  (
250  const surfaceScalarField& rho,
251  surfaceScalarField& phi
252  ) const;
253 
254  //- Correct the boundary velocity for the rotation of the MRF region
256 
257  //- Zero the MRF region of the given field
258  template<class Type>
260 
261  //- Update MRFZone faces if the mesh topology changes
262  void update();
263 
264 
265  // I-O
266 
267  //- Write
268  void writeData(Ostream& os) const;
269 
270  //- Read MRF dictionary
271  bool read(const dictionary& dict);
272 
273 
274  // Member Operators
275 
276  //- Disallow default bitwise assignment
277  void operator=(const MRFZone&) = delete;
278 };
279 
280 
281 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
282 
283 } // End namespace Foam
284 
285 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
286 
287 #ifdef NoRepository
288  #include "MRFZoneTemplates.C"
289 #endif
290 
291 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
292 
293 #include "MRFZoneI.H"
294 
295 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
296 
297 #endif
298 
299 // ************************************************************************* //
bool read(const dictionary &dict)
Read MRF dictionary.
Definition: MRFZone.C:591
Foam::surfaceFields.
bool active() const
Return const access to the MRF active flag.
Definition: MRFZoneI.H:32
void addCoriolis(const volVectorField &U, volVectorField &ddtU) const
Add the Coriolis force contribution to the acceleration field.
Definition: MRFZone.C:311
void makeRelative(volVectorField &U) const
Make the given absolute velocity relative within the MRF region.
Definition: MRFZone.C:406
dictionary dict
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
surfaceScalarField & phi
autoPtr< MRFZone > clone() const
Return clone.
Definition: MRFZone.H:170
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
MRFZone(const word &name, const fvMesh &mesh, const dictionary &dict, const word &cellZoneName=word::null)
Construct from fvMesh.
Definition: MRFZone.C:237
void updateMesh(const mapPolyMesh &mpm)
Update the mesh corresponding to given map.
Definition: MRFZone.H:189
MRF zone definition based on cell zone and parameters obtained from a control dictionary constructed ...
Definition: MRFZone.H:65
void makeAbsolute(volVectorField &U) const
Make the given relative velocity absolute within the MRF region.
Definition: MRFZone.C:480
void update()
Update MRFZone faces if the mesh topology changes.
Definition: MRFZone.C:603
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:158
Generic field type.
Definition: FieldField.H:51
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
const word & name() const
Return const access to the MRF region name.
Definition: MRFZoneI.H:26
void zero(GeometricField< Type, fvsPatchField, surfaceMesh > &phi) const
Zero the MRF region of the given field.
static const word null
An empty word.
Definition: word.H:77
A special matrix type and solver, designed for finite volume solutions of scalar equations. Face addressing is used to make all matrix assembly and solution loops vectorise.
Definition: fvPatchField.H:72
void operator=(const MRFZone &)=delete
Disallow default bitwise assignment.
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
void correctBoundaryVelocity(volVectorField &U) const
Correct the boundary velocity for the rotation of the MRF region.
Definition: MRFZone.C:541
vector Omega() const
Return the current Omega vector.
Definition: MRFZone.C:304
Forward declarations of fvMatrix specializations.
label patchi
U
Definition: pEqn.H:72
fvVectorMatrix & UEqn
Definition: UEqn.H:13
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
void writeData(Ostream &os) const
Write.
Definition: MRFZone.C:571
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:366
ClassName("MRFZone")
Namespace for OpenFOAM.