relaxation.H
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2015 OpenFOAM Foundation
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26Class
27 Foam::reactionRateFlameAreaModels::relaxation
28
29Description
30 Consumption rate per unit of flame area obtained from a relaxation equation
31
32SourceFiles
33 relaxation.C
34
35\*---------------------------------------------------------------------------*/
36
37#ifndef relaxation_H
38#define relaxation_H
39
41#include "consumptionSpeed.H"
42
43// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44
45namespace Foam
46{
47namespace reactionRateFlameAreaModels
48{
49
50/*---------------------------------------------------------------------------*\
51 Class relaxation Declaration
52\*---------------------------------------------------------------------------*/
54class relaxation
55:
57{
58 // Private Data
59
60 //- Correlation
61 consumptionSpeed correlation_;
62
63 //- Proportionality constant for time scale in the relaxation Eq.
64 scalar C_;
65
66 //- Proportionality constant for sub-grid strain
67 scalar alpha_;
68
69
70 // Private Member Functions
71
72 //- No copy construct
73 relaxation(const relaxation&) = delete;
74
75 //- No copy assignment
76 void operator=(const relaxation&) = delete;
77
78
79public:
80
81 //- Runtime type information
82 TypeName("relaxation");
83
84
85 // Constructors
86
87 //- Construct from dictionary and psiReactionThermo
89 (
90 const word modelType,
91 const dictionary& dictCoeffs,
92 const fvMesh& mesh,
93 const combustionModel& combModel
94 );
95
96
97 // Destructor
98
99 virtual ~relaxation();
100
101
102 // Member functions
103
104 //- Correct omega
105 virtual void correct(const volScalarField& sigma);
106
107
108 // IO
109
110 //- Update properties from given dictionary
111 virtual bool read(const dictionary& dictProperties);
112};
113
114
115// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116
117} // End reactionRateFlameAreaModels
118} // End namespace Foam
119
120// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121
122#endif
123
124// ************************************************************************* //
Base class for combustion models.
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:126
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:91
Consumption rate per unit of flame area obtained from a relaxation equation.
Definition: relaxation.H:56
TypeName("relaxation")
Runtime type information.
virtual bool read(const dictionary &dictProperties)
Update properties from given dictionary.
Definition: relaxation.C:145
Abstract class for reaction rate per flame area unit.
A class for handling words, derived from Foam::string.
Definition: word.H:68
thermo correct()
dynamicFvMesh & mesh
Namespace for OpenFOAM.
#define TypeName(TypeNameString)
Declare a ClassName() with extra virtual type info.
Definition: typeInfo.H:73