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