Changes between Version 5 and Version 6 of AddFilterAlgorithm_PDAF3

Timestamp:

Jun 5, 2025, 1:56:12 PM (8 months ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm_PDAF3

@@ -1 @@
-= Adding an Assimilation Method to PDAF =
+= Adding a Data Assimilation Method to PDAF =
 
 [[PageOutline(2-3,Contents of this page)]]
@@ -112 +112 @@
 When a filter algorithm is added, the following filter routines have to be implemented and inserted to each interface routines described above.
 
- * `PDAF_X_init`
- * `PDAF_X_alloc`
- * `PDAF_X_options`
- * `PDAF_X_set_iparam`
- * `PDAF_X_set_rparam`
- * `PDAF_X_config
- * `PDAF_X_memtime`
+ * [#PDAF_X_init PDAF_X_init]
+ * [#PDAF_X_alloc PDAF_X_alloc]
+ * [#PDAF_X_options PDAF_X_options]
+ * [#PDAF_X_set_iparam PDAF_X_set_iparam]
+ * [#PDAF_X_set_rparam PDAF_X_set_rparam]
+ * [#PDAF_X_config PDAF_X_config]
+ * [#PDAF_X_memtime PDAF_X_memtime]
 
 These routines are contained in the module `PDAF_X`.
@@ -161 +161 @@
 === `PDAF_X_config` ===
 
-The routine prints the informstion on the chosen configuration. It is called at the end of the configuration phase when `PDAF_init_forecast` is claled for the online mode, or one of the 'assim_offline' routines (e.g. PDAF3_assim_offline) for the offline mode.
-
-The tempalte show the typical form of the output.
-
+The routine prints the information on the chosen configuration. It is called at the end of the configuration phase when `PDAF_init_forecast` is called for the online mode, or one of the 'assim_offline' routines (e.g. PDAF3_assim_offline) for the offline mode.
+
+The template shows the typical form of the output. 
+
+Note that a DA method can also run without implementing this routine. However, for consistency it should be implemented.
+
+
+=== `PDAF_X_set_iparam` ===
+
+
+
+=== `PDAF_X_set_rparam` ===
 
 === `PDAF_X_options` ===
 
-The optional routine `PDAF_X_options` displays information on the available options for the filter algorithm. 
-
-The routine has no arguments. Thus the interface is as follows:
-{{{
-  SUBROUTINE PDAF_X_options()
-}}}
-
-The following display is recommended:
- * Available subtypes (At least '0' for standard implementation)
- * Parameters used from the parameter arrays `param_int` and `param_real`.
+The routine `PDAF_X_options` displays information on the available options for the filter algorithm. 
+
+The template shows the typical form of the output. 
+
+Note that a DA method can also run without implementing this routine. However, for consistency it should be implemented.