Changes between Initial Version and Version 1 of PDAF_generate_obs_offline


Ignore:
Timestamp:
Apr 21, 2025, 2:01:44 PM (7 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PDAF_generate_obs_offline

    v1 v1  
     1= PDAF_generate_obs_offline =
     2
     3This page documents the routine `PDAF_generate_obs_offline` of PDAF.
     4
     5The routine is used for the offline coupled mode of PDAF, which is described on the page: [wiki:OfflineImplementationGuide Implementation Guide for Offline Coupling].
     6
     7The interface is the following:
     8{{{
     9  SUBROUTINE PDAF_generate_obs_offline(U_init_dim_obs_f, U_obs_op_f, U_get_obs_f, &
     10                                  U_init_obserr_f, U_prepoststep, status_pdaf)
     11}}}
     12with the following arguments:
     13 * `U_init_dim_obs_f`: The name of the user-supplied routine that provides the size of the full observation vector
     14 * `U_obs_op_f`: The name of the user-supplied routine that acts as the full observation operator on some state vector
     15 * `U_get_obs_f`: The name of the user-supplied routine that receives the full vector of generated synthetic observations from PDAF
     16 * `U_init_obserr_f`: The name of the user-supplied routine that initializes the vector of observations error standard deviations for for full observation vector
     17 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     18 * `status_pdaf`: The integer status flag. It is zero, if the routine is exited without errors.
     19
     20
     21The user-supplied call-back routines are described on the [ImplementGenerateObs page on implementing the generation of synthetic observations].
     22
     23It is recommended that the value of `status_pdaf` is checked in the program after the routine is executed. Only if its value is 0 the initialization was successful.
     24
     25
     26