Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.UniformCurrentSource

Type: class │ Base(s): CurrentSource, ReverseInterpolatedSource

Description

Section titled “Description”

Source in a rectangular volume with uniform time dependence.

Notes

Section titled “Notes”

Inputting the parameter size=(0,0,0) defines the equivalent of a point source.

Example(s)

Section titled “Example(s)”
from tidy3d import GaussianPulse
pulse = GaussianPulse(freq0=200e12, fwidth=20e12)
pt_source = UniformCurrentSource(
    size=(0,0,0), source_time=pulse, polarization='Ex', current_amplitude_definition='total',
)

Parameters

Section titled “Parameters”
size [TracedSize]

Size in x, y, and z directions.
source_time [SourceTimeType]

Specification of the source time-dependence.
polarization [Polarization]

Specifies the direction and type of current component.
name [str | None] = None

Optional name for the source.
center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.
interpolate [bool] = True

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.
confine_to_bounds [bool] = False

If True, any source amplitudes which, after discretization, fall beyond the bounding box of the source are zeroed out, but only along directions where the source has a non-zero extent. The bounding box is inclusive. Should be set ```True“ when the current source is being used to excite a current in a conductive material.
current_amplitude_definition [Literal['density', 'total']] = 'density'

Defines how the source_time amplitude is interpreted. If 'total', the source_time parameter is interpreted as the total current in Amperes (A) / Volts (V) when an electric / magnetic current polarization is chosen. The solver automatically scales the current density by the source cross-sectional area to ensure the integrated current equals the specified amplitude, regardless of mesh resolution. If 'density' (default), source_time represents the current density (e.g., A/m²), meaning the total injected current will scale with the source geometry size.

Machine-Readable Export

Section titled “Machine-Readable Export”