OpenFOAM: API Guide
v2112
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-2020 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 surfZoneIOList_H
39
#define 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
public
:
60
61
//- Runtime type information
62
TypeNameNoDebug
(
"surfZoneList"
);
63
64
65
// Constructors
66
67
//- Construct from IOobject
68
explicit
surfZoneIOList
(
const
IOobject
&
io
);
69
70
//- Construct from IOobject and surfZoneList content
71
surfZoneIOList
(
const
IOobject
&
io
,
const
UList<surfZone>
& content);
72
73
//- Construct from IOobject and transferring surfZoneList content
74
surfZoneIOList
(
const
IOobject
&
io
,
surfZoneList
&& content);
75
76
77
//- Destructor
78
virtual
~surfZoneIOList
() =
default
;
79
80
81
// Member Functions
82
83
//- The writeData function - required by regIOobject
84
bool
writeData
(
Ostream
&
os
)
const
;
85
86
87
// Member Operators
88
89
//- Copy assignment of entries
90
void
operator=
(
const
surfZoneIOList
& rhs);
91
92
//- Copy or move assignment of entries
93
using
surfZoneList::operator
=;
94
};
95
96
97
// Global Operators
98
99
//- Write surfZone list using its writeData() method
100
Ostream
&
operator<<
(
Ostream
&
os
,
const
surfZoneIOList
& zones);
101
102
103
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
104
105
}
// End namespace Foam
106
107
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108
109
#endif
110
111
// ************************************************************************* //
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition:
IOobject.H:170
Foam::List< surfZone >
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition:
Ostream.H:62
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:
UList.H:94
Foam::faMatrix::operator
friend Ostream & operator(Ostream &, const faMatrix< Type > &)
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition:
regIOobject.H:76
Foam::surfZoneIOList
IOobject for a surfZoneList.
Definition:
surfZoneIOList.H:57
Foam::surfZoneIOList::operator=
void operator=(const surfZoneIOList &rhs)
Copy assignment of entries.
Definition:
surfZoneIOList.C:141
Foam::surfZoneIOList::writeData
bool writeData(Ostream &os) const
The writeData function - required by regIOobject.
Definition:
surfZoneIOList.C:114
Foam::surfZoneIOList::~surfZoneIOList
virtual ~surfZoneIOList()=default
Destructor.
Foam::surfZoneIOList::TypeNameNoDebug
TypeNameNoDebug("surfZoneList")
Runtime type information.
os
OBJstream os(runTime.globalPath()/outputName)
io
IOobject io("surfaceFilmProperties", mesh.time().constant(), mesh, IOobject::READ_IF_PRESENT, IOobject::NO_WRITE, false)
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:34
Foam::operator<<
Ostream & operator<<(Ostream &, const boundaryPatch &p)
Write boundaryPatch as dictionary entries (without surrounding braces)
Definition:
boundaryPatch.C:83
regIOobject.H
surfZoneList.H
typeInfo.H
TypeNameNoDebug
#define TypeNameNoDebug(TypeNameString)
Declare a ClassNameNoDebug() with extra virtual type info.
Definition:
typeInfo.H:68
src
surfMesh
surfZone
surfZoneIOList.H
Generated by
1.9.5
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.