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, 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.

	LTPspecies_Poly (const LTPspecies_Poly &right)
	Copy constructor.

LTPspecies_Poly &	operator= (const LTPspecies_Poly &right)
	Assignment operator.

virtual	~LTPspecies_Poly ()
	Destructor.

virtual LTPspecies *	duplMyselfAsLTPspecies () const
	Duplication routine.

doublereal	getSpeciesTransProp ()
	Returns the 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
doublereal	m_temp
	temperature from thermo object

doublereal	m_prop
	most recent evaluation of transport property

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_t *	m_thermo
	Pointer to a const thermo object to get current temperature.

doublereal	m_mixWeight
	Weighting used for mixing.

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 pure 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 400 of file LTPspecies.h.

Constructor & Destructor Documentation

LTPspecies_Poly	(	const XML_Node &	propNode,
		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

propNode	Reference to the XML node that contains the property information. This class must 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 332 of file LTPspecies.cpp.

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

Referenced by LTPspecies_Poly::duplMyselfAsLTPspecies().

LTPspecies_Poly ( const LTPspecies_Poly & right )

Copy constructor.

Parameters

right Object to be copied

Definition at line 343 of file LTPspecies.cpp.

~LTPspecies_Poly ( )

virtual

Destructor.

Definition at line 360 of file LTPspecies.cpp.

Member Function Documentation

LTPspecies_Poly & operator= ( const LTPspecies_Poly & right )

Assignment operator.

Parameters

right Object to be copied

Definition at line 350 of file LTPspecies.cpp.

References LTPspecies_Poly::m_prop, LTPspecies_Poly::m_temp, and LTPspecies::operator=().

LTPspecies * duplMyselfAsLTPspecies ( ) const

virtual

Duplication routine.

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

Reimplemented from LTPspecies.

Definition at line 368 of file LTPspecies.cpp.

References LTPspecies_Poly::LTPspecies_Poly().

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

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

bool checkPositive ( ) const

virtualinherited

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

inherited

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.

Member Data Documentation

doublereal m_temp

protected

temperature from thermo object

Definition at line 453 of file LTPspecies.h.

Referenced by LTPspecies_Poly::getSpeciesTransProp(), and LTPspecies_Poly::operator=().

doublereal m_prop

protected

most recent evaluation of transport property

Definition at line 456 of file LTPspecies.h.

Referenced by LTPspecies_Poly::getSpeciesTransProp(), and LTPspecies_Poly::operator=().

std::string m_speciesName

protectedinherited

Species Name.

Definition at line 160 of file LTPspecies.h.

Referenced by LTPspecies::operator=().

LTPTemperatureDependenceType m_model

protectedinherited

Model type for the temperature dependence.

Definition at line 163 of file LTPspecies.h.

Referenced by LTPspecies_Arrhenius::LTPspecies_Arrhenius(), LTPspecies_Const::LTPspecies_Const(), LTPspecies_ExpT::LTPspecies_ExpT(), LTPspecies_Poly::LTPspecies_Poly(), and LTPspecies::operator=().

TransportPropertyType m_property

protectedinherited

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

protectedinherited

Model temperature-dependence ceofficients.

Definition at line 169 of file LTPspecies.h.

Referenced by LTPspecies::checkPositive(), LTPspecies_Const::getSpeciesTransProp(), LTPspecies_Arrhenius::getSpeciesTransProp(), LTPspecies_Poly::getSpeciesTransProp(), LTPspecies_ExpT::getSpeciesTransProp(), LTPspecies_Arrhenius::LTPspecies_Arrhenius(), LTPspecies_Const::LTPspecies_Const(), LTPspecies_ExpT::LTPspecies_ExpT(), LTPspecies_Poly::LTPspecies_Poly(), and LTPspecies::operator=().

const thermo_t* m_thermo

protectedinherited

Pointer to a const thermo object to get current temperature.

Definition at line 172 of file LTPspecies.h.

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

doublereal m_mixWeight

protectedinherited

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:

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation