pyPDAF.PDAF.iau_reset

pyPDAF.PDAF.iau_reset()

Modify the IAU type and the number of IAU time steps during a run

While pyPDAF.PDAF.iau_init() sets the IAU type and number of IAU steps initially, one can change these settings during a model run.

This function has to be called by all processes that are model processes. A common place is to call the function after an analysis step or in distribute_state_pdaf.

Parameters:

  • type_iau_in (int) –

      1. no IAU

      1. constant increment weight 1/nsteps_iau

      1. Linear IAU weight with maximum in middle of IAU period. This weight linearly increases and decreases. This type is usually used if the IAU is applied in re-running over the previous observation period.

      1. Zero weights for null mode (can be used to apply IAU on user side). This stores the increment information, but does not apply the increment. One can use pyPDAF.PDAF.iau_set_pointer() to access the increment array.

  • nsteps_iau_in (int) – number of time steps in IAU

Returns:

flag – Status flag

Return type:

int