Ctrl+K

tidy3d.components.geometry.base.Planar

tidy3d.components.geometry.base.Planar#

class Planar[source]#

Bases: Geometry, ABC

Geometry with one axis that is slab-like with thickness height.

Parameters:

  • axis (Attribute: axis) –

    Type

    Literal[0, 1, 2]

    Default

    = 2

    Description

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

  • sidewall_angle (Attribute: sidewall_angle) –

    Type

    ConstrainedFloatValue

    Default

    = 0.0

    Units

    rad

    Description

    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 (Attribute: reference_plane) –

    Type

    Literal[‘bottom’, ‘middle’, ‘top’]

    Default

    = middle

    Description

    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.

Attributes

center_axis

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

finite_length_axis

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

length_axis

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

Methods

intersections_plane([x, y, z])

Returns shapely geometry at plane specified by one non None value of x,y,z.
axis#
sidewall_angle#
reference_plane#
abstract property center_axis#

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

abstract property length_axis#

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

property finite_length_axis#

Gets the length of the geometry along the out of plane dimension. If the length is td.inf, return LARGE_NUMBER

intersections_plane(x=None, y=None, z=None)[source]#

Returns shapely geometry at plane specified by one non None value of x,y,z.

Parameters:

  • x (float) – Position of plane in x direction, only one of x,y,z can be specified to define plane.

  • y (float) – Position of plane in y direction, only one of x,y,z can be specified to define plane.

  • z (float) – Position of plane in z direction, only one of x,y,z can be specified to define plane.

Returns:

  • List[shapely.geometry.base.BaseGeometry] – List of 2D shapes that intersect plane. For more details refer to

  • `Shapely’s Documentation <https (//shapely.readthedocs.io/en/stable/project.html>`_.)

__hash__()#

Hash method.