tidy3d.components.lumped_element.LumpedElement#

class LumpedElement[source]#

Bases: MicrowaveBaseModel, ABC

Base class describing the interface all lumped elements obey.

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

Attributes

plot_params

Default parameters for plotting a LumpedElement object.

name

num_grid_cells

enable_snapping_points

Methods

to_geometry()

Converts the LumpedElement object to a Geometry.

to_mesh_overrides()

Creates a suggested MeshOverrideStructure list.

to_snapping_points()

Creates a suggested snapping point list.

to_structure([grid])

Converts the network portion of the LumpedElement object to a Structure.

to_structures([grid])

Converts the LumpedElement object to a list of Structure which are ready to be added to the Simulation

name#
num_grid_cells#
enable_snapping_points#
property plot_params#

Default parameters for plotting a LumpedElement object.

abstract to_mesh_overrides()[source]#

Creates a suggested MeshOverrideStructure list.

abstract to_snapping_points()[source]#

Creates a suggested snapping point list.

abstract to_geometry()[source]#

Converts the LumpedElement object to a Geometry.

abstract to_structure(grid=None)[source]#

Converts the network portion of the LumpedElement object to a Structure.

to_structures(grid=None)[source]#

Converts the LumpedElement object to a list of Structure which are ready to be added to the Simulation