src/lagrangian/intermediate/phaseProperties/phasePropertiesList/phasePropertiesList.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::phasePropertiesList
  27
  28 Description
  29     Simple container for a list of phase properties
  30
  31 SourceFiles
  32     phasePropertiesList.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef phasePropertiesList_H
  37 #define phasePropertiesList_H
  38
  39 #include "Istream.H"
  40 #include "volFields.H"
  41 #include "wordList.H"
  42 #include "phaseProperties.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                     Class phasePropertiesList Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class phasePropertiesList
  54 {
  55     // Private data
  56
  57         //- List of phase properties
  58         List<phaseProperties> props_;
  59
  60         //- List of word representation of phase types
  61         wordList phaseTypeNames_;
  62
  63         //- List of state labels
  64         wordList stateLabels_;
  65
  66
  67 public:
  68
  69     //- Constructor
  70     phasePropertiesList
  71     (
  72         Istream& is,
  73         const wordList& gasNames,
  74         const wordList& liquidNames,
  75         const wordList& solidNames
  76     );
  77
  78     //- Destructor
  79     ~phasePropertiesList();
  80
  81
  82     // Public member functions
  83
  84         //- Return the list of phase properties
  85         const List<phaseProperties>& props() const;
  86
  87         //- Return the list of word representation of phase types
  88         const wordList& phaseTypes() const;
  89
  90         //- Return the list of state labels
  91         const wordList& stateLabels() const;
  92
  93         //- Return the size (number of phases)
  94         label size() const;
  95
  96
  97     // Member operators
  98
  99         const phaseProperties& operator[](const label) const;
 100 };
 101
 102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 103
 104 } // End namespace Foam
 105
 106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 107
 108 #endif
 109
 110 // ************************************************************************* //