Changes between Version 2 and Version 3 of ImplementAnalysis_3DEnVar_classical

Timestamp:

Dec 9, 2021, 1:09:58 PM (3 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysis_3DEnVar_classical

@@ -180 +180 @@
 === `U_init_dim_obs` (init_dim_obs_pdaf.F90) ===
 
-This routine is used by all global filter algorithms (SEEK, SEIK, EnKF, ETKF).
+This routine is used by all global filter algorithms (SEEK, SEIK, EnKF, ETKF, NETF, PF) and the 3D-Var methods.
 
 The interface for this routine is:
@@ -198 +198 @@
 === `U_obs_op` (obs_op_pdaf.F90) ===
 
-This routine is used by all global filter algorithms (SEEK, SEIK, EnKF, ETKF).
+This routine is used by all global filter algorithms (SEEK, SEIK, EnKF, ETKF, NETF, PF) and the 3D-Var methods.
 
 The interface for this routine is:
@@ -221 +221 @@
 === `U_init_obs` (init_obs_pdaf.F90) ===
 
-This routine is used by all global filter algorithms (SEEK, SEIK, EnKF, ETKF).
+This routine is used by all global filter algorithms (SEEK, SEIK, EnKF, ETKF, NETF, PF) and the 3D-Var methods.
 
 The interface for this routine is:
@@ -241 +241 @@
 === `U_prodRinvA` (prodrinva_pdaf.F90) ===
 
-This routine is used by all filter algorithms that use the inverse of the observation error covariance matrix (SEEK, SEIK, and ETKF).
+This routine is used by all filter algorithms that use the inverse of the observation error covariance matrix (SEEK, SEIK, ESTKF, ETKF, and NETF).
 
 The interface for this routine is:
@@ -262 +262 @@
  * 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.
- * The interface has a difference for SEIK and ETKF: For ETKF the third argument is the ensemble size (`dim_ens`), while for SEIK it is the rank of the covariance matrix (usually ensemble size minus one). In addition, the second dimension of `A_p` and `C_p` has size `dim_ens` for ETKF, while it is `rank` for the SEIK filter.  (Practically, one can usually ignore this difference as the fourth argument of the interface can be named arbitrarily in the routine.)
+ * The interface has a difference for ESTKF/SEIK and ETKF: For ETKF the third argument is the ensemble size (`dim_ens`), while for ESTKF and SEIK it is the rank of the covariance matrix (usually ensemble size minus one). In addition, the second dimension of `A_p` and `C_p` has size `dim_ens` for ETKF, while it is `rank` for the ESTKF and SEIK filters.  (Practically, one can usually ignore this difference as the fourth argument of the interface can be named arbitrarily in the routine.)
 
 
@@ -359 +359 @@
 === `U_init_dim_obs_f` (init_dim_obs_f_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LESTKF, LETKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -377 +377 @@
 === `U_obs_op_f` (obs_op_f_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -397 +397 @@
 === `U_init_obs_f` (init_obs_f_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 The routine is only called if the globally adaptive forgetting factor is used (`type_forget=1` in the example implementation). For the local filters there is also the alternative to use locally adaptive forgetting factors (`type_forget=2` in the example implementation)
 
@@ -418 +418 @@
 === `U_init_obs_l` (init_obs_l_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -442 +442 @@
 === `U_prodRinvA_l` (prodrinva_l_pdaf.F90) ===
 
-This routine is used by the local filters (LSEIK and LETKF). There is a slight difference between LSEIK and LETKF for this routine, which is described below.
+This routine is used by the local filters (LSEIK, LETKF, LESTKF, LNETF). There is a slight difference between LESTKF/LSEIK and LETKF for this routine, which is described below.
 
 The interface for this routine is:
@@ -457 +457 @@
 }}}
 
-The routine is called during the loop over the local analysis domains. 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`.
+The routine is called during the loop over the local analysis domains. In the algorithm, the product of the inverse of the observation error covariance matrix with some matrix has to be computed. For the ESTKF and SEIK filters 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_weight` can be called. The procedure is used in the example implementation and also demonstrated in the template routine.
@@ -465 +465 @@
  * 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.
- * The interface has a difference for SEIK and ETKF: For ETKF the third argument is the ensemble size (`dim_ens`), while for SEIK it is the rank (`rank`) of the covariance matrix (usually ensemble size minus one). In addition, the second dimension of `A_l` and `C_l` has size `dim_ens` for ETKF, while it is `rank` for the SEIK filter. (Practically, one can usually ignore this difference as the fourth argument of the interface can be named arbitrarily in the routine.)
+ * The interface has a difference for ESTKF/SEIK and ETKF: For ETKF the third argument is the ensemble size (`dim_ens`), while for ESTKF and SEIK it is the rank (`rank`) of the covariance matrix (usually ensemble size minus one). In addition, the second dimension of `A_l` and `C_l` has size `dim_ens` for ETKF, while it is `rank` for the ESTKF and SEIK filters. (Practically, one can usually ignore this difference as the fourth argument of the interface can be named arbitrarily in the routine.)
 
 
 === `U_init_n_domains` (init_n_domains_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -489 +489 @@
 === `U_init_dim_l` (init_dim_l_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -509 +509 @@
 === `U_init_dim_obs_l` (init_dim_obs_l_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -532 +532 @@
 === `U_g2l_state` (g2l_state_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -554 +554 @@
 === `U_l2g_state` (l2g_state_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -576 +576 @@
 === `U_g2l_obs` (g2l_obs_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm.
+This routine is used by all filter algorithms with domain-localization LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm.
 
 The interface for this routine is:
@@ -599 +599 @@
 === `U_init_obsvar` (init_obsvar_pdaf.F90) ===
 
-This routine is used by the global filter algorithms SEIK and  ETKF as well as the local filters LSEIK and LETKF. The routine is only called if the adaptive forgetting factor is used (`type_forget=1` in the example implementation). The difference in this routine between global and local filters is that the global filters use 'global' while the local filters use 'full' quantities.
+This routine is used by the global filter algorithms SEIK, ESTKF and ETKF as well as the local filters LESTKF, LSEIK and LETKF. The routine is only called if the adaptive forgetting factor is used (`type_forget=1` in the example implementation). The difference in this routine between global and local filters is that the global filters use 'global' while the local filters use 'full' quantities.
 
 The interface for this routine is:
@@ -623 +623 @@
 === `U_init_obsvar_l` (init_obsvar_l_pdaf.F90) ===
 
-This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF) and is independent of the particular algorithm. The routine is only called if the local adaptive forgetting factor is used (`type_forget=2` in the example implementation).
+This routine is used by all filter algorithms with domain-localization (LSEIK, LETKF, LESTKF, LNETF) and is independent of the particular algorithm. The routine is only called if the local adaptive forgetting factor is used (`type_forget=2` in the example implementation).
 
 The interface for this routine is: