tidy3d.UnsteadySpec

tidy3d.UnsteadySpec#

class UnsteadySpec[source]#

Defines an unsteady specification

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().
time_step (PositiveFloat) – [units = sec]. Time step taken for each iteration of the time integration loop.
total_time_steps (PositiveInt) – Specifies the total number of time steps run during the simulation.

Example

>>> import tidy3d as td
>>> time_spec = td.UnsteadySpec(
...     time_step=0.01,
...     total_time_steps=200,
... )

Attributes

Methods

Inherited Common Usage