Changes between Version 9 and Version 10 of PDAF3_put_state_local


Ignore:
Timestamp:
Mar 26, 2025, 6:49:31 PM (7 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_put_state_local

    v9 v10  
    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 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 and PDAFlocal to yield a minimum number of arguments.
    66
    77The routine is typically called in `assimilate_pdaf` or directly in the model code.
    … …  
    2424 * `U_init_dim_obs_pdafomi`: [[BR]]The name of the user-supplied routine that initializes the observation information and provides the size of observation vector. This routine is part of an OMI observation module.
    2525 * `U_obs_op_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector. This routine is part of an OMI observation module.
    26  * `U_init_n_domains`: [[BR]]The name of the routine that provides the number of local analysis domains
    27  * `U_init_dim_l`: [[BR]]The name of the routine that provides the state dimension for a local analysis domain
    28  * `U_init_dim_obs_l_pdafomi`: [[BR]]The name of the routine that initializes the size of the observation vector for a local analysis domain. This routine is part of an OMI observation module.
    29  * `U_prepoststep`: [[BR]]The name of the pre/poststep routine as in `PDAF_get_state`
     26 * `U_init_n_domains`: [[BR]]The name of the user-supplied routine that provides the number of local analysis domains
     27 * `U_init_dim_l`: [[BR]]The name of the user-supplied routine that provides the state dimension for a local analysis domain
     28 * `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.
     29 * `U_prepoststep`: [[BR]]The name of the user-supplied pre/poststep routine as in `PDAF_get_state`
    3030 * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors.
    3131
    … …  
    3333 * 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.
    3434 * The routine is identical to the routine `PDAFlocalomi_put_state` of PDAF 2.3. However, the argument `U_prepostep` is at a different place here.
     35 * 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.
    3536
    3637The user-supplied call-back routines are described on the page on [ImplementAnalysisLocal implementing the analysis step of the local filters].