surfacePatchIOList.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::surfacePatchIOList
26 
27 Description
28  IOobject for a surfacePatchList
29 
30 SourceFiles
31  surfacePatchIOList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef surfacePatchIOList_H
36 #define surfacePatchIOList_H
37 
38 #include "surfacePatchList.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 surfacePatchIOList Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 class surfacePatchIOList
55 :
56  public surfacePatchList,
57  public regIOobject
58 {
59  // Private data
60 
61 
62  // Private Member Functions
63 
64  //- Disallow default bitwise copy construct
66 
67  //- Disallow default bitwise assignment
68  void operator=(const surfacePatchIOList&);
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("surfacePatchIOList");
75 
76 
77  // Static data members
78 
79  //- Static data someStaticData
80 
81  // Constructors
82 
83  //- Construct from IOobject
84  explicit surfacePatchIOList(const IOobject& io);
85 
86  //- Construct from IOobject
87  surfacePatchIOList(const IOobject& io, const surfacePatchList&);
88 
89  //- Destructor
91 
92 
93  // Member Functions
94 
95  //- writeData member function required by regIOobject
96  bool writeData(Ostream&) const;
97 
98 
99  // Member Operators
100 
101  // Friend Functions
102 
103  // Friend Operators
104 
105  // IOstream Operators
106 
107  friend Ostream& operator<<(Ostream&, const surfacePatchIOList&);
108 };
109 
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 } // End namespace Foam
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 #endif
118 
119 // ************************************************************************* //
regIOobject.H
faceList.H
Foam::surfacePatchIOList::writeData
bool writeData(Ostream &) const
writeData member function required by regIOobject
Definition: surfacePatchIOList.C:121
surfacePatchList.H
Foam::surfacePatchIOList::~surfacePatchIOList
~surfacePatchIOList()
Definition: surfacePatchIOList.C:113
className.H
Macro definitions for declaring ClassName(), NamespaceName(), etc.
Foam::surfacePatchIOList::operator=
void operator=(const surfacePatchIOList &)
Disallow default bitwise assignment.
Foam
Namespace for OpenFOAM.
Definition: combustionModel.C:30
Foam::IOobject::IOobject
IOobject(const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
Construct from name, instance, registry, io options.
Definition: IOobject.C:116
Foam::surfacePatchIOList::surfacePatchIOList
surfacePatchIOList(const surfacePatchIOList &)
Disallow default bitwise copy construct.
Foam::surfacePatchIOList::TypeName
TypeName("surfacePatchIOList")
Runtime type information.
Foam::surfacePatchList
List< surfacePatch > surfacePatchList
Definition: surfacePatchList.H:44
Foam::surfacePatchIOList::operator<<
friend Ostream & operator<<(Ostream &, const surfacePatchIOList &)