tidy3d.CoaxialLumpedResistor

class CoaxialLumpedResistor

Bases: LumpedElement

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:

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

• name (ConstrainedStrValue) – 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 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.

• resistance (PositiveFloat) – Resistance value in ohms.

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

• outer_diameter (PositiveFloat) – [units = um]. Diameter of the outer concentric circle.

• inner_diameter (PositiveFloat) – [units = um]. Diameter of the inner concentric circle.

• normal_axis (Literal[0, 1, 2]) – Specifies the normal axis, which defines the orientation of the circles making up the coaxial lumped element.

Attributes

geometry	Alias for to_geometry that ignores the grid and allows CoaxialLumpedResistor to behave like a Structure.
attrs

Methods

to_geometry([grid])	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.
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])	Converts the CoaxialLumpedResistor object to a Structure ready to be added to the Simulation

Inherited Common Usage

resistance

center

outer_diameter

inner_diameter

normal_axis

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_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_structure(grid=None)

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

to_geometry(grid=None)

Converts the CoaxialLumpedResistor object to a Geometry.

property geometry

Alias for to_geometry that ignores the grid and allows CoaxialLumpedResistor to behave like a Structure.

Returns:

The annulus describing the coaxial lumped resistor.

Return type:

ClipOperation

__hash__()

Hash method.