Changes between Version 3 and Version 4 of PDAF_set_iparam


Ignore:
Timestamp:
Mar 24, 2025, 9:45:32 AM (8 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF_set_iparam

    v3 v4  
    55This routine is used to set integer parameters for PDAF.
    66
    7 The parameters specific to a DA method can be set in the `filter_param_i` array that is an argument of `PDAF_init` (see the [wiki:InitPdaf page on initializing PDAF]). `PDAF_set_iparam` provides an alternativ way. Instead of providing all parameters in the call to `PDAF_init`, one can provide only the required minimum for this call. Afterwards, one can then call `PDAF_set_iparam` for each integer parameter that one intends to specify differently from the default value. An advantage of using `PDAF_set_iparam` is that one only needs to call it for parameters that one intends to change, while in the call to `PDAF_init` all parameters up to the index one intends to change have to be specified, even of one doe snot want to change a parameter value. The tutorials and templates show this approach.
     7The integer parameters specific to a DA method can be set in the `filter_param_i` array that is an argument of `PDAF_init` (see the [wiki:InitPdaf page on initializing PDAF]). `PDAF_set_iparam` provides an alternativ way. Instead of providing all parameters in the call to `PDAF_init`, one can provide only the required minimum for this call. Afterwards, one can then call `PDAF_set_iparam` for each integer parameter that one intends to specify differently from the default value. An advantage of using `PDAF_set_iparam` is that one only needs to call it for parameters that one intends to change, while in the call to `PDAF_init` all parameters up to the index one intends to change have to be specified, even of one doe snot want to change a parameter value. The tutorials and templates show this approach.
    88
    99The routine is usually called by all processes after the call to `PDAF_init` in `init_pdaf`. One can also call the routine at later time during an assimilation process to change parameters. The parameter will be set for the DA method that was specified in the call to `PDAF_init`.
    … …  
    1313{{{
    1414  SUBROUTINE PDAF_set_iparam(id, value, flag)
    15 }}}
    16 with the following arguments:
    17 {{{
    18   INTEGER, INTENT(in) :: id       !< Index of parameter
    19   INTEGER, INTENT(in) :: value    !< Parameter value
    20   INTEGER, INTENT(inout) :: flag  !< Status flag: 0 for no error
     15
     16    INTEGER, INTENT(in) :: id       ! Index of the parameter that is set
     17    INTEGER, INTENT(in) :: value    ! Value of the parameter
     18    INTEGER, INTENT(inout) :: flag  ! Status flag: 0 for no error
    2119}}}
    2220