Changes between Version 6 and Version 7 of AddFilterAlgorithm

Timestamp:

Nov 11, 2011, 4:23:18 PM (13 years ago)

Author:

lnerger

Comment:

--

AddFilterAlgorithm

@@ -1 +1 @@
 = Adding a Filter Algorithm to PDAF =
+
+[[PageOutline(2-3,Contents of this page)]]
 
 This text describes the implementation strategy and internal structure of PDAF valid for version 1.7.0 and later. If you use an earlier version of PDAF, we recommend to update to the most recent version. In this text, we assume that the reader is already familiar with PDAF to the extend of experience with the implementation of a model with PDAF that is described in the [ImplementationGuide implementation guide].
@@ -7 +9 @@
 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). 
 
-== Internal Interface of PDAF ==
+== PDAF's Internal Interface ==
 
-The internal interface of PDAF is stcructured as follows ('X' is the name of the filter algorithm):
+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):
 
 The routine `PDAF_init` calls
@@ -35 +37 @@
    * This routine contains the actual assimilation or analysis step of the filter algorithm.
 
+
 When `PDAF_init` is called, the filter algorithm is chosen by its ID number. Internally to PDAF, each filter is identified by a string that is defined in `PDAF_init_filters`. The interface routines have a very simple structure. In general, they select the filter-specific routine based on the string identifying the filters. When a filter algorithm is added a line for the corresponding filter-specific routine has to be inserted to each of the interface routines.