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

basicMultiComponentMixtureI.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 \*---------------------------------------------------------------------------*/
00025 
00026 inline Foam::PtrList<Foam::volScalarField>&
00027 Foam::basicMultiComponentMixture::Y()
00028 {
00029     return Y_;
00030 }
00031 
00032 
00033 inline const Foam::PtrList<Foam::volScalarField>&
00034 Foam::basicMultiComponentMixture::Y() const
00035 {
00036     return Y_;
00037 }
00038 
00039 
00040 inline Foam::volScalarField& Foam::basicMultiComponentMixture::Y(const label i)
00041 {
00042     return Y_[i];
00043 }
00044 
00045 
00046 inline const Foam::volScalarField& Foam::basicMultiComponentMixture::Y
00047 (
00048     const label i
00049 ) const
00050 {
00051     return Y_[i];
00052 }
00053 
00054 
00055 inline Foam::volScalarField& Foam::basicMultiComponentMixture::Y
00056 (
00057     const word& specieName
00058 )
00059 {
00060     return Y_[species_[specieName]];
00061 }
00062 
00063 
00064 inline const Foam::volScalarField& Foam::basicMultiComponentMixture::Y
00065 (
00066     const word& specieName
00067 ) const
00068 {
00069     return Y_[species_[specieName]];
00070 }
00071 
00072 
00073 inline bool Foam::basicMultiComponentMixture::contains
00074 (
00075     const word& specieName
00076 ) const
00077 {
00078     return species_.contains(specieName);
00079 }
00080 
00081 
00082 inline Foam::scalar Foam::basicMultiComponentMixture::fres
00083 (
00084     const scalar ft,
00085     const scalar stoicRatio
00086 ) const
00087 {
00088     return max(ft - (1.0 - ft)/stoicRatio, 0.0);
00089 }
00090 
00091 
00092 inline Foam::tmp<Foam::volScalarField> Foam::basicMultiComponentMixture::fres
00093 (
00094     const volScalarField& ft,
00095     const dimensionedScalar& stoicRatio
00096 ) const
00097 {
00098     return max(ft - (scalar(1) - ft)/stoicRatio.value(), scalar(0));
00099 }
00100 
00101 
00102 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines