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-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 "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 compressibleMomentumTransportModel& momentumTransport
51 )
52 :
53  thermo_(thermo),
54  momentumTransport_(momentumTransport),
55  Su_
56  (
57  IOobject
58  (
59  "Su",
60  thermo_.mesh().time().name(),
61  thermo_.mesh(),
62  IOobject::READ_IF_PRESENT,
63  IOobject::NO_WRITE
64  ),
65  thermo_.mesh(),
67  )
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
72 
74 {}
75 
76 
77 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
78 
79 bool Foam::SuModel::read(const dictionary& combustionProperties)
80 {
81  return readCoeffs
82  (
83  combustionProperties.subDict("Su").optionalTypeDict(type())
84  );
85 }
86 
87 
88 // ************************************************************************* //
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
SuModel(const uRhoMulticomponentThermo &thermo, const compressibleMomentumTransportModel &momentumTransport)
Construct from components.
Definition: SuModel.C:48
bool read(const dictionary &combustionProperties)
Update properties from the given combustionProperties dictionary.
Definition: SuModel.C:79
virtual ~SuModel()
Destructor.
Definition: SuModel.C:73
virtual bool readCoeffs(const dictionary &dict)=0
Update coefficients from given dictionary.
Definition: SuModel.C:39
Base class for single-phase compressible momentum 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 & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:778
const dictionary & optionalTypeDict(const word &typeName) const
Find and return an optional type sub-dictionary.
Definition: dictionary.C:921
Base-class for combustion fluid thermodynamic properties based on compressibility.
Foam::fvMesh mesh(Foam::IOobject(regionName, runTime.name(), runTime, Foam::IOobject::MUST_READ), false)
const dimensionSet time
Namespace for OpenFOAM.
const dimensionSet & dimVelocity
Definition: dimensions.C:154
defineRunTimeSelectionTable(fvConstraint, dictionary)
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
defineTypeNameAndDebug(atmosphericBoundaryLayer, 0)
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:15