PLMD::function::Sum Class Reference

#include <Sum.h>

Inheritance diagram for PLMD::function::Sum:

Public Member Functions
bool	allComponentsRequired (const std::vector< Value * > &args, const std::vector< ActionWithVector * > &actions)
void	calc (const ActionWithArguments *action, const std::vector< double > &args, std::vector< double > &vals, Matrix< double > &derivatives) const override
virtual bool	derivativesImplemented ()
	Override this function if you have not implemented the derivatives. More...
virtual bool	doWithTasks () const
virtual unsigned	getArgStart () const
virtual std::vector< Value * >	getArgumentsToCheck (const std::vector< Value * > &args)
virtual std::vector< std::string >	getComponentsPerLabel () const
virtual bool	getDerivativeZeroIfValueIsZero () const
virtual std::string	getGraphInfo (const std::string &lab) const
void	read (ActionWithArguments *action) override
void	registerKeywords (Keywords &keys) override
virtual void	setPeriodicityForOutputs (ActionWithValue *action)
void	setPrefactor (ActionWithArguments *action, const double pref) override
virtual void	setup (ActionWithValue *action)
bool	zeroRank () const override

Protected Member Functions
template<class T >
void	parse (Action *action, const std::string &key, T &t)
	Parse a keyword from the input as a value. More...
void	parseFlag (Action *action, const std::string &key, bool &t)
	Parse a keyword from the input as a flag. More...
template<class T >
void	parseVector (Action *action, const std::string &key, std::vector< T > &t)
	Parse a keyword from the input as a vector. More...

Protected Attributes
bool	noderiv = false
	Are we using derivatives. More...

Private Attributes
double	prefactor

Member Function Documentation

allComponentsRequired()

bool PLMD::function::FunctionTemplateBase::allComponentsRequired ( const std::vector< Value * > &  args, const std::vector< ActionWithVector * > &  actions  )

inlineinherited

calc()

void PLMD::function::Sum::calc ( const ActionWithArguments *  action, const std::vector< double > &  args, std::vector< double > &  vals, Matrix< double > &  derivatives  ) const

overridevirtual

Implements PLMD::function::FunctionTemplateBase.

derivativesImplemented()

virtual bool PLMD::function::FunctionTemplateBase::derivativesImplemented ( )

inlinevirtualinherited

Override this function if you have not implemented the derivatives.

Reimplemented in PLMD::function::Bessel.

doWithTasks()

virtual bool PLMD::function::FunctionTemplateBase::doWithTasks ( ) const

inlinevirtualinherited

Reimplemented in PLMD::function::Highest, PLMD::function::Sort, and PLMD::function::Moments.

getArgStart()

virtual unsigned PLMD::function::FunctionTemplateBase::getArgStart ( ) const

inlinevirtualinherited

Reimplemented in PLMD::gridtools::EvaluateGridFunction.

getArgumentsToCheck()

std::vector< Value * > PLMD::function::FunctionTemplateBase::getArgumentsToCheck ( const std::vector< Value * > &  args )

inlinevirtualinherited

Reimplemented in PLMD::function::Custom.

getComponentsPerLabel()

std::vector< std::string > PLMD::function::FunctionTemplateBase::getComponentsPerLabel ( ) const

inlinevirtualinherited

Reimplemented in PLMD::function::Sort, PLMD::function::Moments, and PLMD::symfunc::SphericalHarmonic.

getDerivativeZeroIfValueIsZero()

virtual bool PLMD::function::FunctionTemplateBase::getDerivativeZeroIfValueIsZero ( ) const

inlinevirtualinherited

Reimplemented in PLMD::function::Custom, PLMD::function::LessThan, PLMD::function::MoreThan, and PLMD::function::Between.

getGraphInfo()

std::string PLMD::function::FunctionTemplateBase::getGraphInfo ( const std::string &  lab ) const

inlinevirtualinherited

Reimplemented in PLMD::function::Custom.

parse()

template<class T >

void PLMD::function::FunctionTemplateBase::parse ( Action *  action, const std::string &  key, T &  t  )

protectedinherited

Parse a keyword from the input as a value.

parseFlag()

void PLMD::function::FunctionTemplateBase::parseFlag ( Action *  action, const std::string &  key, bool &  t  )

inlineprotectedinherited

Parse a keyword from the input as a flag.

parseVector()

template<class T >

void PLMD::function::FunctionTemplateBase::parseVector ( Action *  action, const std::string &  key, std::vector< T > &  t  )

protectedinherited

Parse a keyword from the input as a vector.

read()

void PLMD::function::Sum::read ( ActionWithArguments *  action )

overridevirtual

Implements PLMD::function::FunctionTemplateBase.

registerKeywords()

void PLMD::function::Sum::registerKeywords ( Keywords &  keys )

overridevirtual

Implements PLMD::function::FunctionTemplateBase.

setPeriodicityForOutputs()

void PLMD::function::FunctionTemplateBase::setPeriodicityForOutputs ( ActionWithValue *  action )

inlinevirtualinherited

Reimplemented in PLMD::function::Sort, PLMD::function::Piecewise, PLMD::function::Moments, PLMD::refdist::Difference, PLMD::symfunc::SphericalHarmonic, and PLMD::symfunc::CylindricalHarmonic.

setPrefactor()

void PLMD::function::Sum::setPrefactor ( ActionWithArguments *  action, const double  pref  )

overridevirtual

Reimplemented from PLMD::function::FunctionTemplateBase.

setup()

void PLMD::function::FunctionTemplateBase::setup ( ActionWithValue *  action )

inlinevirtualinherited

Reimplemented in PLMD::gridtools::EvaluateGridFunction.

zeroRank()

bool PLMD::function::Sum::zeroRank ( ) const

overridevirtual

Reimplemented from PLMD::function::FunctionTemplateBase.

Member Data Documentation

noderiv

bool PLMD::function::FunctionTemplateBase::noderiv = false

protectedinherited

Are we using derivatives.

prefactor

double PLMD::function::Sum::prefactor

private

---

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

• function/Sum.h
• function/Sum.cpp