Provides the keyword READ More...
Public Types | |
typedef std::vector< Action * > | Dependencies |
Public Member Functions | |
Read (const ActionOptions &) | |
virtual void | activate () |
Set action to active. 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 | addDependency (Action *) |
Specify that this Action depends on another one. 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 | apply () override |
Apply an Action. More... | |
virtual void | beforeUpdate () |
Before Update. More... | |
void | calculate () override |
Calculate an Action. More... | |
void | calculateFromPDB (const PDB &) |
Calculate the action given a pdb file as input. More... | |
virtual void | calculateNumericalDerivatives (ActionWithValue *a=NULL) |
Perform calculation using numerical derivatives N.B. More... | |
virtual void | checkFieldsAllowed () |
virtual bool | checkNeedsGradients () const |
Check if the action needs gradient. More... | |
bool | checkNumericalDerivatives () const override |
Check if numerical derivatives should be used. More... | |
virtual bool | checkNumericalDerivatives () const |
Check if numerical derivatives should be performed. More... | |
void | checkRead () |
Check if Action was properly read. More... | |
bool | checkUpdate () const |
Check if action should be updated. More... | |
std::string | cite (const std::string &s) |
Cite a paper see PlumedMain::cite. More... | |
void | clearDependencies () |
Clear the dependence list for this Action. More... | |
virtual void | clearDerivatives () |
Clear the derivatives of values wrt parameters. More... | |
void | clearInputForces () |
Clear the forces on the values. More... | |
virtual void | clearOptions () |
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... | |
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... | |
virtual void | deactivate () |
Set action to inactive. More... | |
virtual bool | doNotCalculateDerivatives () const |
Are we not calculating derivatives. More... | |
void | error (const std::string &msg) const |
Crash calculation and print documentation. More... | |
bool | exists (const std::string &name) const |
Check if a value with a particular name is present. More... | |
void | exit (int c=0) |
Exit with error code c. More... | |
int | fclose (FILE *fp) |
Closes a file opened with Action::fclose(). More... | |
void | fflush () |
Tell to the Action to flush open files. More... | |
FILE * | fopen (const char *path, const char *mode) |
Opens a file. 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... | |
bool | getCPT () const |
Return true if we are doing at a checkpoint step. More... | |
const Dependencies & | getDependencies () const |
Return dependencies. More... | |
virtual std::string | getDocumentation () const |
bool | getExchangeStep () const |
Check if we are on an exchange step. More... | |
IFile * | getFile () |
std::string | getFilename () const |
std::string | getKeyword (const std::string &key) |
Just read one of the keywords and return the whole thing as a string. More... | |
const std::string & | getLabel () const |
Returns the label. More... | |
const std::string & | getName () const |
Returns the name. More... | |
int | getNumberOfComponents () const |
Returns the number of values defined. More... | |
unsigned | getNumberOfDerivatives () override |
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 | getRestart () const |
Return true if we are doing a restart. More... | |
long int | getStep () const |
Return the present timestep. More... | |
int | getStride () const |
Get the stride. More... | |
double | getTime () const |
Return the present time. More... | |
double | getTimeStep () const |
Return the timestep. More... | |
bool | isActive () const |
Check if action is active. More... | |
bool | isOptionOn (const std::string &s) const |
Check if an option is on. More... | |
virtual void | lockRequests () |
virtual bool | onStep () const |
Check if the action is active on this step. More... | |
template<class T > | |
void | parse (const std::string &key, T &t) |
Parse one keyword as generic type. More... | |
void | parseFlag (const std::string &key, bool &t) |
Parse one keyword as boolean flag. 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 > | |
bool | parseNumberedVector (const std::string &key, const int no, std::vector< T > &t) |
Parse a vector with a number. More... | |
template<class T > | |
void | parseVector (const std::string &key, std::vector< T > &t) |
Parse one keyword as std::vector. More... | |
void | prepare () override |
Prepare an Action for calculation This can be used by Action if they need some special preparation before calculation. More... | |
virtual void | readAtomsFromPDB (const PDB &) |
This is overwritten in ActionAtomistic so that we can read the atoms from the pdb input file rather than taking them from the MD code. More... | |
virtual void | runFinalJobs () |
RunFinalJobs This method is called once at the very end of the calculation. More... | |
void | setGradientsIfNeeded () |
Calculate the gradients and store them for all the values (need for projections) More... | |
void | setNotPeriodic () |
Set your default value to have no periodicity. More... | |
virtual void | setOption (const std::string &s) |
void | setPeriodic (const std::string &min, const std::string &max) |
Set the value to be periodic with a particular domain. More... | |
void | setStride (const int &n) |
Set the value of the stride. More... | |
void | setValue (Value *, double) |
Set the value. More... | |
void | turnOnDerivatives () override |
Activate the calculation of derivatives. More... | |
virtual void | unlockRequests () |
void | update () override |
Update. More... | |
void | useNumericalDerivatives () |
This forces the class to use numerical derivatives. More... | |
void | warning (const std::string &msg) |
Issue a warning. More... | |
Static Public Member Functions | |
static void | componentsAreNotOptional (Keywords &keys) |
Puts a message into the manual that the components always output. More... | |
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 | registerKeywords (Keywords &keys) |
static void | useCustomisableComponents (Keywords &keys) |
The components in the action will depend on the user. More... | |
Public Attributes | |
Communicator & | comm |
std::set< FILE * > | files |
const Keywords & | keywords |
Log & | log |
Reference to the log stream. More... | |
Communicator & | multi_sim_comm |
PlumedMain & | plumed |
Reference to main plumed object. More... | |
Protected Member Functions | |
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... | |
Value * | getPntrToValue () |
Get a pointer to the default value. More... | |
void | setValue (const double &d) |
Set the default value (the one without name) More... | |
Private Attributes | |
bool | cloned_file |
std::string | filename |
IFile * | ifile |
Pointer to input file. More... | |
std::unique_ptr< IFile > | ifile_ptr |
Unique pointer with the same scope as ifile. More... | |
bool | ignore_forces |
bool | ignore_time |
unsigned | nlinesPerStep |
std::vector< std::unique_ptr< Value > > | readvals |
Provides the keyword READ
|
inherited |
|
explicit |
|
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.
|
inlineoverridevirtual |
Apply an Action.
This method is called one time per step. The set of all Actions is applied in backward order.
Implements PLMD::Action.
|
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.
|
overridevirtual |
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 |
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 |
Perform calculation using numerical derivatives N.B.
only pass an ActionWithValue to this routine if you know exactly what you are doing.
Reimplemented in PLMD::isdb::MetainferenceBase, PLMD::mapping::PCAVars, PLMD::ActionAtomistic, PLMD::multicolvar::MultiColvarBase, PLMD::analysis::AnalysisBase, PLMD::vesselbase::ActionWithAveraging, PLMD::mapping::Mapping, PLMD::multicolvar::DumpMultiColvar, PLMD::ActionWithArguments, PLMD::multicolvar::BridgedMultiColvarFunction, and PLMD::vesselbase::ActionWithInputVessel.
|
inlinevirtualinherited |
Reimplemented in PLMD::piv::PIV, and PLMD::colvar::ContactMap.
|
inlinevirtualinherited |
Check if the action needs gradient.
Reimplemented in PLMD::bias::MetaD, PLMD::bias::PBMetaD, and PLMD::generic::DumpProjections.
|
inlineoverridevirtualinherited |
Check if numerical derivatives should be used.
Reimplemented from PLMD::Action.
|
inlinevirtualinherited |
Check if numerical derivatives should be performed.
Reimplemented in PLMD::ActionWithValue.
|
inherited |
Check if Action was properly read.
This checks if Action::line is empty. It must be called after a final Action has been initialized
|
inherited |
Check if action should be updated.
|
inherited |
Cite a paper see PlumedMain::cite.
|
inherited |
Clear the dependence list for this Action.
|
virtualinherited |
Clear the derivatives of values wrt parameters.
Reimplemented in PLMD::multicolvar::BridgedMultiColvarFunction, and PLMD::manyrestraints::ManyRestraintsBase.
|
inherited |
Clear the forces on the values.
|
virtualinherited |
|
inherited |
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.
|
inlinevirtualinherited |
Are we not calculating derivatives.
Reimplemented in PLMD::multicolvar::MultiColvarBase.
|
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.
|
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 |
Return dependencies.
|
virtualinherited |
|
inherited |
Check if we are on an exchange step.
IFile * PLMD::generic::Read::getFile | ( | ) |
std::string PLMD::generic::Read::getFilename | ( | ) | const |
|
inherited |
Just read one of the keywords and return the whole thing as a string.
|
inlineinherited |
Returns the label.
|
inlineinherited |
Returns the name.
|
inlineinherited |
Returns the number of values defined.
|
overridevirtual |
Implements PLMD::ActionWithValue.
|
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 |
Return true if we are doing a restart.
|
inherited |
Return the present timestep.
|
inherited |
Get the stride.
|
inherited |
Return the present time.
|
inherited |
Return the timestep.
|
inlineinherited |
Check if action is active.
|
inlineinherited |
Check if an option is on.
|
inlinevirtualinherited |
|
staticinherited |
Insist that numerical derivatives should always be used for an action and make this fact appear in the manual.
|
virtualinherited |
Check if the action is active on this step.
Reimplemented in PLMD::gridtools::ConvertToFES.
|
inherited |
Parse one keyword as generic type.
|
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.
|
overridevirtual |
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 from PLMD::Action.
|
inlinevirtualinherited |
This is overwritten in ActionAtomistic so that we can read the atoms from the pdb input file rather than taking them from the MD code.
Reimplemented in PLMD::ActionAtomistic.
|
static |
|
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::vesselbase::ActionWithAveraging, PLMD::analysis::AnalysisBase, PLMD::gridtools::ConvertToFES, PLMD::analysis::ReadDissimilarityMatrix, and PLMD::gridtools::GridPrintingBase.
|
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.
|
inherited |
Set the value of the stride.
|
inlineprotectedinherited |
Set the default value (the one without name)
|
inherited |
Set the value.
|
overridevirtual |
Activate the calculation of derivatives.
Reimplemented from PLMD::ActionWithValue.
|
inlinevirtualinherited |
|
overridevirtual |
Update.
This method is called one time per step. The set of all Actions is updated in forward order.
Reimplemented from PLMD::Action.
|
staticinherited |
The components in the action will depend on the user.
|
inlineinherited |
This forces the class to use numerical derivatives.
|
inherited |
Issue a warning.
|
private |
|
inherited |
|
private |
|
inherited |
|
private |
Pointer to input file.
It is either pointing to the content of ifile_ptr or to the file it is cloned from.
|
private |
Unique pointer with the same scope as ifile.
|
private |
|
private |
|
inherited |
|
inherited |
Reference to the log stream.
|
inherited |
|
private |
|
inherited |
Reference to main plumed object.
|
private |
Hosted by GitHub | 1.8.14 |