basicXiSubG.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) 2011-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::XiGModels::basicSubGrid
26 
27 Description
28  Basic sub-grid obstacle flame-wrinkling generation rate coefficient model.
29  Details supplied by J Puttock 2/7/06.
30 
31  \f$ G_{sub} \f$ denotes the generation coefficient and it is given by
32 
33  \f[
34  G_{sub} = k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{obs}}
35  \frac{/Xi_{{sub}_{eq}}-1}{/Xi_{sub}}
36  \f]
37 
38  and the removal:
39 
40  \f[
41  - k_{1} /frac{\vert \dwea{\vec{U}} \vert}{L_{sub}}
42  \frac{\Xi_{sub}-1}{\Xi_{sub}}
43  \f]
44 
45  Finally, \f$ G_{sub} \f$ is added to generation rate \f$ G_{in} \f$
46  due to the turbulence.
47 
48 SourceFiles
49  basicSubGrid.C
50 
51 \*---------------------------------------------------------------------------*/
52 
53 #ifndef basicXiSubG_H
54 #define basicXiSubG_H
55 
56 #include "XiGModel.H"
57 
58 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
59 
60 namespace Foam
61 {
62 namespace XiGModels
63 {
64 
65 /*---------------------------------------------------------------------------*\
66  Class basicSubGrid Declaration
67 \*---------------------------------------------------------------------------*/
68 
69 class basicSubGrid
70 :
71  public XiGModel
72 {
73  // Private Data
74 
75  //- Sub-grid generation rate coefficient
76  scalar k1;
77 
78  //- Xi generation rate model due to turbulence
79  autoPtr<XiGModel> XiGModel_;
80 
81 
82 public:
83 
84  //- Runtime type information
85  TypeName("basicSubGridG");
86 
87 
88  // Constructors
89 
90  //- Construct from components
92  (
93  const dictionary& XiGProperties,
96  const volScalarField& Su
97  );
98 
99  //- Disallow default bitwise copy construction
100  basicSubGrid(const basicSubGrid&) = delete;
101 
102 
103  //- Destructor
104  virtual ~basicSubGrid();
105 
106 
107  // Member Functions
108 
109  //- Return the flame-wrinkling generation rate
110  virtual tmp<volScalarField> G() const;
111 
112  //- Return the flame diffusivity
113  virtual tmp<volScalarField> Db() const;
114 
115  //- Update properties from given dictionary
116  virtual bool read(const dictionary& XiGProperties);
117 
118 
119  // Member Operators
120 
121  //- Disallow default bitwise assignment
122  void operator=(const basicSubGrid&) = delete;
123 };
124 
125 
126 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
127 
128 } // End namespace XiGModels
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
Generic GeometricField class.
Base-class for all Xi generation models used by the b-Xi combustion model. See Technical Report SH/RE...
Definition: XiGModel.H:55
Basic sub-grid obstacle flame-wrinkling generation rate coefficient model. Details supplied by J Putt...
Definition: basicXiSubG.H:71
virtual bool read(const dictionary &XiGProperties)
Update properties from given dictionary.
Definition: basicXiSubG.C:103
virtual ~basicSubGrid()
Destructor.
Definition: basicXiSubG.C:59
void operator=(const basicSubGrid &)=delete
Disallow default bitwise assignment.
basicSubGrid(const dictionary &XiGProperties, const psiuMulticomponentThermo &thermo, const compressible::RASModel &turbulence, const volScalarField &Su)
Construct from components.
Definition: basicXiSubG.C:44
virtual tmp< volScalarField > G() const
Return the flame-wrinkling generation rate.
Definition: basicXiSubG.C:65
TypeName("basicSubGridG")
Runtime type information.
virtual tmp< volScalarField > Db() const
Return the flame diffusivity.
Definition: basicXiSubG.C:90
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: autoPtr.H:51
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Base-class for combustion fluid thermodynamic properties based on compressibility.
A class for managing temporary objects.
Definition: tmp.H:55
RASModel< momentumTransportModel > RASModel
Typedefs for turbulence, RAS and LES models for compressible flow based on the standard laminar trans...
tmp< VolField< Type > > Su(const VolField< Type > &su, const VolField< Type > &vf)
Definition: fvcSup.C:44
Namespace for OpenFOAM.
autoPtr< incompressible::momentumTransportModel > turbulence(incompressible::momentumTransportModel::New(U, phi, viscosity))
fluidMulticomponentThermo & thermo
Definition: createFields.H:31