Merge release-5-0 into master
[alexxy/gromacs.git] / src / gromacs / legacyheaders / constr.h
index 12c476df74c1200926f564665eaf5efab8e8e8c5..304c07b35b593ad6112381eb13a729077d7dfe7a 100644 (file)
@@ -141,6 +141,7 @@ gmx_bool constrain(FILE *log, gmx_bool bLog, gmx_bool bEner,
                    gmx_ekindata_t *ekind,
                    t_commrec *cr,
                    gmx_int64_t step, int delta_step,
+                   real step_scaling,
                    t_mdatoms *md,
                    rvec *x, rvec *xprime, rvec *min_proj,
                    gmx_bool bMolPBC, matrix box,
@@ -165,6 +166,11 @@ gmx_bool constrain(FILE *log, gmx_bool bLog, gmx_bool bEner,
  * step + delta_step is the step at which the final configuration
  * is meant to be; for update delta_step = 1.
  *
+ * step_scaling can be used to update coordinates based on the time
+ * step multiplied by this factor. Thus, normally 1.0 is passed. The
+ * SD1 integrator uses 0.5 in one of its calls, to correct positions
+ * for half a step of changed velocities.
+ *
  * If v!=NULL also constrain v by adding the constraint corrections / dt.
  *
  * If vir!=NULL calculate the constraint virial.