Changes between Version 12 and Version 13 of ImplementAnalysisGlobal

Timestamp:

Nov 18, 2020, 4:14:32 PM (3 years ago)

Author:

lnerger

Comment:

--

ImplementAnalysisGlobal

@@ -28 +28 @@
 With Version 1.16 of PDAF we introduced PDAF-OMI (observation module infrastructure). With OMI we provide generic routines for the analysis step, which only distinguish global and local filters. This page describes the implementation of the analysis step for global filters (ESTKF, ETKF, EnKF, NETF, PF).
 
-For the analysis step of the global filters different operations related to the observations are needed. These operations are requested by PDAF by call-back routines supplied by the user and provided in the OMI structure. The names of the routines that are provided by the user are specified in the call to the routine `PDAF_assimilate_global_omi` in the fully-parallel implementation (or `PDAF_put_state_global_omi` for the 'flexible' implementation) that was discussed before. With regard to the parallelization, all these routines (except `U_collect_state`, `U_distribute_state`, and `U_next_observation`) are executed by the filter processes (`filterpe=.true.`) only.
+For the analysis step of the global filters different operations related to the observations are needed. These operations are requested by PDAF by call-back routines supplied by the user and provided in the OMI structure. The names of the routines that are provided by the user are specified in the call to the routine `PDAFomi_assimilate_global` in the fully-parallel implementation (or `PDAFomi_put_state_global` for the 'flexible' implementation) that was discussed before. With regard to the parallelization, all these routines (except `U_collect_state`, `U_distribute_state`, and `U_next_observation`) are executed by the filter processes (`filterpe=.true.`) only.
 
-For completeness we discuss here all user-supplied routines that are specified in the interface to `PDAF_assimilate_global_omi`. Thus, some of the user-supplied routines that are explained on the page describing the modification of the model code for the ensemble integration are repeated here.
+For completeness we discuss here all user-supplied routines that are specified in the interface to `PDAFomi_assimilate_global`. Thus, some of the user-supplied routines that are explained on the page describing the modification of the model code for the ensemble integration are repeated here.
 
 
-== `PDAF_assimilate_global_omi` ==
+== `PDAFomi_assimilate_global` ==
 
 The general aspects of the filter specific routines `PDAF_assimilate_*` have been 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 in the fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant is used, the routines `PDAF_put_state_*` is used as described further below. Here, we list the full interface of the routine. Subsequently, the user-supplied routines specified in the call is explained.
@@ -39 +39 @@
 The interface when using one of the global filters is the following:
 {{{
-  SUBROUTINE PDAF_assimilate_global_omi(U_collect_state, U_distribute_state, &
+  SUBROUTINE PDAFomi_assimilate_global(U_collect_state, U_distribute_state, &
                                  U_init_dim_obs, U_obs_op, U_init_obs, &
                                  U_prepoststep, U_next_observation, status)
@@ -50 +50 @@
  * [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep]: The name of the pre/poststep routine as in `PDAF_get_state`
  * [#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_assimilate_global_omi` is exited without errors.
+ * `status`: The integer status flag. It is zero, if `PDAFomi_assimilate_global` is exited without errors.
 
 
-== `PDAF_put_state_global_omi` ==
+== `PDAFomi_put_state_global` ==
 
-When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAF_put_state_global_omi` has to be used instead of `PDAF_assimilate_global_omi`. The general aspects 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_global` with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 
+When the 'flexible' implementation variant is chosen for the assimilation system, the routine `PDAFomi_put_state_global` has to be used instead of `PDAFomi_assimilate_global`. The general aspects 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_global` with the exception the specification of the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 
 
 The interface when using one of the global filters is the following:
 {{{
-  SUBROUTINE PDAF_put_state_global_omi(U_collect_state, &
+  SUBROUTINE PDAFomi_put_state_global(U_collect_state, &
                                  U_init_dim_obs, U_obs_op, U_init_obs, &
                                  U_prepoststep, status)
@@ -66 +66 @@
 == User-supplied routines ==
 
-Here all user-supplied routines are described that are required in the call to `PDAF_assimilate_global_omi`. For some of the generic routines, we link to the page on [ModifyModelforEnsembleIntegration modifying the model code for the ensemble integration].
+Here all user-supplied routines are described that are required in the call to `PDAFomi_assimilate_global`. For some of the generic routines, we link to the page on [ModifyModelforEnsembleIntegration modifying the model code for the ensemble integration].
 
 To indicate user-supplied routines we use the prefix `U_`. In the template directory `templates/` as well as in the tutorial implementations in `tutorial/` these routines exist without the prefix, but with the extension `_pdaf.F90`. In the section titles below we provide the name of the template file in parentheses.
@@ -164 +164 @@
 == Execution order of user-supplied routines ==
 
-The user-supplied routines are essentially executed in the order they are listed in the interface to `PDAF_assimilate_global_omi`. The order can be important as some routines can perform preparatory work for later routines. For example, `U_init_dim_obs` prepares an index array that provides the information for executing the observation operator in `U_obs_op`. How this information is initialized is described in the documentation of OMI.
+The user-supplied routines are essentially executed in the order they are listed in the interface to `PDAFomi_assimilate_global`. The order can be important as some routines can perform preparatory work for later routines. For example, `U_init_dim_obs` prepares an index array that provides the information for executing the observation operator in `U_obs_op`. How this information is initialized is described in the documentation of OMI.
 
 Before the analysis step is called the following routine is executed:
@@ -176 +176 @@
  1. [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep] (Call to act on the analysis ensemble, called with (positive) value of the time step)
 
-In case of the routine `PDAF_assimilate_global_omi`, the following routines are executed after the analysis step:
+In case of the routine `PDAFomi_assimilate_global`, the following routines are executed after the analysis step:
  1. [#U_distribute_statedistribute_state_pdaf.F90 U_distribute_state]
  1. [#U_next_observationnext_observation_pdaf.F90 U_next_observation]