thunderboltz.ThunderBoltz.get_vdfs

ThunderBoltz.get_vdfs(steps='last', sample_cap=500000, particle_type=0, v=0)[source]

Read the electron velocities arrays within a ThunderBoltz calculation. Velocity units are in m/s. If velocity dump files are found corresponding to steps, update vdfs.

Parameters:

  • steps (str, list[int], or int) –

    Options for which time steps to read:

    • "last": Only read the VDF of the last time step

    • "first": Only read the VDF of the first time step

    • "all": Read a separate VDF for each time step.

    • list[int]: Read VDF for each time step included in list.

    • int: read VDF at one specific time step.

  • sample_cap (int) – Limit the number of samples read from the dump file for very large files. Default is 500000. If bool(sample_cap) evaluates to False, then no cap will be imposed.

  • particle_type (str, list[int], or int) –

    Specify which kinds of species data should be read from.

    • int: The particle type to read. Default is 0.

    • list[int]: A set of particle types to read.

    • "all": Read all particle types.

  • v (int) – Verbosity – 0: silent, 1: print file paths before reading.

Returns:

The particle velocity dump data.

Return type:

pandas.DataFrame

Warning

Large files are truncated to the first sample_cap lines. It is assumed that the particle ordering in the dump files is not correlated with any velocity statistics, but this may not be the case when egen is on. In that case, ensure the entire velocity dump file is being read.