flow360.RotationCylinder#

class RotationCylinder[source]#

Bases: RotationVolume

Deprecated since version Use: RotationVolume instead. This class is maintained for backward compatibility but will be removed in a future version.

RotationCylinder creates a rotation volume mesh using cylindrical entities.

  • The mesh on RotationCylinder is guaranteed to be concentric.

  • The RotationCylinder is designed to enclose other objects, but it can’t intersect with other objects.

  • Users could create a donut-shape RotationCylinder and put their stationary centerbody in the middle.

  • This type of volume zone can be used to generate volume zone compatible with Rotation model.

Note

RotationVolume now supports both Cylinder and AxisymmetricBody entities. Please migrate to using RotationVolume directly.

Example

>>> fl.RotationCylinder(
...     name="RotationCylinder",
...     spacing_axial=0.5*fl.u.m,
...     spacing_circumferential=0.3*fl.u.m,
...     spacing_radial=1.5*fl.u.m,
...     entities=cylinder
... )
type: Literal['RotationCylinder'] = 'RotationCylinder'#
entities: EntityList[Cylinder] [Required]#
name: str | None = 'Rotation Volume'#

Name to display in the GUI.

enclosed_entities: EntityList[Cylinder, Surface, AxisymmetricBody, Box] | None = None#

Entities enclosed by RotationVolume. Can be Surface and/or other :class:`~flow360.Cylinder`(s)and/or other :class:`~flow360.AxisymmetricBody`(s)and/or other :class:`~flow360.Box`(s)

spacing_axial: LengthType.Positive [Required]#

Spacing along the axial direction.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x79301f934ee0>

  • return_type = PydanticUndefined

  • when_used = always

spacing_radial: LengthType.Positive [Required]#

Spacing along the radial direction.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x79301f934ee0>

  • return_type = PydanticUndefined

  • when_used = always

spacing_circumferential: LengthType.Positive [Required]#

Spacing along the circumferential direction.

Constraints:
  • func = <function _dimensioned_type_serializer at 0x79301f934ee0>

  • return_type = PydanticUndefined

  • when_used = always