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

Doxygen update

Browse source
This commit is contained in:
Harry Moffat 2008-12-29 18:09:49 +00:00
parent 1d46653f2a
commit 68f1af4b20
2 changed files with 31 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
Cantera/src/thermo/VPSSMgrFactory.cpp
View file

@ -145,6 +145,26 @@ namespace Cantera {
}
}
// Delete static instance of this class
/*
* If it is necessary to explicitly delete the factory before
* the process terminates (for example, when checking for
* memory leaks) then this method can be called to delete it.
*/
void VPSSMgrFactory::deleteFactory() {
#if defined(THREAD_SAFE_CANTERA)
boost::mutex::scoped_lock lock(species_thermo_mutex);
#endif
if (s_factory) {
delete s_factory;
s_factory = 0;
}
}
VPSSMgrFactory::~VPSSMgrFactory() {
}
VPSSMgr_enumType
VPSSMgrFactory::VPSSMgr_StringConversion(std::string ssModel) const {
std::string lssModel = lowercase(ssModel);

48
Cantera/src/thermo/VPSSMgrFactory.h
View file

@ -6,7 +6,6 @@
*/
/*
* $Author$
* $Revision$
* $Date$
*/
@ -99,31 +98,21 @@ namespace Cantera {
}
//! Delete static instance of this class
/**
/*!
* If it is necessary to explicitly delete the factory before
* the process terminates (for example, when checking for
* memory leaks) then this method can be called to delete it.
*/
void deleteFactory() {
#if defined(THREAD_SAFE_CANTERA)
boost::mutex::scoped_lock lock(species_thermo_mutex);
#endif
if (s_factory) {
delete s_factory;
s_factory = 0;
}
}
void deleteFactory();
//! Destructor
/**
/*!
* Doesn't do anything. We do not delete statically
* created single instance of this class here, because it would
* create an infinite loop if destructor is called for that
* single instance.
*/
virtual ~VPSSMgrFactory() {
}
virtual ~VPSSMgrFactory();
//! String conversion to an enumType
/*!
@ -144,35 +133,20 @@ namespace Cantera {
*/
virtual VPSSMgr* newVPSSMgr(VPSSMgr_enumType type, VPStandardStateTP *vp_ptr);
//! Create a new species property manager.
/*!
* This routine will look through species nodes. It will discover what
* each species needs for its species property managers. Then,
* it will malloc and return the proper species property manager to use.
*
* @param vp_ptr Variable pressure standard state ThermoPhase object
* that will be the owner.
* @param phaseNode_ptr Pointer to the ThermoPhase phase XML Node
* @param spData_node Pointer to a speciesData XML Node.
* Each speciesData node contains a list of XML species elements
* e.g., \<speciesData id="Species_Data"\>
*/
// virtual VPSSMgr* newVPSSMgr(VPStandardStateTP *vp_ptr,
// XML_Node* phaseNode_ptr,
// XML_Node* spData_node);
//! Create a new species property manager for a group of species
/*!
* This routine will look through species nodes. It will discover what
* each species needs for its species property managers. Then,
* it will malloc and return the proper species property manager to use.
*
* @param vp_ptr Variable pressure standard state ThermoPhase object
* that will be the owner.
* @param vp_ptr Variable pressure standard state ThermoPhase object
* that will be the owner.
* @param phaseNode_ptr Pointer to the ThermoPhase phase XML Node
* @param spData_nodes Vector of XML_Nodes, each of which is a speciesData XML Node.
* Each speciesData node contains a list of XML species elements
* e.g., \<speciesData id="Species_Data"\>
* @param spDataNodeList Vector of XML_Nodes, each of which is a species XML Node.
* There are m_kk of these.
*
* @return Returns a pointer to a newly malloced species property
* manager object.
*/
virtual VPSSMgr* newVPSSMgr(VPStandardStateTP *vp_ptr,
XML_Node* phaseNode_ptr,