Changes between Version 4 and Version 5 of ImplementAnalysisestkf

Timestamp:

May 5, 2014, 12:10:52 PM (10 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysisestkf

@@ -37 +37 @@
 The ESTKF and the ETKF (Ensemble Transform Kalman Filter) are very similar. For this reason, the interface to the user-supplied routines is almost identical. Depending on the implementation it can be possible to use identical routines for the ESTKF and the ETKF. Differences are marked in the text below.
 
-== `PDAF_put_state_estkf` ==
-
-The general espects of the filter specific routines `PDAF_put_state_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration]. Here, we list once more the full interface. Subsequently, the full set of user-supplied routines specified in the call to `PDAF_put_state_estkf` is explained.
+== `PDAF_assimilate_estkf` ==
+
+The general espects of the filter specific routines `PDAF_assimilate_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration]. The routine is used in the fully-parallel implementation variant of the data assimilation system. Here, we list once more the full interface of the routine. Subsequently, the full set of user-supplied routines specified in the call to `PDAF_assimilate_estkf` is explained.
 
 The interface when using the ESTKF is the following:
 {{{
-  SUBROUTINE PDAF_put_state_estkf(U_collect_state, U_init_dim_obs, U_obs_op, &
-                                 U_init_obs, U_prepoststep, U_prodRinvA, U_init_obsvar, status)
+  SUBROUTINE PDAF_assimilate_estkf(U_collect_state, U_distribute_state, U_init_dim_obs, &
+                                 U_obs_op, U_init_obs, U_prepoststep, U_prodRinvA, &
+                                 U_init_obsvar, U_next_observation, status)
 }}}
 with the following arguments:
- * [#U_collect_statecollect_state_pdaf.F90 U_collect_state]: 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 `PDAF_get_state`
+ * [#U_collect_statecollect_state_pdaf.F90 U_collect_state]: 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 `PDAF_get_state` as well as here. 
+ * [#U_distribute_statedistribute_state_pdaf.F90 U_distribute_state]:  The name of a user supplied routine that initializes the model fields from the array holding the ensemble of model state vectors.
  * [#U_init_dim_obsinit_dim_obs_pdaf.F90 U_init_dim_obs]: The name of the user-supplied routine that provides the size of observation vector
  * [#U_obs_opobs_op_pdaf.F90 U_obs_op]: The name of the user-supplied routine that acts as the observation operator on some state vector
@@ -54 +56 @@
  * [#U_prodRinvAprodrinva_pdaf.F90 U_prodRinvA]: 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. This operation occurs during the analysis step of the SEIK, ETKF, and ESTKF algorithms.
  * [#U_init_obsvarinit_obsvar_pdaf.F90 U_init_obsvar]: The name of the user-supplied routine that provides a mean observation error variance to PDAF (This routine will only be executed, if an adaptive forgetting factor is used)
+ * [#U_next_observationnext_observation.F90 U_next_observation]: The name of a user supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`. The same routine is also used in `PDAF_get_state`.
  * `status`: The integer status flag. It is zero, if `PDAF_put_state_estkf` is exited without errors.
 
+
+== `PDAF_put_state_estkf` ==
+
+When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAF_put_state_estkf` has to be used instead of `PDAF_assimilate_estkf`. The general espects of the filter specific routines `PDAF_put_state_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration]. The interface of the routine is identical with that of `PDAF_assimilate_estkf` with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 
+
+The interface when using the ESTKF is the following:
+{{{
+  SUBROUTINE PDAF_put_state_estkf(U_collect_state, U_init_dim_obs, U_obs_op, &
+                                 U_init_obs, U_prepoststep, U_prodRinvA, U_init_obsvar, status)
+}}}
 
 == User-supplied routines ==