Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | List of all members
PLMD::Action Class Referenceabstract

Base class for all the input Actions. More...

#include <Action.h>

Inheritance diagram for PLMD::Action:
Inheritance graph
[legend]

Public Types

typedef std::vector< Action * > Dependencies
 
typedef std::set< FILE * >::iterator files_iterator
 

Public Member Functions

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...
 
 Action (const ActionOptions &)
 Standard constructor from ActionOptions. More...
 
virtual ~Action ()
 Destructor. 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 lockRequests ()
 
virtual void unlockRequests ()
 
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 DependenciesgetDependencies () 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...
 
virtual void calculateNumericalDerivatives (ActionWithValue *a=NULL)
 Perform calculation using numerical derivatives N.B. 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...
 
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...
 
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)
 Register all the relevant keywords for the action. More...
 

Public Attributes

PlumedMainplumed
 Reference to main plumed object. More...
 
Loglog
 Reference to the log stream. More...
 
std::set< FILE * > files
 
Communicatorcomm
 
Communicatormulti_sim_comm
 
const Keywordskeywords
 

Private Member Functions

 Action (const Action &a)
 Copy constructor is disabled (private and unimplemented) More...
 
Actionoperator= (const Action &a)
 Assignment operator is disabled (private and unimplemented) More...
 

Private Attributes

const std::string name
 Name of the directive in the plumed.dat file. More...
 
std::string label
 Label of the Action, as set with LABEL= in the plumed.dat file. More...
 
std::vector< std::string > line
 Directive line. More...
 
double update_from
 Update only after this time. More...
 
double update_until
 Update only until this time. More...
 
Dependencies after
 Actions on which this Action depends. More...
 
bool active
 Switch to activate Action on this step. More...
 
std::set< std::string > options
 Option that you might have enabled. More...
 
bool restart
 

Detailed Description

Base class for all the input Actions.

The input Actions are more or less corresponding to the directives in the plumed.dat file and are applied in order at each time-step.

Member Typedef Documentation

typedef std::vector<Action*> PLMD::Action::Dependencies
typedef std::set<FILE*>::iterator PLMD::Action::files_iterator

Constructor & Destructor Documentation

PLMD::Action::Action ( const ActionOptions ao)
explicit

Standard constructor from ActionOptions.

PLMD::Action::~Action ( )
virtual

Destructor.

PLMD::Action::Action ( const Action a)
explicitprivate

Copy constructor is disabled (private and unimplemented)

Member Function Documentation

void PLMD::Action::activate ( )
virtual

Set action to active.

void PLMD::Action::addDependency ( Action action)

Specify that this Action depends on another one.

virtual void PLMD::Action::apply ( )
pure virtual
virtual void PLMD::Action::calculate ( )
pure virtual

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 PLMD::Action::calculateFromPDB ( const PDB pdb)

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

void PLMD::Action::calculateNumericalDerivatives ( ActionWithValue a = NULL)
virtual
virtual bool PLMD::Action::checkNeedsGradients ( ) const
inlinevirtual

Check if the action needs gradient.

Reimplemented in PLMD::bias::MetaD, and PLMD::generic::DumpProjections.

virtual bool PLMD::Action::checkNumericalDerivatives ( ) const
inlinevirtual

Check if numerical derivatives should be performed.

Reimplemented in PLMD::ActionWithValue.

void PLMD::Action::checkRead ( )

Check if Action was properly read.

This checks if Action::line is empty. It must be called after a final Action has been initialized

bool PLMD::Action::checkUpdate ( ) const

Check if action should be updated.

std::string PLMD::Action::cite ( const std::string &  s)

Cite a paper see PlumedMain::cite.

void PLMD::Action::clearDependencies ( )

Clear the dependence list for this Action.

void PLMD::Action::clearOptions ( )
virtual
void PLMD::Action::deactivate ( )
inlinevirtual

Set action to inactive.

void PLMD::Action::error ( const std::string &  msg) const

Crash calculation and print documentation.

void PLMD::Action::exit ( int  c = 0)

Exit with error code c.

int PLMD::Action::fclose ( FILE *  fp)

Closes a file opened with Action::fclose().

void PLMD::Action::fflush ( )

Tell to the Action to flush open files.

FILE * PLMD::Action::fopen ( const char *  path,
const char *  mode 
)

Opens a file.

This is similar to plain fopen, but with some extra functionality.

  • When opened for writing, processors other than the one with rank 0 just open /dev/null
  • PlumedMain::fopen is used, so that other tricks may appear (see PlumedMain::fopen)
const Dependencies& PLMD::Action::getDependencies ( ) const
inline

Return dependencies.

std::string PLMD::Action::getDocumentation ( ) const
virtual
bool PLMD::Action::getExchangeStep ( ) const

Check if we are on an exchange step.

const std::string & PLMD::Action::getLabel ( ) const
inline

Returns the label.

const std::string & PLMD::Action::getName ( ) const
inline

Returns the name.

bool PLMD::Action::getRestart ( ) const
inline

Return true if we are doing a restart.

long int PLMD::Action::getStep ( ) const

Return the present timestep.

double PLMD::Action::getTime ( ) const

Return the present time.

double PLMD::Action::getTimeStep ( ) const

Return the timestep.

bool PLMD::Action::isActive ( ) const
inline

Check if action is active.

bool PLMD::Action::isOptionOn ( const std::string &  s) const
inline

Check if an option is on.

virtual void PLMD::Action::lockRequests ( )
inlinevirtual
Action& PLMD::Action::operator= ( const Action a)
private

Assignment operator is disabled (private and unimplemented)

template<class T >
void PLMD::Action::parse ( const std::string &  key,
T &  t 
)

Parse one keyword as generic type.

void PLMD::Action::parseFlag ( const std::string &  key,
bool &  t 
)

Parse one keyword as boolean flag.

template<class T >
bool PLMD::Action::parseNumbered ( const std::string &  key,
const int  no,
T &  t 
)

Parse one numbered keyword as generic type.

template<class T >
bool PLMD::Action::parseNumberedVector ( const std::string &  key,
const int  no,
std::vector< T > &  t 
)

Parse a vector with a number.

template<class T >
void PLMD::Action::parseVector ( const std::string &  key,
std::vector< T > &  t 
)

Parse one keyword as std::vector.

void PLMD::Action::prepare ( )
virtual

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 void PLMD::Action::readAtomsFromPDB ( const PDB )
inlinevirtual

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.

void PLMD::Action::registerKeywords ( Keywords keys)
static

Register all the relevant keywords for the action.

virtual void PLMD::Action::runFinalJobs ( )
inlinevirtual

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 PLMD::Action::setOption ( const std::string &  s)
virtual
virtual void PLMD::Action::unlockRequests ( )
inlinevirtual
virtual void PLMD::Action::update ( )
inlinevirtual
void PLMD::Action::warning ( const std::string &  msg)

Issue a warning.

Member Data Documentation

bool PLMD::Action::active
private

Switch to activate Action on this step.

Dependencies PLMD::Action::after
private

Actions on which this Action depends.

Communicator& PLMD::Action::comm
std::set<FILE*> PLMD::Action::files
const Keywords& PLMD::Action::keywords
std::string PLMD::Action::label
private

Label of the Action, as set with LABEL= in the plumed.dat file.

std::vector<std::string> PLMD::Action::line
private

Directive line.

This line is progressively erased during Action construction so as to check if all the present keywords are correct.

Log& PLMD::Action::log

Reference to the log stream.

Communicator& PLMD::Action::multi_sim_comm
const std::string PLMD::Action::name
private

Name of the directive in the plumed.dat file.

std::set<std::string> PLMD::Action::options
private

Option that you might have enabled.

PlumedMain& PLMD::Action::plumed

Reference to main plumed object.

bool PLMD::Action::restart
private
double PLMD::Action::update_from
private

Update only after this time.

double PLMD::Action::update_until
private

Update only until this time.


The documentation for this class was generated from the following files: