# GridSpec

Collective grid specification for all three dimensions.

# Grid Specification Along X, Y, and Z Axes

grid_x: Grid specification along x-axis

grid_y: Grid specification along y-axis

grid_z: Grid specification along z-axis

Default: AutoGrid

Options:

# Free-Space Wavelength

wavelength: Free-space wavelength for automatic nonuniform grid. It can be None if there is at least one source in the simulation, in which case it is defined by the source central frequency.

Type: floating-point number

  • Unit: μm
  • Constraint: greater than 0
  • Default: None

# Grid Specification Override Structures

override_structures: A list of structures that is added on top of the simulation structures in the process of generating the grid. This can be used to refine the grid or make it coarser depending than the expected need for higher/lower resolution regions.

Options:

Note: it only takes effect when at least one of the three dimensions uses AutoGrid or QuasiUniformGrid.

# Snapping Points

snapping_points: A set of points that enforce grid boundaries to pass through them. However, some points might be skipped if they are too close. When points are very close to override_structures, snapping_points have higher prioirty so that the structures might be skipped.

Type: floating-point number

  • Default: None

Note: it only takes effect when at least one of the three dimensions uses AutoGrid or QuasiUniformGrid.

# Related Content: