Inheritance diagram for PLMD::vesselbase::Histogram:

Public Member Functions
	Histogram (const VesselOptions &da)

std::string	description ()
	Return a description of the vessel contents. More...

unsigned	getNumberOfTerms ()
	Retrieve the number of terms we need to accumulate. More...

void	resize ()
	Reset the size of the buffers. More...

bool	calculate ()
	Calculate the part of the vessel that is done in the loop. More...

void	finish ()
	Complete the calculation once the loop is finished. More...

bool	applyForce (std::vector< double > &forces)
	Retrieve the forces on the quantities in the vessel. More...

std::string	getName () const
	Return the name. More...

std::string	getLabel () const
	Return the label. More...

void	checkRead ()
	Check that readin was fine. More...

void	zero ()
	Set all the buffer elements to zero. More...

void	addToBufferElement (const unsigned &i, const double &val)
	Add something to the ith element in the buffer. More...

virtual void	prepare ()
	Do something before the loop. More...

Static Public Member Functions
static void	registerKeywords (Keywords &keys)

static void	reserveKeyword (Keywords &keys)

Public Attributes
Log &	log
	Reference to the log on which to output details. More...

Protected Member Functions
void	addVessel (const std::string &name, const std::string &intput)

int	getNumericalLabel () const
	Return the numerical label. More...

void	error (const std::string &errmsg)
	Report an error. More...

template<class T >
void	parse (const std::string &key, T &t)
	Parse something from the input. More...

template<class T >
void	parseVector (const std::string &key, std::vector< T > &t)
	Parse one keyword as std::vector. More...

void	parseFlag (const std::string &key, bool &t)
	Parse one keyword as boolean flag. More...

std::string	getAllInput ()
	This returns the whole input line (it is used for less_than/more_than/between) More...

ActionWithVessel *	getAction ()
	Return a pointer to the action we are working in. More...

double	getTolerance () const
	Return the value of the tolerance. More...

double	getNLTolerance () const
	Return the value of the neighbor list tolerance. More...

void	resizeBuffer (const unsigned &n)
	Set the size of the data buffer. More...

void	setBufferElement (const unsigned &i, const double &val)
	Set the value of the ith element in the buffer. More...

double	getBufferElement (const unsigned &i) const
	Get the value in the ith element of the buffer. More...

void	stashBuffers ()
	Store everything that is the buffers. More...

void	setBufferFromStash ()
	Add the contents of the stash to the buffer. More...

Protected Attributes
Communicator &	comm
	A copy of the communicator. More...

Detailed Description

Definition at line 29 of file Histogram.cpp.

Constructor & Destructor Documentation

PLMD::vesselbase::Histogram::Histogram ( const VesselOptions & da )

Definition at line 50 of file Histogram.cpp.

Member Function Documentation

void PLMD::vesselbase::Vessel::addToBufferElement	(	const unsigned &	i,
		const double &	val
	)

inlineinherited

Add something to the ith element in the buffer.

Definition at line 252 of file Vessel.h.

void PLMD::vesselbase::ShortcutVessel::addVessel	(	const std::string &	name,
		const std::string &	intput
	)

protectedinherited

Definition at line 38 of file ShortcutVessel.cpp.

bool PLMD::vesselbase::ShortcutVessel::applyForce ( std::vector< double > & forces )

inlinevirtualinherited

Retrieve the forces on the quantities in the vessel.

Implements PLMD::vesselbase::Vessel.

Definition at line 45 of file ShortcutVessel.h.

bool PLMD::vesselbase::ShortcutVessel::calculate ( )

inlinevirtualinherited

Calculate the part of the vessel that is done in the loop.

Implements PLMD::vesselbase::Vessel.

Definition at line 43 of file ShortcutVessel.h.

void PLMD::vesselbase::Vessel::checkRead ( )

inherited

Check that readin was fine.

Definition at line 111 of file Vessel.cpp.

std::string PLMD::vesselbase::ShortcutVessel::description ( )

inlinevirtualinherited

Return a description of the vessel contents.

Implements PLMD::vesselbase::Vessel.

Definition at line 40 of file ShortcutVessel.h.

void PLMD::vesselbase::Vessel::error ( const std::string & errmsg )

protectedinherited

Report an error.

Definition at line 122 of file Vessel.cpp.

void PLMD::vesselbase::ShortcutVessel::finish ( )

inlinevirtualinherited

Complete the calculation once the loop is finished.

Implements PLMD::vesselbase::Vessel.

Definition at line 44 of file ShortcutVessel.h.

ActionWithVessel * PLMD::vesselbase::Vessel::getAction ( )

inlineprotectedinherited

Return a pointer to the action we are working in.

Definition at line 236 of file Vessel.h.

std::string PLMD::vesselbase::Vessel::getAllInput ( )

protectedinherited

This returns the whole input line (it is used for less_than/more_than/between)

Definition at line 84 of file Vessel.cpp.

double PLMD::vesselbase::Vessel::getBufferElement ( const unsigned & i ) const

inlineprotectedinherited

Get the value in the ith element of the buffer.

Definition at line 258 of file Vessel.h.

std::string PLMD::vesselbase::Vessel::getLabel ( ) const

inherited

Return the label.

Definition at line 80 of file Vessel.cpp.

std::string PLMD::vesselbase::Vessel::getName ( ) const

inherited

Return the name.

Definition at line 76 of file Vessel.cpp.

double PLMD::vesselbase::Vessel::getNLTolerance ( ) const

inlineprotectedinherited

Return the value of the neighbor list tolerance.

Definition at line 231 of file Vessel.h.

unsigned PLMD::vesselbase::ShortcutVessel::getNumberOfTerms ( )

inlinevirtualinherited

Retrieve the number of terms we need to accumulate.

Implements PLMD::vesselbase::Vessel.

Definition at line 41 of file ShortcutVessel.h.

int PLMD::vesselbase::Vessel::getNumericalLabel ( ) const

inlineprotectedinherited

Return the numerical label.

Definition at line 216 of file Vessel.h.

double PLMD::vesselbase::Vessel::getTolerance ( ) const

inlineprotectedinherited

Return the value of the tolerance.

Definition at line 226 of file Vessel.h.

template<class T >

void PLMD::vesselbase::Vessel::parse	(	const std::string &	key,
		T &	t
	)

protectedinherited

Parse something from the input.

Definition at line 169 of file Vessel.h.

void PLMD::vesselbase::Vessel::parseFlag	(	const std::string &	key,
		bool &	t
	)

protectedinherited

Parse one keyword as boolean flag.

Definition at line 93 of file Vessel.cpp.

template<class T >

void PLMD::vesselbase::Vessel::parseVector	(	const std::string &	key,
		std::vector< T > &	t
	)

protectedinherited

Parse one keyword as std::vector.

Definition at line 184 of file Vessel.h.

virtual void PLMD::vesselbase::Vessel::prepare ( )

inlinevirtualinherited

Do something before the loop.

Reimplemented in PLMD::vesselbase::BridgeVessel.

Definition at line 155 of file Vessel.h.

void PLMD::vesselbase::Histogram::registerKeywords ( Keywords & keys )

static

Definition at line 38 of file Histogram.cpp.

void PLMD::vesselbase::Histogram::reserveKeyword ( Keywords & keys )

static

Definition at line 45 of file Histogram.cpp.

void PLMD::vesselbase::ShortcutVessel::resize ( )

inlinevirtualinherited

Reset the size of the buffers.

Implements PLMD::vesselbase::Vessel.

Definition at line 42 of file ShortcutVessel.h.

void PLMD::vesselbase::Vessel::resizeBuffer ( const unsigned & n )

inlineprotectedinherited

Set the size of the data buffer.

Definition at line 221 of file Vessel.h.

void PLMD::vesselbase::Vessel::setBufferElement	(	const unsigned &	i,
		const double &	val
	)

inlineprotectedinherited

Set the value of the ith element in the buffer.

Definition at line 246 of file Vessel.h.

void PLMD::vesselbase::Vessel::setBufferFromStash ( )

protectedinherited

Add the contents of the stash to the buffer.

Definition at line 133 of file Vessel.cpp.

void PLMD::vesselbase::Vessel::stashBuffers ( )

protectedinherited

Store everything that is the buffers.

Definition at line 128 of file Vessel.cpp.

void PLMD::vesselbase::Vessel::zero ( )

inlineinherited

Set all the buffer elements to zero.

Definition at line 241 of file Vessel.h.

Member Data Documentation

Communicator& PLMD::vesselbase::Vessel::comm

protectedinherited

A copy of the communicator.

Definition at line 102 of file Vessel.h.

Log& PLMD::vesselbase::Vessel::log

inherited

Reference to the log on which to output details.

Definition at line 135 of file Vessel.h.

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

vesselbase/Histogram.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation