tidy3d.components.data.monitor_data.ElectromagneticSurfaceFieldData

class ElectromagneticSurfaceFieldData

Bases: MonitorData, AbstractUnstructuredMonitorData, ElectromagneticSurfaceFieldDataset, ABC

Collection of vector fields on a surface with some symmetry properties.

Parameters:

• E (Optional[TriangularSurfaceDataset] = None) – Spatial distribution of the electric field on the one side of the surface.

• H (Optional[TriangularSurfaceDataset] = None) – Spatial distribution of the magnetic field on the one side of the surface.

• normal (TriangularSurfaceDataset) – Normal direction of the surface oriented outward from the surface.

• monitor (Union[SurfaceFieldMonitor, SurfaceFieldTimeMonitor])

• symmetry (tuple[Literal[0, -1, 1], Literal[0, -1, 1], Literal[0, -1, 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.

Attributes

symmetry_expanded	Return the ElectromagneticSurfaceFieldData with fields expanded based on symmetry.
symmetry_expanded_copy	Create a copy of the ElectromagneticSurfaceFieldData with fields expanded based on symmetry.
monitor
symmetry
symmetry_center
E
H
normal

monitor

property symmetry_expanded

Return the ElectromagneticSurfaceFieldData with fields expanded based on symmetry. If any symmetry is nonzero (i.e. expanded), the interpolation implicitly creates a copy of the data array. However, if symmetry is not expanded, the returned array contains a view of the data, not a copy.

Returns:

A data object with the symmetry expanded fields.

Return type:

ElectromagneticSurfaceFieldData

property symmetry_expanded_copy

Create a copy of the ElectromagneticSurfaceFieldData with fields expanded based on symmetry.

Returns:

A data object with the symmetry expanded fields.

Return type:

ElectromagneticSurfaceFieldData