xref: /petsc/config/BuildSystem/config/packages/MUMPS.py (revision 5fedec97950c19de564efaecd0f125b1a6cb2b20)
1import config.package
2
3class Configure(config.package.Package):
4  def __init__(self, framework):
5    config.package.Package.__init__(self, framework)
6    self.version          = '5.4.1'
7    self.minversion       = '5.2.1'
8    self.versionname      = 'MUMPS_VERSION'
9    self.requiresversion  = 1
10    self.gitcommit        = 'v'+self.version+'-p1'
11    self.download         = ['git://https://bitbucket.org/petsc/pkg-mumps.git',
12                             'https://bitbucket.org/petsc/pkg-mumps/get/'+self.gitcommit+'.tar.gz']
13    self.downloaddirnames = ['petsc-pkg-mumps','MUMPS']
14    self.liblist          = [['libcmumps.a','libdmumps.a','libsmumps.a','libzmumps.a','libmumps_common.a','libpord.a'],
15                            ['libcmumps.a','libdmumps.a','libsmumps.a','libzmumps.a','libmumps_common.a','libpord.a','libpthread.a'],
16                            ['libcmumps.a','libdmumps.a','libsmumps.a','libzmumps.a','libmumps_common.a','libpord.a','libmpiseq.a'],
17                            ['libcmumps.a','libdmumps.a','libsmumps.a','libzmumps.a','libmumps_common.a','libpord.a','libpthread.a','libmpiseq.a']]
18    self.functions        = ['dmumps_c']
19    self.includes         = ['dmumps_c.h']
20    #
21    self.buildLanguages   = ['C','FC']
22    self.precisions       = ['single','double']
23    self.downloadonWindows= 1
24    self.hastests         = 1
25    self.hastestsdatafiles= 1
26    return
27
28  def setupHelp(self, help):
29    import nargs
30    config.package.Package.setupHelp(self, help)
31    help.addArgument('MUMPS', '-with-mumps-serial', nargs.ArgBool(None, 0, 'Use serial build of MUMPS'))
32    return
33
34  def setupDependencies(self, framework):
35    config.package.Package.setupDependencies(self, framework)
36    self.flibs            = framework.require('config.packages.flibs',self)
37    self.blasLapack       = framework.require('config.packages.BlasLapack',self)
38    self.mpi              = framework.require('config.packages.MPI',self)
39    self.metis            = framework.require('config.packages.metis',self)
40    self.parmetis         = framework.require('config.packages.parmetis',self)
41    self.ptscotch         = framework.require('config.packages.PTScotch',self)
42    self.scalapack        = framework.require('config.packages.scalapack',self)
43    self.hwloc            = framework.require('config.packages.hwloc',self)
44    if self.argDB['with-mumps-serial']:
45      self.deps           = [self.blasLapack,self.flibs]
46      self.odeps          = [self.metis]
47    else:
48      self.deps           = [self.scalapack,self.mpi,self.blasLapack,self.flibs]
49      self.odeps          = [self.metis,self.parmetis,self.ptscotch,self.hwloc]
50    self.openmp           = framework.require('config.packages.openmp',self)
51    return
52
53  def configureLibrary(self):
54    for arg in ['with-64-bit-blas-indices','known-64-bit-blas-indices']:
55      if self.argDB.get(arg):
56        raise RuntimeError('MUMPS cannot be used with %s' % arg)
57    config.package.Package.configureLibrary(self)
58
59  def consistencyChecks(self):
60    config.package.Package.consistencyChecks(self)
61    if self.argDB['with-'+self.package] or self.argDB['download-'+self.package]:
62      if self.mpi.usingMPIUni and not self.argDB['with-mumps-serial']:
63        raise RuntimeError('Since you are building without MPI you must use --with-mumps-serial to install the correct MUMPS.')
64    if self.argDB['with-mumps-serial']:
65      if not self.mpi.usingMPIUni:
66        raise RuntimeError('Serial MUMPS version is only compatible with MPIUni\nReconfigure using --with-mpi=0')
67    return
68
69  def Install(self):
70    import os
71
72    if self.openmp.found:
73      #  MUMPS has no make flags for turning on/off OpenMP it just uses it if it can
74      self.usesopenmp = 'yes'
75      # use OMP_NUM_THREADS to control the number of threads used
76
77    if not self.fortran.FortranDefineCompilerOption:
78      raise RuntimeError('Fortran compiler cannot handle preprocessing directives from command line.')
79    g = open(os.path.join(self.packageDir,'Makefile.inc'),'w')
80    g.write('LPORDDIR   = $(topdir)/PORD/lib/\n')
81    g.write('IPORD      = -I$(topdir)/PORD/include/\n')
82    g.write('LPORD      = -L$(LPORDDIR) -lpord\n')
83    g.write('PLAT       = \n')
84    orderingsc = '-Dpord'
85    orderingsf = self.fortran.FortranDefineCompilerOption+'pord'
86    # Disable threads on BGL
87    if self.libraries.isBGL():
88      orderingsc += ' -DWITHOUT_PTHREAD'
89    if self.metis.found:
90      g.write('IMETIS = '+self.headers.toString(self.metis.include)+'\n')
91      g.write('LMETIS = '+self.libraries.toString(self.metis.lib)+'\n')
92      orderingsc += ' -Dmetis'
93      orderingsf += ' '+self.fortran.FortranDefineCompilerOption+'metis'
94    if self.parmetis.found:
95      g.write('IPARMETIS = '+self.headers.toString(self.parmetis.include)+'\n')
96      g.write('LPARMETIS = '+self.libraries.toString(self.parmetis.lib)+'\n')
97      orderingsc += ' -Dparmetis'
98      orderingsf += ' '+self.fortran.FortranDefineCompilerOption+'parmetis'
99    if self.ptscotch.found:
100      g.write('ISCOTCH = '+self.headers.toString(self.ptscotch.include)+'\n')
101      g.write('LSCOTCH = '+self.libraries.toString(self.ptscotch.lib)+'\n')
102      orderingsc += ' -Dscotch  -Dptscotch'
103      orderingsf += ' '+self.fortran.FortranDefineCompilerOption+'scotch '+self.fortran.FortranDefineCompilerOption+'ptscotch'
104
105    g.write('ORDERINGSC = '+orderingsc+'\n')
106    g.write('ORDERINGSF = '+orderingsf+'\n')
107    g.write('LORDERINGS  = $(LPARMETIS) $(LMETIS) $(LPORD) $(LSCOTCH)\n')
108    g.write('IORDERINGSC = $(IPARMETIS) $(IMETIS) $(IPORD) $(ISCOTCH)\n')
109    g.write('IORDERINGSF = $(ISCOTCH)\n')
110
111    g.write('RM = /bin/rm -f\n')
112    self.pushLanguage('C')
113    g.write('CC = '+self.getCompiler()+'\n')
114    g.write('OPTC    = '+self.updatePackageCFlags(self.getCompilerFlags())+'\n')
115    g.write('OUTC = -o \n')
116    self.popLanguage()
117    if not self.fortran.fortranIsF90:
118      raise RuntimeError('Installing MUMPS requires a F90 compiler')
119    self.pushLanguage('FC')
120    g.write('FC = '+self.getCompiler()+'\n')
121    g.write('FL = '+self.getCompiler()+'\n')
122    g.write('OPTF    = '+self.updatePackageFFlags(self.getCompilerFlags())+'\n')
123    if self.openmp.found:
124      g.write('OPTF   += -DBLR_MT\n')
125    if self.blasLapack.checkForRoutine('dgemmt'):
126      g.write('OPTF   += -DGEMMT_AVAILABLE\n')
127    g.write('OUTF = -o \n')
128    self.popLanguage()
129
130    # set fortran name mangling
131    # this mangling information is for both BLAS and the Fortran compiler so cannot use the BlasLapack mangling flag
132    if self.compilers.fortranManglingDoubleUnderscore:
133      g.write('CDEFS   = -DAdd__\n')
134    elif self.compilers.fortranMangling == 'underscore':
135      g.write('CDEFS   = -DAdd_\n')
136    elif self.compilers.fortranMangling == 'caps':
137      g.write('CDEFS   = -DUPPPER\n')
138
139    g.write('AR      = '+self.setCompilers.AR+' '+self.setCompilers.AR_FLAGS+' \n')
140    g.write('LIBEXT  = .'+self.setCompilers.AR_LIB_SUFFIX+'\n')
141    g.write('RANLIB  = '+self.setCompilers.RANLIB+'\n')
142    g.write('SCALAP  = '+self.libraries.toString(self.scalapack.lib)+'\n')
143    if not self.argDB['with-mumps-serial']:
144      g.write('INCPAR  = '+self.headers.toString(self.mpi.include)+'\n')
145      g.write('LIBPAR  = $(SCALAP) '+self.libraries.toString(self.mpi.lib)+'\n')
146    else:
147      g.write('INCPAR  = -I../libseq\n')
148    g.write('INCSEQ  = -I$(topdir)/libseq\n')
149    g.write('LIBSEQ  =  $(LAPACK) -L$(topdir)/libseq -lmpiseq\n')
150    g.write('LIBBLAS = '+self.libraries.toString(self.blasLapack.dlib)+'\n')
151    g.write('OPTL    = '+self.getLinkerFlags()+'\n')
152    g.write('INCS = $(INCPAR)\n')
153    g.write('LIBS = $(LIBPAR)\n')
154    if self.argDB['with-mumps-serial']:
155      g.write('LIBSEQNEEDED = libseqneeded\n')
156      g.write('LIBS = $(LIBSEQ)\n')
157    else:
158      g.write('LIBSEQNEEDED =\n')
159      if self.openmp.found and self.hwloc.found:
160        g.write('LIBS += '+self.libraries.toString(self.hwloc.lib)+'\n')
161        g.write('OPTF += -DUSE_LIBHWLOC\n')
162        g.write('OPTC += -DUSE_LIBHWLOC\n')
163    g.close()
164    if self.installNeeded('Makefile.inc'):
165      try:
166        output1,err1,ret1  = config.package.Package.executeShellCommand('make clean', cwd=self.packageDir, timeout=60, log = self.log)
167      except RuntimeError as e:
168        pass
169      try:
170        self.logPrintBox('Compiling Mumps; this may take several minutes')
171        output2,err2,ret2 = config.package.Package.executeShellCommand(self.make.make_jnp+' prerequisites', cwd=self.packageDir, timeout=2500, log = self.log)
172        output3,err3,ret3 = config.package.Package.executeShellCommand(self.make.make_jnp+' all', cwd=os.path.join(self.packageDir,'src'), timeout=2500, log = self.log)
173        libDir     = os.path.join(self.installDir, self.libdir)
174        includeDir = os.path.join(self.installDir, self.includedir)
175        self.logPrintBox('Installing Mumps; this may take several minutes')
176        output,err,ret = config.package.Package.executeShellCommandSeq(
177          ['mkdir -p '+libDir+' '+includeDir,
178           'cp -f lib/*.* '+libDir+'/.',
179           'cp -f include/*.* '+includeDir+'/.'
180          ], cwd=self.packageDir, timeout=60, log = self.log)
181        if self.argDB['with-mumps-serial']:
182          output,err,ret = config.package.Package.executeShellCommand(['cp', '-f', 'libseq/libmpiseq.a', libDir+'/.'], cwd=self.packageDir, timeout=60, log = self.log)
183      except RuntimeError as e:
184        self.logPrint('Error running make on MUMPS: '+str(e))
185        raise RuntimeError('Error running make on MUMPS')
186      self.postInstall(output1+err1+output2+err2+output3+err3,'Makefile.inc')
187    return self.installDir
188
189