hexedpy.utils.History_plot Class Reference

creates a real-time, interactive plot of the convergence history More...

Public Member Functions
	__init__ (self, directory="hexed_out", interval=0.2)
	creates and shows an animated history plot

Static Public Attributes
list	column_blacklist = ["flow_time", "time_step"]
	names of output columns not to plot

Protected Member Functions
	_infinite_generator (self)
	_read_new_lines (self)
	_init (self)
	_update (self, _)

Protected Attributes
	_stop
	_file_position
	_directory
	_interval
	_data
	_lines
	_plot_columns
	_fig
	_axs
	_curves

Detailed Description

creates a real-time, interactive plot of the convergence history

Convergence history is obtained from the output.txt file which contains the console output of hexecute. Every column in the output whose name is not in History_plot.column_blacklist will be plotted in its own subplot. Columns with names ending in residual will be plotted on a log scale. A History_plot instance should be created in a separate process from the solver but may be created before, after, or during the simulation—the plot will not appear until an output.txt file exists. A History_plot can be created directly from the HIL solver script with $plot_history.

Constructor & Destructor Documentation

__init__()

hexedpy.utils.History_plot.__init__	(		self,
			directory = "hexed_out",
			interval = 0.2 )

creates and shows an animated history plot

Parameters

directory	Convergence history will be obtained by looking for a file output.txt in directory.
interval	The plot will be updated every interval seconds to include new iterations.

Member Data Documentation

column_blacklist

list hexedpy.utils.History_plot.column_blacklist = ["flow_time", "time_step"]

static

names of output columns not to plot

You may modify this variable for the class or for instances

---

The documentation for this class was generated from the following file:

• python_package/hexedpy/utils.py