agencyenterprise / neurotechdevkit

Neurotech Development Kit (NDK)
https://agencyenterprise.github.io/neurotechdevkit/
Apache License 2.0
117 stars 10 forks source link

Add timestamp to each wavefield step in the result object #98

Open d-lucena opened 1 year ago

d-lucena commented 1 year ago

Describe the new feature or enhancement

The current result object has the wavefield as 3D or 4D array (problem dimension + time), however, there's no relation back to the wavefield time at simulation time available to the user. This information would be helpful for offline analysis of the results.

Currently only pulsed simulations have a private method (_recording_times ) to compute the recorded times. It should be extended to all results (steady state and pulsed) and made public.

Note: The first recorded timestep for steady-state simulations is not t=0.0, so we'd need to get the value from save_bounds passed to pde inside Scenario._execute_pde.