Changes between Version 19 and Version 20 of AddFilterAlgorithm

Timestamp:

Dec 4, 2011, 1:43:13 PM (12 years ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm

@@ -22 +22 @@
 
 
-The routine `PDAF_get_state` calls
- * `PDAF_initinfo_filters` - interface routine to `PDAF_X_initinfo`
-   * `PDAF_X_initinfo` displays information on the chosen configuration of the filter algorithm. This functionality is optional.
-
-
 The routine `PDAF_print_info` only includes the interface to `PDAF_X_memtime`
  * `PDAF_X_memtime` displays information on the execution duration of the different parts of the assimilation process as well as information on the amount of allocated memory. This functionality is optional.
@@ -33 +28 @@
 The routine `PDAF_put_state_X` is called directly from the model code. There is a separate routine for each filter, mainly because of the fact that different user-supplied routines may be needed for the analysis step of the filter. However, the operations performed directly in `PDAF_put_state_X` are widely generic and the filter-specific analysis step is typically implemented as another subroutine.
 The standard implementation calls
- * `PDAF_X_initinfo`
-   * This is the same routine that is called by `PDAF_get_state`. Here, it is only called, if the offline mode of PDAF is used.
  * `PDAF_X_update`
    * This routine contains the actual assimilation or analysis step of the filter algorithm. 
@@ -57 +50 @@
  * `PDAF_X_init`
  * `PDAF_X_alloc`
- * `PDAF_X_options`
- * `PDAF_X_initinfo`
- * `PDAF_X_memtime`
+ * `PDAF_X_options` (optional)
+ * `PDAF_X_memtime` (optional)
 
 In addition, the routine
@@ -136 +128 @@
 
 
-
-=== `PDAF_X_initinfo` ===
-
-The optional routine `PDAF_X_initinfo` displays information on the chosen configuration of the filter algorithm.
-
-The interface is as follows:
-{{{
-  SUBROUTINE PDAF_X_initinfo()
-}}}
-It has no arguments!
-
-The following functionality is recommended:
- * Display the name of the filter method
- * Display a string about the selected subtype of the filter method
- * Display the ensemble size and value of the forgetting factor
- * Display additional information on options selected by entries in the parameter arrays `param_int` and `param_real`