MulticomponentPhaseModel.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) 2015-2025 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::MulticomponentPhaseModel
 
Description
    Class which represents a phase with multiple species. Returns the species'
    mass fractions, and their governing equations.
 
SourceFiles
    MulticomponentPhaseModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef MulticomponentPhaseModel_H
#define MulticomponentPhaseModel_H
 
#include "phaseModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                  Class MulticomponentPhaseModel Declaration
\*---------------------------------------------------------------------------*/
 
template<class BasePhaseModel>
class MulticomponentPhaseModel
:
    public BasePhaseModel
{
public:
 
    // Constructors
 
        MulticomponentPhaseModel
        (
            const phaseSystem& fluid,
            const word& phaseName,
            const bool referencePhase,
            const label index
        );
 
 
    //- Destructor
    virtual ~MulticomponentPhaseModel();
 
 
    // Member Functions
 
        //- Correct the species fractions
        virtual void correctSpecies();
 
 
        // Species
 
            //- Return whether the phase is pure (i.e., not multi-component)
            virtual bool pure() const;
 
            //- Return the species fraction equation
            virtual tmp<fvScalarMatrix> YiEqn(volScalarField& Yi);
 
            //- Return the species mass fractions
            virtual const PtrList<volScalarField>& Y() const;
 
            //- Return a species mass fraction by index
            virtual const volScalarField& Y(const label speciei) const;
 
            //- Return a species mass fraction by name
            virtual const volScalarField& Y(const word& name) const;
 
            //- Access the species mass fractions
            virtual PtrList<volScalarField>& YRef();
 
            //- Should the given specie be solved for? I.e., is it active and
            //  not the default specie?
            virtual bool solveSpecie(const label speciei) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "MulticomponentPhaseModel.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //