Changes between Version 15 and Version 16 of ImplementAnalysislseik

Timestamp:

Sep 3, 2010, 11:28:30 AM (14 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysislseik

@@ -251 +251 @@
 
   INTEGER, INTENT(in) :: step           ! Current time step
-  INTEGER, INTENT(in) :: domain_        ! Current local analysis domain
-  INTEGER, INTENT(in) :: dim_p          ! PE-local full state dimension
+  INTEGER, INTENT(in) :: domain_p       ! Current local analysis domain
+  INTEGER, INTENT(in) :: dim_p          ! State dimension for model sub-domain
   INTEGER, INTENT(in) :: dim_l          ! Local state dimension
-  REAL, INTENT(in)    :: state_p(dim_p) ! PE-local full state vector 
+  REAL, INTENT(in)    :: state_p(dim_p) ! State vector for model sub-domain 
   REAL, INTENT(out)   :: state_l(dim_l) ! State vector on local analysis domain
 }}}
 
-The routine is called during the loop over the local analysis domains in the analysis step. It has to provide the local state vector `state_l` that corresponds to the local analysis domain with index `domain_p`. With a domain decomposed model, the state vector `state_p` for the local model sub-domain is provided to the routine. 
-
-Hints:
- * In the simple case that a local analysis domain is a single vertical column of the model grid, the operation in this routine would be to take out the data for the vertical column indexed by `domain_p`.
+The routine is called during the loop over the local analysis domains in the analysis step. It has to provide the local state vector `state_l` that corresponds to the local analysis domain with index `domain_p`. Provided to the routine is the state vector `state_p`. With a domain decomposed model, this is the state for the local model sub-domain.
+
+Hints:
+ * In the simple case that a local analysis domain is a single vertical column of the model grid, the operation in this routine would be to take out of `state_p` the data for the vertical column indexed by `domain_p`.
+
+
+=== `U_local2global_state` (local2global_state.F90) ===
+
+This routine is used by all local filter algorithms (LSEIK, LETKF).
+
+The interface for this routine is:
+{{{
+SUBROUTINE local2global_state(step, domain_p, dim_l, state_l, dim_p, state_p)
+
+  INTEGER, INTENT(in) :: step           ! Current time step
+  INTEGER, INTENT(in) :: domain_p       ! Current local analysis domain
+  INTEGER, INTENT(in) :: dim_p          ! State dimension for model sub-domain
+  INTEGER, INTENT(in) :: dim_l          ! Local state dimension
+  REAL, INTENT(in)    :: state_p(dim_p) ! State vector for model sub-domain 
+  REAL, INTENT(out)   :: state_l(dim_l) ! State vector on local analysis domain
+}}}
+
+The routine is called during the loop over the local analysis domains in the analysis step. It has to provide the local state vector `state_l` that corresponds to the local analysis domain with index `domain_p`. Provided to the routine is the state vector `state_p`. With a domain decomposed model, this is the state for the local model sub-domain.
+
+The routine is called during the loop over the local analysis domains in the analysis step. It has to initialize the part of the global state vector `state_p` that corresponds to the local analysis domain with index `domain_p`. Provided to the routine is the state vector `state_l` for the local analysis domain.
+
+Hints:
+ * In the simple case that a local analysis domain is a single vertical column of the model grid, the operation in this routine would be to write into `state_p` the data for the vertical column indexed by `domain_p`.
+
 
 === `U_init_obsvar` (init_obsvar.F90) ===