Changes between Version 10 and Version 11 of PDAF3_assimilate_local

Timestamp:

Apr 26, 2025, 11:57:40 AM (2 days ago)

Author:

lnerger

Comment:

--

PDAF3_assimilate_local

@@ -3 +3 @@
 This page documents the routine `PDAF3_assimilate_local`. The routine is part of the advanced [wiki:PDAF3_interface 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 LKNETF, 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_assimilate] that uses also PDAFlocal.
+|| The routine is universal and can be used to execute the analysis step of all, local and global, ensemble filters. The routine uses the functionalities provided by PDAF-OMI to yield a small number of arguments. This routine exists for backward-compatibility for which 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 allows to easily transfer from using PDAFomi_assimilate_local of PDAF 2. Generally, we recommend to use the routine [wiki:PDAF3_assimilate] that uses also PDAFlocal. ||
 
 The routine is typically called in `assimilate_pdaf` or directly in the model code.
@@ -34 +34 @@
 
 **Notes:**
- * The routine is identical to the routine `PDAFomi_assimilate` of PDAF 2.3, except that the argument `U_prepostep` is at a different place here.
+ * The routine is identical to the routine `PDAFomi_assimilate_local` of PDAF 2.3, except that the argument `U_prepostep` has been moved to a  different place.
  * 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. 
  * 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.
+ * If one only uses the global filters or the LEnKF and ENSRF/EAKF, the routines `U_init_n_domains`, `U_init_dim_l`, `U_init_dim_obs_l_pdafomi`, `U_g2l_state`, `U_l2g_state` only need to be present. Because they are never called for global filters, they do not need to be completed with functionality. For example, one can just use the template files for these routines.
+ * If one only uses the global filters and the LEnKF one can also use alternative routine [wiki:PDAF3_assimilate_global], in which the routines for localization are not in the interface.
  * 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.