OpenFOAM: API Guide
v2112
The open source CFD toolbox
IOporosityModelList.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-2014 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
29
#include "
IOporosityModelList.H
"
30
#include "
fvMesh.H
"
31
#include "
Time.H
"
32
33
// * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * //
34
35
Foam::IOobject
Foam::IOporosityModelList::createIOobject
36
(
37
const
fvMesh&
mesh
38
)
const
39
{
40
IOobject
io
41
(
42
"porosityProperties"
,
43
mesh
.
time
().
constant
(),
44
mesh
,
45
IOobject::MUST_READ
,
46
IOobject::NO_WRITE
47
);
48
49
if
(
io
.
typeHeaderOk
<IOdictionary>(
true
))
50
{
51
Info
<<
"Creating porosity model list from "
<<
io
.
name
() <<
nl
<<
endl
;
52
53
io
.
readOpt
(
IOobject::MUST_READ_IF_MODIFIED
);
54
}
55
else
56
{
57
Info
<<
"No porosity models present"
<<
nl
<<
endl
;
58
59
io
.
readOpt
(
IOobject::NO_READ
);
60
}
61
62
return
io
;
63
}
64
65
66
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
67
68
Foam::IOporosityModelList::IOporosityModelList
69
(
70
const
fvMesh
&
mesh
71
)
72
:
73
IOdictionary
(createIOobject(
mesh
)),
74
porosityModelList
(
mesh
, *this)
75
{}
76
77
78
bool
Foam::IOporosityModelList::read
()
79
{
80
if
(
regIOobject::read
())
81
{
82
porosityModelList::read
(*
this
);
83
return
true
;
84
}
85
86
return
false
;
87
}
88
89
90
// ************************************************************************* //
IOporosityModelList.H
Time.H
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition:
IOdictionary.H:57
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition:
IOobject.H:170
Foam::IOobject::name
const word & name() const noexcept
Return the object name.
Definition:
IOobjectI.H:65
Foam::IOobject::readOpt
readOption readOpt() const noexcept
The read option.
Definition:
IOobjectI.H:164
Foam::IOobject::typeHeaderOk
bool typeHeaderOk(const bool checkType=true, const bool search=true, const bool verbose=true)
Read header (uses typeFilePath to find file) and check its info.
Definition:
IOobjectTemplates.C:39
Foam::IOobject::IOobject
IOobject(const IOobject &)=default
Copy construct.
Foam::IOobject::NO_WRITE
@ NO_WRITE
Definition:
IOobject.H:187
Foam::IOobject::NO_READ
@ NO_READ
Definition:
IOobject.H:178
Foam::IOobject::MUST_READ_IF_MODIFIED
@ MUST_READ_IF_MODIFIED
Definition:
IOobject.H:180
Foam::IOobject::MUST_READ
@ MUST_READ
Definition:
IOobject.H:179
Foam::IOporosityModelList
List of porosity models with IO functionality.
Definition:
IOporosityModelList.H:55
Foam::IOporosityModelList::read
virtual bool read()
Read dictionary.
Definition:
IOporosityModelList.C:78
Foam::RASModels::kEpsilonLopesdaCosta::read
virtual bool read()
Re-read model coefficients if they have changed.
Definition:
kEpsilonLopesdaCosta.C:380
Foam::TimePaths::constant
const word & constant() const
Return constant name.
Definition:
TimePathsI.H:96
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition:
fvMesh.H:91
Foam::fvMesh::time
const Time & time() const
Return the top-level database.
Definition:
fvMesh.H:290
Foam::porosityModelList
List container for porosity models.
Definition:
porosityModelList.H:60
Foam::regIOobject::read
virtual bool read()
Read object.
Definition:
regIOobjectRead.C:193
mesh
dynamicFvMesh & mesh
Definition:
createDynamicFvMesh.H:6
fvMesh.H
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition:
Ostream.H:372
Foam::nl
constexpr char nl
The newline '\n' character (0x0a)
Definition:
Ostream.H:53
src
finiteVolume
cfdTools
general
porosityModel
porosityModel
IOporosityModelList.C
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.