Home Examples Screenshots User manual Bluesky logo YouTube
OghmaNano Multiphysics simulation platform for optoelectronic devices and photonic systems DOWNLOAD Quick Start guide

Understanding Snapshots in OghmaNano

What are snapshots?

When you run a simulation in OghmaNano, the software can optionally store intermediate simulation outputs called snapshots. Snapshots are effectively the state of the simulation stored at different points during the calculation.

For example:

Snapshots provide a way to peer inside the simulation while it is evolving. Rather than only examining the final output, snapshots allow you to inspect how the internal device state changes throughout the calculation.

Snapshot generation can usually be turned on or off directly inside the editor window associated with the simulation type being used. For example, the JV editor window shown in ?? contains options controlling snapshot generation.

JV editor window showing snapshot output controls.
The JV editor window containing snapshot output controls.
Snapshot directories shown in the simulation output browser.
Snapshot directories shown inside the OghmaNano output browser.

Sometimes it is advantageous to disable snapshots if you are not interested in the intermediate output because writing snapshots can significantly increase disk I/O and simulation runtime. Conversely, enabling snapshots can provide extremely useful insight into the internal device physics.

The snapshot controls also allow you to reduce the output frequency. For example, rather than writing every timestep or every voltage point, the simulation can instead store every second, third, or fourth step depending on the level of detail required.

Viewing snapshots

If you double-click on a snapshot directory, OghmaNano launches the snapshot viewer. The snapshot viewer provides a slider bar allowing you to move through the simulation outputs sequentially.

Snapshots can store many different types of data including:

Multiple datasets can often be displayed simultaneously, allowing direct comparison between different physical quantities during the simulation.

Snapshot viewer showing electrical band structure.
Electrical band structure snapshots showing multiple datasets simultaneously.
Trap occupancy snapshot.
Trap occupancy distribution stored as a simulation snapshot.
Electric field within an FDTD simulation.
Electric field snapshots from an FDTD simulation.
3D FDTD optical field snapshot.
3D optical power density snapshot from an FDTD simulation.

Internally, snapshots are simply collections of datasets written at different stages of the simulation. The viewer hides most of the underlying complexity and presents the outputs using a unified interface with playback controls, plotting options, scaling controls, and colour mapping.

How does the snapshot directory work?

Although the snapshot viewer presents a simplified interface, the underlying directory structure is actually very straightforward.

If you open the snapshot directory directly in the operating system file browser, as shown in ??, you will see that the directory simply contains a large number of numbered folders.

Each numbered folder corresponds to a particular simulation state:

Snapshot directory containing numbered folders.
The snapshot directory containing numbered timestep or voltage-step folders.
Files stored inside a snapshot directory.
Files stored inside a single snapshot directory from an electrical simulation.

Inside each folder are the datasets associated with that particular simulation state. For electrical simulations these may include quantities such as:

Snapshots can be written either in human-readable CSV format or compact binary format, exactly as described in Understanding Output Files in OghmaNano.

In general, snapshots provide one of the most powerful ways to understand what is physically occurring inside a simulation because they expose the internal state of the device as the solver evolves toward the final solution.

💡 Tip: Large transient or FDTD simulations can generate extremely large numbers of snapshot files. Reducing the snapshot frequency can significantly reduce disk usage and simulation runtime.