All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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-2020 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  ...
36  }
37 
38  zone2
39  {
40  cellZone rotor2;
41  ...
42  }
43  \endverbatim
44 
45 SourceFiles
46  IOMRFZoneList.C
47 
48 \*---------------------------------------------------------------------------*/
49 
50 #ifndef IOMRFZoneList_H
51 #define IOMRFZoneList_H
52 
53 #include "IOdictionary.H"
54 #include "MRFZoneList.H"
55 
56 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
57 
58 namespace Foam
59 {
60 
61 /*---------------------------------------------------------------------------*\
62  Class IOMRFZoneList Declaration
63 \*---------------------------------------------------------------------------*/
64 
65 class IOMRFZoneList
66 :
67  public IOdictionary,
68  public MRFZoneList
69 {
70  // Private Member Functions
71 
72  //- Create IO object if dictionary is present
73  IOobject createIOobject(const fvMesh& mesh) const;
74 
75 
76 public:
77 
78  // Constructors
79 
80  //- Construct from mesh
81  IOMRFZoneList(const fvMesh& mesh);
82 
83  //- Disallow default bitwise copy construction
84  IOMRFZoneList(const IOMRFZoneList&) = delete;
85 
86 
87  //- Destructor
88  virtual ~IOMRFZoneList()
89  {}
90 
91 
92  // Member Functions
93 
94  //- Read dictionary
95  virtual bool read();
96 
97 
98  // Member Operators
99 
100  //- Disallow default bitwise assignment
101  void operator=(const IOMRFZoneList&) = delete;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace Foam
108 
109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
110 
111 #endif
112 
113 // ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
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:64
Namespace for OpenFOAM.
virtual ~IOMRFZoneList()
Destructor.
Definition: IOMRFZoneList.H:87