00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 1991-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::substance 00026 00027 Description 00028 00029 SourceFiles 00030 substanceI.H 00031 substance.C 00032 substanceIO.C 00033 00034 \*---------------------------------------------------------------------------*/ 00035 00036 #ifndef substance_H 00037 #define substance_H 00038 00039 #include <OpenFOAM/scalar.H> 00040 #include <OpenFOAM/word.H> 00041 #include <OpenFOAM/Istream.H> 00042 00043 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00044 00045 namespace Foam 00046 { 00047 00048 /*---------------------------------------------------------------------------*\ 00049 Class substance Declaration 00050 \*---------------------------------------------------------------------------*/ 00051 00052 class substance 00053 { 00054 // Private data 00055 00056 word name_; 00057 scalar volFrac_; 00058 00059 00060 public: 00061 00062 // Constructors 00063 00064 //- Construct null 00065 substance() 00066 {} 00067 00068 00069 // Member Functions 00070 00071 // Access 00072 00073 const word& name() const 00074 { 00075 return name_; 00076 } 00077 00078 scalar volFrac() const 00079 { 00080 return volFrac_; 00081 } 00082 00083 bool operator==(const substance& s) const 00084 { 00085 return name_ == s.name_ && volFrac_ == s.volFrac_; 00086 } 00087 00088 bool operator!=(const substance& s) const 00089 { 00090 return !operator==(s); 00091 } 00092 00093 00094 // IOstream Operators 00095 00096 friend Istream& operator>>(Istream& is, substance& s) 00097 { 00098 is >> s.name_ >> s.volFrac_; 00099 return is; 00100 } 00101 00102 friend Ostream& operator<<(Ostream& os, const substance& s) 00103 { 00104 os << s.name_ << token::SPACE << s.volFrac_; 00105 return os; 00106 } 00107 }; 00108 00109 00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00111 00112 } // End namespace Foam 00113 00114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00115 00116 #endif 00117 00118 // ************************ vim: set sw=4 sts=4 et: ************************ //
