All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
surfaceFilmModel.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) 2017-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::regionModels::surfaceFilmModel
26 
27 Description
28  Base class for surface film models
29 
30 SourceFiles
31  surfaceFilmModelI.H
32  surfaceFilmModel.C
33  surfaceFilmModelNew.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef surfaceFilmModel_H
38 #define surfaceFilmModel_H
39 
40 #include "runTimeSelectionTables.H"
41 #include "volFields.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 namespace regionModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class surfaceFilmModel Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class surfaceFilmModel
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("surfaceFilmModel");
60 
61  //- Reference temperature for enthalpy
62  static const dimensionedScalar Tref;
63 
64 
65  // Declare runtime constructor selection table
66 
68  (
69  autoPtr,
71  mesh,
72  (
73  const word& modelType,
74  const fvMesh& mesh,
75  const dimensionedVector& g,
76  const word& regionType
77  ),
78  (modelType, mesh, g, regionType)
79  );
80 
81 
82  // Constructors
83 
85 
86  //- Disallow default bitwise copy construction
87  surfaceFilmModel(const surfaceFilmModel&) = delete;
88 
89 
90  // Selectors
91 
92  //- Return a reference to the selected surface film model
94  (
95  const fvMesh& mesh,
96  const dimensionedVector& g,
97  const word& regionType = "surfaceFilm"
98  );
99 
100 
101  //- Destructor
102  virtual ~surfaceFilmModel();
103 
104 
105  // Member Functions
106 
107  // Solution parameters
108 
109  //- Courant number evaluation
110  virtual scalar CourantNumber() const = 0;
111 
112 
113  // Primary region source fields
114 
115  //- Return total mass source - Eulerian phase only
116  virtual tmp<volScalarField::Internal> Srho() const = 0;
117 
118  //- Return mass source for specie i - Eulerian phase only
120  (
121  const label i
122  ) const = 0;
123 
124  //- Return enthalpy source - Eulerian phase only
125  virtual tmp<volScalarField::Internal> Sh() const = 0;
126 
127 
128  // Evolution
129 
130  //- Main driver routing to evolve the region - calls other evolves
131  virtual void evolve() = 0;
132 
133 
134  // Member Operators
135 
136  //- Disallow default bitwise assignment
137  void operator=(const surfaceFilmModel&) = delete;
138 };
139 
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 } // End namespace regionModels
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
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.
virtual tmp< volScalarField::Internal > Sh() const =0
Return enthalpy source - Eulerian phase only.
declareRunTimeSelectionTable(autoPtr, surfaceFilmModel, mesh,(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType),(modelType, mesh, g, regionType))
dynamicFvMesh & mesh
virtual void evolve()=0
Main driver routing to evolve the region - calls other evolves.
virtual tmp< volScalarField::Internal > Srho() const =0
Return total mass source - Eulerian phase only.
A class for handling words, derived from string.
Definition: word.H:59
static autoPtr< surfaceFilmModel > New(const fvMesh &mesh, const dimensionedVector &g, const word &regionType="surfaceFilm")
Return a reference to the selected surface film model.
static const dimensionedScalar Tref
Reference temperature for enthalpy.
TypeName("surfaceFilmModel")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
void operator=(const surfaceFilmModel &)=delete
Disallow default bitwise assignment.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:53
const dimensionedVector & g
virtual scalar CourantNumber() const =0
Courant number evaluation.
Namespace for OpenFOAM.
virtual ~surfaceFilmModel()
Destructor.