add conditional LAPACK build support for SUNDIALS

modules
  options to enable/disable LAPACK backend for SUNDIALS
  rename LAPACK support definition for SUNDIALS wrapper
  skip iterative solver inclusion for SUNDIALS (add when supported)
  use markdown format for SUNDIALS module description

Author: becm

meson_options.txt

@@ -9,3 +9,5 @@ option('sundials', type : 'string', value : '',
        description : 'SUNDIALS install path')
 option('sundials_vec', type : 'string', value : 'serial',
        description : 'SUNDIALS vector implementation')
+option('sundials_lapack', type : 'boolean', value : false,
+       description : 'LAPACK support for SUNDIALS')

modules/sundials/Makefile

@@ -1,24 +1,27 @@
 # Makefile: SUNDIALS interface library
 LIB ?= mpt_sundials
 #
-# additional build flags
-# DEFINES += SUNDIALS_WITH_LAPACK=1
-DIR_SUNDIALS ?= ${MPT_PREFIX}/math/sundials-3.1.0/build
+# precompiled object location
+DIR_SUNDIALS_OBJ ?= ${MPT_PREFIX}/math/sundials-3.1.0/build
+# include directories
+DIR_SUNDIALS_INC ?= ${MPT_PREFIX}/include
+INC = . ${DIR_SUNDIALS_INC}
+#
+# SUNDIALS modules to include in shared library
 sundials_lapack = sunlinsol_lapackband sunlinsol_lapackdense
-sundials_matrix = sunmat_band sunmat_dense
 sundials_direct = sunlinsol_band sunlinsol_dense ${sundials_lapack}
-sundials_iter   = sunlinsol_pcg sunlinsol_spbcgs
 sundials_elements = cvode ida kinsol ${sundials_iter} ${sundials_direct} nvec_ser
-INC = . ${MPT_PREFIX}/include ${DIR_SUNDIALS}/include/
 #
 # shared library version
 SHLIB_MAJOR = 1
 SHLIB_MINOR = 0
 SHLIB_TEENY = 0
 # linker settings
-LDLIBS += -llapack -lblas
+ifneq (${sundials_lapack},)
+  DEF += MPT_WITH_LAPACK
+  LDLIBS += -llapack -lblas
+endif
 LDLIBS += -lm
-LINK   = ${CC}
 #
 # shared components
 mod_require = ${mod_ivp} ufcn_dae ufcn_ode
@@ -30,9 +33,8 @@ sources = $(wildcard sundials_*.c)
 
 SRCS := ${sources} ${sources_cvode} ${sources_ida}
 
-MATH_OBJS_STATIC != env DIR_SUNDIALS="${DIR_SUNDIALS}" LIBRARY_TYPE=static ./sundials_collect.sh ${sundials_elements}
-MATH_OBJS_SHARED != env DIR_SUNDIALS="${DIR_SUNDIALS}" LIBRARY_TYPE=shared ./sundials_collect.sh ${sundials_elements}
-MATH_OBJS = ${MATH_OBJS_STATIC} ${MATH_OBJS_SHARED}
+MATH_OBJS_STATIC != env DIR_SUNDIALS="${DIR_SUNDIALS_OBJ}" LIBRARY_TYPE=static ./sundials_collect.sh ${sundials_elements}
+MATH_OBJS_SHARED != env DIR_SUNDIALS="${DIR_SUNDIALS_OBJ}" LIBRARY_TYPE=shared ./sundials_collect.sh ${sundials_elements}
 #
 # headers to export
 HEADER = sundials.h

modules/sundials/meson.build

@@ -5,7 +5,7 @@ sundials_dir_lib = join_paths(sundials_dir, 'lib')
 sundials_dir_inc = include_directories(join_paths(sundials_dir, 'include'))
 
 sundials_deps = [ cc.find_library('sundials_nvec' + get_option('sundials_vec'), dirs : sundials_dir_lib) ]
-
+sundials_args = []
 sundials_ida = cc.find_library('sundials_ida', required : false, dirs : sundials_dir_lib)
 sundials_cvode = cc.find_library('sundials_cvode', required : false, dirs : sundials_dir_lib)
 sundials_kinsol = cc.find_library('sundials_kinsol', required : false, dirs : sundials_dir_lib)
@@ -35,18 +35,22 @@ endif
 sundials_deps += cc.find_library('sundials_sunlinsolband', dirs : sundials_dir_lib)
 sundials_deps += cc.find_library('sundials_sunlinsoldense', dirs : sundials_dir_lib)
 
-sundials_deps += cc.find_library('sundials_sunlinsollapackband', dirs : sundials_dir_lib)
-sundials_deps += cc.find_library('sundials_sunlinsollapackdense', dirs : sundials_dir_lib)
+if get_option('sundials_lapack')
+  sundials_deps += cc.find_library('sundials_sunlinsollapackband', dirs : sundials_dir_lib)
+  sundials_deps += cc.find_library('sundials_sunlinsollapackdense', dirs : sundials_dir_lib)
+  sundials_args += '-DMPT_WITH_LAPACK'
+endif
 
 sundials_deps += cc.find_library('sundials_sunmatrixdense', dirs : sundials_dir_lib)
 sundials_deps += cc.find_library('sundials_sunmatrixband', dirs : sundials_dir_lib)
 
-# sundials_deps += libm
+sundials_deps += libm
 
 install_data(sources : 'sundials.conf', install_dir : join_paths('etc', 'mpt.conf.d'))
 
 sundials_lib = shared_library('mpt_sundials', sundials_src, 'libinfo.c',
   include_directories : [ solv_mod_inc ],
+  c_args : sundials_args,
   install_rpath : '$ORIGIN' + ':' + sundials_dir_lib,
   dependencies : [ sundials_deps, modules_dep_dae, modules_dep_ode ],
   version : '1.0.0', soversion : '1',

modules/sundials/sundials.info

@@ -0,0 +1,22 @@
+# SUNDIALS module for [MPT](https://github.com/becm/mpt-solver)
+
+## Source Information
+Use solvers from [SUNDIALS](https://computation.llnl.gov/projects/sundials)
+library
+
+## Local Build
+To use *SUNDIALS* libraries with `Makefile` build
+set `DIR_SUNDIALS_OBJ` to *SUNDIALS* CMake build directory
+and `DIR_SUNDIALS_INC` to *SUNDIALS* install include directory.
+
+### Alternative `Makfile` build modes
+To use shared *SUNDIALS* libraries remove `MATH_OBJS_{SHARED,STATIC}`
+definitions and add *SUNDIALS* libraries to linker arguments.
+
+To disable *LAPACK* support in wrapper comment out `sundials_lapack`
+definition.
+
+### Special vector types
+Library creates serial *SUNDIALS* `N_Vector` instances by default.
+To use different vector backend, reimplement `mpt_sundials_nvector()`
+in user program and link in before `libmpt_sundials.so`.

modules/sundials/sundials.md

@@ -16,7 +16,7 @@
 #include <cvode/cvode_impl.h>
 #include <cvode/cvode_direct.h>
 
-#ifdef SUNDIALS_BLAS_LAPACK
+#ifdef MPT_WITH_LAPACK
 # include <sunlinsol/sunlinsol_lapackdense.h>
 # include <sunlinsol/sunlinsol_lapackband.h>
 #endif
@@ -38,7 +38,7 @@ static int setLS(MPT_SOLVER_STRUCT(sundials) *sd, SUNLinearSolver LS, SUNMatrix
 	return 0;
 }
 
-#ifdef SUNDIALS_BLAS_LAPACK
+#ifdef MPT_WITH_LAPACK
 /* set lapack solver jacobian method */
 static int setLapack(MPT_SOLVER_STRUCT(sundials) *sd, sunindextype neqs)
 {
@@ -145,7 +145,7 @@ extern int mpt_sundials_linear(MPT_SOLVER_STRUCT(sundials) *sd, sunindextype neq
 		}
 		return setLS(sd, s, 0);
 	}
-#ifdef SUNDIALS_BLAS_LAPACK
+#ifdef MPT_WITH_LAPACK
 	if (type == MPT_SOLVER_SUNDIALS(Lapack)) {
 		return setLapack(sd, neqs);
 	}