| | 1 | = PDAF_put_state_ensrf = |
| | 2 | |
| | 3 | This page documents the routine `PDAF_put_state_ensrf` of PDAF. It is a routine for using the ENSRF/EAKF filters, which was added to PDAF with version 3.0. |
| | 4 | |
| | 5 | The routine is typically called in `assimilate_pdaf` or directly in the model code. However for newer implementations using [wiki:PDAF3_put_state_local] is recommended since less user-supplied call-back routines are required with the PDAF3 interface. |
| | 6 | |
| | 7 | The routines `PDAF_put_state_*` are used for the offline mode of PDAF and 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 for using the ENSRF/EAKF is the following: |
| | 11 | {{{ |
| | 12 | SUBROUTINE PDAF_put_state_ensrf(U_collect_state, & |
| | 13 | U_init_dim_obs, U_obs_op, U_init_obs, U_init_obsvars, & |
| | 14 | U_localize_covar_serial, U_prepoststep, outflag) |
| | 15 | }}} |
| | 16 | with the following arguments: |
| | 17 | * `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 [wiki:PDAF_get_state]. |
| | 18 | * `U_init_dim_obs`: [[BR]]The name of the user-supplied routine that provides the size of observation vector |
| | 19 | * `U_obs_op`: [[BR]]The name of the user-supplied routine that acts as the observation operator on some state vector |
| | 20 | * `U_init_obs`: [[BR]]The name of the user-supplied routine that initializes the vector of observations |
| | 21 | * `U_init_obsvars`: [[BR]]The name of the user-supplied routine that initializes the vector of observation error variances. |
| | 22 | * `U_localize_covar_serial`: The name of the routine that applies the covariance localization for a single observation |
| | 23 | * `U_prepoststep`: [[BR]]The name of the pre/poststep routine as in `PDAF_get_state` |
| | 24 | * `status_pdaf`: [[BR]]The integer status flag. It is zero, if the routine is exited without errors. |
| | 25 | |
| | 26 | The user-supplied call-back routines are described on the page on [ImplementAnalysislenkf implementing the analysis step of the ENSRF/EAKF]. |
| | 27 | |
| | 28 | It is recommended that the value of `status_pdaf` is checked in the program after PDAF_assimilate_lenkf is executed. Only if its value is 0 the initialization was successful. |
| | 29 | |
| | 30 | |
| | 31 | |
