psiReactionThermo.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) 2011-2019 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::psiReactionThermo
26 
27 Description
28  Foam::psiReactionThermo
29 
30 SourceFiles
31  psiReactionThermo.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef psiReactionThermo_H
36 #define psiReactionThermo_H
37 
38 #include "psiThermo.H"
39 #include "basicSpecieMixture.H"
40 #include "autoPtr.H"
41 #include "runTimeSelectionTables.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class psiReactionThermo Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
54  public psiThermo
55 {
56 
57 public:
58 
59  //- Runtime type information
60  TypeName("psiReactionThermo");
61 
62 
63  //- Declare run-time constructor selection tables
65  (
66  autoPtr,
68  fvMesh,
69  (const fvMesh& mesh, const word& phaseName),
70  (mesh, phaseName)
71  );
72 
73 
74  // Constructors
75 
76  //- Construct from mesh and phase name
78  (
79  const fvMesh&,
80  const word& phaseName
81  );
82 
83 
84  // Selectors
85 
86  //- Standard selection based on fvMesh
88  (
89  const fvMesh&,
90  const word& phaseName=word::null
91  );
92 
93 
94  //- Destructor
95  virtual ~psiReactionThermo();
96 
97 
98  // Member Functions
99 
100  //- Return the composition of the multi-component mixture
101  virtual basicSpecieMixture& composition() = 0;
102 
103  //- Return the composition of the multi-component mixture
104  virtual const basicSpecieMixture& composition() const = 0;
105 };
106 
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 } // End namespace Foam
111 
112 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
113 
114 #endif
115 
116 // ************************************************************************* //
static autoPtr< psiReactionThermo > New(const fvMesh &, const word &phaseName=word::null)
Standard selection based on fvMesh.
Specialization of basicMultiComponentMixture for a mixture consisting of a number for molecular speci...
psiReactionThermo(const fvMesh &, const word &phaseName)
Construct from mesh and phase name.
dynamicFvMesh & mesh
declareRunTimeSelectionTable(autoPtr, psiReactionThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection tables.
A class for handling words, derived from string.
Definition: word.H:59
static const word null
An empty word.
Definition: word.H:77
virtual ~psiReactionThermo()
Destructor.
TypeName("psiReactionThermo")
Runtime type information.
Foam::psiReactionThermo.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual basicSpecieMixture & composition()=0
Return the composition of the multi-component mixture.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Macros to ease declaration of run-time selection tables.
Basic thermodynamic properties based on compressibility.
Definition: psiThermo.H:49
Namespace for OpenFOAM.