phasePropertiesList.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
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 "Istream.H"
39 #include "volFields.H"
40 #include "wordList.H"
41 #include "phaseProperties.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  // Constructors
69 
70  //- Construct null
72 
73  //- Construct from components
75  (
76  Istream& is,
77  const wordList& gasNames,
78  const wordList& liquidNames,
79  const wordList& solidNames
80  );
81 
82 
83  //- Destructor
85 
86 
87  // Public Member Functions
88 
89  //- Return the list of phase properties
90  const List<phaseProperties>& props() const;
91 
92  //- Return the list of word representation of phase types
93  const wordList& phaseTypes() const;
94 
95  //- Return the list of state labels
96  const wordList& stateLabels() const;
97 
98  //- Return the size (number of phases)
99  label size() const;
100 
101 
102  // Member Operators
103 
104  const phaseProperties& operator[](const label) const;
105 };
106 
107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 
109 } // End namespace Foam
110 
111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 
113 #endif
114 
115 // ************************************************************************* //
label size() const
Return the size (number of phases)
const phaseProperties & operator[](const label) const
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A 1D array of objects of type <T>, where the size of the vector is known and used for subscript bound...
Definition: HashTable.H:59
Helper class to manage multi-specie phase properties.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
const wordList & phaseTypes() const
Return the list of word representation of phase types.
const wordList & stateLabels() const
Return the list of state labels.
phasePropertiesList()
Construct null.
Simple container for a list of phase properties.
const List< phaseProperties > & props() const
Return the list of phase properties.
Namespace for OpenFOAM.