Pure Virtual Base class for the thermodynamic manager for an individual species' reference state. More...

#include <SpeciesThermoInterpType.h>

Inheritance diagram for SpeciesThermoInterpType:

Public Member Functions
	SpeciesThermoInterpType ()
	Constructor.

virtual	~SpeciesThermoInterpType ()
	Destructor.

virtual SpeciesThermoInterpType *	duplMyselfAsSpeciesThermoInterpType () const =0
	duplicator

virtual doublereal	minTemp () const =0
	Returns the minimum temperature that the thermo parameterization is valid.

virtual doublereal	maxTemp () const =0
	Returns the maximum temperature that the thermo parameterization is valid.

virtual doublereal	refPressure () const =0
	Returns the reference pressure (Pa)

virtual int	reportType () const =0
	Returns an integer representing the type of parameterization.

virtual size_t	speciesIndex () const =0
	Returns an integer representing the species index.

virtual void	updateProperties (const doublereal tempPoly, doublereal cp_R, doublereal h_RT, doublereal s_R) const
	Update the properties for this species, given a temperature polynomial.

virtual void	updatePropertiesTemp (const doublereal temp, doublereal cp_R, doublereal h_RT, doublereal *s_R) const =0
	Compute the reference-state property of one species.

virtual void	reportParameters (size_t &index, int &type, doublereal &minTemp, doublereal &maxTemp, doublereal &refPressure, doublereal *const coeffs) const =0
	This utility function reports back the type of parameterization and all of the parameters for the species, index.

virtual void	modifyParameters (doublereal *coeffs)
	Modify parameters for the standard state.

Detailed Description

Pure Virtual Base class for the thermodynamic manager for an individual species' reference state.

This differs from the SpeciesThermo virtual base class in the sense that this class is meant to handle only one species. The speciesThermo class is meant to handle the calculation of all the species (or a large subset) in a phase.

One key feature is that the update routines use the same form as the update routines in the speciesThermo class. They update into a vector of cp_R, s_R, and H_R that spans all of the species in a phase. Therefore, this class must carry along a species index into that vector.

These routine may be templated. A key requirement of the template is that there is a constructor with the following form:

SpeciesThermoInterpType(int index, doublereal tlow, doublereal thigh,

doublereal pref, const doublereal* coeffs)

The constructor is used to instantiate the object.

Definition at line 161 of file SpeciesThermoInterpType.h.

Constructor & Destructor Documentation

SpeciesThermoInterpType ( )

Constructor.

Definition at line 15 of file SpeciesThermoInterpType.cpp.

~SpeciesThermoInterpType ( )

virtual

Destructor.

Definition at line 19 of file SpeciesThermoInterpType.cpp.

Member Function Documentation

virtual SpeciesThermoInterpType* duplMyselfAsSpeciesThermoInterpType ( ) const

pure virtual

duplicator

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, Mu0Poly, NasaPoly1, Nasa9PolyMultiTempRegion, Nasa9Poly1, ConstCpPoly, and Adsorbate.

Referenced by GeneralSpeciesThermo::GeneralSpeciesThermo(), and GeneralSpeciesThermo::operator=().

virtual doublereal minTemp ( ) const

pure virtual

Returns the minimum temperature that the thermo parameterization is valid.

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, Mu0Poly, NasaPoly1, Nasa9PolyMultiTempRegion, Nasa9Poly1, Adsorbate, and ConstCpPoly.

Referenced by GeneralSpeciesThermo::install_STIT(), and GeneralSpeciesThermo::minTemp().

virtual doublereal maxTemp ( ) const

pure virtual

Returns the maximum temperature that the thermo parameterization is valid.

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, NasaPoly1, Mu0Poly, Nasa9PolyMultiTempRegion, Nasa9Poly1, Adsorbate, and ConstCpPoly.

Referenced by GeneralSpeciesThermo::install_STIT(), and GeneralSpeciesThermo::maxTemp().

virtual doublereal refPressure ( ) const

pure virtual

Returns the reference pressure (Pa)

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, NasaPoly1, Mu0Poly, Nasa9PolyMultiTempRegion, Nasa9Poly1, Adsorbate, and ConstCpPoly.

Referenced by GeneralSpeciesThermo::refPressure().

virtual int reportType ( ) const

pure virtual

Returns an integer representing the type of parameterization.

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, NasaPoly1, Mu0Poly, Nasa9PolyMultiTempRegion, Nasa9Poly1, Adsorbate, and ConstCpPoly.

Referenced by GeneralSpeciesThermo::reportType().

virtual size_t speciesIndex ( ) const

pure virtual

Returns an integer representing the species index.

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, NasaPoly1, Mu0Poly, Nasa9PolyMultiTempRegion, Nasa9Poly1, Adsorbate, and ConstCpPoly.

Referenced by GeneralSpeciesThermo::install_STIT().

void updateProperties	(	const doublereal *	tempPoly,
		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

tempPoly	vector of temperature polynomials
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 in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly2, NasaPoly1, Mu0Poly, Nasa9PolyMultiTempRegion, Nasa9Poly1, and ConstCpPoly.

Definition at line 23 of file SpeciesThermoInterpType.cpp.

References SpeciesThermoInterpType::updatePropertiesTemp().

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

pure 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, Pref of one of the species. The species index is used to reference into the cp_R, h_RT, and s_R arrays.

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).

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly1, NasaPoly2, Mu0Poly, Nasa9PolyMultiTempRegion, Nasa9Poly1, ConstCpPoly, and Adsorbate.

Referenced by GeneralSpeciesThermo::update(), GeneralSpeciesThermo::update_one(), and SpeciesThermoInterpType::updateProperties().

virtual void reportParameters	(	size_t &	index,
		int &	type,
		doublereal &	minTemp,
		doublereal &	maxTemp,
		doublereal &	refPressure,
		doublereal *const	coeffs
	)		const

pure 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

index	Species index
type	Integer type of the standard type
minTemp	output - Minimum temperature
maxTemp	output - Maximum temperature
refPressure	output - reference pressure (Pa).
coeffs	Vector of coefficients used to set the parameters for the standard state.

Implemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly1, NasaPoly2, Nasa9PolyMultiTempRegion, Nasa9Poly1, Mu0Poly, Adsorbate, and ConstCpPoly.

Referenced by GeneralSpeciesThermo::reportParams().

virtual void modifyParameters ( doublereal * coeffs )

inlinevirtual

Modify parameters for the standard state.

Parameters

coeffs Vector of coefficients used to set the parameters for the standard state.

Reimplemented in ShomatePoly2, STITbyPDSS, ShomatePoly, NasaPoly1, Nasa9PolyMultiTempRegion, Nasa9Poly1, Mu0Poly, and ConstCpPoly.

Definition at line 262 of file SpeciesThermoInterpType.h.

Referenced by GeneralSpeciesThermo::modifyParams().

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation