Cantera  2.4.0
Public Member Functions | List of all members
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:
[legend]
Collaboration diagram for LTPspecies_Const:
[legend]

Public Member Functions

virtual LTPspeciesduplMyselfAsLTPspecies () const
 Duplication routine. More...
 
virtual void setupFromXML (const XML_Node &propNode)
 Set up the species transport property 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) More...
 
void setCoeff (double C)
 
doublereal getSpeciesTransProp ()
 Returns the vector of standard state species transport property. More...
 
- Public Member Functions inherited from LTPspecies
void setThermo (thermo_t *thermo)
 Set the ThermoPhase object, which is used to find the temperature. More...
 
void setName (const std::string &name)
 Set the species name. More...
 
void setTransportPropertyType (TransportPropertyType tp_ind)
 TransportPropertyType containing the property id that this object is creating a parameterization for (e.g., viscosity) 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_tm_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 190 of file LTPspecies.h.

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 from LTPspecies.

Definition at line 106 of file LTPspecies.cpp.

◆ setupFromXML()

void setupFromXML ( const XML_Node propNode)
virtual

Set up the species transport property 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)

Reimplemented from LTPspecies.

Definition at line 91 of file LTPspecies.cpp.

References Cantera::getFloatCurrent(), and XML_Node::name().

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

Definition at line 111 of file LTPspecies.cpp.


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