Changes between Version 7 and Version 8 of AddFilterAlgorithm_PDAF3

Timestamp:

Jun 5, 2025, 4:08:26 PM (9 months ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm_PDAF3

@@ -48 +48 @@
 == Internal code structure of a DA method ==
 
-=== Modules of a DA method ===
+=== Fortran Modules  ===
 
 Each DA method in PDAF consist of 5 standard modules. These are
@@ -170 +170 @@
 === `PDAF_X_set_iparam` ===
 
-This routine 
+This routine sets integer parameters for the DA method. It is called either by `PDAF_X_init` or by `PDAF_set_iparam` via `PDAF_set_iparam_filters`.
+
+The parameters in PDAF are linked to an index. This index is explicitly used when one creates in the user code the real parameter array (`filter_param_i` in the template code and tutorials). In `PDAF_X_set_iparam` one uses the index `id` to select which parameter is initialized.
+
+There are a few parameters which are used with the same id for all DA methods. We recommend to stick to these indices to avoid irritations:
+||= id =||= parameter =||= Decription =||
+|| 1 || `dim_p`  || state dimension, set via `PDAF_reset_dim_p` ||
+|| 2 || `dim_ens` || ensemble size, set via `PDAF_reset_dim_ens` ||
+|| 8 || `observe_ens` || Whether to apply obsevation operator ensmeble mean or all ensemble states ||
+|| 9 || `type_obs_init` || Whether to initialize observations (0) before or (1) after prepoststep ||
+
+
+Additional parameters are recommended to use the following index. We recommend to stick to these indices to avoid irritations. The 3D-Var methods have partly different indices, because the solvers have to be configured:.||= id =||= parameter =||= Decription =||
+|| 3 || `dim_lag` || Smoother lag ||
+|| 5 || `type_forget` || Type for ensemble inflation ||
+|| 6 || `type_trans` || Type of ensemble transformation ||
+
+For further parameters we recommend to check the [wiki:AvailableOptionsforInitPDAF page on available options for each DA method]. 
+
 
 === `PDAF_X_set_rparam` ===
 
+This routine sets real-values parameters for the DA method. It is called either by `PDAF_X_init` or by `PDAF_set_rparam` via `PDAF_set_rparam_filters`.
+
+The parameters in PDAF are linked to an index. This index is explicitly used when one creates in the user code the real parameter array (`filter_param_r` in the template code and tutorials). In `PDAF_X_set_rparam` one uses the index `id` to select which parameter is initialized.
+
+There is one parameters which are used with the same id for all DA methods:
+||= id =||= parameter =||= Decription =||
+|| 1 || `forget`  || Value of inflation parameter (usually the 'forgetting factor' ||
+
+Some DA methods, in particular the nonlinear filters and the 3D-Var methods use additional real-valued parameters. We recommend to check the [wiki:AvailableOptionsforInitPDAF page on available options for each DA method] to obtain an overview. 
+
+
 === `PDAF_X_options` ===
 
-The routine `PDAF_X_options` displays information on the available options for the filter algorithm. 
+This routine `PDAF_X_options` displays information on the available options for the filter algorithm. 
 
 The template shows the typical form of the output. 
@@ -183 +212 @@
 
 
-
-
 === `PDAF_X_memtime` ===
 
@@ -196 +223 @@
 == Analysis routines of DA method ==
 
-=== `PDAF_assimilate_X` / `PDAF_put_state_X` ===
+=== `PDAF_assimilate_X` ===
 
 These routines are called by `PDAFomi_assimilate_*` or `PDAFomi_put_state_*`, which are directly inserted into the model code, if the online mode of PDAF is used together with PDAF-OMI. The description of the [ImplementationofAnalysisStep implementation of the analysis step] in the Implementation Guide explains the interface for the algorithms that are included in the PDAF package. `PDAFomi_assimilate_*` are interface routines for PDAF-OMI and call the `PDAF_assimilate_X` routines as described above. (Likewise the routines `PDAFomi_put_state_*` call `PDAF_put_state_X`.)
@@ -239 +266 @@
 The structure of the operations in `PDAF_X_update` can be designed freely when implementing a new DA method. The existing methods follow the recommended structure in which `PDAF_X_update` only performes preparations for the actual analysis update and then calls `PDAF_X_analysis` for the computation of the actual update. Here, the operations are different for global and local methods.
 
+=== `PDAF_assim_offline_X` ===
+
+=== `PDAF_put_state_X` ===
+
+=== `PDAFX_update` ===
+
+=== `PDAFX_analysis` ===
+
+
+
 === Global Methods ===