laminarFlameSpeed.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/>.
 
Namespace
    Foam::laminarFlameSpeedModels
 
Description
    Namespace for laminar flame speed models
 
 
Class
    Foam::laminarFlameSpeed
 
Description
    Abstract class for laminar flame speed
 
SourceFiles
    laminarFlameSpeed.C
    laminarFlameSpeedNew.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef laminarFlameSpeed_H
#define laminarFlameSpeed_H
 
#include "psiuMulticomponentThermo.H"
#include "runTimeSelectionTables.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                      Class laminarFlameSpeed Declaration
\*---------------------------------------------------------------------------*/
 
class laminarFlameSpeed
{
protected:
 
    // Protected data
 
        const psiuMulticomponentThermo& psiuMulticomponentThermo_;
 
        //- Equivalence ratio of a homogeneous mixture
        scalar equivalenceRatio_;
 
 
public:
 
    //- Runtime type information
    TypeName("laminarFlameSpeed");
 
 
    // Declare run-time constructor selection table
 
        declareRunTimeSelectionTable
        (
            autoPtr,
            laminarFlameSpeed,
            dictionary,
            (
                const dictionary& dict,
                const dictionary& coeffDict,
                const psiuMulticomponentThermo& ct
            ),
            (dict, coeffDict, ct)
        );
 
 
    // Constructors
 
        //- Construct from dictionary and psiuMulticomponentThermo
        laminarFlameSpeed
        (
            const dictionary&,
            const psiuMulticomponentThermo&
        );
 
        //- Disallow default bitwise copy construction
        laminarFlameSpeed(const laminarFlameSpeed&) = delete;
 
 
    // Selector
 
        static autoPtr<laminarFlameSpeed> New
        (
            const dictionary&,
            const psiuMulticomponentThermo&
        );
 
 
    //- Destructor
    virtual ~laminarFlameSpeed();
 
 
    // Member Operators
 
        //- Return the laminar flame speed [m/s]
        virtual tmp<volScalarField> operator()() const = 0;
 
        //- Disallow default bitwise assignment
        void operator=(const laminarFlameSpeed&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //