homogeneousMixture.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-2024 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::homogeneousMixture
 
Description
    Combustion mixture for homogeneous lean, stoichiometric or rich conditions
 
    in which the regress variable \c b defines the composition.
 
SourceFiles
    homogeneousMixture.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef homogeneousMixture_H
#define homogeneousMixture_H
 
#include "dimensionedTypes.H"
#include "FieldListSlice.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     Class homogeneousMixture Declaration
\*---------------------------------------------------------------------------*/
 
template<class ThermoType>
class homogeneousMixture
{
public:
 
    // Public Typedefs
 
        //- The type of thermodynamics this mixture is instantiated for
        typedef ThermoType thermoType;
 
        //- Mixing type for thermodynamic properties
        typedef ThermoType thermoMixtureType;
 
        //- Mixing type for transport properties
        typedef ThermoType transportMixtureType;
 
 
private:
 
    // Private Enumerations
 
        //- Specie indices
        enum species { B };
 
 
    // Private Data
 
        //- Reactant thermodynamic model
        thermoType reactants_;
 
        //- Product thermodynamic model
        thermoType products_;
 
        //- Mutable storage for the mixed thermodynamic model
        mutable thermoType mixture_;
 
 
public:
 
    // Constructors
 
        //- Construct from a dictionary
        homogeneousMixture(const dictionary&);
 
        //- Disallow default bitwise copy construction
        homogeneousMixture(const homogeneousMixture<ThermoType>&) = delete;
 
 
    //- Destructor
    virtual ~homogeneousMixture()
    {}
 
 
    // Member Functions
 
        //- Return the instantiated type name
        static word typeName()
        {
            return "homogeneousMixture<" + ThermoType::typeName() + '>';
        }
 
        //- Return the specie names
        static wordList specieNames()
        {
            return {"b"};
        }
 
        //- Return the residual fraction of fuel in the burnt mixture
        scalar fres(const scalarFieldListSlice& Y) const
        {
            return 0;
        }
 
        //- Return the mixture for the given composition
        const thermoType& mixture(const scalar) const;
 
        //- Return the mixture for thermodynamic properties
        const thermoMixtureType& thermoMixture
        (
            const scalarFieldListSlice&
        ) const;
 
        //- Return the mixture for transport properties
        const transportMixtureType& transportMixture
        (
            const scalarFieldListSlice&
        ) const;
 
        //- Return the mixture for transport properties
        const transportMixtureType& transportMixture
        (
            const scalarFieldListSlice&,
            const thermoMixtureType&
        ) const;
 
        //- Return the reactant mixture
        const thermoType& reactants(const scalarFieldListSlice&) const;
 
        //- Return the product mixture
        const thermoType& products(const scalarFieldListSlice&) const;
 
        //- Reset the mixture to an unburnt state not implemented
        void reset(PtrList<volScalarField>& Y) const
        {
            NotImplemented;
        }
 
        //- Read dictionary
        void read(const dictionary&);
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const homogeneousMixture<ThermoType>&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 
#ifdef NoRepository
    #include "homogeneousMixture.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //