tidy3d.rf.LumpedResistor#
- class LumpedResistor[source]#
Bases:
RectangularLumpedElementClass representing a rectangular lumped resistor. Lumped resistors are appended to the list of structures in the simulation as
Medium2Dwith the appropriate conductivity given their size and voltage axis.- Parameters:
center (Optional[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]]] = None) – [units = um]. Center of object in x, y, and z.
size (tuple[Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box], Union[NonNegativeFloat, autograd.tracer.Box]]) – [units = um]. Size in x, y, and z directions.
name (str) – Unique name for the lumped element.
num_grid_cells (Optional[PositiveInt] = 1) – Number of mesh grid cells associated with the lumped element along each direction. Used in generating the suggested list of
MeshOverrideStructureobjects. A value ofNonewill 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.
voltage_axis (Literal[0, 1, 2]) – 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.
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_axisare snapped to grid boundaries, while the sides parallel to thevoltage_axisare snapped to grid centers. Lumped elements are always snapped to the nearest grid boundary along theirnormal_axis, regardless of this option.resistance (PositiveFloat) – [units = ohm]. Resistance value in ohms.
Attributes
voltage_axissnap_perimeter_to_gridnamenum_grid_cellsenable_snapping_pointssizecenterMethods
to_structure([grid, frequency_range])Converts the
LumpedResistorobject to aStructureready to be added to theSimulation- resistance#
- to_structure(grid=None, frequency_range=None)[source]#
Converts the
LumpedResistorobject to aStructureready to be added to theSimulation