Changeset 3fbbfbb for utilities.f

Timestamp:

06/16/10 08:25:47 (14 years ago)

Author:

Jan Meinke <j.meinke@…>

Branches:

master

Children:

5fef0d7

Parents:

9f146fa

Message:

Move to doxygen comments and smmp_p.

Doxygen comments in Fortran are !> ... !! ... !<. I'm planning move the API documentation from the
lyx file into the code. This should make it easier to get documentation for all the common block
variables as well.

Use import smmp_p to indicate the parallel version of the Python bindings.

File:

• utilities.f (modified) (3 diffs)

utilities.f

@@ -7 +7 @@
 ! *********************************************************************
 
-!! Calculate the best way to distribute the work load across processors.
-!  It calculates the average number of interactions and then tries to
-!  assign a number of interactions to each processor that is as close
-!  as possible to the average. The routine should be called once for
-!  every molecule in the system.
-!
-!  @param num_ppr Number of processors per replica
-!  @param nml index of molecule or zero.
-!
-!  @author Jan H. Meinke
+!> Calculate the best way to distribute the work load across processors.
+!!  It calculates the average number of interactions and then tries to
+!!  assign a number of interactions to each processor that is as close
+!!  as possible to the average. The routine should be called once for
+!!  every molecule in the system.
+!!
+!!  @param num_ppr Number of processors per replica
+!!  @param nml index of molecule or zero.
+!!
+!!  @author Jan H. Meinke
+!<
       subroutine distributeWorkLoad(num_ppr,nml)
 
@@ -117 +118 @@
       end subroutine distributeWorkLoad
 
-!-----------------------------------------------------------------------
-!     The function fileNameMP takes a template of a file name in the
-!     variable base. The position of the first and last character that
-!     may be replaced by rank in the string are given in i1 (first) and
-!     i2 (last).
-!     The function returns an empty string if the rank would need more
-!     characters than is allowed by the template.
-!     For example,
-!     \code
-!     rank = 11
-!     fileName = fileNameMP('base_0000.dat', 6, 9, rank)
-!     write (logString, *), fileName
-!     \endcode
-!     will output base_0011.dat.
-!
-!     @param base the base file name, e.g., base_0000.dat.
-!     @param i1 index of the first character that may be replaced
-!     @param i2 index of the last character that may be replaced
-!     @param rank the number that should be inserted into the file name.
-!
-!     @return file name for rank
-!-----------------------------------------------------------------------
+!>
+!!     The function fileNameMP takes a template of a file name in the
+!!     variable base. The position of the first and last character that
+!!     may be replaced by rank in the string are given in i1 (first) and
+!!     i2 (last).
+!!     The function returns an empty string if the rank would need more
+!!     characters than is allowed by the template.
+!!     For example,
+!!     \code
+!!     rank = 11
+!!     fileName = fileNameMP('base_0000.dat', 6, 9, rank)
+!!     write (logString, *), fileName
+!!     \endcode
+!!     will output base_0011.dat.
+!!
+!!     @param base the base file name, e.g., base_0000.dat.
+!!     @param i1 index of the first character that may be replaced
+!!     @param i2 index of the last character that may be replaced
+!!     @param rank the number that should be inserted into the file name.
+!!
+!!     @return file name for rank
+!<
       character*80 function fileNameMP(base, i1, i2, rank)
 
@@ -172 +173 @@
 
 
-!----------------------------------------------------------------------
-!     Add messages to log. This routine takes the log (debugging) mes-
-!     sages and writes them to the log file if the log level is less or
-!     equal to the maximum log level given by the global variable
-!     MAXLOGLEVEL.
-!
-!     @author Jan H. Meinke
-!
-!     @param loglevel level at which this message should be added to
-!            the log.
-!     @param message message to be written to the log.
-!     @param rank global rank of this node if running an MPI job zero
-!            otherwise.
-!----------------------------------------------------------------------
+!>
+!!     Add messages to log. This routine takes the log (debugging) mes-
+!!     sages and writes them to the log file if the log level is less or
+!!     equal to the maximum log level given by the global variable
+!!     MAXLOGLEVEL.
+!!
+!!     @author Jan H. Meinke
+!!
+!!     @param loglevel level at which this message should be added to
+!!            the log.
+!!     @param message message to be written to the log.
+!!     @param rank global rank of this node if running an MPI job zero
+!!            otherwise.
+!<
       subroutine addLogMessage(loglevel, message, rank)
 
-      integer maxloglevel, logfileunit
+         integer MAXLOGLEVEL, LOGFILEUNIT
+         common /log/MAXLOGLEVEL, LOGFILEUNIT
 
          integer :: loglevel, rank