Changes between Version 8 and Version 9 of AddFilterAlgorithm

Timestamp:

Nov 14, 2011, 9:11:28 AM (13 years ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm

@@ -7 +7 @@
 The internal structure of PDAF is organized into a generic part providing the infrastructure to perform ensemble forecasts and filter analysis steps. The generic part is independent of the particular filter algorithm and only distinguishes between ensemble based filters (all filters except SEEK) and mode based filters (currently only SEEK). The filter-specific routines are called through an internal interface.
 
-Each filter algorithm consists of a minimum of 6 routines. All routines are called trough the internal interface of PDAF, except for the "put state" routine (`PDAF_put_state_X` where X is the name of the selected filter). 
+Each filter algorithm consists of 6 routines that are described below. All routines are called trough the internal interface of PDAF, except for the "put state" routine (`PDAF_put_state_X` where X is the name of the selected filter). 
 
 == PDAF's Internal Interface ==
 
-Before explaining the detailed calling interface of each filter-specific routine, we provide an overview of the internal interface routines of PDAF. The internal interface of PDAF is structured as follows ('X' is the name of the filter algorithm):
+Before explaining the filter-specific routines and the calling interface of each routine, we provide an overview of the internal interface routines of PDAF. The internal interface of PDAF is structured as follows ('X' is the name of the filter algorithm):
 
 The routine `PDAF_init` calls
@@ -50 +50 @@
  * `PDAF_X_memtime`
 
+In addition, the routine
+ * `PDAF_put_state_X`
+has to be implemented.
+
+=== `PDAF_X_init` ===
+
+The routine `PDAF_X_init` performs the initialization of filter-specific parameters. In addition, it calls the user-supplied routine that initializes the initial model state ensemble.
+
+The interface is as follows:
+