Cylinder

final class Cylinder

Bases: _VolumeEntityBase

Cylinder class represents a cylinder in three-dimensional space.

Example

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

---

Attributes

name: str

axis: Axis

The axis of the cylinder.

center: LengthType.Vector

The center point of the cylinder.

height: LengthType.Positive

The height of the cylinder.

inner_radius: LengthType.NonNegative, optional

The inner radius of the cylinder.

Default:

0 * m

outer_radius: LengthType.Positive

The outer radius of the cylinder.

Properties

id: str

Returns private_attribute_id of the entity.

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')