SuModel.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) 2024 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 "SuModel.H"
27 
28 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
34 }
35 
36 
37 // * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * //
38 
40 {
41  return true;
42 }
43 
44 
45 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
46 
48 (
50  const fluidThermoThermophysicalTransportModel& thermoTransport
51 )
52 :
53  thermo_(thermo),
54  thermoTransport_(thermoTransport),
55  turbulence_(thermoTransport.momentumTransport()),
56  Su_
57  (
58  IOobject
59  (
60  "Su",
61  thermo_.mesh().time().name(),
62  thermo_.mesh(),
63  IOobject::READ_IF_PRESENT,
64  IOobject::NO_WRITE
65  ),
66  thermo_.mesh(),
68  )
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
73 
75 {}
76 
77 
78 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
79 
80 bool Foam::SuModel::read(const dictionary& combustionProperties)
81 {
82  return readCoeffs
83  (
84  combustionProperties.subDict("Su").optionalSubDict(type() + "Coeffs")
85  );
86 }
87 
88 
89 // ************************************************************************* //
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
Base-class for all Su models used by the b-Xi combustion model.
Definition: SuModel.H:65
bool read(const dictionary &combustionProperties)
Update properties from the given combustionProperties dictionary.
Definition: SuModel.C:80
virtual ~SuModel()
Destructor.
Definition: SuModel.C:74
virtual bool readCoeffs(const dictionary &dict)=0
Update coefficients from given dictionary.
Definition: SuModel.C:39
SuModel(const psiuMulticomponentThermo &thermo, const fluidThermoThermophysicalTransportModel &turbulence)
Construct from components.
Definition: SuModel.C:48
Templated abstract base class for thermophysical transport models.
A list of keywords followed by any number of values (e.g. words and numbers) or sub-dictionaries.
Definition: dictionary.H:162
const dictionary & optionalSubDict(const word &) const
Find and return a sub-dictionary if found.
Definition: dictionary.C:927
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:849
Base-class for combustion fluid thermodynamic properties based on compressibility.
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
Namespace for OpenFOAM.
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
const dimensionSet dimVelocity
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
fluidMulticomponentThermo & thermo
Definition: createFields.H:31