pyPDAF.PDAF.iau_init

pyPDAF.PDAF.iau_init()

Initialise parameters for incremental analysis updates, IAU.

It further allocates the array in which the ensemble increments are stored. This array exists on all processes that are part of model tasks.

This is usually called after pyPDAF.PDAF.init(). It is important that this is called by all model processes because all these processes need the information on the IAU configuration and need to allocate the increment array.

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