chemistryReductionMethodI.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) 2016-2018 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::chemistryReductionMethod
26 
27 Description
28  An abstract class for reducing chemical mechanism
29 
30 SourceFiles
31  chemistryReductionMethod.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
36 
37 template<class CompType, class ThermoType>
38 inline bool
40 {
41  return active_;
42 }
43 
44 
45 template<class CompType, class ThermoType>
46 inline bool
48 {
49  return active_ && log_;
50 }
51 
52 
53 template<class CompType, class ThermoType>
54 inline const Foam::List<bool>&
56 {
57  return activeSpecies_;
58 }
59 
60 template<class CompType, class ThermoType>
63 {
64  return NsSimp_;
65 }
66 
67 
68 template<class CompType, class ThermoType>
71 {
72  return nSpecie_;
73 }
74 
75 
76 template<class CompType, class ThermoType>
77 inline Foam::scalar
79 {
80  return tolerance_;
81 }
82 
83 
84 // ************************************************************************* //
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
const List< bool > & activeSpecies() const
Return the active species.
scalar tolerance() const
Return the tolerance.
bool active() const
Is mechanism reduction active?
bool log() const
Is performance data logging enabled?
label NsSimp()
Return the number of active species.
label nSpecie()
Return the initial number of species.