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-2020 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 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class psiReactionThermo Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 :
52  public psiThermo
53 {
54 
55 public:
56 
57  //- Runtime type information
58  TypeName("psiReactionThermo");
59 
60 
61  //- Declare run-time constructor selection tables
63  (
64  autoPtr,
66  fvMesh,
67  (const fvMesh& mesh, const word& phaseName),
68  (mesh, phaseName)
69  );
70 
71 
72  // Constructors
73 
74  //- Construct from mesh and phase name
76  (
77  const fvMesh&,
78  const word& phaseName
79  );
80 
81 
82  // Selectors
83 
84  //- Standard selection based on fvMesh
86  (
87  const fvMesh&,
88  const word& phaseName=word::null
89  );
90 
91 
92  //- Destructor
93  virtual ~psiReactionThermo();
94 
95 
96  // Member Functions
97 
98  //- Return the composition of the multi-component mixture
99  virtual basicSpecieMixture& composition() = 0;
100 
101  //- Return the composition of the multi-component mixture
102  virtual const basicSpecieMixture& composition() const = 0;
103 };
104 
105 
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107 
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
static autoPtr< psiReactionThermo > New(const fvMesh &, const word &phaseName=word::null)
Standard selection based on fvMesh.
Specialization of basicMixture for a mixture consisting of a number for molecular species...
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
Basic thermodynamic properties based on compressibility.
Definition: psiThermo.H:49
Namespace for OpenFOAM.