Provides the keyword TORSION More...
Public Types | |
typedef std::vector< Action * > | Dependencies |
typedef std::set< FILE * > ::iterator | files_iterator |
Public Member Functions | |
Torsion (const ActionOptions &) | |
virtual void | calculate () |
Calculate an Action. More... | |
bool | checkIsEnergy () |
virtual unsigned | getNumberOfDerivatives () |
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... | |
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 | 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... | |
void | addDependency (Action *) |
Specify that this Action depends on another one. More... | |
void | clearDependencies () |
Clear the dependence list for this Action. More... | |
long int | getStep () const |
Return the present timestep. More... | |
double | getTime () const |
Return the present time. More... | |
double | getTimeStep () const |
Return the timestep. More... | |
template<class T > | |
void | parse (const std::string &key, T &t) |
Parse one keyword as generic type. More... | |
template<class T > | |
bool | parseNumbered (const std::string &key, const int no, T &t) |
Parse one numbered keyword as generic type. More... | |
template<class T > | |
void | parseVector (const std::string &key, std::vector< T > &t) |
Parse one keyword as std::vector. More... | |
template<class T > | |
bool | parseNumberedVector (const std::string &key, const int no, std::vector< T > &t) |
Parse a vector with a number. More... | |
void | parseFlag (const std::string &key, bool &t) |
Parse one keyword as boolean flag. More... | |
void | error (const std::string &msg) const |
Crash calculation and print documentation. More... | |
void | warning (const std::string &msg) |
Issue a warning. More... | |
void | exit (int c=0) |
Exit with error code c. More... | |
void | checkRead () |
Check if Action was properly read. More... | |
virtual void | prepare () |
Prepare an Action for calculation This can be used by Action if they need some special preparation before calculation. More... | |
virtual void | 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... | |
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... | |
void | useNumericalDerivatives () |
This forces the class to use numerical derivatives. More... | |
virtual void | checkFieldsAllowed () |
virtual void | turnOnDerivatives () |
Activate the calculation of 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 | |
void | requestAtoms (const std::vector< AtomNumber > &a) |
void | setAtomsDerivatives (int, const Vector &) |
void | setAtomsDerivatives (Value *, int, const Vector &) |
void | setBoxDerivatives (const Tensor &) |
void | setBoxDerivatives (Value *, const Tensor &) |
const Tensor & | getBoxDerivatives () const |
const double & | getForce () const |
void | apply () |
Apply an Action. More... | |
void | setBoxDerivativesNoPbc () |
Set box derivatives automatically. More... | |
void | setBoxDerivativesNoPbc (Value *) |
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... | |
Protected Attributes | |
bool | isEnergy |
Atoms & | atoms |
Private Attributes | |
bool | pbc |
bool | do_cosine |
Provides the keyword TORSION
|
inherited |
|
inherited |
PLMD::colvar::Torsion::Torsion | ( | const ActionOptions & | ao | ) |
|
virtualinherited |
Set action to active.
|
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 a value with the name label.
|
inherited |
Add a value with the name label that has derivatives.
|
protectedvirtualinherited |
Apply an Action.
This method is called one time per step. The set of all Actions is applied in backward order.
Implements PLMD::Action.
|
inherited |
|
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::analysis::Analysis, PLMD::multicolvar::ActionVolume, PLMD::multicolvar::MultiColvarFunction, and PLMD::mapping::Mapping.
|
inherited |
Change the box shape.
|
inlinevirtualinherited |
Reimplemented in PLMD::colvar::ContactMap.
|
inlineinherited |
|
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 |
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::ActionVolume, 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.
|
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.
|
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.
|
inlineinherited |
Get the vector of absolute indexes.
|
inlineinherited |
Get box shape.
|
protectedinherited |
|
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
|
inlineinherited |
Return dependencies.
|
virtualinherited |
|
inlineinherited |
Get energy.
|
inherited |
Check if we are on an exchange step.
|
protectedinherited |
|
inlineinherited |
Returns the label.
|
inlineinherited |
Get mass of i-th atom.
|
inlineinherited |
Returns the name.
|
inlineinherited |
Get number of available atoms.
|
inlineinherited |
Returns the number of values defined.
|
inlinevirtualinherited |
Implements PLMD::ActionWithValue.
Reimplemented in PLMD::colvar::Energy.
|
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)
|
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.
|
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.
|
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 |
Check if action is active.
|
inlineinherited |
Check if an option is on.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in PLMD::mapping::Mapping.
|
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).
Should be used by action that need to modify the stored atomic forces
|
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.
|
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 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.
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::multicolvar::MultiColvarBase, PLMD::multicolvar::ActionVolume, PLMD::mapping::Mapping, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::generic::Read, PLMD::generic::Print, 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 |
|
inherited |
|
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 |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
Set box derivatives automatically.
It should be called after the setAtomsDerivatives has been used for all single atoms.
|
protectedinherited |
|
inherited |
Add the forces to the atoms.
|
inherited |
Calculate the gradients and store them for all the values (need for projections)
|
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.
|
virtualinherited |
Activate the calculation of derivatives.
Reimplemented in PLMD::multicolvar::MultiColvarBase, PLMD::multicolvar::ActionVolume, PLMD::generic::Read, PLMD::secondarystructure::SecondaryStructureRMSD, PLMD::mapping::Mapping, and PLMD::bias::Bias.
|
inlinevirtualinherited |
Reimplemented from PLMD::Action.
Reimplemented in 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::analysis::Analysis, PLMD::generic::DumpAtoms, PLMD::generic::Read, PLMD::multicolvar::DumpMultiColvar, PLMD::generic::Print, PLMD::generic::DumpDerivatives, PLMD::generic::DumpForces, and PLMD::generic::DumpProjections.
|
staticinherited |
The components in the action will depend on the user.
|
inlineinherited |
This forces the class to use numerical derivatives.
|
inherited |
Issue a warning.
|
protectedinherited |
|
inherited |
|
private |
|
inherited |
|
protectedinherited |
|
inherited |
|
inherited |
Reference to the log stream.
|
inherited |
|
private |
|
inherited |
Reference to main plumed object.
Hosted by GitHub | 1.8.7 |