tidy3d.CustomFieldSource

class CustomFieldSource

Bases: FieldSource, PlanarSource

Implements a source corresponding to an input dataset containing E and H fields, using the equivalence principle to define the actual injected currents.

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.

• field_dataset –

  Type	Optional[FieldDataset]
  Default
  Description	FieldDataset containing the desired frequency-domain fields patterns to inject. At least one tangential field component must be specified.

Example

>>> from tidy3d import ScalarFieldDataArray
>>> pulse = GaussianPulse(freq0=200e12, fwidth=20e12)
>>> x = np.linspace(-1, 1, 101)
>>> y = np.linspace(-1, 1, 101)
>>> z = np.array([0])
>>> f = [2e14]
>>> coords = dict(x=x, y=y, z=z, f=f)
>>> scalar_field = ScalarFieldDataArray(np.ones((101, 101, 1, 1)), coords=coords)
>>> dataset = FieldDataset(Ex=scalar_field)
>>> custom_source = CustomFieldSource(
...     center=(1, 1, 1),
...     size=(2, 2, 0),
...     source_time=pulse,
...     field_dataset=dataset)

See also

Notebooks

• Defining spatially-varying sources

Attributes

Methods

field_dataset

__hash__()

Hash method.