Changes between Version 3 and Version 4 of ImplementAnalysisPDAF3Universal

Timestamp:

May 24, 2025, 6:18:53 PM (8 days ago)

Author:

lnerger

Comment:

--

ImplementAnalysisPDAF3Universal

@@ -44 +44 @@
 === `PDAF3_assimilate` ===
 
-This routine is used both in the ''fully-parallel'' and the ''flexible'' implementation variant of the data assimilation system. (See the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] for these variants)
+This routine is used both in the ''fully-parallel'' and the ''flexible'' implementation variants of the data assimilation system. (See the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] for these variants)
 
 The interface for the routine `PDAF3_assimilate` contains names for routines that operate on the local analysis domains (marked by the suffix `_l`). 
 Here, we list the full interface of the routine. Subsequently, the user-supplied routines specified in the call are explained. 
 
-The interface when using one of the local filters is the following:
-{{{
-  SUBROUTINE PDAF3_assimilate(U_collect_state, U_distribute_state, &
-                              U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
-                              U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
-                              U_prepoststep, U_next_observation, status)
+The unversal interface is the following:
+{{{
+  SUBROUTINE PDAF3_assimilate(collect_state_pdaf, distribute_state_pdaf, &
+                init_dim_obs_pdafomi, obs_op_pdafomi, &
+                init_n_domains_pdaf, init_dim_l_pdaf, init_dim_obs_l_pdafomi, &
+                g2l_state_pdaf, l2g_state_pdaf, &
+                prepoststep_pdaf, next_observation_pdaf, status)
 }}}
 with the following arguments:
 * Routines to transfer between model fields and state vector:
- * [#U_collect_statecollect_state_pdaf.F90 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_init_forecast PDAF_init_forecast] and also here.
- * [#U_distribute_statedistribute_state_pdaf.F90 U_distribute_state]:[[BR]]  The name of a user supplied routine that initializes the model fields from the array holding the ensemble of model state vectors.
+ * [#collect_state_pdafcollect_state_pdaf.F90 collect_state_pdaf]:[[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. 
+ * [#distribute_state_pdafdistribute_state_pdaf.F90 distribute_state_pdaf]:[[BR]]  The name of a user supplied routine that initializes the model fields from the array holding the ensemble of model state vectors. (The same routine is also used in `PDAF_init_forecast`.)
 * Observation routines using PDAF-OMI:
- * [#U_init_dim_obs_pdafomicallback_obs_pdafomi.F90 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
- * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_pdafomi]:[[BR]] The name of the user-supplied routine that acts as the observation operator on some state vector
+ * [#init_dim_obs_pdafomicallback_obs_pdafomi.F90 init_dim_obs_pdafomi]:[[BR]] The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
+ * [#obs_op_pdafomicallback_obs_pdafomi.F90 obs_op_pdafomi]:[[BR]] The name of the user-supplied routine that acts as the observation operator on some state vector
 * Routines only used for localization:
- * [#U_init_n_domainsinit_n_domains_pdaf.F90 U_init_n_domains]:[[BR]] The name of the routine that provides the number of local analysis domains
- * [#U_init_dim_linit_dim_l_pdaf.F90 U_init_dim_l]:[[BR]] The name of the routine that provides the state dimension for a local analysis domain
- * [#U_init_dim_obs_l_pdafomicallback_obs_pdafomi.F90 U_init_dim_obs_l_pdafomi]:[[BR]] The name of the routine that initializes the size of the observation vector for a local analysis domain and the index arrays used to map between the global state vector and the local state vector.
+ * [#init_n_domains_pdafinit_n_domains_pdaf.F90 init_n_domains_pdaf]:[[BR]] The name of the routine that provides the number of local analysis domains
+ * [#init_dim_l_pdafinit_dim_l_pdaf.F90 init_dim_l_pdaf]:[[BR]] The name of the routine that provides the state dimension for a local analysis domain
+ * [#init_dim_obs_l_pdafomicallback_obs_pdafomi.F90 init_dim_obs_l_pdafomi]:[[BR]] The name of the routine that initializes the size of the observation vector for a local analysis domain and the index arrays used to map between the global state vector and the local state vector.
 * Prepoststep and initialization for next forecast phase
- * [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep]:[[BR]] The name of the pre/poststep routine as in `PDAF_init_forecast`
- * [#U_next_observationnext_observation.F90 U_next_observation]:[[BR]] The name of a user supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`. The same routine is also used in `PDAF_init_forecast`.
+ * [#prepoststep_pdafprepoststep_ens_pdaf.F90 prepoststep_pdaf]:[[BR]] The name of the pre/poststep routine as in `PDAF_init_forecast`. (The same routine is also used in `PDAF_init_forecast`.)
+ * [#next_observation_pdafnext_observation.F90 next_observation_pdaf]:[[BR]] The name of a user supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`. (The same routine is also used in `PDAF_init_forecast`.)
 * Status flag
  * `status`:[[BR]] The integer status flag. It is zero, if the routine is exited without errors.
@@ -79 +80 @@
 === `PDAF3_assim_offline` ===
 
-For the offline mode of PDAF, the routine `PDAF3_assim_offline` is used to perform the analysis step.
+For the offline mode of PDAF, the routine `PDAF3_assim_offline_local` is used to perform the analysis step.
 The interface of the routine is identical with that of `PDAF3_assimilate`, except that the user-supplied routines `U_distribute_state`, `U_collect_state` and `U_next_observation` are missing. 
 
@@ -85 +86 @@
 {{{
   SUBROUTINE PDAF3_assim_offline( &
-             U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
-             U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
-             U_prepoststep, status)
+                init_dim_obs_pdafomi, obs_op_pdafomi, &
+                init_n_domains_pdaf, init_dim_l_pdaf, init_dim_obs_l_pdafomi, &
+                prepoststep_pdaf, status)
 }}}
 
@@ -97 +98 @@
 This routine exists for backward-compatibility. In implementations that were done before the release of PDAF V3.0, a 'put_state' routine was used for the `flexible` parallelization variant and for the offline mode. 
 When the 'flexible' implementation variant is chosen for the assimilation system, the routine. The routine `PDAF3_put_state` allows to port such implemnetations to the PDAF3 interface with minimal changes.
-The interface of the routine is identical with that of `PDAF3_assimilate`, except that the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 
+The interface of the routine is identical with that of `PDAF3_assimilate_local`, except that the user-supplied routines `U_distribute_state` and `U_next_observation` are missing. 
 
 The interface when using one of the local filters is the following:
 {{{
-  SUBROUTINE PDAF3_put_state(U_collect_state, &
-                             U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
-                             U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
-                             U_prepoststep, status)
-}}}
-
- * If your code shows a call to `PDAFomi_put_state_local`, it uses the implementation variant without PDAFlocal. This is documented on the page on [wiki:ImplementAnalysisLocal Implementing the Analysis Step for the Local Filters with OMI without PDAFlocal (until V2.2.1 of PDAF)].
+  SUBROUTINE PDAF3_put_state(collect_state_pdaf, &
+                init_dim_obs_pdafomi, obs_op_pdafomi, &
+                init_n_domains_pdaf, init_dim_l_pdaf, init_dim_obs_l_pdafomi, &
+                prepoststep_pdaf, status)
+}}}
+
 
 == User-supplied routines ==
@@ -113 +113 @@
 Here, all user-supplied routines are described that are required in the call to `PDAF3_assimilate`, `PDAF3_assim_offline` or `PDAF3_put_state`. 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 tutorials in `tutorial/` and in the template directory `templates/` these routines exist without the prefix, but with the extension `_pdaf`. The files are named correspondingly. The user-routines relating to OMI are collected in the file callback_obs_pdafomi.F90. In the section titles below we provide the name of the template file in parentheses.
-
 In the subroutine interfaces some variables appear with the suffix `_p` (short for 'process'). This suffix indicates that the variable is particular to a model sub-domain, if a domain decomposed model is used. In addition, there will be variables with suffix `_l` (indicating 'local').
 
-
-=== `U_collect_state` (collect_state_pdaf.F90) ===
+Call-back routines that end on `_pdaf` are regular call-back routines from the core part of PDAF, while call-back routines that end on `_pdafomi` handle observations within PDAF-OMI.
+
+
+=== `collect_state_pdaf` (collect_state_pdaf.F90) ===
 
 This routine is independent of the filter algorithm used.
@@ -124 +124 @@
 See the page on [ModifyModelforEnsembleIntegration#collect_state_pdafcollect_state_pdaf.F90 modifying the model code for the ensemble integration] for the description of this routine.
 
-=== `U_distribute_state` (distribute_state_pdaf.F90) ===
+=== `distribute_state_pdaf` (distribute_state_pdaf.F90) ===
 
 This routine is independent of the filter algorithm used.
@@ -131 +131 @@
 
 
-=== `U_init_dim_obs_pdafomi` (callback_obs_pdafomi.F90) ===
+=== `init_dim_obs_pdafomi` (callback_obs_pdafomi.F90) ===
 
 This is a call-back routine initializing the observation information. The routine just calls a routine from the observation module for each observation type.
@@ -139 +139 @@
 
 
-=== `U_obs_op_pdafomi` (callback_obs_pdafomi.F90) ===
+=== `obs_op_pdafomi` (callback_obs_pdafomi.F90) ===
 
 This is a call-back routine applying the observation operator to the state vector. The routine calls a routine from the observation module for each observation type.
@@ -146 +146 @@
 
 
-=== `U_init_n_domains` (init_n_domains_pdaf.F90) ===
+=== `init_n_domains_pdaf` (init_n_domains_pdaf.F90) ===
 
 This routine is only used for localization. It is called during the analysis step before the loop over the local analysis domains is entered. It has to provide the number of local analysis domains. In case of a domain-decomposed model, the number of local analysis domain for the model sub-domain of the calling process has to be initialized.
@@ -152 +152 @@
 The interface for this routine is:
 {{{
-SUBROUTINE init_n_domains(step, n_domains_p)
+SUBROUTINE init_n_domains_pdaf(step, n_domains_p)
 
   INTEGER, INTENT(in)  :: step        ! Current time step
@@ -162 +162 @@
 
 
-=== `U_init_dim_l` (init_dim_l_pdaf.F90) ===
+=== `init_dim_l_pdaf` (init_dim_l_pdaf.F90) ===
 
 This routine is only used for localization. 
@@ -168 +168 @@
 The interface for this routine is:
 {{{
-SUBROUTINE init_dim_l(step, domain_p, dim_l)
+SUBROUTINE init_dim_l_pdaf(step, domain_p, dim_l)
 
   INTEGER, INTENT(in)  :: step        ! Current time step
@@ -207 +207 @@
 
 
-=== `U_init_dim_obs_l_pdafomi` (callback_obs_pdafomi.F90) ===
+=== `init_dim_obs_l_pdafomi` (callback_obs_pdafomi.F90) ===
 
 This routine is only used for localization. It is a call-back routine for PDAF-OMI that initializes the local observation vector. The routine calls a routine from the observation module for each observation type.
@@ -214 +214 @@
 
 
-=== `U_prepoststep` (prepoststep_ens_pdaf.F90) ===
+=== `prepoststep_pdaf` (prepoststep_ens_pdaf.F90) ===
 
 The routine has already been described for modifying the model for the ensemble integration and for inserting the analysis step. 
@@ -221 +221 @@
 
 
-=== `U_next_observation` (next_observation_pdaf.F90) ===
+=== `next_observation_pdaf` (next_observation_pdaf.F90) ===
 
 This routine is independent of the filter algorithm used.
@@ -231 +231 @@
 == Execution order of user-supplied routines ==
 
-The user-supplied routines are executed in the order listed below. The order can be important as some routines can perform preparatory work for routines executed later on during the analysis. For example, in `U_init_dim_l` we can prepare the index array that provides the information how to localize a global state vector. 
-
-Before the analysis step is called the following is executed:
- 1. [#U_collect_statecollect_state_pdaf.F90 U_collect_state] (called once for each ensemble member)
- 1. [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep] (Call to act on the forecast ensemble, called with negative value of the time step)
+The user-supplied routines are executed in the order listed below. The order can be important as some routines can perform preparatory work for routines executed later on during the analysis. For example, in `init_dim_l_pdaf` we can prepare the index array that provides the information how to localize a global state vector. 
+
+Before the analysis step is called the following is executed by `PDAF3_assimilate` and `PDAF3_put_state`:
+ 1. [#collect_state_pdafcollect_state_pdaf.F90 collect_state_pdaf] (called once for each ensemble member)
+ 1. [#prepoststep_pdafprepoststep_ens_pdaf.F90 prepoststep_pdaf] (Call to act on the forecast ensemble, called with negative value of the time step)
 
 At the analysis time, the observations are initialized by the routines:
- 1. [#U_init_dim_obs_pdafomicallback_obs_pdafomi.F90 U_init_dim_obs_pdafomi]
- 1. [#U_obs_op_pdadfomicallback_obs_pdafomi.F90 U_obs_op_pdafomi] (Called `dim_ens` times; once for each ensemble member)
+ 1. [#init_dim_obs_pdafomicallback_obs_pdafomi.F90 init_dim_obs_pdafomi]
+ 1. [#obs_op_pdadfomicallback_obs_pdafomi.F90 obs_op_pdafomi] (Called `dim_ens` times; once for each ensemble member)
 
 Now the analysis step is entered and the number of local analysis domain is initialized by calling:
- 1. [#U_init_n_domainsinit_n_domains_pdaf.F90 U_init_n_domains]
+ 1. [#init_n_domains_pdafinit_n_domains_pdaf.F90 init_n_domains_pdaf]
 
 In the loop over all local analysis domains, it is executed for each local analysis domain:
- 1. [#U_init_dim_linit_dim_l_pdaf.F90 U_init_dim_l]
- 1. [#U_init_dim_obs_l_pdafomiinit_dim_obs_l_pdaf.F90 U_init_dim_obs_l_pdafomi]
+ 1. [#init_dim_l_pdafinit_dim_l_pdaf.F90 init_dim_l_pdaf]
+ 1. [#init_dim_obs_l_pdafomiinit_dim_obs_l_pdaf.F90 U_init_dim_obs_l_pdafomi]
 
 After the loop over all local analysis domains, it is executed:
- 1. [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep] (Call to act on the analysis ensemble, called with (positive) value of the time step)
+ 1. [#prepoststep_pdafprepoststep_ens_pdaf.F90 prepoststep_pdaf] (Call to act on the analysis ensemble, called with (positive) value of the time step)
 
 In case of the routine `PDAF3_assimilate`, 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]
+ 1. [#distribute_state_pdafdistribute_state_pdaf.F90 distribute_state_pdaf]
+ 1. [#next_observation_pdafnext_observation_pdaf.F90 next_observation_pdaf]