Changes between Version 66 and Version 67 of InitPdaf

Timestamp:

May 22, 2025, 10:18:12 PM (10 days ago)

Author:

lnerger

Comment:

--

InitPdaf

@@ -168 +168 @@
 An overview of available integer and real-valued options for each DA method can be found on the page [wiki:AvailableOptionsforInitPDAF Available options for the different DA methods]. The available options for a specific DA method can also be displayed by running the assimilation program for the selected DA method setting `subtype = -1`. (In the tutorial and template codes one can set `-subtype -1` on the command line).
 
+== Calling `PDAF_init_forecast` ==
+
+The routine `PDAF_init_forecast` initializes the information, whether further model integrations have to be performed and how many time steps have to be computed in the next forecast aphse. In addition, the ensemble state vectors are written into the model fields so that they can be propagates. In the tutorial codes and the template, the call to `PDAF_init_forecast` is fully implemented. Here, we provide an overview of its arguments.
+
+The interface of `PDAF_init_forecast` is:
+{{{
+  SUBROUTINE PDAF_init_forecast(nsteps, timenow, doexit, &
+                                U_next_observation, U_distribute_state, &
+                                U_prepoststep, status)
+}}}
+with the following arguments: 
+ * `nsteps`, `integer, intent(inout)`: An integer specifying upon exit the number of time steps to be performed
+ * `timenow`, `real, intent(out)`: A real specifying upon exit the current model time.  
+ * `doexit`, `integer, intent(inout)`: An integer variable defining whether the assimilation process is completed and the program should exit the while loop. For compatibility 1 should be used for exit, 0 for continuing in the loop.
+ * [#U_next_observationnext_observation.F90 U_next_observation]: The name of a user supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`
+ * [#U_distribute_statedistribute_state.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_prepoststepprepoststep_seik.F90 U_prepoststep]: The name of a user supplied routine that is called before and after the analysis step. Here the user has the possibility to access the state ensemble and can e.g. compute estimated variances or can write the ensemble states the state estimate into files.
+ * `status`, `integer, intent(inout)`: The integer status flag. It is zero, if `PDAF_init_forecast` is exited without errors.
+
+ 
+
 
 == Testing the PDAF initialization ==