Cantera  2.3.0
Protected Attributes | List of all members

Virtual base class for a species with a pressure dependent standard state. More...

#include <PDSS.h>

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

Public Member Functions

Constructors
 PDSS ()
 Empty Constructor. More...
 
 PDSS (VPStandardStateTP *tp, size_t spindex)
 Constructor that initializes the object by examining the XML entries from the ThermoPhase object. More...
 
 PDSS (const PDSS &b)
 
PDSSoperator= (const PDSS &b)
 
virtual ~PDSS ()
 
virtual PDSSduplMyselfAsPDSS () const
 Duplication routine for objects which inherit from PDSS. More...
 
Utilities
PDSS_enumType reportPDSSType () const
 Returns the type of the standard state parameterization. More...
 
Molar Thermodynamic Properties of the Species Standard State in
the Solution
virtual doublereal enthalpy_mole () const
 Return the molar enthalpy in units of J kmol-1. More...
 
virtual doublereal enthalpy_RT () const
 Return the standard state molar enthalpy divided by RT. More...
 
virtual doublereal intEnergy_mole () const
 Return the molar internal Energy in units of J kmol-1. More...
 
virtual doublereal entropy_mole () const
 Return the molar entropy in units of J kmol-1 K-1. More...
 
virtual doublereal entropy_R () const
 Return the standard state entropy divided by RT. More...
 
virtual doublereal gibbs_mole () const
 Return the molar Gibbs free energy in units of J kmol-1. More...
 
virtual doublereal gibbs_RT () const
 Return the molar Gibbs free energy divided by RT. More...
 
virtual doublereal cp_mole () const
 Return the molar const pressure heat capacity in units of J kmol-1 K-1. More...
 
virtual doublereal cp_R () const
 Return the molar const pressure heat capacity divided by RT. More...
 
virtual doublereal cv_mole () const
 Return the molar const volume heat capacity in units of J kmol-1 K-1. More...
 
virtual doublereal molarVolume () const
 Return the molar volume at standard state. More...
 
virtual doublereal density () const
 Return the standard state density at standard state. More...
 
virtual doublereal enthalpyDelp_mole () const
 Get the difference in the standard state enthalpy between the current pressure and the reference pressure, p0. More...
 
virtual doublereal entropyDelp_mole () const
 Get the difference in the standard state entropy between the current pressure and the reference pressure, p0. More...
 
virtual doublereal gibbsDelp_mole () const
 Get the difference in the standard state Gibbs free energy between the current pressure and the reference pressure, p0. More...
 
virtual doublereal cpDelp_mole () const
 Get the difference in standard state heat capacity between the current pressure and the reference pressure, p0. More...
 
Properties of the Reference State of the Species in the Solution
doublereal refPressure () const
 Return the reference pressure for this phase. More...
 
doublereal minTemp () const
 return the minimum temperature More...
 
doublereal maxTemp () const
 return the minimum temperature More...
 
virtual doublereal gibbs_RT_ref () const
 Return the molar Gibbs free energy divided by RT at reference pressure. More...
 
virtual doublereal enthalpy_RT_ref () const
 Return the molar enthalpy divided by RT at reference pressure. More...
 
virtual doublereal entropy_R_ref () const
 Return the molar entropy divided by R at reference pressure. More...
 
virtual doublereal cp_R_ref () const
 Return the molar heat capacity divided by R at reference pressure. More...
 
virtual doublereal molarVolume_ref () const
 Return the molar volume at reference pressure. More...
 
Mechanical Equation of State Properties
virtual doublereal pressure () const
 Returns the pressure (Pa) More...
 
virtual void setPressure (doublereal pres)
 Sets the pressure in the object. More...
 
virtual doublereal thermalExpansionCoeff () const
 Return the volumetric thermal expansion coefficient. Units: 1/K. More...
 
Partial Molar Properties of the Solution
virtual void setTemperature (doublereal temp)
 Set the internal temperature. More...
 
virtual doublereal temperature () const
 Return the current stored temperature. More...
 
virtual void setState_TP (doublereal temp, doublereal pres)
 Set the internal temperature and pressure. More...
 
virtual void setState_TR (doublereal temp, doublereal rho)
 Set the internal temperature and density. More...
 
Miscellaneous properties of the standard state
virtual doublereal critTemperature () const
 critical temperature More...
 
virtual doublereal critPressure () const
 critical pressure More...
 
virtual doublereal critDensity () const
 critical density More...
 
virtual doublereal satPressure (doublereal T)
 saturation pressure More...
 
doublereal molecularWeight () const
 Return the molecular weight of the species in units of kg kmol-1. More...
 
void setMolecularWeight (doublereal mw)
 Set the molecular weight of the species. More...
 

Protected Attributes

PDSS_enumType m_pdssType
 Enumerated type describing the type of the PDSS object. More...
 
doublereal m_temp
 Current temperature used by the PDSS object. More...
 
doublereal m_pres
 State of the system - pressure. More...
 
doublereal m_p0
 Reference state pressure of the species. More...
 
doublereal m_minTemp
 Minimum temperature. More...
 
doublereal m_maxTemp
 Maximum temperature. More...
 
VPStandardStateTPm_tp
 ThermoPhase which this species belongs to. More...
 
VPSSMgrm_vpssmgr_ptr
 Pointer to the VPSS manager for this object. More...
 
doublereal m_mw
 Molecular Weight of the species. More...
 
size_t m_spindex
 Species index in the ThermoPhase corresponding to this species. More...
 
MultiSpeciesThermom_spthermo
 Pointer to the species thermodynamic property manager. More...
 
doublereal * m_h0_RT_ptr
 Reference state enthalpy divided by RT. More...
 
doublereal * m_cp0_R_ptr
 Reference state heat capacity divided by R. More...
 
doublereal * m_s0_R_ptr
 Reference state entropy divided by R. More...
 
doublereal * m_g0_RT_ptr
 Reference state Gibbs free energy divided by RT. More...
 
doublereal * m_V0_ptr
 Reference state molar volume (m3 kg-1) More...
 
doublereal * m_hss_RT_ptr
 Standard state enthalpy divided by RT. More...
 
doublereal * m_cpss_R_ptr
 Standard state heat capacity divided by R. More...
 
doublereal * m_sss_R_ptr
 Standard state entropy divided by R. More...
 
doublereal * m_gss_RT_ptr
 Standard state Gibbs free energy divided by RT. More...
 
doublereal * m_Vss_ptr
 Standard State molar volume (m3 kg-1) More...
 

Initialization of the Object

virtual void initThermo ()
 Initialization routine for all of the shallow pointers. More...
 
virtual void initThermoXML (const XML_Node &phaseNode, const std::string &id)
 Initialization routine for the PDSS object based on the phaseNode. More...
 
virtual void reportParams (size_t &kindex, int &type, doublereal *const c, doublereal &minTemp, doublereal &maxTemp, doublereal &refPressure) const
 This utility function reports back the type of parameterization and all of the parameters for the species, index. More...
 
virtual void initAllPtrs (VPStandardStateTP *vptp_ptr, VPSSMgr *vpssmgr_ptr, MultiSpeciesThermo *spthermo_ptr)
 Initialize or Reinitialize all shallow pointers in the object. More...
 
void initPtrs ()
 Initialize all of the internal shallow pointers that can be initialized. More...
 

Detailed Description

Virtual base class for a species with a pressure dependent standard state.

Virtual base class for calculation of the pressure dependent standard state for a single species

Class PDSS is the base class for a family of classes that compute properties of a set of species in their standard states at a range of temperatures and pressures. The independent variables for this object are temperature and pressure. The class may have a reference to a MultiSpeciesThermo object which handles the calculation of the reference state temperature behavior of a subset of species.

This class is analogous to the SpeciesThermoInterpType class, except that the standard state inherently incorporates the pressure dependence.

The class operates on a setState temperature and pressure basis. It only recalculates the standard state when the setState functions for temperature and pressure are called.

Thread Safety

These classes are designed such that they are not thread safe when called by themselves. The reason for this is that they sometimes use shared MultiSpeciesThermo resources where they set the states. This condition may be remedied in the future if we get serious about employing multithreaded capabilities by adding mutex locks to the MultiSpeciesThermo resources.

However, in many other respects they can be thread safe. They use separate memory and hold intermediate data.

Definition at line 176 of file PDSS.h.

Constructor & Destructor Documentation

◆ PDSS() [1/3]

PDSS ( )

Empty Constructor.

Definition at line 17 of file PDSS.cpp.

Referenced by PDSS::duplMyselfAsPDSS().

◆ PDSS() [2/3]

PDSS ( VPStandardStateTP tp,
size_t  spindex 
)

Constructor that initializes the object by examining the XML entries from the ThermoPhase object.

This function calls the constructPDSS member function.

Parameters
tpPointer to the ThermoPhase object pertaining to the phase
spindexSpecies index of the species in the phase

Definition at line 42 of file PDSS.cpp.

References PDSS::m_spthermo, PDSS::m_vpssmgr_ptr, VPStandardStateTP::provideVPSSMgr(), and ThermoPhase::speciesThermo().

◆ PDSS() [3/3]

PDSS ( const PDSS b)
Deprecated:
Copy constructor to be removed after Cantera 2.3 for all classes derived from PDSS.

Definition at line 73 of file PDSS.cpp.

Member Function Documentation

◆ operator=()

PDSS & operator= ( const PDSS b)
Deprecated:
Assignment operator to be removed after Cantera 2.3 for all classes derived from PDSS.

Definition at line 103 of file PDSS.cpp.

◆ duplMyselfAsPDSS()

PDSS * duplMyselfAsPDSS ( ) const
virtual

Duplication routine for objects which inherit from PDSS.

This function can be used to duplicate objects derived from PDSS even if the application only has a pointer to PDSS to work with.

Returns
A pointer to the base PDSS object type
Deprecated:
To be removed after Cantera 2.3 for all classes derived from PDSS.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 154 of file PDSS.cpp.

References PDSS::PDSS(), and Cantera::warn_deprecated().

◆ reportPDSSType()

PDSS_enumType reportPDSSType ( ) const

Returns the type of the standard state parameterization.

Returns
The integer # of the parameterization
Deprecated:
To be removed after Cantera 2.3.

Definition at line 161 of file PDSS.cpp.

References PDSS::m_pdssType, and Cantera::warn_deprecated().

◆ enthalpy_mole()

doublereal enthalpy_mole ( ) const
virtual

Return the molar enthalpy in units of J kmol-1.

Returns
the species standard state enthalpy in J kmol-1 at the current temperature and pressure.

Reimplemented in PDSS_Nondimensional, PDSS_Water, and PDSS_HKFT.

Definition at line 211 of file PDSS.cpp.

Referenced by PDSS_Molar::enthalpy_RT(), and PDSS::enthalpyDelp_mole().

◆ enthalpy_RT()

doublereal enthalpy_RT ( ) const
virtual

Return the standard state molar enthalpy divided by RT.

Returns
The dimensionless species standard state enthalpy divided at the current temperature and pressure.

Reimplemented in PDSS_Molar, PDSS_SSVol, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 216 of file PDSS.cpp.

Referenced by VPSSMgr_General::_updateStandardStateThermo(), and PDSS_Nondimensional::enthalpy_mole().

◆ intEnergy_mole()

doublereal intEnergy_mole ( ) const
virtual

Return the molar internal Energy in units of J kmol-1.

Returns
The species standard state internal Energy in J kmol-1 at the current temperature and pressure.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_HKFT, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 221 of file PDSS.cpp.

◆ entropy_mole()

doublereal entropy_mole ( ) const
virtual

Return the molar entropy in units of J kmol-1 K-1.

Returns
The species standard state entropy in J kmol-1 K-1 at the current temperature and pressure.

Reimplemented in PDSS_Nondimensional, PDSS_Water, and PDSS_HKFT.

Definition at line 226 of file PDSS.cpp.

Referenced by VPSSMgr_Water_HKFT::_updateRefStateThermo(), PDSS_Molar::entropy_R(), and PDSS::entropyDelp_mole().

◆ entropy_R()

doublereal entropy_R ( ) const
virtual

Return the standard state entropy divided by RT.

Returns
The species standard state entropy divided by RT at the current temperature and pressure.

Reimplemented in PDSS_Molar, PDSS_SSVol, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 231 of file PDSS.cpp.

Referenced by VPSSMgr_General::_updateStandardStateThermo(), VPSSMgr_Water_HKFT::_updateStandardStateThermo(), and PDSS_Nondimensional::entropy_mole().

◆ gibbs_mole()

doublereal gibbs_mole ( ) const
virtual

Return the molar Gibbs free energy in units of J kmol-1.

Returns
The species standard state Gibbs free energy in J kmol-1 at the current temperature and pressure.

Reimplemented in PDSS_Nondimensional, PDSS_Water, and PDSS_HKFT.

Definition at line 236 of file PDSS.cpp.

Referenced by PDSS_Molar::gibbs_RT(), and PDSS::gibbsDelp_mole().

◆ gibbs_RT()

doublereal gibbs_RT ( ) const
virtual

Return the molar Gibbs free energy divided by RT.

Returns
The species standard state Gibbs free energy divided by RT at the current temperature and pressure.

Reimplemented in PDSS_Molar, PDSS_SSVol, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 241 of file PDSS.cpp.

Referenced by VPSSMgr_Water_HKFT::_updateRefStateThermo(), VPSSMgr_Water_HKFT::_updateStandardStateThermo(), and PDSS_Nondimensional::gibbs_mole().

◆ cp_mole()

doublereal cp_mole ( ) const
virtual

Return the molar const pressure heat capacity in units of J kmol-1 K-1.

Returns
The species standard state Cp in J kmol-1 K-1 at the current temperature and pressure.

Reimplemented in PDSS_Nondimensional, PDSS_Water, and PDSS_HKFT.

Definition at line 246 of file PDSS.cpp.

Referenced by PDSS_Molar::cp_R(), and PDSS::cpDelp_mole().

◆ cp_R()

doublereal cp_R ( ) const
virtual

Return the molar const pressure heat capacity divided by RT.

Returns
The species standard state Cp divided by RT at the current temperature and pressure.

Reimplemented in PDSS_Molar, PDSS_SSVol, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 251 of file PDSS.cpp.

Referenced by VPSSMgr_Water_HKFT::_updateRefStateThermo(), VPSSMgr_General::_updateStandardStateThermo(), VPSSMgr_Water_HKFT::_updateStandardStateThermo(), and PDSS_Nondimensional::cp_mole().

◆ cv_mole()

doublereal cv_mole ( ) const
virtual

Return the molar const volume heat capacity in units of J kmol-1 K-1.

Returns
The species standard state Cv in J kmol-1 K-1 at the current temperature and pressure.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 266 of file PDSS.cpp.

◆ molarVolume()

doublereal molarVolume ( ) const
virtual

Return the molar volume at standard state.

Returns
The standard state molar volume at the current temperature and pressure. Units are m**3 kmol-1.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 256 of file PDSS.cpp.

Referenced by VPSSMgr_Water_HKFT::_updateRefStateThermo(), VPSSMgr_General::_updateStandardStateThermo(), and VPSSMgr_Water_HKFT::_updateStandardStateThermo().

◆ density()

doublereal density ( ) const
virtual

Return the standard state density at standard state.

Returns
The standard state density at the current temperature and pressure. units are kg m-3

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 261 of file PDSS.cpp.

Referenced by HMWSoln::calcDensity().

◆ enthalpyDelp_mole()

doublereal enthalpyDelp_mole ( ) const
virtual

Get the difference in the standard state enthalpy between the current pressure and the reference pressure, p0.

Definition at line 296 of file PDSS.cpp.

References PDSS::enthalpy_mole(), PDSS::enthalpy_RT_ref(), Cantera::GasConstant, and PDSS::m_temp.

◆ entropyDelp_mole()

doublereal entropyDelp_mole ( ) const
virtual

Get the difference in the standard state entropy between the current pressure and the reference pressure, p0.

Definition at line 301 of file PDSS.cpp.

References PDSS::entropy_mole(), PDSS::entropy_R_ref(), and Cantera::GasConstant.

◆ gibbsDelp_mole()

doublereal gibbsDelp_mole ( ) const
virtual

Get the difference in the standard state Gibbs free energy between the current pressure and the reference pressure, p0.

Definition at line 306 of file PDSS.cpp.

References Cantera::GasConstant, PDSS::gibbs_mole(), PDSS::gibbs_RT_ref(), and PDSS::m_temp.

◆ cpDelp_mole()

doublereal cpDelp_mole ( ) const
virtual

Get the difference in standard state heat capacity between the current pressure and the reference pressure, p0.

Definition at line 311 of file PDSS.cpp.

References PDSS::cp_mole(), PDSS::cp_R_ref(), and Cantera::GasConstant.

◆ refPressure()

doublereal refPressure ( ) const
inline

Return the reference pressure for this phase.

Definition at line 335 of file PDSS.h.

References PDSS::m_p0.

Referenced by VPSSMgr_General::createInstallPDSS(), VPSSMgr::initThermoXML(), STITbyPDSS::refPressure(), and VPSSMgr::refPressure().

◆ minTemp()

doublereal minTemp ( ) const
inline

return the minimum temperature

Definition at line 340 of file PDSS.h.

References PDSS::m_minTemp.

Referenced by VPSSMgr_General::createInstallPDSS(), VPSSMgr::initThermoXML(), STITbyPDSS::minTemp(), and VPSSMgr::minTemp().

◆ maxTemp()

doublereal maxTemp ( ) const
inline

return the minimum temperature

Definition at line 345 of file PDSS.h.

References PDSS::m_maxTemp.

Referenced by VPSSMgr_General::createInstallPDSS(), VPSSMgr::initThermoXML(), STITbyPDSS::maxTemp(), and VPSSMgr::maxTemp().

◆ gibbs_RT_ref()

doublereal gibbs_RT_ref ( ) const
virtual

Return the molar Gibbs free energy divided by RT at reference pressure.

Returns
The reference state Gibbs free energy at the current temperature, divided by RT.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 271 of file PDSS.cpp.

Referenced by PDSS::gibbsDelp_mole().

◆ enthalpy_RT_ref()

doublereal enthalpy_RT_ref ( ) const
virtual

Return the molar enthalpy divided by RT at reference pressure.

Returns
The species reference state enthalpy at the current temperature, divided by RT.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 276 of file PDSS.cpp.

Referenced by VPSSMgr_General::_updateRefStateThermo(), PDSS::enthalpyDelp_mole(), VPSSMgr_General::getGibbs_ref(), and STITbyPDSS::updatePropertiesTemp().

◆ entropy_R_ref()

doublereal entropy_R_ref ( ) const
virtual

Return the molar entropy divided by R at reference pressure.

Returns
The species reference state entropy at the current temperature, divided by R.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 281 of file PDSS.cpp.

Referenced by VPSSMgr_General::_updateRefStateThermo(), PDSS::entropyDelp_mole(), VPSSMgr_General::getGibbs_ref(), and STITbyPDSS::updatePropertiesTemp().

◆ cp_R_ref()

doublereal cp_R_ref ( ) const
virtual

Return the molar heat capacity divided by R at reference pressure.

Returns
The species reference state heat capacity divided by R at the current temperature.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 286 of file PDSS.cpp.

Referenced by VPSSMgr_General::_updateRefStateThermo(), PDSS::cpDelp_mole(), and STITbyPDSS::updatePropertiesTemp().

◆ molarVolume_ref()

doublereal molarVolume_ref ( ) const
virtual

Return the molar volume at reference pressure.

Returns
The reference state molar volume. units are m**3 kmol-1.

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_HKFT, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 291 of file PDSS.cpp.

Referenced by VPSSMgr_General::_updateRefStateThermo().

◆ pressure()

doublereal pressure ( ) const
virtual

Returns the pressure (Pa)

Reimplemented in PDSS_Water, and PDSS_IdealGas.

Definition at line 316 of file PDSS.cpp.

References PDSS::m_pres.

◆ setPressure()

void setPressure ( doublereal  pres)
virtual

Sets the pressure in the object.

Currently, this sets the pressure in the PDSS object. It is indeterminant what happens to the owning VPStandardStateTP object and to the VPSSMgr object.

Parameters
presPressure to be set (Pascal)

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 341 of file PDSS.cpp.

References PDSS::m_pres.

Referenced by PDSS_HKFT::setState_TP().

◆ thermalExpansionCoeff()

doublereal thermalExpansionCoeff ( ) const
virtual

Return the volumetric thermal expansion coefficient. Units: 1/K.

The thermal expansion coefficient is defined as

\[ \beta = \frac{1}{v}\left(\frac{\partial v}{\partial T}\right)_P \]

Reimplemented in PDSS_Water.

Definition at line 321 of file PDSS.cpp.

◆ setTemperature()

void setTemperature ( doublereal  temp)
virtual

Set the internal temperature.

Parameters
tempTemperature (Kelvin)

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 351 of file PDSS.cpp.

References PDSS::m_temp.

Referenced by VPSSMgr_Water_ConstVol::_updateRefStateThermo(), PDSS_HKFT::setState_TP(), and STITbyPDSS::updatePropertiesTemp().

◆ temperature()

doublereal temperature ( ) const
virtual

Return the current stored temperature.

Reimplemented in PDSS_IonsFromNeutral, and PDSS_IdealGas.

Definition at line 346 of file PDSS.cpp.

References PDSS::m_temp.

Referenced by PDSS_Nondimensional::enthalpy_mole(), PDSS_Molar::enthalpy_RT(), PDSS_Nondimensional::gibbs_mole(), and PDSS_Molar::gibbs_RT().

◆ setState_TP()

void setState_TP ( doublereal  temp,
doublereal  pres 
)
virtual

◆ setState_TR()

void setState_TR ( doublereal  temp,
doublereal  rho 
)
virtual

Set the internal temperature and density.

Parameters
tempTemperature (Kelvin)
rhoDensity (kg m-3)

Reimplemented in PDSS_SSVol, PDSS_Water, PDSS_IonsFromNeutral, PDSS_IdealGas, and PDSS_ConstVol.

Definition at line 370 of file PDSS.cpp.

◆ critTemperature()

doublereal critTemperature ( ) const
virtual

critical temperature

Reimplemented in PDSS_Water.

Definition at line 326 of file PDSS.cpp.

◆ critPressure()

doublereal critPressure ( ) const
virtual

critical pressure

Reimplemented in PDSS_Water.

Definition at line 331 of file PDSS.cpp.

◆ critDensity()

doublereal critDensity ( ) const
virtual

critical density

Reimplemented in PDSS_Water.

Definition at line 336 of file PDSS.cpp.

◆ satPressure()

doublereal satPressure ( doublereal  T)
virtual

saturation pressure

Parameters
TTemperature (Kelvin)

Reimplemented in PDSS_SSVol, PDSS_Water, and PDSS_ConstVol.

Definition at line 375 of file PDSS.cpp.

Referenced by HMWSoln::satPressure().

◆ molecularWeight()

doublereal molecularWeight ( ) const

Return the molecular weight of the species in units of kg kmol-1.

Definition at line 356 of file PDSS.cpp.

References PDSS::m_mw.

◆ setMolecularWeight()

void setMolecularWeight ( doublereal  mw)

Set the molecular weight of the species.

Parameters
mwMolecular Weight in kg kmol-1

Definition at line 360 of file PDSS.cpp.

References PDSS::m_mw.

◆ initThermo()

void initThermo ( )
virtual

Initialization routine for all of the shallow pointers.

This is a cascading call, where each level should call the the parent level.

The initThermo() routines get called before the initThermoXML() routines from the constructPDSSXML() routine.

Calls initPtrs();

Reimplemented in PDSS_SSVol, PDSS_IonsFromNeutral, PDSS_IdealGas, PDSS_HKFT, and PDSS_ConstVol.

Definition at line 175 of file PDSS.cpp.

References AssertThrow, PDSS::initPtrs(), VPSSMgr::initThermo(), PDSS::m_mw, PDSS::m_spindex, PDSS::m_tp, PDSS::m_vpssmgr_ptr, Phase::molecularWeight(), and VPStandardStateTP::provideVPSSMgr().

Referenced by PDSS_ConstVol::constructPDSSXML(), PDSS_SSVol::constructPDSSXML(), PDSS_ConstVol::initThermo(), PDSS_HKFT::initThermo(), PDSS_IdealGas::initThermo(), PDSS_IonsFromNeutral::initThermo(), VPStandardStateTP::initThermo(), and PDSS_SSVol::initThermo().

◆ initThermoXML()

void initThermoXML ( const XML_Node phaseNode,
const std::string &  id 
)
virtual

Initialization routine for the PDSS object based on the phaseNode.

This is a cascading call, where each level should call the the parent level.

Parameters
phaseNodeReference to the phase Information for the phase that owns this species.
idOptional parameter identifying the name of the phase. If none is given, the first XML phase element will be used.

Reimplemented in PDSS_SSVol, and PDSS_ConstVol.

Definition at line 167 of file PDSS.cpp.

References AssertThrow, PDSS::m_maxTemp, PDSS::m_minTemp, PDSS::m_p0, PDSS::m_spindex, PDSS::m_tp, PDSS::m_vpssmgr_ptr, VPSSMgr::maxTemp(), VPSSMgr::minTemp(), and VPSSMgr::refPressure().

Referenced by PDSS_ConstVol::initThermoXML(), VPStandardStateTP::initThermoXML(), and PDSS_SSVol::initThermoXML().

◆ reportParams()

void reportParams ( size_t &  kindex,
int &  type,
doublereal *const  c,
doublereal &  minTemp,
doublereal &  maxTemp,
doublereal &  refPressure 
) const
virtual

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

Parameters
kindexSpecies index
typeInteger type of the standard type
cVector of coefficients used to set the parameters for the standard state.
minTempoutput - Minimum temperature
maxTempoutput - Maximum temperature
refPressureoutput - reference pressure (Pa).

Reimplemented in PDSS_HKFT.

Definition at line 380 of file PDSS.cpp.

◆ initPtrs()

void initPtrs ( )
private

◆ initAllPtrs()

void initAllPtrs ( VPStandardStateTP vptp_ptr,
VPSSMgr vpssmgr_ptr,
MultiSpeciesThermo spthermo_ptr 
)
virtual

Initialize or Reinitialize all shallow pointers in the object.

This command is called to reinitialize all shallow pointers in the object. It's needed for the duplicator capability

Parameters
vptp_ptrPointer to the Variable pressure ThermoPhase object
vpssmgr_ptrPointer to the variable pressure standard state calculator for this phase
spthermo_ptrPointer to the optional MultiSpeciesThermo object that will handle the calculation of the reference state thermodynamic coefficients.
Deprecated:
To be removed after Cantera 2.3 for all classes derived from PDSS.

Reimplemented in PDSS_HKFT, and PDSS_IonsFromNeutral.

Definition at line 184 of file PDSS.cpp.

References PDSS::initPtrs(), PDSS::m_spthermo, PDSS::m_tp, PDSS::m_vpssmgr_ptr, and Cantera::warn_deprecated().

Referenced by PDSS_IonsFromNeutral::initAllPtrs(), and PDSS_HKFT::initAllPtrs().

Member Data Documentation

◆ m_pdssType

PDSS_enumType m_pdssType
protected

Enumerated type describing the type of the PDSS object.

Deprecated:
To be removed after Cantera 2.3.

Definition at line 538 of file PDSS.h.

Referenced by PDSS_ConstVol::PDSS_ConstVol(), PDSS_HKFT::PDSS_HKFT(), PDSS_IdealGas::PDSS_IdealGas(), PDSS_IonsFromNeutral::PDSS_IonsFromNeutral(), PDSS_SSVol::PDSS_SSVol(), and PDSS::reportPDSSType().

◆ m_temp

doublereal m_temp
mutableprotected

◆ m_pres

doublereal m_pres
mutableprotected

◆ m_p0

doublereal m_p0
protected

◆ m_minTemp

doublereal m_minTemp
protected

◆ m_maxTemp

doublereal m_maxTemp
protected

◆ m_tp

VPStandardStateTP* m_tp
protected

◆ m_vpssmgr_ptr

VPSSMgr* m_vpssmgr_ptr
protected

Pointer to the VPSS manager for this object.

Definition at line 564 of file PDSS.h.

Referenced by PDSS::initAllPtrs(), PDSS::initPtrs(), PDSS::initThermo(), PDSS::initThermoXML(), PDSS::PDSS(), PDSS_IdealGas::temperature(), and PDSS_IonsFromNeutral::temperature().

◆ m_mw

doublereal m_mw
protected

◆ m_spindex

size_t m_spindex
protected

Species index in the ThermoPhase corresponding to this species.

Definition at line 570 of file PDSS.h.

Referenced by PDSS_SSVol::calcMolarVolume(), PDSS_ConstVol::constructPDSSXML(), PDSS_HKFT::constructPDSSXML(), PDSS_SSVol::constructPDSSXML(), PDSS_HKFT::convertDGFormation(), PDSS_ConstVol::cp_R(), PDSS_IdealGas::cp_R(), PDSS_SSVol::cp_R(), PDSS_ConstVol::cp_R_ref(), PDSS_SSVol::cp_R_ref(), PDSS_ConstVol::cv_mole(), PDSS_SSVol::cv_mole(), PDSS_ConstVol::density(), PDSS_SSVol::density(), PDSS_ConstVol::enthalpy_RT(), PDSS_IdealGas::enthalpy_RT(), PDSS_SSVol::enthalpy_RT(), PDSS_ConstVol::enthalpy_RT_ref(), PDSS_IdealGas::enthalpy_RT_ref(), PDSS_SSVol::enthalpy_RT_ref(), PDSS_ConstVol::entropy_R(), PDSS_IdealGas::entropy_R(), PDSS_SSVol::entropy_R(), PDSS_ConstVol::entropy_R_ref(), PDSS_IdealGas::entropy_R_ref(), PDSS_SSVol::entropy_R_ref(), PDSS_ConstVol::gibbs_RT(), PDSS_IdealGas::gibbs_RT(), PDSS_SSVol::gibbs_RT(), PDSS_ConstVol::gibbs_RT_ref(), PDSS_IdealGas::gibbs_RT_ref(), PDSS_SSVol::gibbs_RT_ref(), PDSS_ConstVol::initThermo(), PDSS_HKFT::initThermo(), PDSS_IdealGas::initThermo(), PDSS_IonsFromNeutral::initThermo(), PDSS_SSVol::initThermo(), PDSS::initThermo(), PDSS_ConstVol::initThermoXML(), PDSS_SSVol::initThermoXML(), PDSS::initThermoXML(), PDSS_ConstVol::intEnergy_mole(), PDSS_IdealGas::intEnergy_mole(), PDSS_IonsFromNeutral::intEnergy_mole(), PDSS_SSVol::intEnergy_mole(), PDSS_ConstVol::molarVolume(), PDSS_SSVol::molarVolume(), PDSS_ConstVol::molarVolume_ref(), PDSS_SSVol::molarVolume_ref(), PDSS_ConstVol::setPressure(), PDSS_IdealGas::setPressure(), PDSS_ConstVol::setTemperature(), PDSS_IdealGas::setTemperature(), and PDSS_SSVol::setTemperature().

◆ m_spthermo

MultiSpeciesThermo* m_spthermo
protected

Pointer to the species thermodynamic property manager.

This is a copy of the pointer in the ThermoPhase object. Note, this object doesn't own the pointer. If the MultiSpeciesThermo object doesn't know or doesn't control the calculation, this will be set to zero.

Definition at line 579 of file PDSS.h.

Referenced by PDSS::initAllPtrs(), PDSS_IdealGas::initThermo(), PDSS_IonsFromNeutral::initThermo(), PDSS_ConstVol::initThermoXML(), PDSS_SSVol::initThermoXML(), PDSS::PDSS(), PDSS_ConstVol::setTemperature(), PDSS_IdealGas::setTemperature(), and PDSS_SSVol::setTemperature().

◆ m_h0_RT_ptr

doublereal* m_h0_RT_ptr
protected

◆ m_cp0_R_ptr

doublereal* m_cp0_R_ptr
protected

Reference state heat capacity divided by R.

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and m_p0

Definition at line 593 of file PDSS.h.

Referenced by PDSS_IdealGas::cp_R(), PDSS_ConstVol::cp_R_ref(), PDSS_SSVol::cp_R_ref(), PDSS::initPtrs(), PDSS_ConstVol::setTemperature(), PDSS_IdealGas::setTemperature(), and PDSS_SSVol::setTemperature().

◆ m_s0_R_ptr

doublereal* m_s0_R_ptr
protected

Reference state entropy divided by R.

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and m_p0

Definition at line 600 of file PDSS.h.

Referenced by PDSS_IdealGas::entropy_R(), PDSS_ConstVol::entropy_R_ref(), PDSS_IdealGas::entropy_R_ref(), PDSS_SSVol::entropy_R_ref(), PDSS::initPtrs(), PDSS_IdealGas::setPressure(), PDSS_ConstVol::setTemperature(), PDSS_IdealGas::setTemperature(), and PDSS_SSVol::setTemperature().

◆ m_g0_RT_ptr

doublereal* m_g0_RT_ptr
protected

Reference state Gibbs free energy divided by RT.

Calculated at the current value of T and m_p0

Definition at line 606 of file PDSS.h.

Referenced by PDSS_IdealGas::gibbs_RT(), PDSS_ConstVol::gibbs_RT_ref(), PDSS_IdealGas::gibbs_RT_ref(), PDSS_SSVol::gibbs_RT_ref(), PDSS::initPtrs(), PDSS_ConstVol::setTemperature(), PDSS_IdealGas::setTemperature(), and PDSS_SSVol::setTemperature().

◆ m_V0_ptr

doublereal* m_V0_ptr
protected

Reference state molar volume (m3 kg-1)

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and m_p0

Definition at line 613 of file PDSS.h.

Referenced by PDSS_ConstVol::cv_mole(), PDSS_SSVol::cv_mole(), PDSS::initPtrs(), PDSS_ConstVol::initThermo(), PDSS_SSVol::initThermo(), PDSS_ConstVol::molarVolume_ref(), PDSS_SSVol::molarVolume_ref(), and PDSS_IdealGas::setTemperature().

◆ m_hss_RT_ptr

doublereal* m_hss_RT_ptr
protected

Standard state enthalpy divided by RT.

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and P.

Definition at line 620 of file PDSS.h.

Referenced by PDSS_ConstVol::enthalpy_RT(), PDSS_SSVol::enthalpy_RT(), PDSS::initPtrs(), PDSS_ConstVol::setPressure(), PDSS_IdealGas::setPressure(), PDSS_ConstVol::setTemperature(), and PDSS_IdealGas::setTemperature().

◆ m_cpss_R_ptr

doublereal* m_cpss_R_ptr
protected

Standard state heat capacity divided by R.

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and P.

Definition at line 627 of file PDSS.h.

Referenced by PDSS_ConstVol::cp_R(), PDSS_SSVol::cp_R(), PDSS::initPtrs(), PDSS_ConstVol::setTemperature(), and PDSS_IdealGas::setTemperature().

◆ m_sss_R_ptr

doublereal* m_sss_R_ptr
protected

Standard state entropy divided by R.

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and P.

Definition at line 634 of file PDSS.h.

Referenced by PDSS_ConstVol::entropy_R(), PDSS_SSVol::entropy_R(), PDSS::initPtrs(), PDSS_ConstVol::setPressure(), PDSS_IdealGas::setPressure(), PDSS_ConstVol::setTemperature(), and PDSS_IdealGas::setTemperature().

◆ m_gss_RT_ptr

doublereal* m_gss_RT_ptr
protected

Standard state Gibbs free energy divided by RT.

Storage for the thermo properties is provided by VPSSMgr. Calculated at the current value of T and P.

Definition at line 641 of file PDSS.h.

Referenced by PDSS_ConstVol::gibbs_RT(), PDSS_SSVol::gibbs_RT(), PDSS::initPtrs(), PDSS_ConstVol::setPressure(), PDSS_IdealGas::setPressure(), PDSS_ConstVol::setTemperature(), and PDSS_IdealGas::setTemperature().

◆ m_Vss_ptr

doublereal* m_Vss_ptr
protected

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