| | 1 | = PDAFomi_assimilate_en3dvar_estkf = |
| | 2 | |
| | 3 | This page documents the routine `PDAFomi_assimilate_en3dvar_estkf` of PDAF. |
| | 4 | |
| | 5 | The routine is typically called in `assimilate_pdaf` or directly in the model code. |
| | 6 | |
| | 7 | The general aspects of the filter specific routines `PDAF_assimilate_*` 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 fully-parallel implementation variant of the data assimilation system. When the 'flexible' implementation variant, the routines `PDAF_put_state_*' are used. |
| | 8 | |
| | 9 | |
| | 10 | The interface is: |
| | 11 | {{{ |
| | 12 | SUBROUTINE PDAFomi_assimilate_en3dvar_estkf(U_collect_state, U_distribute_state, & |
| | 13 | U_init_dim_obs_pdafomi, U_obs_op_pdafomi, & |
| | 14 | U_cvt_ens, U_cvt_adj_ens, U_obs_op_lin_pdafomi, U_obs_op_adj_pdafomi, & |
| | 15 | U_prepoststep, U_next_observation, outflag) |
| | 16 | }}} |
| | 17 | with the following arguments: |
| | 18 | * [#U_collect_statecollect_state_pdaf.F90 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. |
| | 19 | * [#U_distribute_statedistribute_state_pdaf.F90 U_distribute_state]: The name of a user supplied routine that initializes the model fields from the array holding the ensemble of model state vectors. |
| | 20 | * [#U_init_dim_obs_pdafomicallback_obs_pdafomi.F90 U_init_dim_obs_pdafomi]: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector |
| | 21 | * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_pdafomi]: The name of the user-supplied routine that acts as the observation operator on some state vector |
| | 22 | * [#U_cvt_enscvt_ens_pdaf.F90 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. |
| | 23 | * [#U_cvt_adj_enscvt_adj_ens_pdaf.F90 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. |
| | 24 | * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_lin_pdafomi]: The name of the user-supplied routine that acts as the linearized observation operator on some state vector |
| | 25 | * [#U_obs_op_pdafomicallback_obs_pdafomi.F90 U_obs_op_lin_pdafomi]: The name of the user-supplied routine that acts as the adjoint observation operator on some state vector |
| | 26 | * [#U_prepoststepprepoststep_ens_pdaf.F90 U_prepoststep]: The name of the pre/poststep routine as in `PDAF_get_state` |
| | 27 | * [#U_next_observationnext_observation.F90 U_next_observation]: The name of a user supplied routine that initializes the variables `nsteps`, `timenow`, and `doexit`. The same routine is also used in `PDAF_get_state`. |
| | 28 | * `status`: The integer status flag. It is zero, if the routine is exited without errors. |
| | 29 | |
| | 30 | |
| | 31 | The user-supplied call-back routines are described on the page on [ImplementAnalysis_3DEnVar implementing the analysis step of 3D Ensemble Var with OMI]. |
| | 32 | |
| | 33 | 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. |
| | 34 | |
