| | 1 | = PDAF3_assim_offline_local = |
| | 2 | |
| | 3 | This page documents the routine `PDAF3_assim_offline_local` of PDAF. The routine is part of the advanced [wiki:PDAF3_interface PDAF3 interface] that was introduced with PDAF V3.0. |
| | 4 | |
| | 5 | 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 [wiki:ImplementAnalysislenkfOmi LEnKF]). The routine uses the functionalities provided by PDAF-OMI to yield a small number of arguments. For backward-compatibility, the routine does not use PDAFlocal, but lets the user provide the routines for filling the local state vector and to fill the global analysis state vectors with the local analysis states. This routine exists only for backward-compatibility. We recommend to use the routine [wiki:PDAF3_put_state] that uses also PDAFlocal. |
| | 6 | |
| | 7 | The routine is used for the offline coupled mode of PDAF, which is described on the page: [wiki:OfflineImplementationGuide Implementation Guide for Offline Coupling]. |
| | 8 | |
| | 9 | 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`). |
| | 10 | |
| | 11 | The interface when using one of the local filters is the following: |
| | 12 | {{{ |
| | 13 | SUBROUTINE PDAF3_assim_offline_local(U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & |
| | 14 | U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, & |
| | 15 | U_g2l_state, U_l2g_state, & |
| | 16 | U_prepoststep, status) |
| | 17 | }}} |
| | 18 | with the following arguments: |
| | 19 | * `U_init_dim_obs_pdafomi`: [[BR]]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. |
| | 20 | * `U_obs_op_pdafomi`: [[BR]]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. |
| | 21 | * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains |
| | 22 | * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain |
| | 23 | * `U_init_dim_obs_l_pdafomi`: [[BR]]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. |
| | 24 | * `U_g2l_state`: The name of the routine that initializes a local state vector from the global state vector |
| | 25 | * `U_l2g_state`: The name of the routine that initializes the corresponding part of the global state vector from the provided local state vector |
| | 26 | * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state` |
| | 27 | * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors. |
| | 28 | |
| | 29 | Notes: |
| | 30 | * 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. Further U_collect_state is not present. |
| | 31 | * The order of the routine names does not show the order in which these routines are executed. See the [ImplementAnalysisLocal#Executionorderofuser-suppliedroutines section on the order of the execution] on the page on implementing the analysis step of the local filter algorithms. |
| | 32 | * To use the localization in the ENSRF/EAKF, one needs to call [wiki:PDAFomi_set_localize_covar] in the observation modules to initialize the localization information. |
| | 33 | * It is recommended to check the value of `status_pdaf` in the program after the routine is executed. Only if its value is 0 the initialization was successful. |
| | 34 | |
| | 35 | The user-supplied call-back routines are described on the page on [ImplementAnalysisLocal implementing the analysis step of the local filters]. |
