CustomUpdater¶

class hoomd.update.CustomUpdater(trigger, action)¶

Bases: CustomOperation, Updater

User-defined updater.

Parameters:

action (hoomd.custom.Action) – The action to call.
trigger (hoomd.trigger.trigger_like) – Select the timesteps to call the action.

CustomUpdater is a hoomd.operation.Updater that wraps a user-defined hoomd.custom.Action object so the action can be added to a hoomd.Operations instance for use with hoomd.Simulation objects.

Updaters modify the system state.

Example:

custom_updater = hoomd.update.CustomUpdater(
    action=custom_action,
    trigger=hoomd.trigger.Periodic(1000),
)
simulation.operations.updaters.append(custom_updater)