#include <Vessel.h>
◆ Vessel()
◆ ~Vessel()
virtual PLMD::vesselbase::Vessel::~Vessel |
( |
| ) |
|
|
inlinevirtual |
Virtual destructor needed for proper inheritance.
◆ applyForce()
virtual bool PLMD::vesselbase::Vessel::applyForce |
( |
std::vector< double > & |
forces | ) |
|
|
pure virtual |
◆ calculate()
virtual void PLMD::vesselbase::Vessel::calculate |
( |
const unsigned & |
current, |
|
|
MultiValue & |
myvals, |
|
|
std::vector< double > & |
buffer, |
|
|
std::vector< unsigned > & |
der_list |
|
) |
| const |
|
pure virtual |
Calculate the part of the vessel that is done in the loop.
Implemented in PLMD::gridtools::GridVessel, PLMD::vesselbase::StoreDataVessel, PLMD::vesselbase::BridgeVessel, PLMD::vesselbase::FunctionVessel, PLMD::gridtools::HistogramOnGrid, PLMD::vesselbase::Moments, PLMD::crystallization::GradientVessel, PLMD::vesselbase::OrderingVessel, PLMD::vesselbase::ShortcutVessel, PLMD::analysis::AverageVessel, PLMD::crystallization::VectorMean, PLMD::crystallization::VectorSum, and PLMD::mapping::SpathVessel.
◆ checkRead()
void PLMD::vesselbase::Vessel::checkRead |
( |
| ) |
|
Check that readin was fine.
◆ description()
virtual std::string PLMD::vesselbase::Vessel::description |
( |
| ) |
|
|
pure virtual |
◆ error()
void PLMD::vesselbase::Vessel::error |
( |
const std::string & |
errmsg | ) |
|
|
protected |
◆ finish()
virtual void PLMD::vesselbase::Vessel::finish |
( |
const std::vector< double > & |
| ) |
|
|
pure virtual |
Complete the calculation once the loop is finished.
Implemented in PLMD::gridtools::GridVessel, PLMD::vesselbase::StoreDataVessel, PLMD::vesselbase::BridgeVessel, PLMD::vesselbase::FunctionVessel, PLMD::vesselbase::AveragingVessel, PLMD::mapping::TrigonometricPathVessel, PLMD::gridtools::HistogramOnGrid, PLMD::vesselbase::Moments, PLMD::crystallization::GradientVessel, PLMD::vesselbase::OrderingVessel, PLMD::vesselbase::ShortcutVessel, PLMD::crystallization::VectorMean, and PLMD::crystallization::VectorSum.
◆ getAction()
Return a pointer to the action we are working in.
◆ getAllInput()
std::string PLMD::vesselbase::Vessel::getAllInput |
( |
| ) |
|
|
protected |
This returns the whole input line (it is used for less_than/more_than/between)
◆ getLabel()
std::string PLMD::vesselbase::Vessel::getLabel |
( |
| ) |
const |
◆ getName()
std::string PLMD::vesselbase::Vessel::getName |
( |
| ) |
const |
◆ getNLTolerance()
double PLMD::vesselbase::Vessel::getNLTolerance |
( |
| ) |
const |
|
inlineprotected |
Return the value of the neighbor list tolerance.
◆ getNumericalLabel()
int PLMD::vesselbase::Vessel::getNumericalLabel |
( |
| ) |
const |
|
inlineprotected |
Return the numerical label.
◆ getSizeOfBuffer()
unsigned PLMD::vesselbase::Vessel::getSizeOfBuffer |
( |
| ) |
const |
|
inlineprotected |
Return the size of the buffer.
◆ getTolerance()
double PLMD::vesselbase::Vessel::getTolerance |
( |
| ) |
const |
|
inlineprotected |
Return the value of the tolerance.
◆ parse()
template<class T >
void PLMD::vesselbase::Vessel::parse |
( |
const std::string & |
key, |
|
|
T & |
t |
|
) |
| |
|
protected |
Parse something from the input.
◆ parseFlag()
void PLMD::vesselbase::Vessel::parseFlag |
( |
const std::string & |
key, |
|
|
bool & |
t |
|
) |
| |
|
protected |
Parse one keyword as boolean flag.
◆ parseVector()
template<class T >
void PLMD::vesselbase::Vessel::parseVector |
( |
const std::string & |
key, |
|
|
std::vector< T > & |
t |
|
) |
| |
|
protected |
Parse one keyword as std::vector.
◆ prepare()
virtual void PLMD::vesselbase::Vessel::prepare |
( |
| ) |
|
|
inlinevirtual |
◆ registerKeywords()
void PLMD::vesselbase::Vessel::registerKeywords |
( |
Keywords & |
keys | ) |
|
|
static |
Reserve any keywords for this particular vessel.
◆ resize()
virtual void PLMD::vesselbase::Vessel::resize |
( |
| ) |
|
|
pure virtual |
Reset the size of the buffers.
Implemented in PLMD::gridtools::GridVessel, PLMD::vesselbase::StoreDataVessel, PLMD::vesselbase::BridgeVessel, PLMD::mapping::TrigonometricPathVessel, PLMD::vesselbase::FunctionVessel, PLMD::vesselbase::Moments, PLMD::crystallization::GradientVessel, PLMD::vesselbase::OrderingVessel, PLMD::vesselbase::ShortcutVessel, PLMD::analysis::AverageVessel, PLMD::crystallization::VectorMean, and PLMD::crystallization::VectorSum.
◆ resizeBuffer()
void PLMD::vesselbase::Vessel::resizeBuffer |
( |
const unsigned & |
n | ) |
|
|
inlineprotected |
Set the size of the data buffer.
◆ setBufferStart()
void PLMD::vesselbase::Vessel::setBufferStart |
( |
unsigned & |
start | ) |
|
|
inlinevirtual |
◆ transformDerivatives()
◆ transformName()
std::string PLMD::vesselbase::Vessel::transformName |
( |
const std::string & |
name | ) |
|
|
static |
Convert the name to the label of the component.
◆ ActionWithVessel
◆ action
The action that this vessel is created within.
◆ bufsize
unsigned PLMD::vesselbase::Vessel::bufsize |
|
private |
The number of elements in this vessel's buffered data.
◆ bufstart
unsigned PLMD::vesselbase::Vessel::bufstart |
|
protected |
◆ finished_read
bool PLMD::vesselbase::Vessel::finished_read |
|
private |
This just checks we have done checkRead.
◆ keywords
◆ line
std::vector<std::string> PLMD::vesselbase::Vessel::line |
|
private |
Directive line.
This line is progressively erased during vessel construction so as to check if all the present keywords are correct.
◆ mylabel
std::string PLMD::vesselbase::Vessel::mylabel |
|
private |
The label for the vessel for referencing.
◆ myname
std::string PLMD::vesselbase::Vessel::myname |
|
private |
The keyword for the vessel in the input file.
◆ numlab
const int PLMD::vesselbase::Vessel::numlab |
|
private |
The numerical label for this object.
The documentation for this class was generated from the following files: