tidy3d.ChargeToleranceSpec

tidy3d.ChargeToleranceSpec#

class ChargeToleranceSpec[source]#

Bases: Tidy3dBaseModel

Charge tolerance parameters relevant to multiple simulation analysis types.

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().
abs_tol (PositiveFloat = 10000000000.0) – Absolute tolerance used as stop criteria when converging towards a solution.
rel_tol (PositiveFloat = 1e-10) – Relative tolerance used as stop criteria when converging towards a solution.
max_iters (PositiveInt = 30) – Indicates the maximum number of iterations to be run. The solver will stop either when this maximum of iterations is met or when the tolerance criteria has been met.
ramp_up_iters (PositiveInt = 1) – In order to help in start up, quantities such as doping are ramped up until they reach their specified value. This parameter determines how many of this iterations it takes to reach full values.

Example

>>> import tidy3d as td
>>> charge_settings = td.ChargeToleranceSpec(abs_tol=1e8, rel_tol=1e-10, max_iters=30)

Attributes

Methods

Inherited Common Usage