mufem.ReportManager

class mufem.ReportManager

Bases: pybind11_object

Class responsible for managing simulation reports.

Reports gather simulation results and may be exported at the end of a run or at intervals.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)
add_report(self, report)	Add a report to the manager.
add_reports(self, reports)	Add multiple reports to the manager.
clear_reports(self)	Remove all registered reports.
get_report(self, report_name)	Retrieve a report by name.

add_report(self: mufem.ReportManager, report: mufem.ReportTrait) → None

Add a report to the manager.

Parameters:

report (ReportTrait) – The report to add.

add_reports(self: mufem.ReportManager, reports: List[mufem.ReportTrait]) → None

Add multiple reports to the manager.

Parameters:

reports (SharedList[ReportTrait]) – The list of reports to add.

clear_reports(self: mufem.ReportManager) → None

Remove all registered reports.

get_report(self: mufem.ReportManager, report_name: str) → mufem.ReportTrait

Retrieve a report by name.

Parameters:

report_name (str) – The name of the report.

Returns:

The requested report.

Return type:

ReportTrait

Raises:

RuntimeError – If the report does not exist.