research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added some doxygen commentary.

Browse source 
Changed a param to a const param
This commit is contained in:
Harry Moffat 2009-05-28 23:08:06 +00:00
parent 5e2904146d
commit e44b49ecae
12 changed files with 78 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Cantera/src/thermo/VPSSMgr.cpp
View file

@ -388,7 +388,6 @@ namespace Cantera {
}
}
for (int k = 0; k < m_kk; k++) {
const PDSS *kPDSS = m_vptp_ptr->providePDSS(k);
m_p0_k = kPDSS->refPressure();
@ -402,8 +401,6 @@ namespace Cantera {
}
}
#endif
}
void VPSSMgr::installSTSpecies(int k, const XML_Node& s,

8
Cantera/src/thermo/VPSSMgr.h
View file

@ -734,7 +734,10 @@ namespace Cantera {
* called for each species in the phase, and after initThermo()
* has been called.
* It's called via an inner-to-outer onion shell like manner.
*
*
* In this routine, we currently calculate the reference pressure,
* the minimum and maximum temperature for the applicability
* of the thermo formulation.
*
* @param phaseNode Reference to the phaseNode XML node.
* @param id ID of the phase.
@ -766,9 +769,8 @@ namespace Cantera {
* to the phase which owns the species
*/
virtual PDSS * createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr);
const XML_Node * const phaseNode_ptr);
//! Initialize the internal pointers in this object
/*!

2
Cantera/src/thermo/VPSSMgr_ConstVol.cpp
View file

@ -127,7 +127,7 @@ namespace Cantera {
PDSS *
VPSSMgr_ConstVol::createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr) {
const XML_Node * const phaseNode_ptr) {
//VPSSMgr::installSpecies(k, speciesNode, phaseNode_ptr);
const XML_Node *ss = speciesNode.findByName("standardState");
if (!ss) {

2
Cantera/src/thermo/VPSSMgr_ConstVol.h
View file

@ -183,7 +183,7 @@ namespace Cantera {
* containing the parameterization
*/
virtual PDSS* createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr);
const XML_Node * const phaseNode_ptr);
//@}
//! This utility function reports the type of parameterization

7
Cantera/src/thermo/VPSSMgr_General.cpp
View file

@ -135,16 +135,14 @@ namespace Cantera {
}
}
void
VPSSMgr_General::initThermoXML(XML_Node& phaseNode, std::string id) {
VPSSMgr::initThermoXML(phaseNode, id);
}
PDSS*
VPSSMgr_General::returnPDSS_ptr(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr, bool &doST) {
const XML_Node * const phaseNode_ptr, bool &doST) {
PDSS *kPDSS = 0;
doST = true;
GeneralSpeciesThermo *genSpthermo = dynamic_cast<GeneralSpeciesThermo *>(m_spthermo);
@ -186,7 +184,7 @@ namespace Cantera {
PDSS *
VPSSMgr_General::createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr) {
const XML_Node * const phaseNode_ptr) {
bool doST;
PDSS *kPDSS = returnPDSS_ptr(k, speciesNode, phaseNode_ptr, doST);
// VPSSMgr::installSTSpecies(k, speciesNode, phaseNode_ptr);
@ -212,7 +210,6 @@ namespace Cantera {
if (k == 0) {
m_p0 = p0;
}
return kPDSS;
}

70
Cantera/src/thermo/VPSSMgr_General.h
View file

@ -7,7 +7,6 @@
* class \link Cantera::VPSSMgr_General VPSSMgr_General\endlink).
*/
/*
* $Author$
* $Revision$
* $Date$
*/
@ -33,9 +32,9 @@ namespace Cantera {
//! Class that handles the calculation of standard state thermo properties for
//! a set of species belonging to a single phase in a completely general
//! but slow way
//! but slow way.
/*!
* This class manages the calculation standard state thermo properties for
* This class manages the calculation of standard state thermo properties for
* a set of species belonging to a single phase in a completely general
* but slow way.
* The way this does this is to call the underlying PDSS routines one at a
@ -186,13 +185,70 @@ namespace Cantera {
*/
virtual void initThermo();
//! Finalize the thermo objects after all species have been entered
/*!
* This function is the LAST initialization routine to be
* called. It's called after createInstallPDSS() has been
* called for each species in the phase, and after initThermo()
* has been called.
* It's called via an inner-to-outer onion-shell like manner.
*
* Currently, this routine passed control to the parent class
* without doing anything.
*
* @param phaseNode Reference to the phaseNode XML node.
* @param id ID of the phase.
*/
virtual void initThermoXML(XML_Node& phaseNode, std::string id);
PDSS* returnPDSS_ptr(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr, bool &doST);
private:
//! Local factory routine for the creation of PDSS objects
/*!
* This routine is specific to the VPSSMgr_General object.
* It will create a PDSS object for species k, by searching
* and querying for the "standardState" XML node in the standard
* state description of the species. If this XML node doesn't
* exist, it will assume that the standard state is an ideal
* gas.
* It decides on the attribute, "model", what PDSS object
* to create.
*
* @param k Species number
* @param speciesNode XML node for the standard state of the species
* @param phaseNode_ptr pointer to the phase XML node
* @param doST output variable indicating whether the
* instantiation has resulted in a SpeciesThermo object
* being created and registered with the SpeciesThermo
* manager class.
*
* @return Returns the pointer to a malloced PDSS object
*/
PDSS * returnPDSS_ptr(int k, const XML_Node& speciesNode,
const XML_Node * const phaseNode_ptr, bool &doST);
virtual PDSS *createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr);
public:
//! Factory routine for the creation of PDSS objects that are
//! then internally registered with this VPSSMgr object
/*!
* This function sets up the internal data within this object for
* handling the calculation of the standard state for the species.
*
* This routine
* will create a PDSS object for species k, by searching
* and querying for the "standardState" XML node in the standard
* state description of the species.
* It will then store the object's pointer in a vector of pointers,
* and it will own the object.
*
* @param k Species number
* @param speciesNode XML node for the standard state of the species
* @param phaseNode_ptr pointer to the phase XML node
*
* @return Returns the pointer to the malloced PDSS object
*/
virtual PDSS* createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node * const phaseNode_ptr);
//! This utility function reports the type of parameterization
//! used for the species with index number index.

2
Cantera/src/thermo/VPSSMgr_IdealGas.cpp
View file

@ -102,7 +102,7 @@ namespace Cantera {
PDSS *
VPSSMgr_IdealGas::createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr) {
const XML_Node * const phaseNode_ptr) {
//VPSSMgr::installSpecies(k, speciesNode, phaseNode_ptr);
const XML_Node *ss = speciesNode.findByName("standardState");
if (ss) {

2
Cantera/src/thermo/VPSSMgr_IdealGas.h
View file

@ -204,7 +204,7 @@ namespace Cantera {
* containing the parameterization
*/
virtual PDSS* createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr);
const XML_Node * const phaseNode_ptr);
//! This utility function reports the type of parameterization

2
Cantera/src/thermo/VPSSMgr_Water_ConstVol.cpp
View file

@ -255,7 +255,7 @@ namespace Cantera {
PDSS*
VPSSMgr_Water_ConstVol::createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr) {
const XML_Node * const phaseNode_ptr) {
PDSS *kPDSS = 0;
// Will have to do something for water

2
Cantera/src/thermo/VPSSMgr_Water_ConstVol.h
View file

@ -281,7 +281,7 @@ namespace Cantera {
* to the phase which owns the species
*/
virtual PDSS *createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr);
const XML_Node * const phaseNode_ptr);
//! This utility function reports the type of parameterization
//! used for the species with index number index.

2
Cantera/src/thermo/VPSSMgr_Water_HKFT.cpp
View file

@ -241,7 +241,7 @@ namespace Cantera {
PDSS *
VPSSMgr_Water_HKFT::createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr) {
const XML_Node * const phaseNode_ptr) {
PDSS *kPDSS = 0;
const XML_Node *ss = speciesNode.findByName("standardState");

2
Cantera/src/thermo/VPSSMgr_Water_HKFT.h
View file

@ -365,7 +365,7 @@ namespace Cantera {
* to the phase which owns the species
*/
virtual PDSS *createInstallPDSS(int k, const XML_Node& speciesNode,
const XML_Node *phaseNode_ptr);
const XML_Node * const phaseNode_ptr);
//@}