IOMRFZoneList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::IOMRFZoneList
26 
27 Description
28  List of MRF zones with IO functionality. MRF zones are specified by a list
29  of dictionary entries, e.g.
30 
31  \verbatim
32  zone1
33  {
34  cellZone rotor1;
35  active yes;
36  ...
37  }
38 
39  zone2
40  {
41  cellZone rotor2;
42  active yes;
43  ...
44  }
45  \endverbatim
46 
47 SourceFiles
48  IOMRFZoneList.C
49 
50 \*---------------------------------------------------------------------------*/
51 
52 #ifndef IOMRFZoneList_H
53 #define IOMRFZoneList_H
54 
55 #include "IOdictionary.H"
56 #include "MRFZoneList.H"
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 
63 /*---------------------------------------------------------------------------*\
64  Class IOMRFZoneList Declaration
65 \*---------------------------------------------------------------------------*/
66 
67 class IOMRFZoneList
68 :
69  public IOdictionary,
70  public MRFZoneList
71 {
72  // Private Member Functions
73 
74  //- Create IO object if dictionary is present
75  IOobject createIOobject(const fvMesh& mesh) const;
76 
77 
78 public:
79 
80  // Constructors
81 
82  //- Construct from mesh
83  IOMRFZoneList(const fvMesh& mesh);
84 
85  //- Disallow default bitwise copy construction
86  IOMRFZoneList(const IOMRFZoneList&) = delete;
87 
88 
89  //- Destructor
90  virtual ~IOMRFZoneList()
91  {}
92 
93 
94  // Member Functions
95 
96  //- Read dictionary
97  virtual bool read();
98 
99 
100  // Member Operators
101 
102  //- Disallow default bitwise assignment
103  void operator=(const IOMRFZoneList&) = delete;
104 };
105 
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
void operator=(const IOMRFZoneList &)=delete
Disallow default bitwise assignment.
dynamicFvMesh & mesh
virtual bool read()
Read dictionary.
Definition: IOMRFZoneList.C:75
List container for MRF zomes.
Definition: MRFZoneList.H:55
IOMRFZoneList(const fvMesh &mesh)
Construct from mesh.
Definition: IOMRFZoneList.C:66
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
List of MRF zones with IO functionality. MRF zones are specified by a list of dictionary entries...
Definition: IOMRFZoneList.H:66
Namespace for OpenFOAM.
virtual ~IOMRFZoneList()
Destructor.
Definition: IOMRFZoneList.H:89