STITbyPDSS Class Reference
[Species Reference-State Thermodynamic Properties]

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

#include <SpeciesThermoInterpType.h>

Inheritance diagram for STITbyPDSS:
Inheritance graph
[legend]
Collaboration diagram for STITbyPDSS:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 STITbyPDSS ()
 Constructor.
 STITbyPDSS (int speciesIndex, VPSSMgr *vpssmgr_ptr, PDSS *PDSS_ptr)
 Main Constructor.
 STITbyPDSS (const STITbyPDSS &b)
 copy constructor
virtual ~STITbyPDSS ()
 Destructor.
virtual SpeciesThermoInterpTypeduplMyselfAsSpeciesThermoInterpType () const
 duplicator
void initAllPtrs (int 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 int 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 (int &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

VPSSMgrm_vpssmgr_ptr
 Pointer to the Variable pressure standard state manager that owns the PDSS object that will handle calls for this object.
PDSSm_PDSS_ptr
 Pointer to the PDSS object that handles calls for this object.
int m_speciesIndex
 Species index within the phase.

Detailed Description

Class for the thermoydnamic manager for an individual species' reference state which usess 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 308 of file SpeciesThermoInterpType.h.


Constructor & Destructor Documentation

STITbyPDSS (  ) 

Constructor.

STITbyPDSS ( int  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
STITbyPDSS ( const STITbyPDSS b  ) 

copy constructor

Parameters:
b Object to be copied
virtual ~STITbyPDSS (  )  [virtual]

Destructor.


Member Function Documentation

virtual SpeciesThermoInterpType* duplMyselfAsSpeciesThermoInterpType (  )  const [virtual]

duplicator

Implements SpeciesThermoInterpType.

void initAllPtrs ( int  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

Referenced by VPSSMgr::initAllPtrs().

virtual doublereal maxTemp (  )  const [virtual]

Returns the maximum temperature that the thermo parameterization is valid.

Implements SpeciesThermoInterpType.

virtual doublereal minTemp (  )  const [virtual]

Returns the minimum temperature that the thermo parameterization is valid.

Implements SpeciesThermoInterpType.

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

Reimplemented from SpeciesThermoInterpType.

virtual doublereal refPressure (  )  const [virtual]

Returns the reference pressure (Pa).

Implements SpeciesThermoInterpType.

virtual void reportParameters ( int &  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.

virtual int reportType (  )  const [virtual]

Returns an integer representing the type of parameterization.

Implements SpeciesThermoInterpType.

virtual int speciesIndex (  )  const [virtual]

Returns an integer representing the species index.

Implements SpeciesThermoInterpType.

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

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


Member Data Documentation

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

int m_speciesIndex [private]

Species index within the phase.

Definition at line 459 of file SpeciesThermoInterpType.h.

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


The documentation for this class was generated from the following file:
Generated by  doxygen 1.6.3