Cantera  2.3.0
Public Member Functions | Protected Attributes | List of all members
LTPspecies_Poly Class Reference

Class LTPspecies_Poly holds transport parameters for a specific liquid-phase species (LTPspecies) when the transport property is expressed as a polynomial in temperature. More...

#include <LTPspecies.h>

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

Public Member Functions

 LTPspecies_Poly (const XML_Node &propNode, const std::string name, TransportPropertyType tp_ind, const thermo_t *thermo)
 Construct an LTPspecies object for a liquid transport property expressed as a polynomial in temperature. More...
 
virtual LTPspeciesduplMyselfAsLTPspecies () const
 Duplication routine. More...
 
doublereal getSpeciesTransProp ()
 Returns the vector of standard state species transport property. More...
 
- Public Member Functions inherited from LTPspecies
 LTPspecies (const XML_Node *const propNode=0, const std::string name="-", TransportPropertyType tp_ind=TP_UNKNOWN, const thermo_t *thermo=0)
 Construct an LTPspecies object for a liquid transport property. More...
 
virtual bool checkPositive () const
 Check to see if the property evaluation will be positive. More...
 
doublereal getMixWeight () const
 Return the weight mixture. More...
 

Protected Attributes

doublereal m_temp
 temperature from thermo object More...
 
doublereal m_prop
 most recent evaluation of transport property More...
 
- Protected Attributes inherited from LTPspecies
std::string m_speciesName
 Species Name for the property that is being described. More...
 
LTPTemperatureDependenceType m_model
 Model type for the temperature dependence. More...
 
TransportPropertyType m_property
 enum indicating which property this is (i.e viscosity) More...
 
vector_fp m_coeffs
 Model temperature-dependence ceofficients. More...
 
const thermo_tm_thermo
 Pointer to a const thermo object to get current temperature. More...
 
doublereal m_mixWeight
 Weighting used for mixing. More...
 

Detailed Description

Class LTPspecies_Poly holds transport parameters for a specific liquid-phase species (LTPspecies) when the transport property is expressed as a polynomial in temperature.

Used for standard state species properties with equations of the form

\[ x = f[0] + f[1] T + ... + f[N] T^N \]

where f[i] are elements of the float array passed in.

As an example of the input required for LTPspecies_Poly consider the following XML fragment

*    <species>
*      <!-- thermodynamic properties -->
*      <transport>
*        <thermalConductivity model="coeffs">
*           <floatArray size="2">  0.6, -15.0e-5 </floatArray>
*        </thermalConductivity>
*        <!-- other transport properties -->
*      </transport>
*    </species>
* 

Definition at line 322 of file LTPspecies.h.

Constructor & Destructor Documentation

◆ LTPspecies_Poly()

LTPspecies_Poly ( const XML_Node propNode,
const std::string  name,
TransportPropertyType  tp_ind,
const thermo_t thermo 
)

Construct an LTPspecies object for a liquid transport property expressed as a polynomial in temperature.

The transport property is constructed from the XML node, <propNode>, that is a child of the <transport> node and specifies a type of transport property (like viscosity).

Parameters
propNodeReference to the XML node that contains the property information. This class must be parameterized by reading XML_Node information.
nameString containing the species name
tp_indenum TransportPropertyType containing the property id that this object is creating a parameterization for (e.g., viscosity)
thermoconst pointer to the ThermoPhase object, which is used to find the temperature.

Definition at line 159 of file LTPspecies.cpp.

References Cantera::getFloatArray(), LTPspecies::m_coeffs, and LTPspecies::m_model.

Referenced by LTPspecies_Poly::duplMyselfAsLTPspecies().

Member Function Documentation

◆ duplMyselfAsLTPspecies()

LTPspecies * duplMyselfAsLTPspecies ( ) const
virtual

Duplication routine.

(virtual from LTPspecies)

Returns
a copy of this routine as a pointer to LTPspecies

Reimplemented from LTPspecies.

Definition at line 169 of file LTPspecies.cpp.

References LTPspecies_Poly::LTPspecies_Poly().

◆ getSpeciesTransProp()

doublereal getSpeciesTransProp ( )
virtual

Returns the vector of standard state species transport property.

The standard state species transport property is returned. Any temperature and composition dependence will be adjusted internally according to the information provided by the subclass object.

Returns
a single double containing the property evaluation at the current ThermoPhase temperature.

Reimplemented from LTPspecies.

Definition at line 174 of file LTPspecies.cpp.

References LTPspecies::m_coeffs, LTPspecies_Poly::m_prop, LTPspecies_Poly::m_temp, LTPspecies::m_thermo, and Phase::temperature().

Member Data Documentation

◆ m_temp

doublereal m_temp
protected

temperature from thermo object

Definition at line 349 of file LTPspecies.h.

Referenced by LTPspecies_Poly::getSpeciesTransProp().

◆ m_prop

doublereal m_prop
protected

most recent evaluation of transport property

Definition at line 352 of file LTPspecies.h.

Referenced by LTPspecies_Poly::getSpeciesTransProp().


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