polyBoundaryMeshEntries.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2015 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::polyBoundaryMeshEntries
28 
29 Description
30  Foam::polyBoundaryMeshEntries
31 
32 SourceFiles
33  polyBoundaryMeshEntries.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef polyBoundaryMeshEntries_H
38 #define polyBoundaryMeshEntries_H
39 
40 #include "regIOobject.H"
41 #include "PtrList.H"
42 #include "entry.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 
52 :
53  public regIOobject,
54  public PtrList<entry>
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("polyBoundaryMesh");
61 
62 
63  // Constructors
64 
65  explicit polyBoundaryMeshEntries(const IOobject& io)
66  :
67  regIOobject(io),
68  PtrList<entry>()
69  {
70  if
71  (
72  (
75  )
77  )
78  {
79  readStream(typeName) >> *this;
80  }
81  }
82 
83 
84  // Member Functions
85 
86  bool writeData(Ostream&) const
87  {
89  return false;
90  }
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Foam::entry
A keyword and a list of tokens is an 'entry'.
Definition: entry.H:67
regIOobject.H
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:104
Foam::polyBoundaryMeshEntries
Foam::polyBoundaryMeshEntries.
Definition: polyBoundaryMeshEntries.H:50
entry.H
Foam::polyBoundaryMeshEntries::writeData
bool writeData(Ostream &) const
Pure virtual writeData function.
Definition: polyBoundaryMeshEntries.H:85
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:436
Foam::IOobject::READ_IF_PRESENT
Definition: IOobject.H:122
Foam::PtrList
A list of pointers to objects of type <T>, with allocation/deallocation management of the pointers....
Definition: List.H:62
Foam::polyBoundaryMeshEntries::polyBoundaryMeshEntries
polyBoundaryMeshEntries(const IOobject &io)
Definition: polyBoundaryMeshEntries.H:64
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:68
Foam::IOobject::readOpt
readOption readOpt() const
The read option.
Definition: IOobjectI.H:165
Foam::IOobject::MUST_READ_IF_MODIFIED
Definition: IOobject.H:121
PtrList.H
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::regIOobject::readStream
Istream & readStream(const word &, const bool valid=true)
Return Istream and check object type against that given.
Definition: regIOobjectRead.C:140
Foam::regIOobject::headerOk
bool headerOk()
Read and check header info.
Definition: regIOobject.C:453
Foam::IOobject::MUST_READ
Definition: IOobject.H:120
Foam::polyBoundaryMeshEntries::TypeName
TypeName("polyBoundaryMesh")
Runtime type information.