Changes between Initial Version and Version 1 of U_prepoststep

Timestamp:

Jan 21, 2015, 2:50:21 PM (10 years ago)

Author:

lnerger

Comment:

--

U_prepoststep

@@ +1 @@
+= U_prepoststep =
+
+The page document the user-supplied call-back routine `U_prepoststep`.
+
+The routine `U_prepoststep` is a call-back routine that has to be provided by the user. In the simplified interface the predefined name of the routine is `prepoststep_pdaf`, but in the full interface, the user can choose the name of the routine. 
+`U_prepoststep` is called by `PDAF_get_state`, `PDAF_put_state_X`, and `PDAF_assimilate_X` with 'X' being the name of a filter method. The routine is called at the initial time and after a forecast (directly before computing the filter analysis step) and after the analysis step. The purpose of the routine is to give the user full access to the forecast and the analysis ensembles. Typically operations that are performed in `U_prepoststep` are to compute the estimated RMS errors form the ensemble and to write e.g. the state estimate (i.e. the ensemble mean state). In case of the offline mode, one will also write the model restart files in `U_prepoststep` when the routine is called after the filter analysis update.
+
+The interface is the following:
+{{{
+SUBROUTINE U_prepoststep(step, dim_p, dim_ens, dim_ens_p, dim_obs_p, &
+                       state_p, Uinv, ens_p, flag)
+}}}
+with
+ * `step` : `integer, intent(in)`[[BR]] Current time step (When the routine is called before the analysis -step is provided.)
+ * `dim_p` : `integer, intent(in)`[[BR]] Size of state vector (local part of process if decomposed)
+ * `dim_ens` : `integer, intent(in)`[[BR]] Size of ensemble
+ * `dim_ens_p` : `integer, intent(in)`[[BR]] Process-local size of ensemble
+ * `dim_obs_p` : `integer, intent(in)`[[BR]] Size of observation vector (local part of process if decomposed)
+ * `state_p` : `real, intent(inout), dimension(dim_p)`[[BR]] State vector (forecast or analysis). The vector is generally not initialized in the case of ESTKF/ETKF/EnKF/SEIK. IT can be used freely in this routine
+ * `Uinv` : `real, intent(inout), dimension(dim_ens-1, dim_ens-1)`[[BR]] Inverse of the error-subspace matrix matrix A in ETKF and ESKTF; inverse of matrix U in SEIK and SEEK; not used in EnKF
+ * `ens_p` : `real, intent(inout), dimension(dim_p, dim_ens)`[[BR]] State ensemble (process-local part of process if decomposed)
+ * `flag` : `integer, intent(in)`[[BR]] PDAF status flag (0 if no error)
+
+Notes:
+ * The routine is called by all filter processes.
+ * If parallelization with domain decomposition is used, the variables `state_p` and `ens_p` will only contain the state information for the process-local domain. Accordingly, also `dim_p` and `dim_obs_p` only contain the state vector size for the local domain. 
+ * For the local filters (LESTKF, LETKF, LSEIK) `dim_obs_p` is the observation dimension for the `full` observations.
+
+Hints:
+ * If a user considers to perform adjustments to the estimates (e.g. for balances), this routine is the right place for it.
+ * Only for the SEEK filter the state vector (`state_p`) is initialized. For all other filters, the array is allocated, but it can be used freely during the execution of `U_prepoststep`.
+ * The interface through which `U_prepoststep` is called does not include the array of smoothed ensembles. In order to access the smoother ensemble array one has to set a pointer to it using a call to the routine `PDAF_get_smootherens` (see page on [AuxiliaryRoutines auxiliary routines])
+