Changes between Initial Version and Version 1 of PDAF_put_state_prepost


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

--

Legend:

Unmodified
Added
Removed
Modified
  • PDAF_put_state_prepost

    v1 v1  
     1= PDAF_put_state_prepost =
     2
     3This page documents the routine `PDAF_put_state_prepost` of PDAF.
     4
     5The routine is typically called in `assimilate_pdaf` or directly in the model code.
     6
     7The routine `PDAF_put_state_prepost` is an alternative to the routines `PDAF_put_state_X` where 'X' is the name of a filter method.
     8The routine can be used with the 'flexible' implementation variant of PDAF. The purpose of `PDAF_put_state_prepost` is to collect the ensmeble information on the processes usually doing the filter analysis. However, in the case of `PDAF_put_state_prepost`, 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.
     9
     10The 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.
     11
     12The interface is the following:
     13{{{
     14  SUBROUTINE PDAF_put_state_prepost(U_collect_state, U_prepoststep, status_pdaf)
     15}}}
     16with the following arguments:
     17 * `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 [ModifyModelforEnsembleIntegration#PDAF_get_state PDAF_get_state].
     18 * `U_prepoststep`: The name of the pre/poststep routine as in `PDAF_get_state`
     19 * `status_pdaf`: The integer status flag. It is zero, if `PDAF_put_state_prepost` is exited without errors.
     20
     21
     22The user-supplied call-back routines are, for example, described on the page on [ImplementAnalysisestkf implementing the analysis step of the ESKTF algorithm].
     23
     24It is recommended that the value of `status_pdaf` is checked in the program after `PDAF_put_state_prepoststep` is executed. Only if its value is 0 the initialization was successful.
     25
     26PDAF also has a [PdafSimplifiedInterface Simplified Interface] providing the routine `PDAF_put_state_prepoststep_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_prepoststep_si`.  More information on the pre-defined names is provided, e.g., in the [ImplementAnalysisestkf page on implementing the analysis step of the ESTKF algorithm].
     27
     28