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 &)

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

unsigned	getNumberOfTerms ()
	Want to get rid of this function. 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...

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

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

Private Attributes
std::vector< double >	forces

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

Definition at line 40 of file BridgeVessel.h.

Constructor & Destructor Documentation

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

Definition at line 29 of file BridgeVessel.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.

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

virtual

Apply some force.

Implements PLMD::vesselbase::Vessel.

Definition at line 143 of file BridgeVessel.cpp.

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

virtual

Actually do the calculation.

Implements PLMD::vesselbase::Vessel.

Definition at line 59 of file BridgeVessel.cpp.

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

inherited

Check that readin was fine.

Definition at line 111 of file Vessel.cpp.

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

Calculate numerical derivatives.

Definition at line 84 of file BridgeVessel.cpp.

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

virtual

Should not be called.

Implements PLMD::vesselbase::Vessel.

Definition at line 51 of file BridgeVessel.cpp.

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

protectedinherited

Report an error.

Definition at line 122 of file Vessel.cpp.

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

virtual

Finish the calculation.

Implements PLMD::vesselbase::Vessel.

Definition at line 69 of file BridgeVessel.cpp.

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::BridgeVessel::getNumberOfTerms ( )

inlinevirtual

Want to get rid of this function.

Implements PLMD::vesselbase::Vessel.

Definition at line 58 of file BridgeVessel.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.

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

virtual

Jobs to do before the task list starts.

Reimplemented from PLMD::vesselbase::Vessel.

Definition at line 55 of file BridgeVessel.cpp.

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

staticinherited

Reserve any keywords for this particular vessel.

Definition at line 53 of file Vessel.cpp.

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

virtual

Resize the quantities in the vessel.

Implements PLMD::vesselbase::Vessel.

Definition at line 36 of file BridgeVessel.cpp.

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::BridgeVessel::setOutputAction ( ActionWithVessel * myOutputAction )

Setup the action we are outputting to.

Definition at line 45 of file BridgeVessel.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.

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

private

Definition at line 42 of file BridgeVessel.h.

unsigned PLMD::vesselbase::BridgeVessel::inum

private

Definition at line 43 of file BridgeVessel.h.

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

inherited

Reference to the log on which to output details.

Definition at line 135 of file Vessel.h.

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

private

Definition at line 44 of file BridgeVessel.h.

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

private

Definition at line 45 of file BridgeVessel.h.

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

private

Definition at line 46 of file BridgeVessel.h.

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