Changes between Version 12 and Version 13 of PDAF3_put_state_local


Ignore:
Timestamp:
Apr 20, 2025, 6:20:22 PM (7 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_put_state_local

    v12 v13  
    33This page documents the routine `PDAF3_put_state_local` of PDAF. The routine is part of the advanced [wiki:PDAF3_interface PDAF3 interface] that was introduced with PDAF V3.0.
    44
    5 The routine is used to execute the analysis step of all local ensemble filters including the nonlinear filter LNETF, the hybrid filter LKENTF, and the ENSRF/EAKF (but except the [wiki:ImplementAnalysislenkfOmi LEnKF]). The routine uses the functionalities provided by PDAF-OMI and PDAFlocal to yield a minimum number of arguments.
     5The routine is used to execute the analysis step of all local ensemble filters including the nonlinear filter LNETF, the hybrid filter LKENTF, and the ENSRF/EAKF (but except the [wiki:ImplementAnalysislenkfOmi LEnKF]). The routine uses the functionalities provided by PDAF-OMI to yield a small number of arguments. For backward-compatibility, the routine does not use PDAFlocal, but lets the user provide the routines for filling the local state vector and to fill the global analysis state vectors with the local analysis states.  This routine exists only for backward-compatibility. We recommend to use the routine [wiki:PDAF3_put_state] that uses also PDAFlocal.
    66
    77The routine is typically called in `assimilate_pdaf` or directly in the model code.
    … …  
    1818             U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
    1919             U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
     20             U_g2l_state, U_l2g_state, &
    2021             U_prepoststep, status)
    2122}}}
    … …  
    2728 * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
    2829 * `U_init_dim_obs_l_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the size of the observation vector for a local analysis domain. This routine is part of an OMI observation module.
     30 * `U_g2l_state`: The name of the routine that initializes a local state vector from the global state vector
     31 * `U_l2g_state`: The name of the routine that initializes the corresponding part of the global state vector from the provided local state vector
    2932 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
    3033 * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors.
    … …  
    3437 * The order of the routine names does not show the order in which these routines are executed. See the [ImplementAnalysisLocal#Executionorderofuser-suppliedroutines section on the order of the execution] on the page on implementing the analysis step of the local filter algorithms.
    3538 * To use the localization in the ENSRF/EAKF, one needs to call [wiki:PDAFomi_set_localize_covar] in the observation modules to initialize the localization information.
     39 * It is recommended to check the value of `status_pdaf` in the program after the routine is executed. Only if its value is 0 the initialization was successful.
    3640
    3741The user-supplied call-back routines are described on the page on [ImplementAnalysisLocal implementing the analysis step of the local filters].
    38 
    39 It 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.