IOporosityModelList.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) 2012 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::IOporosityModelList
28 
29 Description
30  List of porosity models with IO functionality
31 
32 SourceFiles
33  IOporosityModelList.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef IOporosityModelList_H
38 #define IOporosityModelList_H
39 
40 #include "IOdictionary.H"
41 #include "porosityModelList.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class IOporosityModelList Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public IOdictionary,
55  public porosityModelList
56 {
57 private:
58 
59  // Private Member Functions
60 
61  //- Create IO object if dictionary is present
62  IOobject createIOobject(const fvMesh& mesh) const;
63 
64  //- No copy construct
66 
67  //- No copy assignment
68  void operator=(const IOporosityModelList&) = delete;
69 
70 
71 public:
72 
73  // Constructors
74 
75  //- Construct from mesh
76  explicit IOporosityModelList(const fvMesh& mesh);
77 
78 
79  //- Destructor
80  virtual ~IOporosityModelList() = default;
81 
82 
83  // Member Functions
84 
85  //- Read dictionary
86  virtual bool read();
87 };
88 
89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
90 
91 } // End namespace Foam
92 
93 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
94 
95 #endif
96 
97 // ************************************************************************* //
Foam::IOdictionary
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:54
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
Foam::porosityModelList
List container for porosity models.
Definition: porosityModelList.H:57
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
IOdictionary.H
Foam::IOporosityModelList::read
virtual bool read()
Read dictionary.
Definition: IOporosityModelList.C:78
Foam::IOporosityModelList::~IOporosityModelList
virtual ~IOporosityModelList()=default
Destructor.
porosityModelList.H
Foam::IOporosityModelList
List of porosity models with IO functionality.
Definition: IOporosityModelList.H:51