Changes between Version 1 and Version 2 of PDAF3_put_state_local


Ignore:
Timestamp:
Mar 23, 2025, 2:49:23 PM (9 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAF3_put_state_local

    v1 v2  
    11= PDAF3_put_state_local =
    22
    3 This page documents the routine `PDAF3_put_state_local` of PDAF  using the [wiki:PDAFlocal_overview PDAFlocal interface] that was introduced with PDAF V3.0. The routine is used to execute the analysis step of all local ensemble filters including the nonlinear filter LNETF (but except the [wiki:ImplementAnalysislenkfOmi LEnKF]) and the ENSRF/EAKF.
     3This page documents the routine `PDAF3_put_state_local` of PDAF  using the [wiki:PDAFlocal_overview PDAFlocal interface] that was introduced with PDAF V3.0.
     4
     5The 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]).
    46
    57The routine is typically called in `assimilate_pdaf` or directly in the model code.
    68
    7 The general aspects of the filter specific routines `PDAF3_put_state_*` are described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] and its sub-page on [InsertAnalysisStep inserting the analysis step]. The routine is used in the 'flexible' parallelization implementation variant of the data assimilation system. With the 'fully-parallel' implementation variant, the routine [wiki:PDAFomi_assimilate_lenkf PDAFomi_assimilate_local] is used.
     9The general aspects of the filter specific routines `PDAF3_put_state_*` are described on the page [ModifyModelforEnsembleIntegration Modification of the model code for the ensemble integration] and its sub-page on [InsertAnalysisStep inserting the analysis step]. The routine is used for the offline mode of PDAF and in the 'flexible' parallelization implementation variant of the data assimilation system. With the 'fully-parallel' implementation variant, the routine [wiki:PDAFe_assimilate_local PDAFomi_assimilate_local] is used.
    810
    9 The interface for the routine `PDAFlocalomi_put_state` contains names for routines that operate on the local analysis domains (marked by the suffix `_l`).
     11The interface for the routine `PDAF3_put_state_local` contains names for routines that operate on the local analysis domains (marked by the suffix `_l`).
    1012Here, we list the full interface of the routine.
    1113
    1214The interface when using one of the local filters is the following:
    1315{{{
    14   SUBROUTINE PDAFlocalomi_put_state(U_collect_state, &
    15                                   U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
    16                                   U_prepoststep, U_init_n_domains, U_init_dim_l, &
    17                                   U_init_dim_obs_l_pdafomi, status)
     16  SUBROUTINE PDAF3_put_state(U_collect_state, &
     17                             U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
     18                             U_init_n_domains, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
     19                             U_prepoststep, status)
    1820}}}
    1921with the following arguments:
    20  * `U_collect_state`: 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.
    21  * `U_init_dim_obs_pdafomi`: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
    22  * `U_obs_op_pdafomi`: The name of the user-supplied routine that acts as the observation operator on some state vector
    23  * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
    24  * `U_init_n_domains`: The name of the routine that provides the number of local analysis domains
    25  * `U_init_dim_l`: The name of the routine that provides the state dimension for a local analysis domain
    26  * `U_init_dim_obs_l_pdafomi`: The name of the routine that initializes the size of the observation vector for a local analysis domain
    27  * `status`: The integer status flag. It is zero, if the routine is exited without errors.
     22 * `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
     25 * `U_init_n_domains`: [[BR]]The name of the routine that provides the number of local analysis domains
     26 * `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
     28 * `U_prepoststep`: [[BR]]The name of the pre/poststep routine as in `PDAF_get_state`
     29 * `status`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors.
    2830
    2931Note:
    … …  
    3335
    3436It 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.
    35 
    36 PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAFlocalomi_put_state_si`. In the simplified interface, the name of the user-supplied routines have predefined names and do not appear in the call to `PDAFlocalomi_put_state_si`.  More information on the pre-defined names is provided in the [ImplementAnalysisLocal page on implementing the analysis step of the local filters].
    37