tidy3d.plugins.design.MethodGrid

class MethodGrid

Bases: MethodSample

Select parameters uniformly on a grid. Size of the grid is specified by the parameter type, either as the number of unique discrete values (ParameterInt, ParameterAny) or with the num_points argument (ParameterFloat).

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

• name (Optional[str] = None) – Optional name for the sweep method.

Example

>>> import tidy3d.plugins.design as tdd
>>> method = tdd.MethodGrid()

Attributes

attrs

Methods

sample(parameters)

Defines how the design parameters are sampled on the grid.

Inherited Common Usage

static sample(parameters)

Defines how the design parameters are sampled on the grid.

__hash__()

Hash method.