University of Michigan Logo
mode_standard Class Reference

Enables a variety of standard integration methods. More...

Public Member Functions

def __init__ (self, dt, aniso=None)
 Specifies the standard integration mode. More...
def set_params (self, dt=None, aniso=None)
 Changes parameters of an existing integration mode. More...

Detailed Description

Enables a variety of standard integration methods.

integrate.mode_standard performs a standard time step integration technique to move the system forward. At each time step, all of the specified forces are evaluated and used in moving the system forward to the next step.

By itself, integrate.mode_standard does nothing. You must specify one or more integration methods to apply to the system. Each integration method can be applied to only a specific group of particles enabling advanced simulation techniques.

The following commands can be used to specify the integration methods used by integrate.mode_standard.

There can only be one integration mode active at a time. If there are more than one integrate.mode_* commands in a hoomd script, only the most recent before a given run() will take effect.

MPI Support
This command works in MPI parallel jobs.

Constructor & Destructor Documentation

def __init__ (   self,
  aniso = None 

Specifies the standard integration mode.

dtEach time step of the simulation run() will advance the real time of the system forward by dt (in time units)
anisoWhether to integrate rotational degrees of freedom (bool), default None (autodetect)


1 integrate.mode_standard(dt=0.005)
2 integrator_mode = integrate.mode_standard(dt=0.001)

Member Function Documentation

def set_params (   self,
  dt = None,
  aniso = None 

Changes parameters of an existing integration mode.

dtNew time step delta (if set) (in time units)
anisoAnisotropic integration mode (bool), default None (autodetect)

To change the parameters of an existing integration mode, you must save it in a variable when it is specified, like so:

1 integrator_mode = integrate.mode_standard(dt=5e-3)


1 integrator_mode.set_params(dt=0.007)
2 integrator_mode.set_params(dt=0.005, aniso=False)