constant.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) 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::XiEqModels::constant
 
Description
    Simple constant model for the equilibrium flame wrinkling \c XiEq
 
    Reference:
    \verbatim
        Weller, H. G. (1993).
        The development of a new flame area combustion model
        using conditional averaging.
        Thermo-fluids section report TF 9307.
    \endverbatim
 
SourceFiles
    constant.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef constant_H
#define constant_H
 
#include "XiEqModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace XiEqModels
{
 
/*---------------------------------------------------------------------------*\
                           Class constant Declaration
\*---------------------------------------------------------------------------*/
 
class constant
:
    public XiEqModel
{
    // Private Data
 
        //- Specified equilibrium flame-wrinkling value
        dimensionedScalar XiEq_;
 
 
protected:
 
        //- Update coefficients from given dictionary
        virtual bool readCoeffs(const dictionary& dict);
 
 
public:
 
    //- Runtime type information
    TypeName("constant");
 
 
    // Constructors
 
        //- Construct from components
        constant
        (
            const dictionary& dict,
            const psiuMulticomponentThermo& thermo,
            const fluidThermoThermophysicalTransportModel& turbulence,
            const volScalarField& Su
        );
 
        //- Disallow default bitwise copy construction
        constant(const constant&) = delete;
 
 
    //- Destructor
    virtual ~constant();
 
 
    // Member Functions
 
        //- Return the flame-wrinkling XiEq
        virtual tmp<volScalarField> XiEq() const;
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const constant&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace XiEqModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //