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-------------------------------------------------------------------------------
10License
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
26Class
27 Foam::IOporosityModelList
28
29Description
30 List of porosity models with IO functionality
31
32SourceFiles
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
45namespace Foam
46{
47
48/*---------------------------------------------------------------------------*\
49 Class IOporosityModelList Declaration
50\*---------------------------------------------------------------------------*/
53:
54 public IOdictionary,
56{
57private:
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
71public:
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// ************************************************************************* //
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
List of porosity models with IO functionality.
virtual ~IOporosityModelList()=default
Destructor.
virtual bool read()
Read dictionary.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
List container for porosity models.
dynamicFvMesh & mesh
Namespace for OpenFOAM.