flow360.Cylinder

flow360.Cylinder#

class Cylinder[source]#

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,
... )
axis: Axis [Required]#

The axis of the cylinder.

center: Annotated[_VectorType, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]#

The center point of the cylinder.

Constraints:

  • func = <function _dimensioned_type_serializer at 0x79c44aad7130>

  • return_type = PydanticUndefined

  • when_used = always

height: Annotated[_Constrained, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]#

The height of the cylinder.

Constraints:

  • func = <function _dimensioned_type_serializer at 0x79c44aad7130>

  • return_type = PydanticUndefined

  • when_used = always

inner_radius: Annotated[_Constrained, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] | None = unyt_quantity(0, 'm')#

The inner radius of the cylinder.

outer_radius: Annotated[_Constrained, PlainSerializer(func=_dimensioned_type_serializer, return_type=PydanticUndefined, when_used=always)] [Required]#

The outer radius of the cylinder.

Constraints:

  • func = <function _dimensioned_type_serializer at 0x79c44aad7130>

  • return_type = PydanticUndefined

  • when_used = always