Changes between Version 10 and Version 11 of AddFilterAlgorithm

Timestamp:

Nov 14, 2011, 10:01:38 AM (14 years ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm

@@ -54 +54 @@
 has to be implemented.
 
+We recommend to base on the routines of an existing filter, as most of the routines can be easily adapted to a new filter method.
+
 === `PDAF_X_init` ===
 
@@ -64 +66 @@
 }}}
 with the following arguments:
- * `subtype`: The subtype index of the filter algorithm.
- * `param_int`: The array of integer parameters
+ * `subtype`: The subtype index of the filter algorithm [integer, input].
+ * `param_int`: The array of integer parameters [integer(dim_pint), input].
+ * `dim_pint`: The number of parameters in `param_int` [integer, input].
+ * `param_real`: The array of real parameters [real(dim_preal), input].
+ * `dim_preal`: The number of parameters in `param_real` [integer, input]
+ * `ensemblefilter`: Flag, whether the filter is an ensemble filter or a mode-based filter [logical, output].
+ * `fixedbasis`: Flag, whether the chosen `subtype` is a filter with fixed ensemble, such that only the ensemble mean is integrated by the model [logical, output].
+ * `verbose`: Verbosity flag [integer, input]. Valid are the values provided to `PDAF_init`.
+ * `outflag`: Error flag [integer, output]
 
 
 Please note:
- * The routine should check, whether the provided value of `subtype` is a valid choice. 
+ * The routine should check, whether the provided value of `subtype` is a valid choice. If this is not the case, the error flag should be set to 2.
+ * Only parameters from `param_int` and `param_real` up to the value `dim_pint` and `dim_preal` should be considered in the initialization. The array may be bigger, but the user defined which parameters are to be used be setting the values of `dim_pint` and `dim_preal`.
+ * The logical flags `ensemblefilter` and `fixedbasis` have o set in the routine.
+ * The error flag `outflag` is initial set to 0. 
+ * The internal parameters are declared and stored in the Fortran module `PDAF_mod_filter`. If a new filter algorithm requires additional parameters, their declaration should be added to the module. 
+