Changeset 13296 for NEMO

Timestamp:

2020-07-10T20:36:34+02:00 (4 years ago)

Author:

acc

Message:

Update comments in new do_loop_substitute.h90 on the trunk

File:

• NEMO/trunk/src/OCE/do_loop_substitute.h90 (modified) (3 diffs)

NEMO/trunk/src/OCE/do_loop_substitute.h90

@@ -8 +8 @@
 ! between version 4.0 and 4.2. The primary aim of these macros is to assist in future applications of tiling
 ! to improve performance. This is expected to be achieved by alternative versions of these macros in selected
-! locations. The initial introduction of these macros simply replaces all identifiable nested 2D- and 3D-loops
-! with single line statements (and adjusts indenting accordingly). Do loops are identifiable if they comform
+! locations. The initial introduction of these macros simply replaced all identifiable nested 2D- and 3D-loops
+! with single line statements (and adjusts indenting accordingly). Do loops were identifiable if they comformed
 ! to either:
 !                                       DO jk = ....
@@ -21 +21 @@
 ! and white-space variants thereof.
 !
-! Additionally, only loops with recognised jj and ji loops limits are treated; these are:
+! Additionally, only loops with recognised jj and ji loops limits were treated; these were:
 ! Lower limits of 1, 2 or fs_2
 ! Upper limits of jpi, jpim1 or fs_jpim1 (for ji) or jpj, jpjm1 or fs_jpjm1 (for jj)
 !
-! The macro naming convention takes the form: DO_2D_BT_LR where: 
+! The macro naming convention takes the form: DO_2D( B, T, L, R) where: 
 !   B is the Bottom offset from the PE's inner domain;
 !   T is the Top    offset from the PE's inner domain;
@@ -42 +42 @@
 ! with:
 !
-!   DO_2D_01_10
+!   DO_2D( 0, 1, 1, 0 )
 !      .
 !      .