STITbyPDSS Class Reference

Class for the thermodynamic manager for an individual species' reference state which uses the PDSS base class to satisfy the requests. More...

#include <SpeciesThermoInterpType.h>

Inheritance diagram for STITbyPDSS:

Collaboration diagram for STITbyPDSS:

Public Member Functions
	STITbyPDSS ()
	Constructor.
	STITbyPDSS (size_t speciesIndex, VPSSMgr *vpssmgr_ptr, PDSS *PDSS_ptr)
	Main Constructor.
	STITbyPDSS (const STITbyPDSS &b)
	copy constructor
virtual	~STITbyPDSS ()
	Destructor.
virtual SpeciesThermoInterpType *	duplMyselfAsSpeciesThermoInterpType () const
	duplicator
void	initAllPtrs (size_t speciesIndex, VPSSMgr *vpssmgr_ptr, PDSS *PDSS_ptr)
	Initialize and/or Reinitialize all the pointers for this object.
virtual doublereal	minTemp () const
	Returns the minimum temperature that the thermo parameterization is valid.
virtual doublereal	maxTemp () const
	Returns the maximum temperature that the thermo parameterization is valid.
virtual doublereal	refPressure () const
	Returns the reference pressure (Pa)
virtual int	reportType () const
	Returns an integer representing the type of parameterization.
virtual size_t	speciesIndex () const
	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
	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
	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.

Private Attributes
VPSSMgr *	m_vpssmgr_ptr
	Pointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object.
PDSS *	m_PDSS_ptr
	Pointer to the PDSS object that handles calls for this object.
size_t	m_speciesIndex
	Species index within the phase.

Detailed Description

Class for the thermodynamic manager for an individual species' reference state which uses the PDSS base class to satisfy the requests.

This class is a pass-through class for handling thermodynamics calls for reference state thermo to an pressure dependent standard state (PDSS) class. For some situations, it makes no sense to have a reference state at all. One example of this is the real water standard state.

What this class does is just to pass through the calls for thermo at (T , p0) to the PDSS class, which evaluates the calls at (T, p0).

Definition at line 305 of file SpeciesThermoInterpType.h.

Constructor & Destructor Documentation

STITbyPDSS

(

)

Constructor.

Definition at line 50 of file SpeciesThermoInterpType.cpp.

Referenced by STITbyPDSS::duplMyselfAsSpeciesThermoInterpType().

STITbyPDSS	(	size_t	speciesIndex,
		VPSSMgr *	vpssmgr_ptr,
		PDSS *	PDSS_ptr
	)

Main Constructor.

Parameters

speciesIndex	species index for this object. Note, this must agree with what was internally set before.
vpssmgr_ptr	Pointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object
PDSS_ptr	Pointer to the PDSS object that handles calls for this object

Definition at line 55 of file SpeciesThermoInterpType.cpp.

STITbyPDSS

(

const STITbyPDSS &

b

)

copy constructor

Parameters

b	Object to be copied

Definition at line 62 of file SpeciesThermoInterpType.cpp.

~STITbyPDSS ( )

virtual

Destructor.

Definition at line 70 of file SpeciesThermoInterpType.cpp.

Member Function Documentation

SpeciesThermoInterpType * duplMyselfAsSpeciesThermoInterpType ( ) const

virtual

duplicator

Implements SpeciesThermoInterpType.

Definition at line 76 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::STITbyPDSS().

void initAllPtrs	(	size_t	speciesIndex,
		VPSSMgr *	vpssmgr_ptr,
		PDSS *	PDSS_ptr
	)

Initialize and/or Reinitialize all the pointers for this object.

This routine is needed because the STITbyPDSS object doesn't own the underlying objects. Therefore, shallow copies during duplication operations may fail.

Parameters

speciesIndex	species index for this object. Note, this must agree with what was internally set before.
vpssmgr_ptr	Pointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object
PDSS_ptr	Pointer to the PDSS object that handles calls for this object

Definition at line 83 of file SpeciesThermoInterpType.cpp.

References AssertThrow, STITbyPDSS::m_PDSS_ptr, STITbyPDSS::m_speciesIndex, and STITbyPDSS::m_vpssmgr_ptr.

Referenced by VPSSMgr::initAllPtrs().

doublereal minTemp ( ) const

virtual

Returns the minimum temperature that the thermo parameterization is valid.

Implements SpeciesThermoInterpType.

Definition at line 92 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::m_PDSS_ptr, and PDSS::minTemp().

doublereal maxTemp ( ) const

virtual

Returns the maximum temperature that the thermo parameterization is valid.

Implements SpeciesThermoInterpType.

Definition at line 99 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::m_PDSS_ptr, and PDSS::maxTemp().

doublereal refPressure ( ) const

virtual

Returns the reference pressure (Pa)

Implements SpeciesThermoInterpType.

Definition at line 105 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::m_PDSS_ptr, and PDSS::refPressure().

int reportType ( ) const

virtual

Returns an integer representing the type of parameterization.

Implements SpeciesThermoInterpType.

Definition at line 111 of file SpeciesThermoInterpType.cpp.

References PDSS_TYPE.

size_t speciesIndex ( ) const

virtual

Returns an integer representing the species index.

Implements SpeciesThermoInterpType.

Definition at line 117 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::m_speciesIndex.

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 from SpeciesThermoInterpType.

Definition at line 141 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::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, 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).

Implements SpeciesThermoInterpType.

Definition at line 165 of file SpeciesThermoInterpType.cpp.

References AssertThrowMsg, PDSS::cp_R_ref(), PDSS::enthalpy_RT_ref(), PDSS::entropy_R_ref(), STITbyPDSS::m_PDSS_ptr, STITbyPDSS::m_speciesIndex, Cantera::npos, and PDSS::setTemperature().

Referenced by STITbyPDSS::updateProperties().

void reportParameters ( size_t &  index, int &  type, doublereal &  minTemp, doublereal &  maxTemp, doublereal &  refPressure, 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

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.

Implements SpeciesThermoInterpType.

Definition at line 193 of file SpeciesThermoInterpType.cpp.

References STITbyPDSS::m_PDSS_ptr, STITbyPDSS::m_speciesIndex, STITbyPDSS::m_vpssmgr_ptr, VPSSMgr::maxTemp(), VPSSMgr::minTemp(), PDSS_TYPE, and PDSS::refPressure().

void modifyParameters ( doublereal *  coeffs )

virtual

Modify parameters for the standard state.

This is a stub routine, without functionality

Parameters

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

Reimplemented from SpeciesThermoInterpType.

Definition at line 210 of file SpeciesThermoInterpType.cpp.

Member Data Documentation

VPSSMgr* m_vpssmgr_ptr

private

Pointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object.

Definition at line 448 of file SpeciesThermoInterpType.h.

Referenced by STITbyPDSS::initAllPtrs(), and STITbyPDSS::reportParameters().

PDSS* m_PDSS_ptr

private

Pointer to the PDSS object that handles calls for this object.

This object is not owned by the current one.

Definition at line 454 of file SpeciesThermoInterpType.h.

Referenced by STITbyPDSS::initAllPtrs(), STITbyPDSS::maxTemp(), STITbyPDSS::minTemp(), STITbyPDSS::refPressure(), STITbyPDSS::reportParameters(), and STITbyPDSS::updatePropertiesTemp().

size_t m_speciesIndex

private

Species index within the phase.

Definition at line 457 of file SpeciesThermoInterpType.h.

Referenced by STITbyPDSS::initAllPtrs(), STITbyPDSS::reportParameters(), STITbyPDSS::speciesIndex(), and STITbyPDSS::updatePropertiesTemp().

---

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

• SpeciesThermoInterpType.h
• SpeciesThermoInterpType.cpp