Merge pull request #6 from jchristopherson/v1.1.0

V1.1.0

Author: jchristopherson

.github/workflows/cmake.yml

@@ -18,13 +18,13 @@ jobs:
         os: [ubuntu-latest, macos-latest]
         toolchain:
           - {compiler: gcc, version: 11}
-          - {compiler: intel-classic, version: '2021.9'}
+          # - {compiler: intel-classic, version: '2021.9'}
         include:
           - os: ubuntu-latest
             toolchain: {compiler: intel, version: '2023.2'}
 
     steps:
-      - uses: awvwgk/setup-fortran@v1
+      - uses: awvwgk/setup-fortran@v1.6.1
         id: setup-fortran
         with:
           compiler: ${{ matrix.toolchain.compiler }}

.github/workflows/fpm.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        gcc_v: [10] # Version of GFortran we want to use.
+        gcc_v: [12] # Version of GFortran we want to use.
         include:
         - os: ubuntu-latest
           os-arch: linux-x86_64
@@ -22,26 +22,25 @@ jobs:
     - name: Checkout code
       uses: actions/checkout@v1
 
-    - name: Install GFortran macOS
-      if: contains(matrix.os, 'macos')
-      run: |
-        ln -s /usr/local/bin/gfortran-${GCC_V} /usr/local/bin/gfortran
-        which gfortran-${GCC_V}
-        which gfortran
-
     - name: Install GFortran Linux
       if: contains(matrix.os, 'ubuntu')
       run: |
         sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-${GCC_V} 100 \
         --slave /usr/bin/gfortran gfortran /usr/bin/gfortran-${GCC_V} \
         --slave /usr/bin/gcov gcov /usr/bin/gcov-${GCC_V}
     
+    - name: Install BLAS & LAPACK
+      if: contains(matrix.os, 'ubuntu')
+      run: |
+        sudo apt-get update
+        sudo apt-get install libopenblas-dev liblapack-dev
+
     - name: Install fpm
-      uses: fortran-lang/setup-fpm@v3
+      uses: fortran-lang/setup-fpm@v5
       with:
-        fpm-version: 'v0.10.0'
+        fpm-version: 'v0.10.1'
 
-    - name: Build the library
+    - name: Build FRICTION
       run: |
         gfortran --version
         fpm build
@@ -50,77 +49,3 @@ jobs:
       run: |
         gfortran --version
         fpm test
-
-  msys2-build:
-    runs-on: windows-latest
-    defaults:
-      run:
-        shell: msys2 {0}
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: msys2/setup-msys2@v2
-        with:
-          msystem: MINGW64
-          update: true
-          path-type: inherit
-          install: |
-            mingw-w64-x86_64-gcc-fortran
-            mingw-w64-x86_64-fpm
-            mingw-w64-x86_64-openblas
-            mingw-w64-x86_64-lapack
-
-      - name: fpm build
-        run: |
-          gfortran --version
-          fpm --version
-          fpm build
-
-      - name: fpm test
-        run: |
-          fpm test
-
-  intel-build:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-
-    env:
-      FPM_FC: ifx
-      FC: ifx
-
-    steps:
-    - name: Checkout code
-      uses: actions/checkout@v3
-
-    - name: Add Intel repository (Linux)
-      run: |
-        wget https://apt.repos.intel.com/intel-gpg-keys/GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB
-        sudo apt-key add GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB
-        rm GPG-PUB-KEY-INTEL-SW-PRODUCTS-2023.PUB
-        echo "deb https://apt.repos.intel.com/oneapi all main" | sudo tee /etc/apt/sources.list.d/oneAPI.list
-        sudo apt-get update
-
-    - name: Install Intel oneAPI compiler (Linux)
-      run: |
-        sudo apt-get install intel-oneapi-compiler-fortran
-
-    - name: Setup Intel oneAPI environment
-      run: |
-        source /opt/intel/oneapi/setvars.sh
-        printenv >> $GITHUB_ENV
-
-    - name: Install fpm
-      uses: fortran-lang/setup-fpm@v3
-      with:
-        fpm-version: 'v0.10.0'
-
-    - name: fpm build
-      run: |
-        ifx --version
-        fpm --version
-        fpm build --profile debug --flag "-warn nointerfaces"
-
-    - name: fpm test
-      run: |
-        fpm test --profile debug --flag "-warn nointerfaces"

CMakeLists.txt

@@ -5,35 +5,26 @@ project(
     LANGUAGES Fortran
     VERSION 1.0.0
 )
-
-# Get helper macros and functions
-include("${PROJECT_SOURCE_DIR}/cmake/helper.cmake")
+set(CMAKE_Fortran_STANDARD 2018)
+set(CMAKE_Fortran_STANDARD_REQUIRED TRUE)
 
 # Confgiure everything
 add_subdirectory(configure)
 
-# Deal with the dependencies
-add_subdirectory(dependencies)
-
 # Source
 add_subdirectory(src)
-add_fortran_library(
-    ${PROJECT_NAME}
-    ${PROJECT_INCLUDE_DIR}
-    ${CMAKE_INSTALL_INCLUDEDIR}
-    ${PROJECT_VERSION}
-    ${PROJECT_VERSION_MAJOR}
-    ${FRICTION_SOURCES}
+
+# Installation Instructions
+install(
+  EXPORT ${PROJECT_NAME}-targets
+  NAMESPACE ${PROJECT_NAME}::
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
 )
-link_library(${PROJECT_NAME} ${ferror_LIBRARY} ${ferror_INCLUDE_DIR})
-link_library(${PROJECT_NAME} ${diffeq_LIBRARY} ${diffeq_INCLUDE_DIR})
-link_library(${PROJECT_NAME} ${fstats_LIBRARY} ${fstats_INCLUDE_DIR})
-link_library(${PROJECT_NAME} ${fitpack_LIBRARY} ${fitpack_INCLUDE_DIR})
 
 # Testing
 option(BUILD_TESTING "Build tests")
 include(CTest)
-message(STATUS "Build tests: ${BUILD_TESTING}")
+message(STATUS "Build FRICTION tests: ${BUILD_TESTING}")
 if (BUILD_TESTING)
     enable_testing()
     add_subdirectory(test)

README.md

@@ -38,25 +38,25 @@ F = k \delta
 ```
 - Generalized Maxwell Slip Model
 ```math
-F = \sum_{i=1}^{n} \left( k_i z_i + b_i \frac{dz_i}{dt} \right) + b_v v
+F = \sum_{i=1}^{n} \left( k_{i} z_{i} + b_{i} \frac{dz_{i}}{dt} \right) + b_{v} v
 ```
 ```math
 \begin{equation}
-\frac{dz_i}{dt} = 
+\frac{dz_{i}}{dt} = 
 \begin{cases}
-v & \text{if $|z_i| \le g(v)$} \\
-\text{sgn} \left( v \right) \nu_i C \left( 1 - \frac{z_i}{\nu_i g(v)} \right) & \text{otherwise}
+v & \text{if} |z_{i}| \le g(v) \\
+\text{sgn} \left( v \right) \nu_{i} C \left( 1 - \frac{z_{i}}{\nu_{i} g(v)} \right) & \text{otherwise}
 \end{cases}
 \end{equation}
 ```
 ```math
-g(v) = a_{1} + \frac{a_2}{1 + s^{\alpha}}
+g(v) = a_{1} + \frac{a_{2}}{1 + s^{\alpha}}
 ```
 ```math
-a_{1} = \frac{\mu_c N}{\sigma_{0}}, a_{2} = \frac{\mu_s N - \mu_c N}{\sigma_{0}}, s = \frac{\left| v \right|}{v_s}
+a_{1} = \frac{\mu_{c} N}{\sigma_{0}}, a_{2} = \frac{\mu_{s} N - \mu_{c} N}{\sigma_{0}}, s = \frac{\left| v \right|}{v_{s}}
 ```
 ```math
-\sum_{i=1}^{n} \nu_i = 1
+\sum_{i=1}^{n} \nu_{i} = 1
 ```
 - Stribeck Model
 ```math

cmake/helper.cmake

@@ -1,6 +1,3 @@
-# Get the macros and functions we'll need
-include("${PROJECT_SOURCE_DIR}/cmake/helper.cmake")
-
 # Set a default build type if none was specified
 if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
   message(STATUS "Setting build type to 'Release' as none was specified.")
@@ -13,11 +10,67 @@ endif()
 option(BUILD_SHARED_LIBS "Build shared libraries" OFF)
 
 # Export all symbols on Windows when building libraries
-set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS TRUE)
+SET(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS TRUE)
 
 # Utilize the GNU installation structure
 include(GNUInstallDirs)
 
 # Locate the local include directory
 set(PROJECT_INCLUDE_DIR ${PROJECT_BINARY_DIR}/include)
-set(PROJECT_INCLUDE_DIR ${PROJECT_INCLUDE_DIR} PARENT_SCOPE)
+set(PROJECT_INCLUDE_DIR ${PROJECT_INCLUDE_DIR} PARENT_SCOPE)
+
+if(NOT DEFINED CMAKE_INSTALL_MODULEDIR)
+  set(
+    CMAKE_INSTALL_MODULEDIR
+    "${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}/${CMAKE_Fortran_COMPILER_ID}-${CMAKE_Fortran_COMPILER_VERSION}"
+    CACHE
+    STRING
+    "Directory in prefix to install generated module files"
+  )
+endif()
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH}" PARENT_SCOPE)
+
+# Export a pkg-config file
+configure_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/template.pc"
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+  @ONLY
+)
+
+install(
+  FILES
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}.pc"
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/pkgconfig"
+)
+
+# Export CMake package file
+include(CMakePackageConfigHelpers)
+configure_package_config_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/template.cmake"
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
+  INSTALL_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)
+
+if(BUILD_SHARED_LIBS OR PROJECT_VERSION_MAJOR EQUAL 0)
+  # Due to the uncertain ABI compatibility of Fortran shared libraries
+  # limit compatibility for dynamic linking to same minor version.
+  set(COMPATIBILITY SameMinorVersion)
+else()
+  # Require API compatibility via semantic versioning for static linking.
+  set(COMPATIBILITY SameMajorVersion)
+endif()
+
+write_basic_package_version_file(
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake"
+  VERSION "${PROJECT_VERSION}"
+  COMPATIBILITY ${COMPATIBILITY}
+)
+
+install(
+  FILES
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake"
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)

configure/CMakeLists.txt

@@ -0,0 +1,5 @@
+@PACKAGE_INIT@
+
+if(NOT TARGET "@PROJECT_NAME@::@PROJECT_NAME@")
+  include("${CMAKE_CURRENT_LIST_DIR}/@[email protected]")
+endif()

configure/template.cmake

@@ -0,0 +1,10 @@
+prefix=@CMAKE_INSTALL_PREFIX@
+libdir=${prefix}/@CMAKE_INSTALL_LIBDIR@
+includedir=${prefix}/@CMAKE_INSTALL_INCLUDEDIR@
+moduledir=${prefix}/@CMAKE_INSTALL_MODULEDIR@
+
+Name: @PROJECT_NAME@
+Description: @PROJECT_DESCRIPTION@
+Version: @PROJECT_VERSION@
+Libs: -L${libdir} -l@PROJECT_NAME@
+Cflags: -I${includedir} -I${moduledir}