tidy3d.plugins.design.MethodRandom

tidy3d.plugins.design.MethodRandom#

class MethodRandom[source]#

Bases: AbstractMethodRandom

Select sampling points uniformly at random.

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.

  • num_points (PositiveInt) – Maximum number of sampling points to perform in the sweep.

  • monte_carlo_warning (bool = True) – We recommend you use MethodMonteCarlo as it is more efficient at sampling. Setting this field to False will disable the warning that occurs when this class is made.

Example

>>> import tidy3d.plugins.design as tdd
>>> method = tdd.MethodRandom(num_points=20, monte_carlo_warning=False)

Attributes

attrs

Methods

get_sampler(parameters)

Sampler for this Method class.

Inherited Common Usage

monte_carlo_warning#
get_sampler(parameters)[source]#

Sampler for this Method class.

__hash__()#

Hash method.