tidy3d.UniformGrid#

class UniformGrid[source]#

Bases: GridSpec1d

Uniform 1D grid. The most standard way to define a simulation is to use a constant grid size in each of the three directions.

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

  • dl (PositiveFloat) – [units = um]. Grid size for uniform grid generation.

Example

>>> grid_1d = UniformGrid(dl=0.1)

See also

QuasiUniformGrid

Specification for quasi-uniform grid along a given dimension.

AutoGrid

Specification for non-uniform grid along a given dimension.

Notebooks:

Attributes

Methods

estimated_min_dl(wavelength, structure_list, ...)

Minimal grid size, which equals grid size here.

Inherited Common Usage

dl#
estimated_min_dl(wavelength, structure_list, sim_size)[source]#

Minimal grid size, which equals grid size here.

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

__hash__()#

Hash method.