tidy3d.components.source.PlanarSource

tidy3d.components.source.PlanarSource#

class PlanarSource[source]#

Bases: Source, ABC

A source defined on a 2D plane.

Parameters:
  • name (Attribute: name) –

    Type

    Optional[str]

    Default

    = None

    Description

    Optional name for the source.

  • center (Attribute: center) –

    Type

    Tuple[float, float, float]

    Default

    = (0.0, 0.0, 0.0)

    Units

    um

    Description

    Center of object in x, y, and z.

  • size (Attribute: size) –

    Type

    Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]

    Default

    Units

    um

    Description

    Size in x, y, and z directions.

  • source_time (Attribute: source_time) –

    Type

    Union[GaussianPulse, ContinuousWave, CustomSourceTime]

    Default

    Description

    Specification of the source time-dependence.

Attributes

injection_axis

Injection axis of the source.

Methods

property injection_axis#

Injection axis of the source.

__hash__()#

Hash method.