Provides the keyword TD_CHI More...
Public Types | |
typedef std::vector< Action * > | Dependencies |
Public Member Functions | |
TD_Chi (const ActionOptions &ao) | |
virtual void | activate () |
Set action to active. More... | |
void | addDependency (Action *) |
Specify that this Action depends on another one. More... | |
void | allowBiasCutoff () |
void | apply () override |
Apply an Action. More... | |
virtual void | beforeUpdate () |
Before Update. More... | |
bool | biasCutoffActive () const |
bool | biasGridNeeded () const |
bool | biasWithoutCutoffGridNeeded () const |
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 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... | |
void | clearLogTargetDistGrid () |
virtual void | clearOptions () |
virtual void | deactivate () |
Set action to inactive. More... | |
void | doNotAllowBiasCutoff () |
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... | |
bool | fesGridNeeded () const |
void | fflush () |
Tell to the Action to flush open files. More... | |
FILE * | fopen (const char *path, const char *mode) |
Opens a file. More... | |
bool | forcedNormalization () const |
bool | getCPT () const |
Return true if we are doing at a checkpoint step. More... | |
const Dependencies & | getDependencies () const |
Return dependencies. More... | |
unsigned | getDimension () const |
virtual std::string | getDocumentation () const |
bool | getExchangeStep () const |
Check if we are on an exchange step. 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... | |
Grid * | getLogTargetDistGridPntr () const |
Grid | getMarginal (const std::vector< std::string > &) |
const std::string & | getName () const |
Returns the name. More... | |
bool | getRestart () const |
Return true if we are doing a restart. More... | |
long int | getStep () const |
Return the present timestep. More... | |
Grid * | getTargetDistGridPntr () const |
double | getTime () const |
Return the present time. More... | |
double | getTimeStep () const |
Return the timestep. More... | |
double | getValue (const std::vector< double > &) const override |
bool | isActive () const |
Check if action is active. More... | |
bool | isBiasCutoffAllowed () const |
bool | isDynamic () const |
bool | isOptionOn (const std::string &s) const |
Check if an option is on. More... | |
bool | isStatic () const |
bool | isTargetDistGridShiftedToZero () const |
virtual void | linkAction (Action *) |
virtual void | linkBiasGrid (Grid *) |
virtual void | linkBiasWithoutCutoffGrid (Grid *) |
virtual void | linkFesGrid (Grid *) |
virtual void | linkVesBias (VesBias *) |
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 | readInRestartTargetDistGrid (const std::string &) |
virtual void | runFinalJobs () |
RunFinalJobs This method is called once at the very end of the calculation. More... | |
void | setDimension (const unsigned int dimension) |
virtual void | setOption (const std::string &s) |
void | setupBiasCutoff () |
void | setupGrids (const std::vector< Value * > &, const std::vector< std::string > &, const std::vector< std::string > &, const std::vector< unsigned int > &) |
virtual void | unlockRequests () |
void | update () override |
Update. More... | |
void | updateTargetDist () |
void | warning (const std::string &msg) |
Issue a warning. More... | |
Static Public Member Functions | |
static Grid | getMarginalDistributionGrid (Grid *, const std::vector< std::string > &) |
static double | integrateGrid (const Grid *) |
static double | normalizeGrid (Grid *) |
static void | registerKeywords (Keywords &) |
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 | |
void | applyTargetDistModiferToGrid (TargetDistModifer *modifer_pntr) |
double | getBeta () const |
Grid * | getBiasGridPntr () const |
Grid * | getBiasWithoutCutoffGridPntr () const |
Grid * | getFesGridPntr () const |
Action * | getPntrToAction () const |
VesBias * | getPntrToVesBias () const |
Grid & | logTargetDistGrid () const |
void | normalizeTargetDistGrid () |
void | setBiasGridNeeded () |
void | setBiasWithoutCutoffGridNeeded () |
void | setDynamic () |
void | setFesGridNeeded () |
void | setForcedNormalization () |
void | setMinimumOfTargetDistGridToZero () |
void | setStatic () |
virtual void | setupAdditionalGrids (const std::vector< Value * > &, const std::vector< std::string > &, const std::vector< std::string > &, const std::vector< unsigned int > &) |
Grid & | targetDistGrid () const |
void | unsetForcedNormalization () |
virtual void | updateGrid () |
void | updateLogTargetDistGrid () |
Private Types | |
enum | TargetDistType { static_targetdist, dynamic_targetdist } |
Private Member Functions | |
void | calculateStaticDistributionGrid () |
void | checkNanAndInf () |
void | updateBiasCutoffForTargetDistGrid () |
Private Attributes | |
Action * | action_pntr_ |
bool | active |
Switch to activate Action on this step. More... | |
Dependencies | after |
Actions on which this Action depends. More... | |
bool | allow_bias_cutoff_ |
bool | bias_cutoff_active_ |
Grid * | bias_grid_pntr_ |
Grid * | bias_withoutcutoff_grid_pntr_ |
bool | check_nan_inf_ |
bool | check_nonnegative_ |
bool | check_normalization_ |
unsigned int | dimension_ |
bool | doCheckPoint |
Grid * | fes_grid_pntr_ |
bool | force_normalization_ |
std::vector< Value * > | grid_args_ |
std::vector< double > | kappa_ |
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... | |
std::unique_ptr< Grid > | log_targetdist_grid_pntr_ |
std::vector< double > | minima_ |
const std::string | name |
Name of the directive in the plumed.dat file. More... | |
bool | needs_bias_grid_ |
bool | needs_bias_withoutcutoff_grid_ |
bool | needs_fes_grid_ |
std::vector< double > | normalization_ |
std::set< std::string > | options |
Option that you might have enabled. More... | |
int | replica_index |
bool | restart |
bool | shift_targetdist_to_zero_ |
std::vector< double > | sigma_ |
bool | static_grid_calculated |
std::unique_ptr< Grid > | targetdist_grid_pntr_ |
std::vector< std::unique_ptr< TargetDistModifer > > | targetdist_modifer_pntrs_ |
enum PLMD::ves::TargetDistribution::TargetDistType | type_ |
double | update_from |
Update only after this time. More... | |
double | update_until |
Update only until this time. More... | |
VesBias * | vesbias_pntr_ |
Provides the keyword TD_CHI
|
inherited |
|
privateinherited |
|
explicit |
|
virtualinherited |
Set action to active.
|
inherited |
Specify that this Action depends on another one.
|
inlineinherited |
|
inlineoverridevirtualinherited |
Apply an Action.
This method is called one time per step. The set of all Actions is applied in backward order.
Implements PLMD::Action.
|
protectedinherited |
|
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.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineoverridevirtualinherited |
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::vesselbase::ActionWithAveraging, PLMD::multicolvar::DumpMultiColvar, PLMD::ActionAtomistic, PLMD::multicolvar::MultiColvarBase, PLMD::analysis::AnalysisBase, PLMD::ActionWithArguments, PLMD::mapping::Mapping, PLMD::multicolvar::BridgedMultiColvarFunction, PLMD::vesselbase::ActionWithInputVessel, PLMD::isdb::EMMI, PLMD::isdb::MetainferenceBase, and PLMD::mapping::PCAVars.
|
privateinherited |
|
privateinherited |
|
inlinevirtualinherited |
Check if the action needs gradient.
Reimplemented in PLMD::bias::MetaD, PLMD::bias::PBMetaD, 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.
|
inherited |
|
virtualinherited |
|
inlinevirtualinherited |
Set action to inactive.
|
inlineinherited |
|
inherited |
Crash calculation and print documentation.
|
inherited |
Exit with error code c.
|
inherited |
Closes a file opened with Action::fclose().
|
inlineinherited |
|
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 |
|
protectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inherited |
Return true if we are doing at a checkpoint step.
|
inlineinherited |
Return dependencies.
|
inlineinherited |
|
virtualinherited |
|
inherited |
Check if we are on an exchange step.
|
inlineprotectedinherited |
|
inherited |
Just read one of the keywords and return the whole thing as a string.
|
inlineinherited |
Returns the label.
|
inlineinherited |
|
inherited |
|
staticinherited |
|
inlineinherited |
Returns the name.
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineinherited |
Return true if we are doing a restart.
|
inherited |
Return the present timestep.
|
inlineinherited |
|
inherited |
Return the present time.
|
inherited |
Return the timestep.
|
overridevirtual |
Implements PLMD::ves::TargetDistribution.
|
staticinherited |
|
inlineinherited |
Check if action is active.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
Check if an option is on.
|
inlineinherited |
|
inlineinherited |
|
virtualinherited |
Reimplemented in PLMD::ves::TD_LinearCombination, PLMD::ves::TD_ProductCombination, and PLMD::ves::TD_ProductDistribution.
|
virtualinherited |
Reimplemented in PLMD::ves::TD_LinearCombination, PLMD::ves::TD_ProductCombination, and PLMD::ves::TD_ProductDistribution.
|
virtualinherited |
Reimplemented in PLMD::ves::TD_LinearCombination, PLMD::ves::TD_ProductCombination, and PLMD::ves::TD_ProductDistribution.
|
virtualinherited |
Reimplemented in PLMD::ves::TD_LinearCombination, PLMD::ves::TD_ProductCombination, and PLMD::ves::TD_ProductDistribution.
|
virtualinherited |
Reimplemented in PLMD::ves::TD_LinearCombination, PLMD::ves::TD_ProductCombination, and PLMD::ves::TD_ProductDistribution.
|
inlinevirtualinherited |
|
inlineprotectedinherited |
|
staticinherited |
|
inlineprotectedinherited |
|
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.
|
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::isdb::EMMI, PLMD::function::FuncPathMSD, PLMD::generic::Plumed, PLMD::multicolvar::MultiColvarBase, PLMD::generic::Read, PLMD::generic::DumpMassCharge, PLMD::generic::UpdateIf, PLMD::generic::Print, PLMD::GenericMolInfo, PLMD::gridtools::ConvertToFES, PLMD::colvar::Energy, PLMD::colvar::ExtraCV, PLMD::colvar::CoordinationBase, PLMD::function::FuncPathGeneral, PLMD::maze::Optimizer, and PLMD::s2cm::S2ContactModel.
|
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.
|
inherited |
|
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.
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
protectedinherited |
|
virtualinherited |
|
inlineprotectedinherited |
|
inlineprotectedvirtualinherited |
|
inherited |
|
inherited |
|
inlineprotectedinherited |
|
inlinevirtualinherited |
|
inlineprotectedinherited |
|
inlineoverridevirtualinherited |
Update.
This method is called one time per step. The set of all Actions is updated in forward order.
Reimplemented from PLMD::Action.
|
privateinherited |
|
inlineprotectedvirtualinherited |
|
protectedinherited |
|
inherited |
|
inherited |
Issue a warning.
|
privateinherited |
|
privateinherited |
Switch to activate Action on this step.
|
privateinherited |
Actions on which this Action depends.
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
inherited |
|
privateinherited |
|
privateinherited |
|
private |
|
inherited |
|
privateinherited |
Label of the Action, as set with LABEL= in the plumed.dat file.
|
privateinherited |
Directive line.
This line is progressively erased during Action construction so as to check if all the present keywords are correct.
|
inherited |
Reference to the log stream.
|
privateinherited |
|
private |
|
inherited |
|
privateinherited |
Name of the directive in the plumed.dat file.
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
private |
|
privateinherited |
Option that you might have enabled.
|
inherited |
Reference to main plumed object.
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
private |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
|
privateinherited |
Update only after this time.
|
privateinherited |
Update only until this time.
|
privateinherited |
Hosted by GitHub | 1.8.17 |