diff --git a/doc/fix_adapt.html b/doc/fix_adapt.html index 432851d4d7..52a01fae6c 100644 --- a/doc/fix_adapt.html +++ b/doc/fix_adapt.html @@ -87,8 +87,10 @@ set to will be whatever the variable generates. If the scale keyword is set to yes, then the value of the altered parameter will be the initial value of that parameter multiplied by whatever the variable generates. I.e. the variable is now a "scale factor" applied -in (presumably) a time-varying fashion to the parameter. Internally, -the parameters themselves are actually altered; make sure you use the +in (presumably) a time-varying fashion to the parameter. +
+Note that whether scale is no or yes, internally, the parameters +themselves are actually altered by this fix. Make sure you use the reset yes option if you want the parameters to be restored to their initial values after the run.
@@ -215,6 +217,10 @@ discussion above describing the formulas associated with equal-style variables. The new value is assigned to the corresponding attribute for all atoms in the fix group. +IMPORTANT NOTE: The atom keyword works this way whether the scale +keyword is set to no or yes. I.e. the use of scale yes is not yet +supported by the atom keyword. +
If the atom parameter is diameter and per-atom density and per-atom mass are defined for particles (e.g. atom_style granular), then the mass of each particle is also diff --git a/doc/fix_adapt.txt b/doc/fix_adapt.txt index 959aaeb5d6..11b34e79ee 100644 --- a/doc/fix_adapt.txt +++ b/doc/fix_adapt.txt @@ -75,8 +75,10 @@ set to will be whatever the variable generates. If the {scale} keyword is set to {yes}, then the value of the altered parameter will be the initial value of that parameter multiplied by whatever the variable generates. I.e. the variable is now a "scale factor" applied -in (presumably) a time-varying fashion to the parameter. Internally, -the parameters themselves are actually altered; make sure you use the +in (presumably) a time-varying fashion to the parameter. + +Note that whether scale is {no} or {yes}, internally, the parameters +themselves are actually altered by this fix. Make sure you use the {reset yes} option if you want the parameters to be restored to their initial values after the run. @@ -201,6 +203,10 @@ discussion above describing the formulas associated with equal-style variables. The new value is assigned to the corresponding attribute for all atoms in the fix group. +IMPORTANT NOTE: The {atom} keyword works this way whether the {scale} +keyword is set to {no} or {yes}. I.e. the use of scale yes is not yet +supported by the {atom} keyword. + If the atom parameter is {diameter} and per-atom density and per-atom mass are defined for particles (e.g. "atom_style granular"_atom_style.html), then the mass of each particle is also