tidy3d.AutoGrid#

class AutoGrid[source]#

Bases: GridSpec1d

Specification for non-uniform grid along a given dimension.

Parameters:
  • min_steps_per_wvl (Attribute: min_steps_per_wvl) –

    Type

    ConstrainedFloatValue

    Default

    = 10.0

    Description

    Minimal number of steps per wavelength in each medium.

  • max_scale (Attribute: max_scale) –

    Type

    ConstrainedFloatValue

    Default

    = 1.4

    Description

    Sets the maximum ratio between any two consecutive grid steps.

  • dl_min (Attribute: dl_min) –

    Type

    NonNegativeFloat

    Default

    = 0

    Description

    Lower bound of the grid size along this dimension regardless of structures present in the simulation, including override structures with enforced=True. It is a soft bound, meaning that the actual minimal grid size might be slightly smaller.

  • mesher (Attribute: mesher) –

    Type

    GradedMesher

    Default

    = GradedMesher(type’GradedMesher’)

    Description

    The type of mesher to use to generate the grid automatically.

Example

>>> grid_1d = AutoGrid(min_steps_per_wvl=16, max_scale=1.4)

See also

UniformGrid

Uniform 1D grid.

GridSpec

Collective grid specification for all three dimensions.

Notebooks:
Lectures:

Attributes

Methods

min_steps_per_wvl#
max_scale#
dl_min#
mesher#
__hash__()#

Hash method.