noFilm.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) 2011-2017 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::noFilm
26 
27 Description
28  Dummy surface film model for 'none'
29 
30 SourceFiles
31  noFilm.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef noFilm_H
36 #define noFilm_H
37 
38 #include "surfaceFilmModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace regionModels
45 {
46 namespace surfaceFilmModels
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class noFilm Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class noFilm
54 :
55  public surfaceFilmModel
56 {
57 private:
58 
59  // Private member functions
60 
61  //- Disallow default bitwise copy construct
62  noFilm(const noFilm&);
63 
64  //- Disallow default bitwise assignment
65  void operator=(const noFilm&);
66 
67 
68 protected:
69 
70  // Protected member functions
71 
72  //- Read control parameters from dictionary
73  virtual bool read();
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("none");
80 
81 
82  // Constructors
83 
84  //- Construct from components
85  noFilm
86  (
87  const word& modelType,
88  const fvMesh& mesh,
89  const dimensionedVector& g,
90  const word& regionType
91  );
92 
93 
94  //- Destructor
95  virtual ~noFilm();
96 
97 
98  // Member Functions
99 
100  // Access
101 
102  //- External hook to add sources to the film
103  virtual void addSources
104  (
105  const label patchi,
106  const label facei,
107  const scalar massSource,
108  const vector& momentumSource,
109  const scalar pressureSource,
110  const scalar energySource
111  );
112 
113 
114  // Fields
115 
116  //- Return the film thickness [m]
117  virtual const volScalarField& delta() const;
118 
119  //- Return the film coverage, 1 = covered, 0 = uncovered / []
120  virtual const volScalarField& alpha() const;
121 
122  //- Return the film velocity [m/s]
123  virtual const volVectorField& U() const;
124 
125  //- Return the film density [kg/m3]
126  virtual const volScalarField& rho() const;
127 
128  //- Return the film surface velocity [m/s]
129  virtual const volVectorField& Us() const;
130 
131  //- Return the film wall velocity [m/s]
132  virtual const volVectorField& Uw() const;
133 
134  //- Return the film mean temperature [K]
135  virtual const volScalarField& T() const;
136 
137  //- Return the film surface temperature [K]
138  virtual const volScalarField& Ts() const;
139 
140  //- Return the film wall temperature [K]
141  virtual const volScalarField& Tw() const;
142 
143  //- Return the film surface enthalpy [J/kg]
144  virtual const volScalarField& hs() const;
145 
146  //- Return the film specific heat capacity [J/kg/K]
147  virtual const volScalarField& Cp() const;
148 
149  //- Return the film thermal conductivity [W/m/K]
150  virtual const volScalarField& kappa() const;
151 
152  //- Return const access to the surface tension / [m/s2]
153  inline const volScalarField& sigma() const;
154 
155 
156  // Transfer fields - to the primary region
157 
158  //- Return mass transfer source - Eulerian phase only
159  virtual tmp<volScalarField> primaryMassTrans() const;
160 
161  //- Return the film mass available for transfer
162  virtual const volScalarField& cloudMassTrans() const;
163 
164  //- Return the parcel diameters originating from film
165  virtual const volScalarField& cloudDiameterTrans() const;
166 
167 
168  // Source fields
169 
170  // Mapped into primary region
171 
172  //- Return total mass source - Eulerian phase only
173  virtual tmp<volScalarField::Internal> Srho() const;
174 
175  //- Return mass source for specie i - Eulerian phase only
177  (
178  const label i
179  ) const;
180 
181  //- Return enthalpy source - Eulerian phase only
182  virtual tmp<volScalarField::Internal> Sh() const;
183 };
184 
185 
186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
187 
188 } // End namespace surfaceFilmModels
189 } // regionModels
190 } // End namespace Foam
191 
192 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
193 
194 #endif
195 
196 // ************************************************************************* //
virtual tmp< volScalarField > primaryMassTrans() const
Return mass transfer source - Eulerian phase only.
Definition: noFilm.C:212
virtual const volScalarField & rho() const
Return the film density [kg/m3].
Definition: noFilm.C:140
virtual const volScalarField & cloudDiameterTrans() const
Return the parcel diameters originating from film.
Definition: noFilm.C:244
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
virtual const volScalarField & Cp() const
Return the film specific heat capacity [J/kg/K].
Definition: noFilm.C:185
virtual const volVectorField & Us() const
Return the film surface velocity [m/s].
Definition: noFilm.C:122
virtual const volScalarField & hs() const
Return the film surface enthalpy [J/kg].
Definition: noFilm.C:176
virtual tmp< volScalarField::Internal > Srho() const
Return total mass source - Eulerian phase only.
Definition: noFilm.C:254
const dimensionedVector & g() const
Return the accleration due to gravity.
virtual const volScalarField & Ts() const
Return the film surface temperature [K].
Definition: noFilm.C:158
virtual const volScalarField & delta() const
Return the film thickness [m].
Definition: noFilm.C:95
TypeName("none")
Runtime type information.
dynamicFvMesh & mesh
virtual const volVectorField & U() const
Return the film velocity [m/s].
Definition: noFilm.C:113
A class for handling words, derived from string.
Definition: word.H:59
virtual const volScalarField & T() const
Return the film mean temperature [K].
Definition: noFilm.C:149
virtual const volScalarField & Tw() const
Return the film wall temperature [K].
Definition: noFilm.C:167
virtual const volScalarField & kappa() const
Return the film thermal conductivity [W/m/K].
Definition: noFilm.C:194
virtual const volScalarField & alpha() const
Return the film coverage, 1 = covered, 0 = uncovered / [].
Definition: noFilm.C:104
virtual const volVectorField & Uw() const
Return the film wall velocity [m/s].
Definition: noFilm.C:131
label patchi
const volScalarField & sigma() const
Return const access to the surface tension / [m/s2].
Definition: noFilm.C:203
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual bool read()
Read control parameters from dictionary.
Definition: noFilm.C:47
A class for managing temporary objects.
Definition: PtrList.H:53
virtual void addSources(const label patchi, const label facei, const scalar massSource, const vector &momentumSource, const scalar pressureSource, const scalar energySource)
External hook to add sources to the film.
Definition: noFilm.C:84
virtual const volScalarField & cloudMassTrans() const
Return the film mass available for transfer.
Definition: noFilm.C:234
virtual tmp< volScalarField::Internal > Sh() const
Return enthalpy source - Eulerian phase only.
Definition: noFilm.C:298
Namespace for OpenFOAM.