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

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