tidy3d.SteadyPotentialData#

class SteadyPotentialData[source]#

Bases: HeatChargeMonitorData

Stores electric potential \(\psi\) from a charge simulation.

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().
monitor (SteadyPotentialMonitor) – Electric potential monitor associated with a charge simulation.
symmetry (Tuple[Literal[0, 1], Literal[0, 1], Literal[0, 1]] = (0, 0, 0)) – Symmetry of the original simulation in x, y, and z.
symmetry_center (Tuple[float, float, float] = (0, 0, 0)) – Symmetry center of the original simulation in x, y, and z.
potential (Union[SpatialDataArray, Annotated[Union[tidy3d.components.data.unstructured.triangular.TriangularGridDataset, tidy3d.components.data.unstructured.tetrahedral.TetrahedralGridDataset], FieldInfo(default=PydanticUndefined, discriminator='type', extra={})]] = None) – Contains the electric potential series.

Attributes

`field_components`	Maps the field components to their associated data.
`symmetry_expanded_copy`	Return copy of self with symmetry applied.
`attrs`

Methods

`field_name`(val)	Gets the name of the fields to be plot.
`warn_no_data`(val, values)	Warn if no data provided.

Inherited Common Usage

property field_components#: Maps the field components to their associated data.

classmethod warn_no_data(val, values)[source]#: Warn if no data provided.

property symmetry_expanded_copy#: Return copy of self with symmetry applied.

tidy3d.SteadyPotentialData