polaris.tasks.ocean.realistic_global.dynamic_adjustment.checks.check_cfl_max

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

Raise if the stage went above the allowed CFL number at any point.

A stability guard rather than a physical one, and it applies to every stage rather than to a trend: a schedule whose time step is too long for its stage shows up here before it shows up as a blow-up, and it stays caught even if the run happens to survive.

value is None when the model reports no CFL number, which is the case for Omega. See check_temperature_max() for the arguments.