Cantera  2.0
LTPspecies Class Reference

Class LTPspecies holds transport parameters for a specific liquid-phase species. More...

#include <LTPspecies.h>

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

## Public Member Functions

LTPspecies (const XML_Node *const propNode=0, std::string name="-", TransportPropertyType tp_ind=TP_UNKNOWN, const thermo_t *thermo=0)
Construct an LTPspecies object for a liquid transport property.

LTPspecies (const LTPspecies &right)
Copy constructor.

LTPspeciesoperator= (const LTPspecies &right)
Assignment operator.

virtual ~LTPspecies ()
Destructor.

virtual LTPspeciesduplMyselfAsLTPspecies () const
Duplication routine.

virtual doublereal getSpeciesTransProp ()
Returns the vector of pure species transport property.

virtual bool checkPositive () const
Check to see if the property evaluation will be positive.

doublereal getMixWeight () const
Return the weight mixture.

## Protected Attributes

std::string m_speciesName
Species Name.

LTPTemperatureDependenceType m_model
Model type for the temperature dependence.

TransportPropertyType m_property
enum indicating which property this is (i.e viscosity)

vector_fp m_coeffs
Model temperature-dependence ceofficients.

const thermo_tm_thermo
Pointer to a const thermo object to get current temperature.

doublereal m_mixWeight
Weighting used for mixing.

## Private Member Functions

virtual void adjustCoeffsForComposition ()
Internal model to adjust species-specific properties for composition.

## Detailed Description

Class LTPspecies holds transport parameters for a specific liquid-phase species.

Subclasses handle different means of specifying transport properties like constant, Arrhenius or polynomial fits. In its current state, it is primarily suitable for specifying temperature dependence, but the adjustCoeffsForComposition() method can be implemented to adjust for composition dependence.

Mixing rules for computing mixture transport properties are handled separately in LiquidTranInteraction subclasses.

Definition at line 80 of file LTPspecies.h.

## Constructor & Destructor Documentation

 LTPspecies ( const XML_Node *const propNode = 0, std::string name = "-", TransportPropertyType tp_ind = TP_UNKNOWN, const thermo_t * thermo = 0 )

Construct an LTPspecies object for a liquid transport property.

The species transport property is constructed from the XML node,

<propNode>,

that is a child of the

<transport>

node in the species block and specifies a type of transport property (like viscosity)

Parameters
 propNode Pointer to the XML node that contains the property information. A default value of 0 is allowed for the base class, but not for classes which are assumed to be parameterized by reading XML_Node information. name String containing the species name tp_ind enum TransportPropertyType containing the property id that this object is creating a parameterization for (e.g., viscosity) thermo const pointer to the ThermoPhase object, which is used to find the temperature.

Definition at line 65 of file LTPspecies.cpp.

References ctml::getFloat(), XML_Node::hasChild(), and LTPspecies::m_mixWeight.

Referenced by LTPspecies::duplMyselfAsLTPspecies().

 LTPspecies ( const LTPspecies & right )

Copy constructor.

Parameters
 right Object to be copied

Definition at line 81 of file LTPspecies.cpp.

 ~LTPspecies ( )
virtual

Destructor.

Definition at line 110 of file LTPspecies.cpp.

## Member Function Documentation

 LTPspecies & operator= ( const LTPspecies & right )

Assignment operator.

Parameters
 right Object to be copied

Definition at line 87 of file LTPspecies.cpp.

 LTPspecies * duplMyselfAsLTPspecies ( ) const
virtual

Duplication routine.

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

Reimplemented in LTPspecies_ExpT, LTPspecies_Poly, LTPspecies_Arrhenius, and LTPspecies_Const.

Definition at line 104 of file LTPspecies.cpp.

References LTPspecies::LTPspecies().

 doublereal getSpeciesTransProp ( )
virtual

Returns the vector of 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 by the subclass object.

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

Reimplemented in LTPspecies_ExpT, LTPspecies_Poly, LTPspecies_Arrhenius, and LTPspecies_Const.

Definition at line 121 of file LTPspecies.cpp.

 bool checkPositive ( ) const
virtual

Check to see if the property evaluation will be positive.

Returns
Returns a boolean

Definition at line 127 of file LTPspecies.cpp.

References LTPspecies::m_coeffs.

 doublereal getMixWeight ( ) const

Return the weight mixture.

Returns
Returns a single double which is used as a weight

Definition at line 132 of file LTPspecies.cpp.

References LTPspecies::m_mixWeight.

 void adjustCoeffsForComposition ( )
privatevirtual

Internal model to adjust species-specific properties for composition.

Currently just a place holder, but this method could take the composition from the thermo object and adjust coefficients accoding to some unspecified model.

Definition at line 143 of file LTPspecies.cpp.

## Member Data Documentation

 std::string m_speciesName
protected

Species Name.

Definition at line 160 of file LTPspecies.h.

Referenced by LTPspecies::operator=().

 LTPTemperatureDependenceType m_model
protected

Model type for the temperature dependence.

Definition at line 163 of file LTPspecies.h.

 TransportPropertyType m_property
protected

enum indicating which property this is (i.e viscosity)

Definition at line 166 of file LTPspecies.h.

Referenced by LTPspecies_Arrhenius::getSpeciesTransProp(), and LTPspecies::operator=().

 vector_fp m_coeffs
protected

Model temperature-dependence ceofficients.

Definition at line 169 of file LTPspecies.h.

 const thermo_t* m_thermo
protected

Pointer to a const thermo object to get current temperature.

Definition at line 172 of file LTPspecies.h.

 doublereal m_mixWeight
protected

Weighting used for mixing.

This weighting can be employed to allow salt transport properties to be represented by specific ions. For example, to have Li+ and Ca+ represent the mixing transport properties of LiCl and CaCl2, the weightings for Li+ would be 2.0, for K+ would be 3.0 and for Cl- would be 0.0. The transport properties for Li+ would be those for LiCl and the transport properties for Ca+ would be those for CaCl2. The transport properties for Cl- should be something innoccuous like 1.0–note that 0.0 is not innocuous if there are logarithms involved.

Definition at line 186 of file LTPspecies.h.

Referenced by LTPspecies::getMixWeight(), LTPspecies::LTPspecies(), and LTPspecies::operator=().

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