tidy3d.PointCloudPermittivityMonitor

tidy3d.PointCloudPermittivityMonitor#

class PointCloudPermittivityMonitor[source]#

Bases: AbstractMediumPropertyMonitor

Monitor that records permittivity for arbitrary requested points.

Parameters:

  • name (str) – Unique name for monitor.

  • interval_space (tuple[Literal[1], Literal[1], Literal[1]] = (1, 1, 1)) – Point-cloud permittivity monitors do not support spatial downsampling.

  • colocate (Literal[False] = False) – Colocation turned off, since colocated medium property values do not have a physical meaning - they do not correspond to the subpixel-averaged ones.

  • use_colocated_integration (Literal[True] = True) – Whether to use colocated fields for flux, dot products, and overlap integrals. Hard-coded to True for most monitor types. Can be toggled on field, overlap, and flux monitors.

  • freqs (ArrayLike[dtype=float, ndim=1]) – [units = Hz]. Array or list of frequencies stored by the field monitor.

  • apodization (ApodizationSpec = ApodizationSpec()) – This field is ignored in this monitor.

  • points (PointDataArray) – [units = um]. Requested point coordinates for point-cloud permittivity sampling. The array must have dimensions ('index', 'axis') and shape (num_points, 3). Values are sampled from each component’s nearest native Yee-grid location, which may differ from these requested coordinates.

  • each (The monitor samples diagonal permittivity components using nearest-neighbor selection on)

  • coordinates (component's native Yee-grid location. Stored point coordinates are the requested)

:param : :param not the snapped component-grid sampling locations. This monitor records the diagonal entries: :param of the permittivity tensor: :param matching PermittivityMonitor. Point order and duplicate: :param points are preserved.:

Attributes

num_points

Number of points sampled by this monitor.

center

size

points

interval_space

colocate

apodization

freqs

use_colocated_integration

name

Methods

storage_size(num_cells, tmesh)

Size of monitor storage given the number of point-cloud samples.
center#
size#
points#
interval_space#
property num_points#

Number of points sampled by this monitor.

storage_size(num_cells, tmesh)[source]#

Size of monitor storage given the number of point-cloud samples.