Polish

Inst_eddies/Tests/test_set_max_speed.f90

@@ -47,21 +47,21 @@ program test_set_max_speed
 
   type(polyline) cont_list(n_max_cont)
   ! Contour list, with points given by longitude and latitude, in
-  ! radians. Defined only for subscripts 1:n_cont. If n_cont >= 1, the
-  ! outermost contour is element with subscript n_cont. For i <=
-  ! n_cont, the order of points in cont_list(i) (clockwise or
-  ! counter-clockwise) is not specified.
+  ! radians. Defined only for subscripts 1:n_cont. The order of
+  ! points in each contour (clockwise or counter-clockwise) is not
+  ! specified.
 
   type(ssh_contour) cont_list_proj(n_max_cont)
-  ! Contour list, with points given by projection coordinates. Defined
-  ! only for subscripts 1:n_cont. If n_cont >= 1, the outermost
-  ! contour is element with subscript n_cont. The contours are in
-  ! monotonic order of ssh. The contour with a given subscript in
-  ! cont_list_proj corresponds to the contour with the same subscript
-  ! in cont_list. For i <= n_cont, cont_list_proj(i)%area has its
-  ! default initialization value and the order of points in
-  ! cont_list_proj(i) (clockwise or counter-clockwise) is not
-  ! specified.
+  ! Contour list, with points given by projection
+  ! coordinates. Defined only for subscripts 1:n_cont. The contour
+  ! with a given subscript in cont_list_proj corresponds to the
+  ! contour with the same subscript in cont_list. More precisely,
+  ! the point with subscript j in contour i of cont_list_proj
+  ! corresponds to the point with subscript j in contour i of
+  ! cont_list (this is important for mean_speed). For i <= n_cont,
+  ! cont_list_proj(i)%area has its default initialization value and
+  ! the order of points in cont_list_proj(i) (clockwise or
+  ! counter-clockwise) is not specified.
 
   TYPE(shpfileobject) hshp
   type(polygon) p

Inst_eddies/set_contours.f90

@@ -66,21 +66,18 @@ contains
 
     type(polyline) cont_list(n_max_cont)
     ! Contour list, with points given by longitude and latitude, in
-    ! radians. Defined only for subscripts 1:n_cont. If n_cont >= 1,
-    ! the outermost contour is element with subscript n_cont. For i <=
-    ! n_cont, the order of points in cont_list(i) (clockwise or
-    ! counter-clockwise) is not specified.
+    ! radians. Defined only for subscripts 1:n_cont. The order of
+    ! points in each contour (clockwise or counter-clockwise) is not
+    ! specified.
 
     type(ssh_contour) cont_list_proj(n_max_cont)
     ! Contour list, with points given by projection
-    ! coordinates. Defined only for subscripts 1:n_cont. If n_cont >=
-    ! 1, the outermost contour is element with subscript n_cont. The
-    ! contours are in monotonic order of ssh. The contour with a given
-    ! subscript in cont_list_proj corresponds to the contour with the
-    ! same subscript in cont_list. More precisely, the point with
-    ! subscript j in contour i of cont_list_proj corresponds to the
-    ! point with subscript j in contour i of cont_list (this is
-    ! important for mean_speed). For i <= n_cont,
+    ! coordinates. Defined only for subscripts 1:n_cont. The contour
+    ! with a given subscript in cont_list_proj corresponds to the
+    ! contour with the same subscript in cont_list. More precisely,
+    ! the point with subscript j in contour i of cont_list_proj
+    ! corresponds to the point with subscript j in contour i of
+    ! cont_list (this is important for mean_speed). For i <= n_cont,
     ! cont_list_proj(i)%area has its default initialization value and
     ! the order of points in cont_list_proj(i) (clockwise or
     ! counter-clockwise) is not specified.
@@ -102,7 +99,7 @@ contains
     ! Done with outermost contour, now let us take care of the
     ! max-speed contour.
     if (out_cont%closed) then
-       ! Restrict the field to the outermost contour:
+       ! {begin} Restrict the field to the outermost contour:
 
        llc = floor(convert_to_ind(minval(out_cont%points, dim = 2), corner, &
             step))
@@ -115,7 +112,7 @@ contains
 
        corner_window = corner + (llc - 1) * step
 
-       ! Done restricting field
+       ! {end} Done restricting field
 
        call set_max_speed(speed_cont, max_speed, cont_list, cont_list_proj, &
             n_cont, extr%coord, real(extr%coord_proj), &

Inst_eddies/set_max_speed.f90

@@ -44,15 +44,15 @@ contains
 
     type(polyline), intent(inout):: cont_list(:) ! (n_max_cont)
     ! Contour list, with points given by longitude and latitude, in
-    ! radians. Defined only for subscripts 1:n_cont. If n_cont >= 1,
-    ! the outermost contour is element with subscript n_cont. For i <=
-    ! n_cont, the order of points in cont_list(i) (clockwise or
-    ! counter-clockwise) is not specified.
+    ! radians. Defined only for subscripts 1:n_cont. On entry, the
+    ! outermost contour is element with subscript n_cont. The order of
+    ! points in each contour (clockwise or counter-clockwise) is not
+    ! specified.
 
     type(ssh_contour), intent(inout):: cont_list_proj(:) ! (n_max_cont)
     ! Contour list, with points given by projection
-    ! coordinates. Defined only for subscripts 1:n_cont. If n_cont >=
-    ! 1, the outermost contour is element with subscript n_cont. The
+    ! coordinates. Defined only for subscripts 1:n_cont. On entry, the
+    ! outermost contour is element with subscript n_cont and the
     ! contours are in monotonic order of ssh. The contour with a given
     ! subscript in cont_list_proj corresponds to the contour with the
     ! same subscript in cont_list. More precisely, the point with