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-2023 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 "combustionModel.H"
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
33 template<class BasePhaseModel>
35 (
36  const phaseSystem& fluid,
37  const word& phaseName,
38  const bool referencePhase,
39  const label index
40 )
41 :
42  BasePhaseModel(fluid, phaseName, referencePhase, index),
43  reaction_(combustionModel::New(this->thermo_(), this->momentumTransport_()))
44 {}
45 
46 
47 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
48 
49 template<class BasePhaseModel>
51 {}
52 
53 
54 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
55 
56 template<class BasePhaseModel>
58 {
59  reaction_->correct();
60 
61  BasePhaseModel::correctReactions();
62 }
63 
64 
65 template<class BasePhaseModel>
67 (
68  volScalarField& Yi
69 ) const
70 {
71  return reaction_->R(Yi);
72 }
73 
74 
75 template<class BasePhaseModel>
78 {
79  return reaction_->Qdot();
80 }
81 
82 
83 // ************************************************************************* //
Generic GeometricField class.
virtual void correctReactions()
Correct the reaction rates.
ReactingPhaseModel(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
virtual ~ReactingPhaseModel()
Destructor.
virtual tmp< volScalarField > Qdot() const
Return heat release rate.
virtual tmp< fvScalarMatrix > R(volScalarField &Yi) const
Return the fuel consumption rate matrix.
Base class for combustion models.
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:73
A class for managing temporary objects.
Definition: tmp.H:55
A class for handling words, derived from string.
Definition: word.H:62
autoPtr< CompressibleMomentumTransportModel > New(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const viscosity &viscosity)
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