Changes between Initial Version and Version 1 of init_obs_l_pdaf

Timestamp:

Jan 21, 2016, 3:02:57 PM (9 years ago)

Author:

lnerger

Comment:

--

init_obs_l_pdaf

@@ +1 @@
+= init_obs_l_pdaf =
+
+The page document the user-supplied call-back routine `init_obs_l_pdaf`.
+
+The routine `init_obs_l_pdaf` (called `U_init_obs_l` inside the PDAF core routines) is a call-back routine that has to be provided by the user. 
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm. 
+The routine is called during the analysis step during the loop over the local analysis domain. It has to provide the vector of observations for the analysis in the specified local analysis domain for the current time step. 
+
+The interface is the following:
+{{{
+SUBROUTINE init_obs_l_pdaf(domain_p, step, dim_obs_l, observation_l)
+}}}
+with
+ * `domain_p` : `integer, intent(in)`[[BR]] Index of current local analysis domain
+ * `step` : `integer, intent(in)`[[BR]] Current time step
+ * `dim_obs_l` : `integer, intent(in)`[[BR]] Local size of the observation vector
+ * `observation_l` : `real, intent(out), dimension(dim_obs_l)`[[BR]] Local vector of observations
+
+Hints:
+ * For parallel efficiency, the all domain-localized algorithms (LSEIK, LETKF, LESTKF) are implemented in a way that first the full vectors are initialized. These are then restricted to the local analysis domain during the loop over all local analysis domains. Thus, if the full vector of observations has been initialized before `init_obs_l_pdaf` is executed (e.g. by `init_dim_obs_f_pdaf`), the operations performed in this routine will be to select the part of the full observation vector that is relevant for the current local analysis domain.
+ * The routine `init_dim_obs_l_pdaf` is executed before this routine. Thus, if `init_dim_obs_l_pdaf` already prepares the information which elements of `observation_f` are needed for `observation_l`, this information can be used efficiently here.