scale value = no or yesno = the variable value is the new setting
yes = the variable value multiplies the original setting
reset value = no or yesno = values will remain altered at the end of a run
yes = reset altered values to their original values at the end of a run

Description

Change or adapt one or more specific simulation attributes or settings
over time as a simulation runs. Pair potential and K-space and atom
attributes which can be varied by this fix are discussed below. Many
other fixes can also be used to time-vary simulation parameters,
e.g. the “fix deform” command will change the simulation box
size/shape and the “fix move” command will change atom positions and
velocities in a prescribed manner. Also note that many commands allow
variables as arguments for specific parameters, if described in that
manner on their doc pages. An equal-style variable can calculate a
time-dependent quantity, so this is another way to vary a simulation
parameter over time.

If N is specified as 0, the specified attributes are only changed
once, before the simulation begins. This is all that is needed if the
associated variables are not time-dependent. If N > 0, then changes
are made every N steps during the simulation, presumably with a
variable that is time-dependent.

Depending on the value of the reset keyword, attributes changed by
this fix will or will not be reset back to their original values at
the end of a simulation. Even if reset is specified as yes, a
restart file written during a simulation will contain the modified
settings.

If the scale keyword is set to no, then the value the parameter is
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.

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.

The pair keyword enables various parameters of potentials defined by
the pair_style command to be changed, if the pair
style supports it. Note that the pair_style and
pair_coeff commands must be used in the usual manner
to specify these parameters initially; the fix adapt command simply
overrides the parameters.

The pstyle argument is the name of the pair style. If pair_style hybrid or hybrid/overlay is used, pstyle should be
a sub-style name. If there are multiple sub-styles using the same
pair style, then pstyle should be specified as “style:N” where N is
which instance of the pair style you wish to adapt, e.g. the first,
second, etc. For example, pstyle could be specified as “soft” or
“lubricate” or “lj/cut:1” or “lj/cut:2”. The pparam argument is the
name of the parameter to change. This is the current list of pair
styles and parameters that can be varied by this fix. See the doc
pages for individual pair styles and their energy formulas for the
meaning of these parameters:

It is easy to add new pairwise potentials and their parameters
to this list. All it typically takes is adding an extract() method to
the pair_*.cpp file associated with the potential.

Some parameters are global settings for the pair style, e.g. the
viscosity setting “mu” for pair_style lubricate.
For pair_kim, all free parameters supported by the
KIM Model are available (e.g., PARAM_FREE_sigmas provided by the
LennardJones612_Universal__MO_826355984548_001 Model). If the free
parameter corresponds to an array, then the particular array element
to be adapted must be specified (e.g., “PARAM_FREE_sigmas:10”, to
adapt the tenth entry of the sigmas array).
Other parameters apply to atom type pairs within the pair style,
e.g. the prefactor “a” for pair_style soft.

Note that for many of the potentials, the parameter that can be varied
is effectively a prefactor on the entire energy expression for the
potential, e.g. the lj/cut epsilon. The parameters listed as “scale”
are exactly that, since the energy expression for the
coul/cut potential (for example) has no labeled
prefactor in its formula. To apply an effective prefactor to some
potentials, multiple parameters need to be altered. For example, the
Buckingham potential needs both the A and C terms
altered together. To scale the Buckingham potential, you should thus
list the pair style twice, once for A and once for C.

If a type pair parameter is specified, the I and J settings should
be specified to indicate which type pairs to apply it to. If a global
parameter is specified, the I and J settings still need to be
specified, but are ignored.

Similar to the pair_coeff command, I and J can be
specified in one of two ways. Explicit numeric values can be used for
each, as in the 1st example above. I <= J is required. LAMMPS sets
the coefficients for the symmetric J,I interaction to the same values.

A wild-card asterisk can be used in place of or in conjunction with
the I,J arguments to set the coefficients for multiple pairs of atom
types. This takes the form “*” or “*n” or “n*” or “m*n”. If N = the
number of atom types, then an asterisk with no numeric values means
all types from 1 to N. A leading asterisk means all types from 1 to n
(inclusive). A trailing asterisk means all types from n to N
(inclusive). A middle asterisk means all types from m to n
(inclusive). Note that only type pairs with I <= J are considered; if
asterisks imply type pairs where J < I, they are ignored.

IMPROTANT NOTE: If pair_style hybrid or hybrid/overlay is being used, then the pstyle will
be a sub-style name. You must specify I,J arguments that correspond
to type pair values defined (via the pair_coeff
command) for that sub-style.

The v_name argument for keyword pair is the name of an
equal-style variable which will be evaluated each time
this fix is invoked to set the parameter to a new value. It should be
specified as v_name, where name is the variable name. Equal-style
variables can specify formulas with various mathematical functions,
and include thermo_style command keywords for the
simulation box parameters and timestep and elapsed time. Thus it is
easy to specify parameters that change as a function of time or span
consecutive runs in a continuous fashion. For the latter, see the
start and stop keywords of the run command and the
elaplong keyword of thermo_style custom for
details.

For example, these commands would change the prefactor coefficient of
the pair_style soft potential from 10.0 to 30.0 in a
linear fashion over the course of a simulation:

The bond keyword uses the specified variable to change the value of
a bond coefficient over time, very similar to how the pair keyword
operates. The only difference is that now a bond coefficient for a
given bond type is adapted.

Currently bond does not support bond_style hybrid nor bond_style
hybrid/overlay as bond styles. The only bonds that currently are
working with fix_adapt are

The kspace keyword used the specified variable as a scale factor on
the energy, forces, virial calculated by whatever K-Space solver is
defined by the kspace_style command. If the
variable has a value of 1.0, then the solver is unaltered.

The kspace keyword works this way whether the scale keyword
is set to no or yes.

The atom keyword enables various atom properties to be changed. The
aparam argument is the name of the parameter to change. This is the
current list of atom parameters that can be varied by this fix:

charge = charge on particle

diameter = diameter of particle

The v_name argument of the atom keyword is the name of an
equal-style variable which will be evaluated each time
this fix is invoked to set the parameter to a new value. It should be
specified as v_name, where name is the variable name. See the
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.

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
changed when the diameter changes (density is assumed to stay
constant).

For example, these commands would shrink the diameter of all granular
particles in the “center” group from 1.0 to 0.1 in a linear fashion
over the course of a 1000-step simulation:

variablesizeequalramp(1.0,0.1)fix1centeradapt10atomdiameterv_size

Restart, fix_modify, output, run start/stop, minimize info:

No information about this fix is written to binary restart files. None of the fix_modify options
are relevant to this fix. No global or per-atom quantities are stored
by this fix for access by various output commands. No parameter of this fix can
be used with the start/stop keywords of the run command.
This fix is not invoked during energy minimization.