Changes between Initial Version and Version 1 of PDAF_set_iparam

Timestamp:

Mar 21, 2025, 1:49:46 PM (12 days ago)

Author:

lnerger

Comment:

--

PDAF_set_iparam

@@ +1 @@
+= PDAF_set_iparam = 
+
+This page documents the routine `PDAF_set_iparam` of PDAF, which was introduced with PDAF V3.0.
+
+This routine is used to set integer parameters for PDAF. 
+
+The parameters specific to a DA method can be set in the `filter_param_i` array that is an argument of `PDAF_init`. `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 intents 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 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`.
+
+
+The interface is the following:
+{{{
+  SUBROUTINE PDAF_set_iparam(id, value, flag)
+}}}
+with the following arguments:
+{{{
+  INTEGER, INTENT(in) :: id       !< Index of parameter
+  INTEGER, INTENT(in) :: value    !< Parameter value
+  INTEGER, INTENT(inout) :: flag  !< Status flag: 0 for no error
+}}}
+
+Hints:
+ * The available parameter options are listed in the [wiki:AvailableOptionsforInitPDAF Overview of available DA method-specific options].