Changes between Version 6 and Version 7 of AddFilterAlgorithm_PDAF3


Ignore:
Timestamp:
Jun 5, 2025, 3:35:37 PM (6 weeks ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • AddFilterAlgorithm_PDAF3

    v6 v7  
    133133=== `PDAF_X_init` ===
    134134
    135 The routine `PDAF_X_init` performs the initialization of filter-specific parameters.
     135This routine `PDAF_X_init` performs the initialization of filter-specific parameters.
    136136
    137137The routine usually performs the following operations:
    … …  
    154154=== `PDAF_X_alloc` ===
    155155
    156 The routine `PDAF_X_alloc` allocates arrays for the DA method. These are the arrays that are used in the forecasting and hence need to be persistently allocated, like the ensemble array and a state vector. The success of the allocation is checked.
     156This routine `PDAF_X_alloc` allocates arrays for the DA method. These are the arrays that are used in the forecasting and hence need to be persistently allocated, like the ensemble array and a state vector. The success of the allocation is checked.
    157157
    158158For the arrays provided by the PDAF framework, the allocation is usually done by calling `PDAF_alloc`, see [wiki:PDAF_alloc page on PDAF_alloc].
    … …  
    161161=== `PDAF_X_config` ===
    162162
    163 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.
     163This 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.
    164164
    165165The template shows the typical form of the output.
    … …  
    170170=== `PDAF_X_set_iparam` ===
    171171
    172 
     172This routine
    173173
    174174=== `PDAF_X_set_rparam` ===
    … …  
    187187=== `PDAF_X_memtime` ===
    188188
    189 The optional routine `PDAF_X_memtime` displays information about allocated memory and the execution time of different parts of the filter algorithm.
    190 
    191 The interface is as follows:
    192 {{{
    193   SUBROUTINE PDAF_X_memtime(printtype)
    194 
    195   INTEGER, INTENT(in) :: printtype    ! Type of screen output: 
    196                                       ! (1) general timings
    197                                       ! (3) timing information for call-back routines and PDAF-internal operations
    198                                       ! (4) second-level timing information
    199                                       ! (5) very detailed third-level timing information
    200                                       ! (10) process-local allocated memory
    201                                       ! (11) globally allocated memory
    202 
    203 }}}
     189The routine `PDAF_X_memtime` displays information about allocated memory and the execution time of different parts of the filter algorithm.
     190
     191PDAF provides prepared timers in the different framework routines. For the analysis step, one can add more timers to obtain a detailed runtime information. Timers with index between 53 and 66 can be freely used.
    204192
    205193The timing operations are implemented using the module `PDAF_timer`, which provides the function `PDAF_timeit`. Memory allocation is computed using `PDAF_memcount`, which is provided by the module `PDAF_memcounting`.
    206194
     195
     196== Analysis routines of DA method ==
    207197
    208198=== `PDAF_assimilate_X` / `PDAF_put_state_X` ===