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