hoomd.util¶
Overview
Make an example Simulation object. |
Details
Utilities.
- hoomd.util.make_example_simulation(device=None, dimensions=3, particle_types=['A'])¶
Make an example Simulation object.
The simulation state contains two particles at positions (-1, 0, 0) and (1, 0, 0).
- Parameters:
device (hoomd.device.Device) – The device to use. Create a
hoomd.device.CPU
whenNone
.dimensions (int) – Number of dimensions (2 or 3).
- Returns:
The simulation object.
- Return type:
Note
make_example_simulation
is intended for use in the documentation and other minimal working examples. Usehoomd.Simulation
directly in other cases.Example:
simulation = hoomd.util.make_example_simulation()