pgkyl gk_particle_balance

Usage: pgkyl gk_particle_balance [OPTIONS]

  Plot (and compute) the particle balance of a single species.

  Requires ``<name>-<species>_fdot_integrated_moms.gkyl``; and (only if the run had
  sources or non-periodic boundaries) ``<name>-<species>_source_integrated_moms.gkyl``
  and ``<name>-<species>_bflux_<direction><side>_integrated_HamiltonianMoments .gkyl``
  files. If ``relative_error`` is requested, ``<name>-<species>_integrated_moms.gkyl``
  and ``<name>-dt.gkyl`` are also required.

Options:
  -n, --name TEXT                 Simulation name (also the file prefix).  [required]
  -s, --species TEXT              Species name.  [required]
  -p, --path TEXT                 Directory holding the simulation output.  [default:
                                  ./]
  -r, --relative_error [BOOLEAN]  Plot the relative error instead of every balance term.
                                  [default: False]
  -m, --multib TEXT               ``"-10"`` (default) for a single block; ``"-1"`` to
                                  discover every block; otherwise a comma list or
                                  ``'start:stop[:step]'`` slice of block indices.
                                  [default: -10]
  -f, --fdot_file TEXT            Explicit distribution derivative moments path
                                  override.
  --source_file TEXT              Explicit source moments path override.
  -b, --bflux_files TEXT          Optional per-boundary path overrides, keyed by
                                  ``"<direction><side>"``; unlisted boundaries use the
                                  naming convention.
  --f_file TEXT                   Explicit integrated distribution moments path
                                  override.
  -d, --dt_file TEXT              Explicit time-step history path override. In path
                                  overrides, ``*`` stands for the block index.
  -l, --logy [BOOLEAN]            Log-scale the y axis.  [default: False]
  -a, --absy [BOOLEAN]            Take the absolute value of every trace before
                                  plotting.  [default: False]
  -x, --xlabel TEXT               Horizontal-axis label.  [default: Time (s)]
  -y, --ylabel TEXT               Vertical-axis label.
  -t, --title TEXT                Figure title.
  -i, --indent_left FLOAT         Horizontal axes-position adjustment in figure units.
                                  [default: 0.0]
  --add_width FLOAT               Axes-width adjustment in figure units.  [default: 0.0]
  --show [BOOLEAN]                Call ``plt.show()`` before returning.  [default:
                                  False]
  --saveas TEXT                   If given, save the figure to this path.
  --help                          Show this message and exit.

Python API