Changes between Version 5 and Version 6 of HowTo/FortranStandards

Timestamp:

2013-04-17T14:32:23+02:00 (11 years ago)

Author:

mmcgrath

Comment:

--

HowTo/FortranStandards

@@ -18 +18 @@
 > I don't understand this at all (BB)
 >> This needs further clarification (JB)
+
+
+1) For function/suroutine calls, there should only be five arguments per line.
+{{{
+CALL subroutine(arg1, arg2, arg3, arg4, arg5, &
+                arg6, arg7, ... )
+}}}
+
+The reason is that subroutine arguments are not strictly checked, so when one is hunting
+for bugs, it's nice to be able to quickly check that all the arguments are in the right place.
+
+2) Related to point one, in the variable declaration of the subroutine, it's nice to have
+all the variables which are passed to/from to be in the same order as they are listed.
+{{{
+SUBROUTINE subroutine(arg1, arg2, arg3, arg4, arg5, &
+                arg6, arg7, ... )
+
+    !
+    !! 0. Variable and parameter declaration
+    !
+
+    !
+    !! 0.1 Input variables
+    !
+    INTEGER(i_std), INTENT(in)                                :: arg1         !! Domain size (unitless)
+    REAL(r_std), INTENT (in)                                  :: arg2         !! Time step (s)
+    REAL(r_std),DIMENSION (kjpindex), INTENT (in)             :: arg3         !! Downwelling short wave flux 
+                                                  
+   !
+    !! 0.2 Output variables
+    !
+    INTEGER(i_std), INTENT(out)                               :: arg4         !! Domain size (unitless)
+    REAL(r_std), INTENT (out)                                 :: arg5         !! Time step (s)
+    REAL(r_std),DIMENSION (kjpindex), INTENT (out)            :: arg6         !! Downwellin
+
+   !! 0.3 Modified variables
+    !
+    INTEGER(i_std), INTENT(inout)                             :: arg7         !! Domain size (unitless)
+
+}}}