All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
noFilm.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::regionModels::surfaceFilmModels::noFilm
26 
27 Description
28  Dummy surfaceFilmModel to allow solvers supporting film simulations to be
29  run without a film region.
30 
31 SourceFiles
32  noFilm.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef noFilm_H
37 #define noFilm_H
38 
39 #include "surfaceFilmModel.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace regionModels
46 {
47 namespace surfaceFilmModels
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class noFilm Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class noFilm
55 :
56  public surfaceFilmModel
57 {
58  // Private member data
59 
60  //- Reference to the mesh
61  const fvMesh& mesh_;
62 
63 
64 public:
65 
66  //- Runtime type information
67  TypeName("none");
68 
69 
70  // Constructors
71 
72  //- Construct from components
73  noFilm
74  (
75  const word& modelType,
76  const fvMesh& mesh,
77  const dimensionedVector& g,
78  const word& regionType
79  );
80 
81  //- Disallow default bitwise copy construction
82  noFilm(const noFilm&) = delete;
83 
84 
85  //- Destructor
86  virtual ~noFilm();
87 
88 
89  // Member Functions
90 
91  // Solution parameters
92 
93  //- Courant number evaluation
94  virtual scalar CourantNumber() const;
95 
96 
97  // Primary region source fields
98 
99  //- Return total mass source - Eulerian phase only
100  virtual tmp<volScalarField::Internal> Srho() const;
101 
102  //- Return mass source for specie i - Eulerian phase only
104  (
105  const label i
106  ) const;
107 
108  //- Return enthalpy source - Eulerian phase only
109  virtual tmp<volScalarField::Internal> Sh() const;
110 
111 
112  // Evolution
113 
114  //- Main driver routing to evolve the region - calls other evolves
115  virtual void evolve();
116 
117 
118  // Member Operators
119 
120  //- Disallow default bitwise assignment
121  void operator=(const noFilm&) = delete;
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace surfaceFilmModels
128 } // regionModels
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
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.
void operator=(const noFilm &)=delete
Disallow default bitwise assignment.
virtual tmp< volScalarField::Internal > Srho() const
Return total mass source - Eulerian phase only.
Definition: noFilm.C:73
noFilm(const word &modelType, const fvMesh &mesh, const dimensionedVector &g, const word &regionType)
Construct from components.
Definition: noFilm.C:47
virtual void evolve()
Main driver routing to evolve the region - calls other evolves.
Definition: noFilm.C:106
TypeName("none")
Runtime type information.
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
Dummy surfaceFilmModel to allow solvers supporting film simulations to be run without a film region...
Definition: noFilm.H:53
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
const dimensionedVector & g
virtual scalar CourantNumber() const
Courant number evaluation.
Definition: noFilm.C:67
virtual tmp< volScalarField::Internal > Sh() const
Return enthalpy source - Eulerian phase only.
Definition: noFilm.C:95
Namespace for OpenFOAM.