tidy3d.GridRefinementLine

class GridRefinementLine

Bases: Tidy3dBaseModel, ABC

Refinement line for the unstructured mesh. The cell size depends on the distance from the line.

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

• r1 (Tuple[float, float, float]) – [units = um]. Start point of the line in x, y, and z.

• r2 (Tuple[float, float, float]) – [units = um]. End point of the line in x, y, and z.

• dl_near (PositiveFloat) – [units = um]. Mesh cell size near the line

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

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

Attributes

attrs

Methods

names_exist_bcs(val, values)

Error if distance_bulk is less than distance_near

Inherited Common Usage

r1

r2

dl_near

distance_near

distance_bulk

classmethod names_exist_bcs(val, values)

Error if distance_bulk is less than distance_near

__hash__()

Hash method.