tidy3d.GridRefinementRegion

class GridRefinementRegion

Bases: Box

Refinement region for the unstructured mesh. The cell size is enforced to be constant inside the region. The cell size outside of the region depends on the distance from the region.

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().

• center (Union[tuple[Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box], Union[float, autograd.tracer.Box]], Box] = (0.0, 0.0, 0.0)) – [units = um]. Center of object in x, y, and z.

• size (Union[tuple[Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box], Union[pydantic.v1.types.NonNegativeFloat, autograd.tracer.Box]], Box]) – [units = um]. Size in x, y, and z directions.

• dl_internal (PositiveFloat) – [units = um]. Mesh cell size inside the refinement region

• transition_thickness (NonNegativeFloat) – [units = um]. Thickness of a transition layer outside the box where the mesh cell size changes from theinternal size to the external one.

Attributes

attrs

Methods

Inherited Common Usage

dl_internal

transition_thickness

__hash__()

Hash method.