| | 1 | = PDAF_put_state_lenkf = |
| | 2 | |
| | 3 | This page documents the routine `PDAF_put_state_lenkf` of PDAF. The routine is called for the localized EnKF. |
| | 4 | |
| | 5 | The routine is typically called in `assimilate_pdaf` or directly in the model code. |
| | 6 | |
| | 7 | The routines `PDAF_put_state_*` are used with the 'flexible' implementation variant of PDAF. |
| | 8 | The general aspects of the filter specific routines `PDAF_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 `PDAF_assimilate_*` are used. |
| | 9 | |
| | 10 | The interface when using the LEnKF is the following: |
| | 11 | {{{ |
| | 12 | SUBROUTINE PDAF_put_state_lenkf(U_collect_state, U_init_dim_obs, U_obs_op, & |
| | 13 | U_init_obs, U_prepoststep, U_localize, & |
| | 14 | U_add_obs_err, U_init_obscovar, status_pdaf) |
| | 15 | }}} |
| | 16 | with the following arguments: |
| | 17 | * `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`. |
| | 18 | * `U_init_dim_obs`: The name of the user-supplied routine that provides the size of observation vector |
| | 19 | * `U_obs_op`: The name of the user-supplied routine that acts as the observation operator on some state vector |
| | 20 | * `U_init_obs`: The name of the user-supplied routine that initializes the vector of observations |
| | 21 | * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state` |
| | 22 | * `U_localize`: The name of the routine that applied the covariance localization |
| | 23 | * `U_add_obs_err`: The name of the user-supplied routine that adds the observation error covariance matrix to the ensemble covariance matrix projected onto the observation space. |
| | 24 | * `U_init_obscovar`: The name of the user-supplied routine that initializes the observation error covariance matrix. |
| | 25 | * `status_pdaf`: The integer status flag. It is zero, if `PDAF_put_state_lenkf` is exited without errors. |
| | 26 | |
| | 27 | The user-supplied call-back routines are described on the page on [ImplementAnalysislenkf implementing the analysis step of the localized EnKF]. |
| | 28 | |
| | 29 | It is recommended that the value of `status_pdaf` is checked in the program after PDAF_assimilate_enkf is executed. Only if its value is 0 the initialization was successful. |
| | 30 | |
| | 31 | PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAF_put_state_lenkf_si`. In the simplified interface, the name of the user-supplied routines have predefined names and do not appear in the call to `PDAF_put_state_lenkf_si`. More information on the pre-defined names is provided in the [ImplementAnalysislenkf page on implementing the analysis step of the localized EnKF]. |
| | 32 | |
| | 33 | |
| | 34 | |
| | 35 | |
| | 36 | |
| | 37 | The user-supplied call-back routines are described on the page on [ImplementAnalysisenkf implementing the analysis step of the EnKF algorithm]. |
| | 38 | |
| | 39 | It is recommended that the value of `status_pdaf` is checked in the program after `PDAF_put_state_enkf` is executed. Only if its value is 0 the initialization was successful. |
| | 40 | |
| | 41 | PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAF_put_state_enkf_si`. In the simplified interface, the name of the user-supplied routines have predefined names and do not appear in the call to `PDAF_put_state_enkf_si`. More information on the pre-defined names is provided in the [ImplementAnalysisenkf page on implementing the analysis step of the EnKF algorithm]. |
