# ---------------------------------------------------------------
# Programmer(s): Daniel R. Reynolds @ SMU
# ---------------------------------------------------------------
# SUNDIALS Copyright Start
# Copyright (c) 2002-2025, Lawrence Livermore National Security
# and Southern Methodist University.
# All rights reserved.
#
# See the top-level LICENSE and NOTICE files for details.
#
# SPDX-License-Identifier: BSD-3-Clause
# SUNDIALS Copyright End
# ---------------------------------------------------------------
# CMakeLists.txt file for sunlinsol SuperLU_MT examples
# ---------------------------------------------------------------

# Example lists are tuples "name\;args\;type" where the type is 'develop' for
# examples excluded from 'make test' in releases

# Examples using the SuperLU_MT linear solver Note: threaded tests are excluded
# because of a potential bug in SuperLU_MT that causes random test failures
set(sunlinsol_superlumt_examples
    "test_sunlinsol_superlumt\;300 0 1 0\;"
    "test_sunlinsol_superlumt\;300 1 1 0\;"
    "test_sunlinsol_superlumt\;1000 0 3 0\;exclude"
    "test_sunlinsol_superlumt\;1000 1 3 0\;exclude")

# Dependencies for nvector examples
set(sunlinsol_superlumt_dependencies test_sunlinsol)

# Add source directory to include directories
include_directories(. ..)

# Add the build and install targets for each example
foreach(example_tuple ${sunlinsol_superlumt_examples})

  # parse the example tuple
  list(GET example_tuple 0 example)
  list(GET example_tuple 1 example_args)
  list(GET example_tuple 2 example_type)

  # check if this example has already been added, only need to add example
  # source files once for testing with different inputs
  if(NOT TARGET ${example})
    # example source files
    sundials_add_executable(${example} ${example}.c ../test_sunlinsol.c)

    # folder to organize targets in an IDE
    set_target_properties(${example} PROPERTIES FOLDER "Examples")

    # libraries to link against
    target_link_libraries(
      ${example} sundials_nvecserial sundials_sunmatrixdense
      sundials_sunmatrixsparse sundials_sunlinsolsuperlumt
      ${EXE_EXTRA_LINK_LIBS})
  endif()

  # check if example args are provided and set the test name
  if("${example_args}" STREQUAL "")
    set(test_name ${example})
  else()
    string(REGEX REPLACE " " "_" test_name ${example}_${example_args})
  endif()

  # add example to regression tests
  sundials_add_test(
    ${test_name} ${example}
    TEST_ARGS ${example_args}
    EXAMPLE_TYPE ${example_type}
    NODIFF)

  if(EXAMPLES_INSTALL)
    install(FILES ${example}.c ../test_sunlinsol.h ../test_sunlinsol.c
            DESTINATION ${EXAMPLES_INSTALL_PATH}/sunlinsol/superlumt)
  endif()

endforeach(example_tuple ${sunlinsol_superlumt_examples})

if(EXAMPLES_INSTALL)

  # Install the README file
  install(FILES DESTINATION ${EXAMPLES_INSTALL_PATH}/sunlinsol/superlumt)

  # Prepare substitution variables for Makefile and/or CMakeLists templates
  set(SOLVER_LIB "sundials_sunlinsolsuperlumt")
  set(LIBS "${LIBS} -lsundials_sunmatrixdense -lsundials_sunmatrixsparse")

  # Set the link directory for the dense and sparse sunmatrix libraries The
  # generated CMakeLists.txt does not use find_library() locate them
  set(EXTRA_LIBS_DIR "${libdir}")

  examples2string(sunlinsol_superlumt_examples EXAMPLES_SLUMT)
  examples2string(sunlinsol_superlumt_dependencies EXAMPLES_DEPENDENCIES_SLUMT)

  if(SUNDIALS_SUPERLUMT_THREAD_TYPE STREQUAL "PTHREAD")
    set(THREAD_LIBRARY_SLUMT ${CMAKE_THREAD_LIBS_INIT})
  else()
    set(THREAD_LIBRARY_SLUMT "")
  endif()

  # Regardless of the platform we're on, we will generate and install
  # CMakeLists.txt file for building the examples. This file  can then be used
  # as a template for the user's own programs.

  # generate CMakelists.txt in the binary directory
  configure_file(
    ${PROJECT_SOURCE_DIR}/examples/templates/cmakelists_serial_C_ex.in
    ${PROJECT_BINARY_DIR}/test/unit_tests/sunlinsol/superlumt/CMakeLists.txt
    @ONLY)

  # install CMakelists.txt
  install(
    FILES
      ${PROJECT_BINARY_DIR}/test/unit_tests/sunlinsol/superlumt/CMakeLists.txt
    DESTINATION ${EXAMPLES_INSTALL_PATH}/sunlinsol/superlumt)

  # On UNIX-type platforms, we also  generate and install a makefile for
  # building the examples. This makefile can then be used as a template for the
  # user's own programs.

  if(UNIX)
    # generate Makefile and place it in the binary dir
    configure_file(
      ${PROJECT_SOURCE_DIR}/examples/templates/makefile_serial_C_ex.in
      ${PROJECT_BINARY_DIR}/test/unit_tests/sunlinsol/superlumt/Makefile_ex
      @ONLY)
    # install the configured Makefile_ex as Makefile
    install(
      FILES
        ${PROJECT_BINARY_DIR}/test/unit_tests/sunlinsol/superlumt/Makefile_ex
      DESTINATION ${EXAMPLES_INSTALL_PATH}/sunlinsol/superlumt
      RENAME Makefile)
  endif()

endif()
