CADETProcess.comparison.Comparator.add_reference

CADETProcess.comparison.Comparator.add_reference#

Comparator.add_reference(reference: SolutionBase, update: bool | None = False, smooth: bool | None = False) None[source]#

Add reference to the Comparator.

Parameters:
referenceSolutionBase

Reference for comparison with SimulationResults.

updateOptional[bool], default=False

If True, update existing reference.

smoothOptional[bool], default=False

If True, smooth data before comparison.

Raises:
TypeError

If reference is not an instance of SolutionBase.

CADETProcessError

If Reference already exists.