FreeFOAM The Cross-Platform CFD Toolkit
MRFZones.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 OpenCFD Ltd.
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::MRFZones
26 
27 Description
28  Container class for a set of MRFZones with the MRFZone member functions
29  implemented to loop over the functions for each MRFZone.
30 
31 SourceFiles
32  MRFZones.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef MRFZones_H
37 #define MRFZones_H
38 
39 #include "MRFZone.H"
40 #include <OpenFOAM/IOPtrList.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class MRFZones Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class MRFZones
52 :
53  public IOPtrList<MRFZone>
54 {
55 
56  // Private Member Functions
57 
58  //- Disallow default bitwise copy construct
59  MRFZones(const MRFZones&);
60 
61  //- Disallow default bitwise assignment
62  void operator=(const MRFZones&);
63 
64 
65 public:
66 
67  // Constructors
68 
69  //- Construct from fvMesh
70  MRFZones(const fvMesh& mesh);
71 
72 
73  // Member Functions
74 
75  //- Add the Coriolis force contribution to the momentum equation
76  void addCoriolis(fvVectorMatrix& UEqn) const;
77 
78  //- Add the Coriolis force contribution to the momentum equation
79  void addCoriolis(const volScalarField& rho, fvVectorMatrix& UEqn) const;
80 
81  //- Make the given absolute velocity relative within the MRF region
82  void relativeVelocity(volVectorField& U) const;
83 
84  //- Make the given relative velocity absolute within the MRF region
85  void absoluteVelocity(volVectorField& U) const;
86 
87  //- Make the given absolute flux relative within the MRF region
88  void relativeFlux(surfaceScalarField& phi) const;
89 
90  //- Make the given absolute mass-flux relative within the MRF region
91  void relativeFlux
92  (
93  const surfaceScalarField& rho,
95  ) const;
96 
97  //- Make the given relative flux absolute within the MRF region
98  void absoluteFlux(surfaceScalarField& phi) const;
99 
100  //- Make the given relative mass-flux absolute within the MRF region
101  void absoluteFlux
102  (
103  const surfaceScalarField& rho,
104  surfaceScalarField& phi
105  ) const;
106 
107  //- Correct the boundary velocity for the roation of the MRF region
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************ vim: set sw=4 sts=4 et: ************************ //