Changes between Initial Version and Version 1 of PDAF_put_state_seik


Ignore:
Timestamp:
Jan 16, 2015, 9:44:00 AM (6 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PDAF_put_state_seik

    v1 v1  
     1= PDAF_put_state_seik =
     2
     3This page documents the routine `PDAF_put_state_seik` of PDAF.
     4
     5The routine is typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The routines `PDAF_put_state_*` are used with the 'flexible' implementation variant of PDAF.
     8The 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
     10The interface when using the SEIK filter is the following:
     11{{{
     12  SUBROUTINE PDAF_put_state_seik(U_collect_state, U_init_dim_obs, U_obs_op, &
     13                                 U_init_obs, U_prepoststep, U_prodRinvA, U_init_obsvar, status)
     14}}}
     15with the following arguments:
     16 * `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`
     17 * `U_init_dim_obs`: The name of the user-supplied routine that provides the size of observation vector
     18 * `U_obs_op`: The name of the user-supplied routine that acts as the observation operator on some state vector
     19 * `U_init_obs`: The name of the user-supplied routine that initializes the vector of observations
     20 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     21 * `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.
     22 * `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)
     23 * `status_pdaf`: The integer status flag. It is zero, if `PDAF_put_state_seik` is exited without errors.
     24
     25
     26
     27
     28The user-supplied call-back routines are described on the page on [ImplementAnalysisseik implementing the analysis step of the SEIK filter].
     29
     30It is recommended that the value of `status_pdaf` is checked in the program after `PDAF_put_state_seik` is executed. Only if its value is 0 the initialization was successful.
     31
     32PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAF_put_state_seik_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_seik_si`.  More information on the pre-defined names is provided in the [ImplementAnalysisseek page on implementing the analysis step of the SEIK filter].