Nasa9PolyMultiTempRegion.h

Go to the documentation of this file.

/**
 *  @file Nasa9PolyMultiTempRegion.h
 *  Header for a single-species standard state object derived
 *  from @link Cantera::SpeciesThermoInterpType
 *  SpeciesThermoInterpType@endlink  based
 *  on the NASA 9 coefficient temperature polynomial form
 *   applied to multiple temperature regions
 *  (see @ref spthermo and class @link Cantera::Nasa9PolyMultiTempRegion Nasa9PolyMultiTempRegion@endlink).
 *
 *  This parameterization has multiple NASA temperature regions.
 */
 
// This file is part of Cantera. See License.txt in the top-level directory or
// at https://cantera.org/license.txt for license and copyright information.
 
#ifndef CT_NASA9POLYMULTITEMPREGION_H
#define CT_NASA9POLYMULTITEMPREGION_H
 
#include "cantera/thermo/Nasa9Poly1.h"
 
namespace Cantera
{
//! The NASA 9 polynomial parameterization for a single species encompassing
//! multiple temperature regions.
/*!
 * The parameterization used in each temperature range is described in the
 * documentation for class Nasa9Poly1.
 *
 * These NASA representations may have multiple temperature regions through the
 * use of this Nasa9PolyMultiTempRegion object, which uses multiple copies of
 * the Nasa9Poly1 object to handle multiple temperature regions.
 *
 * @ingroup spthermo
 * @see Nasa9Poly1
 */
class Nasa9PolyMultiTempRegion : public SpeciesThermoInterpType
{
public:
    Nasa9PolyMultiTempRegion() = default;
 
    //! Constructor with all input data
    /*!
     * @param regionPts Vector of pointers to Nasa9Poly1 objects. These objects
     *     all refer to the temperature regions for the same species. The vector
     *     must be in increasing temperature region format.  Together they
     *     represent the reference temperature parameterization for a single
     *     species.
     *
     * Note, after the constructor, we will own the underlying Nasa9Poly1
     * objects and be responsible for owning them.
     */
    Nasa9PolyMultiTempRegion(span<Nasa9Poly1*> regionPts);
 
    //! Constructor with all input data
    /*!
     * @param tlow    Minimum temperature
     * @param thigh   Maximum temperature
     * @param pref    reference pressure (Pa).
     * @param coeffs  Vector of coefficients used to set the parameters for the
     *                standard state. The vector has 1 + 11*`nzones` elements
     *                in the following order:
     *                - `coeffs[0]`: Number of zones (`nzones`)
     *                - `coeffs[1 + 11*zone]`: minimum temperature within zone
     *                - `coeffs[2 + 11*zone]`: maximum temperature within zone
     *                - `coeffs[3:11 + 11*zone]`: 9 coefficient parameterization
     *                where `zone` runs from zero to `nzones`-1.
     */
    Nasa9PolyMultiTempRegion(double tlow, double thigh, double pref,
                             span<const double> coeffs);
 
    //! Set the array of polynomial coefficients for each temperature region
    /*!
     *  @param regions  Map where each key is the minimum temperature for a
     *                  region and each value is the array of 9 polynomial
     *                  coefficients for that region.
     */
    void setParameters(const map<double, vector<double>>& regions);
 
    int reportType() const override;
 
    size_t temperaturePolySize() const override { return 7; }
    void updateTemperaturePoly(double T, span<double> T_poly) const override;
 
    //! @copydoc Nasa9Poly1::updateProperties
    void updateProperties(span<const double> tt, double& cp_R, double& h_RT,
                          double& s_R) const override;
 
    void updatePropertiesTemp(const double temp, double& cp_R,
                              double& h_RT, double& s_R) const override;
 
    size_t nCoeffs() const override;
 
    //! This utility function reports back the type of parameterization and all
    //! of the parameters for the species, index.
    /*!
     * All parameters are output variables
     *
     * @param n         Species index
     * @param type      Integer type of the standard type
     * @param tlow      output - Minimum temperature
     * @param thigh     output - Maximum temperature
     * @param pref      output - reference pressure (Pa).
     * @param coeffs    Vector of coefficients used to set the parameters for
     *     the standard state. There are 1 + 11*nzones coefficients.
     *      coeffs[0] is equal to nTempZones.
     *      index = 1
     *      for each zone:
     *        coeffs[index] = minTempZone
     *        coeffs[index+1] = maxTempZone
     *        coeffs[index+2+i] from i =0,9 are the coefficients themselves
     */
    void reportParameters(size_t& n, int& type, double& tlow, double& thigh,
                          double& pref, span<double> coeffs) const override;
 
    void getParameters(AnyMap& thermo) const override;
 
protected:
    //! Lower boundaries of each temperature regions
    vector<double> m_lowerTempBounds;
 
    //! Individual temperature region objects
    vector<unique_ptr<Nasa9Poly1>> m_regionPts;
 
    //! current region
    mutable int m_currRegion = 0;
};
 
}
#endif