Changes between Initial Version and Version 1 of PDAF_assim_offline_lknetf


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

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF_assim_offline_lknetf

    v1 v1  
     1= PDAF_assim_offline_lknetf =
     2
     3This page documents the routine `PDAF_assim_offline_lknetf` 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 when using the LKNETF algorithm is the following:
     8{{{
     9  SUBROUTINE PDAF_assim_offline_lknetf(U_init_dim_obs, U_obs_op, U_init_obs, U_init_obs_l, U_prepoststep, &
     10      U_prodRinvA_l, U_prodRinvA_hyb_l, U_init_n_domains_p, U_init_dim_l, &
     11      U_init_dim_obs_l, U_g2l_state, U_l2g_state, &
     12      U_g2l_obs, U_init_obsvar, U_init_obsvar_l, &
     13      U_likelihood_l, U_likelihood_hyb_l, status_pdaf)
     14}}}
     15with the following arguments:
     16 * `U_init_dim_obs_f`: The name of the user-supplied routine that provides the size of the full observation vector
     17 * `U_obs_op_f`: The name of the user-supplied routine that acts as the full observation operator on some state vector
     18 * `U_init_obs_f`: The name of the user-supplied routine that initializes the full vector of observations
     19 * `U_init_obs_l`: The name of the user-supplied routine that initializes the vector of observations for a local analysis domain
     20 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     21 * `U_prodRinvA_l`: The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF.
     22 * `U_prodRinvA_hyb_l`: The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF including hybridization.
     23 * `U_init_n_domains`: The name of the routine that provides the number of local analysis domains
     24 * `U_init_dim_l`: The name of the routine that provides the state dimension for a local analysis domain
     25 * `U_init_dim_obs_l`: The name of the routine that initializes the size of the observation vector for a local analysis domain
     26 * `U_g2l_state`: The name of the routine that initializes a local state vector from the global state vector
     27 * `U_l2g_state`: The name of the routine that initializes the corresponding part of the global state vector from the the provided local state vector
     28 * `U_g2l_obs`: The name of the routine that initializes a local observation vector from a full observation vector
     29 * `U_init_obsvar`: The name of the user-supplied routine that provides a global mean observation error variance (This routine will only be executed, if an adaptive forgetting factor is used)
     30 * `U_init_obsvar_l`: The name of the user-supplied routine that provides a mean observation error variance for the local analysis domain (This routine will only be executed, if a local adaptive forgetting factor is used)
     31 * `U_likelihood_l`: The name of the user-supplied routine that computes the local likelihood of an ensemble state.
     32 * `U_likelihood_hyb_l`: The name of the user-supplied routine that computes the local likelihood of an ensemble state including hybridization.
     33 * `status_pdaf`: The integer status flag. It is zero, if the routine is exited without errors.
     34
     35
     36
     37Note:
     38 * The order of the routine names does not show the order in which these routines are executed. See the [ImplementAnalysislnetf#Executionorderofuser-suppliedroutines section on the order of the execution] on the page on implementing the analysis step of the LNETF algorithm.
     39
     40The user-supplied call-back routines are described on the page on [ImplementAnalysislknetf implementing the analysis step of the LKNETF].
     41
     42It 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.