src/lagrangian/intermediate/phaseProperties/phaseProperties/phaseProperties.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::phaseProperties
  27
  28 Description
  29     Helper class to manage multi-component phase properties
  30
  31 SourceFiles
  32     phaseProperties.C
  33     phasePropertiesIO.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef phaseProperties_H
  38 #define phaseProperties_H
  39
  40 #include "NamedEnum.H"
  41 #include "Tuple2.H"
  42 #include "PtrList.H"
  43 #include "volFields.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                       Class phaseProperties Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 class phaseProperties
  55 {
  56 public:
  57
  58     // Public data
  59
  60         //- Phase type enumeration
  61         enum phaseType
  62         {
  63             GAS,
  64             LIQUID,
  65             SOLID,
  66             UNKNOWN
  67         };
  68
  69         //- Corresponding word representations for phase type enumerations
  70         static const NamedEnum<phaseType, 4> phaseTypeNames_;
  71
  72
  73 private:
  74
  75    // Private data
  76
  77         //- Phase type
  78         phaseType phase_;
  79
  80         //- State label (s), (l), (g) etc.
  81         word stateLabel_;
  82
  83         //- List of component names
  84         List<word> names_;
  85
  86         //- List of component mass fractions
  87         scalarField Y_;
  88
  89         //- Global ids
  90         labelList globalIds_;
  91
  92         //- Map to carrier global id
  93         labelList globalCarrierIds_;
  94
  95
  96     // Private member functions
  97
  98         //- Set global ids
  99         void setGlobalIds(const wordList& globalNames);
 100
 101         //- Set global carrier ids - attempts to map component names to global
 102         //  carrier species
 103         void setGlobalCarrierIds(const wordList& carrierNames);
 104
 105         //- Check the total mass fraction
 106         void checkTotalMassFraction() const;
 107
 108         //- Set the state label
 109         word phaseToStateLabel(const phaseType pt) const;
 110
 111
 112 public:
 113
 114     // Constructors
 115
 116         //- Null constructor
 117         phaseProperties();
 118
 119         //- Construct from Istream
 120         phaseProperties(Istream&);
 121
 122         //- Construct as copy
 123         phaseProperties(const phaseProperties&);
 124
 125
 126     //- Destructor
 127     ~phaseProperties();
 128
 129
 130     // Public member functions
 131
 132         //- Initialise the global ids
 133         void initialiseGlobalIds
 134         (
 135             const wordList& gasNames,
 136             const wordList& liquidNames,
 137             const wordList& solidNames
 138         );
 139
 140
 141         // Access
 142
 143             //- Return const access to the phase type
 144             phaseType phase() const;
 145
 146             //- Return const access to the phase state label
 147             const word& stateLabel() const;
 148
 149             //- Return word representation of the phase type
 150             word phaseTypeName() const;
 151
 152             //- Return the list of component names
 153             const List<word>& names() const;
 154
 155             //- Return const access to a component name
 156             const word& name(const label cmptI) const;
 157
 158             //- Return const access to all component mass fractions
 159             const scalarField& Y() const;
 160
 161             //- Return non-const access to a component mass fraction
 162             scalar& Y(const label cmptI);
 163
 164             //- Return const access to the global ids
 165             const labelList& globalIds() const;
 166
 167             //- Return const access to the map to the carrier global ids
 168             const labelList& globalCarrierIds() const;
 169
 170             //- Return the global id of a component in the local list by name
 171             //  Returns -1 if not found
 172             label globalId(const word& cmptName) const;
 173
 174             //- Return the id of a component in the local list by name
 175             //  Returns -1 if not found
 176             label id(const word& cmptName) const;
 177
 178
 179     // IOstream Operators
 180
 181         friend Istream& operator>>(Istream&, phaseProperties&);
 182         friend Ostream& operator<<(Ostream&, const phaseProperties&);
 183 };
 184
 185
 186 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 187
 188 } // End namespace Foam
 189
 190 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 191
 192 #endif
 193
 194 // ************************************************************************* //