Detailed Description

Factory class to create Jacobian objects for use by linear solvers.

Definition at line 18 of file SystemJacobianFactory.h.

Public Member Functions
void	deleteFactory () override
	Virtual abstract function that deletes the factory.

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

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

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

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

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

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

Static Public Member Functions
static SystemJacobianFactory *	factory ()

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

Static Private Attributes
static SystemJacobianFactory *	s_factory = 0

static std::mutex	jac_mutex

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

Protected Member Functions inherited from FactoryBase
	FactoryBase ()
	Constructor.

virtual void	deleteFactory ()=0
	Virtual abstract function that deletes the factory.

Constructor & Destructor Documentation

SystemJacobianFactory ( )

private

Definition at line 31 of file SystemJacobianFactory.cpp.

SystemJacobianFactory * factory ( )

static

Definition at line 14 of file SystemJacobianFactory.cpp.

void deleteFactory ( )

overridevirtual

Virtual abstract function that deletes the factory.

This must be properly defined in child objects.

Implements FactoryBase.

Definition at line 22 of file SystemJacobianFactory.cpp.

staticprivate

Definition at line 25 of file SystemJacobianFactory.h.

std::mutex jac_mutex

staticprivate

Definition at line 26 of file SystemJacobianFactory.h.

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