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)

See also

The base class hoomd.custom.CustomOperation.

hoomd.tune.CustomTuner

hoomd.write.CustomWriter

Members inherited from AutotunedObject:

property kernel_parameters¶: Kernel parameters. Read more...

property is_tuning_complete¶: Check if kernel parameter tuning is complete. Read more...

tune_kernel_parameters()¶: Start tuning kernel parameters. Read more...

Members inherited from TriggeredOperation:

trigger¶: The trigger to activate this operation. Read more...

Members inherited from CustomOperation:

act()¶: Perform the action of the custom action if attached Read more...

property action¶: Action that this operation wraps. Read more...