FallOffReactionRate.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-2021 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::FallOffReactionRate
 
Description
    General class for handling unimolecular/recombination fall-off reactions.
 
SourceFiles
    FallOffReactionRateI.H
 
\*---------------------------------------------------------------------------*/
 
#ifndef FallOffReactionRate_H
#define FallOffReactionRate_H
 
#include "thirdBodyEfficiencies.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward declaration of friend functions and operators
 
template<class ReactionRate, class FallOffFunction>
class FallOffReactionRate;
 
template<class ReactionRate, class FallOffFunction>
inline Ostream& operator<<
(
    Ostream&,
    const FallOffReactionRate<ReactionRate, FallOffFunction>&
);
 
 
/*---------------------------------------------------------------------------*\
                     Class FallOffReactionRate Declaration
\*---------------------------------------------------------------------------*/
 
template<class ReactionRate, class FallOffFunction>
class FallOffReactionRate
{
    // Private Data
 
        ReactionRate k0_;
 
        ReactionRate kInf_;
 
        FallOffFunction F_;
 
        thirdBodyEfficiencies thirdBodyEfficiencies_;
 
 
public:
 
    // Constructors
 
        //- Construct from components
        inline FallOffReactionRate
        (
            const ReactionRate& k0,
            const ReactionRate& kInf,
            const FallOffFunction& F,
            const thirdBodyEfficiencies& tbes
        );
 
        //- Construct from dictionary
        inline FallOffReactionRate
        (
            const speciesTable& species,
            const dictionary& dict
        );
 
 
    // Member Functions
 
        //- Return the type name
        static word type()
        {
            return ReactionRate::type() + FallOffFunction::type() + "FallOff";
        }
 
        //- Pre-evaluation hook
        inline void preEvaluate() const;
 
        //- Post-evaluation hook
        inline void postEvaluate() const;
 
        //- Return the rate
        inline scalar operator()
        (
            const scalar p,
            const scalar T,
            const scalarField& c,
            const label li
        ) const;
 
        //- The derivative of the rate w.r.t. temperature
        inline scalar ddT
        (
            const scalar p,
            const scalar T,
            const scalarField& c,
            const label li
        ) const;
 
        //- Is the rate a function of concentration?
        inline bool hasDdc() const;
 
        //- The derivative of the rate w.r.t. concentration
        inline void ddc
        (
            const scalar p,
            const scalar T,
            const scalarField& c,
            const label li,
            scalarField& ddc
        ) const;
 
        //- Write to stream
        inline void write(Ostream& os) const;
 
 
    // Ostream Operator
 
        friend Ostream& operator<< <ReactionRate, FallOffFunction>
        (
            Ostream&,
            const FallOffReactionRate<ReactionRate, FallOffFunction>&
        );
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "FallOffReactionRateI.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //