Changes between Version 7 and Version 8 of PDAF3_put_state_local
- Timestamp:
- Mar 23, 2025, 3:12:11 PM (4 weeks ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
PDAF3_put_state_local
v7 v8 3 3 This 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. 4 4 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]). 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. 6 6 7 7 The routine is typically called in `assimilate_pdaf` or directly in the model code. … … 10 10 11 11 The interface for the routine `PDAF3_put_state_local` contains names for routines that operate on the local analysis domains (marked by the suffix `_l`). 12 Here, we list the full interface of the routine.13 12 14 13 The interface when using one of the local filters is the following: 15 14 {{{ 16 SUBROUTINE PDAF3_put_state (U_collect_state, &17 18 19 15 SUBROUTINE PDAF3_put_state_local(U_collect_state, & 16 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & 17 U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, & 18 U_prepoststep, status) 20 19 }}} 21 20 with the following arguments: 22 21 * `U_collect_state`: [[BR]]The name of the user-supplied routine that initializes a state vector from the array holding the ensemble of model states from the model fields. This is basically the inverse operation to `U_distribute_state` used in [ModifyModelforEnsembleIntegration#PDAF_get_state PDAF_get_state] and also here. 23 * `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 24 * `U_obs_op_pdafomi`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector 22 * `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. 23 * `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. 25 24 * `U_init_n_domains`: [[BR]]The name of the routine that provides the number of local analysis domains 26 25 * `U_init_dim_l`: [[BR]]The name of the routine that provides the state dimension for a local analysis domain 27 * `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 26 * `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. 28 27 * `U_prepoststep`: [[BR]]The name of the pre/poststep routine as in `PDAF_get_state` 29 28 * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors. 30 29 31 Note :30 Notes: 32 31 * 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. 33 32 * 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.