Changes between Version 5 and Version 6 of LnDevel


Ignore:
Timestamp:
Sep 3, 2010, 3:28:50 PM (10 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • LnDevel

    v5 v6  
    3636For the analysis step of the SEIK filter different 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_seik` that was discussed before. With regard to the parallelization, all these routines are executed by the filter processes (`filterpe=1`) only.
    3737
    38 The user-supplied routines for the SEIK filter are
    39  * [#U_init_dim_obsinit_dim_obs.F90 U_init_dim_obs]: The name of the user-supplied routine that provides the size of observation vector
    40  * [#U_obs_opobs_op.F90 U_obs_op]: The name of the user-supplied routine that acts as the observation operator on some state vector
    41  * [#U_init_obsinit_obs.F90 U_init_obs]: The name of the user-supplied routine that initializes the vector of observations
    42  * [#U_prodRinvAprodrinva.F90 U_prodRinvA]: 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.
    43  * [#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)
     38For completeness we discuss here all user-supplied routines that are specified in the interface to PDAF_put_state_seik. Thus, some of the user-supplied that are explained on the page explaining the modification of the model code for the ensemlbe integration are repeated here.
    4439
    45 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.
     40== `PDAF_put_state_seik` ==
     41
     42The 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]. Here, we list once more the full interface. Subsequently, the full set of user-supplied routines specified in the call to `PDAF_put_state_seik` is explained.
     43
     44The interface when using the SEIK filter is the following:
     45{{{
     46  SUBROUTINE PDAF_put_state_seik(U_collect_state, U_init_dim_obs, U_obs_op, &
     47                                 U_init_obs, U_prepoststep, U_prodRinvA, U_init_obsvar, status)
     48}}}
     49with 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`: The name of the user-supplied routine that provides the size of observation vector
     52 * `U_obs_op`: The name of the user-supplied routine that acts as the observation operator on some state vector
     53 * `U_init_obs`: The name of the user-supplied routine that initializes the vector of observations
     54 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     55 * `U_prodRinvA`: 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.
     56 * `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)
     57 * `status`: The integer status flag. It is zero, if PDAF_get_state is exited without errors.
     58
    4659
    4760== `U_init_dim_obs` (init_dim_obs.F90) ==