Cylinder

final class Cylinder

Bases: _VolumeEntityBase

Cylinder in three-dimensional space.

Example

>>> Cylinder(
...     name="bet_disk_volume",
...     center=(0, 0, 0) * unyt.inch,
...     axis=(0, 0, 1),
...     outer_radius=150 * unyt.inch,
...     height=15 * unyt.inch,
... )

Attributes

axis: Axis

The axis of the cylinder.

center: Any

The center point of the cylinder.

height: Any

The height of the cylinder.

inner_radius: Any, optional

The inner radius of the cylinder.

Default:

0 * fl.u.m

outer_radius: Any

The outer radius of the cylinder.

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:

• filename (str)

• kwargs (Any)

Return type:

None