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:

Collaboration diagram for LTPspecies_Const:

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)
	Copy Constructor. More...
LTPspecies_Const &	operator= (const LTPspecies_Const &right)
	Assignment operator. More...
virtual LTPspecies *	duplMyselfAsLTPspecies () const
	Duplicates the current object given the parent class reference. More...
doublereal	getSpeciesTransProp ()
	Returns the 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...
	LTPspecies (const LTPspecies &right)
	Copy Constructor. More...
LTPspecies &	operator= (const LTPspecies &right)
	Assignment operator. More...
virtual	~LTPspecies ()
	Destructor. More...
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 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_t *	m_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 195 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 (e.g., viscosity).

Parameters

propNode	Reference to the XML node that contains the property 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 112 of file LTPspecies.cpp.

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

Referenced by LTPspecies_Const::duplMyselfAsLTPspecies().

LTPspecies_Const

(

const LTPspecies_Const &

right

)

Copy Constructor.

Parameters

right

Object to be copied

Definition at line 125 of file LTPspecies.cpp.

Member Function Documentation

LTPspecies_Const & operator=

(

const LTPspecies_Const &

right

)

Assignment operator.

Parameters

right

Object to be copied

Returns

returns a reference to the current object

Definition at line 131 of file LTPspecies.cpp.

References LTPspecies::operator=().

LTPspecies * duplMyselfAsLTPspecies ( ) const

virtual

Duplicates the current object given the parent class reference.

Returns

returns a malloced duplicate to the current object using the base class pointer

Reimplemented from LTPspecies.

Definition at line 139 of file LTPspecies.cpp.

References LTPspecies_Const::LTPspecies_Const().

doublereal getSpeciesTransProp ( )

virtual

Returns the standard state species transport property.

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

Reimplemented from LTPspecies.

Definition at line 144 of file LTPspecies.cpp.

References LTPspecies::m_coeffs.

---

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

• LTPspecies.h
• LTPspecies.cpp