This is the abstract base class to use for implementing a new way of definining a particular region of the simulation box.
More...
#include <ActionVolume.h>
Public Types | |
typedef std::vector< Action * > | Dependencies |
typedef std::set< FILE * >::iterator | files_iterator |
Public Member Functions | |
ActionVolume (const ActionOptions &) | |
virtual unsigned | getNumberOfQuantities () const |
Get the number of quantities that are calculated each time. More... | |
void | calculateAllVolumes (const unsigned &curr, MultiValue &outvals) const |
Calculate whats in the volume. More... | |
bool | inVolumeOfInterest (const unsigned &curr) const |
This calculates whether or not a particular is inside the box of interest this is used for neighbour list with volumes. More... | |
virtual double | calculateNumberInside (const Vector &cpos, Vector &derivatives, Tensor &vir, std::vector< Vector > &refders) const =0 |
unsigned | getCentralAtomElementIndex () |
const Vector & | getPosition (AtomNumber) const |
Get position of i-th atom (access by absolute AtomNumber). More... | |
void | doJobsRequiredBeforeTaskList () |
Do jobs required before tasks are undertaken. More... | |
void | completeTask (const unsigned &curr, MultiValue &invals, MultiValue &outvals) const |
Actually do what we are asked. More... | |
virtual void | setupRegions ()=0 |
Setup the regions that this is based on. More... | |
void | addBridgeForces (const std::vector< double > &bb) |
Forces here are applied through the bridge. More... | |
MultiColvarBase * | getPntrToMultiColvar () const |
Get a pointer to the base multicolvar. More... | |
void | clearDerivatives () |
Don't actually clear the derivatives when this is called from plumed main. More... | |
virtual void | turnOnDerivatives () |
Check nothing impossible being done with derivatives. More... | |
unsigned | getNumberOfDerivatives () |
Get the number of derivatives for this action. More... | |
unsigned | getSizeOfAtomsWithDerivatives () |
Get the size of the atoms with derivatives array. More... | |
bool | isPeriodic () |
Is the output quantity periodic. More... | |
void | deactivate_task (const unsigned &taskno) |
Routines that have to be defined so as not to have problems with virtual methods. More... | |
void | calculate () |
Do the calculation. More... | |
void | transformBridgedDerivatives (const unsigned ¤t, MultiValue &invals, MultiValue &outvals) const |
This does the task. More... | |
void | performTask (const unsigned &, const unsigned &, MultiValue &) const |
Perform one of the tasks. More... | |
Vector | retrieveCentralAtomPos () |
Get the central atom position. More... | |
AtomNumber | getAbsoluteIndexOfCentralAtom (const unsigned &i) const |
Get the index of the central atom. More... | |
const std::vector< AtomNumber > & | getAbsoluteIndexes () const |
Get indicecs involved in this colvar. More... | |
void | calculateNumericalDerivatives (ActionWithValue *a=NULL) |
We need our own calculate numerical derivatives here. More... | |
void | apply () |
Apply the forces from this action. More... | |
bool | isCurrentlyActive (const unsigned &) |
Is this atom currently being copied. More... | |
Vector | calculateCentralAtomPosition () |
This should not be called. More... | |
double | compute (const unsigned &tindex, AtomValuePack &myvals) const |
This is replaced once we have a function to calculate the cv. More... | |
Vector | getPositionOfAtomForLinkCells (const unsigned &iatom) const |
This gets the position of an atom for the link cell setup. More... | |
void | getIndexList (const unsigned &ntotal, const unsigned &jstore, const unsigned &maxder, std::vector< unsigned > &indices) |
void | applyBridgeForces (const std::vector< double > &bb) |
Apply forces from bridge vessel - this is rarely used - currently only in ActionVolume. More... | |
Vector | getCentralAtomPos (const unsigned &curr) |
Get the index where the central atom is stored. More... | |
CatomPack | getCentralAtomPack (const unsigned &basn, const unsigned &curr) |
bool | usesPbc () const |
Do we use pbc to calculate this quantity. More... | |
void | applyPbc (std::vector< Vector > &dlist, unsigned max_index=0) const |
Apply PBCs over a set of distance vectors. More... | |
bool | threadSafe () const |
Is it safe to use multithreading. More... | |
void | prepare () |
Do some setup before the calculation. More... | |
void | retrieveAtoms () |
This is overwritten here in order to make sure that we do not retrieve atoms multiple times. More... | |
virtual void | updateActiveAtoms (AtomValuePack &myatoms) const |
Update the active atoms. More... | |
virtual Vector | getLinkCellPosition (const std::vector< unsigned > &atoms) const |
Returns the position where we should assume the center is for link cell calculations. More... | |
virtual double | doCalculation (const unsigned &tindex, AtomValuePack &myatoms) const |
And a virtual function which actually computes the colvar. More... | |
virtual double | calculateWeight (const unsigned &taskCode, const double &weight, AtomValuePack &myatoms) const |
You can use this to screen contributions that are very small so we can avoid expensive (and pointless) calculations. More... | |
virtual bool | isDensity () const |
Is this a density? More... | |
bool | storedValueIsActive (const unsigned &iatom) |
Is the iatom'th stored value currently active. More... | |
virtual bool | hasDifferentiableOrientation () const |
This is true if multicolvar is calculating a vector or if the multicolvar is the density. More... | |
virtual void | doNotCalculateDirector () |
This makes sure we are not calculating the director when we do LocalAverage. More... | |
bool | doNotCalculateDerivatives () const |
Ensure that derivatives are only calculated when needed. More... | |
MultiColvarBase * | getBaseMultiColvar (const unsigned &icolv) const |
Get the icolv th base multicolvar. More... | |
unsigned | getNumberOfBaseMultiColvars () const |
Get the number of base multicolvars. More... | |
virtual void | getInputData (const unsigned &ind, const bool &normed, const multicolvar::AtomValuePack &myatoms, std::vector< double > &orient) const |
Get an input data. More... | |
virtual MultiValue & | getInputDerivatives (const unsigned &iatom, const bool &normed, const multicolvar::AtomValuePack &myatoms) const |
Retrieve the input derivatives. 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... | |
Pbc & | modifyGlobalPbc () |
Get modifiable PBC Should be used by action that need to modify the stored box. 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... | |
void | pbcApply (std::vector< Vector > &dlist, unsigned max_index=0) const |
Applies PBCs to a seriens of positions or distances. 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 | interpretAtomList (std::vector< std::string > &strings, std::vector< AtomNumber > &t) |
Convert a set of read in strings into an atom list (this is used in parseAtomList) More... | |
void | changeBox (const Tensor &newbox) |
Change the box shape. 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 | applyForces () |
void | lockRequests () |
void | unlockRequests () |
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... | |
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 | 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... | |
bool | checkNumericalDerivatives () const |
Check if numerical derivatives should be used. 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... | |
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... | |
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 () |
void | lockContributors () |
unsigned | getCurrentNumberOfActiveTasks () const |
Get the number of tasks that are currently active. More... | |
bool | taskIsCurrentlyActive (const unsigned &index) const |
Check whether or not a particular task is currently active. 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... | |
unsigned | getNumberOfVessels () const |
Get the number of vessels. More... | |
Vessel * | getPntrToVessel (const unsigned &i) |
Get a pointer to the ith vessel. 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... | |
unsigned | getActiveTask (const unsigned &ii) const |
Get the ith of the currently active tasks. More... | |
StoreDataVessel * | buildDataStashes (ActionWithVessel *actionThatUses) |
Ensure that data required in other vessels is stored. More... | |
Vessel * | getVesselWithName (const std::string &mynam) |
These are overwritten in MultiColvarFunction. More... | |
bool | weightWithDerivatives () const |
Does the weight have derivatives. More... | |
unsigned | getPositionInCurrentTaskList (const unsigned &myind) const |
Return the position in the current task list. More... | |
virtual void | normalizeVector (std::vector< double > &vals) const |
These normalizes vectors and is used in StoreDataVessel. More... | |
virtual void | normalizeVectorDerivatives (MultiValue &myvals) const |
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 | |
double | getSigma () const |
std::string | getKernelType () const |
const Tensor & | getBox () const |
Get the cell box. More... | |
const Pbc & | getPbc () const |
Get reference to Pbc. More... | |
Vector | pbcDistance (const Vector &v1, const Vector &v2) const |
Calculate distance between two points. More... | |
Vector | getPosition (int iatom) const |
Get position of atom. More... | |
void | requestAtoms (const std::vector< AtomNumber > &atoms) |
Request the atoms. More... | |
void | setNumberInVolume (const unsigned &, const unsigned &, const double &, const Vector &, const Tensor &, const std::vector< Vector > &, MultiValue &) const |
Set the number in the volume. More... | |
void | deactivateAllAtoms () |
Deactivate all the atoms in the list. More... | |
void | setAtomActive (const unsigned &n) |
Activate the nth atom in the list. More... | |
bool | filtersUsedAsInput () |
Function that recursively checks if filters have been used in the input to a multicolvar we need this to ensure that setupLinkCells is run in calculate with some actions. More... | |
void | resizeBookeepingArray (const unsigned &num1, const unsigned &num2) |
This resizes the arrays that are used for link cell update. More... | |
void | addTaskToList (const unsigned &taskCode) |
Add a task to the list of tasks. More... | |
void | setupMultiColvarBase (const std::vector< AtomNumber > &atoms) |
Finish setting up the multicolvar base. More... | |
void | addAtomDerivatives (const int &, const unsigned &, const Vector &, multicolvar::AtomValuePack &) const |
Add some derivatives to a particular component of a particular atom. More... | |
void | mergeInputDerivatives (const unsigned &ival, const unsigned &start, const unsigned &end, const unsigned &jatom, const std::vector< double > &der, MultiValue &myder, AtomValuePack &myatoms) const |
Add derivative of the input value. More... | |
void | accumulateSymmetryFunction (const int &ival, const unsigned &iatom, const double &val, const Vector &der, const Tensor &vir, multicolvar::AtomValuePack &myatoms) const |
This is used to accumulate functions of the coordination sphere. Ensures weights are taken into account. More... | |
void | setAtomsForCentralAtom (const std::vector< bool > &catom_ind) |
Set which atoms are to be used to calculate the central atom position. More... | |
void | setLinkCellCutoff (const double &lcut, double tcut=-1.0) |
Set the value of the cutoff for the link cells. More... | |
void | setupActiveTaskSet (std::vector< unsigned > &active_tasks, const std::string &input_label) |
Setup the link cells and neighbour list stuff. More... | |
void | setupLinkCells () |
Setup link cells in order to make this calculation faster. More... | |
double | getLinkCellCutoff () const |
Get the cutoff for the link cells. More... | |
void | setupNonUseSpeciesLinkCells (const unsigned &) |
This does setup of link cell stuff that is specific to the non-use of the usespecies keyword. More... | |
Vector | getSeparation (const Vector &vec1, const Vector &vec2) const |
Get the separation between a pair of vectors. More... | |
bool | setupCurrentAtomList (const unsigned &taskCode, AtomValuePack &myatoms) const |
This sets up the list of atoms that are involved in this colvar. More... | |
void | decodeIndexToAtoms (const unsigned &taskCode, std::vector< unsigned > &atoms) const |
Decode indices if there are 2 or 3 atoms involved. More... | |
bool | parseMultiColvarAtomList (const std::string &key, const int &num, std::vector< AtomNumber > &t) |
Read in some atoms. More... | |
void | readTwoGroups (const std::string &key0, const std::string &key1, const std::string &key2, std::vector< AtomNumber > &all_atoms) |
Read in two groups of atoms and setup multicolvars to calculate. More... | |
void | readGroupKeywords (const std::string &key0, const std::string &key1, const std::string &key2, const std::string &key3, const bool &no_third_dim_accum, const bool &symmetric, std::vector< AtomNumber > &all_atoms) |
Read in three groups of atoms. More... | |
void | readThreeGroups (const std::string &key1, const std::string &key2, const std::string &key3, const bool &allow2, const bool &no_third_dim_accum, std::vector< AtomNumber > &all_atoms) |
Read in three groups of atoms and construct CVs involving at least one. 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... | |
void | runAllTasks () |
Calculate the values of all the vessels. More... | |
void | resizeFunctions () |
Resize all the functions when the number of derivatives change. More... | |
void | 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... | |
void | deactivateAllTasks () |
Deactivate all the tasks in the task list. More... | |
unsigned | getSizeOfBuffer (unsigned &bufsize) |
Get the size of the buffer. More... | |
Protected Attributes | |
std::vector< std::pair< unsigned, unsigned > > | atom_lab |
This is used to keep track of what is calculated where. More... | |
std::vector< vesselbase::StoreDataVessel * > | mybasedata |
The vessels in these multicolvars in which the data is stored. More... | |
std::vector< MultiColvarBase * > | mybasemulticolvars |
The multicolvars from which we construct these quantities. More... | |
Matrix< std::pair< unsigned, unsigned > > | bookeeping |
This remembers where the boundaries are for the tasks. It makes link cells work fast. More... | |
bool | matsums |
Are we doing sums of matrix rows. More... | |
bool | usespecies |
Using the species keyword to read in atoms. More... | |
unsigned | nblock |
Number of atoms in each block. More... | |
std::vector< unsigned > | decoder |
This is used when turning cvcodes into atom numbers. More... | |
std::vector< std::vector< unsigned > > | ablocks |
Blocks of atom numbers. More... | |
Atoms & | atoms |
bool | dertime |
This is also used to minimise computational expense in complex functions. More... | |
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... | |
StoreDataVessel * | mydata |
A pointer to the object that stores data. More... | |
std::vector< unsigned > | taskFlags |
This list is used to update the neighbor list. More... | |
Private Attributes | |
unsigned | nquantities |
Number of quantities in use in this colvar. More... | |
double | sigma |
The value of sigma. More... | |
bool | not_in |
Are we interested in the area outside the colvar. More... | |
std::string | kerneltype |
The kernel type for this histogram. More... | |
This is the abstract base class to use for implementing a new way of definining a particular region of the simulation box.
You can use this to calculate the number of atoms inside that part or the average value of a quantity like the coordination number inside that part of the cell.
|
inherited |
|
inherited |
|
explicit |
|
protectedinherited |
This is used to accumulate functions of the coordination sphere. Ensures weights are taken into account.
|
virtualinherited |
Set action to active.
|
protectedinherited |
Add some derivatives to a particular component of a particular atom.
|
inherited |
Forces here are applied through the bridge.
|
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.
|
protectedinherited |
Add a task to the list of tasks.
|
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()
|
inlinevirtualinherited |
Apply the forces from this action.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
virtualinherited |
Apply forces from bridge vessel - this is rarely used - currently only in ActionVolume.
Reimplemented from PLMD::vesselbase::ActionWithVessel.
|
inherited |
|
inherited |
Apply PBCs over a set of distance vectors.
|
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.
|
inherited |
Ensure that data required in other vessels is stored.
|
inlinevirtualinherited |
Do the calculation.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
protectedinherited |
This loops over all the vessels calculating them and also sets all the element derivatives equal to zero.
|
virtual |
Calculate whats in the volume.
Implements PLMD::multicolvar::VolumeGradientBase.
|
inherited |
Numerical derivative routine to use when using Actions that inherit from BOTH ActionWithArguments and ActionAtomistic.
|
inlineinherited |
This should not be called.
|
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 |
We need our own calculate numerical derivatives here.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
virtualinherited |
You can use this to screen contributions that are very small so we can avoid expensive (and pointless) calculations.
Reimplemented in PLMD::adjmat::HBondMatrix, PLMD::multicolvar::Angles, PLMD::adjmat::ContactMatrix, PLMD::multicolvar::NumberOfLinks, PLMD::crystallization::InterMolecularTorsions, and PLMD::adjmat::AlignedMatrixBase.
|
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.
|
inlinevirtualinherited |
Don't actually clear the derivatives when this is called from plumed main.
They are calculated inside another action and clearing them would be bad
Reimplemented from PLMD::ActionWithValue.
|
inherited |
Clear the forces on the values.
|
virtualinherited |
|
inherited |
|
virtualinherited |
Actually do what we are asked.
Implements PLMD::multicolvar::BridgedMultiColvarFunction.
|
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.
|
inlinevirtualinherited |
This is replaced once we have a function to calculate the cv.
Implements PLMD::multicolvar::MultiColvarBase.
|
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.
|
inherited |
Routines that have to be defined so as not to have problems with virtual methods.
|
protectedinherited |
Deactivate all the atoms in the list.
|
protectedinherited |
Deactivate all the tasks in the task list.
|
protectedinherited |
Decode indices if there are 2 or 3 atoms involved.
|
inlineinherited |
Are derivatives required for this quantity.
|
virtualinherited |
And a virtual function which actually computes the colvar.
Reimplemented in PLMD::crystallization::VectorMultiColvar.
|
virtualinherited |
Do jobs required before tasks are undertaken.
Reimplemented from PLMD::vesselbase::ActionWithVessel.
|
inlinevirtualinherited |
Ensure that derivatives are only calculated when needed.
Reimplemented from PLMD::ActionWithValue.
|
inlinevirtualinherited |
This makes sure we are not calculating the director when we do LocalAverage.
Reimplemented in PLMD::crystallization::VectorMultiColvar.
|
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.
|
inherited |
Closes a file opened with Action::fclose().
|
inherited |
Tell to the Action to flush open files.
|
protectedinherited |
Function that recursively checks if filters have been used in the input to a multicolvar we need this to ensure that setupLinkCells is run in calculate with some actions.
|
virtualinherited |
Finish running all the calculations.
|
inherited |
Opens a file.
This is similar to plain fopen, but with some extra functionality.
|
inlineinherited |
Get the absolute index of an atom.
|
inlinevirtualinherited |
Get indicecs involved in this colvar.
Reimplemented from PLMD::ActionAtomistic.
|
inlinevirtualinherited |
Get the index of the central atom.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
inlineinherited |
Get the ith of the currently active tasks.
|
inlineinherited |
Get the icolv th base multicolvar.
|
inlineprotectedinherited |
Get the cell box.
|
inline |
|
virtualinherited |
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
inlinevirtualinherited |
Get the index where the central atom is stored.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
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
|
inherited |
Return true if we are doing at a checkpoint step.
|
inlineinherited |
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.
|
inherited |
|
virtualinherited |
Get an input data.
Reimplemented in PLMD::adjmat::ClusterWithSurface, and PLMD::adjmat::ActionWithInputMatrix.
|
virtualinherited |
Retrieve the input derivatives.
Reimplemented in PLMD::adjmat::ClusterWithSurface, and PLMD::adjmat::ActionWithInputMatrix.
|
inlineprotected |
|
inherited |
Just read one of the keywords and return the whole thing as a string.
|
inlineinherited |
Returns the label.
|
protectedinherited |
Get the cutoff for the link cells.
|
inlinevirtualinherited |
Returns the position where we should assume the center is for link cell calculations.
|
inlineinherited |
Get mass of i-th atom.
|
inlineinherited |
Returns the name.
|
inlineprotectedinherited |
Return the value for the neighbor list tolerance.
|
inlineinherited |
Get number of available atoms.
|
inlineinherited |
Get the number of base multicolvars.
|
inlineinherited |
Returns the number of values defined.
|
inlinevirtualinherited |
Get the number of derivatives for this action.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
inlinevirtual |
Get the number of quantities that are calculated each time.
Reimplemented from PLMD::vesselbase::ActionWithVessel.
|
inlineinherited |
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)
|
inlineprotectedinherited |
Get reference to Pbc.
|
protectedinherited |
Return a pointer to the component by index.
|
protectedinherited |
Return a pointer to the value by name.
|
inlineinherited |
Get a pointer to the base multicolvar.
|
protectedinherited |
Get a pointer to the default value.
|
inlineinherited |
Get a pointer to the ith vessel.
|
inlineprotectedinherited |
Get position of atom.
|
inlineinherited |
Get position of i-th atom (access by absolute AtomNumber).
With direct access to the global atom array
|
inlineinherited |
Return the position in the current task list.
|
inlineinherited |
Get the position of the ith active task in the full list.
|
inlinevirtualinherited |
This gets the position of an atom for the link cell setup.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
inlineinherited |
Get the array of all positions.
|
inlineinherited |
Return true if we are doing a restart.
|
protectedinherited |
Get the separation between a pair of vectors.
|
inlineprotected |
|
inlineinherited |
Get the size of the atoms with derivatives array.
|
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
|
inlinevirtualinherited |
This is true if multicolvar is calculating a vector or if the multicolvar is the density.
Reimplemented in PLMD::crystallization::VectorMultiColvar, and PLMD::multicolvar::Density.
|
inherited |
Convert a set of read in strings into an atom list (this is used in parseAtomList)
bool PLMD::multicolvar::ActionVolume::inVolumeOfInterest | ( | const unsigned & | curr | ) | const |
This calculates whether or not a particular is inside the box of interest this is used for neighbour list with volumes.
|
inlineinherited |
Check if action is active.
|
inlinevirtualinherited |
Is this atom currently being copied.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
inlinevirtualinherited |
Is this a density?
Reimplemented in PLMD::multicolvar::DistanceFromContour, and PLMD::multicolvar::Density.
|
inlineinherited |
Check if an option is on.
|
virtualinherited |
Is the output quantity periodic.
Implements PLMD::vesselbase::ActionWithVessel.
|
inherited |
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::PCAVars, PLMD::mapping::Mapping, and PLMD::vesselbase::ActionWithAveraging.
|
inherited |
Make atoms whole, assuming they are in the proper order.
|
protectedinherited |
Add derivative of the input value.
|
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 PBC Should be used by action that need to modify the stored box.
|
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.
|
inlinevirtualinherited |
These normalizes vectors and is used in StoreDataVessel.
Reimplemented in PLMD::multicolvar::LocalAverage, PLMD::crystallization::VectorMultiColvar, and PLMD::crystallization::MoleculeOrientation.
|
inlinevirtualinherited |
Reimplemented in PLMD::crystallization::VectorMultiColvar, and PLMD::crystallization::MoleculeOrientation.
|
inherited |
Parse one keyword as generic type.
|
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.
|
protectedinherited |
Read in some atoms.
|
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.
|
inlineprotectedinherited |
Calculate distance between two points.
|
virtualinherited |
Perform one of the tasks.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
virtualinherited |
Do some setup before 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 |
Read in three groups of atoms.
|
protectedinherited |
Read in three groups of atoms and construct CVs involving at least one.
|
protectedinherited |
Read in two groups of atoms and setup multicolvars to calculate.
|
protectedinherited |
Complete the setup of this object (this routine must be called after construction of ActionWithValue)
|
static |
|
protectedinherited |
Request the atoms.
|
protectedinherited |
This resizes the arrays that are used for link cell update.
|
protectedinherited |
Resize all the functions when the number of derivatives change.
|
virtualinherited |
This is overwritten here in order to make sure that we do not retrieve atoms multiple times.
Reimplemented from PLMD::ActionAtomistic.
|
inherited |
Get the central atom position.
|
virtualinherited |
What are the domains of the base quantities.
Reimplemented in PLMD::crystallization::InterMolecularTorsions, and 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, PLMD::gridtools::ConvertToFES, and PLMD::gridtools::GridPrintingBase.
|
inlineprotectedinherited |
Is the calculation being done in serial.
|
protectedinherited |
Activate the nth atom in the list.
|
protectedinherited |
Set which atoms are to be used to calculate the central atom position.
|
inherited |
Add the forces to the atoms.
|
inherited |
Calculate the gradients and store them for all the values (need for projections)
|
protectedinherited |
Set the value of the cutoff for the link cells.
|
inlineprotectedinherited |
Set that we are using low memory.
|
inherited |
Set your default value to have no periodicity.
|
protectedinherited |
Set the number in the volume.
|
virtualinherited |
|
inherited |
Set the value to be periodic with a particular domain.
|
protectedinherited |
Setup the link cells and neighbour list stuff.
|
protectedinherited |
This sets up the list of atoms that are involved in this colvar.
|
protectedinherited |
Setup link cells in order to make this calculation faster.
|
protectedinherited |
Finish setting up the multicolvar base.
|
protectedinherited |
This does setup of link cell stuff that is specific to the non-use of the usespecies keyword.
|
pure virtualinherited |
Setup the regions that this is based on.
Implemented in PLMD::multicolvar::VolumeTetrapore, PLMD::multicolvar::VolumeCavity, PLMD::multicolvar::VolumeInCylinder, PLMD::multicolvar::VolumeAround, PLMD::multicolvar::VolumeInSphere, and PLMD::crystallization::Gradient.
|
inlineprotectedinherited |
Set the default value (the one without name)
|
inherited |
Set the value.
|
inherited |
Is the iatom'th stored value currently active.
|
inherited |
Check whether or not a particular task is currently active.
|
inlinevirtualinherited |
Is it safe to use multithreading.
Reimplemented from PLMD::vesselbase::ActionWithVessel.
|
virtualinherited |
This does the task.
Reimplemented from PLMD::vesselbase::ActionWithVessel.
|
virtualinherited |
Check nothing impossible being done with derivatives.
Reimplemented from PLMD::multicolvar::MultiColvarBase.
|
inlinevirtualinherited |
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.
|
virtualinherited |
Update the active atoms.
|
staticinherited |
The components in the action will depend on the user.
|
inlineinherited |
This forces the class to use numerical derivatives.
|
inlineinherited |
Do we use pbc to calculate this quantity.
|
inlineprotectedinherited |
Are we using low memory.
|
inherited |
Issue a warning.
|
inlineinherited |
Does the weight have derivatives.
|
protectedinherited |
Blocks of atom numbers.
|
protectedinherited |
This is used to keep track of what is calculated where.
|
protectedinherited |
|
protectedinherited |
This remembers where the boundaries are for the tasks. It makes link cells work fast.
|
protectedinherited |
This is used for numerical derivatives of bridge variables.
|
inherited |
|
protectedinherited |
The terms in the series are locked.
|
protectedinherited |
This is used when turning cvcodes into atom numbers.
|
protectedinherited |
This is also used to minimise computational expense in complex functions.
|
inherited |
|
private |
The kernel type for this histogram.
|
inherited |
|
inherited |
Reference to the log stream.
|
protectedinherited |
Are we doing sums of matrix rows.
|
inherited |
|
protectedinherited |
The vessels in these multicolvars in which the data is stored.
|
protectedinherited |
The multicolvars from which we construct these quantities.
|
protectedinherited |
A pointer to the object that stores data.
|
protectedinherited |
Number of atoms in each block.
|
private |
Are we interested in the area outside the colvar.
|
private |
Number of quantities in use in this colvar.
|
inherited |
Reference to main plumed object.
|
private |
The value of sigma.
|
protectedinherited |
This list is used to update the neighbor list.
|
protectedinherited |
Using the species keyword to read in atoms.
|
protectedinherited |
Does the weight have derivatives.
Hosted by GitHub | 1.8.14 |