Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.RectangularLumpedElement

Type: class │ Base(s): LumpedElement, Box

Description

Section titled “Description”

Class representing a rectangular planar element with zero thickness along its normal axis. A RectangularLumpedElement is appended to the list of structures in the simulation as a Medium2D with the appropriate material properties given their size, voltage axis, and the network they represent.

Notes

Section titled “Notes”

The element must be planar (exactly one zero-size dimension). One-dimensional elements (two zero-size dimensions) are not supported. If you need a narrow element, provide a small but finite width along the lateral axis.

Parameters

Section titled “Parameters”
size [TracedSize]

Size in x, y, and z directions.
name [str]

Unique name for the lumped element.
voltage_axis [Axis]

Specifies the axis along which the component is oriented and along which the associated voltage drop will occur. Must be in the plane of the element.
center [TracedCoordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.
num_grid_cells [PositiveInt | None] = DEFAULT_LUMPED_ELEMENT_NUM_CELLS

Number of mesh grid cells associated with the lumped element along each direction. Used in generating the suggested list of MeshOverrideStructure objects. A value of None will turn off mesh refinement suggestions.
enable_snapping_points [bool] = True

When enabled, snapping points are automatically generated to snap grids to key geometric features of the lumped element for more accurate modelling.
snap_perimeter_to_grid [bool] = True

When enabled, the perimeter of the lumped element is snapped to the simulation grid, which improves accuracy when the number of grid cells is low within the element. Sides of the element perpendicular to the voltage_axis are snapped to grid boundaries, while the sides parallel to the voltage_axis are snapped to grid centers. Lumped elements are always snapped to the nearest grid boundary along their normal_axis, regardless of this option.

Methods

Section titled “Methods”
lateral_axis()

Lateral axis of the lumped element.
monitor_name()
normal_axis()

Normal axis of the lumped element, which is the axis where the element has zero size.
to_geometry(grid: Grid | None = None)

Converts the RectangularLumpedElement object to a Box.
to_mesh_overrides()

Creates a suggested MeshOverrideStructure list for mesh refinement both on the plane of lumped element, and along normal axis. In the normal direction, we’ll make sure there are at least 2 cell layers above and below whose size is the same as the in-plane cell size in the override region.
to_monitor(freqs: FreqArray)

Creates a field monitor that can be added to the simulation, which records field data that can be used to later compute voltage and current flowing through the element.
to_snapping_points()

Creates a suggested snapping point list to ensure that the element is aligned with a grid boundary in the normal direction, and the endpoints aligned with grids in the voltage axis.

Machine-Readable Export

Section titled “Machine-Readable Export”