Sphere

final class Sphere

Bases: _VolumeEntityBase

Sphere in three-dimensional space.

Example

>>> Sphere(
...     name="sphere_zone",
...     center=(0, 0, 0) * unyt.m,
...     radius=1.5 * unyt.m,
...     axis=(0, 0, 1),
... )

Attributes

center: Length.Vector3

The center point of the sphere.

radius: Length.PositiveFloat64

The radius of the sphere.

axis: Axis

The axis of rotation for the sphere (used in sliding interfaces).

Default:

(0, 0, 1)

Properties

id: str

Returns private_attribute_id of the entity.