FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

phasePropertiesList.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 2008-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::phasePropertiesList
00026 
00027 Description
00028     Simple container for a list of phase properties
00029 
00030 SourceFiles
00031     phasePropertiesList.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef phasePropertiesList_H
00036 #define phasePropertiesList_H
00037 
00038 #include <OpenFOAM/Istream.H>
00039 #include <finiteVolume/volFields.H>
00040 #include <OpenFOAM/wordList.H>
00041 #include <lagrangianIntermediate/phaseProperties.H>
00042 
00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00044 
00045 namespace Foam
00046 {
00047 
00048 /*---------------------------------------------------------------------------*\
00049                     Class phasePropertiesList Declaration
00050 \*---------------------------------------------------------------------------*/
00051 
00052 class phasePropertiesList
00053 {
00054     // Private data
00055 
00056         //- List of phase properties
00057         List<phaseProperties> props_;
00058 
00059         //- List of word representation of phase types
00060         wordList phaseTypeNames_;
00061 
00062         //- List of state labels
00063         wordList stateLabels_;
00064 
00065 
00066 public:
00067 
00068     //- Constructor
00069     phasePropertiesList
00070     (
00071         Istream& is,
00072         const wordList& gasNames,
00073         const wordList& liquidNames,
00074         const wordList& solidNames
00075     );
00076 
00077     //- Destructor
00078     ~phasePropertiesList();
00079 
00080 
00081     // Public member functions
00082 
00083         //- Return the list of phase properties
00084         const List<phaseProperties>& props() const;
00085 
00086         //- Return the list of word representation of phase types
00087         const wordList& phaseTypes() const;
00088 
00089         //- Return the list of state labels
00090         const wordList& stateLabels() const;
00091 
00092         //- Return the size (number of phases)
00093         label size() const;
00094 
00095 
00096     // Member operators
00097 
00098         const phaseProperties& operator[](const label) const;
00099 };
00100 
00101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00102 
00103 } // End namespace Foam
00104 
00105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00106 
00107 #endif
00108 
00109 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines