regionModelFunctionObject.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 | Copyright (C) 2012-2016 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 
27 #include "regionModel.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace regionModels
34 {
35  defineTypeNameAndDebug(regionModelFunctionObject, 0);
36  defineRunTimeSelectionTable(regionModelFunctionObject, dictionary);
37 }
38 }
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  regionModel& owner
45 )
46 :
47  dict_(dictionary::null),
48  owner_(owner),
49  modelType_("modelType")
50 {}
51 
52 
54 (
55  const dictionary& dict,
56  regionModel& owner,
57  const word& type
58 )
59 :
60  dict_(dict),
61  owner_(owner),
62  modelType_(type)
63 {}
64 
65 
67 (
68  const regionModelFunctionObject& rmfo
69 )
70 :
71  dict_(rmfo.dict_),
72  owner_(rmfo.owner_),
73  modelType_(rmfo.modelType_)
74 {}
75 
76 
77 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
78 
80 {}
81 
82 
83 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
84 
86 {
87  // do nothing
88 }
89 
90 
92 {
93  if (owner_.regionMesh().time().writeTime())
94  {
95  write();
96  }
97 }
98 
99 
101 {
102  // do nothing
103 }
104 
105 
106 // ************************************************************************* //
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
static const dictionary null
Null dictionary.
Definition: dictionary.H:193
defineTypeNameAndDebug(regionModel, 0)
defineRunTimeSelectionTable(regionModelFunctionObject, dictionary)
A class for handling words, derived from string.
Definition: word.H:59
regionModel & owner_
Reference to the region model.
regionModelFunctionObject(regionModel &owner)
Construct null from owner.
virtual void postEvolveRegion()
Post-evolve region hook.
virtual void preEvolveRegion()
Pre-evolve region hook.
runTime write()
Namespace for OpenFOAM.