Changes between Initial Version and Version 1 of init_obsvar_pdaf


Ignore:
Timestamp:
Jan 22, 2015, 9:37:48 AM (6 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • init_obsvar_pdaf

    v1 v1  
     1= `init_obsvar_pdaf` =
     2
     3The page documents the user-supplied call-back routine `init_obsvar_pdaf`.
     4
     5The routine `init_obsvar_pdaf` (called `U_init_obsvar` inside the PDAF core routines) is a call-back routine that has to be provided by the user. The routine is used with the global filters ESTKF, ETKF, and SEIK as well as the local filters LESTKF, LETKF, and LSEIK. The routine is called during the filter analysis step. The routine is only called if the adaptive forgetting factor is used (`type_forget=1` in the example impementation). When the routine is called it has to return the mean observation error variance.
     6
     7The interface is the following:
     8{{{
     9SUBROUTINE init_obsvar_pdaf(step, dim_obs_p, obs_p, meanvar)
     10}}}
     11with
     12 * `step` : `integer, intent(in)`[[BR]] Current time step
     13 * `dim_obs_p` : `integer, intent(in)`[[BR]] Size of observation vector
     14 * `obs_p` : `real, intent(in), dimension(dim_obs_p)`[[BR]] Vector of observations
     15 * `meanvar` : `real, intent(out)`[[BR]] Mean observation error variance
     16
     17Notes:
     18 * For a model with domain-decomposition one might use the mean variance for the model sub-domain of the calling process. Alternatively one can compute a mean variance for the full model domain using MPI communication (e.g. the function `MPI_allreduce`).
     19 * The observation vector `obs_p` is provided to the routine for the case that the observation error variance is relative to the value of the observations.