#include <Mapping.h>
Public Types | |
typedef std::vector< Action * > | Dependencies |
typedef std::set< FILE * >::iterator | files_iterator |
Public Member Functions | |
Mapping (const ActionOptions &) | |
~Mapping () | |
void | turnOnDerivatives () |
Overload the virtual functions that appear in both ActionAtomistic and ActionWithArguments. More... | |
void | calculateNumericalDerivatives (ActionWithValue *a=NULL) |
N.B. More... | |
void | lockRequests () |
void | unlockRequests () |
bool | isPeriodic () |
Distance from a point is never periodic. More... | |
unsigned | getNumberOfDerivatives () |
Get the number of derivatives for this action. More... | |
virtual double | getLambda () |
Get the value of lambda for paths and property maps. More... | |
virtual double | transformHD (const double &dist, double &df) const =0 |
This does the transformation of the distance by whatever function is required. More... | |
unsigned | getNumberOfProperties () const |
Get the number of properties we are projecting onto. More... | |
std::string | getPropertyName (const unsigned &iprop) const |
Get the name of the ith property we are projecting. More... | |
unsigned | getPropertyIndex (const std::string &name) const |
Get the index of a particular named property. More... | |
std::string | getArgumentName (unsigned &iarg) |
Get the name of the ith argument. More... | |
double | getPropertyValue (const unsigned ¤t, const unsigned &iprop) const |
Get the value of the ith property for the current frame. More... | |
void | prepare () |
Stuff to do before we do the calculation. More... | |
void | apply () |
Apply the forces. More... | |
void | requestAtoms (const std::vector< AtomNumber > &a) |
Request an array of atoms. More... | |
const Vector & | getPosition (int) const |
Get position of i-th atom (access by relative index) More... | |
const Vector & | getPosition (AtomNumber) const |
Get position of i-th atom (access by absolute AtomNumber). More... | |
Vector & | modifyPosition (AtomNumber) |
Get modifiable position of i-th atom (access by absolute AtomNumber). More... | |
unsigned | getTotAtoms () const |
Get total number of atoms, including virtual ones. More... | |
Vector & | modifyGlobalForce (AtomNumber) |
Get modifiable force of i-th atom (access by absolute AtomNumber). More... | |
Tensor & | modifyGlobalVirial () |
Get modifiable virial Should be used by action that need to modify the stored virial. More... | |
const Tensor & | getBox () const |
Get box shape. More... | |
const std::vector< Vector > & | getPositions () const |
Get the array of all positions. More... | |
const double & | getEnergy () const |
Get energy. More... | |
double | getMass (int i) const |
Get mass of i-th atom. More... | |
double | getCharge (int i) const |
Get charge of i-th atom. More... | |
std::vector< Vector > & | modifyForces () |
Get a reference to forces array. More... | |
Tensor & | modifyVirial () |
Get a reference to virial array. More... | |
double & | modifyForceOnEnergy () |
Get a reference to force on energy. More... | |
unsigned | getNumberOfAtoms () const |
Get number of available atoms. More... | |
Vector | pbcDistance (const Vector &, const Vector &) const |
Compute the pbc distance between two positions. More... | |
void | pbcApply (std::vector< Vector > &dlist, unsigned max_index=0) const |
Applies PBCs to a seriens of positions or distances. More... | |
const std::vector< AtomNumber > & | getAbsoluteIndexes () const |
Get the vector of absolute indexes. More... | |
AtomNumber | getAbsoluteIndex (int i) const |
Get the absolute index of an atom. More... | |
void | parseAtomList (const std::string &key, std::vector< AtomNumber > &t) |
Parse a list of atoms without a numbered keyword. More... | |
void | parseAtomList (const std::string &key, const int num, std::vector< AtomNumber > &t) |
Parse an list of atom with a numbred keyword. More... | |
void | changeBox (const Tensor &newbox) |
Change the box shape. More... | |
const Pbc & | getPbc () const |
Get reference to Pbc. More... | |
void | setForcesOnAtoms (const std::vector< double > &forcesToApply, unsigned ind=0) |
Add the forces to the atoms. More... | |
void | doNotRetrieve () |
Skip atom retrieval - use with care. More... | |
void | doNotForce () |
Skip atom forces - use with care. More... | |
void | makeWhole () |
Make atoms whole, assuming they are in the proper order. More... | |
void | allowToAccessGlobalForces () |
Allow calls to modifyGlobalForce() More... | |
void | clearOutputForces () |
void | calculateAtomicNumericalDerivatives (ActionWithValue *a, const unsigned &startnum) |
Numerical derivative routine to use when using Actions that inherit from BOTH ActionWithArguments and ActionAtomistic. More... | |
void | retrieveAtoms () |
void | applyForces () |
const std::set< AtomNumber > & | getUnique () const |
void | readAtomsFromPDB (const PDB &pdb) |
Read in an input file containing atom positions and calculate the action for the atomic configuration therin. 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... | |
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 | 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... | |
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... | |
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... | |
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... | |
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 () |
void | unlockContributors () |
void | lockContributors () |
virtual void | finishTaskListUpdate () |
virtual void | deactivate_task (const unsigned &task_index) |
Activate the jth colvar Deactivate the current task in future loops. More... | |
bool | derivativesAreRequired () const |
Are derivatives required for this quantity. More... | |
virtual void | finishComputations (const std::vector< double > &buffer) |
Finish running all the calculations. More... | |
virtual void | retrieveDomain (std::string &min, std::string &max) |
What are the domains of the base quantities. More... | |
virtual unsigned | getNumberOfQuantities () |
Get the number of quantities that are calculated during each task. More... | |
void | activateTheseTasks (std::vector< unsigned > &addtionalTasks) |
Get the list of indices that have derivatives. More... | |
virtual void | doJobsRequiredBeforeTaskList () |
Do any jobs that are required before the task list is undertaken. More... | |
unsigned | getFullNumberOfTasks () const |
Get the full size of the taskList dynamic list. More... | |
unsigned | getPositionInFullTaskList (const unsigned &ii) const |
Get the position of the ith active task in the full list. More... | |
unsigned | getTaskCode (const unsigned &ii) const |
Get the code for the ii th task in the list. More... | |
virtual void | performTask (const unsigned &, const unsigned &, MultiValue &) const =0 |
Calculate one of the functions in the distribution. More... | |
virtual void | transformBridgedDerivatives (const unsigned ¤t, MultiValue &invals, MultiValue &outvals) const |
Do the task if we have a bridge. More... | |
StoreDataVessel * | buildDataStashes (const bool &allow_wcutoff, const double &wtol) |
Ensure that data required in other vessels is stored. More... | |
virtual void | applyBridgeForces (const std::vector< double > &bb) |
Apply forces from bridge vessel - this is rarely used - currently only in ActionVolume. More... | |
Vessel * | getVesselWithName (const std::string &mynam) |
These are overwritten in MultiColvarFunction. More... | |
bool | weightWithDerivatives () const |
Does the weight have derivatives. 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 | |
unsigned | getNumberOfReferencePoints () const |
Get the number of frames in the path. More... | |
void | finishPackSetup (const unsigned &ifunc, ReferenceValuePack &mypack) const |
Finish the setup of the referenceValuePack by transfering atoms and args. More... | |
double | calculateDistanceFunction (const unsigned &ifunc, ReferenceValuePack &myder, const bool &squared) const |
Calculate the value of the distance from the ith frame. More... | |
void | storeDistanceFunction (const unsigned &ifunc) |
Store the distance function. More... | |
double | getWeight (const unsigned &weight) const |
Get the value of the weight. More... | |
ReferenceConfiguration * | getReferenceConfiguration (const unsigned &ifunc) |
Return a pointer to one of the reference configurations. More... | |
void | expandArgKeywordInPDB (PDB &pdb) |
This changes the arg keyword in the pdb file. More... | |
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 | addVessel (const std::string &name, const std::string &input, const int numlab=0) |
Add a vessel to the list of vessels. More... | |
void | addVessel (Vessel *vv) |
BridgeVessel * | addBridgingVessel (ActionWithVessel *tome) |
Add a bridging vessel to the list of vessels. More... | |
void | readVesselKeywords () |
Complete the setup of this object (this routine must be called after construction of ActionWithValue) More... | |
void | needsDerivatives () |
Turn on the derivatives in the vessel. More... | |
double | getTolerance () const |
Return the value of the tolerance. More... | |
double | getNLTolerance () const |
Return the value for the neighbor list tolerance. More... | |
unsigned | getNumberOfVessels () const |
Get the number of vessels. More... | |
Vessel * | getPntrToVessel (const unsigned &i) |
Get a pointer to the ith vessel. More... | |
void | runAllTasks () |
Calculate the values of all the vessels. More... | |
void | resizeFunctions () |
Resize all the functions when the number of derivatives change. More... | |
bool | calculateAllVessels (const unsigned &taskCode, MultiValue &myvals, MultiValue &bvals, std::vector< double > &buffer, std::vector< unsigned > &der_list) |
This loops over all the vessels calculating them and also sets all the element derivatives equal to zero. More... | |
bool | getForcesFromVessels (std::vector< double > &forcesToApply) |
Retrieve the forces from all the vessels (used in apply) More... | |
bool | serialCalculation () const |
Is the calculation being done in serial. More... | |
bool | usingLowMem () const |
Are we using low memory. More... | |
void | setLowMemOption (const bool &) |
Set that we are using low memory. More... | |
unsigned | getCurrentNumberOfActiveTasks () const |
Get the number of tasks that are currently active. More... | |
unsigned | getActiveTask (const unsigned &ii) const |
Get the ith of the currently active tasks. More... | |
void | deactivateAllTasks () |
Deactivate all the tasks in the task list. More... | |
void | deactivateTasksInRange (const unsigned &lower, const unsigned &upper) |
Deactivate all tasks with i in lower \(\le\) i < upper. More... | |
unsigned | getSizeOfBuffer (unsigned &bufsize) |
Get the size of the buffer. More... | |
void | addTaskToList (const unsigned &taskCode) |
Add a task to the full list. More... | |
Protected Attributes | |
std::vector< double > | fframes |
The (transformed) distance from each frame. More... | |
Atoms & | atoms |
bool | contributorsAreUnlocked |
The terms in the series are locked. More... | |
bool | weightHasDerivatives |
Does the weight have derivatives. More... | |
unsigned | bridgeVariable |
This is used for numerical derivatives of bridge variables. More... | |
Private Attributes | |
std::vector< double > | dfframes |
PointWiseMapping * | mymap |
This holds all the reference information. More... | |
std::vector< double > | forcesToApply |
The forces on each of the derivatives (used in apply) More... | |
|
inherited |
|
inherited |
|
explicit |
PLMD::mapping::Mapping::~Mapping | ( | ) |
|
virtualinherited |
Set action to active.
|
inherited |
Get the list of indices that have derivatives.
Switch on additional tasks
|
protectedinherited |
Add a bridging vessel to the list of vessels.
|
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)
|
protectedinherited |
Add a task to the full list.
|
inherited |
Add a value with the name label.
|
inherited |
Add a value with the name label that has derivatives.
|
protectedinherited |
Add a vessel to the list of vessels.
|
protectedinherited |
|
inlineinherited |
Allow calls to modifyGlobalForce()
|
virtual |
Apply the forces.
Implements PLMD::Action.
|
inlinevirtualinherited |
Apply forces from bridge vessel - this is rarely used - currently only in ActionVolume.
Reimplemented in PLMD::multicolvar::BridgedMultiColvarFunction, and PLMD::manyrestraints::ManyRestraintsBase.
|
inherited |
|
inlineinherited |
Takes one value and brings it back into the pbc of argument i.
|
inherited |
Ensure that data required in other vessels is stored.
|
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::bias::PBMetaD, PLMD::function::FuncSumHills, PLMD::mapping::PCAVars, PLMD::function::Matheval, PLMD::generic::WrapAround, PLMD::function::FuncPathMSD, PLMD::analysis::Analysis, PLMD::RDC, PLMD::bias::ExtendedLagrangian, PLMD::generic::Group, PLMD::colvar::Distance, PLMD::generic::DumpAtoms, PLMD::bias::MovingRestraint, PLMD::generic::EffectiveEnergyDrift, PLMD::generic::WholeMolecules, PLMD::bias::External, PLMD::generic::DumpMassCharge, PLMD::generic::FitToTemplate, PLMD::colvar::Gyration, PLMD::bias::ABMD, PLMD::colvar::Angle, PLMD::colvar::ContactMap, PLMD::colvar::DRMSD, PLMD::function::Combine, PLMD::bias::BiasValue, PLMD::colvar::NOE, PLMD::IMD, PLMD::vatom::Center, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::Read, PLMD::generic::RandomExchanges, PLMD::multicolvar::MultiColvarFunction, PLMD::function::Piecewise, PLMD::colvar::PathMSDBase, PLMD::colvar::Position, PLMD::multicolvar::DumpMultiColvar, PLMD::colvar::Torsion, PLMD::multicolvar::MultiColvarDensity, PLMD::bias::LWalls, PLMD::bias::UWalls, PLMD::vatom::COM, PLMD::generic::Include, PLMD::generic::Print, PLMD::bias::Restraint, PLMD::analysis::Committor, PLMD::generic::Flush, PLMD::colvar::Energy, PLMD::multicolvar::MultiColvar, PLMD::function::Sort, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::generic::DumpDerivatives, PLMD::colvar::Constant, PLMD::generic::DumpForces, PLMD::function::Ensemble, PLMD::generic::Debug, PLMD::colvar::Dipole, PLMD::colvar::Puckering, PLMD::manyrestraints::ManyRestraintsBase, PLMD::vatom::Ghost, PLMD::colvar::Cell, PLMD::colvar::ColvarFake, PLMD::colvar::Volume, PLMD::function::Target, PLMD::colvar::Template, PLMD::generic::Time, PLMD::generic::DumpProjections, PLMD::colvar::MultiRMSD, PLMD::colvar::RMSD, PLMD::colvar::PCARMSD, PLMD::colvar::CoordinationBase, PLMD::ActionSetup, and PLMD::mapping::PathBase.
|
protectedinherited |
This loops over all the vessels calculating them and also sets all the element derivatives equal to zero.
|
inherited |
Numerical derivative routine to use when using Actions that inherit from BOTH ActionWithArguments and ActionAtomistic.
|
protected |
Calculate the value of the distance from the ith frame.
|
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 |
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::ActionAtomistic.
|
inherited |
Change the box shape.
|
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 |
Check if action should be updated.
|
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::BridgedMultiColvarFunction, and PLMD::manyrestraints::ManyRestraintsBase.
|
inherited |
Clear the forces on the values.
|
virtualinherited |
|
inherited |
|
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.
|
virtualinherited |
Activate the jth colvar Deactivate the current task in future loops.
Reimplemented in PLMD::multicolvar::BridgedMultiColvarFunction, and PLMD::manyrestraints::ManyRestraintsBase.
|
protectedinherited |
Deactivate all the tasks in the task list.
|
protectedinherited |
Deactivate all tasks with i in lower \(\le\) i < upper.
|
inlineinherited |
Are derivatives required for this quantity.
|
inlineinherited |
Takes the difference taking into account pbc for arg i.
|
virtualinherited |
Do any jobs that are required before the task list is undertaken.
Reimplemented in PLMD::multicolvar::AdjacencyMatrixAction, PLMD::manyrestraints::ManyRestraintsBase, PLMD::multicolvar::VolumeGradientBase, and PLMD::multicolvar::MultiColvarFilter.
|
inlineinherited |
Are we not calculating derivatives.
|
inlineinherited |
Skip atom forces - use with care.
If this function is called during initialization, then forces are not going to be propagated. Can be used for optimization.
|
inlineinherited |
Skip atom retrieval - use with care.
If this function is called during initialization, then atoms are not going to be retrieved. Can be used for optimization. Notice that calling getPosition(int) in an Action where DoNotRetrieve() was called might lead to undefined behavior.
|
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.
|
virtualinherited |
Finish running all the calculations.
|
protected |
Finish the setup of the referenceValuePack by transfering atoms and args.
|
inlinevirtualinherited |
Reimplemented in PLMD::secondarystructure::SecondaryStructureRMSD.
|
inherited |
Opens a file.
This is similar to plain fopen, but with some extra functionality.
|
inlineinherited |
Get the absolute index of an atom.
|
inlineinherited |
Get the vector of absolute indexes.
|
inlineprotectedinherited |
Get the ith of the currently active tasks.
|
inlineinherited |
Returns the value of an argument.
std::string PLMD::mapping::Mapping::getArgumentName | ( | unsigned & | iarg | ) |
Get the name of the ith argument.
|
inlineinherited |
Returns an array of pointers to the arguments.
|
inlineinherited |
Get box shape.
|
inlineinherited |
Get charge of i-th atom.
|
inherited |
get a string that contains all the available components
|
inherited |
get a vector that contains the label for all the components
|
inlineprotectedinherited |
Get the number of tasks that are currently active.
|
inlineinherited |
Return dependencies.
|
virtualinherited |
|
inlineinherited |
Get energy.
|
inherited |
Check if we are on an exchange step.
|
protectedinherited |
Retrieve the forces from all the vessels (used in apply)
|
inlineinherited |
Get the full size of the taskList dynamic list.
|
inlineinherited |
Returns the label.
|
virtual |
Get the value of lambda for paths and property maps.
Reimplemented in PLMD::mapping::PathBase.
|
inlineinherited |
Get mass of i-th atom.
|
inlineinherited |
Returns the name.
|
inlineprotectedinherited |
Return the value for the neighbor list tolerance.
|
inlineinherited |
Returns the number of arguments.
|
inlineinherited |
Get number of available atoms.
|
inlineinherited |
Returns the number of values defined.
|
inlinevirtual |
Get the number of derivatives for this action.
Implements PLMD::ActionWithValue.
|
inline |
Get the number of properties we are projecting onto.
|
inlinevirtualinherited |
Get the number of quantities that are calculated during each task.
Reimplemented in PLMD::multicolvar::LocalAverage, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::crystallization::VectorMultiColvar, PLMD::crystallization::DFSClustering, PLMD::multicolvar::ActionVolume, PLMD::crystallisation::Gradient, and PLMD::multicolvar::MultiColvarFilter.
|
inlineprotected |
Get the number of frames in the path.
|
inlineprotectedinherited |
Get the number of vessels.
|
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.
|
inlineprotectedinherited |
Get a pointer to the ith vessel.
|
inlineinherited |
Get position of i-th atom (access by relative index)
|
inlineinherited |
Get position of i-th atom (access by absolute AtomNumber).
With direct access to the global atom array
|
inlineinherited |
Get the position of the ith active task in the full list.
|
inlineinherited |
Get the array of all positions.
|
inherited |
Get the scalar product between the gradients of two variables.
unsigned PLMD::mapping::Mapping::getPropertyIndex | ( | const std::string & | name | ) | const |
Get the index of a particular named property.
|
inline |
Get the name of the ith property we are projecting.
|
inline |
Get the value of the ith property for the current frame.
|
protected |
Return a pointer to one of the reference configurations.
|
inlineinherited |
Return true if we are doing a restart.
|
protectedinherited |
Get the size of the buffer.
|
inherited |
Return the present timestep.
|
inlineinherited |
Get the code for the ii th task in the list.
|
inherited |
Return the present time.
|
inherited |
Return the timestep.
|
inlineprotectedinherited |
Return the value of the tolerance.
|
inlineinherited |
Get total number of atoms, including virtual ones.
Can be used to make a loop on modifyPosition or getPosition(AtomNumber)
|
inlineinherited |
|
inherited |
These are overwritten in MultiColvarFunction.
Return a particular named vessel
|
inlineprotected |
Get the value of the weight.
|
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.
|
inlinevirtual |
Distance from a point is never periodic.
Implements PLMD::vesselbase::ActionWithVessel.
|
inherited |
|
inlinevirtual |
Reimplemented from PLMD::ActionAtomistic.
|
inherited |
Make atoms whole, assuming they are in the proper order.
|
inlineinherited |
Get a reference to force on energy.
|
inlineinherited |
Get a reference to forces array.
|
inlineinherited |
Get modifiable force of i-th atom (access by absolute AtomNumber).
|
inlineinherited |
Get modifiable virial Should be used by action that need to modify the stored virial.
|
inlineinherited |
Get modifiable position of i-th atom (access by absolute AtomNumber).
Should be used by action that need to modify the stored atomic coordinates
|
inlineinherited |
Get a reference to virial array.
|
protectedinherited |
Turn on the derivatives in the vessel.
|
staticinherited |
Insist that numerical derivatives should always be used for an action and make this fact appear in the manual.
|
inherited |
Parse one keyword as generic type.
|
inherited |
Parse a list of arguments.
|
inherited |
Parse a list of atoms without a numbered keyword.
|
inherited |
Parse an list of atom with a numbred keyword.
|
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.
|
inherited |
Applies PBCs to a seriens of positions or distances.
Compute the pbc distance between two positions.
|
pure virtualinherited |
Calculate one of the functions in the distribution.
Implemented in PLMD::analysis::Histogram, PLMD::multicolvar::MultiColvarBase, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::manyrestraints::ManyRestraintsBase, PLMD::analysis::AnalysisWithLandmarks, and PLMD::mapping::PathBase.
|
virtual |
Stuff to do before we do the calculation.
Reimplemented from PLMD::Action.
|
virtualinherited |
Read in an input file containing atom positions and calculate the action for the atomic configuration therin.
Reimplemented from PLMD::Action.
|
protectedinherited |
Complete the setup of this object (this routine must be called after construction of ActionWithValue)
|
static |
|
inherited |
Setup the dependencies.
|
inherited |
Request an array of atoms.
This method is used to ask for a list of atoms. Atoms should be asked for by number. If this routine is called during the simulation, atoms will be available at the next step MAYBE WE HAVE TO FIND SOMETHING MORE CLEAR FOR DYNAMIC LISTS OF ATOMS
|
protectedinherited |
Resize all the functions when the number of derivatives change.
|
inherited |
|
virtualinherited |
What are the domains of the base quantities.
Reimplemented in PLMD::multicolvar::Torsions.
|
protectedinherited |
Calculate the values of all the vessels.
|
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.
|
inlineprotectedinherited |
Is the calculation being done in serial.
|
inherited |
Add the forces to the atoms.
|
inherited |
Calculate the gradients and store them for all the values (need for projections)
|
inlineprotectedinherited |
Set that we are using low memory.
|
inherited |
Set your default value to have no periodicity.
|
virtualinherited |
|
inherited |
Set the value to be periodic with a particular domain.
|
inlineprotectedinherited |
Set the default value (the one without name)
|
inherited |
Set the value.
|
inlineprotected |
Store the distance function.
|
virtualinherited |
Do the task if we have a bridge.
Reimplemented in PLMD::multicolvar::BridgedMultiColvarFunction, and PLMD::manyrestraints::ManyRestraintsBase.
|
pure virtual |
This does the transformation of the distance by whatever function is required.
Implemented in PLMD::mapping::PathBase.
|
virtual |
Overload the virtual functions that appear in both ActionAtomistic and ActionWithArguments.
Reimplemented from PLMD::ActionWithValue.
|
inherited |
|
inlinevirtual |
Reimplemented from PLMD::ActionAtomistic.
|
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::analysis::Analysis, PLMD::bias::ExtendedLagrangian, PLMD::multicolvar::VolumeCavity, PLMD::generic::DumpAtoms, PLMD::generic::EffectiveEnergyDrift, PLMD::generic::DumpMassCharge, PLMD::generic::Read, PLMD::multicolvar::DumpMultiColvar, PLMD::multicolvar::MultiColvarDensity, PLMD::generic::Print, PLMD::generic::Flush, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::multicolvar::VolumeTetrapore, and PLMD::generic::DumpProjections.
|
staticinherited |
The components in the action will depend on the user.
|
inlineinherited |
This forces the class to use numerical derivatives.
|
inlineprotectedinherited |
Are we using low memory.
|
inherited |
Issue a warning.
|
inlineinherited |
Does the weight have derivatives.
|
protectedinherited |
|
protectedinherited |
This is used for numerical derivatives of bridge variables.
|
inherited |
|
protectedinherited |
The terms in the series are locked.
|
private |
|
protected |
The (transformed) distance from each frame.
|
inherited |
|
private |
The forces on each of the derivatives (used in apply)
|
inherited |
|
inherited |
Reference to the log stream.
|
inherited |
|
private |
This holds all the reference information.
|
inherited |
Reference to main plumed object.
|
protectedinherited |
Does the weight have derivatives.
Hosted by GitHub | 1.8.10 |