PSCF v1.2
Pscf::Rpg::SweepFactory< D > Class Template Reference

Default Factory for subclasses of Sweep. More...

#include <SweepFactory.h>

Inheritance diagram for Pscf::Rpg::SweepFactory< D >:
Util::Factory< Sweep< D > >

Public Member Functions

 SweepFactory (System< D > &system)
 Constructor.
 
Sweep< D > * factory (std::string const &className) const
 Method to create any Sweep subclass.
 
- Public Member Functions inherited from Util::Factory< Sweep< D > >
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
void addSubfactory (Factory< Sweep< D > > &subfactory)
 Add a new subfactory to the list.
 
Sweep< 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.
 
Sweep< D > * readObjectOptional (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd)
 Read an optional class name, instantiate an object, and read its parameters.
 
Sweep< 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< Sweep< D > >
Sweep< 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::Rpg::SweepFactory< D >

Default Factory for subclasses of Sweep.

Definition at line 40 of file rpg/System.h.

Constructor & Destructor Documentation

◆ SweepFactory()

template<int D>
Pscf::Rpg::SweepFactory< D >::SweepFactory ( System< D > & system)

Constructor.

Parameters
systemparent System object

Definition at line 21 of file rpg/scft/sweep/SweepFactory.tpp.

Member Function Documentation

◆ factory()

template<int D>
Sweep< D > * Pscf::Rpg::SweepFactory< D >::factory ( std::string const & className) const
virtual

Method to create any Sweep subclass.

Parameters
classNamename of the Sweep subclass
Returns
Sweep<D>* pointer to new instance of speciesName

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

Definition at line 29 of file rpg/scft/sweep/SweepFactory.tpp.


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