src/thermophysicalModels/reactionThermo/mixtures/basicMultiComponentMixture/basicMultiComponentMixtureI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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 \*---------------------------------------------------------------------------*/
  25
  26 inline Foam::PtrList<Foam::volScalarField>&
  27 Foam::basicMultiComponentMixture::Y()
  28 {
  29     return Y_;
  30 }
  31
  32
  33 inline const Foam::PtrList<Foam::volScalarField>&
  34 Foam::basicMultiComponentMixture::Y() const
  35 {
  36     return Y_;
  37 }
  38
  39
  40 inline Foam::volScalarField& Foam::basicMultiComponentMixture::Y(const label i)
  41 {
  42     return Y_[i];
  43 }
  44
  45
  46 inline const Foam::volScalarField& Foam::basicMultiComponentMixture::Y
  47 (
  48     const label i
  49 ) const
  50 {
  51     return Y_[i];
  52 }
  53
  54
  55 inline Foam::volScalarField& Foam::basicMultiComponentMixture::Y
  56 (
  57     const word& specieName
  58 )
  59 {
  60     return Y_[species_[specieName]];
  61 }
  62
  63
  64 inline const Foam::volScalarField& Foam::basicMultiComponentMixture::Y
  65 (
  66     const word& specieName
  67 ) const
  68 {
  69     return Y_[species_[specieName]];
  70 }
  71
  72
  73 inline bool Foam::basicMultiComponentMixture::contains
  74 (
  75     const word& specieName
  76 ) const
  77 {
  78     return species_.contains(specieName);
  79 }
  80
  81
  82 inline Foam::scalar Foam::basicMultiComponentMixture::fres
  83 (
  84     const scalar ft,
  85     const scalar stoicRatio
  86 ) const
  87 {
  88     return max(ft - (1.0 - ft)/stoicRatio, 0.0);
  89 }
  90
  91
  92 inline Foam::tmp<Foam::volScalarField> Foam::basicMultiComponentMixture::fres
  93 (
  94     const volScalarField& ft,
  95     const dimensionedScalar& stoicRatio
  96 ) const
  97 {
  98     return max(ft - (scalar(1) - ft)/stoicRatio.value(), scalar(0));
  99 }
 100
 101
 102 // ************************************************************************* //