Changes between Version 2 and Version 3 of PDAF_set_rparam

Timestamp:

Mar 24, 2025, 9:44:28 AM (8 days ago)

Author:

lnerger

Comment:

--

PDAF_set_rparam

@@ -5 +5 @@
 This routine is used to set real-valued (floating-point) parameters for PDAF. 
 
-The parameters specific to a DA method can be set in the `filter_param_r` array that is an argument of `PDAF_init`. `PDAF_set_rparam` 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_rparam` for each real-valued parameter that one intends to set differently from the default value. An advantage of using `PDAF_set_rparam` 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 real-value parameters specific to a DA method can be set in the `filter_param_r` array that is an argument of `PDAF_init` (see the [wiki:InitPdaf page on initializing PDAF]). `PDAF_set_rparam` 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_rparam` for each integer parameter that one intends to specify differently from the default value. An advantage of using `PDAF_set_rparam` 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.
 
 The 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`.
@@ -13 +13 @@
 {{{
   SUBROUTINE PDAF_set_rparam(id, value, flag)
-}}}
-with the following arguments:
-{{{
-  INTEGER, INTENT(in) :: id       !< Index of parameter
-  REAL, INTENT(in) :: value       !< Parameter value
-  INTEGER, INTENT(inout) :: flag  !< Status flag: 0 for no error
+
+    INTEGER, INTENT(in) :: id       ! Index of parameter
+    REAL, INTENT(in) :: value       ! Parameter value
+    INTEGER, INTENT(inout) :: flag  ! Status flag: 0 for no error
 }}}