Cantera 2.6.0

Public Member Functions | Protected Attributes | List of all members
Nasa9PolyMultiTempRegion Class Reference
Models of Phases of Matter » Thermodynamic Properties » Species Reference-State Thermodynamic Properties

The NASA 9 polynomial parameterization for a single species encompassing multiple temperature regions. More...

`#include <Nasa9PolyMultiTempRegion.h>`

Inheritance diagram for Nasa9PolyMultiTempRegion:
[legend]
Collaboration diagram for Nasa9PolyMultiTempRegion:
[legend]

## Public Member Functions
| Nasa9PolyMultiTempRegion (std::vector< Nasa9Poly1 * > &regionPts)
| Constructor with all input data. More...
| Nasa9PolyMultiTempRegion (double tlow, double thigh, double pref, const double *coeffs)
| Constructor with all input data. More...
void | setParameters (const std::map< double, vector_fp > &regions)
| Set the array of polynomial coefficients for each temperature region. More...
virtual int | reportType () const
| Returns an integer representing the type of parameterization. More...
virtual size_t | temperaturePolySize () const
| Number of terms in the temperature polynomial for this parameterization. More...
virtual void | updateTemperaturePoly (double T, double *T_poly) const
| Given the temperature T, compute the terms of the temperature polynomial T_poly. More...
virtual void | updateProperties (const doublereal *tt, doublereal *cp_R, doublereal *h_RT, doublereal *s_R) const
| Update the properties for this species, given a temperature polynomial. More...
virtual void | updatePropertiesTemp (const doublereal temp, doublereal *cp_R, doublereal *h_RT, doublereal *s_R) const
| Compute the reference-state property of one species. More...
virtual size_t | nCoeffs () const
| This utility function returns the number of coefficients for a given type of species parameterization. More...
virtual void | reportParameters (size_t &n, int &type, doublereal &tlow, doublereal &thigh, doublereal &pref, doublereal *const coeffs) const
| This utility function reports back the type of parameterization and all of the parameters for the species, index. More...
virtual void | getParameters (AnyMap &thermo) const
| Store the parameters of the species thermo object such that an identical species thermo object could be reconstructed using the newSpeciesThermo() function. More...
Public Member Functions inherited from SpeciesThermoInterpType
| SpeciesThermoInterpType (double tlow, double thigh, double pref)
| SpeciesThermoInterpType (const SpeciesThermoInterpType &b)=delete
SpeciesThermoInterpType & | operator= (const SpeciesThermoInterpType &b)=delete
virtual doublereal | minTemp () const
| Returns the minimum temperature that the thermo parameterization is valid. More...
virtual void | setMinTemp (double Tmin)
| Set the minimum temperature at which the thermo parameterization is valid. More...
virtual doublereal | maxTemp () const
| Returns the maximum temperature that the thermo parameterization is valid. More...
virtual void | setMaxTemp (double Tmax)
| Set the maximum temperature at which the thermo parameterization is valid. More...
virtual doublereal | refPressure () const
| Returns the reference pressure (Pa) More...
virtual void | setRefPressure (double Pref)
| Set the reference pressure [Pa]. More...
virtual void | validate (const std::string &name)
| Check for problems with the parameterization, and generate warnings or throw and exception if any are found. More...
virtual int | reportType () const
| Returns an integer representing the type of parameterization. More...
virtual size_t | temperaturePolySize () const
| Number of terms in the temperature polynomial for this parameterization. More...
virtual void | updateTemperaturePoly (double T, double *T_poly) const
| Given the temperature T, compute the terms of the temperature polynomial T_poly. More...
virtual void | updateProperties (const doublereal *tt, doublereal *cp_R, doublereal *h_RT, doublereal *s_R) const
| Update the properties for this species, given a temperature polynomial. More...
virtual void | updatePropertiesTemp (const doublereal temp, doublereal *cp_R, doublereal *h_RT, doublereal *s_R) const
| Compute the reference-state property of one species. More...
virtual size_t | nCoeffs () const
| This utility function returns the number of coefficients for a given type of species parameterization. More...
virtual void | reportParameters (size_t &index, int &type, doublereal &minTemp, doublereal &maxTemp, doublereal &refPressure, doublereal *const coeffs) const
| This utility function returns the type of parameterization and all of the parameters for the species. More...
AnyMap | parameters (bool withInput=true) const
| Return the parameters of the species thermo object such that an identical species thermo object could be reconstructed using the newSpeciesThermo() function. More...
virtual doublereal | reportHf298 (doublereal *const h298=0) const
| Report the 298 K Heat of Formation of the standard state of one species (J kmol-1) More...
virtual void | modifyOneHf298 (const size_t k, const doublereal Hf298New)
| Modify the value of the 298 K Heat of Formation of one species in the phase (J kmol-1) More...
virtual void | resetHf298 ()
| Restore the original heat of formation for this species. More...
const AnyMap & | input () const
| Access input data associated with the species thermo definition. More...
AnyMap & | input ()

## Protected Attributes
vector_fp | m_lowerTempBounds
| Lower boundaries of each temperature regions. More...
std::vector< std::unique_ptr< Nasa9Poly1 > > | m_regionPts
| Individual temperature region objects. More...
int | m_currRegion
| current region More...
Protected Attributes inherited from SpeciesThermoInterpType
doublereal | m_lowT
| lowest valid temperature More...
doublereal | m_highT
| Highest valid temperature. More...
doublereal | m_Pref
| Reference state pressure. More...
AnyMap | m_input

## Additional Inherited Members
virtual void | getParameters (AnyMap &thermo) const
| Store the parameters of the species thermo object such that an identical species thermo object could be reconstructed using the newSpeciesThermo() function. More...

## Detailed Description

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.

See also
  Nasa9Poly1

Definition at line 36 of file Nasa9PolyMultiTempRegion.h.

## Constructor & Destructor Documentation

## ◆ Nasa9PolyMultiTempRegion() [1/3]

Nasa9PolyMultiTempRegion | ( |  | ) |

Definition at line 27 of file Nasa9PolyMultiTempRegion.cpp.

## ◆ Nasa9PolyMultiTempRegion() [2/3]

Nasa9PolyMultiTempRegion | ( | std::vector< Nasa9Poly1 * > & | regionPts | ) |

Constructor with all input data.

Parameters

  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.

Definition at line 32 of file Nasa9PolyMultiTempRegion.cpp.

References SpeciesThermoInterpType::m_highT, Nasa9PolyMultiTempRegion::m_lowerTempBounds, SpeciesThermoInterpType::m_lowT, SpeciesThermoInterpType::m_Pref, Nasa9PolyMultiTempRegion::m_regionPts, SpeciesThermoInterpType::maxTemp(), and SpeciesThermoInterpType::refPressure().

## ◆ Nasa9PolyMultiTempRegion() [3/3]

Nasa9PolyMultiTempRegion | ( | double | tlow,
|  | double | thigh,
|  | double | pref,
|  | const double * | coeffs
| ) |  |

Constructor with all input data.

Parameters

  tlow | Minimum temperature
  thigh | Maximum temperature
  pref | reference pressure (Pa).
  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.

Definition at line 62 of file Nasa9PolyMultiTempRegion.cpp.

References Nasa9PolyMultiTempRegion::m_lowerTempBounds, Nasa9PolyMultiTempRegion::m_regionPts, and SpeciesThermoInterpType::maxTemp().

## ◆ ~Nasa9PolyMultiTempRegion()

~Nasa9PolyMultiTempRegion | ( |  | ) |
| virtual

Definition at line 108 of file Nasa9PolyMultiTempRegion.cpp.

## Member Function Documentation

## ◆ setParameters()

void setParameters | ( | const std::map< double, vector_fp > & | regions | ) |

Set the array of polynomial coefficients for each temperature region.

Parameters

  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.

Definition at line 90 of file Nasa9PolyMultiTempRegion.cpp.

References Nasa9PolyMultiTempRegion::m_lowerTempBounds, Nasa9PolyMultiTempRegion::m_regionPts, SpeciesThermoInterpType::maxTemp(), SpeciesThermoInterpType::refPressure(), SpeciesThermoInterpType::setMinTemp(), Nasa9Poly1::setParameters(), and SpeciesThermoInterpType::setRefPressure().

## ◆ reportType()

int reportType | ( |  | ) | const
| virtual

Returns an integer representing the type of parameterization.

Reimplemented from SpeciesThermoInterpType.

Definition at line 112 of file Nasa9PolyMultiTempRegion.cpp.

References NASA9MULTITEMP.

## ◆ temperaturePolySize()

virtual size_t temperaturePolySize | ( |  | ) | const
| inline virtual

Number of terms in the temperature polynomial for this parameterization.

Reimplemented from SpeciesThermoInterpType.

Definition at line 83 of file Nasa9PolyMultiTempRegion.h.

## ◆ updateTemperaturePoly()

void updateTemperaturePoly | ( | double | T,
|  | double * | T_poly
| ) |  | const
| virtual

Given the temperature T, compute the terms of the temperature polynomial T_poly.

Reimplemented from SpeciesThermoInterpType.

Definition at line 117 of file Nasa9PolyMultiTempRegion.cpp.

## ◆ updateProperties()

void updateProperties | ( | const doublereal * | tt,
|  | doublereal * | cp_R,
|  | doublereal * | h_RT,
|  | doublereal * | s_R
| ) |  | const
| virtual

Update the properties for this species, given a temperature polynomial.

This method is called with a pointer to an array containing the functions of temperature needed by this parameterization, and three pointers to arrays where the computed property values should be written. This method updates only one value in each array.

The form and length of the Temperature Polynomial may vary depending on the parameterization.

Parameters

  tt | vector of evaluated temperature functions
  cp_R | Vector of Dimensionless heat capacities. (length m_kk).
  h_RT | Vector of Dimensionless enthalpies. (length m_kk).
  s_R | Vector of Dimensionless entropies. (length m_kk).

Temperature Polynomial:

- tt[0] = t;
- tt[1] = t*t;
- tt[2] = t*t*t;
- tt[3] = t*t*t*t;
- tt[4] = 1.0/t;
- tt[5] = 1.0/(t*t);
- tt[6] = std::log(t);

Reimplemented from SpeciesThermoInterpType.

Definition at line 128 of file Nasa9PolyMultiTempRegion.cpp.

References Nasa9PolyMultiTempRegion::m_currRegion, Nasa9PolyMultiTempRegion::m_lowerTempBounds, and Nasa9PolyMultiTempRegion::m_regionPts.

## ◆ updatePropertiesTemp()

void updatePropertiesTemp | ( | const doublereal | temp,
|  | doublereal * | cp_R,
|  | doublereal * | h_RT,
|  | doublereal * | s_R
| ) |  | const
| virtual

Compute the reference-state property of one species.

Given temperature T in K, this method updates the values of the non- dimensional heat capacity at constant pressure, enthalpy, and entropy, at the reference pressure, of the species.

Parameters

  temp | Temperature (Kelvin)
  cp_R | Vector of Dimensionless heat capacities. (length m_kk).
  h_RT | Vector of Dimensionless enthalpies. (length m_kk).
  s_R | Vector of Dimensionless entropies. (length m_kk).

Reimplemented from SpeciesThermoInterpType.

Definition at line 144 of file Nasa9PolyMultiTempRegion.cpp.

References Nasa9PolyMultiTempRegion::m_currRegion, Nasa9PolyMultiTempRegion::m_lowerTempBounds, and Nasa9PolyMultiTempRegion::m_regionPts.

## ◆ nCoeffs()

size_t nCoeffs | ( |  | ) | const
| virtual

This utility function returns the number of coefficients for a given type of species parameterization.

Reimplemented from SpeciesThermoInterpType.

Definition at line 160 of file Nasa9PolyMultiTempRegion.cpp.

References Nasa9PolyMultiTempRegion::m_regionPts.

## ◆ reportParameters()

void reportParameters | ( | size_t & | n,
|  | int & | type,
|  | doublereal & | tlow,
|  | doublereal & | thigh,
|  | doublereal & | pref,
|  | doublereal *const | coeffs
| ) |  | const
| virtual

This utility function reports back the type of parameterization and all of the parameters for the species, index.

All parameters are output variables

Parameters

  n | Species index
  type | Integer type of the standard type
  tlow | output - Minimum temperature
  thigh | output - Maximum temperature
  pref | output - reference pressure (Pa).
  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

Reimplemented from SpeciesThermoInterpType.

Definition at line 165 of file Nasa9PolyMultiTempRegion.cpp.

## ◆ getParameters()

void getParameters | ( | AnyMap & | thermo | ) | const
| virtual

Store the parameters of the species thermo object such that an identical species thermo object could be reconstructed using the newSpeciesThermo() function.

Reimplemented from SpeciesThermoInterpType.

Definition at line 192 of file Nasa9PolyMultiTempRegion.cpp.

References SpeciesThermoInterpType::getParameters(), SpeciesThermoInterpType::m_highT, Nasa9PolyMultiTempRegion::m_lowerTempBounds, and Nasa9PolyMultiTempRegion::m_regionPts.

## Member Data Documentation

## ◆ m_lowerTempBounds

vector_fp m_lowerTempBounds
| protected

Lower boundaries of each temperature regions.

Definition at line 125 of file Nasa9PolyMultiTempRegion.h.

Referenced by Nasa9PolyMultiTempRegion::getParameters(), Nasa9PolyMultiTempRegion::Nasa9PolyMultiTempRegion(), Nasa9PolyMultiTempRegion::setParameters(), Nasa9PolyMultiTempRegion::updateProperties(), and Nasa9PolyMultiTempRegion::updatePropertiesTemp().

## ◆ m_regionPts

std::vector<std::unique_ptr<Nasa9Poly1> > m_regionPts
| protected

Individual temperature region objects.

Definition at line 128 of file Nasa9PolyMultiTempRegion.h.

Referenced by Nasa9PolyMultiTempRegion::getParameters(), Nasa9PolyMultiTempRegion::Nasa9PolyMultiTempRegion(), Nasa9PolyMultiTempRegion::nCoeffs(), Nasa9PolyMultiTempRegion::setParameters(), Nasa9PolyMultiTempRegion::updateProperties(), and Nasa9PolyMultiTempRegion::updatePropertiesTemp().

## ◆ m_currRegion

int m_currRegion
| mutable protected

current region

Definition at line 131 of file Nasa9PolyMultiTempRegion.h.

Referenced by Nasa9PolyMultiTempRegion::updateProperties(), and Nasa9PolyMultiTempRegion::updatePropertiesTemp().

The documentation for this class was generated from the following files:

- Nasa9PolyMultiTempRegion.h
- Nasa9PolyMultiTempRegion.cpp