VPSSMgrFactory Class Reference
[Managers for Calculating Standard-State Thermodynamics]

Factory to build instances of classes that manage the standard-state thermodynamic properties of a set of species. More...

#include <VPSSMgrFactory.h>

Inheritance diagram for VPSSMgrFactory:

[legend]

Collaboration diagram for VPSSMgrFactory:

[legend]

List of all members.

Public Member Functions
void	deleteFactory ()
	Delete static instance of this class.
virtual	~VPSSMgrFactory ()
	Destructor.
virtual VPSSMgr_enumType	VPSSMgr_StringConversion (std::string ssModel) const
	String conversion to an enumType.
virtual VPSSMgr *	newVPSSMgr (VPSSMgr_enumType type, VPStandardStateTP *vp_ptr)
	Create a new species variable pressure standard state calculator.
virtual VPSSMgr *	newVPSSMgr (VPStandardStateTP vp_ptr, XML_Node phaseNode_ptr, std::vector< XML_Node * > &spDataNodeList)
	Create a new species property manager for a group of species.
Static Public Member Functions
static VPSSMgrFactory *	factory ()
	Static method to return an instance of this class.
static void	deleteFactories ()
	static function that deletes all factories in the internal registry maintained in a static variable
Private Member Functions
	VPSSMgrFactory ()
	Constructor.
Static Private Attributes
static VPSSMgrFactory *	s_factory = 0
	pointer to the sole instance of this class
static boost::mutex	vpss_species_thermo_mutex
	Decl of the static mutex variable that locks the VPSSMgr factory singelton.

Detailed Description

Factory to build instances of classes that manage the standard-state thermodynamic properties of a set of species.

This class is responsible for making the decision concerning which derivative of VPSSMgr object to use. The VPSSMgr object is used to calculate thermodynamic functions for the standard state. It queries the database of species to understand what the requirements are for the submodels for all of the species in the phase. Then, it picks the derived VPSSMgr object to use and passes it back to the calling routine. It doesn't load any data into the derived VPSSMgr object.

Making the choice of VPSSMgr types is the only thing this class does.

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.

Definition at line 79 of file VPSSMgrFactory.h.

Constructor & Destructor Documentation

~VPSSMgrFactory ( ) [virtual]

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.

Definition at line 211 of file VPSSMgrFactory.cpp.

VPSSMgrFactory ( ) [inline, private]

Constructor.

This is made private, so that only the static method factory() can instantiate the class.

Definition at line 168 of file VPSSMgrFactory.h.

Member Function Documentation

static void deleteFactories ( ) [inline, static, inherited]

static function that deletes all factories in the internal registry maintained in a static variable

Definition at line 33 of file FactoryBase.h.

References FactoryBase::s_vFactoryRegistry.

Referenced by Cantera::appdelete().

void deleteFactory ( ) [virtual]

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.

Implements FactoryBase.

Definition at line 200 of file VPSSMgrFactory.cpp.

References VPSSMgrFactory::s_factory.

static VPSSMgrFactory* factory ( ) [inline, static]

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.

Definition at line 92 of file VPSSMgrFactory.h.

References VPSSMgrFactory::s_factory, and VPSSMgrFactory::vpss_species_thermo_mutex.

VPSSMgr * newVPSSMgr	(	VPStandardStateTP *	vp_ptr,
		XML_Node *	phaseNode_ptr,
		std::vector< XML_Node * > &	spDataNodeList
	)			`[virtual]`

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.

Parameters:

	vp_ptr	Variable pressure standard state ThermoPhase object that will be the owner.
	phaseNode_ptr	Pointer to the ThermoPhase phase XML Node
	spDataNodeList	Vector of XML_Nodes, each of which is a species XML Node. There are m_kk of these.

Returns:: Returns a pointer to a newly malloced species property manager object.

Definition at line 239 of file VPSSMgrFactory.cpp.

References XML_Node::child(), VPStandardStateTP::eosType(), XML_Node::hasChild(), Cantera::newSpeciesThermoMgr(), VPSSMgrFactory::newVPSSMgr(), Cantera::popError(), ThermoPhase::setSpeciesThermo(), and VPSSMgrFactory::VPSSMgr_StringConversion().

VPSSMgr * newVPSSMgr	(	VPSSMgr_enumType	type,
		VPStandardStateTP *	vp_ptr
	)			`[virtual]`

Create a new species variable pressure standard state calculator.

Parameters:

	type	The enumerated type of the standard state calculator
	vp_ptr	Variable pressure standard state ThermoPhase object that will be the owner.

Definition at line 349 of file VPSSMgrFactory.cpp.

References Cantera::int2str(), and ThermoPhase::speciesThermo().

Referenced by VPSSMgrFactory::newVPSSMgr().

VPSSMgr_enumType VPSSMgr_StringConversion ( std::string ssModel ) const [virtual]

String conversion to an enumType.

This routine is a string conversion. The string is obtained from the standardState model attribute and converted to a VPSSMgr_enumType type.

Parameters:

ssModel

String representing the VPSSMGr object

Definition at line 215 of file VPSSMgrFactory.cpp.

References Cantera::lowercase().

Referenced by VPSSMgrFactory::newVPSSMgr().

Member Data Documentation

VPSSMgrFactory * s_factory = 0 [static, private]

pointer to the sole instance of this class

Definition at line 158 of file VPSSMgrFactory.h.

Referenced by VPSSMgrFactory::deleteFactory(), and VPSSMgrFactory::factory().

boost::mutex vpss_species_thermo_mutex [static, private]

Decl of the static mutex variable that locks the VPSSMgr factory singelton.

Definition at line 163 of file VPSSMgrFactory.h.

Referenced by VPSSMgrFactory::factory().

The documentation for this class was generated from the following files:

VPSSMgrFactory Class Reference [Managers for Calculating Standard-State Thermodynamics]

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

VPSSMgrFactory Class Reference
[Managers for Calculating Standard-State Thermodynamics]