PDAFlocalomi_put_state

This page documents the routine PDAF_put_state_local of PDAF using the PDAFlocal interface that was introduced with PDAF V2.3. The routine is used to execute the analysis step of all local ensemble filters including the nonlinear filter LNETF (but except the LEnKF) with PDAF-OMI.

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

The general aspects of the filter specific routines PDAFomi_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 in the 'flexible' parallelization implementation variant of the data assimilation system. With the 'fully-parallel' implementation variant, the routine PDAFomi_assimilate_local is used.

The interface for the routine PDAFlocalomi_put_state contains names for routines that operate on the local analysis domains (marked by the suffix _l). Here, we list the full interface of the routine.

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

  SUBROUTINE PDAFlocalomi_put_state(U_collect_state, &
                                  U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
                                  U_prepoststep, U_init_n_domains, U_init_dim_l, &
                                  U_init_dim_obs_l_pdafomi, 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
• U_obs_op_pdafomi: The name of the user-supplied routine that acts as the observation operator on some state vector
• U_prepoststep: The name of the pre/poststep routine as in PDAF_get_state
• U_init_n_domains: The name of the routine that provides the number of local analysis domains
• U_init_dim_l: The name of the routine that provides the state dimension for a local analysis domain
• U_init_dim_obs_l_pdafomi: The name of the routine that initializes the size of the observation vector for a local analysis domain
• status: The integer status flag. It is zero, if the routine is exited without errors.

Note:

• 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.

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.

PDAF also has a Simplified Interface providing the routine PDAFlocalomi_put_state_si. In the simplified interface, the name of the user-supplied routines have predefined names and do not appear in the call to PDAFlocalomi_put_state_si. More information on the pre-defined names is provided in the page on implementing the analysis step of the local filters.