Changes between Version 1 and Version 2 of PDAF3_put_state_en3dvar_lestkf_nondiagR

Timestamp:

Mar 28, 2025, 12:24:13 PM (4 days ago)

Author:

lnerger

Comment:

--

PDAF3_put_state_en3dvar_lestkf_nondiagR

@@ -1 @@
-= PDAF3_put_state_en3dvar_estkf_nondiagR = 
+= PDAF3_assimilate_en3dvar_lestkf_nondiagR = 
 
-This page documents the routine `PDAF3_put_state_en3dvar_estkf_nondiagR`which is used for the case of a non-diagonal observation error covariance matrix. The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0. 
+This page documents the routine `PDAF3_assimilate_en3dvar_lestkf_nondiagR`. The routine is part of the advanced PDAF3 interface that was introduced with PDAF V3.0.  
 
 The routine is typically called in `assimilate_pdaf` or directly in the model code.
-
 The general aspects of the filter specific routines `PDAF3_put_state_*` are described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] and its sub-page on [InsertAnalysisStep inserting the analysis step]. 
 
-The routine is used for the offline mode of PDAF. It can also be used in the 'flexible' parallelization implementation variant of the data assimilation system, but starting with PDAF-3 we recommend to use [wiki:PDAF3_assimilate_en3dvar_estkf_nondiagR], which is also used with the 'fully-parallel' implementation variant. 
+The routine is used for the offline mode of PDAF. It can also be used in the 'flexible' parallelization implementation variant of the data assimilation system, but starting with PDAF-3 we recommend to use [wiki:PDAF3_assimilate_en3dvar_lestkf_nondiagR], which is also used with the 'fully-parallel' implementation variant. 
+
 
 The interface is:
 {{{
-SUBROUTINE PDAF3_put_state_en3dvar_nondiagR_estkf(U_collect_state, &
-                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, U_prodRinvA_pdafomi, &
-                                 U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, &
+SUBROUTINE PDAF3_put_state_en3dvar_lestkf_nondiagR(U_collect_state, &
+                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, prodRinvA_pdafomi, &
+                                 U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, obs_op_adj_pdafomi, &
+                                 U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
                                  U_prepoststep, outflag)
 }}}
@@ -19 +20 @@
  * `U_collect_state`: [[BR]]The name of the user-supplied routine that initializes a state vector from the array holding the ensemble of model states from the model fields. This is basically the inverse operation to `U_distribute_state` used in [ModifyModelforEnsembleIntegration#PDAF_get_state PDAF_get_state] and also here.
  * `U_init_dim_obs_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the observation information and provides the size of observation vector. This routine is part of an OMI observation module.
+ * `U_prodRinvA_pdafomi`: [[BR]]The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF. 
  * `U_obs_op_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector. This routine is part of an OMI observation module.
- * `U_prodRinvA_pdafomi`: [[BR]]The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF. 
  * `U_cvt_ens`: [[BR]]The name of the user-supplied routine that applies the ensemble control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
  * `U_cvt_adj_ens`: [[BR]]The name of the user-supplied routine that applies the adjoint ensemble control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
  * `U_obs_op_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector.  This routine is part of an OMI observation module.
  * `U_obs_op_lin_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the linearized observation operator on some state vector.  This routine is part of an OMI observation module.
- * `U_obs_op_adj_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the adjoint observation operator on some state vector. This routine is part of an OMI observation module.
+ * `U_obs_op_adj_pdafomi: [[BR]]The name of the user-supplied routine that acts as the adjoint observation operator on some state vector. This routine is part of an OMI observation module.
+ * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains
+ * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
+ * `U_init_dim_obs_l_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the size of the observation vector for a local analysis domain
  * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
  * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors. It is recommended that the value of `status_pdaf` is checked in the program after the routine is executed. Only if its value is 0 the initialization was successful.
 
-**Note:**
- * The difference to the routine `PDAF3_assimilate_en3dvar_estkf` used for diagonal R-matrices is only in the additonal argument `U_prodRinvA_pdafomi`.
-
 The user-supplied call-back routines are described on the page on [wiki:ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI].
-
-
-