Changes between Initial Version and Version 1 of g2l_state_pdaf

Timestamp:

Jan 21, 2016, 4:34:42 PM (9 years ago)

Author:

lnerger

Comment:

--

g2l_state_pdaf

@@ +1 @@
+= g2l_state_pdaf =
+
+The page document the user-supplied call-back routine `g2l_state_pdaf`.
+
+The routine `g2l_state_pdaf` (called `U_g2l_state` inside the PDAF core routines) is a call-back routine that has to be provided by the user. 
+The routine is used with all filter algorithms using domain-localization (LSEIK, LETKF, LESTKF) and is independent of the particular algorithm.
+The routine is called during the loop over the local analysis domains in the analysis step. It has to provide the local state vector that corresponds to the specified local analysis domain. Provided to the routine is the state vector `state_p`. With a domain decomposed model, this is the state for the process-local model sub-domain.
+
+
+The interface is the following:
+{{{
+SUBROUTINE g2l_state_pdaf(step, domain_p, dim_p, state_p, dim_l, state_l)
+}}}
+with
+ * `step` : `integer, intent(in)`[[BR]] Current time step
+ * `domain_p` : `integer, intent(in)`[[BR]] Index of current local analysis domain
+ * `dim_p` : `integer, intent(in)`[[BR]] Dimension of state vector for parallel model sub-domain
+ * `dim_l` : `integer, intent(in)`[[BR]] Dimension of state vector in local analysis domain
+ * `state_p` : `integer, intent(in), dimension(dim_p)`[[BR] State vector for parallel model sub-domain
+ * `state_l` : `integer, intent(in), dimension(dim_l)`[[BR] State vector on local analysis domain
+
+Hints:
+ * In the simple case that a local analysis domain is a single point of the model grid, the operation in this routine would be to take out of `state_p` the data (i.e. the different model fields) for the grid point corresponding to the index `domain_p`.