PDAF_assim_offline_lseik

This page documents the routine PDAF_assim_offline_lseik of PDAF. The routine was introduced with PDAF V3.0.

The routine is used for the offline coupled mode of PDAF, which is described on the page: Implementation Guide for Offline Coupling.

The interface when using the LSEIK filter is the following:

  SUBROUTINE PDAF_assim_offline_lseik(U_init_dim_obs_f, U_obs_op_f, U_init_obs_f, &
                                  U_init_obs_l, U_prepoststep, U_prodRinvA_l, U_init_n_domains, &
                                  U_init_dim_l, U_init_dim_obs_l, &
                                  U_g2l_state, U_l2g_state, U_g2l_obs, &
                                  U_init_obsvar, U_init_obsvar_l, status_pdaf)

with the following arguments:

• U_init_dim_obs_f: The name of the user-supplied routine that provides the size of the full observation vector
• U_obs_op_f: The name of the user-supplied routine that acts as the full observation operator on some state vector
• U_init_obs_f: The name of the user-supplied routine that initializes the full vector of observations
• U_init_obs_l: The name of the user-supplied routine that initializes the vector of observations for a local analysis domain
• U_prepoststep: The name of the pre/poststep routine as in PDAF_get_state
• U_prodRinvA_l: The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF.
• 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: The name of the routine that initializes the size of the observation vector for a local analysis domain
• U_g2l_state: The name of the routine that initializes a local state vector from the global state vector
• U_l2g_state: The name of the routine that initializes the corresponding part of the global state vector from the the provided local state vector
• U_g2l_obs: The name of the routine that initializes a local observation vector from a full observation vector
• U_init_obsvar: The name of the user-supplied routine that provides a global mean observation error variance (This routine will only be executed, if an adaptive forgetting factor is used)
• U_init_obsvar_l: The name of the user-supplied routine that provides a mean observation error variance for the local analysis domain (This routine will only be executed, if a local adaptive forgetting factor is used)
• status_pdaf: 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 LSEIK filter.

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

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.