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

Doxygen updates

Browse source
This commit is contained in:
Harry Moffat 2008-12-29 18:40:21 +00:00
parent 68f1af4b20
commit 1e238f7c4d
2 changed files with 134 additions and 94 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

117
Cantera/src/thermo/SpeciesThermoFactory.cpp
View file

@ -112,12 +112,54 @@ namespace Cantera {
} }
} }
//! Static method to return an instance of this class
/*!
* This class is implemented as a singleton -- one in which
* only one instance is needed. The recommended way to access
* the factory is to call this static method, which
* instantiates the class if it is the first call, but
* otherwise simply returns the pointer to the existing
* instance.
*/
SpeciesThermoFactory* SpeciesThermoFactory::factory() {
#if defined(THREAD_SAFE_CANTERA)
boost::mutex::scoped_lock lock(species_thermo_mutex);
#endif
if (!s_factory) s_factory = new SpeciesThermoFactory;
return s_factory;
}
/** // 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 SpeciesThermoFactory::deleteFactory() {
#if defined(THREAD_SAFE_CANTERA)
boost::mutex::scoped_lock lock(species_thermo_mutex);
#endif
if (s_factory) {
delete s_factory;
s_factory = 0;
}
}
// 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.
*/
SpeciesThermoFactory::~SpeciesThermoFactory() {
}
/*
* Return a species thermo manager to handle the parameterizations * Return a species thermo manager to handle the parameterizations
* specified in a CTML phase specification. * specified in a CTML phase specification.
*/ */
SpeciesThermo* SpeciesThermoFactory::newSpeciesThermo(std::vector<XML_Node*> & spDataNodeList) { SpeciesThermo* SpeciesThermoFactory::newSpeciesThermo(std::vector<XML_Node*> & spDataNodeList) const {
int inasa = 0, ishomate = 0, isimple = 0, iother = 0; int inasa = 0, ishomate = 0, isimple = 0, iother = 0;
try { try {
getSpeciesThermoTypes(spDataNodeList, inasa, ishomate, isimple, iother); getSpeciesThermoTypes(spDataNodeList, inasa, ishomate, isimple, iother);
@ -138,7 +180,7 @@ namespace Cantera {
* @todo is this used? * @todo is this used?
*/ */
SpeciesThermo* SpeciesThermoFactory:: SpeciesThermo* SpeciesThermoFactory::
newSpeciesThermoOpt(std::vector<XML_Node*> & spDataNodeList) { newSpeciesThermoOpt(std::vector<XML_Node*> & spDataNodeList) const {
int inasa = 0, ishomate = 0, isimple = 0, iother = 0; int inasa = 0, ishomate = 0, isimple = 0, iother = 0;
try { try {
getSpeciesThermoTypes(spDataNodeList, inasa, ishomate, isimple, iother); getSpeciesThermoTypes(spDataNodeList, inasa, ishomate, isimple, iother);
@ -154,7 +196,7 @@ namespace Cantera {
+ SHOMATE*ishomate + SIMPLE*isimple); + SHOMATE*ishomate + SIMPLE*isimple);
} }
SpeciesThermo* SpeciesThermoFactory::newSpeciesThermo(int type) { SpeciesThermo* SpeciesThermoFactory::newSpeciesThermo(int type) const {
switch (type) { switch (type) {
case NASA: case NASA:
return new NasaThermo; return new NasaThermo;
@ -175,7 +217,7 @@ namespace Cantera {
} }
} }
SpeciesThermo* SpeciesThermoFactory::newSpeciesThermoManager(std::string &stype) { SpeciesThermo* SpeciesThermoFactory::newSpeciesThermoManager(std::string &stype) const {
std::string ltype = lowercase(stype); std::string ltype = lowercase(stype);
if (ltype == "nasa") { if (ltype == "nasa") {
return new NasaThermo; return new NasaThermo;
@ -724,7 +766,7 @@ namespace Cantera {
void SpeciesThermoFactory:: void SpeciesThermoFactory::
installThermoForSpecies(int k, const XML_Node& s, ThermoPhase *th_ptr, installThermoForSpecies(int k, const XML_Node& s, ThermoPhase *th_ptr,
SpeciesThermo& spthermo, SpeciesThermo& spthermo,
const XML_Node *phaseNode_ptr) { const XML_Node *phaseNode_ptr) const {
/* /*
* Check to see that the species block has a thermo block * Check to see that the species block has a thermo block
* before processing. Throw an error if not there. * before processing. Throw an error if not there.
@ -809,12 +851,32 @@ namespace Cantera {
} }
// Install a species thermodynamic property parameterization
// for the standard state for one species into a species thermo manager, VPSSMgr
/*
* This is a wrapper around the createInstallVPSS() function in the
* VPStandardStateTP object.
*
* This serves to install the species into vpss_ptr, create a PDSS file. We also
* read the xml database to extract the constants for these steps.
*
* @param k species number
* @param speciesNode Reference to the XML node specifying the species standard
* state information
* @param vp_ptr variable pressure ThermoPhase object
* @param vpss_ptr Pointer to the Manager for calculating variable pressure
* substances.
* @param spthermo_ptr Species reference state thermo manager
* @param phaseNode_ptr Optional Pointer to the XML phase
* information for the phase in which the species
* resides
*/
void SpeciesThermoFactory:: void SpeciesThermoFactory::
installVPThermoForSpecies(int k, const XML_Node& speciesNode, installVPThermoForSpecies(int k, const XML_Node& speciesNode,
VPStandardStateTP *vp_ptr, VPStandardStateTP *vp_ptr,
VPSSMgr *vpssmgr_ptr, VPSSMgr *vpssmgr_ptr,
SpeciesThermo *spthermo_ptr, SpeciesThermo *spthermo_ptr,
const XML_Node *phaseNode_ptr) { const XML_Node *phaseNode_ptr) const {
// Call the VPStandardStateTP object to install the pressure dependent species // Call the VPStandardStateTP object to install the pressure dependent species
// standard state into the object. // standard state into the object.
@ -849,32 +911,31 @@ namespace Cantera {
return sptherm; return sptherm;
} }
// Function to return SpeciesThermo manager // Create a new species thermo manager instance, by specifying
//the type and (optionally) a pointer to the factory to use to create it.
/* /*
* This utility program will look through species nodes. It will discover what * This utility program is a basic factory operation for spawning a
* each species needs for its species property managers. Then, * new species reference-state thermo mananger
* it will malloc and return the proper species property manager to use.
* *
* These functions allow using a different factory class that * These functions allows for using a different factory class that
* derives from SpeciesThermoFactory. * derives from SpeciesThermoFactory. However, no applications of this
* have been done yet.
* *
* @param spData_node Vector of XML_Nodes, each of which is a speciesData XML Node. * @param stype String specifying the species thermo type
* Each %speciesData node contains a list of XML species elements * @param f Pointer to a SpeciesThermoFactory. optional parameter.
* e.g., \<speciesData id="Species_Data"\> * Defaults to NULL.
* @param f Pointer to a SpeciesThermoFactory. optional parameter.
* Defautls to NULL.
*/ */
// SpeciesThermo* newSpeciesThermoMgr(XML_Node* spData_node, SpeciesThermo* newSpeciesThermoMgr(std::string &stype,
// SpeciesThermoFactory* f) { SpeciesThermoFactory* f) {
//if (f == 0) { if (f == 0) {
// f = SpeciesThermoFactory::factory(); f = SpeciesThermoFactory::factory();
//} }
//SpeciesThermo* sptherm = f->newSpeciesThermo(spData_node); SpeciesThermo* sptherm = f->newSpeciesThermoManager(stype);
//return sptherm; return sptherm;
//} }
//! Function to return SpeciesThermo manager // Function to return SpeciesThermo manager
/*! /*
* This utility program will look through species nodes. It will discover what * This utility program will look through species nodes. It will discover what
* each species needs for its species property managers. Then, * each species needs for its species property managers. Then,
* it will malloc and return the proper species property manager to use. * it will malloc and return the proper species property manager to use.

111
Cantera/src/thermo/SpeciesThermoFactory.h
View file

@ -2,18 +2,17 @@
* @file SpeciesThermoFactory.h * @file SpeciesThermoFactory.h
* Header for factory to build instances of classes that manage the * Header for factory to build instances of classes that manage the
* standard-state thermodynamic properties of a set of species * standard-state thermodynamic properties of a set of species
* (see \ref spthermo and class \link Cantera::SpeciesThermoFactory SpeciesThermoFactory\endlink); * (see \ref spthermo and class
* \link Cantera::SpeciesThermoFactory SpeciesThermoFactory\endlink);
*/ */
/* /*
* $Author$
* $Revision$ * $Revision$
* $Date$ * $Date$
*/ */
// Copyright 2001 California Institute of Technology // Copyright 2001 California Institute of Technology
#ifndef SPECIESTHERMO_FACTORY_H #ifndef SPECIESTHERMO_FACTORY_H
#define SPECIESTHERMO_FACTORY_H #define SPECIESTHERMO_FACTORY_H
@ -91,13 +90,7 @@ namespace Cantera {
* otherwise simply returns the pointer to the existing * otherwise simply returns the pointer to the existing
* instance. * instance.
*/ */
static SpeciesThermoFactory* factory() { static SpeciesThermoFactory* factory();
#if defined(THREAD_SAFE_CANTERA)
boost::mutex::scoped_lock lock(species_thermo_mutex);
#endif
if (!s_factory) s_factory = new SpeciesThermoFactory;
return s_factory;
}
//! Delete static instance of this class //! Delete static instance of this class
/** /**
@ -105,15 +98,7 @@ namespace Cantera {
* the process terminates (for example, when checking for * the process terminates (for example, when checking for
* memory leaks) then this method can be called to delete it. * memory leaks) then this method can be called to delete it.
*/ */
void deleteFactory() { 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;
}
}
//! Destructor //! Destructor
/** /**
@ -122,36 +107,50 @@ namespace Cantera {
* create an infinite loop if destructor is called for that * create an infinite loop if destructor is called for that
* single instance. * single instance.
*/ */
virtual ~SpeciesThermoFactory() { virtual ~SpeciesThermoFactory();
}
//! Create a new species property manager. //! Create a new species property manage for the reference state.
/*! /*!
* @param type the integer type to be created. * @param type the integer type to be created.
*
*
* @return Returns the pointer to the newly malloced
* species property manager for the reference
* state
*/ */
SpeciesThermo* newSpeciesThermo(int type); SpeciesThermo* newSpeciesThermo(int type) const;
//! Create a new species thermo property manager given a string //! Create a new species thermo property manager given a string
/*! /*!
* Create a new species thermo property manager, given a * Create a new species thermo property manager, given a
* string. * string.
* *
* @param stype String name for the species thermo type * @param stype String name for the species thermo type
*
*
* @return Returns the pointer to the newly malloced
* species property manager for the reference
* state
*/ */
SpeciesThermo* newSpeciesThermoManager(std::string &stype); SpeciesThermo* newSpeciesThermoManager(std::string &stype) const;
//! Create a new species property manager for a group of species //! Create a new species property manager for the reference
//! state for a group of species
/*! /*!
* This routine will look through species nodes. It will discover what * This routine will look through species nodes. It will discover what
* each species needs for its species property managers. Then, * each species needs for its species property managers. Then,
* it will malloc and return the proper species property manager to use. * it will malloc and return the proper species property manager to use.
* *
* @param spDataNodeList, This vector contains a list * @param spDataNodeList This vector contains a list
* of species XML nodes that will be in the phase * of species XML nodes that will be in the phase
*
* @return Returns the pointer to the newly malloced
* species property manager for the reference
* state
*/ */
SpeciesThermo* newSpeciesThermo(std::vector<XML_Node*> & spDataNodeList); SpeciesThermo* newSpeciesThermo(std::vector<XML_Node*> & spDataNodeList) const;
//! Create a new species property manager. //! Create a new species property manager for the reference state
/*! /*!
* This routine will look through species nodes. It will discover what * This routine will look through species nodes. It will discover what
* each species needs for its species property managers. Then, * each species needs for its species property managers. Then,
@ -160,24 +159,28 @@ namespace Cantera {
* *
* @param spDataNodeList This vector contains a list * @param spDataNodeList This vector contains a list
* of species XML nodes that will be in the phase * of species XML nodes that will be in the phase
*
* @return Returns the pointer to the newly malloced
* species property manager for the reference state
* @todo is this used? * @todo is this used?
*/ */
SpeciesThermo* newSpeciesThermoOpt(std::vector<XML_Node*> & spDataNodeList); SpeciesThermo* newSpeciesThermoOpt(std::vector<XML_Node*> & spDataNodeList) const;
//! Install a species thermodynamic property parameterization //! Install a species thermodynamic property parameterization
//! for the reference state for one species into a species thermo manager. //! for the reference state for one species into a species thermo manager.
/*! /*!
* @param k species number * @param k Species number
* @param speciesNode Reference to the XML node specifying the species standard * @param speciesNode Reference to the XML node specifying the species standard
* state information * state information
* @param spthermo Species reference state thermo manager * @param th_ptr Pointer to the %ThermoPhase object for the species
* @param phaseNode_ptr Optional Pointer to the XML phase * @param spthermo Species reference state thermo manager
* @param phaseNode_ptr Optional pointer to the XML phase
* information for the phase in which the species * information for the phase in which the species
* resides * resides
*/ */
void installThermoForSpecies(int k, const XML_Node& speciesNode, void installThermoForSpecies(int k, const XML_Node& speciesNode,
ThermoPhase *th_ptr, SpeciesThermo& spthermo, ThermoPhase *th_ptr, SpeciesThermo& spthermo,
const XML_Node *phaseNode_ptr = 0); const XML_Node *phaseNode_ptr = 0) const;
//! Install a species thermodynamic property parameterization //! Install a species thermodynamic property parameterization
//! for the standard state for one species into a species thermo manager, VPSSMgr //! for the standard state for one species into a species thermo manager, VPSSMgr
@ -203,11 +206,11 @@ namespace Cantera {
VPStandardStateTP *vp_ptr, VPStandardStateTP *vp_ptr,
VPSSMgr *vpss_ptr, VPSSMgr *vpss_ptr,
SpeciesThermo *spthermo_ptr, SpeciesThermo *spthermo_ptr,
const XML_Node *phaseNode_ptr); const XML_Node *phaseNode_ptr) const;
private: private:
//! pointer to the sole instance of this class //! Pointer to the sole instance of this class, which is static
static SpeciesThermoFactory* s_factory; static SpeciesThermoFactory* s_factory;
#if defined(THREAD_SAFE_CANTERA) #if defined(THREAD_SAFE_CANTERA)
@ -259,32 +262,8 @@ namespace Cantera {
* @param f Pointer to a SpeciesThermoFactory. optional parameter. * @param f Pointer to a SpeciesThermoFactory. optional parameter.
* Defautls to NULL. * Defautls to NULL.
*/ */
inline SpeciesThermo* newSpeciesThermoMgr(std::string &stype, SpeciesThermo* newSpeciesThermoMgr(std::string &stype,
SpeciesThermoFactory* f=0) { SpeciesThermoFactory* f=0);
if (f == 0) {
f = SpeciesThermoFactory::factory();
}
SpeciesThermo* sptherm = f->newSpeciesThermoManager(stype);
return sptherm;
}
//! Function to return SpeciesThermo manager
/*!
* This utility program 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.
*
* These functions allow using a different factory class that
* derives from SpeciesThermoFactory.
*
* @param spData_node 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 f Pointer to a SpeciesThermoFactory. optional parameter.
* Defautls to NULL.
*/
// SpeciesThermo* newSpeciesThermoMgr(XML_Node* spData_node,
// SpeciesThermoFactory* f=0);
//! Function to return SpeciesThermo manager //! Function to return SpeciesThermo manager
/*! /*!