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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2012-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
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 
29 #include "regionModel.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35 namespace regionModels
36 {
37  defineTypeNameAndDebug(regionModelFunctionObject, 0);
38  defineRunTimeSelectionTable(regionModelFunctionObject, dictionary);
39 }
40 }
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
45 (
46  regionModel& region
47 )
48 :
49  dict_(dictionary::null),
50  regionModel_(region),
51  modelType_("modelType")
52 {}
53 
54 
56 (
57  const dictionary& dict,
58  regionModel& region,
59  const word& type
60 )
61 :
62  dict_(dict),
63  regionModel_(region),
64  modelType_(type)
65 {}
66 
67 
69 (
70  const regionModelFunctionObject& rmfo
71 )
72 :
73  dict_(rmfo.dict_),
74  regionModel_(rmfo.regionModel_),
75  modelType_(rmfo.modelType_)
76 {}
77 
78 
79 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
80 
82 {}
83 
84 
85 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
86 
88 {}
89 
90 
92 {
93  if (regionModel_.regionMesh().time().writeTime())
94  {
95  write();
96  }
97 }
98 
99 
101 {}
102 
103 
104 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
Foam::regionModels::defineTypeNameAndDebug
defineTypeNameAndDebug(KirchhoffShell, 0)
Foam::regionModels::regionModelFunctionObject::~regionModelFunctionObject
virtual ~regionModelFunctionObject()
Destructor.
Definition: regionModelFunctionObject.C:81
Foam::regionModels::regionModelFunctionObject::dict_
dictionary dict_
Dictionary.
Definition: regionModelFunctionObject.H:65
Foam::regionModels::regionModelFunctionObject::regionModel_
regionModel & regionModel_
Reference to the region model.
Definition: regionModelFunctionObject.H:68
regionModelFunctionObject.H
regionModel.H
Foam::regionModels::regionModel
Base class for region models.
Definition: regionModel.H:60
Foam::regionModels::regionModelFunctionObject::write
virtual void write() const
write
Definition: regionModelFunctionObject.C:100
Foam::regionModels::regionModelFunctionObject::regionModelFunctionObject
regionModelFunctionObject(regionModel &region)
Construct null from region.
Definition: regionModelFunctionObject.C:45
Foam::regionModels::regionModelFunctionObject
Region model function object base class.
Definition: regionModelFunctionObject.H:58
Foam::regionModels::defineRunTimeSelectionTable
defineRunTimeSelectionTable(thermalShellModel, dictionary)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::regionModels::regionModelFunctionObject::modelType_
word modelType_
Model type name.
Definition: regionModelFunctionObject.H:71
Foam::vtk::write
void write(vtk::formatter &fmt, const Type &val, const label n=1)
Component-wise write of a value (N times)
Definition: foamVtkOutputTemplates.C:35
Foam::roots::type
type
Types of root.
Definition: Roots.H:54
Foam::regionModels::regionModelFunctionObject::postEvolveRegion
virtual void postEvolveRegion()
Post-evolve region hook.
Definition: regionModelFunctionObject.C:91
Foam::regionModels::regionModelFunctionObject::preEvolveRegion
virtual void preEvolveRegion()
Pre-evolve region hook.
Definition: regionModelFunctionObject.C:87