Changes between Version 6 and Version 7 of ImplementAnalysisseik

Timestamp:

Aug 27, 2010, 9:21:09 AM (14 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysisseik

@@ -57 +57 @@
 == `U_init_obs` (init_obs.F90) ==
 
+{{{
+SUBROUTINE init_obs(step, dim_obs_p, observation_p)
+
+  INTEGER, INTENT(in) :: step             ! Current time step
+  INTEGER, INTENT(in) :: dim_obs_p        ! PE-local dimension of obs. vector
+  REAL, INTENT(out)   :: observation_p(dim_obs_p) ! PE-local observation vector
+}}}
+
+! User-supplied routine for PDAF (SEEK/SEIK/EnKF/ETKF):
+!
+! The routine is called during the analysis step. 
+! It has to provide the PE-local observation vector 
+! for the current time step.
+
+
 == `U_prodRinvA` (prodrinva.F90) ==
 
+{{{
+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.
+! It has to compute the product of the inverse of 
+! the observation error covariance matrix with
+! the matrix of observed EOF modes (SEEK) or 
+! observed ensemble perturbations (SEIK/ETKF).
+
+
+
 == `U_init_obsvar` (init_obsvar.F90) ==
+
+{{{
+SUBROUTINE init_obsvar(step, dim_obs_p, obs_p, meanvar)
+
+  INTEGER, INTENT(in) :: step          ! Current time step
+  INTEGER, INTENT(in) :: dim_obs_p     ! PE-local dimension of observation vector
+  REAL, INTENT(in) :: obs_p(dim_obs_p) ! PE-local observation vector
+  REAL, INTENT(out)   :: meanvar       ! Mean observation error variance
+}}}
+
+! User-supplied routine for PDAF (SEIK/LSEIK/ETKF/LETKF)
+! with adaptive forgetting factor. This routine will
+! only be called, if the adaptive forgetting factor
+! feature is used. Please note that this is an 
+! experimental feature.
+!
+! The routine is called in SEIK during the analysis or 
+! in LSEIK before the loop over local analysis domains 
+! by the routine PDAF\_set\_forget that estimates an 
+! adaptive forgetting factor.  The routine has to 
+! initialize the mean observation error variance.  
+! For SEIK this should be the global mean, while for 
+! LSEIK it should be the mean for the PE-local 
+! sub-domain.  (See init\_obsvar\_local() for a 
+! localized variant for LSEIK.)