Provides the keyword LOWER_WALLS More...
Public Types | |
typedef std::set< Action * > | Dependencies |
typedef std::set< FILE * > ::iterator | files_iterator |
Public Member Functions | |
LWalls (const ActionOptions &) | |
void | calculate () |
Calculate an Action. More... | |
void | apply () |
Apply an Action. 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 () |
void | lockRequests () |
virtual void | unlockRequests () |
void | unlockRequests () |
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... | |
bool | checkNumericalDerivatives () const |
Check if numerical derivatives should be used. 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... | |
virtual void | calculateNumericalDerivatives (ActionWithValue *a=NULL) |
Calculate the 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... | |
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... | |
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) |
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... | |
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 &keys) |
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 > | at |
std::vector< double > | kappa |
std::vector< double > | exp |
std::vector< double > | eps |
std::vector< double > | offset |
Provides the keyword LOWER_WALLS
Definition at line 67 of file LWalls.cpp.
|
inherited |
|
inherited |
PLMD::bias::LWalls::LWalls | ( | const ActionOptions & | ao | ) |
Definition at line 94 of file LWalls.cpp.
|
virtualinherited |
Set action to active.
Definition at line 127 of file Action.cpp.
|
inherited |
Add a value with a name like label.name.
Definition at line 128 of file ActionWithValue.cpp.
|
inherited |
Add a value with a name like label.name that has derivatives.
Definition at line 144 of file ActionWithValue.cpp.
|
inherited |
Specify that this Action depends on another one.
Definition at line 123 of file Action.cpp.
|
inherited |
Add forces to arguments (used in apply)
Definition at line 276 of file ActionWithArguments.cpp.
|
inherited |
Add a value with the name label.
Definition at line 97 of file ActionWithValue.cpp.
|
inherited |
Add a value with the name label that has derivatives.
Definition at line 102 of file ActionWithValue.cpp.
|
virtualinherited |
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.
Definition at line 108 of file ActionWithArguments.h.
|
virtual |
Calculate an Action.
This method is called one or more times per step. The set of all Actions is calculated in forward order.
Implements PLMD::Action.
Definition at line 130 of file LWalls.cpp.
|
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.
|
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.
|
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.
|
inlinevirtualinherited |
Reimplemented in PLMD::colvar::ContactMap.
Definition at line 162 of file ActionWithValue.h.
|
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.
Definition at line 200 of file ActionWithValue.h.
|
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
Definition at line 161 of file Action.cpp.
|
inherited |
Cite a paper see PlumedMain::cite.
Definition at line 221 of file Action.cpp.
|
inherited |
Clear the dependence list for this Action.
Definition at line 153 of file Action.cpp.
|
virtualinherited |
Clear the derivatives of values wrt parameters.
Reimplemented in PLMD::multicolvar::ActionVolume.
Definition at line 69 of file ActionWithValue.cpp.
|
inherited |
Clear the forces on the values.
Definition at line 66 of file ActionWithValue.cpp.
|
virtualinherited |
Definition at line 147 of file Action.cpp.
|
inherited |
Set your value component to have no periodicity.
Definition at line 188 of file ActionWithValue.cpp.
|
inherited |
Set the value to be periodic with a particular domain.
Definition at line 200 of file ActionWithValue.cpp.
|
staticinherited |
Puts a message into the manual that the components always output.
Definition at line 42 of file ActionWithValue.cpp.
|
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.
|
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.
|
inlinevirtualinherited |
|
inlineinherited |
Takes the difference taking into account pbc for arg i.
Definition at line 103 of file ActionWithArguments.h.
|
inherited |
Crash calculation and print documentation.
Definition at line 195 of file Action.cpp.
|
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.
|
inherited |
Exit with error code c.
Definition at line 183 of file Action.cpp.
|
protectedinherited |
This changes the arg keyword in the pdb file.
Definition at line 193 of file ActionWithArguments.cpp.
|
inherited |
Closes a file opened with Action::fclose().
Definition at line 93 of file Action.cpp.
|
inherited |
Tell to the Action to flush open files.
Definition at line 98 of file Action.cpp.
|
inherited |
Opens a file.
This is similar to plain fopen, but with some extra functionality.
Definition at line 83 of file Action.cpp.
|
inlineinherited |
Returns the value of an argument.
Definition at line 93 of file ActionWithArguments.h.
|
inlineinherited |
Returns an array of pointers to the arguments.
Definition at line 123 of file ActionWithArguments.h.
|
inherited |
get a string that contains all the available components
Definition at line 170 of file ActionWithValue.cpp.
|
inherited |
get a vector that contains the label for all the components
Definition at line 179 of file ActionWithValue.cpp.
|
inlineinherited |
|
virtualinherited |
Definition at line 157 of file Action.cpp.
|
inherited |
Check if we are on an exchange step.
Definition at line 217 of file Action.cpp.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Returns the number of arguments.
Definition at line 98 of file ActionWithArguments.h.
|
inlineinherited |
Returns the number of values defined.
Definition at line 190 of file ActionWithValue.h.
|
inlinevirtualinherited |
Reimplemented in PLMD::multicolvar::MultiColvarBase, PLMD::multicolvar::ActionVolume, PLMD::secondarystructure::SecondaryStructureRMSD, and PLMD::manyrestraints::ManyRestraintsBase.
Definition at line 205 of file ActionWithValue.h.
|
inlineinherited |
Get the value of one of the components of the PLMD::Action.
Definition at line 168 of file ActionWithValue.h.
|
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.
|
inlineinherited |
Return a pointer to specific argument.
Definition at line 88 of file ActionWithArguments.h.
|
protectedinherited |
Return a pointer to the component by index.
Definition at line 210 of file ActionWithValue.cpp.
|
protectedinherited |
Return a pointer to the value by name.
Definition at line 205 of file ActionWithValue.cpp.
|
protectedinherited |
Get a pointer to the default value.
Definition at line 120 of file ActionWithValue.cpp.
|
inherited |
Get the scalar product between the gradients of two variables.
Definition at line 268 of file ActionWithArguments.cpp.
|
inherited |
Return the present timestep.
Definition at line 169 of file Action.cpp.
|
protectedinherited |
Definition at line 42 of file ActionPilot.cpp.
|
inherited |
Return the present time.
Definition at line 173 of file Action.cpp.
|
inherited |
Return the timestep.
Definition at line 177 of file Action.cpp.
|
inherited |
Convert a list of argument names into a list of pointers to the values.
Definition at line 44 of file ActionWithArguments.cpp.
|
inlineinherited |
|
inlineinherited |
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Definition at line 113 of file ActionWithArguments.h.
|
inlinevirtualinherited |
Reimplemented in PLMD::ActionAtomistic, and PLMD::ActionWithArguments.
|
virtualinherited |
Definition at line 215 of file ActionWithValue.cpp.
|
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.
|
inherited |
Check if the action is active on this step.
Definition at line 38 of file ActionPilot.cpp.
|
inherited |
|
inherited |
Parse a list of arguments.
Definition at line 40 of file ActionWithArguments.cpp.
|
inherited |
Parse one keyword as boolean flag.
Definition at line 104 of file Action.cpp.
|
inherited |
|
inherited |
|
inherited |
|
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.
|
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 |
Definition at line 81 of file LWalls.cpp.
|
inherited |
Setup the dependencies.
Definition at line 206 of file ActionWithArguments.cpp.
|
inlineprotectedinherited |
|
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)
Definition at line 194 of file ActionWithValue.cpp.
|
inherited |
Set your default value to have no periodicity.
Definition at line 107 of file ActionWithValue.cpp.
|
virtualinherited |
Definition at line 141 of file Action.cpp.
|
inlineprotectedinherited |
|
inherited |
Set the value to be periodic with a particular domain.
Definition at line 114 of file ActionWithValue.cpp.
|
inlineprotectedinherited |
Set the default value (the one without name)
Definition at line 183 of file ActionWithValue.h.
|
inherited |
Set the value.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Definition at line 118 of file ActionWithArguments.h.
|
inlinevirtualinherited |
Reimplemented in PLMD::ActionAtomistic, and PLMD::ActionWithArguments.
|
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.
|
staticinherited |
The components in the action will depend on the user.
Definition at line 48 of file ActionWithValue.cpp.
|
inlineinherited |
This forces the class to use numerical derivatives.
Definition at line 195 of file ActionWithValue.h.
|
inherited |
Issue a warning.
Definition at line 201 of file Action.cpp.
|
private |
Definition at line 68 of file LWalls.cpp.
|
inherited |
|
private |
Definition at line 71 of file LWalls.cpp.
|
private |
Definition at line 70 of file LWalls.cpp.
|
private |
Definition at line 69 of file LWalls.cpp.
|
inherited |
|
inherited |
|
private |
Definition at line 72 of file LWalls.cpp.
|
inherited |
Hosted by GitHub
![]() |
![]() |