janafThermo.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
    Copyright (C) 2020 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::janafThermo
 
Group
    grpSpecieThermo
 
Description
    JANAF tables based thermodynamics package templated
    into the equation of state.
 
SourceFiles
    janafThermoI.H
    janafThermo.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef janafThermo_H
#define janafThermo_H
 
#include "scalar.H"
#include "FixedList.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// Forward Declarations
 
template<class EquationOfState> class janafThermo;
 
template<class EquationOfState>
inline janafThermo<EquationOfState> operator+
(
    const janafThermo<EquationOfState>&,
    const janafThermo<EquationOfState>&
);
 
template<class EquationOfState>
inline janafThermo<EquationOfState> operator*
(
    const scalar,
    const janafThermo<EquationOfState>&
);
 
template<class EquationOfState>
inline janafThermo<EquationOfState> operator==
(
    const janafThermo<EquationOfState>&,
    const janafThermo<EquationOfState>&
);
 
template<class EquationOfState>
Ostream& operator<<
(
    Ostream&,
    const janafThermo<EquationOfState>&
);
 
 
/*---------------------------------------------------------------------------*\
                           Class janafThermo Declaration
\*---------------------------------------------------------------------------*/
 
template<class EquationOfState>
class janafThermo
:
    public EquationOfState
{
public:
 
    // Public Data
 
        static constexpr int nCoeffs_ = 7;
        typedef FixedList<scalar, nCoeffs_> coeffArray;
 
 
private:
 
    // Private Data
 
        // Temperature limits of applicability of functions
        scalar Tlow_, Thigh_, Tcommon_;
 
        coeffArray highCpCoeffs_;
        coeffArray lowCpCoeffs_;
 
 
    // Private Member Functions
 
        //- Check that input data is valid
        void checkInputData() const;
 
        //- Return the coefficients corresponding to the given temperature
        inline const coeffArray& coeffs(const scalar T) const;
 
 
public:
 
    // Constructors
 
        //- Construct from components
        inline janafThermo
        (
            const EquationOfState& st,
            const scalar Tlow,
            const scalar Thigh,
            const scalar Tcommon,
            const coeffArray& highCpCoeffs,
            const coeffArray& lowCpCoeffs,
            const bool convertCoeffs = false
        );
 
        //- Construct from dictionary
        janafThermo(const dictionary& dict);
 
        //- Construct as a named copy
        inline janafThermo(const word&, const janafThermo&);
 
 
    // Member Functions
 
        //- Return the instantiated type name
        static word typeName()
        {
            return "janaf<" + EquationOfState::typeName() + '>';
        }
 
        //- Limit the temperature to be in the range Tlow_ to Thigh_
        inline scalar limit(const scalar T) const;
 
 
        // Access
 
            //- Return const access to the low temperature limit
            inline scalar Tlow() const;
 
            //- Return const access to the high temperature limit
            inline scalar Thigh() const;
 
            //- Return const access to the common temperature
            inline scalar Tcommon() const;
 
            //- Return const access to the high temperature poly coefficients
            inline const coeffArray& highCpCoeffs() const;
 
            //- Return const access to the low temperature poly coefficients
            inline const coeffArray& lowCpCoeffs() const;
 
 
        // Fundamental properties
 
            //- Heat capacity at constant pressure [J/(kg K)]
            inline scalar Cp(const scalar p, const scalar T) const;
 
            //- Absolute Enthalpy [J/kg]
            inline scalar Ha(const scalar p, const scalar T) const;
 
            //- Sensible enthalpy [J/kg]
            inline scalar Hs(const scalar p, const scalar T) const;
 
            //- Chemical enthalpy [J/kg]
            inline scalar Hc() const;
 
            //- Entropy [J/(kg K)]
            inline scalar S(const scalar p, const scalar T) const;
 
            //- Gibbs free energy of the mixture in the standard state [J/kg]
            inline scalar Gstd(const scalar T) const;
 
            #include "HtoEthermo.H"
 
 
        // Derivative term used for Jacobian
 
 
            //- Temperature derivative of heat capacity at constant pressure
            inline scalar dCpdT(const scalar p, const scalar T) const;
 
 
        // I-O
 
            //- Write to Ostream
            void write(Ostream& os) const;
 
 
    // Member operators
 
        inline void operator+=(const janafThermo&);
 
 
    // Friend operators
 
        friend janafThermo operator+ <EquationOfState>
        (
            const janafThermo&,
            const janafThermo&
        );
 
        friend janafThermo operator* <EquationOfState>
        (
            const scalar,
            const janafThermo&
        );
 
        friend janafThermo operator== <EquationOfState>
        (
            const janafThermo&,
            const janafThermo&
        );
 
 
    // Ostream Operator
 
        friend Ostream& operator<< <EquationOfState>
        (
            Ostream&,
            const janafThermo&
        );
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#include "janafThermoI.H"
 
#ifdef NoRepository
    #include "janafThermo.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //