OpenFOAM
v2406
The open source CFD toolbox
fvOptions.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-2024 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
29
#include "
fvOptions.H
"
30
#include "
fvMesh.H
"
31
#include "
Time.H
"
32
33
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34
35
namespace
Foam
36
{
37
namespace
fv
38
{
39
defineTypeNameAndDebug
(options, 0);
40
}
41
}
42
43
44
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
45
46
Foam::IOobject
Foam::fv::options::createIOobject
47
(
48
const
fvMesh&
mesh
49
)
const
50
{
51
IOobject
io
52
(
53
typeName,
54
mesh
.time().constant(),
55
mesh
,
56
IOobject::MUST_READ
,
57
IOobject::NO_WRITE
58
);
59
60
if
(
io
.typeHeaderOk<
IOdictionary
>(
true
))
61
{
62
Info
<<
"Creating finite volume options from "
63
<<
io
.instance()/
io
.name() <<
nl
64
<<
endl
;
65
66
io
.readOpt(
IOobject::MUST_READ_IF_MODIFIED
);
67
}
68
else
69
{
70
// Check if the fvOptions file is in system
71
io
.instance() =
mesh
.time().system();
72
73
if
(
io
.typeHeaderOk<
IOdictionary
>(
true
))
74
{
75
Info
<<
"Creating finite volume options from "
76
<<
io
.instance()/
io
.name() <<
nl
77
<<
endl
;
78
79
io
.readOpt(
IOobject::MUST_READ_IF_MODIFIED
);
80
}
81
else
82
{
83
io
.readOpt(
IOobject::NO_READ
);
84
}
85
}
86
87
return
io
;
88
}
89
90
91
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
92
93
Foam::fv::options::options
94
(
95
const
fvMesh
&
mesh
96
)
97
:
98
IOdictionary
(createIOobject(
mesh
)),
99
optionList
(
mesh
, *this)
100
{}
101
102
103
Foam::fv::options
&
Foam::fv::options::New
(
const
fvMesh
&
mesh
)
104
{
105
auto
* ptr =
mesh
.thisDb().getObjectPtr<
options
>(typeName);
106
107
if
(!ptr)
108
{
109
DebugInFunction
110
<<
"Constructing "
<< typeName
111
<<
" for region "
<<
mesh
.name() <<
nl
;
112
113
ptr =
new
options
(
mesh
);
114
regIOobject::store
(ptr);
115
}
116
117
return
*ptr;
118
}
119
120
121
bool
Foam::fv::options::read
()
122
{
123
if
(
IOdictionary::regIOobject::read
())
124
{
125
optionList::read
(*
this
);
126
return
true
;
127
}
128
129
return
false
;
130
}
131
132
133
// ************************************************************************* //
Foam::IOdictionary::IOdictionary
IOdictionary(const IOobject &io, const dictionary *fallback=nullptr)
Construct given an IOobject and optional fallback dictionary content.
Definition:
IOdictionary.C:30
Foam::fv::defineTypeNameAndDebug
defineTypeNameAndDebug(atmAmbientTurbSource, 0)
Time.H
Foam::nl
constexpr char nl
The newline '\n' character (0x0a)
Definition:
Ostream.H:50
fvMesh.H
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition:
Ostream.H:531
Foam::regIOobject::store
bool store()
Register object with its registry and transfer ownership to the registry.
Definition:
regIOobjectI.H:36
Foam::IOobjectOption::NO_WRITE
Ignore writing from objectRegistry::writeObject()
Definition:
IOobjectOption.H:86
Foam::fv::options
Finite-volume options.
Definition:
fvOptions.H:51
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition:
IOdictionary.H:50
Foam::fv::options::read
virtual bool read()
Read dictionary.
Definition:
fvOptions.C:114
mesh
dynamicFvMesh & mesh
Definition:
createDynamicFvMesh.H:6
fv
labelList fv(nPoints)
DebugInFunction
#define DebugInFunction
Report an information message using Foam::Info.
Definition:
messageStream.H:556
Foam::IOobjectOption::MUST_READ_IF_MODIFIED
Definition:
IOobjectOption.H:71
Foam::IOobjectOption::MUST_READ
Reading required.
Definition:
IOobjectOption.H:63
Foam::blockMeshTools::read
void read(Istream &, label &val, const dictionary &)
In-place read with dictionary lookup.
Definition:
blockMeshTools.C:44
fvOptions.H
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition:
fvMesh.H:78
Foam::IOobject::IOobject
IOobject(const IOobject &)=default
Copy construct.
Foam::IOobjectOption::NO_READ
Nothing to be read.
Definition:
IOobjectOption.H:60
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::fv::optionList
List of finite volume options.
Definition:
fvOptionList.H:63
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
Foam::fv::options::New
static options & New(const fvMesh &mesh)
Construct fvOptions and register to database if not present.
Definition:
fvOptions.C:96
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition:
IOobject.H:180
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:26
Foam::fv::optionList::read
virtual bool read(const dictionary &dict)
Read dictionary.
Definition:
fvOptionList.C:143
src
finiteVolume
cfdTools
general
fvOptions
fvOptions.C
Generated by
1.8.14