tidy3d.LumpedResistor#

class LumpedResistor[source]#

Bases: LumpedElement

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

Parameters:
  • attrs (dict = {}) – Dictionary storing arbitrary metadata for a Tidy3D object. This dictionary can be freely used by the user for storing data without affecting the operation of Tidy3D as it is not used internally. Note that, unlike regular Tidy3D fields, attrs are mutable. For example, the following is allowed for setting an attr obj.attrs['foo'] = bar. Also note that Tidy3D` will raise a TypeError if attrs contain objects that can not be serialized. One can check if attrs are serializable by calling obj.json().

  • center (Tuple[float, float, float] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

  • size (Tuple[NonNegativeFloat, NonNegativeFloat, NonNegativeFloat]) – [units = um]. Size in x, y, and z directions.

  • name (ConstrainedStrValue) – Unique name for the lumped element.

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

  • num_grid_cells (Optional[PositiveInt] = 3) – 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.

  • resistance (PositiveFloat) – Resistance value in ohms.

Attributes

sheet_conductance

Effective sheet conductance.

attrs

Methods

Inherited Common Usage

resistance#
property sheet_conductance#

Effective sheet conductance.

__hash__()#

Hash method.