Changes between Version 2 and Version 3 of PDAF_get_local_type

Timestamp:

Mar 24, 2025, 9:54:32 AM (3 months ago)

Author:

lnerger

Comment:

--

PDAF_get_local_type

@@ -1 +1 @@
 = PDAF_get_local_type = 
 
-This page documents the routine `PDAF_get_local_type` of PDAF, which are introduced with PDAF 3.0.
+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 [wiki: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. 
@@ -11 +11 @@
 The interface is the following:
 {{{
-  SUBROUTINE FUNCTION PDAF_local_type(localtype)
+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)
 }}}
-with argument:
-{{{
-  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/EAKF)
 
-`localtype` can be directly used, e.g. as
+The value of `localtype` can be directly used, e.g. as
 {{{
   IF (localtype > 0) THEN