CombustionModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2017 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::CombustionModel
 
Description
    Combustion models for templated thermodynamics
 
SourceFiles
    CombustionModelI.H
    CombustionModel.C
    CombustionModelNew.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef CombustionModel_H
#define CombustionModel_H
 
#include "combustionModel.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                     class CombustionModel Declaration
\*---------------------------------------------------------------------------*/
 
template<class ReactionThermo>
class CombustionModel
:
    public combustionModel
{
    // Private Member Functions
 
        //- Construct as copy (not implemented)
        CombustionModel(const CombustionModel&) = delete;
 
        //- No copy assignment
        void operator=(const CombustionModel&) = delete;
 
 
public:
 
    //- Thermo type
    typedef ReactionThermo reactionThermo;
 
 
    //- Runtime type information
    TypeName("CombustionModel");
 
 
    //- Declare run-time constructor selection tables
    declareRunTimeSelectionTable
    (
        autoPtr,
        CombustionModel,
        dictionary,
        (
            const word& modelType,
            ReactionThermo& thermo,
            const compressibleTurbulenceModel& turb,
            const word& combustionProperties
        ),
        (modelType, thermo, turb, combustionProperties)
    );
 
 
    // Constructors
 
        //- Construct from components
        CombustionModel
        (
            const word& modelType,
            ReactionThermo& thermo,
            const compressibleTurbulenceModel& turb,
            const word& combustionProperties
        );
 
 
        //- Selector
        static autoPtr<CombustionModel> New
        (
            ReactionThermo& thermo,
            const compressibleTurbulenceModel& turb,
            const word& combustionProperties=combustionPropertiesName
        );
 
 
    //- Destructor
    virtual ~CombustionModel();
 
 
    // Member Functions
 
        //- Return access to the thermo package
        virtual ReactionThermo& thermo() = 0;
 
        //- Return const access to the thermo package
        virtual const ReactionThermo& thermo() const = 0;
 
 
    // IO
 
        //- Update properties from given dictionary
        virtual bool read();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "CombustionModel.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //