presets module

Define keyword arguments to generate SimulationOutputEvaluator.

This presets showcase the how evaluators can be created. It is however best practices to create your own presets in a dedicated module in your project folder.

If you want to add your preset to this file, you must also add it’s key in the config.evaluators.

Todo

Only one reference for the existing evaluators. Here or the configuration module. Here would be better, as configuration handling will evolve.

presets_for_fault_scenario_rel_diff_at_some_element(quantity: str, elt: Element | str, ref_simulation_output: SimulationOutput) → dict[str, Callable | int | str | tuple[Callable]]

Create the settings to evaluate a difference @ some element exit.

Used for FaultScenario s.

presets_for_fault_scenario_rms_over_full_linac(quantity: str, ref_simulation_output: SimulationOutput) → dict[str, Callable | int | str | tuple[Callable]]

Create the settings to evaluate a RMS error over full linac.

Used for FaultScenario s.