This is the abstract base class to use for implementing new simulation biases, within it there is information as to how to go about implementing a new bias. More...
#include <Bias.h>
Public Types | |
typedef std::vector< Action * > | Dependencies |
typedef std::set< FILE * > ::iterator | files_iterator |
Public Member Functions | |
Bias (const ActionOptions &ao) | |
void | apply () |
Apply an Action. More... | |
unsigned | getNumberOfDerivatives () |
void | turnOnDerivatives () |
Activate the calculation of derivatives. More... | |
bool | onStep () const |
Check if the action is active on this step. 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... | |
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 | checkNumericalDerivatives () const |
Check if numerical derivatives should be performed. 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... | |
void | addValue () |
Add a value with the name label. More... | |
void | addValueWithDerivatives () |
Add a value with the name label that has derivatives. 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 | addComponentWithDerivatives (const std::string &name) |
Add a value with a name like label.name that has derivatives. 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... | |
bool | doNotCalculateDerivatives () const |
Are we not calculating derivatives. 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 () |
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 | resetOutputForces () |
void | setOutputForce (int i, double g) |
int | getStride () const |
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... | |
Private Attributes | |
std::vector< double > | outputForces |
This is the abstract base class to use for implementing new simulation biases, within it there is information as to how to go about implementing a new bias.
|
inherited |
|
inherited |
PLMD::bias::Bias::Bias | ( | const ActionOptions & | ao | ) |
|
virtualinherited |
Set action to active.
|
inherited |
Add a value with a name like label.name.
|
inherited |
Add a value with a name like label.name that has derivatives.
|
inherited |
Specify that this Action depends on another one.
|
inherited |
Add forces to arguments (used in apply)
|
inherited |
Add a value with the name label.
|
inherited |
Add a value with the name label that has derivatives.
|
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.
|
inlineinherited |
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::bias::MetaD, PLMD::function::FuncSumHills, PLMD::function::Matheval, PLMD::function::FuncPathMSD, PLMD::analysis::Analysis, PLMD::RDC, PLMD::colvar::Distance, PLMD::bias::MovingRestraint, PLMD::generic::WholeMolecules, PLMD::multicolvar::ActionVolume, PLMD::generic::Group, PLMD::bias::External, PLMD::generic::DumpAtoms, PLMD::generic::FitToTemplate, PLMD::bias::ABMD, PLMD::colvar::Angle, PLMD::multicolvar::MultiColvarFunction, PLMD::colvar::ContactMap, PLMD::function::Combine, PLMD::bias::BiasValue, PLMD::colvar::DRMSD, PLMD::colvar::Gyration, PLMD::colvar::NOE, PLMD::IMD, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::RandomExchanges, PLMD::generic::Read, PLMD::colvar::PathMSDBase, PLMD::function::Piecewise, PLMD::colvar::Position, PLMD::vatom::Center, PLMD::colvar::Torsion, PLMD::multicolvar::DumpMultiColvar, PLMD::multicolvar::MultiColvar, PLMD::bias::LWalls, PLMD::bias::UWalls, PLMD::generic::Include, PLMD::generic::Print, PLMD::bias::Restraint, PLMD::analysis::Committor, PLMD::generic::Flush, PLMD::vatom::COM, PLMD::colvar::Energy, PLMD::function::Sort, PLMD::generic::DumpDerivatives, PLMD::colvar::Constant, PLMD::generic::DumpForces, PLMD::manyrestraints::ManyRestraintsBase, PLMD::function::Ensemble, PLMD::generic::Debug, PLMD::vatom::Ghost, PLMD::colvar::Dipole, PLMD::colvar::Cell, PLMD::colvar::ColvarFake, PLMD::colvar::Volume, PLMD::colvar::Template, PLMD::function::Target, PLMD::generic::Time, PLMD::generic::DumpProjections, PLMD::colvar::MultiRMSD, PLMD::colvar::RMSD, PLMD::colvar::CoordinationBase, PLMD::ActionSetup, 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
|
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.
Reimplemented in PLMD::analysis::Analysis, and PLMD::mapping::Mapping.
|
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::analysis::Analysis, PLMD::ActionAtomistic, PLMD::multicolvar::ActionVolume, PLMD::multicolvar::MultiColvarFunction, PLMD::ActionWithArguments, PLMD::mapping::Mapping, and PLMD::vesselbase::ActionWithInputVessel.
|
inlinevirtualinherited |
Reimplemented in PLMD::colvar::ContactMap.
|
inlinevirtualinherited |
Check if the action needs gradient.
Reimplemented in PLMD::bias::MetaD, and PLMD::generic::DumpProjections.
|
inlinevirtualinherited |
Check if numerical derivatives should be used.
Reimplemented from PLMD::Action.
|
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 |
Cite a paper see PlumedMain::cite.
|
inherited |
Clear the dependence list for this Action.
|
virtualinherited |
Clear the derivatives of values wrt parameters.
Reimplemented in PLMD::multicolvar::ActionVolume, and PLMD::manyrestraints::ManyRestraintsBase.
|
inherited |
Clear the forces on the values.
|
virtualinherited |
|
inherited |
Set your value component to have no periodicity.
|
inherited |
Set the value to be periodic with a particular domain.
|
staticinherited |
Puts a message into the manual that the components always output.
|
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.
|
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.
|
inlinevirtualinherited |
Set action to inactive.
|
inlineinherited |
Takes the difference taking into account pbc for arg i.
|
inlineinherited |
Are we not calculating derivatives.
|
inherited |
Crash calculation and print documentation.
|
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.
|
inherited |
Exit with error code c.
|
protectedinherited |
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.
|
inlineinherited |
Returns the value of an argument.
|
inlineinherited |
Returns an array of pointers to the arguments.
|
inherited |
get a string that contains all the available components
|
inherited |
get a vector that contains the label for all the components
|
inlineinherited |
Return dependencies.
|
virtualinherited |
|
inherited |
Check if we are on an exchange step.
|
inlineinherited |
Returns the label.
|
inlineinherited |
Returns the name.
|
inlineinherited |
Returns the number of arguments.
|
inlineinherited |
Returns the number of values defined.
|
inlinevirtual |
Implements PLMD::ActionWithValue.
|
inlineinherited |
Get the value of one of the components of the PLMD::Action.
|
inlineinherited |
Get the value with a specific name (N.B. if there is no such value this returns zero)
|
inlineinherited |
Return a pointer to specific argument.
|
protectedinherited |
Return a pointer to the component by index.
|
protectedinherited |
Return a pointer to the value by name.
|
protectedinherited |
Get a pointer to the default value.
|
inherited |
Get the scalar product between the gradients of two variables.
|
inherited |
Return the present timestep.
|
protectedinherited |
|
inherited |
Return the present time.
|
inherited |
Return the timestep.
|
inherited |
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.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::Mapping.
|
inlinevirtualinherited |
Reimplemented in PLMD::ActionAtomistic, PLMD::analysis::Analysis, PLMD::ActionWithArguments, and PLMD::mapping::Mapping.
|
staticinherited |
Insist that numerical derivatives should always be used for an action and make this fact appear in the manual.
|
inherited |
Check if the action is active on this step.
|
inherited |
Parse one keyword as generic type.
|
inherited |
Parse a 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::function::FuncPathMSD, PLMD::analysis::Analysis, PLMD::multicolvar::MultiColvarBase, PLMD::multicolvar::ActionVolume, PLMD::mapping::Mapping, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::Read, PLMD::generic::Print, 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 |
|
inherited |
Setup the dependencies.
|
inlineprotected |
|
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.
|
inherited |
Calculate the gradients and store them for all the values (need for projections)
|
inherited |
Set your default value to have no periodicity.
|
virtualinherited |
|
inlineprotected |
|
inherited |
Set the value to be periodic with a particular domain.
|
inlineprotectedinherited |
Set the default value (the one without name)
|
inherited |
Set the value.
|
virtual |
Activate the calculation of derivatives.
Reimplemented from PLMD::ActionWithValue.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::Mapping.
|
inlinevirtualinherited |
Reimplemented in PLMD::ActionAtomistic, PLMD::analysis::Analysis, PLMD::ActionWithArguments, and PLMD::mapping::Mapping.
|
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::multicolvar::DumpMultiColvar, PLMD::generic::Print, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, and PLMD::generic::DumpProjections.
|
staticinherited |
The components in the action will depend on the user.
|
inlineinherited |
This forces the class to use numerical derivatives.
|
inherited |
Issue a warning.
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Reference to the log stream.
|
inherited |
|
private |
|
inherited |
Reference to main plumed object.
Hosted by GitHub | 1.8.7 |