pyPDAF.PDAF.set_iparam

pyPDAF.PDAF.set_iparam()

Set integer parameters for PDAF.

The integer parameters specific to a DA method can be set in the array filter_param_i that is an argument of pyPDAF.PDAF.init() (see the page on initializing PDAF).

This function provides an alternative way. Instead of providing all parameters in the call to pyPDAF.PDAF.init(), one can provide only the required minimum options for this call. Afterwards, one can then call this function for each integer parameter that one intends to specify differently from the default value. An advantage of using this function is that one only needs to call it for parameters that one intends to change, while in the call to pyPDAF.PDAF.init() all parameters up to the index one intends to change have to be specified, even if one does not want to change a parameter value.

The routine is usually called by all processes after the call to pyPDAF.PDAF.init() in init_pdaf. One can also call the routine at a 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 pyPDAF.PDAF.init().

Parameters:

• idval (int) – Index of parameter

• value (int) – Parameter value

• flag (int) – Status flag: 0 for no error

Returns:

flag – Status flag: 0 for no error

Return type:

int