basicCombustionMixtureI.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) 2014-2015 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 \*---------------------------------------------------------------------------*/
27 
28 inline Foam::scalar Foam::basicCombustionMixture::fres
29 (
30  const scalar ft,
31  const scalar stoicRatio
32 ) const
33 {
34  return max(ft - (scalar(1) - ft)/stoicRatio, scalar(0));
35 }
36 
37 
38 inline Foam::tmp<Foam::volScalarField> Foam::basicCombustionMixture::fres
39 (
40  const volScalarField& ft,
41  const dimensionedScalar& stoicRatio
42 ) const
43 {
44  return max(ft - (scalar(1) - ft)/stoicRatio.value(), scalar(0));
45 }
46 
47 
48 // ************************************************************************* //
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
Foam::dimensioned::value
const Type & value() const
Return const reference to value.
Definition: dimensionedType.C:434
Foam::max
label max(const labelHashSet &set, label maxValue=labelMin)
Find the max value in labelHashSet, optionally limited by second argument.
Definition: hashSets.C:47
Foam::dimensioned< scalar >
Foam::GeometricField< scalar, fvPatchField, volMesh >
Foam::basicCombustionMixture::fres
scalar fres(const scalar ft, const scalar stoicRatio) const
Definition: basicCombustionMixtureI.H:29