# CustomCurrentSource

Implements a source corresponding to an input dataset containing E and H fields. Injects the specified components of the E and H dataset directly as J and M current distributions in the FDTD solver.

# Name

name: Optional name for the source.

# Source Region

Specification of the source region.

# Center + size

Object definition through a center position and size.

center: Center of the object in x, y, and z-directions.

Type: floating-point number

  • Unit: m, μm (default), or nm
  • Default: (0, 0, 0)

size: Size of the object in x, y, and z-directions.

Use Infinity to define a geometry extending to infinity in both directions along an axis.

Type: floating-point number

  • Unit: m, μm (default), or nm
  • Constraint: greater than or equal to 0
  • Required field

# Bounds

Object definition through minimum and maximum coordinate bounds.

min: Values of the x, y, and z coordinates defining the object lower corner.

Type: floating-point number

  • Unit: m, μm (default), or nm
  • Required field

max: Values of the x, y, and z coordinates defining the object upper corner.

Type: floating-point number

  • Unit: m, μm (default), or nm
  • Required field

# Current Dataset

current_dataset: FieldDataset containing the desired frequency-domain electric and magnetic current patterns to inject. Upload the dataset through the source upload control.

If you prepare the upload outside the editor, create a CustomCurrentSource with the Python interface and call to_hdf5(filename) (opens new window) to write the expected HDF5 dataset shape.

Type: FieldDataset

  • Unit: unitless
  • Required field

# Interpolation

interpolate: Handles reverse-interpolation of zero-size dimensions of the source. If False, the source data is snapped to the nearest Yee grid point. If True, equivalent source data is applied on the surrounding Yee grid points to emulate placement at the specified location using linear interpolation.

Options:

  • False
  • True (default)

# Source Time

source_time: Specification of the source time-dependence.

Options:

Required field

Baseband source time types are available when the source already uses one, for example a source created with the Python interface. They are not offered for a new source.

← CustomFieldSource →