RotationVolume

RotationVolume#

class RotationVolume[source]#

Bases: _RotationVolumeBase

Creates a rotation volume mesh using cylindrical or axisymmetric body entities.

The mesh on RotationVolume is guaranteed to be concentric.
The RotationVolume is designed to enclose other objects. It can’t intersect them, except with GeometryAI (use_geometry_AI=True), described below.
With GeometryAI, the RotationVolume can cut through the geometry. Each surface that crosses its boundary is split there into a part inside the zone and a part outside it. The inside part rotates with the zone unless it is listed in stationary_enclosed_entities. List every surface that lies inside or crosses the zone in enclosed_entities. The zone must be an AxisymmetricBody or a Cylinder without inner_radius.
Users can create a donut-shaped RotationVolume and put their stationary centerbody in the middle.
This type of volume zone can be used to generate volume zones compatible with Rotation model.
Supports Cylinder and AxisymmetricBody entities for defining the rotation volume geometry.

Note

For spherical sliding interfaces, use RotationSphere.

Note

The deprecated RotationCylinder class is maintained for backward compatibility but only accepts Cylinder entities. New code should use RotationVolume.

Example

Using a Cylinder entity:

>>> fl.RotationVolume(
...     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
... )

Using an AxisymmetricBody entity:

>>> fl.RotationVolume(
...     name="RotationConeFrustum",
...     spacing_axial=0.5*fl.u.m,
...     spacing_circumferential=0.3*fl.u.m,
...     spacing_radial=1.5*fl.u.m,
...     entities=axisymmetric_body
... )

With enclosed entities:

>>> fl.RotationVolume(
...     name="RotationVolume",
...     spacing_axial=0.5*fl.u.m,
...     spacing_circumferential=0.3*fl.u.m,
...     spacing_radial=1.5*fl.u.m,
...     entities=outer_cylinder,
...     enclosed_entities=[inner_cylinder, surface]
... )

Attributes

name: str, optional#

Name to display in the GUI.

Default:: 'Rotation Volume'

enclosed_entities: EntityList[Cylinder, Surface, MirroredSurface, GhostCircularPlane, AxisymmetricBody, Box, Sphere], optional#

Entities enclosed by RotationVolume. Can be Surface and/or the half-body symmetry plane (farfield.symmetry_plane)and/or other Sphere

Default:: None

stationary_enclosed_entities: EntityList[Surface, MirroredSurface], optional#

Surface entities included in enclosed_entities which should remain stationary (excluded from rotation).

Default:: None

entities: EntityList[Cylinder, AxisymmetricBody]#

spacing_axial: Length.PositiveFloat64#: Spacing along the axial direction.

spacing_radial: Length.PositiveFloat64#: Spacing along the radial direction.

spacing_circumferential: Length.PositiveFloat64#: Spacing along the circumferential direction.

Methods

classmethod remap_symmetric_to_user_name(value)#: Remap ‘symmetric’ ghost entity to user’s symmetry surface name for UDF backward compat.

classmethod ensure_surface_existence(value)#: Ensure all boundaries will be present after mesher.

RotationVolume

Contents

RotationVolume#