# CustomFieldSource

Implements a source corresponding to an input dataset containing E and H fields, using the equivalence principle to define the actual injected currents. For the injection to work as expected (i.e. to reproduce the required E and H fields), the field data must decay by the edges of the source plane, or the source plane must span the entire simulation domain and the fields must match the simulation boundary conditions. The equivalent source currents are fully defined by the field components tangential to the source plane. For e.g. source normal along z, the normal components (Ez and Hz) can be provided but will have no effect on the results, and at least one of the tangential components has to be in the dataset, i.e. at least one of Ex, Ey, Hx, and Hy.

# 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

# Field Dataset

field_dataset: FieldDataset containing the desired frequency-domain fields patterns to inject. At least one tangential field component must be specified. Upload the dataset through the source upload control.

If you prepare the upload outside the editor, create a CustomFieldSource with the Python interface and call to_hdf5(filename) (opens new window) to write the expected HDF5 dataset shape. For a spatially varying field source, see the Custom Field Source example (opens new window).

Type: FieldDataset

  • Unit: unitless

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

# Use Colocated Integration

use_colocated_integration: Toggle whether source integration uses colocated fields.

Options:

  • False: Use the native Yee-grid field locations.
  • True: Use fields colocated to grid cell boundaries.

Default: True

← GaussianBeam →