OpenFOAM: API Guide
v2112
The open source CFD toolbox
faBoundaryMeshEntries.H
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) 2022 OpenCFD Ltd.
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
Class
27
Foam::faBoundaryMeshEntries
28
29
Description
30
Read and store dictionary entries for finite-area boundary patches.
31
32
SourceFiles
33
faBoundaryMeshEntries.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef Foam_faBoundaryMeshEntries_H
38
#define Foam_faBoundaryMeshEntries_H
39
40
#include "
regIOobject.H
"
41
#include "
PtrList.H
"
42
#include "
entry.H
"
43
44
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46
namespace
Foam
47
{
48
49
/*---------------------------------------------------------------------------*\
50
Class faBoundaryMeshEntries Declaration
51
\*---------------------------------------------------------------------------*/
52
53
class
faBoundaryMeshEntries
54
:
55
public
regIOobject
,
56
public
PtrList
<entry>
57
{
58
public
:
59
60
//- Runtime type information
61
TypeNameNoDebug
(
"faBoundaryMesh"
);
62
63
64
// Constructors
65
66
//- Read construct from IOobject
67
explicit
faBoundaryMeshEntries
(
const
IOobject
&
io
)
68
:
69
regIOobject
(
io
),
70
PtrList
<
entry
>()
71
{
72
if
73
(
74
(
75
io
.
readOpt
() ==
IOobject::MUST_READ
76
||
io
.
readOpt
() ==
IOobject::MUST_READ_IF_MODIFIED
77
)
78
|| (
io
.
readOpt
() ==
IOobject::READ_IF_PRESENT
&&
headerOk
())
79
)
80
{
81
readStream
(typeName) >> *
this
;
82
}
83
}
84
85
86
// Member Functions
87
88
bool
writeData
(
Ostream
&)
const
89
{
90
NotImplemented
;
91
return
false
;
92
}
93
};
94
95
96
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97
98
}
// End namespace Foam
99
100
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101
102
#endif
103
104
// ************************************************************************* //
PtrList.H
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition:
IOobject.H:170
Foam::IOobject::readOpt
readOption readOpt() const noexcept
The read option.
Definition:
IOobjectI.H:164
Foam::IOobject::MUST_READ_IF_MODIFIED
@ MUST_READ_IF_MODIFIED
Definition:
IOobject.H:180
Foam::IOobject::READ_IF_PRESENT
@ READ_IF_PRESENT
Definition:
IOobject.H:181
Foam::IOobject::MUST_READ
@ MUST_READ
Definition:
IOobject.H:179
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:62
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition:
PtrList.H:73
Foam::entry
A keyword and a list of tokens is an 'entry'.
Definition:
entry.H:70
Foam::faBoundaryMeshEntries
Read and store dictionary entries for finite-area boundary patches.
Definition:
faBoundaryMeshEntries.H:56
Foam::faBoundaryMeshEntries::writeData
bool writeData(Ostream &) const
Pure virtual writeData function.
Definition:
faBoundaryMeshEntries.H:87
Foam::faBoundaryMeshEntries::TypeNameNoDebug
TypeNameNoDebug("faBoundaryMesh")
Runtime type information.
Foam::faBoundaryMeshEntries::faBoundaryMeshEntries
faBoundaryMeshEntries(const IOobject &io)
Read construct from IOobject.
Definition:
faBoundaryMeshEntries.H:66
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition:
regIOobject.H:76
Foam::regIOobject::readStream
Istream & readStream(const word &, const bool valid=true)
Return Istream and check object type against that given.
Definition:
regIOobjectRead.C:131
Foam::regIOobject::headerOk
bool headerOk()
Read and check header info. Does not check the headerClassName.
Definition:
regIOobject.C:438
entry.H
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition:
error.H:517
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
regIOobject.H
TypeNameNoDebug
#define TypeNameNoDebug(TypeNameString)
Declare a ClassNameNoDebug() with extra virtual type info.
Definition:
typeInfo.H:68
src
finiteArea
faMesh
faBoundaryMesh
faBoundaryMeshEntries.H
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.