Skip to content
Snippets Groups Projects
Commit bc8f90af authored by Giovanni Bussi's avatar Giovanni Bussi
Browse files

Added doc

parent 48187cbf
No related branches found
No related tags found
No related merge requests found
......@@ -212,6 +212,9 @@ plumed_cmd(plumedmain,"setKbT",&kbT); // Pointer to a r
// This is valid only if API VERSION > 2
plumed_cmd(plumedmain,"setRestart",&res); // Pointer to an integer saying if we are restarting (zero means no, one means yes)
// This is valid only if API VERSION > 3
plumed_cmd(plumedmain,"readInputLine","d: DISTANCE ATOMS=1,2");// Read a single input line directly from a string
// Calls to do the actual initialization (all the above commands must appear before this call)
plumed_cmd(plumedmain,"init",NULL); // Do all the initialization of plumed
plumed_cmd(plumedmain,"read",read); // Read the plumed input. N.B. This is called during init and so this call is only required in special cases.
......@@ -257,6 +260,12 @@ plumed_cmd(plumedmain,"calc",NULL); // Calculate and ap
// One can break up the "calc" command in two parts:
plumed_cmd(plumedmain,"prepareCalc",NULL); // Prepare to do a calculation by requesting all the atomic positions from the MD code
plumed_cmd(plumedmain,"performCalc",NULL); // Use the atomic positions collected during prepareCalc phase to calculate colvars and biases.
// The "performCalc" step can be further split into:
// This is valid only if API VERSION > 3
plumed_cmd(plumedmain,"performCalcNoUpdate",NULL); // Same as "performCalc", skipping the update phase. Could be called multiple time per step
// This is valid only if API VERSION > 3
plumed_cmd(plumedmain,"update",NULL); // Only performs the update phase. Should be called once per step
// After the first part it will be possible to ask PLUMED e.g. if the energy is required with
plumed_cmd(plumedmain,"isEnergyNeeded,&flag); // assuming flag is an int, that will be set to 0 if energy is not needed and 1 if it is needed
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment