OpenFOAM
v2312
The open source CFD toolbox
surfZoneIOList.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) 2011-2016 OpenFOAM Foundation
9
Copyright (C) 2018-2023 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
Class
28
Foam::surfZoneIOList
29
30
Description
31
IOobject for a surfZoneList
32
33
SourceFiles
34
surfZoneIOList.C
35
36
\*---------------------------------------------------------------------------*/
37
38
#ifndef Foam_surfZoneIOList_H
39
#define Foam_surfZoneIOList_H
40
41
#include "
surfZoneList.H
"
42
#include "
regIOobject.H
"
43
#include "
typeInfo.H
"
44
45
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46
47
namespace
Foam
48
{
49
50
/*---------------------------------------------------------------------------*\
51
Class surfZoneIOList Declaration
52
\*---------------------------------------------------------------------------*/
53
54
class
surfZoneIOList
55
:
56
public
regIOobject
,
57
public
surfZoneList
58
{
59
// Private Member Functions
60
61
//- Return true if contents were read
62
//- (controlled by IOobject readOption flags).
63
bool
readContents();
64
65
66
public
:
67
68
//- Runtime type information
69
TypeNameNoDebug
(
"surfZoneList"
);
70
71
72
// Constructors
73
74
//- Construct from IOobject
75
explicit
surfZoneIOList
(
const
IOobject
&
io
);
76
77
//- Construct from IOobject and surfZoneList content
78
surfZoneIOList
(
const
IOobject
&
io
,
const
UList<surfZone>
& content);
79
80
//- Construct from IOobject and transferring surfZoneList content
81
surfZoneIOList
(
const
IOobject
&
io
,
surfZoneList
&& content);
82
83
84
//- Destructor
85
virtual
~surfZoneIOList
() =
default
;
86
87
88
// Member Functions
89
90
//- The writeData function - required by regIOobject
91
bool
writeData
(
Ostream
&
os
)
const
;
92
93
94
// Member Operators
95
96
//- Copy assignment of entries
97
void
operator=
(
const
surfZoneIOList
& rhs);
98
99
//- Copy or move assignment of entries
100
using
surfZoneList::operator=;
101
};
102
103
104
// Global Operators
105
106
//- Write surfZone list using its writeData() method
107
Ostream
&
operator<<
(
Ostream
&
os
,
const
surfZoneIOList
& zones);
108
109
110
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111
112
}
// End namespace Foam
113
114
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115
116
#endif
117
118
// ************************************************************************* //
Foam::surfZoneIOList::surfZoneIOList
surfZoneIOList(const IOobject &io)
Construct from IOobject.
Definition:
surfZoneIOList.C:85
Foam::List< surfZone >
Foam::surfZoneIOList::~surfZoneIOList
virtual ~surfZoneIOList()=default
Destructor.
Foam::surfZoneIOList::TypeNameNoDebug
TypeNameNoDebug("surfZoneList")
Runtime type information.
Foam::surfZoneIOList
IOobject for a surfZoneList.
Definition:
surfZoneIOList.H:49
Foam::UList
A 1D vector of objects of type <T>, where the size of the vector is known and can be used for subscri...
Definition:
HashTable.H:105
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition:
Ostream.H:56
surfZoneList.H
os
OBJstream os(runTime.globalPath()/outputName)
typeInfo.H
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition:
boundaryPatch.C:77
regIOobject.H
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition:
regIOobject.H:66
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, IOobject::NO_REGISTER)
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition:
IOobject.H:172
Foam::surfZoneIOList::writeData
bool writeData(Ostream &os) const
The writeData function - required by regIOobject.
Definition:
surfZoneIOList.C:120
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:26
Foam::surfZoneIOList::operator=
void operator=(const surfZoneIOList &rhs)
Copy assignment of entries.
Definition:
surfZoneIOList.C:147
src
surfMesh
surfZone
surfZoneIOList.H
Generated by
1.8.14