OpenFOAM: API Guide
v1912
The open source CFD toolbox
IOMRFZoneList.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) 2012 OpenFOAM Foundation
9
Copyright (C) 2019 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::IOMRFZoneList
29
30
Description
31
List of MRF zones with IO functionality. MRF zones are specified by a list
32
of dictionary entries, e.g.
33
34
\verbatim
35
zone1
36
{
37
cellZone rotor1;
38
active yes;
39
...
40
}
41
42
zone2
43
{
44
cellZone rotor2;
45
active yes;
46
...
47
}
48
\endverbatim
49
50
SourceFiles
51
IOMRFZoneList.C
52
53
\*---------------------------------------------------------------------------*/
54
55
#ifndef IOMRFZoneList_H
56
#define IOMRFZoneList_H
57
58
#include "
IOdictionary.H
"
59
#include "
MRFZoneList.H
"
60
61
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
62
63
namespace
Foam
64
{
65
66
/*---------------------------------------------------------------------------*\
67
Class IOMRFZoneList Declaration
68
\*---------------------------------------------------------------------------*/
69
70
class
IOMRFZoneList
71
:
72
public
IOdictionary
,
73
public
MRFZoneList
74
{
75
private
:
76
77
// Private Member Functions
78
79
//- Create IO object if dictionary is present
80
IOobject
createIOobject(
const
fvMesh
&
mesh
)
const
;
81
82
//- No copy construct
83
IOMRFZoneList
(
const
IOMRFZoneList
&) =
delete
;
84
85
//- No copy assignment
86
void
operator=(
const
IOMRFZoneList
&) =
delete
;
87
88
89
public
:
90
91
// Constructors
92
93
//- Construct from mesh
94
IOMRFZoneList
(
const
fvMesh
&
mesh
);
95
96
97
//- Destructor
98
virtual
~IOMRFZoneList
() =
default
;
99
100
101
// Member Functions
102
103
//- Read dictionary
104
virtual
bool
read
();
105
};
106
107
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108
109
}
// End namespace Foam
110
111
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112
113
#endif
114
115
// ************************************************************************* //
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition:
IOdictionary.H:54
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition:
IOobject.H:104
Foam::IOMRFZoneList::~IOMRFZoneList
virtual ~IOMRFZoneList()=default
Destructor.
Foam::MRFZoneList
List container for MRF zomes.
Definition:
MRFZoneList.H:57
mesh
dynamicFvMesh & mesh
Definition:
createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition:
fvMesh.H:84
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
IOdictionary.H
Foam::IOMRFZoneList::read
virtual bool read()
Read dictionary.
Definition:
IOMRFZoneList.C:78
MRFZoneList.H
Foam::IOMRFZoneList
List of MRF zones with IO functionality. MRF zones are specified by a list of dictionary entries,...
Definition:
IOMRFZoneList.H:69
src
finiteVolume
cfdTools
general
MRF
IOMRFZoneList.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.