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 | Copyright (C) 2011 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::surfZoneIOList
26 
27 Description
28  IOobject for a surfZoneList
29 
30 SourceFiles
31  surfZoneIOList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfZoneIOList_H
36 #define surfZoneIOList_H
37 
38 #include "surfZoneList.H"
39 #include "regIOobject.H"
40 #include "faceList.H"
41 #include "className.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of classes
49 
50 /*---------------------------------------------------------------------------*\
51  Class surfZoneIOList Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class surfZoneIOList
55 :
56  public surfZoneList,
57  public regIOobject
58 {
59  // Private Member Functions
60 
61  //- Disallow default bitwise copy construct
63 
64  //- Disallow default bitwise assignment
65  void operator=(const surfZoneIOList&);
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("surfZoneList");
72 
73 
74  // Constructors
75 
76  //- Construct from IOobject
77  explicit surfZoneIOList(const IOobject&);
78 
79  //- Construct from IOobject and surfZoneList
80  surfZoneIOList(const IOobject&, const surfZoneList&);
81 
82  //- Construct from IOobject and surfZoneList
84 
85 
86  //- Destructor
88 
89 
90  // Member Functions
91 
92  //- writeData member function required by regIOobject
93  bool writeData(Ostream&) const;
94 
95 
96  // IOstream Operators
97 
98  friend Ostream& operator<<(Ostream&, const surfZoneIOList&);
99 };
100 
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 } // End namespace Foam
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 #endif
109 
110 // ************************************************************************* //
regIOobject.H
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
Foam::surfZoneIOList::TypeName
TypeName("surfZoneList")
Runtime type information.
faceList.H
Foam::Xfer
A simple container for copying or transferring objects of type <T>.
Definition: Xfer.H:85
Foam::surfZoneIOList
IOobject for a surfZoneList.
Definition: surfZoneIOList.H:53
className.H
Macro definitions for declaring ClassName(), NamespaceName(), etc.
Foam::surfZoneIOList::writeData
bool writeData(Ostream &) const
writeData member function required by regIOobject
Definition: surfZoneIOList.C:138
Foam::surfZoneIOList::surfZoneIOList
surfZoneIOList(const surfZoneIOList &)
Disallow default bitwise copy construct.
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:60
Foam::surfZoneIOList::~surfZoneIOList
~surfZoneIOList()
Destructor.
Definition: surfZoneIOList.C:130
Foam::List
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Foam::surfZoneIOList::operator<<
friend Ostream & operator<<(Ostream &, const surfZoneIOList &)
surfZoneList.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:53
Foam::surfZoneIOList::operator=
void operator=(const surfZoneIOList &)
Disallow default bitwise assignment.