tidy3d.UniformGrid

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

AutoGrid

Specification for non-uniform grid along a given dimension.

Notebooks:

Attributes

Methods

Inherited Common Usage

dl#
__hash__()#

Hash method.