Changes between Version 44 and Version 45 of AddFilterAlgorithm

Timestamp:

Nov 30, 2020, 5:29:43 PM (4 years ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm

@@ -163 +163 @@
 
 
-=== `PDAF_put_state_X` / `PDAF_assimilate_X` ===
+=== `PDAFomi_put_state_X` / `PDAFomi_assimilate_X` ===
 
 One of these routines is directly inserted into the model code, if the online mode of PDAF is used. The text on the [ImplementationofAnalysisStep implementation of the analysis step] in the Implementation Guide explains the interface for the algorithms that are included in the PDAF package. Apart from the usual integer status flag, the interface contains the names of the user-supplied routines that are required for the analysis step. Usually, the minimum set of routines are:
@@ -169 +169 @@
  * A routine that determines the size of the observation vector (`U_init_dim_obs`).
  * A routine that contains the implementation of the observation operator (`U_obs_op`).
- * A routine that fills the observation vector (`U_init_obs`).
  * The pre- and post-step routine in which the forecast and analysis ensembles can be analyzed (`U_prepoststep`).
-Additional routines are possible depending on the requirements of the filter algorithm. When one implements a new filter, one should check, which of the existing routines can be reused. This will facilitate the switching between different filter methods. For example, the SEIK, ETKF, and ESTKF filters (as well as the LSEIK, LETKF, and LESTKF algorithms) use the identical set of user-supplied routines. Thus, switching between these filters is possible without additional implementation work.
+Additional routines are possible depending on the requirements of the filter algorithm. When one implements a new filter, one should check, if the filter is compatible with the existing local or global filters. In this case, support for the new filter can be added into one of the existing routines (PDAFomi_assimilate_global/PDAFomi_assimilate_local or likewise PDAFomi_put_state_global/PDAFomi_put_state_local).
+For working without OMI one can check if one of the existing routines can be reused. This will facilitate the switching between different filter methods. 
 
-With regard to the operations, `PDAF_put_state_X` prepares for the actual analysis step, that is called inside `PDAF_put_state_X` as a separate routine. The required operations are:
+With regard to the operations, `PDAFomi_put_state_X` and `PDAF_put_state_X` prepare for the actual analysis step, that is called inside these routines as a separate routine. The required operations are:
  * Write model fields back into the ensemble array (by calling `U_collect_state`)
  * Increment the counter for the integrated ensemble members (named `counter` and provided by the module `PDAF_mod_filter`.