Changes between Initial Version and Version 1 of PDAF_get_fcst_info

Timestamp:

Mar 21, 2025, 7:40:01 PM (12 days ago)

Author:

lnerger

Comment:

--

PDAF_get_fcst_info

@@ +1 @@
+= PDAF_get_fcst_info = 
+
+This page documents the routine `PDAF_get_fcst_info` of PDAF, which was introduced with PDAF V3.0.
+
+This routine returns information used for the flexible parallelization mode. In particular these are the number of time steps, current model time, and a flag whether the forecasting should be exited. This routine is used when the flexible parallelization mode is used with the `PDAF3_assimilate_X` routines, where `X` indicates the name of the DA method. (This also holds for the older interface routines `PDAFomi_assimilation_X`, `PDAF_assimilate_X`). The outputs are the same as for `PDAF_get_state`, which is used with the `PDAF*_put_state_X`. The routine `PDAF_get_state` is called inside `PDAF*_assimilate_X`, but the values are not directly returned to the user.
+
+See the [wiki:ExternalModelLoop explanation of the flexible parallelization mode]  for further information.
+
+The routine have to be called by all processses that perform model integrations. 
+
+The interface is the following: 
+{{{
+  SUBROUTINE PDAF_get_fcst_info(nsteps, timenow, doexit)
+}}}
+with the following arguments:
+{{{
+  INTEGER, INTENT(inout) :: nsteps  !< Number of time steps to be performed in next forecast phase
+  REAL, INTENT(inout)    :: timenow !< Current model time
+  INTEGER, INTENT(inout) :: doexit  !< variable defining whether the assimilation process is completed. 1 for exit, 0 for continuing.
+
+**Note:**
+ * The output values are provided by the routine `U_prepostep` which is called by `PDAF_get_state` inside  `PDAF*_assimilate_X`.