make Release mode the default build type so users automatically get the fastest configuration

CHANGELOG.md

@@ -159,7 +159,11 @@ Fixed [#329](https://github.com/LLNL/sundials/issues/329) so that C++20 aggregat
 
 Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 [#409](https://github.com/LLNL/sundials/issues/409) and
-[#249](https://github.com/LLNL/sundials/issues/249)
+[#249](https://github.com/LLNL/sundials/issues/249).
+
+The `CMAKE_BUILD_TYPE` defaults to `Release` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was
+unset by default so no optimization or debug flags were set.
 
 ## Changes to SUNDIALS in release 6.7.0
 

CMakeLists.txt

@@ -139,6 +139,16 @@ set(_SHARED_LIB_SUFFIX
 set(_SUNDIALS_ALIAS_TARGETS ""
     CACHE INTERNAL "" FORCE)
 
+# We default to release builds
+set(_DEFAULT_CMAKE_BUILD_TYPE RelWithDebInfo)
+if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
+  message(STATUS "Building SUNDIALS in '${_DEFAULT_CMAKE_BUILD_TYPE}' mode as CMAKE_BUILD_TYPE was not specified.")
+  set(CMAKE_BUILD_TYPE "${_DEFAULT_CMAKE_BUILD_TYPE}" CACHE STRING "Choose the type of build." FORCE)
+  set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
+else()
+  message(STATUS "Building SUNDIALS in '${CMAKE_BUILD_TYPE}' mode.")
+endif()
+
 # ===============================================================
 # Build options to be processed first
 # ===============================================================

doc/arkode/guide/source/Introduction.rst

@@ -317,6 +317,10 @@ Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 `GitHub Issues #409 <https://github.com/LLNL/sundials/issues/409>`_ and
 `#249 <https://github.com/LLNL/sundials/issues/249>`_.
 
+The ``CMAKE_BUILD_TYPE`` defaults to ``Release`` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was unset
+by default so no optimization or debug flags were set.
+
 Changes in v5.7.0
 -----------------
 

doc/cvode/guide/source/Introduction.rst

@@ -287,6 +287,10 @@ Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 `GitHub Issues #409 <https://github.com/LLNL/sundials/issues/409>`_ and
 `#249 <https://github.com/LLNL/sundials/issues/249>`_.
 
+The ``CMAKE_BUILD_TYPE`` defaults to ``Release`` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was unset
+by default so no optimization or debug flags were set.
+
 Changes in v6.7.0
 -----------------
 

doc/cvodes/guide/source/Introduction.rst

@@ -287,6 +287,10 @@ Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 `GitHub Issues #409 <https://github.com/LLNL/sundials/issues/409>`_ and
 `#249 <https://github.com/LLNL/sundials/issues/249>`_.
 
+The ``CMAKE_BUILD_TYPE`` defaults to ``Release`` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was unset
+by default so no optimization or debug flags were set.
+
 Changes in v6.7.0
 -----------------
 

doc/ida/guide/source/Introduction.rst

@@ -248,6 +248,10 @@ Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 `GitHub Issues #409 <https://github.com/LLNL/sundials/issues/409>`_ and
 `#249 <https://github.com/LLNL/sundials/issues/249>`_.
 
+The ``CMAKE_BUILD_TYPE`` defaults to ``Release`` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was unset
+by default so no optimization or debug flags were set.
+
 Changes in v6.7.0
 -----------------
 

doc/idas/guide/source/Introduction.rst

@@ -262,6 +262,10 @@ Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 `GitHub Issues #409 <https://github.com/LLNL/sundials/issues/409>`_ and
 `#249 <https://github.com/LLNL/sundials/issues/249>`_.
 
+The ``CMAKE_BUILD_TYPE`` defaults to ``Release`` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was unset
+by default so no optimization or debug flags were set.
+
 Changes in v5.7.0
 -----------------
 

doc/kinsol/guide/source/Introduction.rst

@@ -243,6 +243,10 @@ Fixed integer overflow in the internal SUNDIALS hashmap. This resolves
 `GitHub Issues #409 <https://github.com/LLNL/sundials/issues/409>`_ and
 `#249 <https://github.com/LLNL/sundials/issues/249>`_.
 
+The ``CMAKE_BUILD_TYPE`` defaults to ``Release`` mode now i.e., SUNDIALS will be
+built with optimizations enabled by default. Previously the build type was unset
+by default so no optimization or debug flags were set.
+
 Changes in v6.7.0
 -----------------
 

doc/shared/sundials/Install.rst

@@ -27,16 +27,16 @@ source. One option is to use the `Spack HPC package manager <https://spack.io/>`
 The second supported option for building and installing SUNDIALS is with CMake.
 Before proceeding with CMake, the source code must be downloaded. This can be done
 by cloning the `SUNDIALS GitHub repository <https://github.com/LLNL/sundials>`_
-(run ``git clone https://github.com/LLNL/sundials``), or by downloading the 
-SUNDIALS release compressed archives (``.tar.gz``) from  the SUNDIALS 
+(run ``git clone https://github.com/LLNL/sundials``), or by downloading the
+SUNDIALS release compressed archives (``.tar.gz``) from  the SUNDIALS
 `website <https://computing.llnl.gov/projects/sundials/sundials-software>`_.
 
 The compressed archives allow for downloading of indvidual SUNDIALS packages.
 The name of the distribution archive is of the form
 ``SOLVER-X.Y.Z.tar.gz``, where ``SOLVER`` is one of: ``sundials``, ``cvode``,
 ``cvodes``, ``arkode``, ``ida``, ``idas``, or ``kinsol``, and ``X.Y.Z``
 represents the version number (of the SUNDIALS suite or of the individual
-solver). After downloading the relevant archives, uncompress and expand the sources, 
+solver). After downloading the relevant archives, uncompress and expand the sources,
 by running
 
 .. code-block:: bash
@@ -353,9 +353,9 @@ illustration only.
 .. cmakeoption:: CMAKE_BUILD_TYPE
 
    Choose the type of build, options are:
-   ``None``, ``Debug``, ``Release``, ``RelWithDebInfo``, and ``MinSizeRel``
+   ``Debug``, ``Release``, ``RelWithDebInfo``, and ``MinSizeRel``
 
-   Default:
+   Default: ``RelWithDebInfo``
 
    .. note::
 
@@ -630,8 +630,8 @@ illustration only.
 
 .. cmakeoption:: SUNDIALS_ENABLE_ERROR_CHECKS
 
-   Build SUNDIALS with more extensive checks for unrecoverable errors. 
-   
+   Build SUNDIALS with more extensive checks for unrecoverable errors.
+
    Default: ``OFF`` when ``CMAKE_BUILD_TYPE=Release|RelWithDebInfo `` and ``ON`` otherwise.
 
    .. warning::
@@ -1048,7 +1048,7 @@ illustration only.
    Default: None
 
 .. cmakeoption:: ENABLE_ADIAK
-   
+
    Enable Adiak support
 
    Default: OFF
@@ -1675,7 +1675,7 @@ header files.
    SUNDIALS installs some header files to ``INSTDIR/include/sundials/priv``.
    All of the header files in this directory are private and **should not
    be included in user code**. The private headers are subject to change
-   without any notice and relying on them may break your code. 
+   without any notice and relying on them may break your code.
 
 
 Using SUNDIALS in your prpject