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