Skip to content
Flex RF Flex RF Flex RF

flex_rf.tidy3d.CustomGrid

Type: class │ Base(s): GridSpec1d

Description

Section titled “Description”

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

Example(s)

Section titled “Example(s)”
grid_1d = CustomGrid(dl=[0.2, 0.2, 0.1, 0.1, 0.1, 0.2, 0.2])

Parameters

Section titled “Parameters”
dl [tuple[PositiveFloat, ...]]

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 [float | None] = None

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

Methods

Section titled “Methods”
estimated_min_dl(wavelength: float, structure_list: list[Structure], sim_size: tuple[float, 3])

Minimal grid size from grid specification.

Machine-Readable Export

Section titled “Machine-Readable Export”