PSCF v1.2
Pscf::Rpc::PerturbationFactory< D > Class Template Reference

Factory for subclasses of Perturbation. More...

#include <PerturbationFactory.h>

Inheritance diagram for Pscf::Rpc::PerturbationFactory< D >:
Util::Factory< Perturbation< D > >

Public Member Functions

 PerturbationFactory (Simulator< D > &simulator)
 Constructor.
 
Perturbation< D > * factory (const std::string &className) const
 Method to create any Perturbation supplied with PSCF.
 
- Public Member Functions inherited from Util::Factory< Perturbation< D > >
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
void addSubfactory (Factory< Perturbation< D > > &subfactory)
 Add a new subfactory to the list.
 
Perturbation< D > * readObject (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd, bool isRequired=true)
 Read a class name, instantiate an object, and read its parameters.
 
Perturbation< D > * readObjectOptional (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd)
 Read an optional class name, instantiate an object, and read its parameters.
 
Perturbation< D > * loadObject (Serializable::IArchive &ar, ParamComposite &parent, std::string &className)
 Load a class name, instantiate an object, and load the object.
 

Additional Inherited Members

- Protected Member Functions inherited from Util::Factory< Perturbation< D > >
Perturbation< D > * trySubfactories (const std::string &className) const
 Search through subfactories for match.
 
void setIoCommunicator (MPI::Intracomm &communicator)
 Set associated Mpi communicator.
 
bool hasIoCommunicator () const
 Does this factory have a param communicator?
 

Detailed Description

template<int D>
class Pscf::Rpc::PerturbationFactory< D >

Factory for subclasses of Perturbation.

Definition at line 27 of file rpc/fts/simulator/Simulator.h.

Constructor & Destructor Documentation

◆ PerturbationFactory()

template<int D>
Pscf::Rpc::PerturbationFactory< D >::PerturbationFactory ( Simulator< D > & simulator)

Constructor.

Parameters
simulatorparent Simulator<D> object

Definition at line 20 of file rpc/fts/perturbation/PerturbationFactory.tpp.

Member Function Documentation

◆ factory()

template<int D>
Perturbation< D > * Pscf::Rpc::PerturbationFactory< D >::factory ( const std::string & className) const
virtual

Method to create any Perturbation supplied with PSCF.

Parameters
classNamename of the Perturbation subclass
Returns
Perturbation* pointer to new instance of className

Implements Util::Factory< Perturbation< D > >.

Definition at line 29 of file rpc/fts/perturbation/PerturbationFactory.tpp.


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