Factory class for creating new instances of classes derived from Transport. More...

#include <TransportFactory.h>

Inheritance diagram for TransportFactory:

Collaboration diagram for TransportFactory:

Public Member Functions
virtual void	deleteFactory ()
	Deletes the statically allocated factory instance. More...

virtual Transport *	newTransport (const std::string &model, ThermoPhase *thermo, int log_level=0)
	Build a new transport manager using a transport manager that may not be the same as in the phase description and return a base class pointer to it. More...

virtual Transport *	newTransport (ThermoPhase *thermo, int log_level=0)
	Build a new transport manager using the default transport manager in the phase description and return a base class pointer to it. More...

Public Member Functions inherited from Factory< Transport >
Transport *	create (const std::string &name, Args... args)
	Create an object using the object construction function corresponding to "name" and the provided constructor arguments. More...

void	reg (const std::string &name, std::function< Transport *(Args...)> f)
	Register a new object construction function. More...

void	addAlias (const std::string &original, const std::string &alias)
	Add an alias for an existing registered type. More...

std::string	canonicalize (const std::string &name)
	Get the canonical name registered for a type. More...

bool	exists (const std::string &name) const
	Returns true if `name` is registered with this factory. More...

Public Member Functions inherited from FactoryBase
virtual	~FactoryBase ()
	destructor More...

Static Public Member Functions
static TransportFactory *	factory ()
	Return a pointer to a TransportFactory instance. More...

Static Public Member Functions inherited from FactoryBase
static void	deleteFactories ()
	static function that deletes all factories in the internal registry maintained in a static variable More...

Private Member Functions
	TransportFactory ()
	The constructor is private; use static method factory() to get a pointer to a factory instance. More...

Private Attributes
std::map< std::string, bool >	m_CK_mode
	Models included in this map are initialized in CK compatibility mode. More...

Static Private Attributes
static TransportFactory *	s_factory = 0
	Static instance of the factor -> This is the only instance of this object allowed. More...

static std::mutex	transport_mutex
	Static instance of the mutex used to ensure the proper reading of the transport database. More...

Additional Inherited Members
Protected Member Functions inherited from Factory< Transport >
void	addDeprecatedAlias (const std::string &original, const std::string &alias)
	Add a deprecated alias for an existing registered type. More...

Protected Member Functions inherited from FactoryBase
	FactoryBase ()
	Constructor. More...

Detailed Description

Factory class for creating new instances of classes derived from Transport.

Creates 'transport managers', which are classes derived from class Transport that provide transport properties. TransportFactory handles all initialization required, including evaluation of collision integrals and generating polynomial fits. Transport managers can also be created in other ways.

Definition at line 30 of file TransportFactory.h.

Constructor & Destructor Documentation

◆ TransportFactory()

TransportFactory ( )

private

The constructor is private; use static method factory() to get a pointer to a factory instance.

The default constructor for this class sets up m_models[], a mapping between the string name for a transport model and the integer name.

Definition at line 30 of file TransportFactory.cpp.

References Factory< Transport >::addAlias(), TransportFactory::m_CK_mode, and Factory< Transport >::reg().

Referenced by TransportFactory::factory().

Member Function Documentation

◆ factory()

static TransportFactory * factory ( )

inlinestatic

Return a pointer to a TransportFactory instance.

TransportFactory is implemented as a 'singleton', which means that at most one instance may be created. The constructor is private. When a TransportFactory instance is required, call static method factory() to return a pointer to the TransportFactory instance.

TransportFactory* f;

f = TransportFactory::factory();

Cantera::TransportFactory::factory

static TransportFactory * factory()

Return a pointer to a TransportFactory instance.

Definition: TransportFactory.h:45

Cantera::TransportFactory::TransportFactory

TransportFactory()

The constructor is private; use static method factory() to get a pointer to a factory instance.

Definition: TransportFactory.cpp:30

Definition at line 45 of file TransportFactory.h.

References TransportFactory::s_factory, TransportFactory::transport_mutex, and TransportFactory::TransportFactory().