| 1 | = Implementation of the Analysis step for the SEIK filter = |
| 2 | |
| 3 | {{{ |
| 4 | #!html |
| 5 | <div class="wiki-toc"> |
| 6 | <h4>Implementation Guide</h4> |
| 7 | <ol><li><a href="ImplementationGuide">Main page</a></li> |
| 8 | <li><a href="AdaptParallelization">Adaptation of the parallelization</a></li> |
| 9 | <li><a href="InitPdaf">Initialization of PDAF</a></li> |
| 10 | <li><a href="ModifyModelforEnsembleIntegration">Modifications for ensemble integration</a></li> |
| 11 | <li><a href="ImplementationofAnalysisStep">Implementation of the analysis step</a></li> |
| 12 | <ol> |
| 13 | <li><a href="ImplementAnalysisseik">Implementation for SEIK</a></li> |
| 14 | <li>Implementation for LSEIK</li> |
| 15 | </ol> |
| 16 | <li><a href="AddingMemoryandTimingInformation">Memory and timing information</a></li> |
| 17 | </ol> |
| 18 | </div> |
| 19 | }}} |
| 20 | |
| 21 | |
| 22 | [[PageOutline(2-3,Contents of this page)]] |
| 23 | |
| 24 | == Overview == |
| 25 | |
| 26 | For the analysis step of the LSEIK filter several operations related to the observations are needed. These operations are requested by PDAF by calling user-supplied routines. Intentionally, the operations are split into separate routines in order to keep the operations rather elementary. This procedure should simplify the implementation. The names of the required routines are specified in the call to the routine `PDAF_put_state_lseik` described below. With regard to the parallelization, all these routines are executed by the filter processes (`filterpe=1`) only. |
| 27 | |
| 28 | The following user-supplied routines for the SEIK filter are described on this page. (For completeness, we also repeat the generic routines that were described on the page [ModifyModelforEnsembleIntegration Modification of the model core for the ensemble integration]. |
| 29 | * [#U_init_dim_obs_fullinit_dim_obs_full.F90 U_init_dim_obs_full]: The name of the user-supplied routine that provides the size of observation vector |
| 30 | * [#U_obs_op_fullobs_op_full.F90 U_obs_op_full]: The name of the user-supplied routine that acts as the observation operator on some state vector |
| 31 | * [#U_init_obs_fullinit_obs_full.F90 U_init_obs_full]: The name of the user-supplied routine that initializes the vector of observations |
| 32 | * [#U_prodRinv_localA_prodrinva_local.F90 U_prodRinvA_local]: The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF. This operation occurs during the analysis step of the LSEIK filter. |
| 33 | * [#U_init_obsvarinit_obsvar.F90 U_init_obsvar]: The name of the user-supplied routine that provides a mean observation error variance to PDAF (This routine will only be executed, if an adaptive forgetting factor is used) |
| 34 | |
| 35 | Below the names of the corresponding routines in the template directory are provided in parentheses. The the routines in the example implementation have the same name but include '`_dummy_D`' in the name. |
| 36 | |
| 37 | == PDAF_put_state_lseik == |
| 38 | |
| 39 | The general espects of the filter specific routines `PDAF_put_state_*` have been described on the page [ModifyModelforEnsembleIntegration Modification of the model core for the ensemble integration]. |
| 40 | The interface for the routine `PDAF_put_state_lseik` contains routine names for routines that operate on the local analysis domains (marked by `_l` at then end of the routine name), as well as routines that consider all available observations to be considered within some sub-domain of the model (marked by `_f` ('full') at then end of the routine name). In case of a serial execution of the assimilation program, this will be all available observation. However, if the program is execute with parallelization, this might be a limited number of observations. |
| 41 | |
| 42 | The interface when using the LSEIK filter is the following: |
| 43 | {{{ |
| 44 | SUBROUTINE PDAF_put_state_lseik(U_collect_state, U_init_dim_obs_f, U_obs_op_f, & |
| 45 | U_init_obs_f, U_init_obs_l, U_prepoststep, U_prodRinvA_l, U_init_n_domains, & |
| 46 | U_init_dim_l, U_init_dim_obs_l, U_g2l_state, U_l2g_state, U_g2l_obs, & |
| 47 | U_init_obsvar, U_init_obsvar_l, status) |
| 48 | }}} |
| 49 | with the following arguments: |
| 50 | * `U_collect_state`: The name of the user-supplied routine that initializes a state vector from the array holding the ensembel of model states from the model fields. This is basically the inverse operation to `U_distribute_state` used in `PDAF_get_state` |
| 51 | * `U_init_dim_obs_f`: The name of the user-supplied routine that provides the size of observation vector |
| 52 | * `U_obs_op_f`: The name of the user-supplied routine that acts as the observation operator on some state vector |
| 53 | * `U_init_obs_f`: The name of the user-supplied routine that initializes the vector of observations |
| 54 | * `U_init_obs_l`: The name of the user-supplied routine that initializes the vector of observations for a local analysis domain |
| 55 | * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state` |
| 56 | * `U_prodRinvA_l`: The name of the user-supplied routine that computes the product of the inverse of the observation error covariance matrix with some matrix provided to the routine by PDAF. This operation occurs during the analysis step of the SEIK filter. |
| 57 | * `U_init_n_domains`: The name of the routine that provides the number of local analysis domains |
| 58 | * `U_init_dim_l`: The name of the routine that provides the state domains for a local analysis domain |
| 59 | * `U_init_dim_obs_l`: The name of the routine that initializes the size of the observation vector for a local analysis domain |
| 60 | * `U_g2l_state`: The name of the routine that initializes a local state vector from the global state vector |
| 61 | * `U_l2g_state`: The name of the routine that initializes the part of the global state vector corresponding to the provided local state vector |
| 62 | * `U_g2l_obs`: The name of the routine that initialized a local observation vector from a full observation vector |
| 63 | * `U_init_obsvar`: The name of the user-supplied routine that provides a global mean observation error variance to PDAF (This routine will only be executed, if an adaptive forgetting factor is used) |
| 64 | * `U_init_obsvar_l`: The name of the user-supplied routine that provides a mean observation error variance for the local analysis domain to PDAF (This routine will only be executed, if an adaptive forgetting factor is used) |
| 65 | * `status`: The integer status flag. It is zero, if PDAF_get_state is exited without errors. |
| 66 | |
| 67 | == User-supplied routines == |
| 68 | |
| 69 | Here, only the user-supplied routines are discussed that are required at this stage of the implementation (that is, the ensemble integration). The routines that are required to conduct the analysis step of some filter, are described in the main section about the implementation of the analysis step. For testing (see [#Compilationandtesting 'Compilation and testing']), all routines need to exist, but only those described here in detail need to be implemented with functionality. |
| 70 | |
| 71 | To indicate user-supplied routines we use the prefix `U_`. In the template directory `templates/` these routines are provided in files with the routines name without this prefix. In the example implementation in `testsuite/src/dummymodel_1D` the routines exist without the prefix, but with the extension `_dummy_D.F90`. In the section titles below we provide the name of the template file in parentheses. |
| 72 | |
| 73 | === `U_next_observation` (next_observation.F90) === |
| 74 | |
| 75 | The interface for this routine is |
| 76 | {{{ |
| 77 | SUBROUTINE U_next_obs(stepnow, nsteps, doexit, timenow) |
| 78 | |
| 79 | INTEGER, INTENT(in) :: stepnow ! Number of the current time step |
| 80 | INTEGER, INTENT(out) :: nsteps ! Number of time steps until next obs |
| 81 | INTEGER, INTENT(out) :: doexit ! Whether to exit forecasting (1 for exit) |
| 82 | REAL, INTENT(out) :: timenow ! Current model (physical) time |
| 83 | }}} |
| 84 | |
| 85 | The routine is called once at the beginning of each forecast phase. It is executed by all processes that participate in the model integrations. |
| 86 | |
| 87 | Based on the information of the current time step, the routine has to define the number of time steps `nsteps` for the next forecast phase. In addition, the flag `doexit` has to be initialized to provide the information if the external ensemble loop can be exited. `timenow` is the current model time. This variable should also be initialized. It is particularly important, if an ensemble task integrates more than one model state. In this case `timenow` can be used to correctly jump back in time. |
| 88 | |
| 89 | Some hints: |
| 90 | * If the time interval between successive observations is known, `nsteps` can be simply initialized by dividing the time interval by the size of the time step |
| 91 | * `doexit` should be 0 to continue the assimilation process. In most cases `doexit` is set to 1, when `PDAF_get_state` is called after the last analysis for which observations are available. |
| 92 | * At the first call to `U_next_obs` the variable `timenow` should be initialized with the current model time. At the next call a forecast phase has been completed. Thus, the new value of `timenow` follows from the timer interval for the previous forecast phase. |
| 93 | |
| 94 | === `U_distribute_state` (distribute_state.F90) === |
| 95 | |
| 96 | The interface for this routine is |
| 97 | {{{ |
| 98 | SUBROUTINE distribute_state(dim_p, state_p) |
| 99 | |
| 100 | INTEGER, INTENT(in) :: dim_p ! State dimension for PE-local model sub-domain |
| 101 | REAL, INTENT(inout) :: state_p(dim_p) ! State vector for PE-local model sub-domain |
| 102 | }}} |
| 103 | |
| 104 | This routine is called during the forecast phase as many times as there are states to be integrated by a model task. Again, the routine is executed by all processes that belong to model tasks. |
| 105 | |
| 106 | When the routine is called a state vector `state_p` and its size `dim_p` are provided. As the user has defined how the model fields are stored in the state vector, one can initialize the model fields from this information. If the model is not parallelized, `state_p` will contain a full state vector. If the model is parallelized using domain decomposition, `state_p` will contain the part of the state vector that corresponds to the model sub-domain for the calling process. |
| 107 | |
| 108 | Some hints: |
| 109 | * If the state vector does not include all model fields, it can be useful to keep a separate array to store those additional fields. This array has to be kept separate from PDAF, but can be defined using a module like `mod_assimilation`. |
| 110 | |
| 111 | === `U_prepoststep` (prepoststep_seik.F90) === |
| 112 | |
| 113 | The interface of the routine is identical for all filters. However, the particular operations that are performed in the routine can be specific for each filter algorithm. Here, we exemplify the interface on the example of the SEIK filter. |
| 114 | |
| 115 | The interface for this routine is |
| 116 | {{{ |
| 117 | SUBROUTINE prepoststep(step, dim_p, dim_ens, dim_ens_p, dim_obs_p, & |
| 118 | state_p, Uinv, ens_p, flag) |
| 119 | |
| 120 | INTEGER, INTENT(in) :: step ! Current time step |
| 121 | ! (When the routine is called before the analysis -step is provided.) |
| 122 | INTEGER, INTENT(in) :: dim_p ! PE-local state dimension |
| 123 | INTEGER, INTENT(in) :: dim_ens ! Size of state ensemble |
| 124 | INTEGER, INTENT(in) :: dim_ens_p ! PE-local size of ensemble |
| 125 | INTEGER, INTENT(in) :: dim_obs_p ! PE-local dimension of observation vector |
| 126 | REAL, INTENT(inout) :: state_p(dim_p) ! PE-local forecast/analysis state |
| 127 | ! The array 'state_p' is not generally not initialized in the case of SEIK. |
| 128 | ! It can be used freely here. |
| 129 | REAL, INTENT(inout) :: Uinv(dim_ens-1, dim_ens-1) ! Inverse of matrix U |
| 130 | REAL, INTENT(inout) :: ens_p(dim_p, dim_ens) ! PE-local state ensemble |
| 131 | INTEGER, INTENT(in) :: flag ! PDAF status flag |
| 132 | }}} |
| 133 | |
| 134 | The routine `U_prepoststep` is called once at the beginning of the assimilation process. In addition, it is called during the assimilation cycles before the analysis step and after the ensemble transformation. The routine is called by all filter processes (that is `filterpe=1`). |
| 135 | |
| 136 | The routine provides for the user the full access to the ensemble of model states. Thus, user-controlled pre- and post-step operations can be performed. For example the forecast and the analysis states and ensemble covariance matrix can be analyzed, e.g. by computing the estimated variances. In addition, the estimates can be written to disk. |
| 137 | |
| 138 | Hint: |
| 139 | * If a user considers to perform adjustments to the estimates (e.g. for balances), this routine is the right place for it. |
| 140 | |
| 141 | |
| 142 | === `U_collect_state` (collect_state.F90) === |
| 143 | |
| 144 | The interface for this routine is |
| 145 | {{{ |
| 146 | SUBROUTINE collect_state(dim_p, state_p) |
| 147 | |
| 148 | INTEGER, INTENT(in) :: dim_p ! State dimension for PE-local model sub-domain |
| 149 | REAL, INTENT(inout) :: state_p(dim_p) ! State vector for PE-local model sub-domain |
| 150 | }}} |
| 151 | |
| 152 | This routine is called during the forecast phase as many times as there are states to be integrated by a model task. It is called at the end of the integration of a member state of the ensemble. The routine is executed by all processes that belong to model tasks. |
| 153 | |
| 154 | When the routine is called, a state vector `state_p` and its size `dim_p` are provided. The operation to be performed in this routine is inverse to that of the routine `U_distribute_state`. That is, the state vector `state_p` has to be initialized from the model fields. If the model is not parallelized, `state_p` will contain a full state vector. If the model is parallelized using domain decomposition, `state_p` will contain the part of the state vector that corresponds to the model sub-domain for the calling process. |
| 155 | |
| 156 | Some hints: |
| 157 | * If the state vector does not include all model fields, it can be useful to keep a separate array to store those additional fields. This array has to be kept separate from PDAF, but can be defined using a module like `mod_assimilation`. |