Changes between Version 1 and Version 2 of next_observation_pdaf

Timestamp:

Jan 19, 2015, 9:56:59 PM (9 years ago)

Author:

lnerger

Comment:

--

next_observation_pdaf

@@ -1 @@
-= U_next_observation =
+= next_observation_pdaf =
 
-The page document the user-supplied call-back routine `U_next_observation`.
+The page document the user-supplied call-back routine `next_observation_pdaf`.
 
-The routine `U_next_observation` is a call-back routine that has to be provided by the user. In the simplified interface the predefined name of the routine is `next_observation_pdaf`, but in the full interface, the user can choose the name of the routine. At the beginning of a forecast phase, `U_next_observation` is called once by either `PDAF_get_state` ot `PDAF_assimilate_X` (with X being the name of a filter algorithm) to get the number of time steps to be computed in the forecast phase. 
+
+The routine `init_ens_pdaf` (called `U_init_ens` in the PDAF core routines) is a call-back routine that has to be provided by the user. `init_ens_pdaf` is called by `PDAF_init` at the initialization stage of a data assimilation program. The purpose of the routine is to fill the ensemble array that is provided by PDAF with an initial ensemble of model states.
+
+
+The routine `next_observation_pdaf` (called `U_next_observation` in the PDAF core routines) is a call-back routine that has to be provided by the user. At the beginning of a forecast phase, `next_observation_pdaf` is called once by either `PDAF_get_state` or `PDAF_assimilate_X` (with X being the name of a filter algorithm) to get the number of time steps to be computed in the forecast phase. 
 
 The interface is the following:
 {{{
-SUBROUTINE U_next_observation(stepnow, nsteps, doexit, timenow)
+SUBROUTINE next_observation_pdaf(stepnow, nsteps, doexit, timenow)
 }}}
 with
@@ -21 +25 @@
 Some hints: 
  * If the time interval between successive observations is known, `nsteps` can be simply initialized by dividing the time interval by the size of the time step
- * At the first call to `U_next_observation` the variable `timenow` can be initialized with the current model time. At the next call a forecast phase has been completed. Thus, the new value of `timenow` follows from the time interval for the previous forecast phase.
+ * At the first call to `next_observation_pdaf` the variable `timenow` can be initialized with the current model time. At the next call a forecast phase has been completed. Thus, the new value of `timenow` follows from the time interval for the previous forecast phase.