Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.CoaxialLumpedResistor

Type: class │ Base(s): LumpedElement

Description

Section titled “Description”

Class representing a coaxial lumped resistor. Lumped resistors are appended to the list of structures in the simulation as Medium2D with the appropriate conductivity given their size and geometry.

Parameters

Section titled “Parameters”
name [str]

Unique name for the lumped element.
resistance [PositiveFloat]

Resistance value in ohms.
outer_diameter [PositiveFloat]

Diameter of the outer concentric circle.
inner_diameter [PositiveFloat]

Diameter of the inner concentric circle.
normal_axis [Axis]

Specifies the normal axis, which defines the orientation of the circles making up the coaxial lumped element.
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.
center [Coordinate] = (0.0, 0.0, 0.0)

Center of object in x, y, and z.

Methods

Section titled “Methods”
geometry()

Alias for to_geometry that ignores the grid and allows CoaxialLumpedResistor to behave like a Structure.
to_geometry(grid: Grid | None = None)

Converts the CoaxialLumpedResistor object to a Geometry.
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 half of the in-plane cell size in the override region.
to_snapping_points()

Creates a suggested snapping point list to ensure that the element is aligned with a grid boundary in the normal direction.
to_structure(grid: Grid | None = None, frequency_range: FreqBound | None = None)

Converts the CoaxialLumpedResistor object to a Structure ready to be added to the Simulation

Machine-Readable Export

Section titled “Machine-Readable Export”