CustomWriter¶

class hoomd.write.CustomWriter(trigger, action)¶

Bases: CustomOperation, Writer

User-defined writer.

Parameters:

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

CustomWriter is a hoomd.operation.Writer 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.

Writers may read the system state and generate output files or print to output streams. Writers should not modify the system state.

Example:

custom_writer = hoomd.write.CustomWriter(
    action=custom_action,
    trigger=hoomd.trigger.Periodic(1000),
)
simulation.operations.writers.append(custom_writer)