Changes between Initial Version and Version 1 of PDAF_put_state_prepost_si


Ignore:
Timestamp:
Jan 16, 2015, 10:50:40 AM (6 years ago)
Author:
lnerger
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • PDAF_put_state_prepost_si

    v1 v1  
     1= PDAF_put_state_prepost_si =
     2
     3This page documents the routine `PDAF_put_state_prepost_si` of PDAF.
     4
     5
     6`PDAF_put_state_prepost_si` is the variant of [wiki:PDAF_put_state_prepost PDAF_put_state_prepost] with the [PdafSimplifiedInterface simplified interface]. The difference between both routines is that in the simplified interface the names of the call-back subroutines are not specified. Instead the routine assumes that the call-back routines have a standard name as specified at the end of this page.
     7
     8The routine is typically called in `assimilate_pdaf` or directly in the model code.
     9
     10The routine `PDAF_put_state_prepost_si` is an alternative to the routines `PDAF_put_state_X_si` where 'X' is the name of a filter method.
     11The routine can be used with the 'flexible' implementation variant of PDAF. The purpose of `PDAF_put_state_prepost_si` is to collect the ensemble information on the processes usually doing the filter analysis. However, in the case of `PDAF_put_state_prepost_si`, no filter analysis step is performed when the ensemble integration is complete, but only the user-supplied pre/poststep routine is called to allow the user to analyze the forecast ensemble.
     12
     13The 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 routine `PDAF_prepost` is used.
     14
     15The routines `PDAF_put_state_*` are used with the 'flexible' implementation variant of PDAF.
     16The 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_*_si` are used.
     17
     18The interface is the following:
     19{{{
     20  SUBROUTINE PDAF_put_state_prepost_si(status_pdaf)
     21}}}
     22with the following arguments:
     23 * `status_pdaf`: The integer status flag. It is 0, if `PDAF_put_state_prepost_si` is exited without errors.
     24
     25
     26The routine calls several user-supplied call-back routines. They are described on the page on [ImplementAnalysisestkf implementing the analysis step of the ESTKF algorithm].
     27
     28It is recommended that the value of `status_pdaf` is checked in the program after `PDAF_put_state_estkf_si` is executed. Only if its value is 0 the initialization was successful.