Working Library Build and Installation

.gitignore

@@ -1,2 +1,6 @@
 # Mac custom attributes file
-.DS_Store  
+.DS_Store  
+
+# IntelliJ
+.idea/
+cmake-build-*/

CMakeLists.txt

@@ -54,6 +54,8 @@ set_target_properties(${TARGET}-static
 		      ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_Fortran_LIB_DIRECTORY})
 target_link_libraries(${TARGET}-static ${LIBS})
 
+# Set fortran preprocessor variables 
+include(cmake/PreprocessorSettings.cmake)
 
 # Install libraries and modules
 # Not sure when this is required: include(GNUInstallDirs)

cmake/CompilerWarnings.cmake

@@ -8,8 +8,8 @@
       -Wcharacter-truncation # Warn when a character assignment will truncate the assigned string.
       -Wfunction-elimination # Warn if any calls to impure functions are eliminated by the optimizations
                              # enabled by the -ffrontend-optimize option
-      -Wimplicit-interface   # Warn if a procedure is called without an explicit interface. 
-      -Wimplicit-procedure   # Warn if a procedure is called that has neither an explicit interface nor has been declared as EXTERNAL.
+      #-Wimplicit-interface   # Warn if a procedure is called without an explicit interface.
+      #-Wimplicit-procedure   # Warn if a procedure is called that has neither an explicit interface nor has been declared as EXTERNAL.
       -Wuse-without-only     # Warn if modules are used without only keyword
       -Wunderflow            # Produce a warning when numerical constant expressions are encountered, which yield an UNDERFLOW during compilation.
       -Wrealloc-lhs          # I assume this warns if the shape of the L.H.S. and R.H.S of an allocatable assignment differ.
@@ -19,6 +19,10 @@
       -pedantic)    # Issue warnings for uses of extensions to Fortran i.e. C's #include
                     # This should be used in conjunction with -std=f95 to f2018
 
+    # Removed warnings
+    # Wimplicit-interface and Wimplicit-procedure are not usable with MPI.
+    # See: https://stackoverflow.com/questions/41938663/why-does-mpich-3-0s-mpi-module-omit-explicit-interfaces-for-some-procedures
+
    # See https://software.intel.com/content/www/us/en/develop/documentation/fortran-compiler-developer-guide-and-reference/top/compiler-reference/compiler-options/compiler-option-details/compiler-diagnostic-options/warn.html
    set(INTEL_WARNINGS
        -warn all     # Enables all warning messages except errors and stderrors

cmake/Doxygen.cmake

@@ -1,3 +1,4 @@
+# TODO(Alex) Replace with FORD
 function(enable_doxygen)
   option(ENABLE_DOXYGEN "Enable doxygen" OFF)
   if (ENABLE_DOXYGEN)

cmake/PreprocessorSettings.cmake

@@ -0,0 +1,23 @@
+# Set pre-processing variables for shared and static libs
+
+if(CMAKE_BUILD_TYPE MATCHES Debug)
+    # Preprocessor variable "DEBUG" in the code
+    set_property(TARGET ${TARGET} APPEND PROPERTY
+            COMPILE_DEFINITIONS "DEBUG")
+
+    set_property(TARGET ${TARGET}-static APPEND PROPERTY
+            COMPILE_DEFINITIONS "DEBUG")
+endif()
+
+# Provides an option for the user to select as ON or OFF.
+#If <variable> is  already set as a normal or cache variable, then the command does nothing
+option(MPI08 "Use mpi_f08 bindings" ON)
+
+if(MPI08)
+    # Preprocessor variable "MPI08" in the code
+    set_property(TARGET ${TARGET} APPEND PROPERTY
+            COMPILE_DEFINITIONS "MPI08")
+
+    set_property(TARGET ${TARGET}-static APPEND PROPERTY
+            COMPILE_DEFINITIONS "MPI08")
+endif()

cmake/StandardProjectSettings.cmake

@@ -24,7 +24,7 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
 endif()
 
 # Generate compile_commands.json: Useful for generating source trails 
-# Test with SourceTrail
+# Test with SourceTrail (although this doesn't support fortran as of 2021)
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
 # Never tested with fortran
@@ -40,6 +40,3 @@ IF(ENABLE_IPO)
      message(SEND_ERROR "IPO is not supported: ${output}")
   endif()
 endif()
-
-
-

src/CMakeLists.txt

@@ -3,8 +3,8 @@ include_directories("${CMAKE_SOURCE_DIR}/src")
 
 set(SOURCE_CODE
    src/mpilib20.F90
-   src/routines/mpilib20_init_finalise.f90
-   src/bindings/mpi_bindings.F90 
-   src/asserts.F90 
+   src/routines/mpilib20_init_finalise.F90
+   src/bindings/mpi_bindings.F90
+   src/errors_warnings/asserts.F90 
    PARENT_SCOPE
    )

src/bindings/mpi_bindings.F90

@@ -6,8 +6,8 @@
 module mpi_bindings
 
     ! Default mpi bindings 
-    #ifdef MPI08 then
-        ! TODO MIght be easier to get rid of the use statement
+#ifdef MPI08
+        ! TODO Might be easier to get rid of the use statement
         use mpi_f08, only:   &
 
             ! Routines
@@ -21,14 +21,14 @@ module mpi_bindings
             MPI_GROUP_SIZE,  &
 
             ! Data types  
-            MPI_COMM_WORLD, &
-            MPI_THREAD_SINGLE
-            MPI_THREAD_FUNNELED
-            MPI_THREAD_SERIALIZED
-            MPI_THREAD_MULTIPLE
+            MPI_COMM_WORLD,        &
+            MPI_THREAD_SINGLE,     &
+            MPI_THREAD_FUNNELED,   &
+            MPI_THREAD_SERIALIZED, &
+            MPI_THREAD_MULTIPLE,   &
 
             ! Derived types 
-            MPI_comm,          &
+            MPI_Comm,          &
             MPI_Datatype,      &
             MPI_Errhandler,    &
             MPI_File,          &
@@ -41,11 +41,11 @@ module mpi_bindings
             MPI_Status
 
         implicit none
-        public 
+        public
 
     ! Support for older mpi bindings     
-    #else 
-        ! TODO MIght be easier to get rid of the use statement
+#else 
+        ! TODO Might be easier to get rid of the use statement
         use mpi, only:  &
 
              ! Routines
@@ -60,9 +60,9 @@ module mpi_bindings
 
              ! Data types  
              MPI_COMM_WORLD, &
-             MPI_THREAD_SINGLE
-             MPI_THREAD_FUNNELED
-             MPI_THREAD_SERIALIZED
+             MPI_THREAD_SINGLE, &
+             MPI_THREAD_FUNNELED, &
+             MPI_THREAD_SERIALIZED, &
              MPI_THREAD_MULTIPLE
 
         implicit none
@@ -75,8 +75,8 @@ module mpi_bindings
         ! https://github.com/hpc/cce-mpi-openmpi-1.7.1/blob/master/ompi/mpi/fortran/use-mpi-f08-desc/mpi-f08-types.f90
 
         ! TODO Document each type 
-        type MPI_comm
-            integer :: VALUE 
+        type MPI_Comm
+            integer :: VALUE
         end type 
         type :: MPI_Datatype
             integer :: MPI_VAL
@@ -123,6 +123,6 @@ module mpi_bindings
            !integer(C_SIZE_T), private :: c_count
         end type MPI_Status
 
-    #endif 
+#endif 
 
 end module

src/errors_warnings/asserts.F90

@@ -17,6 +17,7 @@ module asserts
 
 contains
 
+#ifdef DEBUG
     !> Terminate following a failed assertion 
     !>
     !> @todo Note, this kills ALL mpi processes. One may not want to do this 
@@ -29,6 +30,7 @@ subroutine terminate()
         call MPI_ABORT(MPI_COMM_WORLD, error_code_logical, ierr) 
         !stop error_code_logical
     end subroutine terminate
+#endif
 
     !> Assert if a logical condition is true
     !>
@@ -38,16 +40,25 @@ end subroutine terminate
     subroutine assert_true(logical_condition, message)
         !> Condition to test
         logical, intent(in) :: logical_condition
+#ifdef DEBUG
         !> Optional message for termination
         character(len=*), intent(in), optional :: message
-#ifdef USE_ASSERT
         if (.not. logical_condition) then
             if (present(message)) then
                 write (error_unit, '(/,1x,a)') trim(adjustl(message))
             endif
             call terminate()
         end if
+#else
+        !> Optional message for termination
+        character(len=*), intent(inout), optional :: message
+        ! Return prior to evaluating anything
+        return
+        ! Peform a 'nothing' operation after return so Wunused-dummy-argument doesn't
+        ! complain in release mode. Fortran needs C++17's [[maybe_unused]] attribute.
+        message = merge(message, message, logical_condition)
 #endif
+
     end subroutine assert_true
 
 end module asserts

src/routines/mpilib20_init_finalise.f90

@@ -4,7 +4,7 @@
 !>  to be used as free subroutines.
 module mpilib20_init_finalise
   use, intrinsic :: iso_fortran_env, only: error_unit
-  use mpi_bindings, only: MPI_comm, MPI_Group
+  use mpi_bindings, only : MPI_Comm, MPI_Group
   implicit none
   private 
 
@@ -14,7 +14,7 @@ module mpilib20_init_finalise
   ! TODO. Add get and set 
   !> MPI environment type
   type, public :: mpi_env_type
-     type(MPI_comm)  :: comm         !! MPI communicator (integer in older bindings)
+     type(MPI_Comm)  :: comm         !! MPI communicator (integer in older bindings)
      integer         :: process      !! Process id (rank)
      integer         :: n_processes  !! Total number of processes
      type(MPI_Group) :: group        !! Group id (integer in older bindings)