tidy3d.rf.CoaxialLumpedResistor#
- class CoaxialLumpedResistor[source]#
Bases:
LumpedElementClass representing a coaxial lumped resistor. Lumped resistors are appended to the list of structures in the simulation as
Medium2Dwith the appropriate conductivity given their size and geometry.- Parameters:
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.
resistance (PositiveFloat) – [units = ohm]. 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
Alias for
to_geometrythat ignores the grid and allowsCoaxialLumpedResistorto behave like aStructure.namenum_grid_cellsenable_snapping_pointsMethods
to_geometry([grid])Converts the
CoaxialLumpedResistorobject to aGeometry.Creates a suggested
MeshOverrideStructurelist for mesh refinement both on the plane of lumped element, and along normal axis.Creates a suggested snapping point list to ensure that the element is aligned with a grid boundary in the normal direction.
to_structure([grid, frequency_range])Converts the
CoaxialLumpedResistorobject to aStructureready to be added to theSimulation- resistance#
- center#
- outer_diameter#
- inner_diameter#
- normal_axis#
- to_snapping_points()[source]#
Creates a suggested snapping point list to ensure that the element is aligned with a grid boundary in the normal direction.
- to_mesh_overrides()[source]#
Creates a suggested
MeshOverrideStructurelist 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, frequency_range=None)[source]#
Converts the
CoaxialLumpedResistorobject to aStructureready to be added to theSimulation
- to_geometry(grid=None)[source]#
Converts the
CoaxialLumpedResistorobject to aGeometry.
- property geometry#
Alias for
to_geometrythat ignores the grid and allowsCoaxialLumpedResistorto behave like aStructure.- Returns:
The annulus describing the coaxial lumped resistor.
- Return type: