src/lagrangian/intermediate/submodels/Reacting/CompositionModel/CompositionModel/CompositionModel.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::CompositionModel
  27
  28 Description
  29     Templated reacting parcel composition model class
  30     Consists of carrier species (via thermo package), and additional liquids
  31     and solids
  32
  33 SourceFiles
  34     CompositionModel.C
  35     NewCompositionModel.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef CompositionModel_H
  40 #define CompositionModel_H
  41
  42 #include "IOdictionary.H"
  43 #include "autoPtr.H"
  44 #include "runTimeSelectionTables.H"
  45
  46 #include "PtrList.H"
  47 #include "multiComponentMixture.H"
  48
  49 #include "liquidMixture.H"
  50 #include "solidMixture.H"
  51
  52 #include "phasePropertiesList.H"
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 namespace Foam
  57 {
  58
  59 /*---------------------------------------------------------------------------*\
  60                        Class CompositionModel Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class CloudType>
  64 class CompositionModel
  65 {
  66     // Private data
  67
  68         //- The cloud dictionary
  69         const dictionary& dict_;
  70
  71         //- Reference to the owner injection class
  72         CloudType& owner_;
  73
  74         //- The coefficients dictionary
  75         const dictionary& coeffDict_;
  76
  77         //- Reference to the multi-component carrier phase thermo
  78         multiComponentMixture<typename CloudType::thermoType>& mcCarrierThermo_;
  79
  80         //- Global (additional) liquid properties data
  81         autoPtr<liquidMixture> liquids_;
  82
  83         //- Global (additional) solid properties data
  84         autoPtr<solidMixture> solids_;
  85
  86         //- List of phase properties
  87         phasePropertiesList phaseProps_;
  88
  89
  90 public:
  91
  92     //- Runtime type information
  93     TypeName("CompositionModel");
  94
  95     //- Declare runtime constructor selection table
  96     declareRunTimeSelectionTable
  97     (
  98         autoPtr,
  99         CompositionModel,
 100         dictionary,
 101         (
 102             const dictionary& dict,
 103             CloudType& owner
 104         ),
 105         (dict, owner)
 106     );
 107
 108
 109     // Constructors
 110
 111         //- Construct from dictionary
 112         CompositionModel
 113         (
 114             const dictionary& dict,
 115             CloudType& owner,
 116             const word& type
 117         );
 118
 119
 120     //- Destructor
 121     virtual ~CompositionModel();
 122
 123
 124     //- Selector
 125     static autoPtr<CompositionModel<CloudType> > New
 126     (
 127         const dictionary& dict,
 128         CloudType& owner
 129     );
 130
 131
 132     // Member Functions
 133
 134         // Access
 135
 136             //- Return the cloud object
 137             const CloudType& owner() const;
 138
 139             //- Return the cloud dictionary
 140             const dictionary& dict() const;
 141
 142             //- Return the coefficients dictionary
 143             const dictionary& coeffDict() const;
 144
 145             //- Return the carrier phase thermo package
 146             const multiComponentMixture<typename CloudType::thermoType>&
 147                 mcCarrierThermo() const;
 148
 149
 150             // Composition lists
 151
 152                 //- Return the global (additional) liquids
 153                 const liquidMixture& liquids() const;
 154
 155                 //- Return the global (additional) solids
 156                 const solidMixture& solids() const;
 157
 158                 //- Return the list of phase properties
 159                 const phasePropertiesList& phaseProps() const;
 160
 161                 //- Return the number of phases
 162                 label nPhase() const;
 163
 164
 165             // Phase properties
 166
 167                 //- Return the list of phase type names
 168                 //  If only 1 phase, return the component names of that phase
 169                 const wordList& phaseTypes() const;
 170
 171                 //- Return the list of state labels (s), (l), (g) etc.
 172                 const wordList& stateLabels() const;
 173
 174                 //- Return the list of component names for phaseI
 175                 const wordList& componentNames(const label phaseI) const;
 176
 177                 //- Return global id of component cmptName in carrier thermo
 178                 label globalCarrierId(const word& cmptName) const;
 179
 180                 //- Return global id of component cmptName in phase phaseI
 181                 label globalId(const label phaseI, const word& cmptName) const;
 182
 183                 //- Return global ids of for phase phaseI
 184                 const labelList& globalIds(const label phaseI) const;
 185
 186                 //- Return local id of component cmptName in phase phaseI
 187                 label localId(const label phaseI, const word& cmptName) const;
 188
 189                 //- Return global carrier id of component given local id
 190                 label localToGlobalCarrierId
 191                 (
 192                     const label phaseI,
 193                     const label id
 194                 ) const;
 195
 196                 //- Return the list of phase phaseI mass fractions
 197                 const scalarField& Y0(const label phaseI) const;
 198
 199                 //- Return the list of phase phaseI volume fractions fractions
 200                 //  based on supplied mass fractions Y
 201                 scalarField X
 202                 (
 203                     const label phaseI,
 204                     const scalarField& Y
 205                 ) const;
 206
 207
 208             // Mixture properties
 209
 210                 //- Return the list of mixture mass fractions
 211                 //  If only 1 phase, return component fractions of that phase
 212                 virtual const scalarField& YMixture0() const = 0;
 213
 214                 // Indices of gas, liquid and solid phases in phase properties
 215                 // list - returns -1 if not applicable
 216
 217                     //- Gas id
 218                     virtual label idGas() const = 0;
 219
 220                     //- Liquid id
 221                     virtual label idLiquid() const = 0;
 222
 223                     //- Solid id
 224                     virtual label idSolid() const = 0;
 225
 226
 227         // Evaluation
 228
 229             //- Return enthalpy for the phase phaseI
 230             virtual scalar H
 231             (
 232                 const label phaseI,
 233                 const scalarField& Y,
 234                 const scalar p,
 235                 const scalar T
 236             ) const;
 237
 238             //- Return specific heat caoacity for the phase phaseI
 239             virtual scalar cp
 240             (
 241                 const label phaseI,
 242                 const scalarField& Y,
 243                 const scalar p,
 244                 const scalar T
 245             ) const;
 246
 247             //- Return latent heat for the phase phaseI
 248             virtual scalar L
 249             (
 250                 const label phaseI,
 251                 const scalarField& Y,
 252                 const scalar p,
 253                 const scalar T
 254             ) const;
 255 };
 256
 257
 258 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 259
 260 } // End namespace Foam
 261
 262 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 263
 264 #define makeCompositionModel(CloudType)                                       \
 265                                                                               \
 266     defineNamedTemplateTypeNameAndDebug                                       \
 267     (                                                                         \
 268         CompositionModel<CloudType>,                                          \
 269         0                                                                     \
 270     );                                                                        \
 271                                                                               \
 272     defineTemplateRunTimeSelectionTable                                       \
 273     (                                                                         \
 274         CompositionModel<CloudType>,                                          \
 275         dictionary                                                            \
 276     );
 277
 278
 279 #define makeCompositionModelThermoType(SS, CloudType, ParcelType, ThermoType) \
 280                                                                               \
 281     defineNamedTemplateTypeNameAndDebug                                       \
 282     (                                                                         \
 283         SS<CloudType<ParcelType<ThermoType> > >,                              \
 284         0                                                                     \
 285     );                                                                        \
 286                                                                               \
 287     CompositionModel<CloudType<ParcelType<ThermoType> > >::                   \
 288         adddictionaryConstructorToTable                                       \
 289             <SS<CloudType<ParcelType<ThermoType> > > >                        \
 290             add##SS##CloudType##ParcelType##ThermoType##ConstructorToTable_;
 291
 292
 293 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 294
 295 #ifdef NoRepository
 296 #   include "CompositionModel.C"
 297 #endif
 298
 299 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 300
 301 #endif
 302
 303 // ************************************************************************* //