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	applyForce (std::vector< double > &forces) override
	Apply some force.
void	calculate (const unsigned &current, MultiValue &myvals, std::vector< double > &buffer, std::vector< unsigned > &der_index) const override
	Actually do the calculation.
void	checkRead ()
	Check that readin was fine.
void	completeNumericalDerivatives ()
	Calculate numerical derivatives.
void	copyTaskFlags ()
	Set the task flags in the bridged class the same as in the original class.
std::string	description () override
	Should not be called.
void	finish (const std::vector< double > &buffer) override
	Finish the calculation.
std::string	getLabel () const
	Return the label.
std::string	getName () const
	Return the name.
ActionWithVessel *	getOutputAction ()
	Get the action that reads the command in.
MultiValue &	getTemporyMultiValue ()
	Return a tempory multi value - we do this so as to avoid vector resizing.
bool	hasDerivatives ()
	Does this have derivatives.
void	prepare () override
	Jobs to do before the task list starts.
void	resize () override
	Resize the quantities in the vessel.
void	setBufferStart (unsigned &start) override
	Set the start of the buffer.
void	setOutputAction (ActionWithVessel *myOutputAction)
	Setup the action we are outputting to.
MultiValue &	transformDerivatives (const unsigned &current, MultiValue &invals, MultiValue &outvals) override
	This transforms the derivatives using the output value.

Static Public Member Functions
static void	registerKeywords (Keywords &keys)
	Reserve any keywords for this particular vessel.
static std::string	transformName (const std::string &name)
	Convert the name to the label of the component.

Protected Member Functions
void	error (const std::string &errmsg)
	Report an error.
ActionWithVessel *	getAction () const
	Return a pointer to the action we are working in.
std::string	getAllInput ()
	This returns the whole input line (it is used for less_than/more_than/between).
double	getNLTolerance () const
	Return the value of the neighbor list tolerance.
int	getNumericalLabel () const
	Return the numerical label.
unsigned	getSizeOfBuffer () const
	Return the size of the buffer.
double	getTolerance () const
	Return the value of the tolerance.
template<class T>
void	parse (const std::string &key, T &t)
	Parse something from the input.
void	parseFlag (const std::string &key, bool &t)
	Parse one keyword as boolean flag.
template<class T>
void	parseVector (const std::string &key, std::vector< T > &t)
	Parse one keyword as std::vector.
void	resizeBuffer (const unsigned &n)
	Set the size of the data buffer.

Protected Attributes
unsigned	bufstart
	The start of this Vessel's buffer in buffer in the underlying ActionWithVessel.

Private Attributes
ActionWithVessel *	action
	The action that this vessel is created within.
unsigned	bufsize
	The number of elements in this vessel's buffered data.
bool	finished_read
	This just checks we have done checkRead.
unsigned	inum
const PLMD::Keywords &	keywords
	The keywords.
std::vector< std::string >	line
	Directive line.
MultiValue	my_tmp_val
std::string	mylabel
	The label for the vessel for referencing.
std::string	myname
	The keyword for the vessel in the input file.
std::vector< double >	mynumerical_values
ActionWithVessel *	myOutputAction
ActionWithValue *	myOutputValues
const int	numlab
	The numerical label for this object.

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

◆ BridgeVessel()

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

explicit

Member Function Documentation

◆ applyForce()

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

overridevirtual

Apply some force.

Implements PLMD::vesselbase::Vessel.

◆ calculate()

void PLMD::vesselbase::BridgeVessel::calculate	(	const unsigned &	current,
		MultiValue &	myvals,
		std::vector< double > &	buffer,
		std::vector< unsigned > &	der_index ) const

overridevirtual

Actually do the calculation.

Implements PLMD::vesselbase::Vessel.

◆ checkRead()

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

inherited

Check that readin was fine.

◆ completeNumericalDerivatives()

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

Calculate numerical derivatives.

◆ copyTaskFlags()

void PLMD::vesselbase::BridgeVessel::copyTaskFlags ( )

Set the task flags in the bridged class the same as in the original class.

◆ description()

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

overridevirtual

Should not be called.

Implements PLMD::vesselbase::Vessel.

◆ error()

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

protectedinherited

Report an error.

◆ finish()

void PLMD::vesselbase::BridgeVessel::finish ( const std::vector< double > & buffer )

overridevirtual

Finish the calculation.

Implements PLMD::vesselbase::Vessel.

◆ getAction()

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

inlineprotectedinherited

Return a pointer to the action we are working in.

◆ getAllInput()

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

protectedinherited

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

◆ getLabel()

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

inherited

Return the label.

◆ getName()

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

inherited

Return the name.

◆ getNLTolerance()

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

inlineprotectedinherited

Return the value of the neighbor list tolerance.

◆ getNumericalLabel()

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

inlineprotectedinherited

Return the numerical label.

◆ getOutputAction()

ActionWithVessel * PLMD::vesselbase::BridgeVessel::getOutputAction ( )

inline

Get the action that reads the command in.

◆ getSizeOfBuffer()

unsigned PLMD::vesselbase::Vessel::getSizeOfBuffer ( ) const

inlineprotectedinherited

Return the size of the buffer.

◆ getTemporyMultiValue()

MultiValue & PLMD::vesselbase::BridgeVessel::getTemporyMultiValue ( )

Return a tempory multi value - we do this so as to avoid vector resizing.

◆ getTolerance()

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

inlineprotectedinherited

Return the value of the tolerance.

◆ hasDerivatives()

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

Does this have derivatives.

◆ parse()

template<class T>

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

protectedinherited

Parse something from the input.

◆ parseFlag()

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

protectedinherited

Parse one keyword as boolean flag.

◆ parseVector()

template<class T>

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

protectedinherited

Parse one keyword as std::vector.

◆ prepare()

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

overridevirtual

Jobs to do before the task list starts.

Reimplemented from PLMD::vesselbase::Vessel.

◆ registerKeywords()

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

staticinherited

Reserve any keywords for this particular vessel.

◆ resize()

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

overridevirtual

Resize the quantities in the vessel.

Implements PLMD::vesselbase::Vessel.

◆ resizeBuffer()

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

inlineprotectedinherited

Set the size of the data buffer.

◆ setBufferStart()

void PLMD::vesselbase::BridgeVessel::setBufferStart ( unsigned & start )

overridevirtual

Set the start of the buffer.

Reimplemented from PLMD::vesselbase::Vessel.

◆ setOutputAction()

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

Setup the action we are outputting to.

◆ transformDerivatives()

MultiValue & PLMD::vesselbase::BridgeVessel::transformDerivatives	(	const unsigned &	current,
		MultiValue &	invals,
		MultiValue &	outvals )

overridevirtual

This transforms the derivatives using the output value.

Reimplemented from PLMD::vesselbase::Vessel.

◆ transformName()

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

staticinherited

Convert the name to the label of the component.

Member Data Documentation

◆ action

ActionWithVessel* PLMD::vesselbase::Vessel::action

privateinherited

The action that this vessel is created within.

◆ bufsize

unsigned PLMD::vesselbase::Vessel::bufsize

privateinherited

The number of elements in this vessel's buffered data.

◆ bufstart

unsigned PLMD::vesselbase::Vessel::bufstart

protectedinherited

The start of this Vessel's buffer in buffer in the underlying ActionWithVessel.

◆ finished_read

bool PLMD::vesselbase::Vessel::finished_read

privateinherited

This just checks we have done checkRead.

◆ inum

unsigned PLMD::vesselbase::BridgeVessel::inum

private

◆ keywords

const PLMD::Keywords& PLMD::vesselbase::Vessel::keywords

privateinherited

The keywords.

◆ line

std::vector<std::string> PLMD::vesselbase::Vessel::line

privateinherited

Directive line.

This line is progressively erased during vessel construction so as to check if all the present keywords are correct.

◆ my_tmp_val

MultiValue PLMD::vesselbase::BridgeVessel::my_tmp_val

private

◆ mylabel

std::string PLMD::vesselbase::Vessel::mylabel

privateinherited

The label for the vessel for referencing.

◆ myname

std::string PLMD::vesselbase::Vessel::myname

privateinherited

The keyword for the vessel in the input file.

◆ mynumerical_values

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

private

◆ myOutputAction

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

private

◆ myOutputValues

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

private

◆ numlab

const int PLMD::vesselbase::Vessel::numlab

privateinherited

The numerical label for this object.

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

vesselbase/BridgeVessel.h
vesselbase/BridgeVessel.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BridgeVessel()

Member Function Documentation

◆ applyForce()

◆ calculate()

◆ checkRead()

◆ completeNumericalDerivatives()

◆ copyTaskFlags()

◆ description()

◆ error()

◆ finish()

◆ getAction()

◆ getAllInput()

◆ getLabel()

◆ getName()

◆ getNLTolerance()

◆ getNumericalLabel()

◆ getOutputAction()

◆ getSizeOfBuffer()

◆ getTemporyMultiValue()

◆ getTolerance()

◆ hasDerivatives()

◆ parse()

◆ parseFlag()

◆ parseVector()

◆ prepare()

◆ registerKeywords()

◆ resize()

◆ resizeBuffer()

◆ setBufferStart()

◆ setOutputAction()

◆ transformDerivatives()

◆ transformName()

Member Data Documentation

◆ action

◆ bufsize

◆ bufstart

◆ finished_read

◆ inum

◆ keywords

◆ line

◆ my_tmp_val

◆ mylabel

◆ myname

◆ mynumerical_values

◆ myOutputAction

◆ myOutputValues

◆ numlab