flex_rf.tidy3d.Cylinder

Type: class │ Base(s): Centered, Circular, Planar

Description

Cylindrical geometry with optional sidewall angle along axis direction. When sidewall_angle is nonzero, the shape is a conical frustum or a cone.

Example(s)

c = Cylinder(center=(1,2,3), radius=2, length=5, axis=2)

Parameters

radius [TracedSize1D]

Radius of geometry at the reference_plane.

length [TracedSize1D]

Defines thickness of cylinder along axis dimension.

axis [Axis] = 2

Specifies dimension of the planar axis (0,1,2) -> (x,y,z).

sidewall_angle [TracedFloat] = 0.0

Angle of the sidewall. sidewall_angle=0 (default) specifies a vertical wall; 0<sidewall_angle<np.pi/2 specifies a shrinking cross section along the axis direction; and -np.pi/2<sidewall_angle<0 specifies an expanding cross section along the axis direction.

reference_plane [PlanePosition] = 'middle'

The position of the plane where the supplied cross section are defined. The plane is perpendicular to the axis. The plane is located at the bottom, middle, or top of the geometry with respect to the axis. E.g. if axis=1, bottom refers to the negative side of the y-axis, and top refers to the positive side of the y-axis.

center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

Attributes

center_axis [Any]

Gets the position of the center of the geometry in the out of plane dimension.

length_axis [float]

Gets the length of the geometry along the out of plane dimension.

Methods

bounds()

Returns bounding box min and max coordinates.

inside(x: np.ndarray[float], y: np.ndarray[float], z: np.ndarray[float])

For input arrays x, y, z of arbitrary but identical shape, return an array with the same shape which is True for every point in zip(x, y, z) that is inside the volume of the Geometry, and False otherwise.

radius_bottom()

radius of bottom

radius_max()

max(radius of top, radius of bottom)

radius_min()

min(radius of top, radius of bottom). It can be negative for a large sidewall angle.

radius_top()