src/lagrangian/intermediate/submodels/Reacting/CompositionModel/SingleMixtureFraction/SingleMixtureFraction.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::SingleMixtureFraction
  27
  28 Description
  29     Templated parcel multi-phase, multi-component class
  30
  31 SourceFiles
  32     SingleMixtureFraction.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef SingleMixtureFraction_H
  37 #define SingleMixtureFraction_H
  38
  39 #include "CompositionModel.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                       Class SingleMixtureFraction Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 template<class CloudType>
  51 class SingleMixtureFraction
  52 :
  53     public CompositionModel<CloudType>
  54 {
  55     // Private data
  56
  57         // Indices of the phases
  58
  59             //- Gas
  60             label idGas_;
  61
  62             //- Liquid
  63             label idLiquid_;
  64
  65             //- Solid
  66             label idSolid_;
  67
  68
  69        // Mixture properties
  70
  71             //- Phase component total fractions
  72             scalarField YMixture0_;
  73
  74
  75     // Private member functions
  76
  77         //- Construct the indices and check correct specification of
  78         //  1 gas, 1 liquid and 1 solid
  79         void constructIds();
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("SingleMixtureFraction");
  86
  87
  88     // Constructors
  89
  90         //- Construct from dictionary
  91         SingleMixtureFraction(const dictionary& dict, CloudType& owner);
  92
  93
  94     //- Destructor
  95     virtual ~SingleMixtureFraction();
  96
  97
  98     // Member Functions
  99
 100         // Access
 101
 102             // Gas properties
 103
 104                 //- Return the list of gas mass fractions
 105                 const scalarField& YGas0() const;
 106
 107                 //- Return the total gas mass fraction
 108                 scalar YGasTot0() const;
 109
 110
 111             // Liquid properties
 112
 113                 //- Return the list of liquid mass fractions
 114                 const scalarField& YLiquid0() const;
 115
 116                 //- Return the total liquid mass fraction
 117                 scalar YLiquidTot0() const;
 118
 119
 120             // Solid properties
 121
 122                 //- Return the list of solid mass fractions
 123                 const scalarField& YSolid0() const;
 124
 125                 //- Return the total solid mass fraction
 126                 scalar YSolidTot0() const;
 127
 128
 129             // Mixture properties
 130
 131                 //- Return the list of mixture mass fractions
 132                 virtual const scalarField& YMixture0() const;
 133
 134                 // Indices of gas, liquid and solid phases in phase properties
 135                 // list
 136
 137                     //- Gas id
 138                     virtual label idGas() const;
 139
 140                     //- Liquid id
 141                     virtual label idLiquid() const;
 142
 143                     //- Solid id
 144                     virtual label idSolid() const;
 145 };
 146
 147
 148 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 149
 150 #ifdef NoRepository
 151 #   include "SingleMixtureFraction.C"
 152 #endif
 153
 154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 155
 156 } // End namespace Foam
 157
 158 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 159
 160 #endif
 161
 162 // ************************************************************************* //