PDAF_put_state_etkf_si

This page documents the routine PDAF_put_state_etkf_si of PDAF.

PDAF_put_state_etkf_si is the variant of PDAF_put_state_etkf with the simplified interface. The difference between both routines is that in the simplified interface the names of the call-back subroutines are not specified. Instead the routine assumes that the call-back routines have a standard name as specified at the end of this page.

The routine is typically called in assimilate_pdaf or directly in the model code.

The routines PDAF_put_state_* are used with the 'flexible' implementation variant of PDAF. The general aspects of the filter specific routines PDAF_put_state_* are described on the page Modification of the model code for the ensemble integration and its sub-page on inserting the analysis step. For the 'fully parallel' implementation variant the alternative routines PDAF_assimilate_*_si are used.

The interface when using the ETKF is the following:

  SUBROUTINE PDAF_put_state_etkf_si(status_pdaf)

with the following arguments:

• status_pdaf: The integer status flag. It is 0, if PDAF_put_state_etkf_si is exited without errors.

The routine calls several user-supplied call-back routines. They are described on the page on implementing the analysis step of the ETKF algorithm.

It is recommended that the value of status_pdaf is checked in the program after PDAF_put_state_etkf_si is executed. Only if its value is 0 the initialization was successful.