# ---------------------------------------------------------------
# Programmer(s): Cody J. Balos @ LLNL
# ---------------------------------------------------------------
# SUNDIALS Copyright Start
# Copyright (c) 2002-2020, 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 SUNMATRIX_CUSPARSE examples
# ---------------------------------------------------------------

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

# Examples using SUNDIALS cuda nvector
set(sunmatrix_cusparse_examples
  "test_sunmatrix_cusparse\;random 100 100 1 CSR 0\;\;\;"
  "test_sunmatrix_cusparse\;random 101 100 1 CSR 0\;\;\;"
  "test_sunmatrix_cusparse\;random 10 10 50 BCSR 0\;\;\;"
  "test_sunmatrix_cusparse\;random 100 100 5 BCSR 0\;\;\;"
  )

# Dependencies for matrix examples
set(sunmatrix_examples_dependencies
  test_sunmatrix
  sundials_matrix
  dreadrb
  )

# Specify libraries to link against (through the target that was used to
# generate them) based on the value of the variable LINK_LIBRARY_TYPE
if(LINK_LIBRARY_TYPE MATCHES "static")
  set(SUNDIALS_LIBS sundials_nvecserial_static
                    sundials_nveccuda_static
                    sundials_sunmatrixdense_static
                    sundials_sunmatrixsparse_static
                    sundials_sunmatrixcusparse_static
                    ${EXTRA_LINK_LIBS})
else()
  set(SUNDIALS_LIBS sundials_nvecserial_shared
                    sundials_nveccuda_shared
                    sundials_sunmatrixdense_shared
                    sundials_sunmatrixsparse_shared
                    sundials_sunmatrixcusparse_shared
                    ${EXTRA_LINK_LIBS})
endif()

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

  # parse the example tuple
  list(GET example_tuple 0 example)
  list(GET example_tuple 1 example_args)
  list(GET example_tuple 2 number_of_nodes)
  list(GET example_tuple 3 number_of_tasks)
  list(GET example_tuple 4 example_type)

  # This is used to get around DLL linkage issue since we are
  # manually including sundials_nvector.c here, which is normally in
  # a library that is included.  If this is not set build system
  # thinks nvector is externally linked.
  if(WIN32)
    add_definitions(-DBUILD_SUNDIALS_LIBRARY)
  endif(WIN32)

  # 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
    add_executable(${example} ${example}.cu
                  ../test_sunmatrix.c
                  ../dreadrb.c
                  ${sundials_SOURCE_DIR}/src/sundials/sundials_matrix.c)

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

    # libraries to link against
    target_link_libraries(${example} PRIVATE ${SUNDIALS_LIBS})

    # additional includes
    target_include_directories(${example} PRIVATE . .. ${sundials_SOURCE_DIR}/src/sunmatrix/cusparse)
  endif()

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

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

  # install example source files
  if(SUNDIALS_EXAMPLES_INSTALL)
    install(FILES ${example}.cu
      ../test_sunmatrix.c
      ../test_sunmatrix.h
      ../dreadrb.c
      ../dreadrb.h
      ../../../src/sundials/sundials_matrix.c
      DESTINATION ${SUNDIALS_EXAMPLES_INSTALL_PATH}/sunmatrix/cusparse)
  endif()

endforeach(example_tuple ${sunmatrix_cusparse_examples})

if(SUNDIALS_EXAMPLES_INSTALL)

  # Install the README file
  install(FILES DESTINATION ${SUNDIALS_EXAMPLES_INSTALL_PATH}/sunmatrix/cusparse)

  # Prepare substitution variables for Makefile and/or CMakeLists templates
  set(SOLVER_LIB "")
  set(NVECTOR_LIB " sundials_nvecserial sundials_nveccuda")
  set(SUNMAT_LIB "sundials_sunmatrixdense sundials_sunmatrixsparse sundials_sunmatrixcusparse")
  set(SUNLS_LIB "")

  examples2string(sunmatrix_cusparse_examples EXAMPLES_CUSOLVER)
  examples2string(sunmatrix_examples_dependencies EXAMPLES_DEPENDENCIES)

  # 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_CUDA_ex.in
    ${PROJECT_BINARY_DIR}/examples/sunmatrix/cusparse/CMakeLists.txt
    @ONLY
    )

  # install CMakelists.txt
  install(
    FILES ${PROJECT_BINARY_DIR}/examples/sunmatrix/cusparse/CMakeLists.txt
    DESTINATION ${SUNDIALS_EXAMPLES_INSTALL_PATH}/sunmatrix/cusparse
    )

  # 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_CUDA_ex.in
      ${PROJECT_BINARY_DIR}/examples/sunmatrix/cusparse/Makefile_ex
      @ONLY
      )
    # install the configured Makefile_ex as Makefile
    install(
      FILES ${PROJECT_BINARY_DIR}/examples/sunmatrix/cusparse/Makefile_ex
      DESTINATION ${SUNDIALS_EXAMPLES_INSTALL_PATH}/sunmatrix/cusparse
      RENAME Makefile
      )
  endif(UNIX)

endif(SUNDIALS_EXAMPLES_INSTALL)
