This class allows you to calculate the vessel in one ActionWithVessel. More...

#include <BridgeVessel.h>

Inheritance diagram for PLMD::vesselbase::BridgeVessel:

Public Member Functions
	BridgeVessel (const VesselOptions &)

bool	hasDerivatives ()
	Does this have derivatives. More...

void	resize ()
	Resize the quantities in the vessel. More...

void	setOutputAction (ActionWithVessel *myOutputAction)
	Setup the action we are outputting to. More...

bool	applyForce (std::vector< double > &forces)
	Apply some force. More...

std::string	description ()
	Should not be called. More...

void	prepare ()
	Jobs to do before the task list starts. More...

bool	calculate ()
	Actually do the calculation. More...

void	finish ()
	Finish the calculation. More...

void	completeNumericalDerivatives ()
	Calculate numerical derivatives. 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...

Static Public Member Functions
static void	registerKeywords (Keywords &keys)
	Reserve any keywords for this particular vessel. More...

static std::string	transformName (const std::string &name)
	Convert the name to the label of the component. More...

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

Protected Member Functions
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...

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

Private Attributes
unsigned	inum

std::vector< double >	mynumerical_values

ActionWithVessel *	myOutputAction

ActionWithValue *	myOutputValues

Detailed Description

This class allows you to calculate the vessel in one ActionWithVessel.

The user thinks it is created in a different Action however. At the moment this is used for region

Constructor & Destructor Documentation

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

Member Function Documentation

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

inlineinherited

Add something to the ith element in the buffer.

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

virtual

Apply some force.

Implements PLMD::vesselbase::Vessel.

bool PLMD::vesselbase::BridgeVessel::calculate ( )

virtual

Actually do the calculation.

Implements PLMD::vesselbase::Vessel.

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

inherited

Check that readin was fine.

void PLMD::vesselbase::BridgeVessel::completeNumericalDerivatives ( )

Calculate numerical derivatives.

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

virtual

Should not be called.

Implements PLMD::vesselbase::Vessel.

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

protectedinherited

Report an error.

void PLMD::vesselbase::BridgeVessel::finish ( )

virtual

Finish the calculation.

Implements PLMD::vesselbase::Vessel.

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

inlineprotectedinherited

Return a pointer to the action we are working in.

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

protectedinherited

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

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

inlineprotectedinherited

Get the value in the ith element of the buffer.

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

inherited

Return the label.

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

inherited

Return the name.

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

inlineprotectedinherited

Return the value of the neighbor list tolerance.

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

inlineprotectedinherited

Return the numerical label.

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

inlineprotectedinherited

Return the value of the tolerance.

bool PLMD::vesselbase::BridgeVessel::hasDerivatives ( )

Does this have derivatives.

template<class T >

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

protectedinherited

Parse something from the input.

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

protectedinherited

Parse one keyword as boolean flag.

template<class T >

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

protectedinherited

Parse one keyword as std::vector.

void PLMD::vesselbase::BridgeVessel::prepare ( )

virtual

Jobs to do before the task list starts.

Reimplemented from PLMD::vesselbase::Vessel.

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

staticinherited

Reserve any keywords for this particular vessel.

void PLMD::vesselbase::BridgeVessel::resize ( )

virtual

Resize the quantities in the vessel.

Implements PLMD::vesselbase::Vessel.

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

inlineprotectedinherited

Set the size of the data buffer.

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

inlineprotectedinherited

Set the value of the ith element in the buffer.

void PLMD::vesselbase::BridgeVessel::setOutputAction ( ActionWithVessel * myOutputAction )

Setup the action we are outputting to.

std::string PLMD::vesselbase::Vessel::transformName ( const std::string & name )

staticinherited

Convert the name to the label of the component.

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

inlineinherited

Set all the buffer elements to zero.

Member Data Documentation

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

protectedinherited

A copy of the communicator.

unsigned PLMD::vesselbase::BridgeVessel::inum

private

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

inherited

Reference to the log on which to output details.

std::vector<double> PLMD::vesselbase::BridgeVessel::mynumerical_values

private

ActionWithVessel* PLMD::vesselbase::BridgeVessel::myOutputAction

private

ActionWithValue* PLMD::vesselbase::BridgeVessel::myOutputValues

private

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

vesselbase/BridgeVessel.h
vesselbase/BridgeVessel.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation