Factory for subclasses of Iterator. More...
#include <IteratorFactory.h>
Inheritance diagram for Pscf::Fd1d::IteratorFactory:
Public Member Functions | |
| IteratorFactory (System &system) | |
| Constructor. More... | |
| Iterator * | factory (const std::string &className) const |
| Method to create any Iterator supplied with PSCF. More... | |
 Public Member Functions inherited from Util::Factory< Iterator > | |
| Factory () | |
| Constructor. More... | |
| virtual | ~Factory () |
| Destructor. More... | |
| void | addSubfactory (Factory< Iterator > &subfactory) |
| Add a new subfactory to the list. More... | |
| virtual Iterator * | factory (const std::string &className) const=0 |
| Returns a pointer to a new instance of specified subclass. More... | |
| Iterator * | 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. More... | |
| Iterator * | readObjectOptional (std::istream &in, ParamComposite &parent, std::string &className, bool &isEnd) |
| Read an optional class name, instantiate an object, and read its parameters. More... | |
| Iterator * | loadObject (Serializable::IArchive &ar, ParamComposite &parent, std::string &className) |
| Load a class name, instantiate an object, and load the object. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from Util::Factory< Iterator > | |
| Iterator * | trySubfactories (const std::string &className) const |
| Search through subfactories for match. More... | |
| void | setIoCommunicator (MPI::Intracomm &communicator) |
| Set associated Mpi communicator. More... | |
| bool | hasIoCommunicator () const |
| Does this factory have a param communicator? More... | |
Detailed Description
Factory for subclasses of Iterator.
The default iterator, invoked by className Iterator, is the Anderson mixing iterator (className AmIterator).
Definition at line 30 of file fd1d/iterator/IteratorFactory.h.
Constructor & Destructor Documentation
◆ IteratorFactory()
| Pscf::Fd1d::IteratorFactory::IteratorFactory | ( | System & | system | ) |
Constructor.
- Parameters
-
system parent System object
Definition at line 16 of file fd1d/iterator/IteratorFactory.cpp.
Member Function Documentation
◆ factory()
|
virtual |
Method to create any Iterator supplied with PSCF.
- Parameters
-
className name of the Iterator subclass
- Returns
- Iterator* pointer to new instance of className
Implements Util::Factory< Iterator >.
Definition at line 23 of file fd1d/iterator/IteratorFactory.cpp.
References Util::Factory< Iterator >::trySubfactories().
The documentation for this class was generated from the following files:
