relaxation.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-2020 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::reactionRateFlameAreaModels::relaxation
26 
27 Description
28  Consumption rate per unit of flame area obtained from a relaxation equation
29 
30 SourceFiles
31  relaxation.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef relaxation_H
36 #define relaxation_H
37 
38 #include "reactionRateFlameArea.H"
39 #include "consumptionSpeed.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 namespace reactionRateFlameAreaModels
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class relaxation Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 class relaxation
53 :
55 {
56  // Private Data
57 
58  //- Correlation
59  consumptionSpeed correlation_;
60 
61  //- Proportionality constant for time scale in the relaxation Eq.
62  scalar C_;
63 
64  //- Proportionality constant for sub-grid strain
65  scalar alpha_;
66 
67 
68 public:
69 
70  //- Runtime type information
71  TypeName("relaxation");
72 
73 
74  // Constructors
75 
76  //- Construct from dictionary, mesh and combustion model
78  (
79  const word modelType,
80  const dictionary& dictCoeffs,
81  const fvMesh& mesh,
82  const combustionModel& combModel
83  );
84 
85  //- Disallow default bitwise copy construction
86  relaxation(const relaxation&) = delete;
87 
88 
89  // Destructor
90 
91  virtual ~relaxation();
92 
93 
94  // Member Functions
95 
96  //- Correct omega
97  virtual void correct(const volScalarField& sigma);
98 
99 
100  // IO
101 
102  //- Update properties from given dictionary
103  virtual bool read(const dictionary& dictProperties);
104 
105 
106  // Member Operators
107 
108  //- Disallow default bitwise assignment
109  void operator=(const relaxation&) = delete;
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End reactionRateFlameAreaModels
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************************************************************* //
Correlation function for laminar consumption speed obtained from flamelet solution at increasing stra...
relaxation(const word modelType, const dictionary &dictCoeffs, const fvMesh &mesh, const combustionModel &combModel)
Construct from dictionary, mesh and combustion model.
Definition: relaxation.C:51
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
virtual void correct(const volScalarField &sigma)
Correct omega.
Definition: relaxation.C:77
Abstract class for reaction rate per flame area unit.
void operator=(const relaxation &)=delete
Disallow default bitwise assignment.
fvMesh & mesh
Consumption rate per unit of flame area obtained from a relaxation equation.
Definition: relaxation.H:51
TypeName("relaxation")
Runtime type information.
virtual bool read(const dictionary &dictProperties)
Update properties from given dictionary.
Definition: relaxation.C:149
const dimensionedScalar sigma
Stefan-Boltzmann constant: default SI units: [W/m^2/K^4].
A class for handling words, derived from string.
Definition: word.H:59
Base class for combustion models.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
Namespace for OpenFOAM.