Public Member Functions
	__init__ (self, model, analysis_folder, analysis_prefix)
	analysis_save (self, iplot)
	load_analysis (self)
	digest_perf_history (self)
	plot_perf_history (self, close_plots=True, figsize=(8, 5), dpi=200)

Public Attributes
	model = model
	analysis_prefix = os.path.join(analysis_folder, analysis_prefix)
	plot_prefix = os.path.join(analysis_folder, "plot_" + analysis_prefix)
str	json_data_filename = self.analysis_prefix + ".json"
	plot_filename = self.plot_prefix

Detailed Description

Analysis utility to report performance during the simulation as well as some metrics regarding walltime and step counts.

Definition at line 17 of file PerfHistory.py.

Constructor & Destructor Documentation

◆ init()

shamrock.utils.analysis.PerfHistory.PerfHistory.__init__	(	self,
		model,
		analysis_folder,
		analysis_prefix )

Definition at line 22 of file PerfHistory.py.

Member Function Documentation

◆ analysis_save()

shamrock.utils.analysis.PerfHistory.PerfHistory.analysis_save	(		self,
			iplot )

Definition at line 31 of file PerfHistory.py.

◆ digest_perf_history()

shamrock.utils.analysis.PerfHistory.PerfHistory.digest_perf_history ( self )

Definition at line 69 of file PerfHistory.py.

◆ load_analysis()

shamrock.utils.analysis.PerfHistory.PerfHistory.load_analysis ( self )

Definition at line 64 of file PerfHistory.py.

◆ plot_perf_history()

shamrock.utils.analysis.PerfHistory.PerfHistory.plot_perf_history	(	self,
		close_plots = True,
		figsize = (8, 5),
		dpi = 200 )

Definition at line 127 of file PerfHistory.py.

Member Data Documentation

◆ analysis_prefix

shamrock.utils.analysis.PerfHistory.PerfHistory.analysis_prefix = os.path.join(analysis_folder, analysis_prefix)

Definition at line 25 of file PerfHistory.py.

◆ json_data_filename

shamrock.utils.analysis.PerfHistory.PerfHistory.json_data_filename = self.analysis_prefix + ".json"

Definition at line 28 of file PerfHistory.py.

◆ model

shamrock.utils.analysis.PerfHistory.PerfHistory.model = model

Definition at line 23 of file PerfHistory.py.

◆ plot_filename

shamrock.utils.analysis.PerfHistory.PerfHistory.plot_filename = self.plot_prefix

Definition at line 29 of file PerfHistory.py.

◆ plot_prefix

shamrock.utils.analysis.PerfHistory.PerfHistory.plot_prefix = os.path.join(analysis_folder, "plot_" + analysis_prefix)

Definition at line 26 of file PerfHistory.py.

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

pylib/shamrock/utils/analysis/PerfHistory.py

Public Member Functions

Public Attributes