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>
Public Member Functions | |
| virtual LTPspecies * | duplMyselfAsLTPspecies () 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... | |
| doublereal | getSpeciesTransProp () |
| Returns the vector of standard state species transport property. More... | |
| void | setCoeffs (size_t N, const double *coeffs) |
 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... | |
Protected Attributes | |
| doublereal | m_temp |
| temperature from thermo object More... | |
| doublereal | m_prop |
| most recent evaluation of transport property More... | |
| 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_Poly holds transport parameters for a specific liquid-phase species (LTPspecies) when the transport property is expressed as a polynomial in temperature.
Used for standard state 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 303 of file LTPspecies.h.
Member Function Documentation
◆ duplMyselfAsLTPspecies()
|
virtual |
Duplication routine.
(virtual from LTPspecies)
- Returns
- a copy of this routine as a pointer to LTPspecies
Reimplemented from LTPspecies.
Definition at line 173 of file LTPspecies.cpp.
◆ setupFromXML()
|
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 178 of file LTPspecies.cpp.
References Cantera::getFloatArray().
◆ 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 190 of file LTPspecies.cpp.
References LTPspecies::m_coeffs, LTPspecies_Poly::m_prop, LTPspecies_Poly::m_temp, LTPspecies::m_thermo, and Phase::temperature().
Member Data Documentation
◆ m_temp
|
protected |
temperature from thermo object
Definition at line 317 of file LTPspecies.h.
Referenced by LTPspecies_Poly::getSpeciesTransProp().
◆ m_prop
|
protected |
most recent evaluation of transport property
Definition at line 320 of file LTPspecies.h.
Referenced by LTPspecies_Poly::getSpeciesTransProp().
The documentation for this class was generated from the following files:
