All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
surfaceFilmRegionModel.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-2020 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::regionModels::surfaceFilmModels::surfaceFilmRegionModel
26 
27 Description
28  Base class for surface film models
29 
30 SourceFiles
31  surfaceFilmRegionModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfaceFilmRegionModel_H
36 #define surfaceFilmRegionModel_H
37 
38 #include "surfaceFilmModel.H"
39 #include "singleLayerRegion.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace regionModels
46 {
47 namespace surfaceFilmModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class surfaceFilmRegionModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
55 :
56  public surfaceFilmModel,
57  public singleLayerRegion
58 {
59 protected:
60 
61  // Protected data
62 
63  //- Acceleration due to gravity [m/s^2]
64  const dimensionedVector& g_;
65 
66 
67  // Protected member functions
68 
69  //- Read control parameters from dictionary
70  virtual bool read();
71 
72 
73 public:
74 
75  //- Runtime type information
76  TypeName("surfaceFilmRegionModel");
77 
78 
79  // Constructors
80 
81  //- Construct from type name, mesh and gravity vector
83  (
84  const word& modelType,
85  const fvMesh& mesh,
86  const dimensionedVector& g,
87  const word& regionType
88  );
89 
90  //- Disallow default bitwise copy construction
92 
93 
94  //- Destructor
95  virtual ~surfaceFilmRegionModel();
96 
97 
98  // Member Functions
99 
100  // Access
101 
102  //- Return the acceleration due to gravity
103  inline const dimensionedVector& g() const;
104 
105  //- External hook to add sources to the film
106  virtual void addSources
107  (
108  const label patchi,
109  const label facei,
110  const scalar massSource,
111  const vector& momentumSource,
112  const scalar pressureSource,
113  const scalar energySource
114  ) = 0;
115 
116 
117  // Fields
118 
119  //- Return the film thickness [m]
120  virtual const volScalarField& delta() const = 0;
121 
122  //- Return the film coverage, 1 = covered, 0 = uncovered / []
123  virtual const volScalarField& coverage() const = 0;
124 
125  //- Return the film velocity [m/s]
126  virtual const volVectorField& U() const = 0;
127 
128  //- Return the film surface velocity [m/s]
129  virtual const volVectorField::Internal& Us() const = 0;
130 
131  //- Return the film wall velocity [m/s]
132  virtual const volVectorField::Internal& Uw() const = 0;
133 
134  //- Return the film density [kg/m^3]
135  virtual const volScalarField& rho() const = 0;
136 
137  //- Return the film surface tension [N/m]
138  virtual const volScalarField& sigma() const = 0;
139 
140 
141  // Transfer fields - to the primary region
142 
143  //- Return mass transfer source - Eulerian phase only
144  virtual tmp<volScalarField> primaryMassTrans() const = 0;
145 
146  //- Return the film mass available for transfer
147  virtual const volScalarField& cloudMassTrans() const = 0;
148 
149  //- Return the parcel diameters originating from film
150  virtual const volScalarField& cloudDiameterTrans() const = 0;
151 
152 
153  // Evolution
154 
155  //- Main driver routing to evolve the region - calls other evolves
156  virtual void evolve();
157 
158 
159  // Member Operators
160 
161  //- Disallow default bitwise assignment
162  void operator=(const surfaceFilmRegionModel&) = delete;
163 };
164 
165 
166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
167 
168 } // End namespace surfaceFilmModels
169 } // End namespace regionModels
170 } // End namespace Foam
171 
172 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
173 
174 #include "surfaceFilmRegionModelI.H"
175 
176 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
177 
178 #endif
179 
180 // ************************************************************************* //
virtual bool read()
Read control parameters from dictionary.
surfaceFilmRegionModel(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
Construct from type name, mesh and gravity vector.
virtual void addSources(const label patchi, const label facei, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource)=0
External hook to add sources to the film.
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
Base class for surface film models.
Base class for single layer region models.
TypeName("surfaceFilmRegionModel")
Runtime type information.
virtual const volScalarField & rho() const =0
Return the film density [kg/m^3].
virtual tmp< volScalarField > primaryMassTrans() const =0
Return mass transfer source - Eulerian phase only.
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
virtual void evolve()
Main driver routing to evolve the region - calls other evolves.
virtual const volScalarField & delta() const =0
Return the film thickness [m].
virtual const volVectorField & U() const =0
Return the film velocity [m/s].
const dimensionedVector & g() const
Return the acceleration due to gravity.
virtual const volVectorField::Internal & Uw() const =0
Return the film wall velocity [m/s].
label patchi
virtual const volVectorField::Internal & Us() const =0
Return the film surface velocity [m/s].
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
virtual const volScalarField & coverage() const =0
Return the film coverage, 1 = covered, 0 = uncovered / [].
const dimensionedVector & g_
Acceleration due to gravity [m/s^2].
A class for managing temporary objects.
Definition: PtrList.H:53
virtual const volScalarField & sigma() const =0
Return the film surface tension [N/m].
void operator=(const surfaceFilmRegionModel &)=delete
Disallow default bitwise assignment.
Namespace for OpenFOAM.
virtual const volScalarField & cloudDiameterTrans() const =0
Return the parcel diameters originating from film.
virtual const volScalarField & cloudMassTrans() const =0
Return the film mass available for transfer.