RotationSphere#

class RotationSphere[source]#

Bases: _RotationVolumeBase

Creates a spherical sliding interface using Sphere entities.

  • The mesh on RotationSphere is guaranteed to be concentric.

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

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

Example

>>> fl.RotationSphere(
...     name="RotationSphere",
...     spacing_circumferential=0.3*fl.u.m,
...     entities=sphere
... )

Attributes

name: str, optional#

Name to display in the GUI.

Default:

'Rotation Sphere'

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

Entities enclosed by RotationVolume. Can be Surface 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[Sphere]#
spacing_circumferential: Length.PositiveFloat64#

Uniform spacing on the spherical interface.

Methods

classmethod ensure_surface_existence(value)#

Ensure all boundaries will be present after mesher.