uniformConstant_SuModel.H
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 Class
25  Foam::SuModels::uniformConstant
26 
27 Description
28  Simple uniform constant laminar flame speed \c Su model
29 
30 SourceFiles
31  uniformConstant_SuModel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef uniformConstant_SuModel_H
36 #define uniformConstant_SuModel_H
37 
38 #include "SuModel.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 namespace SuModels
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class uniformConstant Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class uniformConstant
52 :
53  public SuModel
54 {
55  // Private Data
56 
57  //- Specified laminar flame speed
59 
60 
61 protected:
62 
63  //- Update coefficients from given dictionary
64  virtual bool readCoeffs(const dictionary& dict);
65 
66 
67 public:
68 
69  //- Runtime type information
70  TypeName("uniformConstant");
71 
72 
73  // Constructors
74 
75  //- Construct from components
77  (
78  const dictionary& dict,
81  );
82 
83  //- Disallow default bitwise copy construction
84  uniformConstant(const uniformConstant&) = delete;
85 
86 
87  //- Destructor
88  virtual ~uniformConstant();
89 
90 
91  // Member Functions
92 
93  //- Correct the laminar flame speed
94  virtual void correct()
95  {}
96 
97 
98  // Member Operators
99 
100  //- Disallow default bitwise assignment
101  void operator=(const uniformConstant&) = delete;
102 };
103 
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 } // End namespace SuModels
108 } // End namespace Foam
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 #endif
113 
114 // ************************************************************************* //
Base-class for all Su models used by the b-Xi combustion model.
Definition: SuModel.H:65
Simple uniform constant laminar flame speed Su model.
uniformConstant(const dictionary &dict, const psiuMulticomponentThermo &thermo, const fluidThermoThermophysicalTransportModel &turbulence)
Construct from components.
void operator=(const uniformConstant &)=delete
Disallow default bitwise assignment.
virtual bool readCoeffs(const dictionary &dict)
Update coefficients from given dictionary.
TypeName("uniformConstant")
Runtime type information.
virtual void correct()
Correct the laminar flame speed.
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
Base-class for combustion fluid thermodynamic properties based on compressibility.
Namespace for OpenFOAM.
dictionary dict
autoPtr< incompressible::momentumTransportModel > turbulence(incompressible::momentumTransportModel::New(U, phi, viscosity))
fluidMulticomponentThermo & thermo
Definition: createFields.H:31