Calculates averages of all components of a Tensor-valued variable. More...

#include <TensorAverage.h>

Inheritance diagram for Util::TensorAverage:

Public Member Functions
	TensorAverage (int blockFactor=2)
	Constructor.
virtual	~TensorAverage ()
	Destructor.
void	setNSamplePerBlock (int nSamplePerBlock)
	Set nSamplePerBlock.
void	readParameters (std::istream &in)
	Read parameter nSamplePerBlock from file and initialize.
virtual void	loadParameters (Serializable::IArchive &ar)
	Load internal state from an archive.
virtual void	save (Serializable::OArchive &ar)
	Save internal state to an archive.
template<class Archive>
void	serialize (Archive &ar, const unsigned int version)
	Serialize this to or from an archive.
void	clear ()
	Clear all accumulators, set to empty initial state.
void	sample (const Tensor &value)
	Add a sampled value to the ensemble.
const Average &	operator() (int i, int j)
	Access the Average object for one tensor component.
int	nSamplePerBlock () const
	Get number of samples per block average.
int	iBlock () const
	Get number of samples in current block average.
bool	isBlockComplete () const
	Is the current block average complete?
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	readParam (std::istream &in)
	Read the parameter file block.
virtual void	readParamOptional (std::istream &in)
	Read optional parameter file block.
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 ?

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

Detailed Description

Calculates averages of all components of a Tensor-valued variable.

TensorAverage is a simple container for an array of Average objects, each of which calculates averages and error estimates for one component of a Tensor.

Definition at line 32 of file TensorAverage.h.

Constructor & Destructor Documentation

◆ TensorAverage()

Util::TensorAverage::TensorAverage ( int blockFactor = 2 )

Constructor.

Parameters

blockFactor ratio of block sizes for subsequent stages.

Definition at line 21 of file TensorAverage.cpp.

References Util::Dimension, Util::ParamComposite::ParamComposite(), and Util::ParamComposite::setClassName().

◆ ~TensorAverage()

Util::TensorAverage::~TensorAverage ( )

virtual

Destructor.

Definition at line 40 of file TensorAverage.cpp.

Member Function Documentation

◆ setNSamplePerBlock()

void Util::TensorAverage::setNSamplePerBlock ( int nSamplePerBlock )

Set nSamplePerBlock.

If nSamplePerBlock > 0, the sample function will increment block averages, and reset the average every nSamplePerBlock samples.

If nSamplePerBlock == 0, block averaging is disabled. This is the default (i.e., the initial value set in the constructor).

Parameters

nSamplePerBlock number of samples per block average output

Definition at line 46 of file TensorAverage.cpp.

References Util::Dimension, nSamplePerBlock(), and UTIL_THROW.

◆ readParameters()

void Util::TensorAverage::readParameters ( std::istream & in )

virtual

Read parameter nSamplePerBlock from file and initialize.

See setNSamplePerBlock() for discussion of value.

Parameters

in	input stream

Reimplemented from Util::ParamComposite.

Definition at line 65 of file TensorAverage.cpp.

References Util::Dimension, Util::ParamComposite::read(), and UTIL_THROW.

◆ loadParameters()

void Util::TensorAverage::loadParameters ( Serializable::IArchive & ar )

virtual

Load internal state from an archive.

Parameters

ar	input/loading archive

Reimplemented from Util::ParamComposite.

Definition at line 84 of file TensorAverage.cpp.

References Util::Dimension, Util::ParamComposite::loadParameter(), and UTIL_THROW.

◆ save()

void Util::TensorAverage::save ( Serializable::OArchive & ar )

virtual

Save internal state to an archive.

Parameters

ar	output/saving archive

Reimplemented from Util::ParamComposite.

Definition at line 104 of file TensorAverage.cpp.

◆ serialize()

template<class Archive>

void Util::TensorAverage::serialize	(	Archive &	ar,
		const unsigned int	version )

Serialize this to or from an archive.

Parameters

ar	input or output archive
version	file version id

Definition at line 185 of file TensorAverage.h.

References Util::Dimension.

◆ clear()

void Util::TensorAverage::clear ( )

Clear all accumulators, set to empty initial state.

Definition at line 110 of file TensorAverage.cpp.

References Util::Dimension.

◆ sample()

void Util::TensorAverage::sample ( const Tensor & value )

Add a sampled value to the ensemble.

Parameters

value sampled value

Definition at line 126 of file TensorAverage.cpp.

References Util::Dimension.

◆ operator()()

const Average & Util::TensorAverage::operator()	(	int	i,
		int	j )

Access the Average object for one tensor component.

Parameters

i	first index of associated tensor component
j	second index of associated tensor component

Returns: Average object associated with element (i, j)

Definition at line 147 of file TensorAverage.cpp.

References Util::Dimension.

◆ nSamplePerBlock()

int Util::TensorAverage::nSamplePerBlock ( ) const

inline

Get number of samples per block average.

Returns zero if block averaging is disabled.

Returns: number of samples per block (or 0 if disabled).

Definition at line 166 of file TensorAverage.h.

Referenced by setNSamplePerBlock().

◆ iBlock()

int Util::TensorAverage::iBlock ( ) const

inline

Get number of samples in current block average.

Returns 0 if block averaging is disabled (i.e., nSamplePerBlock == 0).

Returns: number of samples in current block (or 0 if disabled)

Definition at line 172 of file TensorAverage.h.

◆ isBlockComplete()

bool Util::TensorAverage::isBlockComplete ( ) const

inline

Is the current block average complete?

Returns true iff blocking is enabled and iBlock == nSamplePerBlock

Returns: (iBlock > 0) && (iBlock == nSamplePerBlock)

Definition at line 178 of file TensorAverage.h.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TensorAverage()

◆ ~TensorAverage()

Member Function Documentation

◆ setNSamplePerBlock()

◆ readParameters()

◆ loadParameters()

◆ save()

◆ serialize()

◆ clear()

◆ sample()

◆ operator()()

◆ nSamplePerBlock()

◆ iBlock()

◆ isBlockComplete()