Provides the keyword CENTER More...
Public Types | |
typedef std::vector< Action * > | Dependencies |
Public Member Functions | |
Center (const ActionOptions &ao) | |
void | calculate () |
Calculate an Action. More... | |
void | setGradients () |
const std::map< AtomNumber, Tensor > & | getGradients () const |
AtomNumber | getIndex () const |
Return the atom id of the corresponding virtual atom. More... | |
void | setGradientsIfNeeded () |
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... | |
Pbc & | modifyGlobalPbc () |
Get modifiable PBC Should be used by action that need to modify the stored box. 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... | |
virtual 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 | 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... | |
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 | updateUniqueLocal () |
updates local unique atoms More... | |
void | clearOutputForces () |
virtual void | calculateNumericalDerivatives (ActionWithValue *a=NULL) |
N.B. More... | |
void | calculateAtomicNumericalDerivatives (ActionWithValue *a, const unsigned &startnum) |
Numerical derivative routine to use when using Actions that inherit from BOTH ActionWithArguments and ActionAtomistic. More... | |
virtual void | retrieveAtoms () |
void | applyForces () |
void | lockRequests () |
void | unlockRequests () |
const std::set< AtomNumber > & | getUnique () const |
const std::set< AtomNumber > & | getUniqueLocal () 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 | prepare () |
Prepare an Action for calculation This can be used by Action if they need some special preparation before calculation. More... | |
virtual void | beforeUpdate () |
Before Update. More... | |
virtual void | update () |
Update. More... | |
virtual void | runFinalJobs () |
RunFinalJobs This method is called once at the very end of the calculation. More... | |
void | fflush () |
Tell to the Action to flush open files. More... | |
virtual std::string | getDocumentation () const |
const std::string & | getLabel () const |
Returns the label. More... | |
const std::string & | getName () const |
Returns the name. More... | |
virtual void | activate () |
Set action to active. More... | |
virtual void | setOption (const std::string &s) |
virtual void | clearOptions () |
virtual void | deactivate () |
Set action to inactive. More... | |
bool | isActive () const |
Check if action is active. More... | |
bool | isOptionOn (const std::string &s) const |
Check if an option is on. More... | |
const Dependencies & | getDependencies () const |
Return dependencies. More... | |
virtual bool | checkNumericalDerivatives () const |
Check if numerical derivatives should be performed. More... | |
virtual bool | checkNeedsGradients () const |
Check if the action needs gradient. More... | |
FILE * | fopen (const char *path, const char *mode) |
Opens a file. More... | |
int | fclose (FILE *fp) |
Closes a file opened with Action::fclose(). More... | |
void | calculateFromPDB (const PDB &) |
Calculate the action given a pdb file as input. More... | |
bool | getExchangeStep () const |
Check if we are on an exchange step. More... | |
std::string | cite (const std::string &s) |
Cite a paper see PlumedMain::cite. More... | |
Static Public Member Functions | |
static void | registerKeywords (Keywords &keys) |
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 | setPosition (const Vector &) |
Set position of the virtual atom. More... | |
void | setMass (double) |
Set its mass. More... | |
void | setCharge (double) |
Set its charge. More... | |
void | requestAtoms (const std::vector< AtomNumber > &a) |
Request atoms on which the calculation depends. More... | |
void | setAtomsDerivatives (const std::vector< Tensor > &d) |
Set the derivatives of virtual atom coordinate wrt atoms on which it dependes. More... | |
void | setBoxDerivatives (const std::vector< Tensor > &d) |
Set the box derivatives. More... | |
void | setBoxDerivativesNoPbc () |
Set box derivatives automatically. More... | |
Protected Attributes | |
Atoms & | atoms |
Private Attributes | |
std::vector< double > | weights |
bool | weight_mass |
bool | nopbc |
Provides the keyword CENTER
|
inherited |
|
explicit |
|
virtualinherited |
Set action to active.
|
inherited |
Specify that this Action depends on another one.
|
inlineinherited |
Allow calls to modifyGlobalForce()
|
inherited |
|
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.
|
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.
|
inherited |
Numerical derivative routine to use when using Actions that inherit from BOTH ActionWithArguments and ActionAtomistic.
|
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 |
N.B.
only pass an ActionWithValue to this routine if you know exactly what you are doing. The default will be correct for the vast majority of cases
Reimplemented from PLMD::Action.
Reimplemented in PLMD::isdb::MetainferenceBase, PLMD::mapping::PCAVars, PLMD::multicolvar::MultiColvarBase, PLMD::multicolvar::DumpMultiColvar, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::vesselbase::ActionWithAveraging, and PLMD::mapping::Mapping.
|
inherited |
Change the box shape.
|
inlinevirtualinherited |
Check if the action needs gradient.
Reimplemented in PLMD::bias::MetaD, PLMD::bias::PBMetaD, and PLMD::generic::DumpProjections.
|
inlinevirtualinherited |
Check if numerical derivatives should be performed.
Reimplemented in PLMD::ActionWithValue.
|
inherited |
Check if Action was properly read.
This checks if Action::line is empty. It must be called after a final Action has been initialized
|
inherited |
Check if action should be updated.
|
inherited |
Cite a paper see PlumedMain::cite.
|
inherited |
Clear the dependence list for this Action.
|
virtualinherited |
|
inherited |
|
inlinevirtualinherited |
Set action to inactive.
|
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 |
Exit with error code c.
|
inherited |
Closes a file opened with Action::fclose().
|
inherited |
Tell to the Action to flush open files.
|
inherited |
Opens a file.
This is similar to plain fopen, but with some extra functionality.
|
inlineinherited |
Get the absolute index of an atom.
|
inlinevirtualinherited |
Get the vector of absolute indexes.
Reimplemented in PLMD::multicolvar::BridgedMultiColvarFunction.
|
inlineinherited |
Get box shape.
|
inlineinherited |
Get charge of i-th atom.
|
inherited |
Return true if we are doing at a checkpoint step.
|
inlineinherited |
Return dependencies.
|
virtualinherited |
|
inlineinherited |
Get energy.
|
inherited |
Check if we are on an exchange step.
|
inlineinherited |
|
inlineinherited |
Return the atom id of the corresponding virtual atom.
|
inherited |
Just read one of the keywords and return the whole thing as a string.
|
inlineinherited |
Returns the label.
|
inlineinherited |
Get mass of i-th atom.
|
inlineinherited |
Returns the name.
|
inlineinherited |
Get number of available atoms.
|
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 array of all positions.
|
inlineinherited |
Return true if we are doing a restart.
|
inherited |
Return the present timestep.
|
inherited |
Return the present time.
|
inherited |
Return the timestep.
|
inlineinherited |
Get total number of atoms, including virtual ones.
Can be used to make a loop on modifyPosition or getPosition(AtomNumber)
|
inlineinherited |
|
inlineinherited |
|
inherited |
Convert a set of read in strings into an atom list (this is used in parseAtomList)
|
inlineinherited |
Check if action is active.
|
inlineinherited |
Check if an option is on.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::isdb::MetainferenceBase, PLMD::mapping::PCAVars, PLMD::mapping::Mapping, and PLMD::vesselbase::ActionWithAveraging.
|
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 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.
|
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.
|
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.
|
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::isdb::EMMI, PLMD::multicolvar::MultiColvarBase, PLMD::function::FuncPathMSD, PLMD::generic::DumpMassCharge, PLMD::generic::UpdateIf, PLMD::generic::Print, PLMD::generic::Read, PLMD::bias::ReweightTemperature, PLMD::gridtools::ConvertToFES, PLMD::colvar::Energy, and PLMD::colvar::CoordinationBase.
|
virtualinherited |
Read in an input file containing atom positions and calculate the action for the atomic configuration therin.
Reimplemented from PLMD::Action.
|
static |
|
protectedinherited |
Request atoms on which the calculation depends.
|
virtualinherited |
Reimplemented in PLMD::multicolvar::MultiColvarBase.
|
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 |
Set the derivatives of virtual atom coordinate wrt atoms on which it dependes.
|
protectedinherited |
Set the box derivatives.
This should be a vector of size 3. First index corresponds to the components of the virtual atom. Notice that this routine subtract the trivial term coming from cell deformation since this term is already implicitly included. Indeed, if the vatom position is a linear function of atomic coordinates it is not necessary to call this function (implicit term is fine) (e.g. vatom::COM and vatom::Center). On the other hand if the vatom position is a non-linear function of atomic coordinates this should be called (see vatom::Ghost).
|
protectedinherited |
Set box derivatives automatically.
It should be called after the settomsDerivatives has been used for all single atoms.
|
inlineprotectedinherited |
Set its charge.
|
inherited |
Add the forces to the atoms.
|
inherited |
|
inherited |
|
inlineprotectedinherited |
Set its mass.
|
virtualinherited |
|
inlineprotectedinherited |
Set position of the virtual atom.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::isdb::MetainferenceBase, 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::isdb::CS2Backbone, PLMD::bias::MetaD, PLMD::bias::PBMetaD, PLMD::isdb::Metainference, PLMD::ves::Optimizer, PLMD::isdb::RDC, PLMD::eds::EDS, PLMD::ves::TargetDistribution, PLMD::bias::MaxEnt, PLMD::generic::DumpAtoms, PLMD::multicolvar::VolumeTetrapore, PLMD::bias::ExtendedLagrangian, PLMD::multicolvar::VolumeCavity, PLMD::generic::EffectiveEnergyDrift, PLMD::isdb::SAXS, PLMD::generic::DumpMassCharge, PLMD::isdb::JCoupling, PLMD::mapping::AdaptivePath, PLMD::generic::Print, PLMD::ves::OutputFesBias, PLMD::isdb::PRE, PLMD::adjmat::OutputCluster, PLMD::generic::Read, PLMD::isdb::NOE, PLMD::multicolvar::DumpMultiColvar, PLMD::vesselbase::ActionWithAveraging, PLMD::generic::Flush, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::generic::DumpProjections, PLMD::adjmat::DumpGraph, and PLMD::gridtools::GridPrintingBase.
|
inherited |
updates local unique atoms
|
inherited |
Issue a warning.
|
protectedinherited |
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Reference to the log stream.
|
inherited |
|
private |
|
inherited |
Reference to main plumed object.
|
private |
|
private |
Hosted by GitHub | 1.8.14 |