OpenFOAM: API Guide
v2112
The open source CFD toolbox
chemistryReductionMethodI.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) 2016 OpenFOAM Foundation
9
-------------------------------------------------------------------------------
10
License
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
26
Class
27
Foam::chemistryReductionMethod
28
29
Description
30
An abstract class for reducing chemical mechanisms
31
32
SourceFiles
33
chemistryReductionMethod.C
34
35
\*---------------------------------------------------------------------------*/
36
37
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
38
39
template
<
class
CompType,
class
ThermoType>
40
inline
bool
41
Foam::chemistryReductionMethod<CompType, ThermoType>::active
()
const
42
{
43
return
active_;
44
}
45
46
47
template
<
class
CompType,
class
ThermoType>
48
inline
bool
49
Foam::chemistryReductionMethod<CompType, ThermoType>::log
()
const
50
{
51
return
active_ && log_;
52
}
53
54
55
template
<
class
CompType,
class
ThermoType>
56
inline
const
Foam::List<bool>
&
57
Foam::chemistryReductionMethod<CompType, ThermoType>::activeSpecies
()
const
58
{
59
return
activeSpecies_;
60
}
61
62
63
template
<
class
CompType,
class
ThermoType>
64
inline
Foam::label
65
Foam::chemistryReductionMethod<CompType, ThermoType>::NsSimp
()
66
{
67
return
NsSimp_;
68
}
69
70
71
template
<
class
CompType,
class
ThermoType>
72
inline
Foam::label
73
Foam::chemistryReductionMethod<CompType, ThermoType>::nSpecie
()
74
{
75
return
nSpecie_;
76
}
77
78
79
template
<
class
CompType,
class
ThermoType>
80
inline
Foam::scalar
81
Foam::chemistryReductionMethod<CompType, ThermoType>::tolerance
()
const
82
{
83
return
tolerance_;
84
}
85
86
87
// ************************************************************************* //
Foam::chemistryReductionMethod::activeSpecies
const List< bool > & activeSpecies() const
Return the active species.
Definition:
chemistryReductionMethodI.H:56
Foam::chemistryReductionMethod::log
bool log() const
Is performance data logging enabled?
Definition:
chemistryReductionMethodI.H:48
Foam::chemistryReductionMethod::tolerance
scalar tolerance() const
Return the tolerance.
Definition:
chemistryReductionMethodI.H:80
Foam::chemistryReductionMethod::active
bool active() const
Is mechanism reduction active?
Definition:
chemistryReductionMethodI.H:40
Foam::chemistryReductionMethod::nSpecie
label nSpecie()
Return the initial number of species.
Definition:
chemistryReductionMethodI.H:72
Foam::List< bool >
Foam::chemistryReductionMethod::NsSimp
label NsSimp()
Return the number of active species.
Definition:
chemistryReductionMethodI.H:64
src
thermophysicalModels
chemistryModel
chemistryModel
TDACChemistryModel
reduction
chemistryReductionMethod
chemistryReductionMethodI.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.