Changes between Version 3 and Version 4 of AuxiliaryRoutines

Timestamp:

May 3, 2013, 8:06:04 PM (12 years ago)

Author:

lnerger

Comment:

--

AuxiliaryRoutines

@@ -4 +4 @@
 
 PDAF provide a number of auxiliary routines. They serve to access PDAF-internal data, which is not available through the regular interface of PDAF.
+
+== PDAF_interfaces_module.F90 ==
+
+This file contains the module `PDAF_interfaces_module`. It provides interface definitions for the routines of PDAF. If you like to use explicit Fortran interfaces, or if you have to use then in case of the smoother, you have to include the following line in the header you the calling routine:
+
+{{{
+  use PDAF_interfaces_module
+}}}
 
 == PDAF-D_get_smootherens.F90 ==
@@ -55 +63 @@
  * `PDAF_set_smootherens` is typically called in the initialization phase of PDAF. It was to be called after the basic initialization of PDAF in `PDAF_init`. A possible location is to call `PDAF_set_smootherens` is the ensemble initialization routine `U_init_ens`. 
  * The first two indices of `sens_pointer` are identical to those in the ensemble array `ens_p`. Thus, the array contains state vectors in its columns. The second index is the ensemble index. The third index is the lag. Thus, if the value of the third index is fixed one can use the array `sens_pointer` analogous to the ensemble array `ens_p`.
+
+
+== PDAF-D_get_memberid.F90 ==
+
+This routine can be called from the model during an ensemble integration. It provides access to the number (id) of the ensemble member that is currently intrated.
+
+{{{
+CALL PDAF_get_memberid(memberid)
+}}}
+
+The only argument is:
+ * `memberid`: In integer providing on output the id the ensemble member
+
+Note:
+ * Using `PDAF_get_memberid` is obviously only useful if more than one ensemble member is integrated by a model task. If there are as many model tasks as ensemble members, `memberid` is always 1. In this case one can use `task_id` from the module `mod_parallel` to distinguish the ensemble members. 
+
+
+== PDAF-D_incremental.F90 ==
+
+When incremental updating is used, this routine is called during the forecast phase to add a fraction of the analysis increment to an ensemble member. 
+
+{{{ 
+CALL PDAF_incremental(steps, U_dist_stateinc)
+}}}
+
+The arguments are:
+ * `steps`: The number of time steps over which the increment should be distributed
+ * `U_dist_stateinc`: The name of the user supplied call-back function that performs the actual addition of the state vector increment to the individual model fields. 
+
+
+== PDAF-D_add_increment.F90 ==
+
+When incremental updating is used, the state increment of the analysis step is not directly added to the forecast state. To add the increment to some state vector `PDAF_add_increment` is called:
+
+{{{
+CALL PDAF_add_increment(dim_p, state_p)
+}}}
+
+The arguments are
+ * `dim_p`: An integer giving the state dimension of `state_p`
+ * `state_p`: A real array of size `dim_p` holding the on input the state vector and on output the state vector plus increment.
+
+Note:
+ * the routine can be used in the prepoststep routine when the analysis state should be analized.
+