summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/sundials/package.py
diff options
context:
space:
mode:
Diffstat (limited to 'var/spack/repos/builtin/packages/sundials/package.py')
-rw-r--r--var/spack/repos/builtin/packages/sundials/package.py494
1 files changed, 397 insertions, 97 deletions
diff --git a/var/spack/repos/builtin/packages/sundials/package.py b/var/spack/repos/builtin/packages/sundials/package.py
index 6ee247b7ea..16cbcbe34f 100644
--- a/var/spack/repos/builtin/packages/sundials/package.py
+++ b/var/spack/repos/builtin/packages/sundials/package.py
@@ -1,13 +1,13 @@
##############################################################################
-# Copyright (c) 2013-2016, Lawrence Livermore National Security, LLC.
+# Copyright (c) 2013-2017, Lawrence Livermore National Security, LLC.
# Produced at the Lawrence Livermore National Laboratory.
#
# This file is part of Spack.
# Created by Todd Gamblin, tgamblin@llnl.gov, All rights reserved.
# LLNL-CODE-647188
#
-# For details, see https://github.com/llnl/spack
-# Please also see the LICENSE file for our notice and the LGPL.
+# For details, see https://github.com/spack/spack
+# Please also see the NOTICE and LICENSE files for our notice and the LGPL.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU Lesser General Public License (as
@@ -24,126 +24,351 @@
##############################################################################
from spack import *
import os
+import sys
-class Sundials(Package):
+class Sundials(CMakePackage):
"""SUNDIALS (SUite of Nonlinear and DIfferential/ALgebraic equation
Solvers)"""
- homepage = "http://computation.llnl.gov/casc/sundials/"
- url = "http://computation.llnl.gov/projects/sundials-suite-nonlinear-differential-algebraic-equation-solvers/download/sundials-2.6.2.tar.gz"
+ homepage = "https://computation.llnl.gov/projects/sundials"
+ url = "https://computation.llnl.gov/projects/sundials/download/sundials-2.7.0.tar.gz"
+ maintainers = ['cswoodward', 'gardner48']
+ # ==========================================================================
+ # Versions
+ # ==========================================================================
+
+ version('3.1.0', '1a84ca41c7f71067e03d519ddbcd9dae')
+ version('3.0.0', '5163a44cedd7398bddda442ba00313b8')
+ version('2.7.0', 'c304631b9bc82877d7b0e9f4d4fd94d3')
version('2.6.2', '3deeb0ede9f514184c6bd83ecab77d95')
- variant('mpi', default=True, description='Enable MPI support')
- variant('lapack', default=True,
- description='Build with external BLAS/LAPACK libraries')
- variant('klu', default=False,
- description='Build with SuiteSparse KLU libraries')
- variant('superlu', default=False,
- description='Build with SuperLU_MT libraries')
- variant('openmp', default=False, description='Enable OpenMP support')
- variant('pthread', default=True,
- description='Enable POSIX threads support')
-
- depends_on('cmake', type='build')
- depends_on('mpi', when='+mpi')
- depends_on('blas', when='+lapack')
- depends_on('lapack', when='+lapack')
- depends_on('suite-sparse', when='+klu')
- depends_on('superlu-mt+openmp', when='+superlu+openmp')
- depends_on('superlu-mt+pthread', when='+superlu+pthread')
-
- def install(self, spec, prefix):
- cmake_args = std_cmake_args[:]
- cmake_args.extend([
- '-DBUILD_SHARED_LIBS=ON',
- '-DCMAKE_C_FLAGS=-fPIC',
- '-DCMAKE_Fortran_FLAGS=-fPIC',
- '-DEXAMPLES_ENABLE=ON',
- '-DEXAMPLES_INSTALL=ON',
- '-DFCMIX_ENABLE=ON'
+ # ==========================================================================
+ # Variants
+ # ==========================================================================
+
+ # SUNDIALS solvers
+ sun_solvers = ['CVODE', 'CVODES', 'ARKODE', 'IDA', 'IDAS', 'KINSOL']
+
+ for pkg in sun_solvers:
+ variant(pkg, default=True,
+ description='Enable %s solver' % pkg)
+
+ # Real type
+ variant(
+ 'precision',
+ default='double',
+ description='real type precision',
+ values=('single', 'double', 'extended'),
+ multi=False
+ )
+
+ # Index type
+ variant('int64', default=False,
+ description='Use 64bit integers for indices')
+
+ # Parallelism
+ variant('mpi', default=True,
+ description='Enable MPI parallel vector')
+ variant('openmp', default=False,
+ description='Enable OpenMP parallel vector')
+ variant('pthread', default=False,
+ description='Enable Pthreads parallel vector')
+ variant('cuda', default=False,
+ description='Enable CUDA parallel vector')
+ variant('raja', default=False,
+ description='Enable RAJA parallel vector')
+
+ # External libraries
+ variant('lapack', default=False,
+ description='Enable LAPACK direct solvers')
+ variant('klu', default=False,
+ description='Enable KLU sparse, direct solver')
+ variant('superlu-mt', default=False,
+ description='Enable SuperLU_MT sparse, direct solver')
+ variant('hypre', default=False,
+ description='Enable Hypre MPI parallel vector')
+ variant('petsc', default=False,
+ description='Enable PETSc MPI parallel vector')
+
+ # Library type
+ variant('shared', default=True,
+ description='Build shared libraries')
+ variant('static', default=True,
+ description='Build static libraries')
+
+ # Fortran interface
+ variant('fcmix', default=False,
+ description='Enable Fortran interface')
+
+ # Examples
+ variant('examples-c', default=True,
+ description='Enable C examples')
+ variant('examples-cxx', default=False,
+ description='Enable C++ examples')
+ variant('examples-f77', default=True,
+ description='Enable Fortran 77 examples')
+ variant('examples-f90', default=False,
+ description='Enable Fortran 90 examples')
+ variant('examples-cuda', default=False,
+ description='Enable CUDA examples')
+ variant('examples-raja', default=False,
+ description='Enable RAJA examples')
+ variant('examples-install', default=True,
+ description='Install examples')
+
+ # Generic (std-c) math libraries (UNIX only)
+ variant('generic-math', default=True,
+ description='Use generic (std-c) math libraries on unix systems')
+
+ # ==========================================================================
+ # Conflicts
+ # ==========================================================================
+
+ # Options added after v2.6.2
+ conflicts('+hypre', when='@:2.6.2')
+ conflicts('+petsc', when='@:2.6.2')
+
+ # Options added after v2.7.0
+ conflicts('+cuda', when='@:2.7.0')
+ conflicts('+raja', when='@:2.7.0')
+ conflicts('~int64', when='@:2.7.0')
+ conflicts('+examples-cuda', when='@:2.7.0')
+ conflicts('+examples-raja', when='@:2.7.0')
+
+ # External libraries incompatible with 64-bit indices
+ conflicts('+lapack', when='@3.0.0: +int64')
+ conflicts('+hypre', when='+hypre@:2.6.1a +int64')
+
+ # External libraries incompatible with single precision
+ conflicts('+klu', when='precision=single')
+ conflicts('+hypre', when='+hypre@:2.12.0 precision=single')
+
+ # External libraries incompatible with extended (quad) precision
+ conflicts('+lapack', when='precision=extended')
+ conflicts('+superlu-mt', when='precision=extended')
+ conflicts('+klu', when='precision=extended')
+ conflicts('+hypre', when='+hypre@:2.12.0 precision=extended')
+
+ # External libraries that need to be built with MPI
+ conflicts('+hypre', when='~mpi')
+ conflicts('+petsc', when='~mpi')
+
+ # SuperLU_MT interface requires lapack for external blas (before v3.0.0)
+ conflicts('+superlu-mt', when='@:2.7.0 ~lapack')
+
+ # ==========================================================================
+ # Dependencies
+ # ==========================================================================
+
+ # Build dependencies
+ depends_on('cmake@2.8.1:', type='build')
+
+ # MPI related dependencies
+ depends_on('mpi', when='+mpi')
+ depends_on('mpi', when='+hypre')
+ depends_on('mpi', when='+petsc')
+
+ # Other parallelism dependencies
+ depends_on('cuda', when='+cuda')
+ depends_on('raja', when='+raja')
+
+ # External libraries
+ depends_on('blas', when='+lapack')
+ depends_on('lapack', when='+lapack')
+ depends_on('suite-sparse', when='+klu')
+
+ # Require that external libraries built with the same precision
+ depends_on('petsc~double~complex', when='+petsc precision=single')
+ depends_on('petsc+double~complex', when='+petsc precision=double')
+
+ # Require that external libraries built with the same index type
+ depends_on('hypre', when='+hypre')
+ depends_on('hypre~int64', when='+hypre ~int64')
+ depends_on('hypre+int64', when='+hypre +int64')
+ depends_on('petsc', when='+petsc')
+ depends_on('petsc~int64', when='+petsc ~int64')
+ depends_on('petsc+int64', when='+petsc +int64')
+
+ # Require that PETSc is built with MPI
+ depends_on('petsc+mpi', when='+petsc')
+
+ # Require that SuperLU_MT built with external blas
+ depends_on('superlu-mt+blas', when='+superlu-mt')
+
+ # ==========================================================================
+ # Patches
+ # ==========================================================================
+
+ # remove OpenMP header file and function from hypre vector test code
+ patch('test_nvector_parhyp.patch', when='@2.7.0:3.0.0')
+
+ # ==========================================================================
+ # SUNDIALS Settings
+ # ==========================================================================
+
+ def cmake_args(self):
+ spec = self.spec
+
+ def on_off(varstr):
+ return 'ON' if varstr in self.spec else 'OFF'
+
+ fortran_flag = self.compiler.pic_flag
+ if spec.satisfies('%clang platform=darwin'):
+ mpif77 = Executable(self.spec['mpi'].mpif77)
+ libgfortran = LibraryList(mpif77('--print-file-name',
+ 'libgfortran.a', output=str))
+ fortran_flag += ' ' + libgfortran.ld_flags
+
+ # List of CMake arguments
+ # Note: CMAKE_INSTALL_PREFIX and CMAKE_BUILD_TYPE are set automatically
+ args = []
+
+ # SUNDIALS solvers
+ for pkg in self.sun_solvers:
+ args.extend(['-DBUILD_%s=%s' % (pkg, on_off('+' + pkg))])
+
+ # precision
+ args.extend([
+ '-DSUNDIALS_PRECISION=%s' % spec.variants['precision'].value
+ ])
+
+ # index type (v3.0.0 or later)
+ if spec.satisfies('@3.0.0:'):
+ if '+int64' in spec:
+ args.extend(['-DSUNDIALS_INDEX_TYPE=int64_t'])
+ else:
+ args.extend(['-DSUNDIALS_INDEX_TYPE=int32_t'])
+
+ # Fortran interface
+ args.extend(['-DFCMIX_ENABLE=%s' % on_off('+fcmix')])
+
+ # library type
+ args.extend([
+ '-DBUILD_SHARED_LIBS=%s' % on_off('+shared'),
+ '-DBUILD_STATIC_LIBS=%s' % on_off('+static')
+ ])
+
+ # generic (std-c) math libraries
+ args.extend([
+ '-DUSE_GENERIC_MATH=%s' % on_off('+generic-math')
+ ])
+
+ # parallelism
+ args.extend([
+ '-DMPI_ENABLE=%s' % on_off('+mpi'),
+ '-DOPENMP_ENABLE=%s' % on_off('+openmp'),
+ '-DPTHREAD_ENABLE=%s' % on_off('+pthread'),
+ '-DCUDA_ENABLE=%s' % on_off('+cuda'),
+ '-DRAJA_ENABLE=%s' % on_off('+raja')
])
# MPI support
if '+mpi' in spec:
- cmake_args.extend([
- '-DMPI_ENABLE=ON',
- '-DMPI_MPICC={0}'.format(spec['mpi'].mpicc),
- '-DMPI_MPIF77={0}'.format(spec['mpi'].mpif77)
- ])
- else:
- cmake_args.append('-DMPI_ENABLE=OFF')
+ args.extend(['-DMPI_MPICC=%s' % spec['mpi'].mpicc])
+ if 'examples-cxx' in spec:
+ args.extend(['-DMPI_MPICXX=%s' % spec['mpi'].mpicxx])
+ if ('+fcmix' in spec) and ('+examples-f77' in spec):
+ args.extend(['-DMPI_MPIF77=%s' % spec['mpi'].mpif77])
+ if ('+fcmix' in spec) and ('+examples-f90' in spec):
+ args.extend(['-DMPI_MPIF90=%s' % spec['mpi'].mpifc])
# Building with LAPACK and BLAS
if '+lapack' in spec:
- cmake_args.extend([
+ args.extend([
'-DLAPACK_ENABLE=ON',
- '-DLAPACK_LIBRARIES={0}'.format(
- (spec['lapack'].lapack_libs +
- spec['blas'].blas_libs).joined(';')
- )
+ '-DLAPACK_LIBRARIES=%s'
+ % (spec['lapack'].libs + spec['blas'].libs).joined(';')
])
- else:
- cmake_args.append('-DLAPACK_ENABLE=OFF')
# Building with KLU
if '+klu' in spec:
- cmake_args.extend([
+ args.extend([
'-DKLU_ENABLE=ON',
- '-DKLU_INCLUDE_DIR={0}'.format(
- spec['suite-sparse'].prefix.include),
- '-DKLU_LIBRARY_DIR={0}'.format(
- spec['suite-sparse'].prefix.lib)
+ '-DKLU_INCLUDE_DIR=%s' % spec['suite-sparse'].prefix.include,
+ '-DKLU_LIBRARY_DIR=%s' % spec['suite-sparse'].prefix.lib
])
- else:
- cmake_args.append('-DKLU_ENABLE=OFF')
# Building with SuperLU_MT
- if '+superlu' in spec:
- cmake_args.extend([
+ if '+superlu-mt' in spec:
+ if spec.satisfies('@3.0.0:'):
+ args.extend([
+ '-DBLAS_ENABLE=ON',
+ '-DBLAS_LIBRARIES=%s' % spec['blas'].libs
+ ])
+ args.extend([
'-DSUPERLUMT_ENABLE=ON',
- '-DSUPERLUMT_INCLUDE_DIR={0}'.format(
- spec['superlu-mt'].prefix.include),
- '-DSUPERLUMT_LIBRARY_DIR={0}'.format(
- spec['superlu-mt'].prefix.lib)
+ '-DSUPERLUMT_INCLUDE_DIR=%s'
+ % spec['superlu-mt'].prefix.include,
+ '-DSUPERLUMT_LIBRARY_DIR=%s'
+ % spec['superlu-mt'].prefix.lib
])
- if '+openmp' in spec:
- cmake_args.append('-DSUPERLUMT_THREAD_TYPE=OpenMP')
- elif '+pthread' in spec:
- cmake_args.append('-DSUPERLUMT_THREAD_TYPE=Pthread')
+ if spec.satisfies('^superlu-mt+openmp'):
+ args.append('-DSUPERLUMT_THREAD_TYPE=OpenMP')
else:
- msg = 'You must choose either +openmp or +pthread when '
- msg += 'building with SuperLU_MT'
- raise RuntimeError(msg)
- else:
- cmake_args.append('-DSUPERLUMT_ENABLE=OFF')
+ args.append('-DSUPERLUMT_THREAD_TYPE=Pthread')
- # OpenMP support
- if '+openmp' in spec:
- cmake_args.append('-DOPENMP_ENABLE=ON')
- else:
- cmake_args.append('-DOPENMP_ENABLE=OFF')
+ # Building with Hypre
+ if '+hypre' in spec:
+ args.extend([
+ '-DHYPRE_ENABLE=ON',
+ '-DHYPRE_INCLUDE_DIR=%s' % spec['hypre'].prefix.include,
+ '-DHYPRE_LIBRARY_DIR=%s' % spec['hypre'].prefix.lib
+ ])
+
+ # Building with PETSc
+ if '+petsc' in spec:
+ args.extend([
+ '-DPETSC_ENABLE=ON',
+ '-DPETSC_INCLUDE_DIR=%s' % spec['petsc'].prefix.include,
+ '-DPETSC_LIBRARY_DIR=%s' % spec['petsc'].prefix.lib
+ ])
- # POSIX threads support
- if '+pthread' in spec:
- cmake_args.append('-DPTHREAD_ENABLE=ON')
+ # Examples
+ if spec.satisfies('@3.0.0:'):
+ args.extend([
+ '-DEXAMPLES_ENABLE_C=%s' % on_off('+examples-c'),
+ '-DEXAMPLES_ENABLE_CXX=%s' % on_off('+examples-cxx'),
+ '-DEXAMPLES_ENABLE_F77=%s' % on_off('+examples-f77'),
+ '-DEXAMPLES_ENABLE_F90=%s' % on_off('+examples-f90'),
+ '-DEXAMPLES_ENABLE_CUDA=%s' % on_off('+examples-cuda'),
+ '-DEXAMPLES_ENABLE_RAJA=%s' % on_off('+examples-raja')
+ ])
else:
- cmake_args.append('-DPTHREAD_ENABLE=OFF')
+ args.extend([
+ '-DEXAMPLES_ENABLE=%s' % on_off('+examples-c'),
+ '-DCXX_ENABLE=%s' % on_off('+examples-cxx'),
+ '-DF90_ENABLE=%s' % on_off('+examples-f90')
+ ])
+
+ args.extend([
+ '-DEXAMPLES_INSTALL=%s' % on_off('+examples-install')
+ ])
+
+ return args
- with working_dir('build', create=True):
- cmake('..', *cmake_args)
+ # ==========================================================================
+ # Post Install Actions
+ # ==========================================================================
- make()
- make('install')
+ @run_after('install')
+ def post_install(self):
+ """Run after install to fix install name of dynamic libraries
+ on Darwin to have full path and install the LICENSE file."""
+ spec = self.spec
+ prefix = self.spec.prefix
- install('LICENSE', prefix)
+ if (sys.platform == 'darwin'):
+ fix_darwin_install_name(prefix.lib)
- self.filter_compilers()
+ if spec.satisfies('@:3.0.0'):
+ install('LICENSE', prefix)
+ @run_after('install')
def filter_compilers(self):
- """Run after install to tell the Makefiles to use
- the compilers that Spack built the package with.
+ """Run after install to tell the example program Makefiles
+ to use the compilers that Spack built the package with.
If this isn't done, they'll have CC, CPP, and F77 set to
Spack's generic cc and f77. We want them to be bound to
@@ -153,26 +378,101 @@ class Sundials(Package):
dirname = os.path.join(self.prefix, 'examples')
cc_files = [
- 'arkode/C_serial/Makefile', 'arkode/C_parallel/Makefile',
- 'cvode/serial/Makefile', 'cvode/parallel/Makefile',
- 'cvodes/serial/Makefile', 'cvodes/parallel/Makefile',
- 'ida/serial/Makefile', 'ida/parallel/Makefile',
- 'idas/serial/Makefile', 'idas/parallel/Makefile',
- 'kinsol/serial/Makefile', 'kinsol/parallel/Makefile',
- 'nvector/serial/Makefile', 'nvector/parallel/Makefile',
- 'nvector/pthreads/Makefile'
+ 'arkode/C_openmp/Makefile',
+ 'arkode/C_parallel/Makefile',
+ 'arkode/C_parhyp/Makefile',
+ 'arkode/C_serial/Makefile',
+ 'cvode/C_openmp/Makefile',
+ 'cvode/parallel/Makefile',
+ 'cvode/parhyp/Makefile',
+ 'cvode/serial/Makefile',
+ 'cvodes/C_openmp/Makefile',
+ 'cvodes/parallel/Makefile',
+ 'cvodes/serial/Makefile',
+ 'ida/C_openmp/Makefile',
+ 'ida/parallel/Makefile',
+ 'ida/petsc/Makefile',
+ 'ida/serial/Makefile',
+ 'idas/C_openmp/Makefile',
+ 'idas/parallel/Makefile',
+ 'idas/serial/Makefile',
+ 'kinsol/C_openmp/Makefile',
+ 'kinsol/parallel/Makefile',
+ 'kinsol/serial/Makefile',
+ 'nvector/C_openmp/Makefile',
+ 'nvector/parallel/Makefile',
+ 'nvector/parhyp/Makefile',
+ 'nvector/petsc/Makefile',
+ 'nvector/pthreads/Makefile',
+ 'nvector/serial/Makefile',
+ 'sunlinsol/band/Makefile',
+ 'sunlinsol/dense/Makefile',
+ 'sunlinsol/klu/Makefile',
+ 'sunlinsol/lapackband/Makefile',
+ 'sunlinsol/lapackdense/Makefile',
+ 'sunlinsol/pcg/parallel/Makefile',
+ 'sunlinsol/pcg/serial/Makefile',
+ 'sunlinsol/spbcgs/parallel/Makefile',
+ 'sunlinsol/spbcgs/serial/Makefile',
+ 'sunlinsol/spfgmr/parallel/Makefile',
+ 'sunlinsol/spfgmr/serial/Makefile',
+ 'sunlinsol/spgmr/parallel/Makefile',
+ 'sunlinsol/spgmr/serial/Makefile',
+ 'sunlinsol/sptfqmr/parallel/Makefile',
+ 'sunlinsol/sptfqmr/serial/Makefile',
+ 'sunlinsol/superlumt/Makefile',
+ 'sunmatrix/band/Makefile',
+ 'sunmatrix/dense/Makefile',
+ 'sunmatrix/sparse/Makefile'
+ ]
+
+ cxx_files = [
+ 'arkode/CXX_parallel/Makefile',
+ 'arkode/CXX_serial/Makefile'
+ 'cvode/cuda/Makefile',
+ 'cvode/raja/Makefile',
+ 'nvector/cuda/Makefile',
+ 'nvector/raja/Makefile'
]
f77_files = [
- 'arkode/F77_serial/Makefile', 'cvode/fcmix_serial/Makefile',
- 'ida/fcmix_serial/Makefile', 'ida/fcmix_pthreads/Makefile',
+ 'arkode/F77_parallel/Makefile',
+ 'arkode/F77_serial/Makefile',
+ 'cvode/fcmix_parallel/Makefile',
+ 'cvode/fcmix_serial/Makefile',
+ 'ida/fcmix_openmp/Makefile',
+ 'ida/fcmix_parallel/Makefile',
+ 'ida/fcmix_pthreads/Makefile',
+ 'ida/fcmix_serial/Makefile',
+ 'kinsol/fcmix_parallel/Makefile',
'kinsol/fcmix_serial/Makefile'
]
+ f90_files = [
+ 'arkode/F90_parallel/Makefile',
+ 'arkode/F90_serial/Makefile'
+ ]
+
for filename in cc_files:
filter_file(os.environ['CC'], self.compiler.cc,
os.path.join(dirname, filename), **kwargs)
+ for filename in cc_files:
+ filter_file(r'^CPP\s*=.*', self.compiler.cc,
+ os.path.join(dirname, filename), **kwargs)
+
+ for filename in cxx_files:
+ filter_file(os.environ['CXX'], self.compiler.cxx,
+ os.path.join(dirname, filename), **kwargs)
+
+ for filename in cxx_files:
+ filter_file(r'^CPP\s*=.*', self.compiler.cc,
+ os.path.join(dirname, filename), **kwargs)
+
for filename in f77_files:
filter_file(os.environ['F77'], self.compiler.f77,
os.path.join(dirname, filename), **kwargs)
+
+ for filename in f90_files:
+ filter_file(os.environ['FC'], self.compiler.fc,
+ os.path.join(dirname, filename), **kwargs)