A monitor that give the norm of the displacement. More...

#include <MonitorNormDisplacement.h>

Public Member Functions
void	calculate () override
	calculate current followed data and store them in values vector More...

std::string	getTypeName () override
	return a string relative to monitor type More...

	MonitorNormDisplacement (mml::Monitor m, MonitoringManager monitoringManager)
	constructor More...

	~MonitorNormDisplacement () override=default
	destructor More...

Public Member Functions inherited from Monitor
int	getIndex ()

int	getIndexOfValues (const unsigned int i)
	get index i of indexes vector More...

unsigned int	getNumberOfIndex ()
	get number of index in indexes vetor More...

unsigned int	getNumberOfValues ()
	get number of value in values vetor More...

std::string	getReferenceName ()

double	getStartAt ()

double	getStopAt ()

std::string	getTargetName ()

double	getValue (const unsigned int i)
	get value i of values vector More...

bool	getValuesOfIndex (int i, double values[])
	populate values with the corresponding values at index i More...

Monitor::type	getValueType ()

	Monitor (mml::Monitor m, MonitoringManager monitoringManager, Monitor::type type)
	constructor More...

virtual void	write ()
	write data stored in values vector into mmlOut file More...

virtual	~Monitor ()
	destructor More...

Additional Inherited Members
Public Types inherited from Monitor
enum	type { SCALAR, SCALARSET, VECTORSET, MATRIX_33SET }
	type of the values stored (please update typeCount and doc if you update the enum) SCALAR: the monitor store a single scalar value SCALARSET: the monitor stores a scalar value for each atom VECTORSET: the monitor stores 3 scalar values for each atom MATRIX_33SET: the monitor stores a matrix 3x3 for each atom More...

Static Public Attributes inherited from Monitor
static const unsigned int	typeCount = 4
	number of possible types (siez of the previous enum). Please always update if the enum is updated. More...

Protected Attributes inherited from Monitor
int	dimension
	dimension of data stored More...

double	dx
	offset in x direction (if reference is not aligned) More...

double	dy
	offset in y direction (if reference is not aligned) More...

double	dz
	offset in z direction (if reference is not aligned) More...

int	index
	index of monitor More...

std::vector< int >	indexes
	vector which contains target's atoms index (in same order that values associate with) More...

std::map< int, std::vector< double > >	indexToValuesMap
	map between indexes and values More...

mml::Monitor *	mappedObject
	the xsdcxx object representing monitor, used for serialization More...

MonitoringManager *	monitoringManager
	monitoring manager More...

std::vector< Reference * >	references
	references used when monitor need references More...

double	startAt
	time to start monitoring More...

double	stopAt
	time to stop monitoring More...

std::string	target
	the name of the component targeted by the monitor More...

std::vector< double >	values
	the vector which contains data monitored More...

Monitor::type	valueType
	type of the values stored More...

Detailed Description

A monitor that give the norm of the displacement.

Constructor & Destructor Documentation

◆ MonitorNormDisplacement()

MonitorNormDisplacement::MonitorNormDisplacement	(	mml::Monitor *	m,
		MonitoringManager *	monitoringManager
	)

constructor

Parameters

m	the xsdcxx generated monitor

◆ ~MonitorNormDisplacement()

MonitorNormDisplacement::~MonitorNormDisplacement ( )

overridedefault

destructor

Member Function Documentation

◆ calculate()

void MonitorNormDisplacement::calculate ( )

overridevirtual

calculate current followed data and store them in values vector

Implements Monitor.

References AtomIterator::begin(), AtomIterator::currentAtom(), distance(), Monitor::dx, Monitor::dy, Monitor::dz, AtomIterator::end(), PhysicalModel::getAtom(), Structure::getIndex(), MonitoringManager::getInitPml(), MonitoringManager::getPml(), Atom::getPosition(), Monitor::monitoringManager, AtomIterator::next(), Monitor::target, Monitor::values, and Monitor::write().

◆ getTypeName()

std::string MonitorNormDisplacement::getTypeName ( )

overridevirtual

return a string relative to monitor type