Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
PLMD::gridtools::Gradient Class Reference

Provides the keyword GRADIENT More...

Inheritance diagram for PLMD::gridtools::Gradient:
Inheritance graph
[legend]

Public Types

typedef std::vector< Action * > Dependencies
 

Public Member Functions

 Gradient (const ActionOptions &)
 
virtual void activate ()
 Set action to active. More...
 
void addCommentToShortcutOutput (const std::string &input)
 Add a comment to your shortcut output. More...
 
void addDependency (Action *)
 Specify that this Action depends on another one. More...
 
void apply () override
 Do nothing. More...
 
virtual void beforeUpdate ()
 Before Update. More...
 
void calculate () override
 Do nothing. 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 ActionAtomisticcastToActionAtomistic () noexcept
 
virtual ActionForInterfacecastToActionForInterface () noexcept
 
ActionShortcutcastToActionShortcut () noexcept final
 
virtual ActionToGetDatacastToActionToGetData () noexcept
 
virtual ActionToPutDatacastToActionToPutData () noexcept
 
virtual ActionWithArgumentscastToActionWithArguments () noexcept
 
virtual ActionWithValuecastToActionWithValue () noexcept
 Specialized casts, to make PlumedMain run faster. More...
 
virtual ActionWithVirtualAtomcastToActionWithVirtualAtom () noexcept
 
virtual DomainDecompositioncastToDomainDecomposition () noexcept
 
virtual PbcActioncastToPbcAction () noexcept
 
bool checkForDependency (Action *)
 Check that this action does not depend on the action in the argument. More...
 
virtual bool checkNeedsGradients () const
 Check if the action needs gradient. 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 clearOptions ()
 
std::string convertInputLineToString ()
 Take everything that was input to this action and convert it to a string. More...
 
virtual void deactivate ()
 Set action to inactive. More...
 
void error (const std::string &msg) const
 Crash calculation and print documentation. 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...
 
bool getCPT () const
 Return true if we are doing at a checkpoint step. More...
 
std::string getDefaultString () const
 Get the defaults. More...
 
const DependenciesgetDependencies () const
 Return dependencies. More...
 
bool getExchangeStep () const
 Check if we are on an exchange step. More...
 
double getkBT ()
 Get the value of kBT by either reading the TEMP keyword and multiplying the temperature by Boltzmann's constant or get it fro the MD code. More...
 
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...
 
bool getRestart () const
 Return true if we are doing a restart. More...
 
std::vector< std::string > getSavedInputLines () const
 Get the lines of the shortcut that were read in. More...
 
std::vector< std::string > getSavedOutputs () const
 Get the labels of the actions that this creates. More...
 
const std::string & getShortcutLabel () const
 
long long int getStep () const
 Return the present timestep. More...
 
double getTime () const
 Return the present time. More...
 
double getTimeStep () const
 Return the timestep. More...
 
void interpretDataLabel (const std::string &mystr, Action *myuser, std::vector< Value * > &args) const
 This sorts out the reading of arguments from shortcuts. 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 ()
 
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...
 
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 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...
 
void readInputLine (const std::string &input, bool saveline=true)
 Read a line of input and create appropriate actions. More...
 
void readShortcutKeywords (const Keywords &keys, std::map< std::string, std::string > &keymap)
 Read keywords. More...
 
void resetStoredTimestep ()
 Set the timestep that is stored in the action to the correct value. More...
 
virtual void runFinalJobs ()
 RunFinalJobs This method is called once at the very end of the calculation. More...
 
virtual void setOption (const std::string &s)
 
void setupConstantValues (const bool &have_atoms)
 This calculates any values that are constant and ensures that we don't calculate these actions on every timestep. More...
 
virtual void unlockRequests ()
 
virtual void update ()
 Update. More...
 
void warning (const std::string &msg)
 Issue a warning. More...
 
virtual std::string writeInGraph () const
 Get the info on what to calculate. More...
 

Static Public Member Functions

static void registerKeywords (Keywords &keys)
 

Public Attributes

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

Protected Member Functions

double getKBoltzmann () const
 Get the value of Boltzmann's constant. More...
 
const UnitsgetUnits () const
 Get the units that we are operating in. More...
 
std::string getUpdateLimits () const
 
bool usingNaturalUnits () const
 Are we using natural units. More...
 

Private Member Functions

void addToSavedInputLines (const std::string &line)
 

Private Attributes

bool active
 Switch to activate Action on this step. More...
 
Dependencies after
 Actions on which this Action depends. More...
 
std::string defaults
 The set of default arguments that we are using. More...
 
bool doCheckPoint
 
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...
 
const std::string name
 Name of the directive in the plumed.dat file. More...
 
bool never_activate
 
std::set< std::string > options
 Option that you might have enabled. More...
 
int replica_index
 
bool restart
 
std::vector< std::string > savedInputLines
 
std::vector< std::string > savedOutputs
 
std::string shortcutlabel
 
double timestep
 Save the timestep here. More...
 
double update_from
 Update only after this time. More...
 
double update_until
 Update only until this time. More...
 

Detailed Description

Provides the keyword GRADIENT

Member Typedef Documentation

◆ Dependencies

typedef std::vector<Action*> PLMD::Action::Dependencies
inherited

Constructor & Destructor Documentation

◆ Gradient()

PLMD::gridtools::Gradient::Gradient ( const ActionOptions ao)
explicit

Member Function Documentation

◆ activate()

void PLMD::Action::activate ( )
virtualinherited

Set action to active.

◆ addCommentToShortcutOutput()

void PLMD::ActionShortcut::addCommentToShortcutOutput ( const std::string &  input)
inherited

Add a comment to your shortcut output.

◆ addDependency()

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

Specify that this Action depends on another one.

◆ addToSavedInputLines()

void PLMD::ActionShortcut::addToSavedInputLines ( const std::string &  line)
privateinherited

◆ apply()

void PLMD::ActionShortcut::apply ( )
inlineoverridevirtualinherited

Do nothing.

Implements PLMD::Action.

◆ beforeUpdate()

virtual void PLMD::Action::beforeUpdate ( )
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.

◆ calculate()

void PLMD::ActionShortcut::calculate ( )
inlineoverridevirtualinherited

Do nothing.

Implements PLMD::Action.

◆ calculateFromPDB()

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

◆ calculateNumericalDerivatives()

void PLMD::Action::calculateNumericalDerivatives ( ActionWithValue a = NULL)
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::ActionWithVector, PLMD::ActionAtomistic, PLMD::generic::DumpAtoms, PLMD::ActionWithArguments, PLMD::generic::PrintNDX, PLMD::isdb::EMMI, PLMD::isdb::MetainferenceBase, and PLMD::contour::DistanceFromContourBase.

◆ castToActionAtomistic()

virtual ActionAtomistic* PLMD::Action::castToActionAtomistic ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::ActionAtomistic.

◆ castToActionForInterface()

virtual ActionForInterface* PLMD::Action::castToActionForInterface ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::ActionForInterface.

◆ castToActionShortcut()

ActionShortcut* PLMD::ActionShortcut::castToActionShortcut ( )
inlinefinalvirtualnoexceptinherited

Reimplemented from PLMD::Action.

◆ castToActionToGetData()

virtual ActionToGetData* PLMD::Action::castToActionToGetData ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::ActionToGetData.

◆ castToActionToPutData()

virtual ActionToPutData* PLMD::Action::castToActionToPutData ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::ActionToPutData.

◆ castToActionWithArguments()

virtual ActionWithArguments* PLMD::Action::castToActionWithArguments ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::ActionWithArguments.

◆ castToActionWithValue()

virtual ActionWithValue* PLMD::Action::castToActionWithValue ( )
inlinevirtualnoexceptinherited

Specialized casts, to make PlumedMain run faster.

Reimplemented in PLMD::ActionWithValue.

◆ castToActionWithVirtualAtom()

virtual ActionWithVirtualAtom* PLMD::Action::castToActionWithVirtualAtom ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::ActionWithVirtualAtom.

◆ castToDomainDecomposition()

virtual DomainDecomposition* PLMD::Action::castToDomainDecomposition ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::DomainDecomposition.

◆ castToPbcAction()

virtual PbcAction* PLMD::Action::castToPbcAction ( )
inlinevirtualnoexceptinherited

Reimplemented in PLMD::PbcAction.

◆ checkForDependency()

bool PLMD::Action::checkForDependency ( Action action)
inherited

Check that this action does not depend on the action in the argument.

◆ checkNeedsGradients()

virtual bool PLMD::Action::checkNeedsGradients ( ) const
inlinevirtualinherited

Check if the action needs gradient.

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

◆ checkNumericalDerivatives()

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

Check if numerical derivatives should be performed.

Reimplemented in PLMD::ActionWithValue.

◆ checkRead()

void PLMD::Action::checkRead ( )
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

◆ checkUpdate()

bool PLMD::Action::checkUpdate ( ) const
inherited

Check if action should be updated.

◆ cite()

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

Cite a paper see PlumedMain::cite.

◆ clearDependencies()

void PLMD::Action::clearDependencies ( )
inherited

Clear the dependence list for this Action.

◆ clearOptions()

void PLMD::Action::clearOptions ( )
virtualinherited

◆ convertInputLineToString()

std::string PLMD::ActionShortcut::convertInputLineToString ( )
inherited

Take everything that was input to this action and convert it to a string.

◆ deactivate()

void PLMD::Action::deactivate ( )
inlinevirtualinherited

Set action to inactive.

◆ error()

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

Crash calculation and print documentation.

◆ exit()

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

Exit with error code c.

◆ fclose()

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

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

◆ fflush()

void PLMD::Action::fflush ( )
inherited

Tell to the Action to flush open files.

◆ fopen()

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

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)

◆ getCPT()

bool PLMD::Action::getCPT ( ) const
inherited

Return true if we are doing at a checkpoint step.

◆ getDefaultString()

std::string PLMD::Action::getDefaultString ( ) const
inlineinherited

Get the defaults.

◆ getDependencies()

const Dependencies& PLMD::Action::getDependencies ( ) const
inlineinherited

Return dependencies.

◆ getExchangeStep()

bool PLMD::Action::getExchangeStep ( ) const
inherited

Check if we are on an exchange step.

◆ getKBoltzmann()

double PLMD::Action::getKBoltzmann ( ) const
protectedinherited

Get the value of Boltzmann's constant.

◆ getkBT()

double PLMD::Action::getkBT ( )
inherited

Get the value of kBT by either reading the TEMP keyword and multiplying the temperature by Boltzmann's constant or get it fro the MD code.

◆ getKeyword()

std::string PLMD::Action::getKeyword ( const std::string &  key)
inherited

Just read one of the keywords and return the whole thing as a string.

◆ getLabel()

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

Returns the label.

◆ getName()

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

Returns the name.

◆ getRestart()

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

Return true if we are doing a restart.

◆ getSavedInputLines()

std::vector< std::string > PLMD::ActionShortcut::getSavedInputLines ( ) const
inherited

Get the lines of the shortcut that were read in.

◆ getSavedOutputs()

std::vector< std::string > PLMD::ActionShortcut::getSavedOutputs ( ) const
inherited

Get the labels of the actions that this creates.

◆ getShortcutLabel()

const std::string & PLMD::ActionShortcut::getShortcutLabel ( ) const
inherited

◆ getStep()

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

Return the present timestep.

◆ getTime()

double PLMD::Action::getTime ( ) const
inherited

Return the present time.

◆ getTimeStep()

double PLMD::Action::getTimeStep ( ) const
inherited

Return the timestep.

◆ getUnits()

const Units & PLMD::Action::getUnits ( ) const
protectedinherited

Get the units that we are operating in.

◆ getUpdateLimits()

std::string PLMD::ActionShortcut::getUpdateLimits ( ) const
protectedinherited

◆ interpretDataLabel()

void PLMD::ActionShortcut::interpretDataLabel ( const std::string &  mystr,
Action myuser,
std::vector< Value * > &  args 
) const
inherited

This sorts out the reading of arguments from shortcuts.

◆ isActive()

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

Check if action is active.

◆ isOptionOn()

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

Check if an option is on.

◆ lockRequests()

virtual void PLMD::Action::lockRequests ( )
inlinevirtualinherited

◆ parse()

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

Parse one keyword as generic type.

◆ parseFlag()

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

Parse one keyword as boolean flag.

◆ parseNumbered()

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

Parse one numbered keyword as generic type.

◆ parseNumberedVector()

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

Parse a vector with a number.

◆ parseVector()

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

Parse one keyword as std::vector.

◆ prepare()

void PLMD::Action::prepare ( )
virtualinherited

◆ readAtomsFromPDB()

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

◆ readInputLine()

void PLMD::ActionShortcut::readInputLine ( const std::string &  input,
bool  saveline = true 
)
inherited

Read a line of input and create appropriate actions.

◆ readShortcutKeywords()

void PLMD::ActionShortcut::readShortcutKeywords ( const Keywords keys,
std::map< std::string, std::string > &  keymap 
)
inherited

Read keywords.

◆ registerKeywords()

void PLMD::gridtools::Gradient::registerKeywords ( Keywords keys)
static

◆ resetStoredTimestep()

void PLMD::Action::resetStoredTimestep ( )
inherited

Set the timestep that is stored in the action to the correct value.

◆ runFinalJobs()

virtual void PLMD::Action::runFinalJobs ( )
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.

◆ setOption()

void PLMD::Action::setOption ( const std::string &  s)
virtualinherited

◆ setupConstantValues()

void PLMD::Action::setupConstantValues ( const bool &  have_atoms)
inherited

This calculates any values that are constant and ensures that we don't calculate these actions on every timestep.

◆ unlockRequests()

virtual void PLMD::Action::unlockRequests ( )
inlinevirtualinherited

◆ update()

virtual void PLMD::Action::update ( )
inlinevirtualinherited

◆ usingNaturalUnits()

bool PLMD::Action::usingNaturalUnits ( ) const
protectedinherited

Are we using natural units.

◆ warning()

void PLMD::Action::warning ( const std::string &  msg)
inherited

Issue a warning.

◆ writeInGraph()

std::string PLMD::Action::writeInGraph ( ) const
virtualinherited

Member Data Documentation

◆ active

bool PLMD::Action::active
privateinherited

Switch to activate Action on this step.

◆ after

Dependencies PLMD::Action::after
privateinherited

Actions on which this Action depends.

◆ comm

Communicator& PLMD::Action::comm
inherited

◆ defaults

std::string PLMD::Action::defaults
privateinherited

The set of default arguments that we are using.

◆ doCheckPoint

bool PLMD::Action::doCheckPoint
privateinherited

◆ files

std::set<FILE*> PLMD::Action::files
inherited

◆ keywords

const Keywords& PLMD::Action::keywords
inherited

◆ label

std::string PLMD::Action::label
privateinherited

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

◆ line

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

Directive line.

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

◆ log

Log& PLMD::Action::log
inherited

Reference to the log stream.

◆ multi_sim_comm

Communicator& PLMD::Action::multi_sim_comm
inherited

◆ name

const std::string PLMD::Action::name
privateinherited

Name of the directive in the plumed.dat file.

◆ never_activate

bool PLMD::Action::never_activate
privateinherited

◆ options

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

Option that you might have enabled.

◆ plumed

PlumedMain& PLMD::Action::plumed
inherited

Reference to main plumed object.

◆ replica_index

int PLMD::Action::replica_index
privateinherited

◆ restart

bool PLMD::Action::restart
privateinherited

◆ savedInputLines

std::vector<std::string> PLMD::ActionShortcut::savedInputLines
privateinherited

◆ savedOutputs

std::vector<std::string> PLMD::ActionShortcut::savedOutputs
privateinherited

◆ shortcutlabel

std::string PLMD::ActionShortcut::shortcutlabel
privateinherited

◆ timestep

double PLMD::Action::timestep
privateinherited

Save the timestep here.

◆ update_from

double PLMD::Action::update_from
privateinherited

Update only after this time.

◆ update_until

double PLMD::Action::update_until
privateinherited

Update only until this time.


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