This is the abstract base class to use for implementing new CV function, within it there is information as to how to go about implementing a new function. More...

#include <Function.h>

Inheritance diagram for PLMD::function::Function:

[legend]

Public Types
typedef std::set< Action * >	Dependencies

typedef std::set< FILE * > ::iterator	files_iterator

Public Member Functions
	Function (const ActionOptions &)

virtual	~Function ()

void	apply ()
	Apply an Action. More...

void	addValue ()
	Add a value with the name label. More...

void	setNotPeriodic ()
	Set your default value to have no periodicity. More...

void	setPeriodic (const std::string &min, const std::string &max)
	Set the value to be periodic with a particular domain. More...

void	setValue (Value *, double)
	Set the value. More...

void	addComponent (const std::string &name)
	Add a value with a name like label.name. More...

void	componentIsNotPeriodic (const std::string &name)
	Set your value component to have no periodicity. More...

void	componentIsPeriodic (const std::string &name, const std::string &min, const std::string &max)
	Set the value to be periodic with a particular domain. More...

double	getOutputQuantity (const unsigned j) const
	Get the value of one of the components of the PLMD::Action. More...

double	getOutputQuantity (const std::string &name) const
	Get the value with a specific name (N.B. if there is no such value this returns zero) More...

bool	exists (const std::string &name) const
	Check if a value with a particular name is present. More...

Value *	copyOutput (const std::string &name) const
	Return a pointer to the value with name (this is used to retrieve values in other PLMD::Actions) You should NEVER use this routine to refer to the components of your PLMD::Action. More...

Value *	copyOutput (const unsigned &n) const
	Return a pointer to the value with this number (this is used to retrieve values in other PLMD::Actions) You should NEVER use this routine to refer to the components of your PLMD::Action. More...

std::string	getComponentsList () const
	get a string that contains all the available components More...

std::vector< std::string >	getComponentsVector () const
	get a vector that contains the label for all the components More...

int	getNumberOfComponents () const
	Returns the number of values defined. More...

void	clearInputForces ()
	Clear the forces on the values. More...

virtual void	clearDerivatives ()
	Clear the derivatives of values wrt parameters. More...

void	setGradientsIfNeeded ()
	Calculate the gradients and store them for all the values (need for projections) More...

bool	checkNumericalDerivatives () const
	Check if numerical derivatives should be used. More...

void	useNumericalDerivatives ()
	This forces the class to use numerical derivatives. More...

virtual void	checkFieldsAllowed ()

virtual unsigned	getNumberOfDerivatives ()

virtual void	mergeFieldDerivatives (const std::vector< double > &derivatives, Value *val_out)

void	addDependency (Action *)
	Specify that this Action depends on another one. More...

void	clearDependencies ()
	Clear the dependence list for this Action. More...

long int	getStep () const
	Return the present timestep. More...

double	getTime () const
	Return the present time. More...

double	getTimeStep () const
	Return the timestep. More...

template<class T >
void	parse (const std::string &key, T &t)
	Parse one keyword as generic type. More...

template<class T >
bool	parseNumbered (const std::string &key, const int no, T &t)
	Parse one numbered keyword as generic type. More...

template<class T >
void	parseVector (const std::string &key, std::vector< T > &t)
	Parse one keyword as std::vector. More...

template<class T >
bool	parseNumberedVector (const std::string &key, const int no, std::vector< T > &t)
	Parse a vector with a number. More...

void	parseFlag (const std::string &key, bool &t)
	Parse one keyword as boolean flag. More...

void	error (const std::string &msg) const
	Crash calculation and print documentation. More...

void	warning (const std::string &msg)
	Issue a warning. More...

void	exit (int c=0)
	Exit with error code c. More...

void	checkRead ()
	Check if Action was properly read. More...

virtual void	prepare ()
	Prepare an Action for calculation This can be used by Action if they need some special preparation before calculation. More...

virtual void	lockRequests ()

virtual void	unlockRequests ()

virtual void	calculate ()=0
	Calculate an Action. More...

virtual void	update ()
	Update. More...

virtual void	runFinalJobs ()
	RunFinalJobs This method is called once at the very end of the calculation. More...

void	fflush ()
	Tell to the Action to flush open files. More...

virtual std::string	getDocumentation () const

const std::string &	getLabel () const
	Returns the label. More...

const std::string &	getName () const
	Returns the name. More...

virtual void	activate ()
	Set action to active. More...

virtual void	setOption (const std::string &s)

virtual void	clearOptions ()

virtual void	deactivate ()
	Set action to inactive. More...

bool	isActive () const
	Check if action is active. More...

bool	isOptionOn (const std::string &s) const
	Check if an option is on. More...

const Dependencies &	getDependencies () const
	Return dependencies. More...

virtual bool	checkNeedsGradients () const
	Check if the action needs gradient. More...

virtual void	calculateNumericalDerivatives (ActionWithValue *a=NULL)
	Perform calculation using numerical derivatives N.B. More...

FILE *	fopen (const char path, const char mode)
	Opens a file. More...

int	fclose (FILE *fp)
	Closes a file opened with Action::fclose(). More...

void	calculateFromPDB (const PDB &)
	Calculate the action given a pdb file as input. More...

virtual void	readAtomsFromPDB (const PDB &)
	This is overwritten in ActionAtomistic so that we can read the atoms from the pdb input file rather than taking them from the MD code. More...

bool	getExchangeStep () const
	Check if we are on an exchange step. More...

std::string	cite (const std::string &s)
	Cite a paper see PlumedMain::cite. More...

double	getProjection (unsigned i, unsigned j) const
	Get the scalar product between the gradients of two variables. More...

double	getArgument (const unsigned n) const
	Returns the value of an argument. More...

Value *	getPntrToArgument (const unsigned n)
	Return a pointer to specific argument. More...

unsigned	getNumberOfArguments () const
	Returns the number of arguments. More...

double	difference (int, double, double) const
	Takes the difference taking into account pbc for arg i. More...

double	bringBackInPbc (int i, double d1) const
	Takes one value and brings it back into the pbc of argument i. More...

void	parseArgumentList (const std::string &key, std::vector< Value * > &args)
	Parse a list of arguments. More...

void	requestArguments (const std::vector< Value * > &arg)
	Setup the dependencies. More...

void	addForcesOnArguments (const std::vector< double > &forces)
	Add forces to arguments (used in apply) More...

virtual void	calculateNumericalDerivatives (ActionWithValue *a=NULL)
	Calculate the numerical derivatives N.B. More...

void	lockRequests ()

void	unlockRequests ()

std::vector< Value * > &	getArguments ()
	Returns an array of pointers to the arguments. More...

void	interpretArgumentList (const std::vector< std::string > &c, std::vector< Value * > &arg)
	Convert a list of argument names into a list of pointers to the values. More...

Static Public Member Functions
static void	registerKeywords (Keywords &)

static void	noAnalyticalDerivatives (Keywords &keys)
	Insist that numerical derivatives should always be used for an action and make this fact appear in the manual. More...

static void	componentsAreNotOptional (Keywords &keys)
	Puts a message into the manual that the components always output. More...

static void	useCustomisableComponents (Keywords &keys)
	The components in the action will depend on the user. More...

Public Attributes
PlumedMain &	plumed
	Reference to main plumed object. More...

Log &	log
	Reference to the log stream. More...

std::set< FILE * >	files

Communicator &	comm

Communicator &	multi_sim_comm

const Keywords &	keywords

Protected Member Functions
void	setDerivative (int, double)

void	setDerivative (Value *, int, double)

void	addValueWithDerivatives ()

void	addComponentWithDerivatives (const std::string &name)

Value *	getPntrToValue ()
	Get a pointer to the default value. More...

void	setValue (const double &d)
	Set the default value (the one without name) More...

Value *	getPntrToComponent (int i)
	Return a pointer to the component by index. More...

Value *	getPntrToComponent (const std::string &name)
	Return a pointer to the value by name. More...

void	expandArgKeywordInPDB (PDB &pdb)
	This changes the arg keyword in the pdb file. More...

Detailed Description

This is the abstract base class to use for implementing new CV function, within it there is information as to how to go about implementing a new function.

Definition at line 37 of file Function.h.

Member Typedef Documentation

typedef std::set<Action*> PLMD::Action::Dependencies

inherited

Definition at line 75 of file Action.h.

typedef std::set<FILE*>::iterator PLMD::Action::files_iterator

inherited

Definition at line 140 of file Action.h.

Constructor & Destructor Documentation

PLMD::function::Function::Function ( const ActionOptions & ao )

Definition at line 35 of file Function.cpp.

virtual PLMD::function::Function::~Function ( )

inlinevirtual

Definition at line 48 of file Function.h.

Member Function Documentation

void PLMD::Action::activate ( )

virtualinherited

Set action to active.

Definition at line 127 of file Action.cpp.

void PLMD::ActionWithValue::addComponent ( const std::string & name )

inherited

Add a value with a name like label.name.

Definition at line 128 of file ActionWithValue.cpp.

void PLMD::function::Function::addComponentWithDerivatives ( const std::string & name )

protected

Definition at line 58 of file Function.cpp.

void PLMD::Action::addDependency ( Action * action )

inherited

Specify that this Action depends on another one.

Definition at line 123 of file Action.cpp.

void PLMD::ActionWithArguments::addForcesOnArguments ( const std::vector< double > & forces )

inherited

Add forces to arguments (used in apply)

Definition at line 276 of file ActionWithArguments.cpp.

void PLMD::ActionWithValue::addValue ( )

inherited

Add a value with the name label.

Definition at line 97 of file ActionWithValue.cpp.

void PLMD::function::Function::addValueWithDerivatives ( )

protected

Definition at line 42 of file Function.cpp.

void PLMD::function::Function::apply ( )

virtual

Apply an Action.

This method is called one time per step. The set of all Actions is applied in backward order.

Implements PLMD::Action.

Definition at line 64 of file Function.cpp.

double PLMD::ActionWithArguments::bringBackInPbc	(	int	i,
		double	d1
	)		const

inlineinherited

Takes one value and brings it back into the pbc of argument i.

Definition at line 108 of file ActionWithArguments.h.

virtual void PLMD::Action::calculate ( )

pure virtualinherited

Calculate an Action.

This method is called one or more times per step. The set of all Actions is calculated in forward order.

Implemented in PLMD::bias::MetaD, PLMD::function::FuncSumHills, PLMD::analysis::Analysis, PLMD::colvar::Distance, PLMD::bias::MovingRestraint, PLMD::function::FuncPathMSD, PLMD::multicolvar::ActionVolume, PLMD::bias::External, PLMD::generic::WholeMolecules, PLMD::generic::DumpAtoms, PLMD::bias::ABMD, PLMD::colvar::Angle, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::Group, PLMD::bias::BiasValue, PLMD::colvar::DRMSD, PLMD::colvar::Gyration, PLMD::IMD, PLMD::colvar::ContactMap, PLMD::function::Matheval, PLMD::generic::RandomExchanges, PLMD::colvar::PathMSDBase, PLMD::generic::Read, PLMD::function::Piecewise, PLMD::bias::LWalls, PLMD::bias::UWalls, PLMD::multicolvar::MultiColvar, PLMD::generic::Include, PLMD::generic::Print, PLMD::vatom::Center, PLMD::function::Combine, PLMD::bias::Restraint, PLMD::generic::Flush, PLMD::colvar::Energy, PLMD::function::Sort, PLMD::multicolvar::MultiColvarFunction, PLMD::vatom::Ghost, PLMD::colvar::Constant, PLMD::colvar::Torsion, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::vatom::COM, PLMD::generic::Debug, PLMD::colvar::Dipole, PLMD::colvar::Cell, PLMD::colvar::ColvarFake, PLMD::colvar::Volume, PLMD::colvar::Template, PLMD::generic::Time, PLMD::function::Target, PLMD::generic::DumpProjections, PLMD::colvar::RMSD, PLMD::colvar::CoordinationBase, PLMD::manyrestraints::Sphere, and PLMD::ActionSetup.

void PLMD::Action::calculateFromPDB ( const PDB & pdb )

inherited

Calculate the action given a pdb file as input.

This is used to initialize things like distance from a point in CV map space given a pdb as an input file

Definition at line 205 of file Action.cpp.

void PLMD::ActionWithArguments::calculateNumericalDerivatives ( ActionWithValue * a = NULL )

virtualinherited

Calculate the numerical derivatives N.B.

only pass an ActionWithValue to this routine if you know exactly what you are doing. The default will be correct for the vast majority of cases

Reimplemented from PLMD::Action.

Definition at line 242 of file ActionWithArguments.cpp.

void PLMD::Action::calculateNumericalDerivatives ( ActionWithValue * a = NULL )

virtualinherited

Perform calculation using numerical derivatives N.B.

only pass an ActionWithValue to this routine if you know exactly what you are doing.

Reimplemented in PLMD::ActionAtomistic, PLMD::multicolvar::ActionVolume, PLMD::ActionWithArguments, and PLMD::multicolvar::MultiColvarFunction.

Definition at line 187 of file Action.cpp.

virtual void PLMD::ActionWithValue::checkFieldsAllowed ( )

inlinevirtualinherited

Reimplemented in PLMD::colvar::ContactMap.

Definition at line 162 of file ActionWithValue.h.

virtual bool PLMD::Action::checkNeedsGradients ( ) const

inlinevirtualinherited

Check if the action needs gradient.

Reimplemented in PLMD::bias::MetaD, and PLMD::generic::DumpProjections.

Definition at line 230 of file Action.h.

bool PLMD::ActionWithValue::checkNumericalDerivatives ( ) const

inlinevirtualinherited

Check if numerical derivatives should be used.

Reimplemented from PLMD::Action.

Definition at line 200 of file ActionWithValue.h.

void PLMD::Action::checkRead ( )

inherited

Check if Action was properly read.

This checks if Action::line is empty. It must be called after a final Action has been initialized

Definition at line 161 of file Action.cpp.

std::string PLMD::Action::cite ( const std::string & s )

inherited

Cite a paper see PlumedMain::cite.

Definition at line 221 of file Action.cpp.

void PLMD::Action::clearDependencies ( )

inherited

Clear the dependence list for this Action.

Definition at line 153 of file Action.cpp.

void PLMD::ActionWithValue::clearDerivatives ( )

virtualinherited

Clear the derivatives of values wrt parameters.

Reimplemented in PLMD::multicolvar::ActionVolume.

Definition at line 69 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::clearInputForces ( )

inherited

Clear the forces on the values.

Definition at line 66 of file ActionWithValue.cpp.

void PLMD::Action::clearOptions ( )

virtualinherited

Definition at line 147 of file Action.cpp.

void PLMD::ActionWithValue::componentIsNotPeriodic ( const std::string & name )

inherited

Set your value component to have no periodicity.

Definition at line 188 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::componentIsPeriodic	(	const std::string &	name,
		const std::string &	min,
		const std::string &	max
	)

inherited

Set the value to be periodic with a particular domain.

Definition at line 200 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::componentsAreNotOptional ( Keywords & keys )

staticinherited

Puts a message into the manual that the components always output.

Definition at line 42 of file ActionWithValue.cpp.

Value * PLMD::ActionWithValue::copyOutput ( const std::string & name ) const

inherited

Return a pointer to the value with name (this is used to retrieve values in other PLMD::Actions) You should NEVER use this routine to refer to the components of your PLMD::Action.

Use getPntrToComponent instead.

Definition at line 82 of file ActionWithValue.cpp.

Value * PLMD::ActionWithValue::copyOutput ( const unsigned & n ) const

inherited

Return a pointer to the value with this number (this is used to retrieve values in other PLMD::Actions) You should NEVER use this routine to refer to the components of your PLMD::Action.

Use getPntrToComponent instead.

Definition at line 90 of file ActionWithValue.cpp.

void PLMD::Action::deactivate ( )

inlinevirtualinherited

Set action to inactive.

Definition at line 369 of file Action.h.

double PLMD::ActionWithArguments::difference	(	int	i,
		double	d1,
		double	d2
	)		const

inlineinherited

Takes the difference taking into account pbc for arg i.

Definition at line 103 of file ActionWithArguments.h.

void PLMD::Action::error ( const std::string & msg ) const

inherited

Crash calculation and print documentation.

Definition at line 195 of file Action.cpp.

bool PLMD::ActionWithValue::exists ( const std::string & name ) const

inherited

Check if a value with a particular name is present.

This is only used in PLMD::ActionWithArguments. You should not use it when manipulating components.

Definition at line 75 of file ActionWithValue.cpp.

void PLMD::Action::exit ( int c = 0 )

inherited

Exit with error code c.

Definition at line 183 of file Action.cpp.

void PLMD::ActionWithArguments::expandArgKeywordInPDB ( PDB & pdb )

protectedinherited

This changes the arg keyword in the pdb file.

Definition at line 193 of file ActionWithArguments.cpp.

int PLMD::Action::fclose ( FILE * fp )

inherited

Closes a file opened with Action::fclose().

Definition at line 93 of file Action.cpp.

void PLMD::Action::fflush ( )

inherited

Tell to the Action to flush open files.

Definition at line 98 of file Action.cpp.

FILE * PLMD::Action::fopen	(	const char *	path,
		const char *	mode
	)

inherited

Opens a file.

This is similar to plain fopen, but with some extra functionality.

When opened for writing, processors other than the one with rank 0 just open /dev/null
PlumedMain::fopen is used, so that other tricks may appear (see PlumedMain::fopen)

Definition at line 83 of file Action.cpp.

double PLMD::ActionWithArguments::getArgument ( const unsigned n ) const

inlineinherited

Returns the value of an argument.

Definition at line 93 of file ActionWithArguments.h.

std::vector< Value * > & PLMD::ActionWithArguments::getArguments ( )

inlineinherited

Returns an array of pointers to the arguments.

Definition at line 123 of file ActionWithArguments.h.

std::string PLMD::ActionWithValue::getComponentsList ( ) const

inherited

get a string that contains all the available components

Definition at line 170 of file ActionWithValue.cpp.

std::vector< std::string > PLMD::ActionWithValue::getComponentsVector ( ) const

inherited

get a vector that contains the label for all the components

Definition at line 179 of file ActionWithValue.cpp.

const Dependencies& PLMD::Action::getDependencies ( ) const

inlineinherited

Return dependencies.

Definition at line 224 of file Action.h.

std::string PLMD::Action::getDocumentation ( ) const

virtualinherited

Definition at line 157 of file Action.cpp.

bool PLMD::Action::getExchangeStep ( ) const

inherited

Check if we are on an exchange step.

Definition at line 217 of file Action.cpp.

const std::string & PLMD::Action::getLabel ( ) const

inlineinherited

Returns the label.

Definition at line 263 of file Action.h.

const std::string & PLMD::Action::getName ( ) const

inlineinherited

Returns the name.

Definition at line 268 of file Action.h.

unsigned PLMD::ActionWithArguments::getNumberOfArguments ( ) const

inlineinherited

Returns the number of arguments.

Definition at line 98 of file ActionWithArguments.h.

int PLMD::ActionWithValue::getNumberOfComponents ( ) const

inlineinherited

Returns the number of values defined.

Definition at line 190 of file ActionWithValue.h.

unsigned PLMD::ActionWithValue::getNumberOfDerivatives ( )

inlinevirtualinherited

Reimplemented in PLMD::multicolvar::MultiColvarBase, PLMD::multicolvar::ActionVolume, PLMD::secondarystructure::SecondaryStructureRMSD, and PLMD::manyrestraints::ManyRestraintsBase.

Definition at line 205 of file ActionWithValue.h.

double PLMD::ActionWithValue::getOutputQuantity ( const unsigned j ) const

inlineinherited

Get the value of one of the components of the PLMD::Action.

Definition at line 168 of file ActionWithValue.h.

double PLMD::ActionWithValue::getOutputQuantity ( const std::string & name ) const

inlineinherited

Get the value with a specific name (N.B. if there is no such value this returns zero)

Definition at line 174 of file ActionWithValue.h.

Value * PLMD::ActionWithArguments::getPntrToArgument ( const unsigned n )

inlineinherited

Return a pointer to specific argument.

Definition at line 88 of file ActionWithArguments.h.

Value * PLMD::ActionWithValue::getPntrToComponent ( int i )

protectedinherited

Return a pointer to the component by index.

Definition at line 210 of file ActionWithValue.cpp.

Value * PLMD::ActionWithValue::getPntrToComponent ( const std::string & name )

protectedinherited

Return a pointer to the value by name.

Definition at line 205 of file ActionWithValue.cpp.

Value * PLMD::ActionWithValue::getPntrToValue ( )

protectedinherited

Get a pointer to the default value.

Definition at line 120 of file ActionWithValue.cpp.

double PLMD::ActionWithArguments::getProjection	(	unsigned	i,
		unsigned	j
	)		const

inherited

Get the scalar product between the gradients of two variables.

Definition at line 268 of file ActionWithArguments.cpp.

long int PLMD::Action::getStep ( ) const

inherited

Return the present timestep.

Definition at line 169 of file Action.cpp.

double PLMD::Action::getTime ( ) const

inherited

Return the present time.

Definition at line 173 of file Action.cpp.

double PLMD::Action::getTimeStep ( ) const

inherited

Return the timestep.

Definition at line 177 of file Action.cpp.

void PLMD::ActionWithArguments::interpretArgumentList	(	const std::vector< std::string > &	c,
		std::vector< Value * > &	arg
	)

inherited

Convert a list of argument names into a list of pointers to the values.

Definition at line 44 of file ActionWithArguments.cpp.

bool PLMD::Action::isActive ( ) const

inlineinherited

Check if action is active.

Definition at line 375 of file Action.h.

bool PLMD::Action::isOptionOn ( const std::string & s ) const

inlineinherited

Check if an option is on.

Definition at line 380 of file Action.h.

void PLMD::ActionWithArguments::lockRequests ( )

inlinevirtualinherited

Reimplemented from PLMD::Action.

Definition at line 113 of file ActionWithArguments.h.

virtual void PLMD::Action::lockRequests ( )

inlinevirtualinherited

Reimplemented in PLMD::ActionAtomistic, and PLMD::ActionWithArguments.

Definition at line 172 of file Action.h.

void PLMD::ActionWithValue::mergeFieldDerivatives	(	const std::vector< double > &	derivatives,
		Value *	val_out
	)

virtualinherited

Definition at line 215 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::noAnalyticalDerivatives ( Keywords & keys )

staticinherited

Insist that numerical derivatives should always be used for an action and make this fact appear in the manual.

Definition at line 37 of file ActionWithValue.cpp.

template<class T >

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

inherited

Parse one keyword as generic type.

Definition at line 273 of file Action.h.

void PLMD::ActionWithArguments::parseArgumentList	(	const std::string &	key,
		std::vector< Value * > &	args
	)

inherited

Parse a list of arguments.

Definition at line 40 of file ActionWithArguments.cpp.

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

inherited

Parse one keyword as boolean flag.

Definition at line 104 of file Action.cpp.

template<class T >

bool PLMD::Action::parseNumbered	(	const std::string &	key,
		const int	no,
		T &	t
	)

inherited

Parse one numbered keyword as generic type.

Definition at line 300 of file Action.h.

template<class T >

bool PLMD::Action::parseNumberedVector	(	const std::string &	key,
		const int	no,
		std::vector< T > &	t
	)

inherited

Parse a vector with a number.

Definition at line 352 of file Action.h.

template<class T >

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

inherited

Parse one keyword as std::vector.

Definition at line 311 of file Action.h.

void PLMD::Action::prepare ( )

virtualinherited

Prepare an Action for calculation This can be used by Action if they need some special preparation before calculation.

Typical case is for collective variables which would like to change their list of requested atoms. By default (if not overridden) does nothing.

Reimplemented in PLMD::analysis::Analysis, PLMD::function::FuncPathMSD, PLMD::multicolvar::MultiColvarBase, PLMD::multicolvar::ActionVolume, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::Read, PLMD::generic::Print, PLMD::colvar::Energy, and PLMD::colvar::CoordinationBase.

Definition at line 191 of file Action.cpp.

virtual void PLMD::Action::readAtomsFromPDB ( const PDB & )

inlinevirtualinherited

This is overwritten in ActionAtomistic so that we can read the atoms from the pdb input file rather than taking them from the MD code.

Reimplemented in PLMD::ActionAtomistic.

Definition at line 251 of file Action.h.

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

static

Definition at line 28 of file Function.cpp.

void PLMD::ActionWithArguments::requestArguments ( const std::vector< Value * > & arg )

inherited

Setup the dependencies.

Definition at line 206 of file ActionWithArguments.cpp.

virtual void PLMD::Action::runFinalJobs ( )

inlinevirtualinherited

RunFinalJobs This method is called once at the very end of the calculation.

The set of all Actions in run for the final time in forward order.

Reimplemented in PLMD::analysis::Analysis.

Definition at line 193 of file Action.h.

void PLMD::function::Function::setDerivative	(	int	i,
		double	d
	)

inlineprotected

Definition at line 59 of file Function.h.

void PLMD::function::Function::setDerivative	(	Value *	v,
		int	i,
		double	d
	)

inlineprotected

Definition at line 54 of file Function.h.

void PLMD::ActionWithValue::setGradientsIfNeeded ( )

inherited

Calculate the gradients and store them for all the values (need for projections)

Definition at line 194 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::setNotPeriodic ( )

inherited

Set your default value to have no periodicity.

Definition at line 107 of file ActionWithValue.cpp.

void PLMD::Action::setOption ( const std::string & s )

virtualinherited

Definition at line 141 of file Action.cpp.

void PLMD::ActionWithValue::setPeriodic	(	const std::string &	min,
		const std::string &	max
	)

inherited

Set the value to be periodic with a particular domain.

Definition at line 114 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::setValue ( const double & d )

inlineprotectedinherited

Set the default value (the one without name)

Definition at line 183 of file ActionWithValue.h.

void PLMD::ActionWithValue::setValue	(	Value *	,
		double
	)

inherited

Set the value.

void PLMD::ActionWithArguments::unlockRequests ( )

inlinevirtualinherited

Reimplemented from PLMD::Action.

Definition at line 118 of file ActionWithArguments.h.

virtual void PLMD::Action::unlockRequests ( )

inlinevirtualinherited

Reimplemented in PLMD::ActionAtomistic, and PLMD::ActionWithArguments.

Definition at line 173 of file Action.h.

virtual void PLMD::Action::update ( )

inlinevirtualinherited

Update.

This method is called one time per step. The set of all Actions is updated in forward order.

Reimplemented in PLMD::bias::MetaD, PLMD::analysis::Analysis, PLMD::generic::DumpAtoms, PLMD::generic::Read, PLMD::generic::Print, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, and PLMD::generic::DumpProjections.

Definition at line 188 of file Action.h.

void PLMD::ActionWithValue::useCustomisableComponents ( Keywords & keys )

staticinherited

The components in the action will depend on the user.

Definition at line 48 of file ActionWithValue.cpp.

void PLMD::ActionWithValue::useNumericalDerivatives ( )

inlineinherited

This forces the class to use numerical derivatives.

Definition at line 195 of file ActionWithValue.h.

void PLMD::Action::warning ( const std::string & msg )

inherited

Issue a warning.

Definition at line 201 of file Action.cpp.

Member Data Documentation

Communicator& PLMD::Action::comm

inherited

Definition at line 158 of file Action.h.

std::set<FILE*> PLMD::Action::files

inherited

Definition at line 139 of file Action.h.

const Keywords& PLMD::Action::keywords

inherited

Definition at line 161 of file Action.h.

Log& PLMD::Action::log

inherited

Reference to the log stream.

Definition at line 93 of file Action.h.

Communicator& PLMD::Action::multi_sim_comm

inherited

Definition at line 159 of file Action.h.

PlumedMain& PLMD::Action::plumed

inherited

Reference to main plumed object.

Definition at line 90 of file Action.h.

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

function/Function.h
function/Function.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation