tidy3d.CustomGrid

class CustomGrid

Bases: GridSpec1d

Custom 1D grid supplied as a list of grid cell sizes centered on the simulation center.

Parameters:

• dl (tuple[PositiveFloat, ...]) – [units = um]. An array of custom nonuniform grid sizes. The resulting grid is centered on the simulation center such that it spans the region (center - sum(dl)/2, center + sum(dl)/2), unless a custom_offset is given. Note: if supplied sizes do not cover the simulation size, the first and last sizes are repeated to cover the simulation domain.

• custom_offset (Optional[float] = None) – [units = um]. The starting coordinate of the grid which defines the simulation center. If None, the simulation center is set such that it spans the region (center - sum(dl)/2, center + sum(dl)/2).

Example

>>> grid_1d = CustomGrid(dl=[0.2, 0.2, 0.1, 0.1, 0.1, 0.2, 0.2])

Attributes

dl
custom_offset

Methods

estimated_min_dl(wavelength, structure_list, ...)

Minimal grid size from grid specification.

dl

custom_offset

estimated_min_dl(wavelength, structure_list, sim_size)

Minimal grid size from grid specification.

Parameters:

• wavelength (float) – Wavelength to use for the step size and for dispersive media epsilon.

• structure_list (list[Structure]) – List of structures present in the simulation.

• sim_size (tuple[float, 3]) – Simulation domain size.

Returns:

Minimal grid size from grid specification.

Return type:

float