tidy3d.components.source.PlanarSource

tidy3d.components.source.PlanarSource#

class PlanarSource[source]#

Bases: Source, ABC

A source defined on a 2D plane.

Parameters:
  • name (Optional[str] = None) – Optional name for the source.

  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

  • source_time (Union[GaussianPulse, ContinuousWave, CustomSourceTime]) – Specification of the source time-dependence.

Attributes

injection_axis

Injection axis of the source.

Methods

Inherited Common Usage

property injection_axis#

Injection axis of the source.

__hash__()#

Hash method.