rhoCombustionModel.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::rhoCombustionModel
26 
27 Description
28  Combustion models for rho-based thermodynamics
29 
30 SourceFiles
31  rhoCombustionModelI.H
32  rhoCombustionModel.C
33  rhoCombustionModelNew.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef rhoCombustionModel_H
38 #define rhoCombustionModel_H
39 
40 #include "combustionModel.H"
41 #include "autoPtr.H"
42 #include "runTimeSelectionTables.H"
43 #include "rhoReactionThermo.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 namespace combustionModels
50 {
51 
52 /*---------------------------------------------------------------------------*\
53  class rhoCombustionModel Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public combustionModel
59 {
60 
61  // Private Member Functions
62 
63  //- Construct as copy (not implemented)
65 
66  //- Disallow default bitwise assignment
67  void operator=(const rhoCombustionModel&);
68 
69 
70 public:
71 
72  //- Runtime type information
73  TypeName("rhoCombustionModel");
74 
75 
76  //- Declare run-time constructor selection tables
78  (
79  autoPtr,
81  dictionary,
82  (
83  const word& modelType,
84  const fvMesh& mesh,
85  const word& phaseName
86  ),
87  (modelType, mesh, phaseName)
88  );
89 
90 
91  // Constructors
92 
93 
94  //- Construct from components
96  (
97  const word& modelType,
98  const fvMesh& mesh,
99  const word& phaseName
100  );
101 
102 
103 
104  //- Selector
106  (
107  const fvMesh& mesh,
108  const word& phaseName=word::null
109  );
110 
111 
112  //- Destructor
113  virtual ~rhoCombustionModel();
114 
115 
116  // Member Functions
117 
118  // Access functions
119 
120  //- Access combustion dict
121  inline const dictionary& coeff() const;
122 
123 
124  //- Return access to the thermo package
125  virtual rhoReactionThermo& thermo() = 0;
126 
127  //- Return const access to the thermo package
128  virtual const rhoReactionThermo& thermo() const = 0;
129 
130  //- Return tmp of rho
131  virtual tmp<volScalarField> rho() const = 0;
132 
133 
134  // IO
135 
136  //- Update properties from given dictionary
137  virtual bool read();
138 };
139 
140 
141 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
142 
143 } // End namespace combustionModels
144 } // End namespace Foam
145 
146 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
147 
148 #endif
149 
150 // ************************************************************************* //
virtual bool read()
Update properties from given dictionary.
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const dictionary & coeff() const
Access combustion dict.
const fvMesh & mesh() const
Return const access to the mesh database.
virtual tmp< volScalarField > rho() const =0
Return tmp of rho.
A class for handling words, derived from string.
Definition: word.H:59
declareRunTimeSelectionTable(autoPtr, rhoCombustionModel, dictionary,(const word &modelType, const fvMesh &mesh, const word &phaseName),(modelType, mesh, phaseName))
Declare run-time constructor selection tables.
Foam::rhoReactionThermo.
static const word null
An empty word.
Definition: word.H:77
virtual rhoReactionThermo & thermo()=0
Return access to the thermo package.
static autoPtr< rhoCombustionModel > New(const fvMesh &mesh, const word &phaseName=word::null)
Selector.
TypeName("rhoCombustionModel")
Runtime type information.
Base class for combustion models.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:53
Macros to ease declaration of run-time selection tables.
A class for managing temporary objects.
Definition: PtrList.H:54
Namespace for OpenFOAM.