Files
openfoam/src/combustionModels/combustionModel/combustionModel.H
2019-02-06 12:28:23 +00:00

183 lines
4.9 KiB
C++

/*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration |
\\ / A nd |
\\/ 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
Group
grpCombustionModels
Description
Base class for combustion models
SourceFiles
combustionModel.C
\*---------------------------------------------------------------------------*/
#ifndef combustionModel_H
#define combustionModel_H
#include "IOdictionary.H"
#include "turbulentFluidThermoModel.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class combustionModel Declaration
\*---------------------------------------------------------------------------*/
class combustionModel
:
public IOdictionary
{
// Private Member Functions
//- No copy construct
combustionModel(const combustionModel&) = delete;
//- No copy assignment
void operator=(const combustionModel&) = delete;
//- Construct the base IO object
IOobject createIOobject
(
basicThermo& thermo,
const word& combustionProperties
) const;
protected:
// Protected data
//- Reference to the mesh database
const fvMesh& mesh_;
//- Reference to the turbulence model
const compressibleTurbulenceModel& turb_;
//- Active
Switch active_;
//- Dictionary of the model
dictionary coeffs_;
//- Model type
const word modelType_;
public:
//- Runtime type information
TypeName("combustionModel");
//- Default combustionProperties dictionary name
static const word combustionPropertiesName;
// Constructors
//- Construct from components
combustionModel
(
const word& modelType,
basicThermo& thermo,
const compressibleTurbulenceModel& turb,
const word& combustionProperties=combustionPropertiesName
);
// Selectors
//- Generic New for each of the related chemistry model
template<class CombustionModel>
static autoPtr<CombustionModel> New
(
typename CombustionModel::reactionThermo& thermo,
const compressibleTurbulenceModel& turb,
const word& combustionProperties
);
//- Destructor
virtual ~combustionModel();
// Member Functions
//- Return const access to the mesh database
inline const fvMesh& mesh() const;
//- Return access to turbulence
inline const compressibleTurbulenceModel& turbulence() const;
//- Return const access to rho
inline const volScalarField& rho() const;
//- Return const access to phi
inline tmp<surfaceScalarField> phi() const;
//- Is combustion active?
inline const Switch& active() const;
//- Return const dictionary of the model
inline const dictionary& coeffs() const;
//- Correct combustion rate
virtual void correct() = 0;
//- Fuel consumption rate matrix, i.e. source term for fuel equation
virtual tmp<fvScalarMatrix> R(volScalarField& Y) const = 0;
//- Heat release rate [kg/m/s3]
virtual tmp<volScalarField> Qdot() const = 0;
//- Update properties from given dictionary
virtual bool read();
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "combustionModelI.H"
#ifdef NoRepository
#include "combustionModelTemplates.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //