tidy3d.components.lumped_element.LumpedElement#

class LumpedElement[source]#

Base class describing the interface all lumped elements obey.

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

Attributes

`plot_params`	Default parameters for plotting a `LumpedElement` object.
`attrs`

Methods

`to_mesh_overrides`()	Creates a suggested `MeshOverrideStructure` list that could be added to the `Simulation`
`to_structure`()	Converts the `LumpedElement` object to a `Structure` ready to be added to the `Simulation`

Inherited Common Usage

property plot_params#: Default parameters for plotting a LumpedElement object.

abstract to_mesh_overrides()[source]#: Creates a suggested MeshOverrideStructure list that could be added to the Simulation

abstract to_structure()[source]#: Converts the LumpedElement object to a Structure ready to be added to the Simulation

tidy3d.components.lumped_element.LumpedElement