Version 1 (modified by 4 weeks ago) (diff) | ,
---|

# PDAFomi_put_state_3dvar_nondiagR

This page documents the routine `PDAFomi_put_state_3dvar_nondiagR`

of PDAF which is used in case of a non-diagonal observation error covariance matrix. This routine was introduced with PDAF V2.3.

The routine is typically called in `assimilate_pdaf`

or directly in the model code.

The routines `PDAF_put_state_*`

are used with the 'flexible' implementation variant of PDAF.
The general aspects of the filter specific routines `PDAF_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 routines `PDAF_assimilate_*`

are used.

The interface for using the parameterized 3D-Var is:

SUBROUTINE PDAFomi_put_state_3dvar_nondiagR(U_collect_state, & U_init_dim_obs_pdafomi, U_obs_op_pdafomi, U_prodRinvA_pdafomi, & U_cvt, U_cvt_adj, U_obs_op_lin_pdafomi, obs_op_adj_pdafomi, & U_prepoststep, outflag)

with the following arguments:

- 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`

as well as here. - U_init_dim_obs_pdafomi: The name of the user-supplied routine that initializes the observation information and provides the size of observation vector
- U_cvt: The name of the user-supplied routine that applies the control-vector transformation (square-root of the B-matrix) on some control vector to obtain a state vector.
- U_cvt_adj: The name of the user-supplied routine that applies the adjoint control-vector transformation (with square-root of the B-matrix) on some state vector to obtain the control vector.
- U_obs_op_pdafomi: The name of the user-supplied routine that acts as the observation operator on some state vector
- U_prodRinvA_pdafomi: 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.
- U_obs_op_lin_pdafomi: The name of the user-supplied routine that acts as the linearized observation operator on some state vector
- U_obs_op_lin_pdafomi: The name of the user-supplied routine that acts as the adjoint observation operator on some state vector
- U_prepoststep: The name of the pre/poststep routine as in
`PDAF_get_state`

`status`

: The integer status flag. It is zero, if the routine is exited without errors.

The user-supplied call-back routines are described on the page on implementing the analysis step of 3D-Var with OMI.

It is recommended that the value of `status_pdaf`

is checked in the program after the routine is executed. Only if its value is 0 the initialization was successful.