PDAF_get_local_type

This page documents the routine PDAF_get_local_type of PDAF, which was introduced with PDAF 3.0.

The routine is an alternative to the function PDAF_local_type. In the routine the return value is an argument of the routine, wile for the function the value is the return value of the function, which can be more directly used.

The routine returns the information on the localization type of the selected filter. With this one can distinguish filters using domain localization (LESTKF, LETKF, LSEIK, LNETF), covariance localization (LEnKF), or covariance localization with observation handling like domain localization (ENSRF/EAKF).

The routine can be called in init_dim_obs_OBSTYPE, of each observation module to control whether PDAFomi_set_localize_covar is called to initialize covariance localization.

The interface is the following:

SUBROUTINE FUNCTION PDAF_local_type(localtype)

  INTEGER, INTENT(out) :: localtype !< Localization type of the filter
                       !<  (0) no localization; global filter
                       !<  (1) domain localization (LESTKF, LETKF, LNETF, LSEIK)
                       !<  (2) covariance localization (LEnKF)
                       !<  (3) covariance loc. but observation handling like domain localization (ENSRF)

The value of localtype can be directly used, e.g. as

  IF (localtype > 0) THEN
    CALL PDAFomi_set_localize_covar(...)

Notes:

• The routine can also be used as an alternative to PDAF_get_localfilter in assimilate_pdaf.