filmSubModelBase.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-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "filmSubModelBase.H"
29
30// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
31
32namespace Foam
33{
34namespace regionModels
35{
36namespace surfaceFilmModels
37{
38
39// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
40
42:
43 subModelBase(film.outputProperties()),
44 filmModel_(film)
45{}
46
47
49(
51 const dictionary& dict,
52 const word& baseName,
53 const word& modelType,
54 const word& dictExt
55)
56:
58 (
59 film.outputProperties(),
60 dict,
61 baseName,
62 modelType,
63 dictExt
64 ),
65 filmModel_(film)
66{}
67
68
70(
71 const word& modelName,
73 const dictionary& dict,
74 const word& baseName,
75 const word& modelType
76)
77:
79 (
80 modelName,
81 film.outputProperties(),
82 dict,
83 baseName,
84 modelType
85 ),
86 filmModel_(film)
87{}
88
89
90// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
91
93{}
94
95
96// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
97
99{
100 return active() && filmModel_.time().writeTime();
101}
102
103
104// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106} // End namespace surfaceFilmModels
107} // End namespace regionModels
108} // End namespace Foam
109
110// ************************************************************************* //
bool writeTime() const noexcept
True if this is a write time.
Definition: TimeStateI.H:67
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
const Time & time() const
Return the reference to the time database.
Definition: regionModelI.H:40
surfaceFilmRegionModel & filmModel_
Reference to the film surface film model.
virtual bool writeTime() const
Flag to indicate when to write a property.
Base class for generic sub-models requiring to be read from dictionary. Provides a mechanism to read ...
Definition: subModelBase.H:55
virtual bool active() const
Return the model 'active' status - default active = true.
Definition: subModelBase.C:157
A class for handling words, derived from Foam::string.
Definition: word.H:68
Namespace for OpenFOAM.
dictionary dict