ReactingPhaseModel.C
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) 2015-2026 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 \*---------------------------------------------------------------------------*/
25 
26 #include "ReactingPhaseModel.H"
27 #include "phaseSystem.H"
28 #include "fvMatrix.H"
29 #include "reactionModel.H"
30 #include "volFieldsFwd.H"
31 
32 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33 
34 template<class BasePhaseModel>
36 (
37  const phaseSystem& fluid,
38  const word& phaseName,
39  const bool referencePhase,
40  const label index
41 )
42 :
43  BasePhaseModel(fluid, phaseName, referencePhase, index),
44  reaction_(reactionModel::New(this->thermo_(), this->momentumTransport_()))
45 {}
46 
47 
48 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
49 
50 template<class BasePhaseModel>
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
56 
57 template<class BasePhaseModel>
59 {
60  reaction_->correct();
61 
62  BasePhaseModel::correctReactions();
63 }
64 
65 
66 template<class BasePhaseModel>
68 {
69  return false;
70 }
71 
72 
73 template<class BasePhaseModel>
76 {
77  return reaction_->R(speciei);
78 }
79 
80 
81 template<class BasePhaseModel>
84 {
85  return reaction_->R(Yi);
86 }
87 
88 
89 template<class BasePhaseModel>
92 {
93  return reaction_->Qdot();
94 }
95 
96 
97 // ************************************************************************* //
Generic GeometricField class.
virtual void correctReactions()
Correct the reaction rates.
ReactingPhaseModel(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
virtual bool inert() const
Return whether the phase is inert (i.e., not reacting)
virtual ~ReactingPhaseModel()
Destructor.
virtual tmp< volScalarField::Internal > R(const label speciei) const
Return the consumption rate for a specie.
virtual tmp< volScalarField > Qdot() const
Return heat release rate.
Class to represent a system of phases.
Definition: phaseSystem.H:74
Base class for reaction models.
Definition: reactionModel.H:53
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:63
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
tmp< DimensionedField< TypeR, GeoMesh, Field > > New(const tmp< DimensionedField< TypeR, GeoMesh, Field >> &tdf1, const word &name, const dimensionSet &dimensions)