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

mixture.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) 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::mixture
00026 
00027 Description
00028 
00029 SourceFiles
00030     mixtureI.H
00031     mixture.C
00032     mixtureIO.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef mixture_H
00037 #define mixture_H
00038 
00039 #include <OpenFOAM/error.H>
00040 
00041 #include <OpenFOAM/List.H>
00042 #include "substance.H"
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                            Class mixture Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 class mixture
00054 :
00055     public List<substance>
00056 {
00057     // Private data
00058 
00059         word name_;
00060 
00061 
00062 public:
00063 
00064     // Constructors
00065 
00066         //- Construct from Istream
00067         mixture(Istream& is)
00068         :
00069             List<substance>(is),
00070             name_(is)
00071         {
00072             scalar volTot = 0;
00073 
00074             for (label i = 0; i < size(); i++)
00075             {
00076                 volTot += operator[](i).volFrac();
00077             }
00078 
00079             if (volTot > 1.001 || volTot < 0.999)
00080             {
00081                 FatalErrorIn("mixture::mixture(istream& is)")
00082                     << "Sum of volume fractions for Mixture " << name_
00083                     << " = " << volTot << endl
00084                     << "Should equal one."
00085                     << abort(FatalError);
00086             }
00087         }
00088 
00089 
00090     // Member Functions
00091 
00092         // Access
00093 
00094             const word& name() const
00095             {
00096                 return name_;
00097             }
00098 };
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