Changes between Initial Version and Version 1 of PDAFlocalomi_put_state_en3dvar_lestkf


Ignore:
Timestamp:
Sep 9, 2024, 4:33:50 PM (10 days ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PDAFlocalomi_put_state_en3dvar_lestkf

    v1 v1  
     1= PDAFomi_put_state_en3dvar_lestkf =
     2
     3This page documents the routine `PDAFlocalomi_put_state_en3dvar_lestkf` of PDAF.
     4
     5The routine is typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The routines `PDAFomi_put_state_*` are used with the 'flexible' implementation variant of PDAF.
     8The general aspects of the filter specific routines `PDAFomi_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]. For the 'fully parallel' implementation variant the alternative routines `PDAFomi_assimilate_*` are used.
     9
     10
     11The interface is:
     12{{{
     13SUBROUTINE PDAFlocalomi_put_state_en3dvar_lestkf(U_collect_state, &
     14                                 U_init_dim_obs_pdafomi, U_obs_op_pdafomi, &
     15                                 U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, &
     16                                 U_obs_op_adj_pdafomi, &
     17                                 U_init_n_domains_p, U_init_dim_l, U_init_dim_obs_l_pdafomi, &
     18                                 U_prepoststep, outflag)
     19}}}
     20with the following arguments:
     21 * `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 `PDAF_get_state` as well as here.
     22 * `U_init_dim_obs_pdafomi]: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
     23 * `U_obs_op_pdafomi]: The name of the user-supplied routine that acts as the observation operator on some state vector
     24 * `U_cvt_ens]: The name of the user-supplied routine that applies the ensemble control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
     25 * `U_cvt_adj_ens]: The name of the user-supplied routine that applies the adjoint ensemble control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
     26 * `U_obs_op_lin_pdafomi]: The name of the user-supplied routine that acts as the linearized observation operator on some state vector
     27 * `U_obs_op_lin_pdafomi]: The name of the user-supplied routine that acts as the adjoint observation operator on some state vector
     28 * `U_init_n_domains]: The name of the routine that provides the number of local analysis domains
     29 * `U_init_dim_l]: The name of the routine that provides the state dimension for a local analysis domain
     30 * `U_init_dim_obs_l_pdafomi]: The name of the routine that initializes the size of the observation vector for a local analysis domain
     31 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     32 * `status`: The integer status flag. It is zero, if the routine is exited without errors.
     33
     34
     35The user-supplied call-back routines are described on the page on [ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI].
     36
     37It 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.