Cantera  2.1.2
Public Member Functions | List of all members
LTPspecies_Const Class Reference

Class LTPspecies_Const holds transport parameters for a specific liquid-phase species (LTPspecies) when the transport property is just a constant value. More...

#include <LTPspecies.h>

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

Public Member Functions

 LTPspecies_Const (const XML_Node &propNode, const std::string name, TransportPropertyType tp_ind, const thermo_t *const thermo)
 Construct an LTPspecies object for a liquid transport property expressed as a constant value. More...
 
 LTPspecies_Const (const LTPspecies_Const &right)
 
LTPspecies_Constoperator= (const LTPspecies_Const &right)
 
virtual LTPspeciesduplMyselfAsLTPspecies () const
 Duplication routine. More...
 
doublereal getSpeciesTransProp ()
 Returns the pure 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...
 
 LTPspecies (const LTPspecies &right)
 
LTPspeciesoperator= (const LTPspecies &right)
 
virtual bool checkPositive () const
 Check to see if the property evaluation will be positive. More...
 
doublereal getMixWeight () const
 Return the weight mixture. More...
 

Additional Inherited Members

- Protected Attributes inherited from LTPspecies
std::string m_speciesName
 Species Name. 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_Const holds transport parameters for a specific liquid-phase species (LTPspecies) when the transport property is just a constant value.

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

*    <species>
*      <!-- thermodynamic properties -->
*      <transport>
*        <hydrodynamicRadius model="Constant" units="A">
*            1.000
*        </hydrodynamicRadius>
*        <!-- other transport properties -->
*      </transport>
*    </species>
* 

Definition at line 182 of file LTPspecies.h.

Constructor & Destructor Documentation

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

Construct an LTPspecies object for a liquid transport property expressed as a constant value.

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.
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 116 of file LTPspecies.cpp.

References ctml::getFloatCurrent(), LTPspecies::m_coeffs, LTPspecies::m_model, and XML_Node::name().

Referenced by LTPspecies_Const::duplMyselfAsLTPspecies().

Member Function Documentation

LTPspecies * duplMyselfAsLTPspecies ( ) const
virtual

Duplication routine.

Returns
Returns a copy of this routine as a pointer to LTPspecies

Reimplemented from LTPspecies.

Definition at line 143 of file LTPspecies.cpp.

References LTPspecies_Const::LTPspecies_Const().

doublereal getSpeciesTransProp ( )
virtual

Returns the pure species transport property.

The pure species transport property (i.e. pure species viscosity) is returned. Any temperature and composition dependence will be adjusted internally according to the information provided.

Reimplemented from LTPspecies.

Definition at line 148 of file LTPspecies.cpp.

References LTPspecies::m_coeffs.


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