Changes between Version 1 and Version 2 of PDAF3_init


Ignore:
Timestamp:
Jul 7, 2025, 11:36:53 AM (11 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_init

    v1 v2  
    11= PDAF3_init =
    22
    3 This page documents the routine PDAF3_init of PDAF. The routine was introduced with the final release of PDAF V3.0/
     3This page documents the routine `PDAF3_init` of PDAF. The routine was introduced with the final release of PDAF V3.0.
    44
    55The routine `PDAF3_init` is typically called in `init_pdaf` where also the variables for the call are set.
    … …  
    77The call to `PDAF3_init` has the following structure:
    88{{{
    9 CALL PDAF_init(filtertype, subtype, step_null, &
     9CALL PDAF3_init(filtertype, subtype, step_null, &
    1010               filter_param_i, length_filter_param_i, &
    1111               filter_param_r, length_filter_param_r, &
    … …  
    3131  * 2: as 1 plus display of timing information during the assimilation process
    3232  * 3: Display detailed information for debugging
    33  * `status_pdaf`: An integer used as status flag of PDAF. If `status_pdaf` is zero upon exit from `PDAF_init` the initialization was successful. An error occurred for non-zero values. (The error codes are documented in the routine `PDAF3_init`.)
     33 * `status_pdaf`: An integer used as status flag of PDAF. If `status_pdaf` is zero upon exit from `PDAF3_init` the initialization was successful. An error occurred for non-zero values. The error codes are:
     34  * 1: No valid filter type
     35  * 2: No valid sub type
     36  * 3: Invalid dim_pint
     37  * 4: Invalid dim_preal
     38  * 5: Invalid state dimension
     39  * 6: Invalid ensemble size
     40  * 7: Invalid value for forgetting factor
     41  * 8: Invalid other integer parameter value
     42  * 9: Invalid other real parameter value
     43  * 10: MPI information not initialized
     44  * 20: error in allocation of array at PDAF init
     45
    3446
    3547An overview of available options for each filter an be found on the [wiki:AvailableOptionsforInitPDAF overview page on options].
    … …  
    3951**Note:**
    4052 * `PDAF3_init` has to be used in combination with [wiki:PDAF3_set_parallel], which is called in `init_parallel_pdaf` to provide the parallelization information to PDAF.
     53 * `PDAF3_init` is an alternative to `PDAF_init`. While `PDAF_init` include parallelization variables in its interface, these are not present in `PDAF3_init`. With this, `PDAF3_init` allows to obtain a simpler code.