FreeFOAM The Cross-Platform CFD Toolkit
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) 1991-2010 OpenCFD Ltd.
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 <OpenFOAM/regIOobject.H>
40 #include <OpenFOAM/faceList.H>
41 #include <OpenFOAM/className.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 // Forward declaration of classes
49 
50 /*---------------------------------------------------------------------------*\
51  Class surfacePatchIOList Declaration
52 \*---------------------------------------------------------------------------*/
53 
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
90 
92 
93 
94  // Member Functions
95 
96  //- writeData member function required by regIOobject
97  bool writeData(Ostream&) const;
98 
99 
100  // Member Operators
101 
102  // Friend Functions
103 
104  // Friend Operators
105 
106  // IOstream Operators
107 
108  friend Ostream& operator<<(Ostream&, const surfacePatchIOList&);
109 };
110 
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 } // End namespace Foam
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 #endif
119 
120 // ************************ vim: set sw=4 sts=4 et: ************************ //