hoomd.box

Overview

BoxInterface

The class interface which HOOMD considers to be a box-like object.

box_like

Objects that are or can be converted to Box.

Details

Implement Box.

class hoomd.box.BoxInterface

The class interface which HOOMD considers to be a box-like object.

Note

This class is exclusively used for help with typing and documentation in HOOMD, and is not meant to be used.

hoomd.box.box_like

Objects that are or can be converted to Box.

This includes

  • hoomd.Box objects.

  • Objects with attributes Lx, Ly, Lz, xy, xz, yz.

  • Lists like [Lx, Ly, Lz, xy, xz, yz].

  • Dictionaries with keys 'Lx', 'Ly', 'Lz', 'xy', 'xz', 'yz'.

  • 3x3 NumPy arrays or objects convertible to a 3x3 array (see hoomd.Box.from_matrix).

Note

If any of Lz, xy, xz, yz for these different types are not provided, they are considered 0.

alias of Union[Box, BoxInterface, Sequence[float], Mapping[str, float], ndarray]