Changes between Version 6 and Version 7 of OfflineInitPdaf

Timestamp:

Apr 2, 2025, 10:50:44 AM (27 hours ago)

Author:

lnerger

Comment:

--

OfflineInitPdaf

@@ -26 +26 @@
 In the offline mode, the routine `init_pdaf_offline` is executed after the initialization of the parallelization. (Note: In the main program of the example implementation (`main_offine.F90`) we added a call to a routine `initialize` in between for clarity of the implementation. As no real model initialization is conducted, this routine simply initializes the size of the model state. This initialization could also be performed in `init_pdaf_offline`.)
 
-In the routine `init_pdaf_offline` a number of variables are defined that are used in the call to `PDAF_init` as described below in '[#RequiredargumentsforPDAF_init Required arguments for `PDAF_init`]'. (Please note: All names of subroutines that start with `PDAF_` are core routines of PDAF, while subroutines whose name end with `_pdaf` are generally user-supplied call-back routines) There are also a few variables that are initialized in `init_pdaf_offline` but not used in the call to `PDAF_init`. These are variables that are specific for the data assimilation system, but only shared in between the user-supplied routines. For the tutorial example, these variables are described below in the section '[#Othervariablesfortheassimilation Other variables for the assimilation]'
+In the routine `init_pdaf_offline` a number of variables are defined that are used in the call to `PDAF_init` as described below in '[#RequiredargumentsforPDAF_init Required arguments for `PDAF_init`]'. (Please note: All names of subroutines that start with `PDAF_` are core routines of PDAF, while subroutines whose name end with `_pdaf` are generally user-supplied call-back routines) There are also a few variables that are initialized in `init_pdaf_offline` but not used in the call to `PDAF_init`. These are variables that are specific for the data assimilation system, but only shared in between the user-supplied routines. For the tutorial example, these variables are described below in the section '[#Othervariablesfortheassimilation Other variables for the assimilation]'.
+
+The PDAF offline mode is activated by calling the routine PDAF_set_offline_mode, whic is usually done at the end of the routine `init_pdaf_offline`.
 
 The example implementation and the template version allow to parse all variables through a command line parser. This method provides a convenient way to define an experiment and could also be used for other models. The parser module is provided by the file `tutorial/offline_2D_serial/parser_mpi.F90`
@@ -59 +61 @@
   * 100: GENOBS
   * 200: 3DVAR
- * `subtype`: An integer defining the sub-type of the filter algorithm (always 5 for the offline mode)
+ * `subtype`: An integer defining the sub-type of the filter algorithm
  * `step_null`: Always 0 for the offline mode. 
  * `filter_param_i`: Integer array collecting several variables for PDAF. The first two variables are mandatory and equal for all filters. Further variables are optional (see example code). The mandatory variables are in the following order:
@@ -116 +118 @@
 === Initialization for ensemble-based filters ===
 
-Generally, we work with ensemble-based filters (an exception is only the SEEK filter and the parameterized 3D-Var). For these filters only the array `ens_p` needs to be initialized by the ensemble of model states. If a model with domain decomposition is used, the full ensemble for the local sub-domain of the MPI process has to be initialized.
+Generally, we work with ensemble-based filters (an exception is only the parameterized 3D-Var). For the ensemble-based filters only the array `ens_p` needs to be initialized by the ensemble of model states. If a model with domain decomposition is used, the full ensemble for the local sub-domain of the MPI process has to be initialized.
 
 The arrays `state_p` and `Uinv` are allocated to their correct sizes because they are used during the assimilation cycles. They are not yet initialized and it is allowed to use these arrays in the initialization. An exception from this is EnKF for which `Uinv` is allocated only with size (`1`,`1`), because `Uinv` is not using for EnKF.
@@ -123 +125 @@
 
 
-=== Initialization for mode-based filters (deprecated in PDAF V2.x) ===
+== Activating the offline mode with `PDAF_set_offline_mode` ==
 
-The only mode-based filter supplied with PDAF is currenly the SEEK filter. For this filter the initialization bases on the decomposition of the state error covariance matrix in the form '''P''' = '''VUV^T^'''. According to this decomposition, the array `ens_p` has to be initialized to hold the modes from matrix '''V''' and `Uinv` holds the inverse of matrix '''U'''. In addition `state_p` has to be initialized with the initial state estimate.  If a model with domain decomposition is used, the part of all modes for the local sub-domain of the MPI process and the corresponding part of the state vector has to be initialized.
+To use the offline mode, it has to be activated by calling `PDAF_set_offline_mode`. This is usally done at the end of `init_pdaf`. The routine has a simple interface as follows:
+{{{
+  SUBROUTINE PDAF_set_offline_mode(screen)
+
+    INTEGER, INTENT(in) :: screen            ! Control verbosity of routine
+                                             ! >0: display information output
+}}}
+here `screen` is usually the same variable as what is used as argument in the call to `PDAF_init`. 
+
+'''Note: '''
+ * Before PDAF V2.2 one had to activate the offline mode by setting `subtype=5`. This has been replaced by the call to `PDAF_set_offline_mode` to give users flexibility in specifying `subtype`. Up to PDAF V2.3.1 the use of `subtype=5` was still possible. In PDAF V3.0 we removed this possibility  and the call to `PDAF_set_offline_mode` is mandatory.
 
 == Testing the PDAF initialization ==
@@ -134 +146 @@
 Standard output from PDAF_init should look like the following:
 {{{
-PDAF    ++++++++++++++++++++++++++++++++++++++++++++++++++++++
-PDAF    +++                      PDAF                      +++
-PDAF    +++      Parallel Data Assimilation Framework      +++
-PDAF    +++                                                +++
-PDAF    +++                 Version 2.1                    +++
-PDAF    +++                                                +++
-PDAF    +++                 Please cite                    +++
-PDAF    +++     L. Nerger and W. Hiller, Computers and     +++
-PDAF    +++         Geosciences, 2013, 55, 110-118,        +++
-PDAF    +++         doi:10.1016/j.cageo.2012.03.026        +++
-PDAF    +++ when publishing work resulting from using PDAF +++
-PDAF    ++++++++++++++++++++++++++++++++++++++++++++++++++++++
+PDAF    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+PDAF    +++                       PDAF                         +++
+PDAF    +++       Parallel Data Assimilation Framework         +++
+PDAF    +++                                                    +++
+PDAF    +++                  Version 2.3.1                     +++
+PDAF    +++                                                    +++
+PDAF    +++                   Please cite                      +++
+PDAF    +++ L. Nerger and W. Hiller, Computers and Geosciences +++
+PDAF    +++ 2013, 55, 110-118, doi:10.1016/j.cageo.2012.03.026 +++
+PDAF    +++   when publishing work resulting from using PDAF   +++
+PDAF    +++                                                    +++
+PDAF    +++          PDAF itself can also be cited as          +++
+PDAF    +++  L. Nerger. Parallel Data Assimilation Framework   +++
+PDAF    +++  (PDAF). Zenodo. 2024. doi:10.5281/zenodo.7861812  +++
+PDAF    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 
@@ -158 +173 @@
 
 PDAF    ESTKF configuration
-PDAF          filter sub-type = 5
-PDAF            --> offline mode
+PDAF          filter sub-type = 0
+PDAF            --> Standard ESTKF
 PDAF            --> Deterministic ensemble transformation
 PDAF            --> Use fixed forgetting factor: 1.00
@@ -173 +188 @@
 PDAF     #PEs     1
 PDAF        N    40
+
+PDAF: Call routine for ensemble initialization
+
+PDAF: Initialization completed
+PDAF    Activate PDAF offline mode
 }}}