libMesh::FactoryImp< Derived, Base > Class Template Reference

Factory implementation class. More...

#include <factory.h>

Inheritance diagram for libMesh::FactoryImp< Derived, Base >:

Public Member Functions
	FactoryImp (const std::string &name)
	Constructor. More...
	~FactoryImp ()=default
	Destructor. More...

Static Public Member Functions
static std::unique_ptr< Base >	build (const std::string &name)
	Builds an object of type Base identified by name. More...

Protected Member Functions
template<>
std::map< std::string, Factory< FunctionBase< Number > > *> &	factory_map ()
template<>
std::map< std::string, Factory< FunctionBase< Number > > *> &	factory_map ()
template<>
std::map< std::string, Factory< Partitioner > *> &	factory_map ()

Static Protected Member Functions
static std::map< std::string, Factory< Base > * > &	factory_map ()
	Map from a name to a Factory<Base> * pointer. More...

Private Member Functions
virtual std::unique_ptr< Base >	create () override

Detailed Description

template<class Derived, class Base>
class libMesh::FactoryImp< Derived, Base >

Factory implementation class.

Definition at line 88 of file factory.h.

Constructor & Destructor Documentation

FactoryImp()

template<class Derived, class Base>

libMesh::FactoryImp< Derived, Base >::FactoryImp ( const std::string &  name )

inline

Constructor.

Takes a name as input.

Definition at line 95 of file factory.h.

: Factory<Base>(name) { }

~FactoryImp()

template<class Derived, class Base>

libMesh::FactoryImp< Derived, Base >::~FactoryImp ( )

default

Destructor.

Empty.

Member Function Documentation

build()

template<class Base >

std::unique_ptr< Base > libMesh::Factory< Base >::build ( const std::string &  name )

inlinestaticinherited

Builds an object of type Base identified by name.

Definition at line 129 of file factory.h.

References libMesh::Factory< Base >::create(), libMesh::err, and libMesh::Quality::name().

Referenced by main().

{
  // name not found in the map
  if (!factory_map().count(name))
    {
      libMesh::err << "Tried to build an unknown type: " << name << std::endl;

      libMesh::err << "valid options are:" << std::endl;

      for (const auto & pr : factory_map())
        libMesh::err << "  " << pr.first << std::endl;

      libmesh_error_msg("Exiting...");
    }

  Factory<Base> * f = factory_map()[name];
  return std::unique_ptr<Base>(f->create());
}

create()

template<class Derived , class Base >

std::unique_ptr< Base > libMesh::FactoryImp< Derived, Base >::create ( )

inlineoverrideprivatevirtual

Returns

A new object of type Derived.

Implements libMesh::Factory< Base >.

Definition at line 152 of file factory.h.

{
  return std::make_unique<Derived>();
}

factory_map() [1/4]

template<>

std::map< std::string, Factory< Partitioner > * > & libMesh::Factory< Partitioner >::factory_map ( )

protectedinherited

Definition at line 38 of file partitioner_factory.C.

{
  static std::map<std::string, Factory<Partitioner> *> _map;
  return _map;
}

factory_map() [2/4]

template<>

std::map< std::string, Factory< FunctionBase< Number > > * > & libMesh::Factory< FunctionBase< Number > >::factory_map ( )

protectedinherited

Definition at line 64 of file factoryfunction.C.

{
  static std::map<std::string, Factory<FunctionBase<Number>> *> _map;
  return _map;
}

factory_map() [3/4]

template<>

std::map< std::string, Factory< FunctionBase< Number > > * > & libMesh::Factory< FunctionBase< Number > >::factory_map ( )

protectedinherited

Definition at line 64 of file factoryfunction.C.

{
  static std::map<std::string, Factory<FunctionBase<Number>> *> _map;
  return _map;
}

factory_map() [4/4]

template<class Base>

static std::map<std::string, Factory<Base> *>& libMesh::Factory< Base >::factory_map ( )

staticprotectedinherited

Map from a name to a Factory<Base> * pointer.

---

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

• include/base/factory.h