PDAF3_put_state_local

This page documents the routine PDAF3_put_state_local of PDAF. The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0.

The routine is used to execute the analysis step of all local ensemble filters including the nonlinear filter LNETF, the hybrid filter LKENTF, and the ENSRF/EAKF (but except the LEnKF). The routine uses the functionalities provided by PDAF-OMI and PDAFlocal to yield a minimum number of arguments.

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

The general aspects of the filter specific routines PDAF3_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.

The routine is used for the offline mode of PDAF. It can also be used in the 'flexible' parallelization implementation variant of the data assimilation system, but starting with PDAF-3 we recommend to use PDAF3_assimilate_local, which is also used with the 'fully-parallel' implementation variant.

The interface for the routine PDAF3_put_state_local contains names for routines that operate on the local analysis domains (marked by the suffix _l).

The interface when using one of the local filters is the following:

  SUBROUTINE PDAF3_put_state_local(U_collect_state, &
             U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
             U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
             U_prepoststep, status)

with the following arguments:

• U_collect_state:
  The name of the user-supplied routine that initializes a state vector from the array holding the ensemble of model states from the model fields. This is basically the inverse operation to U_distribute_state used in PDAF_get_state and also here.
• U_init_dim_obs_pdafomi:
  The name of the user-supplied routine that initializes the observation information and provides the size of observation vector. This routine is part of an OMI observation module.
• U_obs_op_pdafomi:
  The name of the user-supplied routine that acts as the observation operator on some state vector. This routine is part of an OMI observation module.
• U_init_n_domains:
  The name of the user-supplied routine that provides the number of local analysis domains
• U_init_dim_l:
  The name of the user-supplied routine that provides the state dimension for a local analysis domain
• U_init_dim_obs_l_pdafomi:
  The name of the user-supplied routine that initializes the size of the observation vector for a local analysis domain. This routine is part of an OMI observation module.
• U_prepoststep:
  The name of the user-supplied pre/poststep routine as in PDAF_get_state
• status:
  The integer status flag. It is zero, if the routine is exited without errors.

Notes:

• The routine is identical to the routine PDAFlocalomi_put_state of PDAF 2.3, except that the argument U_prepostep is at a different place here.
• The order of the routine names does not show the order in which these routines are executed. See the section on the order of the execution on the page on implementing the analysis step of the local filter algorithms.
• To use the localization in the ENSRF/EAKF, one needs to call PDAFomi_set_localize_covar in the observation modules to initialize the localization information.

The user-supplied call-back routines are described on the page on implementing the analysis step of the local filters.

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