Detailed Description

Manager for a list of Analyzer objects.

Definition at line 27 of file ddMd/analyzers/AnalyzerManager.h.

#include <AnalyzerManager.h>

Inheritance diagram for DdMd::AnalyzerManager:

Public Member Functions
	AnalyzerManager (Simulation &simulation)
	Constructor. More...

virtual	~AnalyzerManager ()
	Destructor. More...

virtual void	readParameters (std::istream &in)
	Read parameter block (without begin and end). More...

virtual void	loadParameters (Serializable::IArchive &ar)
	Load internal state from an archive. More...

virtual void	save (Serializable::OArchive &ar)
	Save internal state to an archive. More...

void	setup ()
	Call setup method of each Analyzer. More...

void	clear ()
	Call clear method of each Analyzer. More...

void	sample (long iStep)
	Call sample method of each Analyzer, if scheduled. More...

void	output ()
	Call output method of each analyzer. More...

virtual Factory< Analyzer > *	newDefaultFactory () const
	Return pointer to a new default factory. More...

Public Member Functions inherited from Util::Manager< Analyzer >
	Manager (bool uniqueNames=false)
	Constructor. More...

virtual	~Manager ()
	Destructor. More...

void	addSubfactory (Factory< Analyzer > &subfactory)
	Set a SubFactory for this Manager. More...

void	setFactory (Factory< Analyzer > &factory)
	Associate a Factory with this Manager. More...

void	setFactory (Factory< Analyzer > *factoryPtr)
	Associated a Factory with this Manager (pass by pointer). More...

virtual void	readParam (std::istream &in)
	Read and create a set of objects. More...

virtual void	readParamOptional (std::istream &in)
	Optionally read and create a set of objects. More...

void	append (Analyzer &data, const std::string &name)
	Append a Data object to the end of the sequence. More...

int	size () const
	Get logical size. More...

std::string	className (int i) const
	Get the subclass name for object number i. More...

Factory< Analyzer > &	factory ()
	Return a reference to the factory. More...

bool	hasFactory () const
	Return true if this Manager has a Factory, false otherwise. More...

Analyzer &	operator[] (int i) const
	Mimic C array subscripting. More...

Analyzer *	findFirst (std::string const &className)
	Return pointer to first object with specified class name. More...

Public Member Functions inherited from Util::ParamComposite
	ParamComposite ()
	Constructor. More...

	ParamComposite (const ParamComposite &other)
	Copy constructor. More...

	ParamComposite (int capacity)
	Constructor. More...

virtual	~ParamComposite ()
	Virtual destructor. More...

void	resetParam ()
	Resets ParamComposite to its empty state. More...

virtual void	writeParam (std::ostream &out)
	Write all parameters to an output stream. More...

virtual void	load (Serializable::IArchive &ar)
	Load all parameters from an input archive. More...

virtual void	loadOptional (Serializable::IArchive &ar)
	Load an optional ParamComposite. More...

void	saveOptional (Serializable::OArchive &ar)
	Saves isActive flag, and then calls save() iff isActive is true. More...

void	readParamComposite (std::istream &in, ParamComposite &child, bool next=true)
	Add and read a required child ParamComposite. More...

void	readParamCompositeOptional (std::istream &in, ParamComposite &child, bool next=true)
	Add and attempt to read an optional child ParamComposite. More...

template<typename Type >
ScalarParam< Type > &	read (std::istream &in, const char *label, Type &value)
	Add and read a new required ScalarParam < Type > object. More...

template<typename Type >
ScalarParam< Type > &	readOptional (std::istream &in, const char *label, Type &value)
	Add and read a new optional ScalarParam < Type > object. More...

template<typename Type >
CArrayParam< Type > &	readCArray (std::istream &in, const char label, Type value, int n)
	Add and read a required C array parameter. More...

template<typename Type >
CArrayParam< Type > &	readOptionalCArray (std::istream &in, const char label, Type value, int n)
	Add and read an optional C array parameter. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

template<typename Type >
DSymmMatrixParam< Type > &	readDSymmMatrix (std::istream &in, const char *label, DMatrix< Type > &matrix, int n)
	Add and read a required symmetrix DMatrix. More...

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. More...

Begin &	readBegin (std::istream &in, const char *label, bool isRequired=true)
	Add and read a class label and opening bracket. More...

End &	readEnd (std::istream &in)
	Add and read the closing bracket. More...

Blank &	readBlank (std::istream &in)
	Add and read a new Blank object, representing a blank line. More...

void	loadParamComposite (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load a required child ParamComposite. More...

void	loadParamCompositeOptional (Serializable::IArchive &ar, ParamComposite &child, bool next=true)
	Add and load an optional child ParamComposite if isActive. More...

template<typename Type >
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value, bool isRequired)
	Add and load a new ScalarParam < Type > object. More...

template<typename Type >
ScalarParam< Type > &	loadParameter (Serializable::IArchive &ar, const char *label, Type &value)
	Add and load new required ScalarParam < Type > object. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

void	addParamComposite (ParamComposite &child, bool next=true)
	Add a child ParamComposite object to the format array. More...

Begin &	addBegin (const char *label)
	Add a Begin object representing a class name and bracket. More...

End &	addEnd ()
	Add a closing bracket. More...

Blank &	addBlank ()
	Create and add a new Blank object, representing a blank line. More...

std::string	className () const
	Get class name string. More...

bool	isRequired () const
	Is this ParamComposite required in the input file? More...

bool	isActive () const
	Is this parameter active? More...

Public Member Functions inherited from Util::ParamComponent
virtual	~ParamComponent ()
	Destructor. More...

void	setIndent (const ParamComponent &parent, bool next=true)
	Set indent level. More...

std::string	indent () const
	Return indent string for this object (string of spaces). More...

template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	Serialize this ParamComponent as a string. More...

Public Member Functions inherited from Util::Serializable
virtual	~Serializable ()
	Destructor. More...

Public Member Functions inherited from Util::MpiFileIo
	MpiFileIo ()
	Constructor. More...

	MpiFileIo (const MpiFileIo &other)
	Copy constructor. More...

bool	isIoProcessor () const
	Can this processor do file I/O ? More...

void	setIoCommunicator (MPI::Intracomm &communicator)
	Set the communicator. More...

void	clearCommunicator ()
	Clear (nullify) the communicator. More...

bool	hasIoCommunicator () const
	Does this object have an associated MPI communicator? More...

MPI::Intracomm &	ioCommunicator () const
	Get the MPI communicator by reference. More...

Additional Inherited Members
Public Types inherited from Util::Serializable
typedef BinaryFileOArchive	OArchive
	Type of output archive used by save method. More...

typedef BinaryFileIArchive	IArchive
	Type of input archive used by load method. More...

Static Public Member Functions inherited from Util::ParamComponent
static void	initStatic ()
	Initialize static echo member to false. More...

static void	setEcho (bool echo=true)
	Enable or disable echoing for all subclasses of ParamComponent. More...

static bool	echo ()
	Get echo parameter. More...

Protected Member Functions inherited from Util::Manager< Analyzer >
void	beginReadManager (std::istream &in)
	Read (or attempt to read) opening line: "ManagerName{". More...

void	endReadManager ()
	Add closing bracket to output format. More...

virtual void	initFactory ()
	Create factory if necessary. More...

Protected Member Functions inherited from Util::ParamComposite
void	setClassName (const char *className)
	Set class name string. More...

void	setIsRequired (bool isRequired)
	Set or unset the isActive flag. More...

void	setIsActive (bool isActive)
	Set or unset the isActive flag. More...

void	setParent (ParamComponent &param, bool next=true)
	Set this to the parent of a child component. More...

void	addComponent (ParamComponent &param, bool isLeaf=true)
	Add a new ParamComponent object to the format array. More...

template<typename Type >
ScalarParam< Type > &	add (std::istream &in, const char *label, Type &value, bool isRequired=true)
	Add a new required ScalarParam < Type > object. More...

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. More...

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. More...

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. More...

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. More...

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. More...

Protected Member Functions inherited from Util::ParamComponent
	ParamComponent ()
	Constructor. More...

	ParamComponent (const ParamComponent &other)
	Copy constructor. More...

Protected Attributes inherited from Util::Manager< Analyzer >
Factory< Analyzer > *	factoryPtr_
	Pointer to an associated Factory<Data> object. More...

Constructor & Destructor Documentation

DdMd::AnalyzerManager::AnalyzerManager ( Simulation & simulation )

Constructor.

Definition at line 19 of file ddMd/analyzers/AnalyzerManager.cpp.

References Util::ParamComposite::setClassName().

DdMd::AnalyzerManager::~AnalyzerManager ( )

virtual

Destructor.

Definition at line 27 of file ddMd/analyzers/AnalyzerManager.cpp.

Member Function Documentation

void DdMd::AnalyzerManager::readParameters ( std::istream & in )

virtual

Read parameter block (without begin and end).

Parameters

in	input parameter file stream.

Reimplemented from Util::Manager< Analyzer >.

Definition at line 35 of file ddMd/analyzers/AnalyzerManager.cpp.

References DdMd::Analyzer::baseInterval, and Util::Manager< Data >::readParameters().

void DdMd::AnalyzerManager::loadParameters ( Serializable::IArchive & ar )

virtual

Load internal state from an archive.

Parameters

ar	input/loading archive

Reimplemented from Util::Manager< Analyzer >.

Definition at line 44 of file ddMd/analyzers/AnalyzerManager.cpp.

References DdMd::Analyzer::baseInterval, and Util::Manager< Data >::loadParameters().

void DdMd::AnalyzerManager::save ( Serializable::OArchive & ar )

virtual

Save internal state to an archive.

Parameters

ar	output/saving archive

Reimplemented from Util::Manager< Analyzer >.

Definition at line 53 of file ddMd/analyzers/AnalyzerManager.cpp.

References DdMd::Analyzer::baseInterval, and Util::Manager< Data >::save().

void DdMd::AnalyzerManager::setup ( )

Call setup method of each Analyzer.

Definition at line 62 of file ddMd/analyzers/AnalyzerManager.cpp.

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

Referenced by DdMd::TwoStepIntegrator::run().

void DdMd::AnalyzerManager::clear ( )

Call clear method of each Analyzer.

Definition at line 72 of file ddMd/analyzers/AnalyzerManager.cpp.

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

Referenced by DdMd::Integrator::clear().

void DdMd::AnalyzerManager::sample ( long iStep )

Call sample method of each Analyzer, if scheduled.

This function should be called every time step during a simulation. It executes a loop over analyzers if the static member Analyzer::baseInterval is positive on time steps for which iStep is an interval multiple of Analyzer::baseInterval. It call the sample() function of each Analyzer object only when iStep is an integer multiple of the interval variable for that Analyzer.

Parameters

iStep time step counter

Definition at line 82 of file ddMd/analyzers/AnalyzerManager.cpp.

References DdMd::Analyzer::baseInterval, and Util::Manager< Analyzer >::size().

Referenced by DdMd::TwoStepIntegrator::run().

void DdMd::AnalyzerManager::output ( )

Call output method of each analyzer.

Definition at line 98 of file ddMd/analyzers/AnalyzerManager.cpp.

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

Factory< Analyzer > * DdMd::AnalyzerManager::newDefaultFactory ( ) const

virtual

Return pointer to a new default factory.