This is used to create PLMD::Action objects that take the output from some other Action as input.
More...
#include <ActionWithArguments.h>
Public Types | |
typedef std::vector< Action * > | Dependencies |
typedef std::set< FILE * >::iterator | files_iterator |
Public Member Functions | |
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... | |
virtual 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... | |
bool | parseArgumentList (const std::string &key, int i, std::vector< Value *> &args) |
Parse a numbered 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... | |
ActionWithArguments (const ActionOptions &) | |
virtual | ~ActionWithArguments () |
virtual void | calculateNumericalDerivatives (ActionWithValue *a=NULL) |
Calculate the numerical derivatives N.B. More... | |
void | lockRequests () |
void | unlockRequests () |
const std::vector< Value * > & | getArguments () const |
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... | |
bool | checkUpdate () const |
Check if action should be updated. More... | |
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... | |
bool | getRestart () const |
Return true if we are doing a restart. More... | |
bool | getCPT () const |
Return true if we are doing at a checkpoint step. More... | |
std::string | getKeyword (const std::string &key) |
Just read one of the keywords and return the whole thing as a string. 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 | calculate ()=0 |
Calculate an Action. More... | |
virtual void | apply ()=0 |
Apply an Action. More... | |
virtual void | beforeUpdate () |
Before Update. 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 | checkNumericalDerivatives () const |
Check if numerical derivatives should be performed. More... | |
virtual bool | checkNeedsGradients () const |
Check if the action needs gradient. 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... | |
Static Public Member Functions | |
static void | registerKeywords (Keywords &keys) |
Registers the list of keywords. 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 | expandArgKeywordInPDB (PDB &pdb) |
This changes the arg keyword in the pdb file. More... | |
Private Attributes | |
std::vector< Value * > | arguments |
bool | lockRequestArguments |
This is used to create PLMD::Action objects that take the output from some other Action as input.
This is used in PLMD::Function and PLMD::Bias PLMD::Action objects that inherit from PLMD::ActionWithArguments take values and components calculated in other PLMD::Action objects and use this information to calculate some new function. If you have only one list of arguments you should use the reserved keyword ARG when you use parseArgumentList.
|
inherited |
|
inherited |
|
explicit |
|
inlinevirtual |
|
virtualinherited |
Set action to active.
|
inherited |
Specify that this Action depends on another one.
void PLMD::ActionWithArguments::addForcesOnArguments | ( | const std::vector< double > & | forces | ) |
Add forces to arguments (used in apply)
|
pure virtualinherited |
Apply an Action.
This method is called one time per step. The set of all Actions is applied in backward order.
Implemented in PLMD::mapping::PCAVars, PLMD::multicolvar::MultiColvarBase, PLMD::generic::WrapAround, PLMD::generic::Group, PLMD::generic::FitToTemplate, PLMD::generic::DumpAtoms, PLMD::generic::EffectiveEnergyDrift, PLMD::generic::WholeMolecules, PLMD::generic::DumpMassCharge, PLMD::adjmat::Sprint, PLMD::generic::ResetCell, PLMD::generic::UpdateIf, PLMD::multicolvar::DistanceFromContour, PLMD::mapping::Mapping, PLMD::adjmat::OutputCluster, PLMD::generic::RandomExchanges, PLMD::generic::Read, PLMD::multicolvar::DumpMultiColvar, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::vesselbase::ActionWithAveraging, PLMD::generic::Print, PLMD::generic::Include, PLMD::analysis::Committor, PLMD::generic::Flush, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::manyrestraints::ManyRestraintsBase, PLMD::generic::DumpProjections, PLMD::generic::Debug, PLMD::Colvar, PLMD::adjmat::ClusteringBase, PLMD::bias::Bias, PLMD::generic::Time, PLMD::function::Function, PLMD::ActionWithVirtualAtom, PLMD::bias::ReweightBase, PLMD::ActionSetup, and PLMD::gridtools::GridPrintingBase.
|
inlinevirtualinherited |
Before Update.
This is a special method that is called just before the update() method. It can be used by actions that want to do something irrespectively of the fact that update() is active or not. In other words, this is always called, even when action is not active.
Reimplemented in PLMD::generic::UpdateIf.
|
inline |
Takes one value and brings it back into the pbc of argument i.
|
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::colvar::CS2Backbone, PLMD::bias::MetaD, PLMD::bias::PBMetaD, PLMD::function::FuncSumHills, PLMD::mapping::PCAVars, PLMD::function::Matheval, PLMD::generic::WrapAround, PLMD::multicolvar::MultiColvarBase, PLMD::bias::Metainference, PLMD::function::FuncPathMSD, PLMD::colvar::RDC, PLMD::bias::ExtendedLagrangian, PLMD::generic::Group, PLMD::generic::FitToTemplate, PLMD::colvar::Distance, PLMD::colvar::ContactMap, PLMD::generic::DumpAtoms, PLMD::generic::EffectiveEnergyDrift, PLMD::bias::MovingRestraint, PLMD::colvar::ERMSD, PLMD::generic::WholeMolecules, PLMD::colvar::DRMSD, PLMD::colvar::JCoupling, PLMD::function::Target, PLMD::generic::DumpMassCharge, PLMD::bias::External, PLMD::adjmat::Sprint, PLMD::generic::ResetCell, PLMD::colvar::Gyration, PLMD::multicolvar::CenterOfMultiColvar, PLMD::bias::ABMD, PLMD::colvar::Angle, PLMD::colvar::FretEfficiency, PLMD::generic::UpdateIf, PLMD::multicolvar::DistanceFromContour, PLMD::function::Combine, PLMD::vatom::FixedAtom, PLMD::bias::BiasValue, PLMD::function::LocalEnsemble, PLMD::vatom::Center, PLMD::adjmat::OutputCluster, PLMD::colvar::PRE, PLMD::generic::Read, PLMD::generic::RandomExchanges, PLMD::colvar::NOE, PLMD::colvar::Puckering, PLMD::function::Piecewise, PLMD::multicolvar::DumpMultiColvar, PLMD::vesselbase::ActionWithAveraging, PLMD::adjmat::ClusterDistribution, PLMD::colvar::PathMSDBase, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::colvar::Position, PLMD::bias::LWalls, PLMD::bias::UWalls, PLMD::colvar::Torsion, PLMD::vatom::COM, PLMD::adjmat::ClusterDiameter, PLMD::generic::Print, PLMD::adjmat::ClusterSize, PLMD::colvar::Constant, PLMD::generic::Include, PLMD::analysis::Committor, PLMD::bias::Restraint, PLMD::generic::Flush, PLMD::adjmat::ClusterProperties, PLMD::function::Ensemble, PLMD::colvar::Energy, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::colvar::Dipole, PLMD::function::Sort, PLMD::function::Stats, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::generic::Debug, PLMD::vatom::Ghost, PLMD::colvar::Template, PLMD::generic::DumpProjections, PLMD::manyrestraints::ManyRestraintsBase, PLMD::colvar::Cell, PLMD::colvar::ColvarFake, PLMD::colvar::Volume, PLMD::generic::Time, PLMD::adjmat::ClusteringBase, PLMD::colvar::MultiRMSD, PLMD::colvar::RMSD, PLMD::colvar::PCARMSD, PLMD::colvar::CoordinationBase, PLMD::bias::ReweightBase, PLMD::ActionSetup, PLMD::gridtools::GridPrintingBase, and PLMD::mapping::PathBase.
|
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
|
virtual |
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.
Reimplemented in PLMD::mapping::PCAVars, PLMD::vesselbase::ActionWithAveraging, and PLMD::mapping::Mapping.
|
inlinevirtualinherited |
Check if the action needs gradient.
Reimplemented in PLMD::bias::MetaD, and PLMD::generic::DumpProjections.
|
inlinevirtualinherited |
Check if numerical derivatives should be performed.
Reimplemented in PLMD::ActionWithValue.
|
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
|
inherited |
Check if action should be updated.
|
inherited |
Cite a paper see PlumedMain::cite.
|
inherited |
Clear the dependence list for this Action.
|
virtualinherited |
|
inlinevirtualinherited |
Set action to inactive.
|
inline |
Takes the difference taking into account pbc for arg i.
|
inherited |
Crash calculation and print documentation.
|
inherited |
Exit with error code c.
|
protected |
This changes the arg keyword in the pdb file.
|
inherited |
Closes a file opened with Action::fclose().
|
inherited |
Tell to the Action to flush open files.
|
inherited |
Opens a file.
This is similar to plain fopen, but with some extra functionality.
|
inline |
Returns the value of an argument.
|
inline |
Returns an array of pointers to the arguments.
|
inherited |
Return true if we are doing at a checkpoint step.
|
inlineinherited |
Return dependencies.
|
virtualinherited |
|
inherited |
Check if we are on an exchange step.
|
inherited |
Just read one of the keywords and return the whole thing as a string.
|
inlineinherited |
Returns the label.
|
inlineinherited |
Returns the name.
|
inlinevirtual |
Returns the number of arguments.
Reimplemented in PLMD::vesselbase::ActionWithAveraging.
|
inline |
Return a pointer to specific argument.
double PLMD::ActionWithArguments::getProjection | ( | unsigned | i, |
unsigned | j | ||
) | const |
Get the scalar product between the gradients of two variables.
|
inlineinherited |
Return true if we are doing a restart.
|
inherited |
Return the present timestep.
|
inherited |
Return the present time.
|
inherited |
Return the timestep.
void PLMD::ActionWithArguments::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.
|
inlineinherited |
Check if action is active.
|
inlineinherited |
Check if an option is on.
|
inlinevirtual |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::PCAVars, PLMD::mapping::Mapping, and PLMD::vesselbase::ActionWithAveraging.
|
inherited |
Parse one keyword as generic type.
void PLMD::ActionWithArguments::parseArgumentList | ( | const std::string & | key, |
std::vector< Value *> & | args | ||
) |
Parse a list of arguments.
bool PLMD::ActionWithArguments::parseArgumentList | ( | const std::string & | key, |
int | i, | ||
std::vector< Value *> & | args | ||
) |
Parse a numbered list of arguments.
|
inherited |
Parse one keyword as boolean flag.
|
inherited |
Parse one numbered keyword as generic type.
|
inherited |
Parse a vector with a number.
|
inherited |
Parse one keyword as std::vector.
|
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::multicolvar::MultiColvarBase, PLMD::function::FuncPathMSD, PLMD::generic::DumpMassCharge, PLMD::generic::UpdateIf, PLMD::generic::Read, PLMD::generic::Print, PLMD::bias::ReweightTemperature, PLMD::gridtools::ConvertToFES, PLMD::colvar::Energy, and PLMD::colvar::CoordinationBase.
|
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.
|
static |
Registers the list of keywords.
void PLMD::ActionWithArguments::requestArguments | ( | const std::vector< Value *> & | arg | ) |
Setup the dependencies.
|
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, PLMD::gridtools::ConvertToFES, and PLMD::gridtools::GridPrintingBase.
|
virtualinherited |
|
inlinevirtual |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::PCAVars, PLMD::mapping::Mapping, and PLMD::vesselbase::ActionWithAveraging.
|
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::bias::PBMetaD, PLMD::bias::ExtendedLagrangian, PLMD::multicolvar::VolumeTetrapore, PLMD::multicolvar::VolumeCavity, PLMD::generic::DumpAtoms, PLMD::generic::EffectiveEnergyDrift, PLMD::generic::DumpMassCharge, PLMD::adjmat::OutputCluster, PLMD::generic::Read, PLMD::multicolvar::DumpMultiColvar, PLMD::vesselbase::ActionWithAveraging, PLMD::generic::Print, PLMD::generic::Flush, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::generic::DumpProjections, and PLMD::gridtools::GridPrintingBase.
|
inherited |
Issue a warning.
|
private |
|
inherited |
|
inherited |
|
inherited |
|
private |
|
inherited |
Reference to the log stream.
|
inherited |
|
inherited |
Reference to main plumed object.
Hosted by GitHub | 1.8.14 |