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

SingleMixtureFraction.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::SingleMixtureFraction
00026 
00027 Description
00028     Templated parcel multi-phase, multi-component class
00029 
00030 SourceFiles
00031     SingleMixtureFraction.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef SingleMixtureFraction_H
00036 #define SingleMixtureFraction_H
00037 
00038 #include <lagrangianIntermediate/CompositionModel.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                       Class SingleMixtureFraction Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 template<class CloudType>
00050 class SingleMixtureFraction
00051 :
00052     public CompositionModel<CloudType>
00053 {
00054     // Private data
00055 
00056         // Indices of the phases
00057 
00058             //- Gas
00059             label idGas_;
00060 
00061             //- Liquid
00062             label idLiquid_;
00063 
00064             //- Solid
00065             label idSolid_;
00066 
00067 
00068        // Mixture properties
00069 
00070             //- Phase component total fractions
00071             scalarField YMixture0_;
00072 
00073 
00074     // Private member functions
00075 
00076         //- Construct the indices and check correct specification of
00077         //  1 gas, 1 liquid and 1 solid
00078         void constructIds();
00079 
00080 
00081 public:
00082 
00083     //- Runtime type information
00084     TypeName("SingleMixtureFraction");
00085 
00086 
00087     // Constructors
00088 
00089         //- Construct from dictionary
00090         SingleMixtureFraction(const dictionary& dict, CloudType& owner);
00091 
00092 
00093     //- Destructor
00094     virtual ~SingleMixtureFraction();
00095 
00096 
00097     // Member Functions
00098 
00099         // Access
00100 
00101             // Gas properties
00102 
00103                 //- Return the list of gas mass fractions
00104                 const scalarField& YGas0() const;
00105 
00106                 //- Return the total gas mass fraction
00107                 scalar YGasTot0() const;
00108 
00109 
00110             // Liquid properties
00111 
00112                 //- Return the list of liquid mass fractions
00113                 const scalarField& YLiquid0() const;
00114 
00115                 //- Return the total liquid mass fraction
00116                 scalar YLiquidTot0() const;
00117 
00118 
00119             // Solid properties
00120 
00121                 //- Return the list of solid mass fractions
00122                 const scalarField& YSolid0() const;
00123 
00124                 //- Return the total solid mass fraction
00125                 scalar YSolidTot0() const;
00126 
00127 
00128             // Mixture properties
00129 
00130                 //- Return the list of mixture mass fractions
00131                 virtual const scalarField& YMixture0() const;
00132 
00133                 // Indices of gas, liquid and solid phases in phase properties
00134                 // list
00135 
00136                     //- Gas id
00137                     virtual label idGas() const;
00138 
00139                     //- Liquid id
00140                     virtual label idLiquid() const;
00141 
00142                     //- Solid id
00143                     virtual label idSolid() const;
00144 };
00145 
00146 
00147 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00148 
00149 #ifdef NoRepository
00150 #   include <lagrangianIntermediate/SingleMixtureFraction.C>
00151 #endif
00152 
00153 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00154 
00155 } // End namespace Foam
00156 
00157 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00158 
00159 #endif
00160 
00161 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines