Changes between Initial Version and Version 1 of PDAFomi_set_localization

Timestamp:

Sep 8, 2024, 5:44:06 PM (11 days ago)

Author:

lnerger

Comment:

--

PDAFomi_set_localization

@@ +1 @@
+= PDAFomi_set_localization =
+
+This page documents the routine `PDAFomi_set_localization`` of PDAF-OMI.
+
+This routine is used for the case that a user implements a user-provided alternative for the routine `PDAFomi_init_dim_obs_l`, which initializes the local observation information for PDAF-OMI in `thisobs_l` for a single local analysis domain.
+
+This routine is for isotropic localization (for non-isotropic localization see [wiki:PDAFomi_set_localization_noniso])
+
+The routine has to be called in `init_dim_obs_l_OBTYPE` in each observation module if a domain-localized filter (LESTKF/LETKF/LNETF/LSEIK/LKNETF)is used. 
+
+|| See the [wiki:OMI_search_local_observations page on user-provided initialization of local observations] for the full description of a user-provided routine to intialize local observations. ||
+
+The interface is:
+{{{
+  SUBROUTINE PDAFomi_set_localization(thisobs_l, cradius, sradius, locweight)
+
+    TYPE(obs_l), INTENT(inout) :: thisobs_l  ! Data type with local observation
+    REAL, INTENT(in) :: cradius              ! Localization cut-off radius
+    REAL, INTENT(in) :: sradius              ! Support radius of localization function
+    INTEGER, INTENT(in) :: locweight         ! Type of localization function
+}}}
+
+'''Notes:'''
+ * The arguments are usually the same inputs as used when calling `PDAFomi_init_dim_obs_l`.