FreeFOAM The Cross-Platform CFD Toolkit
phasePropertiesList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2008-2010 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::phasePropertiesList
26 
27 Description
28  Simple container for a list of phase properties
29 
30 SourceFiles
31  phasePropertiesList.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef phasePropertiesList_H
36 #define phasePropertiesList_H
37 
38 #include <OpenFOAM/Istream.H>
39 #include <finiteVolume/volFields.H>
40 #include <OpenFOAM/wordList.H>
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class phasePropertiesList Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 {
54  // Private data
55 
56  //- List of phase properties
57  List<phaseProperties> props_;
58 
59  //- List of word representation of phase types
60  wordList phaseTypeNames_;
61 
62  //- List of state labels
63  wordList stateLabels_;
64 
65 
66 public:
67 
68  //- Constructor
70  (
71  Istream& is,
72  const wordList& gasNames,
73  const wordList& liquidNames,
74  const wordList& solidNames
75  );
76 
77  //- Destructor
79 
80 
81  // Public member functions
82 
83  //- Return the list of phase properties
84  const List<phaseProperties>& props() const;
85 
86  //- Return the list of word representation of phase types
87  const wordList& phaseTypes() const;
88 
89  //- Return the list of state labels
90  const wordList& stateLabels() const;
91 
92  //- Return the size (number of phases)
93  label size() const;
94 
95 
96  // Member operators
97 
98  const phaseProperties& operator[](const label) const;
99 };
100 
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102 
103 } // End namespace Foam
104 
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
106 
107 #endif
108 
109 // ************************ vim: set sw=4 sts=4 et: ************************ //