Merge pull request #38 from MiCurry/cmake-add-spherical

This commit adds the ability for the CMake build system to build the spherical version of ModEM. The user can add the -CBUILD_SPHERICAL=ON flag to build the spherical version.

Similar to the Configure script, it produces a warning to the user alerting them that they cannot use it as simply as normal MT setups. In order to bypass the warning the error message indicates they should use the -DFORCE_SPHERICAL=ON.

Author: MiCurry

CMakeLists.txt

@@ -10,6 +10,7 @@ option(BUILD_MPI "Build MPI version of MPI" ON)
 option(BUILD_HDF5 "Build with HDF5" OFF)
 option(FG "Build the Fine-Grained ModEM Version - (Only compatiable with SP2)" OFF)
 option(USE_C_TIMERS "Use the C timers in ModEM_timers" OFF)
+option(BUILD_SPHERICAL "Specify whether to build Spherical Coordinate version of ModEM" OFF)
 
 set(FORWARD_FORMULATION "SP2" CACHE STRING "Set the forward formulation: < MF | SP | SP2 >")
 set(MODEM_BUILD_DIMS "3D" CACHE STRING "Specify whether to build either the 2D or 3D versino of ModEM < 2D | 3D >")
@@ -72,6 +73,14 @@ if (FG AND NOT FORWARD_FORMULATION STREQUAL SP2)
         message(FATAL_ERROR "You cannot build 'FG' with '${FORWARD_FORMULATION}' - Only SP2: -DFG=on -DFORWARD_FORMULATION=SP2")
 endif()
 
+if (BUILD_SPHERICAL AND NOT FORCE_SPHERICAL)
+        message(SEND_ERROR
+           "The Spherical Version is experimental and will not work with traditional MT source setup."
+           "For more information please see 'Spherical Coordinates' section in the README.md.\n"
+           "To bypass this error run cmake with: '-DBUILD_SPHERICAL -DFORCE_SPHERICAL' flags"
+        )
+endif()
+
 if (BUILD_MPI)
         add_compile_definitions(MPI)
 endif()

docs/source/building_with_cmake.rst

@@ -39,7 +39,7 @@ Building ModEM with CMake
 
     or if you are in ``ModEM/build``:
 
-    ``cmake -S .. -B . -LH``
+    ``cmake .. -LH``
 
 Navigate into ModEM and create a new directory, ``build``. CMake is nice in that
 it allows us to build out of source. Change directory into this ``build`` directory:
@@ -54,17 +54,13 @@ Now, we can run CMake:
 
 .. code-block:: bash
 
-    $ cmake -S .. -B . -DCMAKE_Fortran_COMPILER=mpifort
-
-In the above command, the ``-S ..`` says that CMake should look in the directory
-above for the source and the ``-B .`` specifies that CMake should build in the
-current working directory.
+    $ cmake .. -DCMAKE_Fortran_COMPILER=mpifort
 
 The above command prints some output:
 
 .. code-block:: bash
 
-    $ cmake -S .. -B . -DCMAKE_Fortran_COMPILER=mpifort
+    $ cmake .. -DCMAKE_Fortran_COMPILER=mpifort
     -- The Fortran compiler identification is LLVMFlang 20.1.8
     -- Detecting Fortran compiler ABI info
     -- Detecting Fortran compiler ABI info - done
@@ -100,7 +96,7 @@ difficulties finding them, you can specify them by using the
 
 .. code-block:: bash
 
-    $ cmake -S .. -B -DLAPACK_LIBRARIES=/path/to/lapacklib/liblapack.a -DBLAS_LIBRARIES=/path/to/lablaslib/libblas.a
+    $ cmake .. -DLAPACK_LIBRARIES=/path/to/lapacklib/liblapack.a -DBLAS_LIBRARIES=/path/to/lablaslib/libblas.a
 
 
 After running CMake command above, and you see that the build files have been
@@ -182,7 +178,7 @@ Again, once can use the following to display all the available options:
 
     $ mkdir build
     $ cd build
-    $ cmake -B .. -S . -LH
+    $ cmake .. -LH
 
 * 2D/3D Builds:
     * ``-DMODEM_BUILD_DIMS=<2D | 3D>``
@@ -243,6 +239,39 @@ also explicitly specify your feature set:
     $ cmake .. -DCMAKE_Fortran_FLAGS="-msse4.2"
 
 
+
+Building ModEM Spherical Version
+==================================
+
+.. warning::
+
+    The Spherical version of ModEM is experimental and will not work with
+    traditional MT source setup. MT forward modeling in spherical coordinates
+    relies on an external 1D forward model and the secondary field formulation
+    option in ModEM to be physically correct.
+
+    Using spherical coordinates with the tradtional MT source setup has not
+    been shown to be physically accurate.
+
+
+To build the experimental spherical version of ModEM you can specify the
+``BUILD_SPHERICAL`` argument in CMake:
+
+.. code-block:: bash
+
+   $ cmake .. -DBUILD_SPHERICAL=on
+
+
+After running the above, you will presented with the same warning printed
+above, in order to fully build the experimental version, you must also pass the
+`FORCE_SPHERICAL` argument as well:
+
+.. code-block:: bash
+
+   $ cmake .. -DBUILD_SPHERICAL=on -DFORCE_SPHERICAL=on
+   $ make
+
+
 Building GPU capable ModEM with CMake
 ======================================
 
@@ -271,7 +300,7 @@ To build ModEM with GPU CUDA we can run the following command:
 .. code-block:: bash
 
     $ mkdir build; cd build
-    $ cmake -S .. -B . -DCMAKE_Fortran_COMPILER=mpifort -DBUILD_GPU=CUDA
+    $ cmake .. -DCMAKE_Fortran_COMPILER=mpifort -DBUILD_GPU=CUDA
 
 Again, you may need to specify LAPACK or BLAS libraries, see
 :ref:`findlapack_n_blas`. After building, you should see confirmation that the
@@ -328,14 +357,14 @@ You can specify your desired compute capability by specifying the
 
 .. code-block:: bash
 
-    $ cmake -S .. -B . -DCMAKE_Fortran_COMPILER=mpifort -DBUILD_GPU=CUDA -DCMAKE_CUDA_ARCHITECTURES="35;50;72"
+    $ cmake .. -DCMAKE_Fortran_COMPILER=mpifort -DBUILD_GPU=CUDA -DCMAKE_CUDA_ARCHITECTURES="35;50;72"
 
 This will generate code for Cuda architectures 35, 50 and 72. You can also tell
 CMake to use whatever capability your GPU can handle with the ``native`` keyword:
 
 .. code-block:: bash
 
-    $ cmake -S .. -B . -DCMAKE_Fortran_COMPILER=mpifort -DBUILD_GPU=CUDA -DCMAKE_CUDA_ARCHITECTURES="native"
+    $ cmake .. -DCMAKE_Fortran_COMPILER=mpifort -DBUILD_GPU=CUDA -DCMAKE_CUDA_ARCHITECTURES="native"
 
 You can also specify ``all`` or ``all-major``, which will generate code for all
 or all major version. For more information on available options see:
@@ -404,3 +433,5 @@ Compiling ModEM GPU Code with HIP
 ----------------------------------
 
 Compiling the HIP code with CMAKE is currently a WIP.
+
+

f90/3D_MT/CMakeLists.txt

@@ -21,18 +21,26 @@ add_subdirectory(modelParam)
 
 target_sources(${MODEM_EXE} 
     PRIVATE DataFunc.f90
+    PRIVATE DataIO.f90
     PRIVATE EMfieldInterp.f90
     PRIVATE ForwardSolver.f90
-    PRIVATE GridCalc.f90
-    #PRIVATE GridCalcS.f90
     PRIVATE GridDef.f90
     PRIVATE Main.f90
-    #PRIVATE mtInvSetup.f90
     PRIVATE SolnSpace.f90
     PRIVATE SolverSens.f90
     PRIVATE Sub_MPI.f90
 )
 
+if (!BUILD_SPHERICAL)
+    target_sources(${MODEM_EXE}
+        PRIVATE GridCalc.f90
+    )
+else()
+    target_sources(${MODEM_EXE}
+        PRIVATE GridCalcS.f90
+    )
+endif()
+
 if(BUILD_MPI)
     target_sources(${MODEM_EXE}
         PRIVATE Sub_MPI.f90

f90/3D_MT/FWD/CMakeLists.txt

@@ -2,9 +2,17 @@
 
 add_subdirectory(Mod2d)
 
+if (!BUILD_SPHERICAL)
+    target_sources(${MODEM_EXE}
+        PRIVATE boundary_ws.f90
+    )
+else()
+    target_sources(${MODEM_EXE}
+        PRIVATE boundary_wsS.f90
+    )
+endif()
+
 target_sources(${MODEM_EXE}
-    PRIVATE boundary_ws.f90
-    #PRIVATE boundary_wsS.f90
     PRIVATE nestedEM.f90
 )
 

f90/3D_MT/SP_Topology/CMakeLists.txt

@@ -1,8 +1,17 @@
 # f90/3D_MT/SP_Topology CMakeLists.txt
 
 target_sources(${MODEM_EXE}
-    PRIVATE MetricElements_CSG.f90
     PRIVATE spOpTools.f90
     PRIVATE spOpTopology_SG.f90
     PRIVATE vecTranslate.f90
-)
+)
+
+if (!BUILD_SPHERICAL)
+    target_sources(${MODEM_EXE}
+        PRIVATE MetricElements_CSG.f90
+    )
+else()
+    target_sources(${MODEM_EXE}
+        PRIVATE MetricElements_SSG.f90
+    )
+endif()

f90/CMakeLists.txt

@@ -8,6 +8,12 @@ elseif (MODEM_BUILD_DIMS STREQUAL 3D)
     set(MODEM_EXE Mod3DMT_${FORWARD_FORMULATION})
     set(MODEM_MAIN_FILE Mod3DMT.f90)
     set(DIM_DIR 3D_MT)
+
+    message(STATUS "Spherical ${BUILD_SPHERICAL}")
+
+    if (BUILD_SPHERICAL)
+        string(APPEND MODEM_EXE "_SPH")
+    endif()
 endif()
 
 add_executable(${MODEM_EXE} ${MODEM_MAIN_FILE})