tidy3d.SteadyElectricFieldData

class SteadyElectricFieldData

Bases: HeatChargeMonitorData

Stores electric field \(\vec{E}\) from a Charge/Conduction 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 (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)) – [units = um]. Symmetry center of the original simulation in x, y, and z.

• E (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.
attrs

Methods

check_correct_data_type(values)

Issue error if incorrect data type is used

Inherited Common Usage

monitor

E

property field_components

Maps the field components to their associated data.

classmethod check_correct_data_type(values)

Issue error if incorrect data type is used

__hash__()

Hash method.