fdtdx.Cylinder

Bases: StaticMultiMaterialObject

A cylindrical optical fiber with configurable properties.

This class represents a cylindrical fiber with customizable radius, material, and orientation. The fiber can be positioned along any of the three principal axes.

Attributes:
  • radius (float) –

    The radius of the fiber in meter.

  • axis (int) –

    The principal axis along which the fiber extends (0=x, 1=y, 2=z).

  • material_name (str) –

    Name of the material in the materials dictionary to be used for the object.

horizontal_axis property 

horizontal_axis: int

Gets the horizontal axis perpendicular to the fiber axis.

Returns:
  • int( int ) –

    The index of the horizontal axis (0=x or 1=y).

vertical_axis property 

vertical_axis: int

Gets the vertical axis perpendicular to the fiber axis.

Returns:
  • int( int ) –

    The index of the vertical axis (1=y or 2=z).