tidy3d.components.source.field.DirectionalSource

tidy3d.components.source.field.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 (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.
size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.
source_time (Union[GaussianPulse, ContinuousWave, CustomSourceTime, BroadbandPulse, BasebandStep, BasebandGaussianPulse, BasebandRectangularPulse, BasebandCustomSourceTime]) – Specification of the source time-dependence.
direction (Literal['+', '-']) – Specifies propagation in the positive or negative direction of the injection axis.

Attributes