Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
PLMD::vesselbase::Lowest Class Reference
Inheritance diagram for PLMD::vesselbase::Lowest:
Inheritance graph
[legend]

Public Member Functions

 Lowest (const VesselOptions &da)
 
bool applyForce (std::vector< double > &forces) override
 Retrieve the forces on the quantities in the vessel. More...
 
void calculate (const unsigned &current, MultiValue &myvals, std::vector< double > &buffer, std::vector< unsigned > &der_list) const override
 Calculate the part of the vessel that is done in the loop. More...
 
void checkRead ()
 Check that readin was fine. More...
 
bool compare (const double &, const double &) override
 
std::string description () override
 Return a description of the vessel contents. More...
 
void finish (const std::vector< double > &buffer) override
 Complete the calculation once the loop is finished. More...
 
ValuegetFinalValue () const
 
std::string getLabel () const
 Return the label. More...
 
std::string getName () const
 Return the name. More...
 
double getOutputValue () const
 
virtual void prepare ()
 Do something before the loop. More...
 
void resize () override
 Reset the size of the buffers. More...
 
virtual void setBufferStart (unsigned &start)
 Set the start of the buffer. More...
 
virtual MultiValuetransformDerivatives (const unsigned &current, MultiValue &myvals, MultiValue &bvals)
 This is replaced in bridges so we can transform the derivatives. More...
 
std::string value_descriptor () override
 

Static Public Member Functions

static void registerKeywords (Keywords &keys)
 
static void reserveKeyword (Keywords &keys)
 
static std::string transformName (const std::string &name)
 Convert the name to the label of the component. More...
 

Protected Member Functions

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

Protected Attributes

unsigned bufstart
 The start of this Vessel's buffer in buffer in the underlying ActionWithVessel. More...
 
unsigned mycomp
 The component that is being averaged/accumulated whatever. More...
 

Constructor & Destructor Documentation

◆ Lowest()

PLMD::vesselbase::Lowest::Lowest ( const VesselOptions da)
explicit

Member Function Documentation

◆ applyForce()

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

Retrieve the forces on the quantities in the vessel.

Implements PLMD::vesselbase::Vessel.

◆ calculate()

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

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

Implements PLMD::vesselbase::Vessel.

◆ checkRead()

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

Check that readin was fine.

◆ compare()

bool PLMD::vesselbase::Lowest::compare ( const double &  val1,
const double &  val2 
)
overridevirtual

◆ description()

std::string PLMD::vesselbase::ValueVessel::description ( )
overridevirtualinherited

Return a description of the vessel contents.

Implements PLMD::vesselbase::Vessel.

◆ error()

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

Report an error.

◆ finish()

void PLMD::vesselbase::OrderingVessel::finish ( const std::vector< double > &  )
overridevirtualinherited

Complete the calculation once the loop is finished.

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)

◆ getFinalValue()

Value * PLMD::vesselbase::ValueVessel::getFinalValue ( ) const
inlineinherited

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

◆ getOutputValue()

double PLMD::vesselbase::ValueVessel::getOutputValue ( ) const
inlineinherited

◆ getSizeOfBuffer()

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

Return the size of the buffer.

◆ getTolerance()

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

Return the value of the tolerance.

◆ 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()

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

Do something before the loop.

Reimplemented in PLMD::vesselbase::BridgeVessel, and PLMD::mapping::SpathVessel.

◆ registerKeywords()

void PLMD::vesselbase::Lowest::registerKeywords ( Keywords keys)
static

◆ reserveKeyword()

void PLMD::vesselbase::Lowest::reserveKeyword ( Keywords keys)
static

◆ resize()

void PLMD::vesselbase::OrderingVessel::resize ( )
overridevirtualinherited

Reset the size of the buffers.

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::Vessel::setBufferStart ( unsigned &  start)
inlinevirtualinherited

Set the start of the buffer.

Reimplemented in PLMD::vesselbase::BridgeVessel.

◆ setOutputValue()

void PLMD::vesselbase::ValueVessel::setOutputValue ( const double &  val)
inlineprotectedinherited

Set the final value.

◆ transformDerivatives()

MultiValue & PLMD::vesselbase::Vessel::transformDerivatives ( const unsigned &  current,
MultiValue myvals,
MultiValue bvals 
)
inlinevirtualinherited

This is replaced in bridges so we can transform the derivatives.

Reimplemented in PLMD::vesselbase::BridgeVessel.

◆ transformName()

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

Convert the name to the label of the component.

◆ value_descriptor()

std::string PLMD::vesselbase::Lowest::value_descriptor ( )
overridevirtual

Member Data Documentation

◆ bufstart

unsigned PLMD::vesselbase::Vessel::bufstart
protectedinherited

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

◆ mycomp

unsigned PLMD::vesselbase::ValueVessel::mycomp
protectedinherited

The component that is being averaged/accumulated whatever.


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