kinematicSingleLayerI.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-2021 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 \*---------------------------------------------------------------------------*/
25 
26 #include "surfaceInterpolate.H"
27 #include "fvcSurfaceIntegrate.H"
28 
29 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace regionModels
34 {
35 namespace surfaceFilmModels
36 {
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
41 {
42  return deltaSmall_;
43 }
44 
45 
47 {
48  return phaseName_;
49 }
50 
51 
53 {
54  return thermo_->rho();
55 }
56 
57 
59 {
60  return mu_;
61 }
62 
63 
65 {
66  return delta_;
67 }
68 
69 
71 {
72  return alpha_;
73 }
74 
75 
77 {
78  return U_;
79 }
80 
81 
83 {
84  return momentumTransport_->Us();
85 }
86 
87 
89 {
90  return phi_;
91 }
92 
93 
95 {
96  return phiU_;
97 }
98 
99 
100 inline const volScalarField::Internal&
102 {
103  return continuityErr_;
104 }
105 
106 
108 {
109  return coverage_;
110 }
111 
112 
114 {
115  return USpPrimary_;
116 }
117 
118 
120 {
121  return pSpPrimary_;
122 }
123 
124 
126 {
127  return rhoSpPrimary_;
128 }
129 
130 
132 {
133  return USp_;
134 }
135 
136 
138 {
139  return pSp_;
140 }
141 
142 
144 {
145  return rhoSp_;
146 }
147 
148 
150 {
151  return USp_;
152 }
153 
154 
156 {
157  return pSp_;
158 }
159 
160 
162 {
163  return rhoSp_;
164 }
165 
166 
168 {
169  return UPrimary_;
170 }
171 
172 
174 {
175  return thermo_->p();
176 }
177 
178 
180 {
181  return rhoPrimary_;
182 }
183 
184 
186 {
187  return muPrimary_;
188 }
189 
190 
192 {
193  return thermo_();
194 }
195 
196 
198 {
199  return ejection_;
200 }
201 
202 
204 {
205  return transfer_;
206 }
207 
208 
209 inline const momentumTransportModel&
211 {
212  return momentumTransport_();
213 }
214 
215 
217 {
218  return rho()()*delta_()*magSf();
219 }
220 
221 
223 {
224  return rhoSp_*magSf()*time().deltaT();
225 }
226 
227 
228 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
229 
230 } // End namespace surfaceFilmModels
231 } // End namespace regionModels
232 } // End namespace Foam
233 
234 // ************************************************************************* //
const momentumTransportModel & momentumTransport() const
Momentum transport.
tmp< volScalarField::Internal > mass() const
Return the current film mass.
List container for film ejection models.
Surface integrate surfaceField creating a volField. Surface sum a surfaceField creating a volField...
const volVectorField & U() const
Return the film velocity [m/s].
volScalarField::Internal continuityErr_
Current continuity error caused by delta_ bounding.
volVectorField::Internal USp_
Momentum [kg/m/s^2].
volScalarField coverage_
Film coverage indicator, 1 = covered, 0 = uncovered [].
volVectorField USpPrimary_
Primary region tangential momentum source [kg m/s].
const Time & time() const
Return the reference to the time database.
Definition: regionModelI.H:37
const volScalarField & rhoPrimary() const
Density [kg/m^3].
tmp< volVectorField::Internal > Us() const
Return the film surface velocity [m/s].
volScalarField::Internal & rhoSp()
Mass [kg/m^2/s].
const word & phaseName() const
Return the name of the phase deposited to form the film.
const volScalarField & muPrimary() const
Viscosity [Pa.s].
const volVectorField & UPrimary() const
Velocity [m/s].
const volScalarField & mu() const
Return const access to the dynamic viscosity [Pa.s].
const surfaceScalarField & phiU() const
Return the film velocity flux [m^3/s].
A class for handling words, derived from string.
Definition: word.H:59
const dimensionedScalar & deltaSmall() const
Return small delta.
const volScalarField & coverage() const
Return the film coverage, 1 = covered, 0 = uncovered [].
const surfaceScalarField & phi() const
Return the film flux [kg m/s].
const volScalarField::Internal & continuityErr() const
Return the current continuity error.
volScalarField pSpPrimary_
Primary region normal momentum source (pressure) [kg m/s].
volVectorField::Internal & USp()
Momentum [kg/m/s^2].
autoPtr< momentumTransportModel > momentumTransport_
Momentum transport model.
const volScalarField & pPrimary() const
Pressure [Pa].
List container for film transfer models.
const volScalarField & delta() const
Return const access to the film thickness [m].
transferModelList transfer_
Transfer with the continuous phase.
const volScalarField::Internal & magSf() const
Return the face area magnitudes [m^2].
volScalarField alpha_
Film volume fraction in the cell layer [].
Field with dimensions and associated with geometry type GeoMesh which is used to size the field and a...
Base-class for fluid thermodynamic properties based on density.
Definition: rhoThermo.H:52
volScalarField rhoSpPrimary_
Primary region mass source [kg].
surfaceScalarField phiU_
Film velocity flux [m^3/s].
const volScalarField & rho() const
Return the film density [kg/m^3].
A class for managing temporary objects.
Definition: PtrList.H:53
dimensionedScalar deltaT() const
Return time step.
Definition: TimeStateI.H:46
const volScalarField & alpha() const
Return const access to the film volume fraction [].
Namespace for OpenFOAM.
tmp< volScalarField::Internal > deltaMass() const
Return the change in film mass due to sources/sinks.