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  Copyright (C) 2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
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 #include "regionModel.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace regionModels
37 {
38  defineTypeNameAndDebug(regionModelFunctionObject, 0);
39  defineRunTimeSelectionTable(regionModelFunctionObject, dictionary);
40 }
41 }
42 
43 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44 
46 (
47  regionModel& region
48 )
49 :
50  dict_(),
51  regionModel_(region),
52  modelType_("modelType")
53 {}
54 
55 
57 (
58  const dictionary& dict,
59  regionModel& region,
60  const word& type
61 )
62 :
63  dict_(dict),
64  regionModel_(region),
65  modelType_(type)
66 {}
67 
68 
70 (
71  const regionModelFunctionObject& rmfo
72 )
73 :
74  dict_(rmfo.dict_),
75  regionModel_(rmfo.regionModel_),
76  modelType_(rmfo.modelType_)
77 {}
78 
79 
80 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
81 
83 {}
84 
85 
86 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
87 
89 {}
90 
91 
93 {
94  if (regionModel_.regionMesh().time().writeTime())
95  {
96  write();
97  }
98 }
99 
100 
102 {}
103 
104 
105 // ************************************************************************* //
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::regionModels::defineTypeNameAndDebug
defineTypeNameAndDebug(KirchhoffShell, 0)
Foam::regionModels::regionModelFunctionObject::~regionModelFunctionObject
virtual ~regionModelFunctionObject()
Destructor.
Definition: regionModelFunctionObject.C:82
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:101
Foam::regionModels::regionModelFunctionObject::regionModelFunctionObject
regionModelFunctionObject(regionModel &region)
Construct null from region.
Definition: regionModelFunctionObject.C:46
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:123
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:36
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:92
Foam::regionModels::regionModelFunctionObject::preEvolveRegion
virtual void preEvolveRegion()
Pre-evolve region hook.
Definition: regionModelFunctionObject.C:88