Cantera  2.1.2
Public Member Functions | Private Attributes | List of all members

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:
[legend]
Collaboration diagram for STITbyPDSS:
[legend]

Public Member Functions

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

Private Attributes

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

Additional Inherited Members

- 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...
 
size_t m_index
 species index More...
 

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 319 of file SpeciesThermoInterpType.h.

Constructor & Destructor Documentation

STITbyPDSS ( size_t  speciesIndex,
VPSSMgr vpssmgr_ptr,
PDSS PDSS_ptr 
)

Main Constructor.

Parameters
speciesIndexspecies index for this object. Note, this must agree with what was internally set before.
vpssmgr_ptrPointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object
PDSS_ptrPointer to the PDSS object that handles calls for this object

Definition at line 57 of file SpeciesThermoInterpType.cpp.

References SpeciesThermoInterpType::m_index.

STITbyPDSS ( const STITbyPDSS b)

copy constructor

Parameters
bObject to be copied

Definition at line 64 of file SpeciesThermoInterpType.cpp.

Member Function Documentation

SpeciesThermoInterpType * duplMyselfAsSpeciesThermoInterpType ( ) const
virtual

duplicator

Implements SpeciesThermoInterpType.

Definition at line 71 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
speciesIndexspecies index for this object. Note, this must agree with what was internally set before.
vpssmgr_ptrPointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object
PDSS_ptrPointer to the PDSS object that handles calls for this object

Definition at line 76 of file SpeciesThermoInterpType.cpp.

References AssertThrow, SpeciesThermoInterpType::m_index, STITbyPDSS::m_PDSS_ptr, and STITbyPDSS::m_vpssmgr_ptr.

Referenced by VPSSMgr::initAllPtrs().

doublereal minTemp ( ) const
virtual

Returns the minimum temperature that the thermo parameterization is valid.

Reimplemented from SpeciesThermoInterpType.

Definition at line 83 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.

Reimplemented from SpeciesThermoInterpType.

Definition at line 88 of file SpeciesThermoInterpType.cpp.

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

doublereal refPressure ( ) const
virtual

Returns the reference pressure (Pa)

Reimplemented from SpeciesThermoInterpType.

Definition at line 93 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 98 of file SpeciesThermoInterpType.cpp.

References PDSS_TYPE.

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
tempPolyvector of temperature polynomials
cp_RVector of Dimensionless heat capacities. (length m_kk).
h_RTVector of Dimensionless enthalpies. (length m_kk).
s_RVector of Dimensionless entropies. (length m_kk).

Reimplemented from SpeciesThermoInterpType.

Definition at line 103 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
tempTemperature (Kelvin)
cp_RVector of Dimensionless heat capacities. (length m_kk).
h_RTVector of Dimensionless enthalpies. (length m_kk).
s_RVector of Dimensionless entropies. (length m_kk).

Implements SpeciesThermoInterpType.

Definition at line 111 of file SpeciesThermoInterpType.cpp.

References AssertThrowMsg, PDSS::cp_R_ref(), PDSS::enthalpy_RT_ref(), PDSS::entropy_R_ref(), SpeciesThermoInterpType::m_index, STITbyPDSS::m_PDSS_ptr, 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
void modifyParameters ( doublereal *  coeffs)
virtual
Deprecated:

Reimplemented from SpeciesThermoInterpType.

Definition at line 138 of file SpeciesThermoInterpType.cpp.

References Cantera::warn_deprecated().

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 396 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 402 of file SpeciesThermoInterpType.h.

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


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