wiki:PDAFomi_put_state_generate_obs_si

Version 1 (modified by lnerger, 12 months ago) (diff)

--

PDAFomi_put_state_generate_obs_si

This page documents the routine PDAFomi_put_state_generate_obs_si of PDAF. It is used with PDAF_omi.

PDAFomi_put_state_generate_obs_si is the variant of PDAFomi_put_state_generate_obs with the 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.

The routine is typically called in assimilate_pdaf or directly in the model code.

The routines PDAFomi_put_state_* are used with the 'flexible' implementation variant of PDAF. The general aspects of the filter specific routines PDAFomi_put_state_* are described on the page Modification of the model code for the ensemble integration and its sub-page on inserting the analysis step. For the 'fully parallel' implementation variant the alternative routine PDAFomi_generate_obs_si is used.

The interface is the following:

  SUBROUTINE PDAFomi_put_state_generate_obs_si(status_pdaf)

with the following arguments:

  • status_pdaf: The integer status flag. It is 0, if PDAFomi_put_state_generate_obs_si is exited without errors.

The user-supplied call-back routines are described on the page on implementing the generation of synthetic observations.

It is recommended that the value of status_pdaf is checked in the program after PDAFomi_put_state_generate_obs_si is executed. Only if its value is 0 the initialization was successful.