Module plot2d

This IGM module generates 2D plan-view plots of a variable specified by the parameter var (e.g., var can be set to thk, ubar, etc.). The saving frequency is determined by the parameter processes.time.save defined in the time module. The color bar's scale range is controlled by the parameter varmax.

By default, the plots are saved as PNG files in the working directory. However, you can display the plot "live" by setting live to True.

If the particles module is activated, you can overlay particles on the plot by setting particles to True, or exclude them by setting it to False.

Config Structure

plot2d:
  editor: vs
  live: False
  particles: True
  var: "velbar_mag"
  var_max: 1000.0

Parameters

Name	Type	Units	Description	Default Value
editor	string	dimless	Optimized for VS code (vs) or spyder (sp) for live plot.	vs
live	boolean	dimless	Display plots live the results during computation instead of making png.	False
particles	boolean	dimless	Display particles is True, does not display if False.	True
var	string	dimless	Name of the variable to plot.	velbar_mag
var_max	float	dimless	Maximum value of the varplot variable used to adjust the scaling of the colorbar.	1000.0

Example Usage