CustomOperation

class hoomd.custom.CustomOperation(trigger, action)

Bases: TriggeredOperation

User defined operation.

This is the parent class for hoomd.tune.CustomTuner, hoomd.update.CustomUpdater. and hoomd.write.CustomWriter. These classes wrap Python objects that inherit from hoomd.custom.Action so they can be added to the simulation operations.

This class also implements a “pass-through” system for attributes. Attributes and methods from the passed in action will be available directly in this class. This does not apply to attributes with these names: trigger, _action, and action.

Note

Due to the pass through no attribute should exist both in hoomd.custom.CustomOperation and the hoomd.custom.Action.

Note

This object should not be instantiated or subclassed by an user.

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 defined in CustomOperation:

__getattr__(attr)

Pass through attributes/methods of the wrapped object.

__setstate__(state)

Set object state from pickling or deepcopying.

act(timestep)

Perform the action of the custom action if attached.

Calls through to the action property of the instance.

Parameters:

timestep (int) – The current timestep of the state.

property action

Action that this operation wraps.

Type:

hoomd.custom.Action