Ctrl+K

tidy3d.components.source.CurrentSource

tidy3d.components.source.CurrentSource#

class CurrentSource[source]#

Bases: Source, ABC

Source implements a current distribution directly.

Parameters:

  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • 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.

  • polarization (Literal['Ex', 'Ey', 'Ez', 'Hx', 'Hy', 'Hz']) – Specifies the direction and type of current component.

Attributes

attrs

Methods

Inherited Common Usage

polarization#
__hash__()#

Hash method.