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

	LTPspecies_Const (const LTPspecies_Const &right)
	Copy constructor.

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

virtual	~LTPspecies_Const ()
	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
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_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 209 of file LTPspecies.h.

Constructor & Destructor Documentation

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

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

References ctml::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 168 of file LTPspecies.cpp.

~LTPspecies_Const ( )

virtual

Destructor.

Definition at line 183 of file LTPspecies.cpp.

Member Function Documentation

LTPspecies_Const & operator= ( const LTPspecies_Const & right )

Assignment operator.

Parameters

right Object to be copied

Definition at line 175 of file LTPspecies.cpp.

References 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 191 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 198 of file LTPspecies.cpp.

References LTPspecies::m_coeffs.

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

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