Sphere

Sphere#

final class Sphere[source]#

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: Any#

The center point of the sphere.

radius: Any#

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.

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None