text: # Copyright 2013-2020 Lawrence Livermore National Security, LLC and other
  # Spack Project Developers. See the top-level COPYRIGHT file for details.
  #
  # SPDX-License-Identifier: (Apache-2.0 OR MIT)
  
  
  import os
  import sys
  from spack import *
  
  
  class Petsc(Package):
      """PETSc is a suite of data structures and routines for the scalable
      (parallel) solution of scientific applications modeled by partial
      differential equations.
      """
  
      homepage = "http://www.mcs.anl.gov/petsc/index.html"
      url      = "http://ftp.mcs.anl.gov/pub/petsc/release-snapshots/petsc-3.5.3.tar.gz"
      git      = "https://gitlab.com/petsc/petsc.git"
  
      maintainers = ['balay', 'barrysmith', 'jedbrown']
  
      version('develop', branch='master')
      version('xsdk-0.2.0', tag='xsdk-0.2.0')
  
      version('3.12.4', sha256='56a941130da93bbacb3cfa74dcacea1e3cd8e36a0341f9ced09977b1457084c3')
      version('3.12.3', sha256='91f77d7b0f54056f085b9e27938922db3d9bb1734a2e2a6d26f43d3e6c0cf631')
      version('3.12.2', sha256='d874b2e198c4cb73551c2eca1d2c5d27da710be4d00517adb8f9eb3d6d0375e8')
      version('3.12.1', sha256='b72d895d0f4a79acb13ebc782b47b26d10d4e5706d399f533afcd5b3dba13737')
      version('3.12.0', sha256='ba9ecf69783c7ebf05bd1c91dd1d4b38bf09b7a2d5f9a774aa6bb46deff7cb14')
      version('3.11.4', sha256='319cb5a875a692a67fe5b1b90009ba8f182e21921ae645d38106544aff20c3c1')
      version('3.11.3', sha256='199ad9650a9f58603b49e7fff7cd003ceb03aa231e5d37d0bf0496c6348eca81')
      version('3.11.2', sha256='4d244dd7d1565d6534e776445fcf6977a6ee2a8bb2be4a36ac1e0fc1f9ad9cfa')
      version('3.11.1', sha256='cb627f99f7ce1540ebbbf338189f89a5f1ecf3ab3b5b0e357f9e46c209f1fb23')
      version('3.11.0', sha256='b3bed2a9263193c84138052a1b92d47299c3490dd24d1d0bf79fb884e71e678a')
      version('3.10.5', sha256='3a81c8406410e0ffa8a3e9f8efcdf2e683cc40613c9bb5cb378a6498f595803e')
      version('3.10.4', sha256='6c836df84caa9ae683ae401d3f94eb9471353156fec6db602bf2e857e4ec339f')
      version('3.10.3', sha256='cd106babbae091604fee40c258737c84dec048949be779eaef5a745df3dc8de4')
      version('3.10.2', sha256='9d3381bcf9c63abe6521b21a88efc70f8e893293503cff497971d0d9c1ec68cc')
      version('3.10.1', sha256='b6e64ce062113ee0e2e2a6cfffb4d33c085ec91d5bc3afeb33781074aa5a22a5')
      version('3.10.0', sha256='6ebacc010397ea47649495e8363cd7d7d86b876e6df07c6f6ccfa48b22fa555c')
      version('3.9.4', sha256='ecc647c9b1ef565a2c113936454c65632eedc1626e0fc99b5a36accb91195a63')
      version('3.9.3', sha256='6c7f2c7a28433385d74d647b4934aaeea3c1b3053b207973c9497639b6ebf7c8')
      version('3.9.2', sha256='ab396ae5dbfff808df1b5648f5ce30f3021ec70faec3d5cd63df324d416ac6ac')
      version('3.9.1', sha256='742e838a35d278693e956ed1ca4592c1d663451f6beea0694bf334aeb67681e8')
      version('3.9.0', sha256='dcbcab1f321667be1c6e5f8e7b4ee8670bb09e372e51f1ea6471464519d54b2d')
      version('3.8.4', sha256='9f78dc4dd4c58433fa18d3dd3a9029e39a83e4e4b64f845a029dd9fed44bc4c7')
      version('3.8.3', sha256='01f9c3ed937eafac6c9e006510b61c7cd07197115ec40c429fc835f346ca3eac')
      version('3.8.2', sha256='42690508d408e31fb98be738ac097bc869be14c5bfe08dda2184243283ceb16a')
      version('3.8.1', sha256='9b48a9e72d304046923667d2ab1f201778cc56242928a374ff9e074843a334ff')
      version('3.8.0', sha256='1e1b4d90ccbf98dc5759a956ac9a771310a6690f1cbb37b31502b29568262d7e')
      version('3.7.7', sha256='40fd3bc76998e056c4097704c08f28eb89bf3b93164dc9e69abab393f43bf6f0')
      version('3.7.6', sha256='3c8ee051349587d45baa7910c54ce8e0a571592e3b40f3054a7b7f986919d449')
      version('3.7.5', sha256='493ab0b6c1b3fe68e71d990eff87c84f499f680e6d2c0c394e78646a82ed4be3')
      version('3.7.4', sha256='54b804f924ea5be3b6718b4d4e98f8ccb9d1bd6bbbd1e9c0f18c4a90ddf5db18')
      version('3.7.2', sha256='36681dd0df97e0d5cd182d902e89f527eb8f441f05271159dac5340acb4cf0ec')
      version('3.6.4', sha256='eb09925a139b52b4dd5a071b3da4fe2165f1d6e8f71d410479603c9976c940f0')
      version('3.6.3', sha256='776e2644e4003653c56a44a6f7c02c41427af26f7c5cd9bec3aa84ed90223245')
      version('3.5.3', sha256='68e6a42f5ec75bad87f74d4df8f55ad63f0c4d996f162da6713cb3d6f566830d')
      version('3.5.2', sha256='1a8f09af654afab787c732e7b2f5d0c1d856777398148351565389d38d30935e')
      version('3.5.1', sha256='199af205f62dcc572728600670c7d4c8cb0d4efc4172c26f02b895d9dd1df245')
      version('3.4.4', sha256='fa73b99caf70c416a967234f5476cdb1d2c014610ee0619e48f54d8d309631b7')
  
      variant('shared',  default=True,
              description='Enables the build of shared libraries')
      variant('mpi',     default=True,  description='Activates MPI support')
      variant('double',  default=True,
              description='Switches between single and double precision')
      variant('complex', default=False, description='Build with complex numbers')
      variant('debug',   default=False, description='Compile in debug mode')
  
      variant('metis',   default=True,
              description='Activates support for metis and parmetis')
      variant('hdf5',    default=True,
              description='Activates support for HDF5 (only parallel)')
      variant('hypre',   default=True,
              description='Activates support for Hypre (only parallel)')
      # Mumps is disabled by default, because it depends on Scalapack
      # which is not portable to all HPC systems
      variant('mumps',   default=False,
              description='Activates support for MUMPS (only parallel'
              ' and 32bit indices)')
      variant('superlu-dist', default=True,
              description='Activates support for SuperluDist (only parallel)')
      variant('trilinos', default=False,
              description='Activates support for Trilinos (only parallel)')
      variant('int64', default=False,
              description='Compile with 64bit indices')
      variant('clanguage', default='C', values=('C', 'C++'),
              description='Specify C (recommended) or C++ to compile PETSc',
              multi=False)
      variant('fftw', default=False,
              description='Activates support for FFTW (only parallel)')
      variant('suite-sparse', default=False,
              description='Activates support for SuiteSparse')
      variant('knl', default=False,
              description='Build for KNL')
      variant('X', default=False,
              description='Activate X support')
      variant('batch', default=False,
              description='Enable when mpiexec is not available to run binaries')
      variant('valgrind', default=False,
              description='Enable Valgrind Client Request mechanism')
  
      # 3.8.0 has a build issue with MKL - so list this conflict explicitly
      conflicts('^intel-mkl', when='@3.8.0')
  
      filter_compiler_wrappers(
          'petscvariables', relative_root='lib/petsc/conf'
      )
  
      # temporary workaround Clang 8.1.0 with XCode 8.3 on macOS, see
      # https://bitbucket.org/petsc/petsc/commits/4f290403fdd060d09d5cb07345cbfd52670e3cbc
      # the patch is an adaptation of the original commit to 3.7.5
      if sys.platform == "darwin":
          patch('macos-clang-8.1.0.diff',
                when='@3.7.5%clang@8.1.0:')
      patch('pkg-config-3.7.6-3.8.4.diff', when='@3.7.6:3.8.4')
  
      patch('xcode_stub_out_of_sync.patch', when='@:3.10.4')
  
      patch('xlf_fix-dup-petscfecreate.patch', when='@3.11.0')
  
      # Virtual dependencies
      # Git repository needs sowing to build Fortran interface
      depends_on('sowing', when='@develop')
      depends_on('sowing@1.1.23-p1', when='@xsdk-0.2.0')
  
      # PETSc, hypre, superlu_dist when built with int64 use 32 bit integers
      # with BLAS/LAPACK
      depends_on('blas')
      depends_on('lapack')
      depends_on('mpi', when='+mpi')
  
      # Build dependencies
      depends_on('python@2.6:2.8', type='build', when='@:3.10.99')
      depends_on('python@2.6:2.8,3.4:', type='build', when='@3.11:')
  
      # Other dependencies
      depends_on('metis@5:~int64+real64', when='@:3.7.99+metis~int64+double')
      depends_on('metis@5:~int64', when='@:3.7.99+metis~int64~double')
      depends_on('metis@5:+int64+real64', when='@:3.7.99+metis+int64+double')
      depends_on('metis@5:+int64', when='@:3.7.99+metis+int64~double')
      # petsc-3.8+ uses default (float) metis with any (petsc) precision
      depends_on('metis@5:~int64', when='@3.8:+metis~int64')
      depends_on('metis@5:+int64', when='@3.8:+metis+int64')
  
      depends_on('hdf5@:1.10.99+mpi+hl+fortran', when='+hdf5+mpi')
      depends_on('zlib', when='+hdf5')
      depends_on('parmetis', when='+metis+mpi')
      depends_on('valgrind', when='+valgrind')
      # Hypre does not support complex numbers.
      # Also PETSc prefer to build it without internal superlu, likely due to
      # conflict in headers see
      # https://bitbucket.org/petsc/petsc/src/90564b43f6b05485163c147b464b5d6d28cde3ef/config/BuildSystem/config/packages/hypre.py
      depends_on('hypre@:2.13.99~internal-superlu~int64', when='@:3.8.99+hypre+mpi~complex~int64')
      depends_on('hypre@:2.13.99~internal-superlu+int64', when='@:3.8.99+hypre+mpi~complex+int64')
      depends_on('hypre@2.14:~internal-superlu~int64', when='@3.9:+hypre+mpi~complex~int64')
      depends_on('hypre@2.14:~internal-superlu+int64', when='@3.9+hypre+mpi~complex+int64')
      depends_on('hypre@xsdk-0.2.0~internal-superlu+int64', when='@xsdk-0.2.0+hypre+mpi~complex+int64')
      depends_on('hypre@xsdk-0.2.0~internal-superlu~int64', when='@xsdk-0.2.0+hypre+mpi~complex~int64')
      depends_on('hypre@develop~internal-superlu+int64', when='@develop+hypre+mpi~complex+int64')
      depends_on('hypre@develop~internal-superlu~int64', when='@develop+hypre+mpi~complex~int64')
      depends_on('superlu-dist@:4.3~int64', when='@3.4.4:3.6.4+superlu-dist+mpi~int64')
      depends_on('superlu-dist@:4.3+int64', when='@3.4.4:3.6.4+superlu-dist+mpi+int64')
      depends_on('superlu-dist@5.0.0:5.1.3~int64', when='@3.7:3.7.99+superlu-dist+mpi~int64')
      depends_on('superlu-dist@5.0.0:5.1.3+int64', when='@3.7:3.7.99+superlu-dist+mpi+int64')
      depends_on('superlu-dist@5.2:5.2.99~int64', when='@3.8:3.9.99+superlu-dist+mpi~int64')
      depends_on('superlu-dist@5.2:5.2.99+int64', when='@3.8:3.9.99+superlu-dist+mpi+int64')
      depends_on('superlu-dist@5.4:5.4.99~int64', when='@3.10:3.10.2+superlu-dist+mpi~int64')
      depends_on('superlu-dist@5.4:5.4.99+int64', when='@3.10:3.10.2+superlu-dist+mpi+int64')
      depends_on('superlu-dist@6.1:6.1.99~int64', when='@3.10.3:3.12.99+superlu-dist+mpi~int64')
      depends_on('superlu-dist@6.1:6.1.99+int64', when='@3.10.3:3.12.99+superlu-dist+mpi+int64')
      depends_on('superlu-dist@xsdk-0.2.0~int64', when='@xsdk-0.2.0+superlu-dist+mpi~int64')
      depends_on('superlu-dist@xsdk-0.2.0+int64', when='@xsdk-0.2.0+superlu-dist+mpi+int64')
      depends_on('superlu-dist@develop~int64', when='@develop+superlu-dist+mpi~int64')
      depends_on('superlu-dist@develop+int64', when='@develop+superlu-dist+mpi+int64')
      depends_on('mumps+mpi', when='+mumps+mpi~int64')
      depends_on('scalapack', when='+mumps+mpi~int64')
      depends_on('trilinos@12.6.2:', when='@3.7.0:+trilinos+mpi')
      depends_on('trilinos@xsdk-0.2.0', when='@xsdk-0.2.0+trilinos+mpi')
      depends_on('trilinos@develop', when='@xdevelop+trilinos+mpi')
      depends_on('fftw+mpi', when='+fftw+mpi')
      depends_on('suite-sparse', when='+suite-sparse')
      depends_on('libx11', when='+X')
  
      def mpi_dependent_options(self):
          if '~mpi' in self.spec:
              compiler_opts = [
                  '--with-cc=%s' % os.environ['CC'],
                  '--with-cxx=%s' % (os.environ['CXX']
                                     if self.compiler.cxx is not None else '0'),
                  '--with-fc=%s' % (os.environ['FC']
                                    if self.compiler.fc is not None else '0'),
                  '--with-mpi=0'
              ]
              error_message_fmt = \
                  '\t{library} support requires "+mpi" to be activated'
  
              # If mpi is disabled (~mpi), it's an error to have any of these
              # enabled. This generates a list of any such errors.
              errors = [
                  error_message_fmt.format(library=x)
                  for x in ('hdf5', 'hypre', 'parmetis', 'mumps', 'superlu-dist')
                  if ('+' + x) in self.spec]
              if errors:
                  errors = ['incompatible variants given'] + errors
                  raise RuntimeError('\n'.join(errors))
          else:
              compiler_opts = [
                  '--with-cc=%s' % self.spec['mpi'].mpicc,
                  '--with-cxx=%s' % self.spec['mpi'].mpicxx,
                  '--with-fc=%s' % self.spec['mpi'].mpifc,
              ]
              if self.spec.satisfies('%intel'):
                  # mpiifort needs some help to automatically link
                  # all necessary run-time libraries
                  compiler_opts.append('--FC_LINKER_FLAGS=-lintlc')
          return compiler_opts
  
      def install(self, spec, prefix):
          options = ['--with-ssl=0',
                     '--download-c2html=0',
                     '--download-sowing=0',
                     '--download-hwloc=0',
                     'CFLAGS=%s' % ' '.join(spec.compiler_flags['cflags']),
                     'FFLAGS=%s' % ' '.join(spec.compiler_flags['fflags']),
                     'CXXFLAGS=%s' % ' '.join(spec.compiler_flags['cxxflags'])]
          options.extend(self.mpi_dependent_options())
          options.extend([
              '--with-precision=%s' % (
                  'double' if '+double' in spec else 'single'),
              '--with-scalar-type=%s' % (
                  'complex' if '+complex' in spec else 'real'),
              '--with-shared-libraries=%s' % ('1' if '+shared' in spec else '0'),
              '--with-debugging=%s' % ('1' if '+debug' in spec else '0'),
              '--with-64-bit-indices=%s' % ('1' if '+int64' in spec else '0')
          ])
          if '+debug' not in spec:
              options.extend(['COPTFLAGS=',
                              'FOPTFLAGS=',
                              'CXXOPTFLAGS='])
  
          # Make sure we use exactly the same Blas/Lapack libraries
          # across the DAG. To that end list them explicitly
          lapack_blas = spec['lapack'].libs + spec['blas'].libs
          options.extend([
              '--with-blas-lapack-lib=%s' % lapack_blas.joined()
          ])
  
          if '+batch' in spec:
              options.append('--with-batch=1')
          if '+knl' in spec:
              options.append('--with-avx-512-kernels')
              options.append('--with-memalign=64')
          if '+X' in spec:
              options.append('--with-x=1')
          else:
              options.append('--with-x=0')
  
          if 'trilinos' in spec:
              options.append('--with-cxx-dialect=C++11')
              if spec.satisfies('^trilinos+boost'):
                  options.append('--with-boost=1')
  
          if self.spec.satisfies('clanguage=C++'):
              options.append('--with-clanguage=C++')
          else:
              options.append('--with-clanguage=C')
  
          # PETSc depends on scalapack when '+mumps+mpi~int64' (see depends())
          # help PETSc pick up Scalapack from MKL
          if spec.satisfies('+mumps+mpi~int64'):
              scalapack = spec['scalapack'].libs
              options.extend([
                  '--with-scalapack-lib=%s' % scalapack.joined(),
                  '--with-scalapack=1'
              ])
          else:
              options.extend([
                  '--with-scalapack=0'
              ])
  
          # Activates library support if needed
          for library in ('metis', 'hdf5', 'hypre', 'parmetis',
                          'mumps', 'trilinos', 'fftw', 'valgrind'):
              options.append(
                  '--with-{library}={value}'.format(
                      library=library, value=('1' if library in spec else '0'))
              )
              if library in spec:
                  options.append(
                      '--with-{library}-dir={path}'.format(
                          library=library, path=spec[library].prefix)
                  )
          # PETSc does not pick up SuperluDist from the dir as they look for
          # superlu_dist_4.1.a
          if 'superlu-dist' in spec:
              if spec.satisfies('@3.10.3:'):
                  options.append('--with-cxx-dialect=C++11')
              options.extend([
                  '--with-superlu_dist-include=%s' %
                  spec['superlu-dist'].prefix.include,
                  '--with-superlu_dist-lib=%s' %
                  join_path(spec['superlu-dist'].prefix.lib,
                            'libsuperlu_dist.a'),
                  '--with-superlu_dist=1'
              ])
          else:
              options.append(
                  '--with-superlu_dist=0'
              )
          # SuiteSparse: configuring using '--with-suitesparse-dir=...' has some
          # issues, so specify directly the include path and the libraries.
          if '+suite-sparse' in spec:
              ss_spec = 'suite-sparse:umfpack,klu,cholmod,btf,ccolamd,colamd,' \
                  'camd,amd,suitesparseconfig'
              options.extend([
                  '--with-suitesparse-include=%s' % spec[ss_spec].prefix.include,
                  '--with-suitesparse-lib=%s' % spec[ss_spec].libs.joined(),
                  '--with-suitesparse=1'
              ])
          else:
              options.append('--with-suitesparse=0')
  
          # zlib: configuring using '--with-zlib-dir=...' has some issues with
          # SuiteSparse so specify directly the include path and the libraries.
          if 'zlib' in spec:
              options.extend([
                  '--with-zlib-include=%s' % spec['zlib'].prefix.include,
                  '--with-zlib-lib=%s'     % spec['zlib'].libs.joined(),
                  '--with-zlib=1'
              ])
          else:
              options.append('--with-zlib=0')
  
          python('configure', '--prefix=%s' % prefix, *options)
  
          # PETSc has its own way of doing parallel make.
          make('MAKE_NP=%s' % make_jobs, parallel=False)
          make("install")
  
          # solve Poisson equation in 2D to make sure nothing is broken:
          if ('mpi' in spec) and self.run_tests:
              with working_dir('src/ksp/ksp/examples/tutorials'):
                  env['PETSC_DIR'] = self.prefix
                  cc = Executable(spec['mpi'].mpicc)
                  cc('ex50.c', '-I%s' % prefix.include, '-L%s' % prefix.lib,
                     '-lpetsc', '-lm', '-o', 'ex50')
                  run = Executable(join_path(spec['mpi'].prefix.bin, 'mpirun'))
                  # For Spectrum MPI, if -np is omitted, the default behavior is
                  # to assign one process per process slot, where the default
                  # process slot allocation is one per core. On systems with
                  # many cores, the number of processes can exceed the size of
                  # the grid specified when the testcase is run and the test case
                  # fails. Specify a small number of processes to prevent
                  # failure.
                  # For more information about Spectrum MPI invocation, see URL
                  # https://www.ibm.com/support/knowledgecenter/en/SSZTET_10.1.0/smpi02/smpi02_mpirun_options.html
                  if ('spectrum-mpi' in spec):
                      run.add_default_arg('-np')
                      run.add_default_arg('4')
                  run('ex50', '-da_grid_x', '4', '-da_grid_y', '4')
                  if 'superlu-dist' in spec:
                      run('ex50',
                          '-da_grid_x', '4',
                          '-da_grid_y', '4',
                          '-pc_type', 'lu',
                          '-pc_factor_mat_solver_package', 'superlu_dist')
  
                  if 'mumps' in spec:
                      run('ex50',
                          '-da_grid_x', '4',
                          '-da_grid_y', '4',
                          '-pc_type', 'lu',
                          '-pc_factor_mat_solver_package', 'mumps')
  
                  if 'hypre' in spec:
                      run('ex50',
                          '-da_grid_x', '4',
                          '-da_grid_y', '4',
                          '-pc_type', 'hypre',
                          '-pc_hypre_type', 'boomeramg')
  
      def setup_build_environment(self, env):
          # configure fails if these env vars are set outside of Spack
          env.unset('PETSC_DIR')
          env.unset('PETSC_ARCH')
  
      def setup_run_environment(self, env):
          # Set PETSC_DIR in the module file
          env.set('PETSC_DIR', self.prefix)
          env.unset('PETSC_ARCH')
  
      def setup_dependent_build_environment(self, env, dependent_spec):
          # Set up PETSC_DIR for everyone using PETSc package
          env.set('PETSC_DIR', self.prefix)
          env.unset('PETSC_ARCH')
  
      @property
      def headers(self):
          return find_headers('petsc', self.prefix.include, recursive=False) \
              or None  # return None to indicate failure
  
      # For the 'libs' property - use the default handler.
  