fvIOoptionList.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-2015 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::fv::IOoptionList
26 
27 Description
28  IOoptionList
29 
30 SourceFiles
31  IOoptionList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef IOoptionList_H
36 #define IOoptionList_H
37 
38 #include "fvOptionList.H"
39 #include "IOdictionary.H"
40 #include "autoPtr.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 namespace fv
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class IOoptionList Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class IOoptionList
54 :
55  public IOdictionary,
56  public optionList
57 {
58 private:
59 
60  // Private Member Functions
61 
62  //- Create IO object if dictionary is present
63  IOobject createIOobject(const fvMesh& mesh) const;
64 
65  //- Disallow default bitwise copy construct
66  IOoptionList(const IOoptionList&);
67 
68  //- Disallow default bitwise assignment
69  void operator=(const IOoptionList&);
70 
71 
72 public:
73 
74  // Constructors
75 
76  //- Construct from components with list of field names
77  IOoptionList(const fvMesh& mesh);
78 
79 
80  //- Destructor
81  virtual ~IOoptionList()
82  {}
83 
84 
85  // Member Functions
86 
87  //- Inherit read from optionList
88  using optionList::read;
89 
90  //- Read dictionary
91  virtual bool read();
92 };
93 
94 
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 
97 } // End namespace fv
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
dynamicFvMesh & mesh
Namespace for OpenFOAM.
virtual bool read()
Read dictionary.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:91
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
virtual ~IOoptionList()
Destructor.
List of finite volume options.
Definition: fvOptionList.H:63
labelList fv(nPoints)
virtual bool read(const dictionary &dict)
Read dictionary.
Definition: fvOptionList.C:139