polaris.tasks.ocean.realistic_global.dynamic_adjustment.checks.check_temperature_max

polaris.tasks.ocean.realistic_global.dynamic_adjustment.checks.check_temperature_max(value: float | None, when: float | None, temperature_max: float, stage_name: str, logger: Any) → None

Raise if the stage’s maximum temperature exceeds the threshold.

Parameters:

• value (float or None) – The largest temperature reached at any point in the stage, not only at its end, so a blow-up the run recovered from is still caught. None means the model reported no temperature, and there is nothing to check.

• when (float or None) – The day, measured from the start of the stage, at which that maximum occurred. Reported because where in a stage an extreme sits is most of the diagnosis. The caller is expected to have excluded the sample written before the first time step, which describes what the stage was handed rather than what it did, along with any part of the stage inside the sequence’s startup window.

• temperature_max (float) – The largest allowed temperature.

• stage_name (str) – The stage being checked.

• logger (logging.Logger) – A logger for the passing case.