pyPDAF.PDAF.reset_fcst_flag

pyPDAF.PDAF.reset_fcst_flag() → int

Return PDAF’s forecast-time reset flag.

PDAF uses this flag in the flexible parallelization mode when an assimilation routine PDAF_assimilate_* is used instead of a PDAF_put_state_* routine. A nonzero value tells the user-side model integration to reset its model time before continuing the forecast.

Returns:

reset_fcst_flag – Internal PDAF flag indicating whether the user-side model time should be reset.

Return type:

int