syntax polishing

CMakeLists.txt

@@ -7,19 +7,20 @@ cmake_minimum_required (VERSION 2.8.8 FATAL_ERROR)
 set(PETSC_DIR $ENV{PETSC_DIR})
 if ("${PETSC_DIR}" STREQUAL "")
   message (FATAL_ERROR "PETSC_DIR is not defined")
-endif ("${PETSC_DIR}" STREQUAL "")
+endif
-
-# Use existing variables from PETSc
-# https://github.com/jedbrown/cmake-modules/blob/master/FindPETSc.cmake
-exec_program(mktemp ARGS -d OUTPUT_VARIABLE PETSC_TEMP)
 
 set (petsc_conf_variables "${PETSC_DIR}/lib/petsc/conf/variables")
 set (petsc_conf_rules     "${PETSC_DIR}/lib/petsc/conf/rules"    )
-# Generate a temporary makefile to probe the PETSc configuration
-# This file will be deleted once the settings from PETSc are parsed
-# into CMake
-set (petsc_config_makefile "${PETSC_TEMP}/Makefile.petsc")
 
+# Use existing variables from PETSc
+# https://github.com/jedbrown/cmake-modules/blob/master/FindPETSc.cmake
+
+# Generate a temporary makefile to probe the PETSc configuration
+# This file will be deleted
+# once the settings from PETSc are parsed into CMake
+
+exec_program (mktemp ARGS -d OUTPUT_VARIABLE TEMPDIR)
+set (petsc_config_makefile "${TEMPDIR}/Makefile.petsc")
 file (WRITE
 "${petsc_config_makefile}"
 "## This file was auto generated by CMake
@@ -74,7 +75,7 @@ execute_process(COMMAND ${MAKE_EXECUTABLE} --no-print-directory -f ${petsc_confi
                  OUTPUT_VARIABLE PETSC_LINKER
                  OUTPUT_STRIP_TRAILING_WHITESPACE)
 # Remove temporary makefile, no need to keep it anymore.
-file (REMOVE_RECURSE ${PETSC_TEMP})
+file (REMOVE_RECURSE ${TEMPDIR})
 
 # Remove duplicate compiler and linker flags
 string (REGEX MATCHALL "-I([^\" ]+)" TMP_LIST "${petsc_includes}")
@@ -98,16 +99,16 @@ message("Found MPI C Compiler:\n${PETSC_MPICC}\n"           )
 #---------------------------------------------------------------------------------------
 # Now start to care about DAMASK
 
-# DAMASK Solver selection
+# DAMASK solver defines project to build
 if ("${DAMASK_SOLVER}" STREQUAL "SPECTRAL")
     project (DAMASK_spectral Fortran C)
     add_definitions (-DSpectral)
-    message("Configuring Spectral Solver\n")
+    message ("Building Spectral Solver\n")
 elseif ("${DAMASK_SOLVER}" STREQUAL "FEM")
     project (DAMASK_FEM Fortran C)
     add_definitions (-DFEM)
-    message("Configuring FEM Solver\n")
+    message ("Building FEM Solver\n")
-endif()
+endif
 
 # set compiler and linker commands (need to be done after defining the project)
 # https://cmake.org/Wiki/CMake_FAQ#How_do_I_use_a_different_compiler.3F
@@ -126,37 +127,37 @@ elseif("${CMAKE_BUILD_TYPE}" STREQUAL "RELEASE")
 elseif ("${CMAKE_BUILD_TYPE}" STREQUAL "PERFORMANCE")
     set (PARALLEL "ON")
     set (OPTI "AGGRESSIVE")
-endif("${CMAKE_BUILD_TYPE}" STREQUAL "DEBUG")
+endif
 
-# overwrite optimization if given
+# $OPTIMIZATION takes precedence over $BUILD_TYPE defaults
 if ("${OPTIMIZATION}" STREQUAL "")
     set (OPTIMIZATION "${OPTI}")
-else("${OPTIMIZATION}" STREQUAL "")
+else
     set (OPTIMIZATION "${OPTIMIZATION}")
-endif("${OPTIMIZATION}" STREQUAL "")
+endif
 
-# overwrite optimization if given
+# $OPENMP takes precedence over $BUILD_TYPE defaults
 if ("${OPENMP}" STREQUAL "")
     set (OPENMP "${PARALLEL}")
-else("${OPENMP}" STREQUAL "")
+else
     set(OPENMP "${OPENMP}")
-endif("${OPENMP}" STREQUAL "")
+endif
 
 # Parse DAMASK_BIN from CONFIG file
 file (READ "CONFIG" CONFIGFILE)
-STRING(REGEX REPLACE ";"  "\\\\;" CONFIGFILE "${CONFIGFILE}")
+string (REGEX REPLACE ";"  "\\\\;" CONFIGFILE "${CONFIGFILE}")
-STRING(REGEX REPLACE "\n" ";"     CONFIGFILE "${CONFIGFILE}")
+string (REGEX REPLACE "\n" ";"     CONFIGFILE "${CONFIGFILE}")
-FOREACH(item ${CONFIGFILE})
+foreach (item ${CONFIGFILE})
-  STRING(REGEX MATCH ".+DAMASK_BIN.+" item ${item})
+  string (REGEX MATCH ".+DAMASK_BIN.+" item ${item})
-    IF(item)
+    if (item)
       string (REGEX REPLACE "set" "" item "${item}")
       string (REGEX REPLACE "="  " " item "${item}")
       string (REGEX REPLACE "\\\${DAMASK_ROOT}" "${PROJECT_SOURCE_DIR}" item "${item}")
       string (REPLACE "DAMASK_BIN" ";" STRING_LIST ${item})
       list (GET STRING_LIST 1 item)
       string (STRIP "${item}" CMAKE_INSTALL_PREFIX)
-    ENDIF(item)
+    endif
-ENDFOREACH(item ${CONFIGFILE})
+endforeach(item ${CONFIGFILE})
 
 # Parse DAMASK version from VERSION file
 find_program (CAT_EXECUTABLE NAMES cat)
@@ -181,7 +182,7 @@ if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
 
   if (OPENMP)
     set (OPENMP_FLAGS "-qopenmp -parallel")
-  endif(OPENMP)
+  endif
 
   if ("${OPTIMIZATION}" STREQUAL "OFF")
       set (OPTIMIZATION_FLAGS    "-O0 -no-ip")
@@ -190,7 +191,7 @@ if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
   elseif ("${OPTIMIZATION}" STREQUAL "AGGRESSIVE")
       set (OPTIMIZATION_FLAGS    "-ipo -O3 -no-prec-div -fp-model fast=2 -xHost")
       # -fast = -ipo, -O3, -no-prec-div, -static, -fp-model fast=2, and -xHost"
-  endif()
+  endif
 
   set (STANDARD_CHECK "-stand f08 -standard-semantics")
   set (LINKER_FLAGS   "${LINKER_FLAGS} -shared-intel")
@@ -200,34 +201,38 @@ if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
 # Fine tuning compilation options
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -fpp")
   # preprocessor
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -ftz")
-  # flush unterflow to zero, automatically set if O<0,1,2,3> >0
+  # flush underflow to zero, automatically set if -O[1,2,3]
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -assume")
-  # assume 
+  # assume ...
   set (COMPILE_FLAGS "${COMPILE_FLAGS} byterecl")
-  #   record length is given in bytes (also set by -standard-semantics)
+  #   ... record length is given in bytes (also set by -standard-semantics)
   set (COMPILE_FLAGS "${COMPILE_FLAGS},fpe_summary")  
-  #   print list of floating point exceptions occured during execution
+  #   ... print list of floating point exceptions occured during execution
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -diag-disable")
-  # disables warnings, where
+  # disables warnings ...
   set (COMPILE_FLAGS "${COMPILE_FLAGS} 5268")
-  #   the text exceeds right hand column allowed on the line (we have only comments there)
+  #   ... the text exceeds right hand column allowed on the line (we have only comments there)
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -warn")
-  # enables warnings, where
+  # enables warnings ...
   set (COMPILE_FLAGS "${COMPILE_FLAGS} declarations")
-  #   any undeclared names (alternative name: -implicitnone)
+  #   ... any undeclared names (alternative name: -implicitnone)
   set (COMPILE_FLAGS "${COMPILE_FLAGS},general")
-  #   warning messages and informational messages are issued by the compiler
+  #   ... warning messages and informational messages are issued by the compiler
   set (COMPILE_FLAGS "${COMPILE_FLAGS},usage")
-  #   questionable programming practices
+  #   ... questionable programming practices
   set (COMPILE_FLAGS "${COMPILE_FLAGS},interfaces")
-  #   checks the interfaces of all SUBROUTINEs called and FUNCTIONs invoked in your compilation against an external set of interface blocks
+  #   ... checks the interfaces of all SUBROUTINEs called and FUNCTIONs invoked in your compilation against an external set of interface blocks
   set (COMPILE_FLAGS "${COMPILE_FLAGS},ignore_loc")
-  #   %LOC is stripped from an actual argument
+  #   ... %LOC is stripped from an actual argument
   set (COMPILE_FLAGS "${COMPILE_FLAGS},alignments")
-  #   data that is not naturally aligned
+  #   ... data that is not naturally aligned
   set (COMPILE_FLAGS "${COMPILE_FLAGS},unused")
-  #   declared variables that are never used
+  #   ... declared variables that are never used
 
   # Additional options
   #  -warn:                    enables warnings, where
@@ -241,36 +246,43 @@ if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
 # Runtime debugging
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -g")
   # Generate symbolic debugging information in the object file
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -traceback")
-  # Generate extra information in the object file to provide source file traceback information when a severe error occurs at run time.
+  # Generate extra information in the object file to provide source file traceback information when a severe error occurs at run time
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -gen-interfaces")
   # Generate an interface block for each routine. http://software.intel.com/en-us/blogs/2012/01/05/doctor-fortran-gets-explicit-again/
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -fp-stack-check")
-  # Generate extra code after every function call to ensure that the floating-point (FP) stack is in the expected state.
+  # Generate extra code after every function call to ensure that the floating-point (FP) stack is in the expected state
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -fp-model strict")
   # Trap uninitalized variables
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -check" )
-  # Checks at runtime, where
+  # Checks at runtime ...
   set (DEBUG_FLAGS "${DEBUG_FLAGS} bounds")
-  #   if an array index is too small (<1) or too large!
+  #   ... if an array index is too small (<1) or too large!
   set (DEBUG_FLAGS "${DEBUG_FLAGS},format")
-  #   for the data type of an item being formatted for output.
+  #   ... for the data type of an item being formatted for output.
   set (DEBUG_FLAGS "${DEBUG_FLAGS},output_conversion")
-  #   for the fit of data items within a designated format descriptor field.
+  #   ... for the fit of data items within a designated format descriptor field.
   set (DEBUG_FLAGS "${DEBUG_FLAGS},pointers")
-  #   for certain disassociated or uninitialized pointers or unallocated allocatable objects.
+  #   ... for certain disassociated or uninitialized pointers or unallocated allocatable objects.
   set (DEBUG_FLAGS "${DEBUG_FLAGS},uninit")
-  #   for uninitialized variables.
+  #   ... for uninitialized variables.
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -ftrapuv")
-  #   initializes stack local variables to an unusual value to aid error detection
+  #   ... initializes stack local variables to an unusual value to aid error detection
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -fpe-all0")
-  #   capture all floating-point exceptions, sets -ftz automatically
+  #   ... capture all floating-point exceptions, sets -ftz automatically
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -warn")
-  # enables warnings, where
+  # enables warnings ...
   set (DEBUG_FLAGS "${DEBUG_FLAGS} errors")
-  #   warnings are changed to errors
+  #   ... warnings are changed to errors
   set (DEBUG_FLAGS "${DEBUG_FLAGS},stderrors")
-  #   warnings about Fortran standard violations are changed to errors
+  #   ... warnings about Fortran standard violations are changed to errors
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -debug-parameters all")
   # generate debug information for parameters
 
@@ -283,9 +295,9 @@ if(${CMAKE_Fortran_COMPILER_ID} STREQUAL "Intel")
 #------------------------------------------------------------------------------------------------
 #  precision settings
   set (PRECISION_FLAGS "${PRECISION_FLAGS} -real-size 64")
-  # set precision to one of those 32/64/128 (= 4/8/16 bytes) for standard real (=8 for pReal)
+  # set precision for standard real to 32 | 64 | 128 (= 4 | 8 | 16 bytes, type pReal is always 8 bytes)
   set (PRECISION_FLAGS "${PRECISION_FLAGS} -integer-size 32")
-  # set precision to one of those 16/32/64 (= 2/4/8 bytes) for standard integer (=4 for pInt)
+  # set precision for standard int to 16 | 32 | 64 (= 2 | 4 | 8 bytes, type pInt is always 4 bytes)
 
 
 ###################################################################################################
@@ -295,7 +307,7 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
 
   if (OPENMP)
     set (OPENMP_FLAGS "-fopenmp")
-  endif()
+  endif
 
   if ("${OPTIMIZATION}" STREQUAL "OFF")
       set (OPTIMIZATION_FLAGS "-O0"       )
@@ -303,7 +315,7 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
       set (OPTIMIZATION_FLAGS "-O2")
   elseif ("${OPTIMIZATION}" STREQUAL "AGGRESSIVE")
       set (OPTIMIZATION_FLAGS "-O3 -ffast-math -funroll-loops -ftree-vectorize")
-  endif()
+  endif
 
   set (STANDARD_CHECK "-std=f2008ts -pedantic-errors" )
   set (LINKER_FLAGS  "${LINKER_FLAGS} -Wl")
@@ -316,12 +328,16 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
 # Fine tuning compilation options
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -xf95-cpp-input")
   # preprocessor
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -ffree-line-length-132")
   # restrict line length to the standard 132 characters (lattice.f90 require more characters)
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -fimplicit-none")
   # assume "implicit none" even if not present in source
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -fmodule-private")
   # assume "private" even if not present in source
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wall")
   # sets the following Fortran options:
   #   -Waliasing:                   warn about possible aliasing of dummy arguments. Specifically, it warns if the same actual argument is associated with a dummy argument with "INTENT(IN)" and a dummy argument with "INTENT(OUT)" in a call with an explicit interface.
@@ -362,6 +378,7 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
   #   -Wunused-value
   #   -Wunused-variable
   #   -Wvolatile-register-var
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wextra")
   # sets the following Fortran options:
   #   -Wunuses-parameter:
@@ -377,10 +394,13 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
   #   -Wuninitialized
   #   -Wunused-but-set-parameter (only with -Wunused or -Wall)
   #   -Wno-globals
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wcharacter-truncation")
   # warn if character expressions (strings) are truncated
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wunderflow")
   # produce a warning when numerical constant expressions are encountered, which yield an UNDERFLOW during compilation
+
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wsuggest-attribute=pure")
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wsuggest-attribute=noreturn")
   set (COMPILE_FLAGS "${COMPILE_FLAGS} -Wconversion-extra")
@@ -398,8 +418,10 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
 # Runtime debugging
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -ffpe-trap=invalid,zero,overflow")
   # stop execution if floating point exception is detected (NaN is silent)
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -g")
   # Generate symbolic debugging information in the object file
+
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -fbacktrace")
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -fdump-core")
   set (DEBUG_FLAGS "${DEBUG_FLAGS} -fcheck=all")
@@ -411,12 +433,13 @@ elseif(${CMAKE_Fortran_COMPILER_ID} STREQUAL "GNU")
 #  precision settings
   set (PRECISION_FLAGS "${PRECISION_FLAGS} -fdefault-real-8")
   # set precision to 8 bytes for standard real (=8 for pReal). Will set size of double to 16 bytes as long as -fdefault-double-8 is not set
+
   set (PRECISION_FLAGS "${PRECISION_FLAGS} -fdefault-double-8")
   # set precision to 8 bytes for double real, would be 16 bytes if -fdefault-real-8 is used
 
   # Additional options
   # -fdefault-integer-8: Use it to set precision to 8 bytes for integer, don't use it for the standard case of pInt=4 (there is no -fdefault-integer-4)
-endif()
+endif
 
 set (CMAKE_Fortran_FLAGS            "${BUILDCMD_PRE} ${OPENMP_FLAGS} ${STANDARD_CHECK} ${OPTIMIZATION_FLAGS} ${COMPILE_FLAGS} ${PRECISION_FLAGS}")
 set (CMAKE_Fortran_LINK_EXECUTABLE  "${BUILDCMD_PRE} ${CMAKE_LINKER} ${OPENMP_FLAGS}   ${OPTIMIZATION_FLAGS} ${LINKER_FLAGS}")
@@ -426,13 +449,13 @@ if("${CMAKE_BUILD_TYPE}" STREQUAL "")
 elseif ("${CMAKE_BUILD_TYPE}" STREQUAL "DEBUG")
   set (CMAKE_Fortran_FLAGS            "${CMAKE_Fortran_FLAGS} ${DEBUG_FLAGS}")
   set (CMAKE_Fortran_LINK_EXECUTABLE  "${CMAKE_Fortran_LINK_EXECUTABLE} ${DEBUG_FLAGS}")
-endif()
+endif
 
 set (CMAKE_Fortran_LINK_EXECUTABLE "${CMAKE_Fortran_LINK_EXECUTABLE} <OBJECTS> -o <TARGET> <LINK_LIBRARIES> ${PETSC_EXTERNAL_LIB} ${BUILDCMD_POST}")
 set (CMAKE_Fortran_FLAGS  "${CMAKE_Fortran_FLAGS} ${DAMASK_INCLUDE_FLAGS} ${BUILDCMD_POST}")
 
-message("Compiler Flags (Fortran):\n${CMAKE_Fortran_FLAGS}\n")
+message ("Fortran Compiler Flags:\n${CMAKE_Fortran_FLAGS}\n")
-message("Linker Flags (Fortran):\n${CMAKE_Fortran_LINK_EXECUTABLE}\n")
+message ("Fortran Linker   Flags:\n${CMAKE_Fortran_LINK_EXECUTABLE}\n")
 
 # location of code
 add_subdirectory (src)
@@ -440,14 +463,14 @@ add_subdirectory(src)
 # INSTALL BUILT BINARIES
 if ("${BUILD_TYPE}" STREQUAL SYNTAXONLY)
    if ("${PROJECT_NAME}" STREQUAL DAMASK_spectral)
-       INSTALL(PROGRAMS    ${PROJECT_BINARY_DIR}/src/DAMASK_spectral
+       install (PROGRAMS    ${PROJECT_BINARY_DIR}/src/DAMASK_spectral
                 DESTINATION ${CMAKE_INSTALL_PREFIX})
    elseif ("${PROJECT_NAME}" STREQUAL DAMASK_FEM)
-       INSTALL(PROGRAMS    ${PROJECT_BINARY_DIR}/src/DAMASK_FEM
+       install (PROGRAMS    ${PROJECT_BINARY_DIR}/src/DAMASK_FEM
                 DESTINATION ${CMAKE_INSTALL_PREFIX})
-   endif("${PROJECT_NAME}" STREQUAL DAMASK_spectral)
+   endif
-else("${BUILD_TYPE}" STREQUAL SYNTAXONLY)
+else
    exec_program(mktemp ARGS -d OUTPUT_VARIABLE BLACK_HOLE)
-       INSTALL(PROGRAMS    ${PROJECT_BINARY_DIR}/src/prec.mod
+   install (PROGRAMS    ${PROJECT_BINARY_DIR}/src/prec.mod
             DESTINATION ${BLACK_HOLE})
-endif()
+endif