property BaseTimeSimulation.time_steps#

Time step lengths, in seconds, for the time domain simulation.

There are two ways in which the user can set the time_steps property for the forward simulation. The most basic approach is to use a (n_steps, ) numpy.ndarray that explicitly defines the step lengths in order. I.e.:

>>> sim.time_steps = np.r_[1e-6, 1e-6, 1e-6, 1e-5, 1e-5, 1e-4, 1e-4]

We can define also define the step lengths in compact for when the same step length is reused multiple times in succession. In this case, the time_steps property is set using a list of tuple. Each tuple contains the step length and number of times that step is repeated. The time stepping defined above can be set equivalently with:

>>> sim.time_steps = [(1e-6, 3), (1e-5, 2), (1e-4, 2)]

When set, the discretize.utils.unpack_widths() utility is used to convert the list of tuple to its (n_steps, ) numpy.ndarray representation.

(n_steps, ) numpy.ndarray

The time step lengths for the time domain simulation.