tidy3d.SteadyElectricFieldData

tidy3d.SteadyElectricFieldData#

class SteadyElectricFieldData[source]#

Bases: HeatChargeMonitorData

Stores electric field \(\vec{E}\) from a Charge/Conduction simulation.

Parameters:

  • monitor (SteadyElectricFieldMonitor) – Electric field data associated with a Charge/Conduction 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.

  • E (Optional[Union[TriangularGridDataset, TetrahedralGridDataset]] = None) – [units = \(V/\mu m\)]. Contains the computed electric field.

Notes

The electric field is computed as the negative gradient of the electric potential \(\vec{E} = -\nabla \psi\). It is given in units of \(V/\mu m\) (Volts per micrometer).

Attributes

field_components

Maps the field components to their associated data.

monitor

E

symmetry

symmetry_center

Methods

check_correct_data_type()

Issue error if incorrect data type is used
monitor#
E#
property field_components#

Maps the field components to their associated data.

check_correct_data_type()[source]#

Issue error if incorrect data type is used