IOporosityModelList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2012-2018 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::IOporosityModelList
26 
27 Description
28  List of porosity models with IO functionality
29 
30 SourceFiles
31  IOporosityModelList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef IOporosityModelList_H
36 #define IOporosityModelList_H
37 
38 #include "IOdictionary.H"
39 #include "porosityModelList.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class IOporosityModelList Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public IOdictionary,
53  public porosityModelList
54 {
55 private:
56 
57  // Private Member Functions
58 
59  //- Create IO object if dictionary is present
60  IOobject createIOobject(const fvMesh& mesh) const;
61 
62  //- Disallow default bitwise copy construct
64 
65  //- Disallow default bitwise assignment
66  void operator=(const IOporosityModelList&);
67 
68 
69 public:
70 
71  // Constructors
72 
73  //- Construct from mesh
74  IOporosityModelList(const fvMesh& mesh);
75 
76 
77  //- Destructor
78  virtual ~IOporosityModelList()
79  {}
80 
81 
82  // Member Functions
83 
84  //- Read dictionary
85  virtual bool read();
86 };
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:52
dynamicFvMesh & mesh
virtual bool read()
Read dictionary.
List of porosity models with IO functionality.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
List container for porosity models.
virtual ~IOporosityModelList()
Destructor.
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
Namespace for OpenFOAM.