combustionModel.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) 2011-2022 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 "combustionModel.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
34 }
35 
37 (
38  "combustionProperties"
39 );
40 
41 
42 // * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
43 
44 Foam::IOobject Foam::combustionModel::createIOobject
45 (
46  const fluidMulticomponentThermo& thermo,
47  const word& combustionProperties
48 ) const
49 {
50  typeIOobject<IOdictionary> io
51  (
52  thermo.phasePropertyName(combustionProperties),
53  thermo.T().mesh().time().constant(),
54  thermo.T().mesh(),
57  );
58 
59  if (io.headerOk())
60  {
61  io.readOpt() = IOobject::MUST_READ_IF_MODIFIED;
62  return io;
63  }
64  else
65  {
66  io.readOpt() = IOobject::NO_READ;
67  return io;
68  }
69 }
70 
71 
72 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
73 
75 (
76  const word& modelType,
79  const word& combustionProperties
80 )
81 :
82  IOdictionary(createIOobject(thermo, combustionProperties)),
83  mesh_(thermo.T().mesh()),
84  thermo_(thermo),
85  turb_(turb),
86  coeffs_(optionalSubDict(modelType + "Coeffs")),
87  modelType_(modelType)
88 {}
89 
90 
91 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
92 
94 {}
95 
96 
97 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
98 
100 {
101  if (regIOobject::read())
102  {
103  coeffs_ = optionalSubDict(modelType_ + "Coeffs");
104  return true;
105  }
106  else
107  {
108  return false;
109  }
110 }
111 
112 
113 // ************************************************************************* //
const Mesh & mesh() const
Return mesh.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:57
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
@ MUST_READ_IF_MODIFIED
Definition: IOobject.H:119
static word phasePropertyName(const word &name, const word &phaseName)
Name of a property for a given phase.
Definition: basicThermo.H:154
virtual const volScalarField & T() const =0
Temperature [K].
Base class for combustion models.
const fluidMulticomponentThermo & thermo() const
Return const access to the thermo.
combustionModel(const word &modelType, const fluidMulticomponentThermo &thermo, const compressibleMomentumTransportModel &turb, const word &combustionProperties=combustionPropertiesName)
Construct from components.
static const word combustionPropertiesName
Default combustionProperties dictionary name.
virtual ~combustionModel()
Destructor.
virtual bool read()
Update properties from given dictionary.
Base class for single-phase compressible turbulence models.
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Base-class for multi-component fluid thermodynamic properties.
virtual bool read()
Read object.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
fluidMulticomponentThermo & thermo
Definition: createFields.H:31