Ctrl+K

tidy3d.components.source.DirectionalSource

tidy3d.components.source.DirectionalSource#

class DirectionalSource[source]#

Bases: FieldSource, ABC

A Field source that propagates in a given direction.

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.

  • direction (Literal['+', '-']) – Specifies propagation in the positive or negative direction of the injection axis.

Attributes

Methods

direction#
__hash__()#

Hash method.