CustomTuner¶

class hoomd.tune.CustomTuner(trigger, action)¶

Bases: CustomOperation, Tuner

User-defined tuner.

Parameters:

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

CustomTuner is a hoomd.operation.Tuner 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.

Tuners modify the parameters of other operations to improve performance. Tuners may read the system state, but not modify it.

Example:

custom_tuner = hoomd.tune.CustomTuner(
    action=custom_action,
    trigger=hoomd.trigger.Periodic(1000),
)
simulation.operations.tuners.append(custom_tuner)