Changes between Version 1 and Version 2 of PDAFomi_set_localize_covar

Timestamp:

Mar 25, 2025, 7:45:39 PM (7 days ago)

Author:

lnerger

Comment:

--

PDAFomi_set_localize_covar

@@ -1 +1 @@
 = PDAFomi_set_localize_covar =
 
-This page documents the routine `PDAFomi_set_localize_covar`` of PDAF-OMI, which are introduced with PDAF3.0.
+This page documents the routine `PDAFomi_set_localize_covar` of PDAF-OMI, which was introduced with PDAF V3.0.
 
 The routine has to be called in `init_dim_obs_OBSTYPE` in each observation module if the localized EnKF or the ENSRF/EAKF with localization are used. It initializes the information for covariance localization.
@@ -11 +11 @@
   SUBROUTINE PDAFomi_set_localize_covar(thisobs, dim, ncoords, coords, &
        locweight, cradius, sradius)
-}}}
-with arguments:
-{{{
+
     TYPE(obs_f), INTENT(inout) :: thisobs       ! Data type with full observation
     INTEGER, INTENT(in) :: dim                  ! State dimension
@@ -25 +23 @@
 '''Notes:'''
  * The routine allows to specify the localization radius and support radius (`lradius`, `sradius`) and localization function (`locweight`) individually for each observation type. 
- * The coordinate array `coords` specified the coordinates of each element in the state vector. The units have to be consistent with those used to specify the coordinates of observations.
+ * The coordinate array `coords` specifies the coordinates of each element in the state vector. The coordinate units have to be consistent with those used to specify the coordinates of observations.
  * The routine only supports a fixed localization radius throughout the domain.
  * One can also directly call the routine `PDAFomi_set_localize_covar_iso`, e.g. when calling from a program coded in C. 
@@ -32 +30 @@
 == `PDAFomi_set_localize_covar` for non-isotropic localization ==
 
-There is an alternative interface for non-isotropic localization. In this variant `cradius` and `sradius` are specified as vectors holding a value of localization radius for each coordinate direction. This permits for non-isotropic localization.
+There is an alternative interface for non-isotropic localization. In this variant `cradius` and `sradius` are specified as vectors holding a value of the localization radius for each coordinate direction. This permits for non-isotropic localization.
 
 {{{
   SUBROUTINE PDAFomi_set_localize_covar(thisobs, dim, ncoords, coords, &
        locweight, cradius, sradius)
-}}}
-with arguments:
-{{{
+
     TYPE(obs_f), INTENT(inout) :: thisobs       ! Data type with full observation
     INTEGER, INTENT(in) :: dim                  ! State dimension
@@ -57 +53 @@
 == `PDAFomi_set_localize_covar` for non-isotropic localization with different weight functions ==
 
-There is an alternative interface for non-isotropic localization which further allows to specify different weight functions for each direction. This allows, for example to use a constant weight in the vertical direction, but smoother decaying weight in the horizontal directions. In this variant `cradius` and `sradius` are specified as vectors holding a value of localization radius for each coordinate direction. In addition `locweight` is specified as a vector holding the localization function index for each coordinate direction.
+There is also an alternative interface for non-isotropic localization which further allows to specify different weight functions for each direction. This allows, for example, to use a constant weight in the vertical direction, but smooth decaying weight in the horizontal directions. In this variant of the interface `cradius` and `sradius` are specified as vectors holding a value of localization radius for each coordinate direction. In addition `locweight` is specified as a vector holding the localization function index for each coordinate direction.
 
 {{{
   SUBROUTINE PDAFomi_set_localize_covar(thisobs, dim, ncoords, coords, &
        locweight, cradius, sradius)
-}}}
-with arguments:
-{{{
+
     TYPE(obs_f), INTENT(inout) :: thisobs       ! Data type with full observation
     INTEGER, INTENT(in) :: dim                  ! State dimension