Action used to create objects that access the positions of the atoms from the MD code. More...
#include <ActionAtomistic.h>
Public Types | |
typedef std::vector< Action * > | Dependencies |
typedef std::set< FILE * >::iterator | files_iterator |
Public Member Functions | |
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... | |
ActionAtomistic (const ActionOptions &ao) | |
~ActionAtomistic () | |
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... | |
void | retrieveAtoms () |
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... | |
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 | calculate ()=0 |
Calculate an Action. More... | |
virtual void | apply ()=0 |
Apply 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... | |
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 Attributes | |
Atoms & | atoms |
Private Attributes | |
std::vector< AtomNumber > | indexes |
std::set< AtomNumber > | unique |
std::vector< Vector > | positions |
double | energy |
Pbc & | pbc |
Tensor | virial |
std::vector< double > | masses |
bool | chargesWereSet |
std::vector< double > | charges |
std::vector< Vector > | forces |
double | forceOnEnergy |
bool | lockRequestAtoms |
bool | donotretrieve |
bool | donotforce |
Action used to create objects that access the positions of the atoms from the MD code.
|
inherited |
|
inherited |
|
explicit |
ActionAtomistic::~ActionAtomistic | ( | ) |
|
virtualinherited |
Set action to active.
|
inherited |
Specify that this Action depends on another one.
|
inline |
Allow calls to modifyGlobalForce()
|
pure virtualinherited |
Apply an Action.
This method is called one time per step. The set of all Actions is applied in backward order.
Implemented in PLMD::mapping::PCAVars, PLMD::generic::WrapAround, PLMD::analysis::Analysis, PLMD::generic::Group, PLMD::generic::DumpAtoms, PLMD::generic::EffectiveEnergyDrift, PLMD::multicolvar::MultiColvarBase, PLMD::generic::WholeMolecules, PLMD::generic::DumpMassCharge, PLMD::generic::FitToTemplate, PLMD::multicolvar::Sprint, PLMD::mapping::Mapping, PLMD::IMD, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::RandomExchanges, PLMD::generic::Read, PLMD::multicolvar::DumpMultiColvar, PLMD::multicolvar::MultiColvarDensity, PLMD::generic::Print, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::generic::Include, PLMD::analysis::Committor, PLMD::generic::Flush, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, PLMD::manyrestraints::ManyRestraintsBase, PLMD::generic::Debug, PLMD::Colvar, PLMD::generic::Time, PLMD::bias::Bias, PLMD::generic::DumpProjections, PLMD::function::Function, PLMD::ActionWithVirtualAtom, and PLMD::ActionSetup.
void ActionAtomistic::applyForces | ( | ) |
|
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.
void ActionAtomistic::calculateAtomicNumericalDerivatives | ( | ActionWithValue * | a, |
const unsigned & | startnum | ||
) |
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
|
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::Action.
Reimplemented in PLMD::mapping::PCAVars, PLMD::analysis::Analysis, PLMD::multicolvar::MultiColvarFunction, PLMD::multicolvar::MultiColvarDensity, PLMD::multicolvar::BridgedMultiColvarFunction, and PLMD::mapping::Mapping.
void ActionAtomistic::changeBox | ( | const Tensor & | newbox | ) |
Change the box shape.
|
inlinevirtualinherited |
Check if the action needs gradient.
Reimplemented in PLMD::bias::MetaD, 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 |
void ActionAtomistic::clearOutputForces | ( | ) |
|
inlinevirtualinherited |
Set action to inactive.
|
inline |
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.
|
inline |
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.
|
inline |
Get the absolute index of an atom.
|
inline |
Get the vector of absolute indexes.
|
inline |
Get box shape.
|
inline |
Get charge of i-th atom.
|
inlineinherited |
Return dependencies.
|
virtualinherited |
|
inline |
Get energy.
|
inherited |
Check if we are on an exchange step.
|
inlineinherited |
Returns the label.
|
inline |
Get mass of i-th atom.
|
inlineinherited |
Returns the name.
|
inline |
Get number of available atoms.
|
inline |
Get position of i-th atom (access by relative index)
|
inline |
Get position of i-th atom (access by absolute AtomNumber).
With direct access to the global atom array
|
inline |
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.
|
inline |
Get total number of atoms, including virtual ones.
Can be used to make a loop on modifyPosition or getPosition(AtomNumber)
|
inline |
|
inlineinherited |
Check if action is active.
|
inlineinherited |
Check if an option is on.
|
inlinevirtual |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::PCAVars, and PLMD::mapping::Mapping.
void ActionAtomistic::makeWhole | ( | ) |
Make atoms whole, assuming they are in the proper order.
|
inline |
Get a reference to force on energy.
|
inline |
Get a reference to forces array.
|
inline |
Get modifiable force of i-th atom (access by absolute AtomNumber).
|
inline |
Get modifiable virial Should be used by action that need to modify the stored virial.
|
inline |
Get modifiable position of i-th atom (access by absolute AtomNumber).
Should be used by action that need to modify the stored atomic coordinates
|
inline |
Get a reference to virial array.
|
inherited |
Parse one keyword as generic type.
void ActionAtomistic::parseAtomList | ( | const std::string & | key, |
std::vector< AtomNumber > & | t | ||
) |
Parse a list of atoms without a numbered keyword.
void ActionAtomistic::parseAtomList | ( | const std::string & | key, |
const int | num, | ||
std::vector< AtomNumber > & | t | ||
) |
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.
void ActionAtomistic::pbcApply | ( | std::vector< Vector > & | dlist, |
unsigned | max_index = 0 |
||
) | const |
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::function::FuncPathMSD, PLMD::analysis::Analysis, PLMD::mapping::Mapping, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::Read, PLMD::generic::Print, PLMD::colvar::Energy, and PLMD::colvar::CoordinationBase.
|
virtual |
Read in an input file containing atom positions and calculate the action for the atomic configuration therin.
Reimplemented from PLMD::Action.
|
static |
void ActionAtomistic::requestAtoms | ( | const std::vector< AtomNumber > & | a | ) |
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
void ActionAtomistic::retrieveAtoms | ( | ) |
|
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.
void ActionAtomistic::setForcesOnAtoms | ( | const std::vector< double > & | forcesToApply, |
unsigned | ind = 0 |
||
) |
Add the forces to the atoms.
|
virtualinherited |
|
inlinevirtual |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::PCAVars, and PLMD::mapping::Mapping.
|
inlinevirtualinherited |
Update.
This method is called one time per step. The set of all Actions is updated in forward order.
Reimplemented in PLMD::bias::MetaD, PLMD::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.
|
inherited |
Issue a warning.
|
protected |
|
private |
|
private |
|
inherited |
|
private |
|
private |
|
private |
|
inherited |
|
private |
|
private |
|
private |
|
inherited |
|
private |
|
inherited |
Reference to the log stream.
|
private |
|
inherited |
|
private |
|
inherited |
Reference to main plumed object.
|
private |
|
private |
|
private |
Hosted by GitHub | 1.8.10 |