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-2016 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 friend functions and operators
49 
50 class surfacePatchIOList;
51 
52 Ostream& operator<<(Ostream&, const surfacePatchIOList&);
53 
54 
55 /*---------------------------------------------------------------------------*\
56  Class surfacePatchIOList Declaration
57 \*---------------------------------------------------------------------------*/
58 
60 :
61  public surfacePatchList,
62  public regIOobject
63 {
64  // Private data
65 
66 
67  // Private Member Functions
68 
69  //- Disallow default bitwise copy construct
71 
72  //- Disallow default bitwise assignment
73  void operator=(const surfacePatchIOList&);
74 
75 
76 public:
77 
78  //- Runtime type information
79  TypeName("surfacePatchIOList");
80 
81 
82  // Static data members
83 
84  //- Static data someStaticData
85 
86  // Constructors
87 
88  //- Construct from IOobject
89  explicit surfacePatchIOList(const IOobject& io);
90 
91  //- Construct from IOobject
92  surfacePatchIOList(const IOobject& io, const surfacePatchList&);
93 
94  //- Destructor
96 
97 
98  // Member Functions
99 
100  //- writeData member function required by regIOobject
101  bool writeData(Ostream&) const;
102 
103 
104  // IOstream Operators
105 
106  friend Ostream& operator<<(Ostream&, const surfacePatchIOList&);
107 };
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
friend Ostream & operator<<(Ostream &, const surfacePatchIOList &)
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:60
IOobject for a surfacePatchList.
bool writeData(Ostream &) const
writeData member function required by regIOobject
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
TypeName("surfacePatchIOList")
Runtime type information.
Macro definitions for declaring ClassName(), NamespaceName(), etc.
Ostream & operator<<(Ostream &, const ensightPart &)
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:65
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
Namespace for OpenFOAM.