basicSolidChemistryModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2013-2015 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::basicSolidChemistryModel
 
Description
    Chemistry model for solid thermodynamics
 
SourceFiles
    basicSolidChemistryModelI.H
    basicSolidChemistryModel.C
    newChemistrySolidModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef basicSolidChemistryModel_H
#define basicSolidChemistryModel_H
 
#include "basicChemistryModel.H"
#include "autoPtr.H"
#include "runTimeSelectionTables.H"
#include "solidReactionThermo.H"
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of classes
class fvMesh;
 
/*---------------------------------------------------------------------------*\
                     class basicSolidChemistryModel Declaration
\*---------------------------------------------------------------------------*/
 
class basicSolidChemistryModel
:
    public basicChemistryModel
{
    // Private Member Functions
 
        //- Construct as copy (not implemented)
        basicSolidChemistryModel(const basicSolidChemistryModel&);
 
        //- Disallow default bitwise assignment
        void operator=(const basicSolidChemistryModel&);
 
 
protected:
 
    // Protected data
 
        //- Solid thermo package
        autoPtr<solidReactionThermo> solidThermo_;
 
 
public:
 
    //- Runtime type information
    TypeName("basicSolidChemistryModel");
 
 
    //- Declare run-time constructor selection tables
    declareRunTimeSelectionTable
    (
        autoPtr,
        basicSolidChemistryModel,
        fvMesh,
        (const fvMesh& mesh, const word& phaseName),
        (mesh, phaseName)
    );
 
 
    // Constructors
 
        //- Construct from mesh
        basicSolidChemistryModel(const fvMesh& mesh, const word& phaseName);
 
 
    //- Selector
    static autoPtr<basicSolidChemistryModel> New
    (
        const fvMesh& mesh,
        const word& phaseName=word::null
    );
 
 
    //- Destructor
    virtual ~basicSolidChemistryModel();
 
 
    // Member Functions
 
        //- Return access to the solid thermo package
        inline solidReactionThermo& solidThermo();
 
        //- Return const access to the solid thermo package
        inline const solidReactionThermo& solidThermo() const;
 
        //- Return total gases mass source term [kg/m3/s]
        virtual tmp<DimensionedField<scalar, volMesh> > RRg() const = 0;
 
        //- Return total solids mass source term [kg/m3/s]
        virtual tmp<DimensionedField<scalar, volMesh> > RRs() const = 0;
 
        //- Return chemical source terms for solids [kg/m3/s]
        virtual const DimensionedField<scalar, volMesh>& RRs
        (
            const label i
        ) const = 0;
 
        //- Return chemical source terms for gases [kg/m3/s]
        virtual const DimensionedField<scalar, volMesh>& RRg
        (
            const label i
        ) const = 0;
 
        //- Returns the reaction rate of the speciei in reactionI
        virtual tmp<DimensionedField<scalar, volMesh> > calculateRR
        (
            const label reactionI,
            const label speciei
        ) const;
 
        //- Return sensible enthalpy for gas i [J/Kg]
        virtual tmp<volScalarField> gasHs
        (
            const volScalarField& p,
            const volScalarField& T,
            const label i
        ) const = 0;
 
        //- Return specie Table for gases
        virtual const speciesTable& gasTable() const = 0;
 
        //- Set reacting status of cell, cellI
        virtual void setCellReacting(const label cellI, const bool active) = 0;
 
        //- Calculates the reaction rates
        virtual void calculate() = 0;
 
        //- Return const access to the total source terms
        virtual const DimensionedField<scalar, volMesh>& RR
        (
            const label i
        ) const;
 
        //- Return non-const access to the total source terms
        virtual DimensionedField<scalar, volMesh>& RR(const label i);
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "basicSolidChemistryModelI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //