Clean up Doxygen docs for some liquid transport related classes
This commit is contained in:
Ray Speth
parent
d253fc0d63
commit
b888df70c4
5 changed files with 62 additions and 329 deletions
|
|
@ -12,7 +12,6 @@
|
|||
namespace Cantera
|
||||
{
|
||||
|
||||
//====================================================================================================================
|
||||
//! Enumeration of the types of transport properties that can be
|
||||
//! handled by the variables in the various Transport classes.
|
||||
/*!
|
||||
|
|
@ -44,7 +43,6 @@ enum TransportPropertyType {
|
|||
TP_DEFECTDIFF
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
//! Temperature dependence type for pure (liquid) species properties
|
||||
/*!
|
||||
* Types of temperature dependencies:
|
||||
|
|
@ -61,7 +59,6 @@ enum LTPTemperatureDependenceType {
|
|||
LTP_TD_EXPT
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
//! Class LTPspecies holds transport parameters for a specific liquid-phase species.
|
||||
/*!
|
||||
* Subclasses handle different means of specifying transport properties
|
||||
|
|
@ -75,15 +72,13 @@ enum LTPTemperatureDependenceType {
|
|||
*/
|
||||
class LTPspecies
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
//! Construct an LTPspecies object for a liquid transport property.
|
||||
/*!
|
||||
* The species transport property is constructed from the XML node,
|
||||
* \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node in the species block and specifies a type of transport
|
||||
* property (like viscosity)
|
||||
* `<propNode>` that is a child of the `<transport>` node in the
|
||||
* species block and specifies a type of transport property (like
|
||||
* viscosity)
|
||||
*
|
||||
* @param 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
|
||||
|
|
@ -96,19 +91,8 @@ public:
|
|||
LTPspecies(const XML_Node* const propNode = 0, const std::string name = "-",
|
||||
TransportPropertyType tp_ind = TP_UNKNOWN, const thermo_t* thermo = 0);
|
||||
|
||||
//! Copy constructor
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies(const LTPspecies& right);
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies& operator=(const LTPspecies& right);
|
||||
|
||||
//! Destructor
|
||||
virtual ~LTPspecies();
|
||||
|
||||
//! Duplication routine
|
||||
|
|
@ -130,15 +114,9 @@ public:
|
|||
virtual doublereal getSpeciesTransProp();
|
||||
|
||||
//! Check to see if the property evaluation will be positive
|
||||
/*!
|
||||
* @return Returns a boolean
|
||||
*/
|
||||
virtual bool checkPositive() const;
|
||||
|
||||
//! Return the weight mixture
|
||||
/*!
|
||||
* @return Returns a single double which is used as a weight
|
||||
*/
|
||||
doublereal getMixWeight() const;
|
||||
|
||||
private:
|
||||
|
|
@ -182,7 +160,6 @@ protected:
|
|||
doublereal m_mixWeight;
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
//! Class LTPspecies_Const holds transport parameters for a
|
||||
//! specific liquid-phase species (LTPspecies) when the
|
||||
//! transport property is just a constant value.
|
||||
|
|
@ -204,16 +181,12 @@ protected:
|
|||
*/
|
||||
class LTPspecies_Const : public LTPspecies
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
//! Construct an LTPspecies object for a liquid transport property
|
||||
//! expressed as a constant value.
|
||||
/** The transport property is constructed from the XML node,
|
||||
* \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of
|
||||
* transport property (like viscosity).
|
||||
*
|
||||
* `<propNode>`, that is a child of the `<transport>` node and specifies
|
||||
* a type of transport property (like viscosity).
|
||||
*
|
||||
* @param propNode Reference to the XML node that contains the property information.
|
||||
* @param name String containing the species name
|
||||
|
|
@ -224,22 +197,8 @@ public:
|
|||
LTPspecies_Const(const XML_Node& propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* const thermo);
|
||||
|
||||
//! Copy constructor
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_Const(const LTPspecies_Const& right);
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_Const& operator=(const LTPspecies_Const& right);
|
||||
|
||||
//! duplication routine
|
||||
/*!
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
virtual LTPspecies* duplMyselfAsLTPspecies() const;
|
||||
|
||||
//! Returns the pure species transport property
|
||||
|
|
@ -249,10 +208,8 @@ public:
|
|||
* adjusted internally according to the information provided.
|
||||
*/
|
||||
doublereal getSpeciesTransProp();
|
||||
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
//! Class LTPspecies_Arrhenius holds transport parameters for a
|
||||
//! specific liquid-phase species (LTPspecies) when the
|
||||
//! transport property is expressed in Arrhenius form.
|
||||
|
|
@ -283,16 +240,13 @@ public:
|
|||
*/
|
||||
class LTPspecies_Arrhenius : public LTPspecies
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
//! Construct an LTPspecies object for a liquid transport property
|
||||
//! expressed in extended Arrhenius form.
|
||||
/*!
|
||||
* The transport property is constructed from the XML node,
|
||||
* \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of transport property (like viscosity)
|
||||
*
|
||||
* 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)
|
||||
*
|
||||
* @param propNode Reference to the XML node that contains the property information.This class
|
||||
* is assumed to be parameterized by reading XML_Node information.
|
||||
|
|
@ -300,28 +254,12 @@ public:
|
|||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*
|
||||
|
||||
*/
|
||||
LTPspecies_Arrhenius(const XML_Node& propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* thermo);
|
||||
|
||||
//! Copy constructor
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_Arrhenius(const LTPspecies_Arrhenius& right);
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_Arrhenius& operator=(const LTPspecies_Arrhenius& right);
|
||||
|
||||
//! duplication routine
|
||||
/*!
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
virtual LTPspecies* duplMyselfAsLTPspecies() const;
|
||||
|
||||
//! Return the pure species value for this transport property evaluated
|
||||
|
|
@ -333,10 +271,9 @@ public:
|
|||
* \mu = A T^n \exp( - E / R T ).
|
||||
* \f]
|
||||
*
|
||||
* Note that for viscosity, the convention is such that
|
||||
* a positive activation energy corresponds to the typical
|
||||
* case of a positive argument to the exponential so that
|
||||
* the Arrhenius expression is
|
||||
* Note that for viscosity, the convention is such that a positive
|
||||
* activation energy corresponds to the typical case of a positive
|
||||
* argument to the exponential so that the Arrhenius expression is
|
||||
*
|
||||
* \f[
|
||||
* \mu = A T^n \exp( + E / R T ).
|
||||
|
|
@ -348,7 +285,6 @@ public:
|
|||
doublereal getSpeciesTransProp();
|
||||
|
||||
protected:
|
||||
|
||||
//! temperature from thermo object
|
||||
doublereal m_temp;
|
||||
|
||||
|
|
@ -362,7 +298,6 @@ protected:
|
|||
doublereal m_logProp;
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
//! Class LTPspecies_Poly holds transport parameters for a
|
||||
//! specific liquid-phase species (LTPspecies) when the transport
|
||||
//! property is expressed as a polynomial in temperature.
|
||||
|
|
@ -390,14 +325,12 @@ protected:
|
|||
*/
|
||||
class LTPspecies_Poly : public LTPspecies
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
//! Construct an LTPspecies object for a liquid transport property expressed as a polynomial in temperature.
|
||||
/*!
|
||||
* The transport property is constructed from the XML node, \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of transport property (like viscosity).
|
||||
*
|
||||
* 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).
|
||||
*
|
||||
* @param propNode Reference to the XML node that contains the property information. This class
|
||||
* must be parameterized by reading XML_Node information.
|
||||
|
|
@ -405,27 +338,11 @@ public:
|
|||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*
|
||||
|
||||
*/
|
||||
LTPspecies_Poly(const XML_Node& propNode, const std::string name, TransportPropertyType tp_ind, const thermo_t* thermo);
|
||||
|
||||
//! Copy constructor
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_Poly(const LTPspecies_Poly& right);
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_Poly& operator=(const LTPspecies_Poly& right);
|
||||
|
||||
//! Duplication routine
|
||||
/*!
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
virtual LTPspecies* duplMyselfAsLTPspecies() const;
|
||||
|
||||
//! Returns the pure species transport property
|
||||
|
|
@ -437,18 +354,16 @@ public:
|
|||
doublereal getSpeciesTransProp();
|
||||
|
||||
protected:
|
||||
|
||||
//! temperature from thermo object
|
||||
doublereal m_temp;
|
||||
|
||||
//! most recent evaluation of transport property
|
||||
doublereal m_prop;
|
||||
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
//! Class LTPspecies_ExpT holds transport parameters for a specific liquid-phase species (LTPspecies)
|
||||
//! when the transport property is expressed as an exponential in temperature.
|
||||
//! Class LTPspecies_ExpT holds transport parameters for a specific liquid-
|
||||
//! phase species (LTPspecies) when the transport property is expressed as an
|
||||
//! exponential in temperature.
|
||||
/*!
|
||||
* Used for pure species properties with equations of the form
|
||||
*
|
||||
|
|
@ -475,15 +390,13 @@ protected:
|
|||
*/
|
||||
class LTPspecies_ExpT : public LTPspecies
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
//! Construct an LTPspecies object for a liquid transport property
|
||||
//! expressed as an exponential in temperature.
|
||||
/*!
|
||||
* The transport property is constructed from the XML node, \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of transport property (like viscosity).
|
||||
*
|
||||
* 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).
|
||||
*
|
||||
* @param propNode Reference to the XML node that contains the property information. This class
|
||||
* must be parameterized by reading XML_Node information.
|
||||
|
|
@ -491,28 +404,12 @@ public:
|
|||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*
|
||||
*/
|
||||
LTPspecies_ExpT(const XML_Node& propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* thermo);
|
||||
|
||||
|
||||
//! Copy constructor
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_ExpT(const LTPspecies_ExpT& right);
|
||||
|
||||
//! Assignment operator
|
||||
/*!
|
||||
* @param right Object to be copied
|
||||
*/
|
||||
LTPspecies_ExpT& operator=(const LTPspecies_ExpT& right);
|
||||
|
||||
//! Duplication routine
|
||||
/*!
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
virtual LTPspecies* duplMyselfAsLTPspecies() const;
|
||||
|
||||
//! Returns the pure species transport property
|
||||
|
|
@ -524,16 +421,12 @@ public:
|
|||
doublereal getSpeciesTransProp();
|
||||
|
||||
protected:
|
||||
|
||||
//! temperature from thermo object
|
||||
doublereal m_temp;
|
||||
|
||||
//! most recent evaluation of transport property
|
||||
doublereal m_prop;
|
||||
|
||||
};
|
||||
|
||||
//====================================================================================================================
|
||||
|
||||
}
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -17,12 +17,11 @@ namespace Cantera
|
|||
/*!
|
||||
* A LiquidTransportData object is created for each species.
|
||||
*
|
||||
* This class is mainly used to collect transport properties
|
||||
* from the parse phase in the TransportFactory and transfer
|
||||
* them to the Transport class. Transport properties are
|
||||
* expressed by subclasses of LTPspecies.
|
||||
* One may need to be careful about deleting pointers to LTPspecies
|
||||
* objects created in the TransportFactory.
|
||||
* This class is mainly used to collect transport properties from the parse
|
||||
* phase in the TransportFactory and transfer them to the Transport class.
|
||||
* Transport properties are expressed by subclasses of LTPspecies. One may
|
||||
* need to be careful about deleting pointers to LTPspecies objects created in
|
||||
* the TransportFactory.
|
||||
*
|
||||
* All of the pointers in this class are shallow pointers. Therefore, this
|
||||
* is a passthrough class, which keeps track of pointer ownership by zeroing
|
||||
|
|
@ -30,19 +29,10 @@ namespace Cantera
|
|||
*/
|
||||
class LiquidTransportData
|
||||
{
|
||||
|
||||
public:
|
||||
|
||||
//! Default constructor
|
||||
LiquidTransportData();
|
||||
|
||||
//! Copy constructor
|
||||
LiquidTransportData(const LiquidTransportData& right);
|
||||
|
||||
//! Assignment operator
|
||||
LiquidTransportData& operator=(const LiquidTransportData& right);
|
||||
|
||||
//! Destructor
|
||||
~LiquidTransportData();
|
||||
|
||||
//! A LiquidTransportData object is instantiated for each species.
|
||||
|
|
@ -100,4 +90,3 @@ public:
|
|||
|
||||
}
|
||||
#endif
|
||||
|
||||
|
|
|
|||
|
|
@ -22,8 +22,6 @@ using namespace std;
|
|||
namespace Cantera
|
||||
{
|
||||
|
||||
|
||||
//====================================================================================================================
|
||||
AqueousTransport::AqueousTransport() :
|
||||
m_iStateMF(-1),
|
||||
m_temp(-1.0),
|
||||
|
|
@ -48,14 +46,8 @@ AqueousTransport::AqueousTransport() :
|
|||
{
|
||||
}
|
||||
|
||||
//====================================================================================================================
|
||||
// Initialize the object
|
||||
/*
|
||||
* This is where we dimension everything.
|
||||
*/
|
||||
bool AqueousTransport::initLiquid(LiquidTransportParams& tr)
|
||||
{
|
||||
|
||||
// constant substance attributes
|
||||
m_thermo = tr.thermo;
|
||||
m_nsp = m_thermo->nSpecies();
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ using namespace ctml;
|
|||
|
||||
namespace Cantera
|
||||
{
|
||||
//====================================================================================================================
|
||||
|
||||
//! Exception thrown if an error is encountered while reading the transport database.
|
||||
class LTPError : public CanteraError
|
||||
{
|
||||
|
|
@ -25,8 +25,8 @@ public:
|
|||
CanteraError("LTPspecies", "error parsing transport data: " + msg + "\n") {
|
||||
}
|
||||
};
|
||||
//====================================================================================================================
|
||||
//! getArrhenius() parses the xml element called Arrhenius.
|
||||
|
||||
//! Parses the xml element called Arrhenius.
|
||||
/*!
|
||||
* The Arrhenius expression is
|
||||
* \f[
|
||||
|
|
@ -49,20 +49,7 @@ static void getArrhenius(const XML_Node& node,
|
|||
E /= GasConstant;
|
||||
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Construct an LTPspecies object for a liquid tranport property.
|
||||
/*
|
||||
* The species transport property is constructed from the XML node,
|
||||
* \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node in the species block and specifies a type of transport
|
||||
* property (like viscosity)
|
||||
*
|
||||
* @param propNode Pointer to the XML node that contains the property information
|
||||
* @param name String containing the species name
|
||||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*/
|
||||
|
||||
LTPspecies::LTPspecies(const XML_Node* const propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* thermo) :
|
||||
m_speciesName(name),
|
||||
|
|
@ -77,15 +64,13 @@ LTPspecies::LTPspecies(const XML_Node* const propNode, const std::string name,
|
|||
}
|
||||
}
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
|
||||
LTPspecies::LTPspecies(const LTPspecies& right)
|
||||
{
|
||||
|
||||
*this = right;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
|
||||
LTPspecies& LTPspecies::operator=(const LTPspecies& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
|
|
@ -98,61 +83,36 @@ LTPspecies& LTPspecies::operator=(const LTPspecies& right)
|
|||
}
|
||||
return *this;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Duplication routine
|
||||
/*
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
|
||||
LTPspecies* LTPspecies::duplMyselfAsLTPspecies() const
|
||||
{
|
||||
return new LTPspecies(*this);
|
||||
}
|
||||
//====================================================================================================================
|
||||
|
||||
LTPspecies::~LTPspecies()
|
||||
{
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Returns the vector of 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 by the
|
||||
* subclass object.
|
||||
*/
|
||||
|
||||
doublereal LTPspecies::getSpeciesTransProp()
|
||||
{
|
||||
return 0.0;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Check to see if the property evaluation will be positive
|
||||
|
||||
bool LTPspecies::checkPositive() const
|
||||
{
|
||||
return (m_coeffs[0] > 0);
|
||||
|
||||
}
|
||||
//====================================================================================================================
|
||||
|
||||
doublereal LTPspecies::getMixWeight() const
|
||||
{
|
||||
return m_mixWeight;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Internal model to adjust species-specific properties for composition.
|
||||
/*
|
||||
* Currently just a place holder, but this method could take
|
||||
* the composition from the thermo object and adjust coefficients
|
||||
* accoding to some unspecified model.
|
||||
*/
|
||||
|
||||
void LTPspecies::adjustCoeffsForComposition()
|
||||
{
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Construct an LTPspecies object for a liquid tranport property
|
||||
// expressed as a constant value.
|
||||
/* The transport property is constructed from the XML node,
|
||||
* \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of
|
||||
* transport property (like viscosity)
|
||||
*/
|
||||
|
||||
LTPspecies_Const::LTPspecies_Const(const XML_Node& propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* const thermo) :
|
||||
LTPspecies(&propNode, name, tp_ind, thermo)
|
||||
|
|
@ -165,15 +125,13 @@ LTPspecies_Const::LTPspecies_Const(const XML_Node& propNode, const std::string n
|
|||
throw LTPError("negative or zero " + propNode.name());
|
||||
}
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
|
||||
LTPspecies_Const::LTPspecies_Const(const LTPspecies_Const& right)
|
||||
: LTPspecies()
|
||||
{
|
||||
*this = right; //use assignment operator to do other work
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
|
||||
LTPspecies_Const& LTPspecies_Const::operator=(const LTPspecies_Const& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
|
|
@ -181,39 +139,18 @@ LTPspecies_Const& LTPspecies_Const::operator=(const LTPspecies_Const& right)
|
|||
}
|
||||
return *this;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Duplication routine
|
||||
/*
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
|
||||
LTPspecies* LTPspecies_Const::duplMyselfAsLTPspecies() const
|
||||
{
|
||||
return new LTPspecies_Const(*this);
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Return the (constant) value for this transport property
|
||||
|
||||
doublereal LTPspecies_Const::getSpeciesTransProp()
|
||||
{
|
||||
return m_coeffs[0];
|
||||
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Construct an LTPspecies object for a liquid tranport property
|
||||
// expressed in extended Arrhenius form.
|
||||
/*
|
||||
* The transport property is constructed from the XML node,
|
||||
* \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of transport property (like viscosity)
|
||||
*
|
||||
*
|
||||
* @param propNode Referenc to the XML node that contains the property information.This class
|
||||
* is assumed to be parameterized by reading XML_Node information.
|
||||
* @param name String containing the species name
|
||||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*
|
||||
*/
|
||||
|
||||
LTPspecies_Arrhenius::LTPspecies_Arrhenius(const XML_Node& propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* thermo) :
|
||||
LTPspecies(&propNode, name, tp_ind, thermo)
|
||||
|
|
@ -233,15 +170,13 @@ LTPspecies_Arrhenius::LTPspecies_Arrhenius(const XML_Node& propNode, const std::
|
|||
m_coeffs.push_back(Tact_k);
|
||||
m_coeffs.push_back(log(A_k));
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
|
||||
LTPspecies_Arrhenius::LTPspecies_Arrhenius(const LTPspecies_Arrhenius& right)
|
||||
: LTPspecies()
|
||||
{
|
||||
*this = right;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
|
||||
LTPspecies_Arrhenius& LTPspecies_Arrhenius::operator=(const LTPspecies_Arrhenius& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
|
|
@ -253,40 +188,14 @@ LTPspecies_Arrhenius& LTPspecies_Arrhenius::operator=(const LTPspecies_Arrhenius
|
|||
}
|
||||
return *this;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Duplication routine
|
||||
/*
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
|
||||
LTPspecies* LTPspecies_Arrhenius::duplMyselfAsLTPspecies() const
|
||||
{
|
||||
return new LTPspecies_Arrhenius(*this);
|
||||
}
|
||||
//===================================================================================================================
|
||||
// Return the pure species value for this transport property evaluated
|
||||
// from the Arrhenius expression
|
||||
/*
|
||||
* In general the Arrhenius expression is
|
||||
*
|
||||
* \f[
|
||||
* \mu = A T^n \exp(- E / R T).
|
||||
* \f]
|
||||
*
|
||||
* Note that for viscosity, the convention is such that
|
||||
* a positive activation energy corresponds to the typical
|
||||
* case of a positive argument to the exponential so that
|
||||
* the Arrhenius expression is
|
||||
*
|
||||
* \f[
|
||||
* \mu = A T^n \exp(+ E / R T).
|
||||
* \f]
|
||||
*
|
||||
* Any temperature and composition dependence will be
|
||||
* adjusted internally according to the information provided.
|
||||
*/
|
||||
|
||||
doublereal LTPspecies_Arrhenius::getSpeciesTransProp()
|
||||
{
|
||||
|
||||
doublereal t = m_thermo->temperature();
|
||||
//m_coeffs[0] holds A
|
||||
//m_coeffs[1] holds n
|
||||
|
|
@ -306,23 +215,8 @@ doublereal LTPspecies_Arrhenius::getSpeciesTransProp()
|
|||
m_prop = exp(m_logProp);
|
||||
}
|
||||
return m_prop;
|
||||
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Construct an LTPspecies object for a liquid tranport property expressed as a polynomial in temperature.
|
||||
/*
|
||||
* The transport property is constructed from the XML node, \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of transport property (like viscosity).
|
||||
*
|
||||
*
|
||||
* @param propNode Referenc to the XML node that contains the property information. This class
|
||||
* must be parameterized by reading XML_Node information.
|
||||
* @param name String containing the species name
|
||||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*
|
||||
*/
|
||||
|
||||
LTPspecies_Poly::LTPspecies_Poly(const XML_Node& propNode, const std::string name,
|
||||
TransportPropertyType tp_ind, const thermo_t* thermo) :
|
||||
LTPspecies(&propNode, name, tp_ind, thermo),
|
||||
|
|
@ -332,15 +226,13 @@ LTPspecies_Poly::LTPspecies_Poly(const XML_Node& propNode, const std::string nam
|
|||
m_model = LTP_TD_POLY;
|
||||
getFloatArray(propNode, m_coeffs, "true", "toSI");
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
|
||||
LTPspecies_Poly::LTPspecies_Poly(const LTPspecies_Poly& right)
|
||||
: LTPspecies()
|
||||
{
|
||||
*this = right;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
|
||||
LTPspecies_Poly& LTPspecies_Poly::operator=(const LTPspecies_Poly& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
|
|
@ -350,17 +242,12 @@ LTPspecies_Poly& LTPspecies_Poly::operator=(const LTPspecies_Poly& right)
|
|||
}
|
||||
return *this;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Duplication routine
|
||||
/*
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
|
||||
LTPspecies* LTPspecies_Poly::duplMyselfAsLTPspecies() const
|
||||
{
|
||||
return new LTPspecies_Poly(*this);
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Return the value for this transport property evaluated from the polynomial expression
|
||||
|
||||
doublereal LTPspecies_Poly::getSpeciesTransProp()
|
||||
{
|
||||
doublereal t = m_thermo->temperature();
|
||||
|
|
@ -374,24 +261,8 @@ doublereal LTPspecies_Poly::getSpeciesTransProp()
|
|||
}
|
||||
}
|
||||
return m_prop;
|
||||
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Construct an LTPspecies object for a liquid tranport property
|
||||
// expressed as an exponential in temperature.
|
||||
/*
|
||||
* The transport property is constructed from the XML node, \verbatim <propNode>, \endverbatim that is a child of the
|
||||
* \verbatim <transport> \endverbatim node and specifies a type of transport property (like viscosity).
|
||||
*
|
||||
*
|
||||
* @param propNode Referenc to the XML node that contains the property information. This class
|
||||
* must be parameterized by reading XML_Node information.
|
||||
* @param name String containing the species name
|
||||
* @param tp_ind enum TransportPropertyType containing the property id that this object
|
||||
* is creating a parameterization for (e.g., viscosity)
|
||||
* @param thermo const pointer to the ThermoPhase object, which is used to find the temperature.
|
||||
*
|
||||
*/
|
||||
|
||||
LTPspecies_ExpT::LTPspecies_ExpT(const XML_Node& propNode, const std::string name, TransportPropertyType tp_ind,
|
||||
const thermo_t* thermo) :
|
||||
|
||||
|
|
@ -402,15 +273,13 @@ LTPspecies_ExpT::LTPspecies_ExpT(const XML_Node& propNode, const std::string nam
|
|||
m_model = LTP_TD_EXPT;
|
||||
getFloatArray(propNode, m_coeffs, "true", "toSI");
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
|
||||
LTPspecies_ExpT::LTPspecies_ExpT(const LTPspecies_ExpT& right)
|
||||
: LTPspecies()
|
||||
{
|
||||
*this = right; //use assignment operator to do other work
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
|
||||
LTPspecies_ExpT& LTPspecies_ExpT::operator=(const LTPspecies_ExpT& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
|
|
@ -420,18 +289,12 @@ LTPspecies_ExpT& LTPspecies_ExpT::operator=(const LTPspecies_ExpT& right)
|
|||
}
|
||||
return *this;
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Duplication routine
|
||||
/*
|
||||
* @return Returns a copy of this routine as a pointer to LTPspecies
|
||||
*/
|
||||
|
||||
LTPspecies* LTPspecies_ExpT::duplMyselfAsLTPspecies() const
|
||||
{
|
||||
return new LTPspecies_ExpT(*this);
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Return the value for this transport property evaluated
|
||||
// from the exponential in temperature expression
|
||||
|
||||
doublereal LTPspecies_ExpT::getSpeciesTransProp()
|
||||
{
|
||||
doublereal t = m_thermo->temperature();
|
||||
|
|
@ -448,5 +311,5 @@ doublereal LTPspecies_ExpT::getSpeciesTransProp()
|
|||
}
|
||||
return m_prop;
|
||||
}
|
||||
//====================================================================================================================
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -8,8 +8,6 @@ using namespace std;
|
|||
|
||||
namespace Cantera
|
||||
{
|
||||
|
||||
//====================================================================================================================
|
||||
LiquidTransportData::LiquidTransportData() :
|
||||
speciesName("-"),
|
||||
hydroRadius(0),
|
||||
|
|
@ -23,8 +21,7 @@ LiquidTransportData::LiquidTransportData() :
|
|||
{
|
||||
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Copy constructor
|
||||
|
||||
LiquidTransportData::LiquidTransportData(const LiquidTransportData& right) :
|
||||
speciesName("-"),
|
||||
hydroRadius(0),
|
||||
|
|
@ -38,8 +35,7 @@ LiquidTransportData::LiquidTransportData(const LiquidTransportData& right) :
|
|||
{
|
||||
*this = right; //use assignment operator to do other work
|
||||
}
|
||||
//====================================================================================================================
|
||||
// Assignment operator
|
||||
|
||||
LiquidTransportData& LiquidTransportData::operator=(const LiquidTransportData& right)
|
||||
{
|
||||
if (&right != this) {
|
||||
|
|
@ -81,7 +77,7 @@ LiquidTransportData& LiquidTransportData::operator=(const LiquidTransportData& r
|
|||
}
|
||||
return *this;
|
||||
}
|
||||
//====================================================================================================================
|
||||
|
||||
LiquidTransportData::~LiquidTransportData()
|
||||
{
|
||||
delete hydroRadius;
|
||||
|
|
@ -103,5 +99,5 @@ LiquidTransportData::~LiquidTransportData()
|
|||
delete electCond;
|
||||
delete speciesDiffusivity;
|
||||
}
|
||||
//====================================================================================================================
|
||||
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue