All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
fluidReactionThermo.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) 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::fluidReactionThermo
26 
27 Description
28  Base-class for multi-component fluid thermodynamic properties.
29 
30 See also
31  Foam::basicThermo
32 
33 SourceFiles
34  fluidReactionThermo.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef fluidReactionThermo_H
39 #define fluidReactionThermo_H
40 
41 #include "fluidThermo.H"
42 #include "basicSpecieMixture.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class fluidReactionThermo Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
55  virtual public fluidThermo
56 {
57 public:
58 
59  // Public Classes
60 
61  //- Forward declare the implementation class
62  class implementation;
63 
64 
65  //- Runtime type information
66  TypeName("fluidReactionThermo");
67 
68 
69  //- Declare run-time constructor selection tables
71  (
72  autoPtr,
74  fvMesh,
75  (const fvMesh& mesh, const word& phaseName),
76  (mesh, phaseName)
77  );
78 
79 
80  // Selectors
81 
82  //- Standard selection based on fvMesh
84  (
85  const fvMesh&,
86  const word& phaseName=word::null
87  );
88 
89 
90  //- Destructor
91  virtual ~fluidReactionThermo();
92 
93 
94  // Member Functions
95 
96  //- Return the composition of the multi-component mixture
97  virtual basicSpecieMixture& composition() = 0;
98 
99  //- Return the composition of the multi-component mixture
100  virtual const basicSpecieMixture& composition() const = 0;
101 };
102 
103 
104 /*---------------------------------------------------------------------------*\
105  Class fluidReactionThermo Declaration
106 \*---------------------------------------------------------------------------*/
109 :
110  virtual public fluidReactionThermo
111 {
112 public:
113 
114  // Constructors
115 
116  //- Construct from mesh and phase name
117  implementation(const fvMesh&, const word& phaseName);
118 
119 
120  //- Destructor
121  virtual ~implementation();
122 };
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 } // End namespace Foam
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
declareRunTimeSelectionTable(autoPtr, fluidReactionThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
Declare run-time constructor selection tables.
static autoPtr< fluidReactionThermo > New(const fvMesh &, const word &phaseName=word::null)
Standard selection based on fvMesh.
Base-class for multi-component fluid thermodynamic properties.
Specialisation of basicMixture for a mixture consisting of a number for molecular species...
virtual basicSpecieMixture & composition()=0
Return the composition of the multi-component mixture.
TypeName("fluidReactionThermo")
Runtime type information.
virtual const word & phaseName() const =0
Return the phase name.
dynamicFvMesh & mesh
A class for handling words, derived from string.
Definition: word.H:59
Base-class for fluid thermodynamic properties.
Definition: fluidThermo.H:53
static const word null
An empty word.
Definition: word.H:77
virtual ~fluidReactionThermo()
Destructor.
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:52
Namespace for OpenFOAM.