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

#include <LTPspecies.h>

Inheritance diagram for LTPspecies:

Collaboration diagram for LTPspecies:

Public Member Functions
	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...

virtual LTPspecies *	duplMyselfAsLTPspecies () const
	Duplication routine. More...

virtual doublereal	getSpeciesTransProp ()
	Returns the vector of standard state species transport property. More...

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

doublereal	getMixWeight () const
	Return the weight mixture. More...

Protected Attributes
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...

Private Member Functions
virtual void	adjustCoeffsForComposition ()
	Internal model to adjust species-specific properties for the composition. More...

Detailed Description

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

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

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

Definition at line 76 of file LTPspecies.h.

Constructor & Destructor Documentation

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

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

Referenced by LTPspecies::duplMyselfAsLTPspecies().

Member Function Documentation

◆ duplMyselfAsLTPspecies()

LTPspecies * duplMyselfAsLTPspecies ( ) const

virtual

Duplication routine.

(virtual from LTPspecies)

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

References LTPspecies::LTPspecies().

◆ getSpeciesTransProp()

doublereal getSpeciesTransProp ( )

virtual

Returns the vector of standard state species transport property.

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

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

Referenced by SolidTransport::defectActivity(), SolidTransport::defectDiffusivity(), SolidTransport::electricalConductivity(), SolidTransport::ionConductivity(), and SolidTransport::thermalConductivity().

◆ checkPositive()

bool checkPositive ( ) const

virtual

Check to see if the property evaluation will be positive.

Definition at line 75 of file LTPspecies.cpp.

References LTPspecies::m_coeffs.

◆ getMixWeight()

doublereal getMixWeight ( ) const

Return the weight mixture.

Definition at line 80 of file LTPspecies.cpp.

References LTPspecies::m_mixWeight.

◆ adjustCoeffsForComposition()

void adjustCoeffsForComposition ( )

privatevirtual

Internal model to adjust species-specific properties for the composition.

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

Definition at line 85 of file LTPspecies.cpp.

Member Data Documentation

◆ m_speciesName

std::string m_speciesName

protected

Species Name for the property that is being described.

Definition at line 136 of file LTPspecies.h.

◆ m_model

LTPTemperatureDependenceType m_model

protected

Model type for the temperature dependence.

Definition at line 139 of file LTPspecies.h.

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

◆ m_property

TransportPropertyType m_property

protected

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

Definition at line 142 of file LTPspecies.h.

Referenced by LTPspecies_Arrhenius::getSpeciesTransProp().

◆ m_coeffs

vector_fp m_coeffs

protected

Model temperature-dependence ceofficients.

Definition at line 145 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(), and LTPspecies_Poly::LTPspecies_Poly().

◆ m_thermo

const thermo_t* m_thermo

protected

Pointer to a const thermo object to get current temperature.

Definition at line 148 of file LTPspecies.h.

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

◆ m_mixWeight

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

Referenced by LTPspecies::getMixWeight().

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

Public Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ LTPspecies()

Member Function Documentation

◆ duplMyselfAsLTPspecies()

◆ getSpeciesTransProp()

◆ checkPositive()

◆ getMixWeight()

◆ adjustCoeffsForComposition()

Member Data Documentation

◆ m_speciesName

◆ m_model

◆ m_property

◆ m_coeffs

◆ m_thermo

◆ m_mixWeight