tidy3d.DistanceUnstructuredGrid#

class DistanceUnstructuredGrid[source]#

Bases: Tidy3dBaseModel

Adaptive grid based on distance to material interfaces. Currently not recommended for larger simulations.

Parameters:
  • dl_interface (PositiveFloat) – [units = um]. Grid size near material interfaces.

  • dl_bulk (PositiveFloat) – [units = um]. Grid size away from material interfaces.

  • distance_interface (NonNegativeFloat) – [units = um]. Distance from interface within which dl_interface is enforced.Typically the same as dl_interface or its multiple.

  • distance_bulk (NonNegativeFloat) – [units = um]. Distance from interface outside of which dl_bulk is enforced.Typically twice of dl_bulk or its multiple. Use larger values for a smoother transition from dl_interface to dl_bulk.

  • sampling (PositiveFloat = 100) – An internal advanced parameter that defines number of sampling points per surface when computing distance values.

  • non_refined_structures (Tuple[str, ...] = ()) – List of structures for which dl_interface will not be enforced. dl_bulk is used instead.

Example

>>> heat_grid = DistanceUnstructuredGrid(
...     dl_interface=0.1,
...     dl_bulk=1,
...     distance_interface=0.3,
...     distance_bulk=2,
... )

Attributes

Methods

names_exist_bcs(val, values)

Error if distance_bulk is less than distance_interface

Inherited Common Usage

dl_interface#
dl_bulk#
distance_interface#
distance_bulk#
sampling#
non_refined_structures#
classmethod names_exist_bcs(val, values)[source]#

Error if distance_bulk is less than distance_interface

__hash__()#

Hash method.