Manager for a set of McMove objects. More...

#include <McMoveManager.h>

Inheritance diagram for Pscf::Rp::McMoveManager< D, T >:

Public Member Functions
virtual void	readParameters (std::istream &in)
	Read instructions for creating McMove objects.
void	setup ()
	Initialize at beginning of system run.
T::McMove &	chooseMove ()
	Choose an McMove at random, using specified probabilities.
void	output () const
	Output statistics for all moves.
double	probability (int i) const
	Return probability of move i.
void	outputTimers (std::ostream &out) const
	Write timing results to an output stream.
void	clearTimers ()
	Clear timers.
bool	needsCc ()
	Decide whether any move needs to store cc fields.
bool	needsDc ()
	Decide whether any move needs to store dc fields.
Public Member Functions inherited from Util::Manager< T::McMove >
	Manager (bool uniqueNames=false)
	Constructor.
virtual	~Manager ()
	Destructor.
void	addSubfactory (Factory< T::McMove > &subfactory)
	Set a SubFactory for this Manager.
void	setFactory (Factory< T::McMove > &factory)
	Associate a Factory with this Manager.
virtual void	readParam (std::istream &in)
	Read and create a set of objects.
virtual void	readParamOptional (std::istream &in)
	Optionally read and create a set of objects.
virtual void	loadParameters (Serializable::IArchive &ar)
	Load a set of objects to an output archive.
virtual void	save (Serializable::OArchive &ar)
	Save a set of objects to an output archive.
void	append (T::McMove &data, const std::string &name)
	Append a Data object to the end of the sequence.
int	size () const
	Get logical size.
std::string	className (int i) const
	Get the subclass name for object number i.
Factory< T::McMove > &	factory ()
	Return a reference to the factory.
bool	hasFactory () const
	Return true if this Manager has a Factory, false otherwise.
T::McMove &	operator[] (int i) const
	Mimic C array subscripting.
T::McMove *	findFirst (std::string const &className)
	Return pointer to first object with specified class name.
Public Member Functions inherited from Util::ParamComposite
	ParamComposite ()
	Constructor.
	ParamComposite (const ParamComposite &other)
	Copy constructor.
	ParamComposite (int capacity)
	Constructor.
virtual	~ParamComposite ()
	Virtual destructor.
void	resetParam ()
	Resets ParamComposite to its empty state.
virtual void	writeParam (std::ostream &out) const
	Write all parameters to an output stream.
virtual void	load (Serializable::IArchive &ar)
	Load all parameters from an input archive.
virtual void	loadOptional (Serializable::IArchive &ar)
	Load an optional ParamComposite.
void	saveOptional (Serializable::OArchive &ar)
	Saves isActive flag, and then calls save() iff isActive is true.
void	readParamComposite (std::istream &in, ParamComposite &child, bool next=true)
	Add and read a required child ParamComposite.
void	readParamCompositeOptional (std::istream &in, ParamComposite &child, bool next=true)
	Add and attempt to read an optional child ParamComposite.
template<typename Type>
ScalarParam< Type > &	read (std::istream &in, const char *label, Type &value)
	Add and read a new required ScalarParam < Type > object.
template<typename Type>
ScalarParam< Type > &	readOptional (std::istream &in, const char *label, Type &value)
	Add and read a new optional ScalarParam < Type > object.
template<typename Type>
CArrayParam< Type > &	readCArray (std::istream &in, const char label, Type value, int n)
	Add and read a required C array parameter.
template<typename Type>
CArrayParam< Type > &	readOptionalCArray (std::istream &in, const char label, Type value, int n)
	Add and read an optional C array parameter.
template<typename Type>
DArrayParam< Type > &	readDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read a required DArray < Type > parameter.
template<typename Type>
DArrayParam< Type > &	readOptionalDArray (std::istream &in, const char *label, DArray< Type > &array, int n)
	Add and read an optional DArray < Type > parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	readFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read a required FArray < Type, N > array parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	readOptionalFArray (std::istream &in, const char *label, FArray< Type, N > &array)
	Add and read an optional FArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	readFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read a required FSArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	readOptionalFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size)
	Add and read an optional FSArray < Type, N > array parameter.
template<typename Type>
CArray2DParam< Type > &	readCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read a required CArray2DParam < Type > 2D C-array.
template<typename Type>
CArray2DParam< Type > &	readOptionalCArray2D (std::istream &in, const char label, Type value, int m, int n, int np)
	Add and read an optional CArray2DParam < Type > 2D C-array parameter.
template<typename Type>
DMatrixParam< Type > &	readDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read a required DMatrix < Type > matrix parameter.
template<typename Type>
DMatrixParam< Type > &	readOptionalDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and read an optional DMatrix < Type > matrix parameter.
template<typename Type>
DSymmMatrixParam< Type > &	readDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read a required symmetrix DMatrix.
template<typename Type>
DSymmMatrixParam< Type > &	readOptionalDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read an optional DMatrix matrix parameter.
Begin &	readBegin (std::istream &in, const char *label, bool isRequired=true)
	Add and read a class label and opening bracket.
End &	readEnd (std::istream &in)
	Add and read the closing bracket.
Blank &	readBlank (std::istream &in)
	Add and read a new Blank object, representing a blank line.
void	loadParamComposite (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load a required child ParamComposite.
void	loadParamCompositeOptional (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load an optional child ParamComposite if isActive.
template<typename Type>
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value, bool isRequired)
	Add and load a new ScalarParam < Type > object.
template<typename Type>
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value)
	Add and load new required ScalarParam < Type > object.
template<typename Type>
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n, bool isRequired)
	Add a C array parameter and load its elements.
template<typename Type>
CArrayParam< Type > &	loadCArray (Serializable::IArchive &ar, const char label, Type value, int n)
	Add and load a required CArrayParam< Type > array parameter.
template<typename Type>
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n, bool isRequired)
	Add an load a DArray < Type > array parameter.
template<typename Type>
DArrayParam< Type > &	loadDArray (Serializable::IArchive &ar, const char *label, DArray< Type > &array, int n)
	Add and load a required DArray< Type > array parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array, bool isRequired)
	Add and load an FArray < Type, N > fixed-size array parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	loadFArray (Serializable::IArchive &ar, const char *label, FArray< Type, N > &array)
	Add and load a required FArray < Type > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size, bool isRequired)
	Add and load an FSArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	loadFSArray (Serializable::IArchive &ar, const char *label, FSArray< Type, N > &array, int size)
	Add and load a required FSArray < Type > array parameter.
template<typename Type>
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np, bool isRequired)
	Add and load a CArray2DParam < Type > C 2D array parameter.
template<typename Type>
CArray2DParam< Type > &	loadCArray2D (Serializable::IArchive &ar, const char label, Type value, int m, int n, int np)
	Add and load a required < Type > matrix parameter.
template<typename Type>
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired)
	Add and load a DMatrixParam < Type > matrix parameter.
template<typename Type>
DMatrixParam< Type > &	loadDMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int m, int n)
	Add and load a required DMatrixParam < Type > matrix parameter.
template<typename Type>
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n, bool isRequired)
	Add and load a symmetric DSymmMatrixParam < Type > matrix parameter.
template<typename Type>
DSymmMatrixParam< Type > &	loadDSymmMatrix (Serializable::IArchive &ar, const char *label, DMatrix< Type > &matrix, int n)
	Add and load a required DSymmMatrixParam < Type > matrix parameter.
void	addParamComposite (ParamComposite &child, bool next=true)
	Add a child ParamComposite object to the format array.
Begin &	addBegin (const char *label)
	Add a Begin object representing a class name and bracket.
End &	addEnd ()
	Add a closing bracket.
Blank &	addBlank ()
	Create and add a new Blank object, representing a blank line.
std::string	className () const
	Get class name string.
bool	isRequired () const
	Is this ParamComposite required in the input file?
bool	isActive () const
	Is this parameter active?
Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor.
void	setIndent (const ParamComponent &parent, bool next=true)
	Set indent level.
std::string	indent () const
	Return indent string for this object (string of spaces).
template<class Archive>
void	serialize (Archive &ar, const unsigned int version)
	Serialize this ParamComponent as a string.
Public Member Functions inherited from Util::Serializable
virtual	~Serializable ()
	Destructor.
Public Member Functions inherited from Util::MpiFileIo
	MpiFileIo ()
	Constructor.
	MpiFileIo (const MpiFileIo &other)
	Copy constructor.
bool	isIoProcessor () const
	Can this processor do file I/O ?

Protected Member Functions
	McMoveManager (typename T::McSimulator &simulator, typename T::System &system)
	Constructor.
	~McMoveManager ()=default
	Destructor.
Protected Member Functions inherited from Util::Manager< T::McMove >
void	beginReadManager (std::istream &in)
	Read (or attempt to read) opening line: "ManagerName{".
void	endReadManager ()
	Add closing bracket to output format.
virtual void	initFactory ()
	Create factory if necessary.
void	setClassName (const char *className)
	Set class name string.
void	setIsRequired (bool isRequired)
	Set or unset the isActive flag.
void	setIsActive (bool isActive)
	Set or unset the isActive flag.
void	setParent (ParamComponent &param, bool next=true)
	Set this to the parent of a child component.
void	addComponent (ParamComponent &param, bool isLeaf=true)
	Add a new ParamComponent object to the format array.
template<typename Type>
ScalarParam< Type > &	add (std::istream &in, const char *label, Type &value, bool isRequired=true)
	Add a new required ScalarParam < Type > object.
template<typename Type>
CArrayParam< Type > &	addCArray (std::istream &in, const char label, Type value, int n, bool isRequired=true)
	Add (but do not read) a required C array parameter.
template<typename Type>
DArrayParam< Type > &	addDArray (std::istream &in, const char *label, DArray< Type > &array, int n, bool isRequired=true)
	Add (but do not read) a DArray < Type > parameter.
template<typename Type, int N>
FArrayParam< Type, N > &	addFArray (std::istream &in, const char *label, FArray< Type, N > &array, bool isRequired=true)
	Add (but do not read) a FArray < Type, N > array parameter.
template<typename Type, int N>
FSArrayParam< Type, N > &	addFSArray (std::istream &in, const char *label, FSArray< Type, N > &array, int size, bool isRequired=true)
	Add (but do not read) a FSArray < Type, N > array parameter.
template<typename Type>
CArray2DParam< Type > &	addCArray2D (std::istream &in, const char label, Type value, int m, int n, int np, bool isRequired=true)
	Add (but do not read) a CArray2DParam < Type > 2D C-array.
template<typename Type>
DMatrixParam< Type > &	addDMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int m, int n, bool isRequired=true)
	Add and read a required DMatrix < Type > matrix parameter.
Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor.
	ParamComponent (const ParamComponent &other)
	Copy constructor.

Additional Inherited Members
Public Types inherited from Util::Serializable
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method.
typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method.
Static Public Member Functions inherited from Util::ParamComponent
static void	initStatic ()
	Initialize static echo member to false.
static void	setEcho (bool echo=true)
	Enable or disable echoing for all subclasses of ParamComponent.
static bool	echo ()
	Get echo parameter.
Protected Attributes inherited from Util::Manager< T::McMove >
Factory< T::McMove > *	factoryPtr_
	Pointer to an associated Factory<Data> object.

Detailed Description

template<int D, class T>
class Pscf::Rp::McMoveManager< D, T >

Manager for a set of McMove objects.

Specializations of this class template are used as base classes for two closely analogous class templates, both also named McMoveManager, that are defined in Rpc and Rpg namespaces for use in the pscf_rpc and pscf_rpg programs, respectively.

Template parameters:

D : dimension
T : Types class, Rpc::Types<D> or Rpg::Types<D>

Definition at line 38 of file fts/montecarlo/McMoveManager.h.

Constructor & Destructor Documentation

◆ McMoveManager()

template<int D, class T>

Pscf::Rp::McMoveManager< D, T >::McMoveManager	(	typename T::McSimulator &	simulator,
		typename T::System &	system )

protected

Constructor.

Parameters

simulator	parent McSimulator
system	parent System

Definition at line 23 of file McMoveManager.tpp.

References Util::ParamComposite::setClassName().

◆ ~McMoveManager()

template<int D, class T>

Pscf::Rp::McMoveManager< D, T >::~McMoveManager ( )

protecteddefault

Destructor.

Member Function Documentation

◆ readParameters()

template<int D, class T>

void Pscf::Rp::McMoveManager< D, T >::readParameters ( std::istream & in )

virtual

Read instructions for creating McMove objects.

Parameters

in	input parameter stream

Reimplemented from Util::Manager< T::McMove >.

Definition at line 43 of file McMoveManager.tpp.

References Util::Manager< McMoveT >::readParameters(), and Util::Manager< McMoveT >::size().

◆ setup()

template<int D, class T>

void Pscf::Rp::McMoveManager< D, T >::setup ( )

Initialize at beginning of system run.

This method calls the initialize method for every McMove.

Definition at line 76 of file McMoveManager.tpp.

References Util::Manager< McMoveT >::size().

◆ chooseMove()

template<int D, class T>

T::McMove & Pscf::Rp::McMoveManager< D, T >::chooseMove ( )

Choose an McMove at random, using specified probabilities.

Returns: chosen McMove

Definition at line 87 of file McMoveManager.tpp.

◆ output()

template<int D, class T>

void Pscf::Rp::McMoveManager< D, T >::output ( ) const

Output statistics for all moves.

Definition at line 98 of file McMoveManager.tpp.

◆ probability()

template<int D, class T>

double Pscf::Rp::McMoveManager< D, T >::probability ( int i ) const

inline

Return probability of move i.

Parameters

i	index for McMove

Returns: probability of McMove number i

Definition at line 159 of file fts/montecarlo/McMoveManager.h.

References Util::Manager< McMoveT >::size().

◆ outputTimers()

template<int D, class T>

void Pscf::Rp::McMoveManager< D, T >::outputTimers ( std::ostream & out ) const

Write timing results to an output stream.

Parameters

out	output stream (i.e., file)

Definition at line 109 of file McMoveManager.tpp.

◆ clearTimers()

template<int D, class T>

void Pscf::Rp::McMoveManager< D, T >::clearTimers ( )

Clear timers.

Definition at line 120 of file McMoveManager.tpp.

References Util::Manager< McMoveT >::size().

◆ needsCc()

template<int D, class T>

bool Pscf::Rp::McMoveManager< D, T >::needsCc ( )

Decide whether any move needs to store cc fields.

Definition at line 131 of file McMoveManager.tpp.

References needsCc(), and Util::Manager< McMoveT >::size().

Referenced by needsCc().

◆ needsDc()

template<int D, class T>

bool Pscf::Rp::McMoveManager< D, T >::needsDc ( )

Decide whether any move needs to store dc fields.

Definition at line 145 of file McMoveManager.tpp.

References needsDc(), and Util::Manager< McMoveT >::size().

Referenced by needsDc().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ McMoveManager()

◆ ~McMoveManager()

Member Function Documentation

◆ readParameters()

◆ setup()

◆ chooseMove()

◆ output()

◆ probability()

◆ outputTimers()

◆ clearTimers()

◆ needsCc()

◆ needsDc()