surfaceFilmRegionModel.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2017 OpenFOAM Foundation
9 Copyright (C) 2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
30
31// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
32
33namespace Foam
34{
35namespace regionModels
36{
37namespace surfaceFilmModels
38{
39
40// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
41
43
44// * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
45
47{
49 {
50 return true;
51 }
52
53 return false;
54}
55
56
57// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
58
60(
61 const word& modelType,
62 const fvMesh& mesh,
63 const dimensionedVector& g,
64 const word& regionType
65)
66:
68 singleLayerRegion(mesh, regionType, modelType),
69 g_(g)
70{
71 if (active_)
72 {
73 read();
74 }
75}
76
77
78// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
79
81{}
82
83
84
85// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
86
88{
90}
91
92
93// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94
95} // End namespace surfaceFilmModels
96} // End namespace regionModels
97} // End namespace Foam
98
99// ************************************************************************* //
const uniformDimensionedVectorField & g
void evolve()
Evolve the cloud collection.
Definition: coalCloudList.C:84
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Switch active_
Active flag.
Definition: regionModel.H:93
Base class for single layer region models.
virtual bool read()
Read control parameters from dictionary.
Base class for surface film models.
virtual void evolve()
Main driver routing to evolve the region - calls other evolves.
virtual bool read()
Read control parameters from dictionary.
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
dynamicFvMesh & mesh
Namespace for OpenFOAM.