hoomd.operation
Overview
Base class for all HOOMD computes. |
|
Represents operations that are added to an |
|
Base class for all HOOMD tuners. |
|
Base class for all HOOMD updaters. |
|
Base class for all HOOMD analyzers. |
Details
Base classes for all HOOMD-blue operations.
- class hoomd.operation.Operation
Represents operations that are added to an
hoomd.Operations
object.Operations in the HOOMD-blue data scheme are objects that operate on a
hoomd.Simulation
object. They broadly consist of 5 subclasses:Updater
,Writer
,Compute
,Tuner
, andhoomd.integrate.BaseIntegrator
. All HOOMD-blue operations inherit from one of these five base classes. To find the purpose of each class see its documentation.Note
Developers or those contributing to HOOMD-blue, see our architecture file for information on HOOMD-blue’s architecture decisions regarding operations.
- __dir__()
Expose all attributes for dynamic querying in notebooks and IDEs.
- class hoomd.operation.Compute
Base class for all HOOMD computes.
A compute is an operation which computes some property for another operation or use by a user.
Note
This class should not be instantiated by users. The class can be used for
isinstance
orissubclass
checks.
- class hoomd.operation.Tuner
Base class for all HOOMD tuners.
A tuner is an operation which tunes the parameters of another operation for performance or other reasons. A tuner does not modify the current microstate of the simulation. That is a tuner does not change quantities like temperature, particle position, or the number of bonds in a simulation.
Note
This class should not be instantiated by users. The class can be used for
isinstance
orissubclass
checks.
- class hoomd.operation.Updater(trigger)
Base class for all HOOMD updaters.
An updater is an operation which modifies a simulation’s state.
Note
This class should not be instantiated by users. The class can be used for
isinstance
orissubclass
checks.
- class hoomd.operation.Writer(trigger)
Base class for all HOOMD analyzers.
An analyzer is an operation which writes out a simulation’s state.
Note
This class should not be instantiated by users. The class can be used for
isinstance
orissubclass
checks.