PDAF_assimilate_enkf_si
This page documents the routine PDAF_assimilate_enkf_si
of PDAF.
PDAF_assimilate_enkf_si
is the variant of PDAF_assimilate_enkf 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 general aspects of the filter specific routines PDAF_assimilate_*
are described on the page Modification of the model code for the ensemble integration and its sub-page on inserting the analysis step. The routine is used in the fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant, the routines `PDAF_put_state_*' are used.
The interface when using the EnKF is the following:
SUBROUTINE PDAF_assimilate_enkf_si(status_pdaf)
with the following arguments:
status_pdaf
: The integer status flag. It is zero, ifPDAF_assimilate_enkf_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 EnKF.
It is recommended that the value of status_pdaf
is checked in the program after PDAF_assimilate_enkf is executed. Only if its value is 0 the initialization was successful.