Changes between Version 2 and Version 3 of ImplementanalysisPDAF3Global

Timestamp:

May 25, 2025, 12:13:20 PM (7 days ago)

Author:

lnerger

Comment:

--

ImplementanalysisPDAF3Global

@@ -33 +33 @@
 == Overview ==
 
-This page describes the recommended implementation of the analysis step using the universal routines of the PDAF3 interface. 
+This page describes the recommended implementation of the analysis step specific for global ensemble filters and LEnKF (Thus the filters: ESTKF, ETKF, SEIK, EnKF, NETF, PF, and LEnKF). 
 
-PDAF3 provides universal routines for the analysis step, which only distinguish whether the online or offline mode is used. 
+|| We recommend to only use this variant if one only runs global filters. As soon as one also intends to use local filters, like the LESTKF or LETKF, we recommend to use the [wiki:ImplementAnalysisPDAF3Universal implementation using the using the universal routines of the PDAF3 interface]. ||
+
+The PDAF3 routines for the analysis step only distinguish whether the online or offline mode is used. 
 
 For the analysis step we need different operations related to the observations. These operations are requested by PDAF by call-back routines supplied by the user and provided in the observation modules using PDAF-OMI. The names of the routines that are provided by the user are specified in the call to the assimilation routine `PDAF3_assimilate`. 
@@ -90 +92 @@
 
 This routine exists for backward-compatibility. In implementations that were done before the release of PDAF V3.0, a 'put_state' routine was used for the `flexible` parallelization variant and for the offline mode. 
-When the 'flexible' implementation variant is chosen for the assimilation system, the routine. The routine `PDAF3_put_state` allows to port such implemnetations to the PDAF3 interface with minimal changes.
+When the 'flexible' implementation variant is chosen for the assimilation system, the routine. The routine `PDAF3_put_state_global` allows to port such implementations to the PDAF3 interface with minimal changes.
 The interface of the routine is identical with that of `PDAF3_assimilate_global`, except that the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 
 
@@ -160 +162 @@
 The user-supplied routines are executed in the order listed below. The order can be important as some routines can perform preparatory work for routines executed later on during the analysis. 
 
-Before the analysis step is called the following is executed by `PDAF3_assimilate` and `PDAF3_put_state`:
+Before the analysis step is called the following is executed by `PDAF3_assimilate_global` and `PDAF3_put_state_global`:
  1. [#collect_state_pdafcollect_state_pdaf.F90 collect_state_pdaf] (called once for each ensemble member)
  1. [#prepoststep_pdafprepoststep_ens_pdaf.F90 prepoststep_pdaf] (Call to act on the forecast ensemble, called with negative value of the time step)
@@ -171 +173 @@
  1. [#prepoststep_pdafprepoststep_ens_pdaf.F90 prepoststep_pdaf] (Call to act on the analysis ensemble, called with (positive) value of the time step)
 
-In case of the routine `PDAF3_assimilate`, the following routines are executed after the analysis step:
+In case of the routine `PDAF3_assimilate_global`, the following routines are executed after the analysis step:
  1. [#distribute_state_pdafdistribute_state_pdaf.F90 distribute_state_pdaf]
  1. [#next_observation_pdafnext_observation_pdaf.F90 next_observation_pdaf]