porousModel.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) 2017-2020 OpenCFD Ltd.
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::porousModel
28
29Description
30
31SourceFiles
32 porousModel.C
33
34\*---------------------------------------------------------------------------*/
35
36#ifndef porousModel_H
37#define porousModel_H
38
39// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40
41#include "volFields.H"
42#include "dictionary.H"
44
45namespace Foam
46{
47
48// Forward Declarations
49class fvMesh;
50
51/*---------------------------------------------------------------------------*\
52 Class porousModel Declaration
53\*---------------------------------------------------------------------------*/
55class porousModel
56:
57 public regIOobject
58{
59protected:
60
61 // Protected Data
62
63 //- Reference to mesh
64 const fvMesh& mesh_;
65
66
67public:
68
69 //- Runtime type information
70 TypeName("porousModel");
71
72
73 // Declare runtime construction
75 (
76 autoPtr,
79 (
80 const dictionary& dict,
81 const fvMesh& mesh
82 ),
83 (dict, mesh)
84 );
85
86
87 // Constructors
88
89 //- Construct from a dictionary and mesh
91 (
92 const dictionary& dict,
93 const fvMesh& mesh
94 );
95
96
97 //- Destructor
98 virtual ~porousModel() = default;
99
100
101 // Selectors
102
104 (
105 const dictionary& dict,
106 const fvMesh& mesh
107 );
108
109
110 // Member Functions
111
112 //- Momentum source
113 virtual tmp<volScalarField> S() const = 0;
114
115 //- Dummy write for regIOobject
116 bool writeData(Ostream& os) const;
117};
118
119
120// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121
122} // End namespace Foam
123
124// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125
126#endif
127
128// ************************************************************************* //
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:62
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: autoPtr.H:66
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
const fvMesh & mesh_
Reference to mesh.
Definition: porousModel.H:63
TypeName("porousModel")
Runtime type information.
bool writeData(Ostream &os) const
Dummy write for regIOobject.
Definition: porousModel.C:96
declareRunTimeSelectionTable(autoPtr, porousModel, dictionary,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
static autoPtr< porousModel > New(const dictionary &dict, const fvMesh &mesh)
Definition: porousModel.C:67
virtual ~porousModel()=default
Destructor.
virtual tmp< volScalarField > S() const =0
Momentum source.
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:76
A class for managing temporary objects.
Definition: tmp.H:65
dynamicFvMesh & mesh
OBJstream os(runTime.globalPath()/outputName)
Namespace for OpenFOAM.
Macros to ease declaration of run-time selection tables.
#define declareRunTimeSelectionTable(ptrWrapper, baseType, argNames, argList, parList)
Declare a run-time selection (variables and adder classes)
dictionary dict
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73