Changes between Version 8 and Version 9 of ImplementAnalysislseik

Timestamp:

Sep 1, 2010, 5:04:55 PM (14 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysislseik

@@ -74 +74 @@
 === `U_collect_state` (collect_state.F90) ===
 
+This routine is independent from the filter algorithm used.
 See [ModifyModelforEnsembleIntegration#U_collect_statecollect_state.F90 here] for the description of this routine.
 
@@ -155 +156 @@
  * For parallel efficiency the LSEIK is implemented in a way that first the full vectors are initialized. Thus, as `observation_f` has been initialized before `init_obs_local` is executed, 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.
 
-
-
-=== `U_prodRinvA` (prodrinva.F90) ===
-
-This routine is used by all filters whose algorithm uses the inverse of the observation error covariance matrix (SEEK, SEIK, and ETKF).
-
-The interface for this routine is:
-{{{
-SUBROUTINE prodRinvA(step, dim_obs_p, rank, obs_p, A_p, C_p)
-
-  INTEGER, INTENT(in) :: step                ! Current time step
-  INTEGER, INTENT(in) :: dim_obs_p           ! PE-local dimension of obs. vector
-  INTEGER, INTENT(in) :: rank                ! Rank of initial covariance matrix
-  REAL, INTENT(in)    :: obs_p(dim_obs_p)    ! PE-local vector of observations
-  REAL, INTENT(in)    :: A_p(dim_obs_p,rank) ! Input matrix from analysis routine
-  REAL, INTENT(out)   :: C_p(dim_obs_p,rank) ! Output matrix
-}}}
-
-The routine is called during the analysis step. In the algorithms the product of the inverse of the observation error covariance matrix with some matrix has to be computed. For the SEIK filter this matrix holds the observed part of the ensemble perturbations. The matrix is provided as `A_p`. The product has to be given as `C_p`.
-
-For a model with domain decomposition, `A_p` contains the part of the matrix that resides on the model sub-domain of the calling process. The product has to be computed for this sub-domain, too.
-
-Hints:
- * the routine does not require that the product is implemented as a real matrix-matrix product. Rather, the product can be implemented in its most efficient form. For example, if the observation error covariance matrix is diagonal, only the multiplication of the diagonal with matrix `A_p` has to be implemented.
- * The observation vector `obs_p` is provided through the interface for cases where the observation error variance is relative to the actual value of the observations.
+=== `U_prepoststep` (prepoststep_seik.F90) ===
+
+This routine can be identical to that used for the global SEIK filter. 
+See [ModifyModelforEnsembleIntegration#U_prepoststepprepoststep_seik.F90 here] for the description of this routine.
+
+
+
+=== `U_prodRinvA_local` (prodrinva_local.F90) ===
+
+This routine is used by the local filters (LSEIK and LETKF).
+
+The interface for this routine is:
+{{{
+SUBROUTINE prodRinvA_local(domain_p, step, dim_obs_p, rank, obs_p, A_p, C_p)
+SUBROUTINE prodRinvA_local(domain_p, step, dim_obs_l, rank, obs_l, A_l, C_l)
+
+  INTEGER, INTENT(in) :: domain_p             ! Current local analysis domain
+  INTEGER, INTENT(in) :: step                 ! Current time step
+  INTEGER, INTENT(in) :: dim_obs_l            ! Dimension of local observation vector
+  INTEGER, INTENT(in) :: rank                 ! Rank of initial covariance matrix
+  REAL, INTENT(in)    :: obs_l(dim_obs_l)     ! Local vector of observations
+  REAL, INTENT(inout) :: A_l(dim_obs_l, rank) ! Input matrix from analysis routine
+  REAL, INTENT(out)   :: C_l(dim_obs_l, rank) ! Output matrix
+}}}
+
+The routine is called during the loop over the local analysis domains in the analysis step. In the algorithm the product of the inverse of the observation error covariance matrix with some matrix has to be computed. For the SEIK filter this matrix holds the observed part of the ensemble perturbations for the local analysis domain of index `domain_p`. The matrix is provided as `A_l`. The product has to be given as `C_l`.
+
+This routine is also the place to perform observation localization. To initialize a vector of weights, the routine `PDAF_local_weights` can be called. The procedure is used in the example implementation and also demonstrated in the template routine.
+
+Hints:
+ * the routine does not require that the product is implemented as a real matrix-matrix product. Rather, the product can be implemented in its most efficient form. For example, if the observation error covariance matrix is diagonal, only the multiplication of the diagonal with matrix `A_l` has to be implemented.
+ * The observation vector `obs_l` is provided through the interface for cases where the observation error variance is relative to the actual value of the observations.
 
 
@@ -205 +213 @@
  * 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`).
  * The observation vector `obs_p` is provided to the rotine for the case that the observation error variance is relative to the value of the observations.
-
-=== `U_prepoststep` (prepoststep_seik.F90) ===
-
-See [ModifyModelforEnsembleIntegration#U_prepoststepprepoststep_seik.F90 here] for the description of this routine.
-