xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision 26cc229b24afffee8e9a203ddc8754b40d660fc7)
11c2a3de1SBarry Smith 
2397b6df1SKris Buschelman /*
3c2b5dc30SHong Zhang     Provides an interface to the MUMPS sparse solver
4397b6df1SKris Buschelman */
567602552SJunchao Zhang #include <petscpkg_version.h>
6c6db04a5SJed Brown #include <../src/mat/impls/aij/mpi/mpiaij.h> /*I  "petscmat.h"  I*/
7c6db04a5SJed Brown #include <../src/mat/impls/sbaij/mpi/mpisbaij.h>
87ee00b23SStefano Zampini #include <../src/mat/impls/sell/mpi/mpisell.h>
9397b6df1SKris Buschelman 
10397b6df1SKris Buschelman EXTERN_C_BEGIN
11397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
122907cef9SHong Zhang #if defined(PETSC_USE_REAL_SINGLE)
132907cef9SHong Zhang #include <cmumps_c.h>
142907cef9SHong Zhang #else
15c6db04a5SJed Brown #include <zmumps_c.h>
162907cef9SHong Zhang #endif
172907cef9SHong Zhang #else
182907cef9SHong Zhang #if defined(PETSC_USE_REAL_SINGLE)
192907cef9SHong Zhang #include <smumps_c.h>
20397b6df1SKris Buschelman #else
21c6db04a5SJed Brown #include <dmumps_c.h>
22397b6df1SKris Buschelman #endif
232907cef9SHong Zhang #endif
24397b6df1SKris Buschelman EXTERN_C_END
25397b6df1SKris Buschelman #define JOB_INIT -1
263d472b54SHong Zhang #define JOB_FACTSYMBOLIC 1
273d472b54SHong Zhang #define JOB_FACTNUMERIC 2
283d472b54SHong Zhang #define JOB_SOLVE 3
29397b6df1SKris Buschelman #define JOB_END -2
303d472b54SHong Zhang 
312907cef9SHong Zhang /* calls to MUMPS */
322907cef9SHong Zhang #if defined(PETSC_USE_COMPLEX)
332907cef9SHong Zhang #if defined(PETSC_USE_REAL_SINGLE)
343ab56b82SJunchao Zhang #define MUMPS_c cmumps_c
352907cef9SHong Zhang #else
363ab56b82SJunchao Zhang #define MUMPS_c zmumps_c
372907cef9SHong Zhang #endif
382907cef9SHong Zhang #else
392907cef9SHong Zhang #if defined(PETSC_USE_REAL_SINGLE)
403ab56b82SJunchao Zhang #define MUMPS_c smumps_c
412907cef9SHong Zhang #else
423ab56b82SJunchao Zhang #define MUMPS_c dmumps_c
432907cef9SHong Zhang #endif
442907cef9SHong Zhang #endif
452907cef9SHong Zhang 
46a6053eceSJunchao Zhang /* MUMPS uses MUMPS_INT for nonzero indices such as irn/jcn, irn_loc/jcn_loc and uses int64_t for
47a6053eceSJunchao Zhang    number of nonzeros such as nnz, nnz_loc. We typedef MUMPS_INT to PetscMUMPSInt to follow the
48a6053eceSJunchao Zhang    naming convention in PetscMPIInt, PetscBLASInt etc.
49a6053eceSJunchao Zhang */
50a6053eceSJunchao Zhang typedef MUMPS_INT PetscMUMPSInt;
51a6053eceSJunchao Zhang 
5267602552SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5,3,0)
5367602552SJunchao Zhang   #if defined(MUMPS_INTSIZE64) /* MUMPS_INTSIZE64 is in MUMPS headers if it is built in full 64-bit mode, therefore the macro is more reliable */
54a6053eceSJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
5567602552SJunchao Zhang   #endif
56a6053eceSJunchao Zhang #else
5767602552SJunchao Zhang   #if defined(INTSIZE64) /* INTSIZE64 is a command line macro one used to build MUMPS in full 64-bit mode */
5867602552SJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
5967602552SJunchao Zhang   #endif
6067602552SJunchao Zhang #endif
6167602552SJunchao Zhang 
62a6053eceSJunchao Zhang #define MPIU_MUMPSINT             MPI_INT
63a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MAX       2147483647
64a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MIN       -2147483648
65a6053eceSJunchao Zhang 
66a6053eceSJunchao Zhang /* Cast PetscInt to PetscMUMPSInt. Usually there is no overflow since <a> is row/col indices or some small integers*/
679fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscMUMPSIntCast(PetscInt a,PetscMUMPSInt *b)
68a6053eceSJunchao Zhang {
69a6053eceSJunchao Zhang   PetscFunctionBegin;
70ece88022SPierre Jolivet #if PetscDefined(USE_64BIT_INDICES)
712c71b3e2SJacob Faibussowitsch   PetscAssert(a <= PETSC_MUMPS_INT_MAX && a >= PETSC_MUMPS_INT_MIN,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"PetscInt too long for PetscMUMPSInt");
72ece88022SPierre Jolivet #endif
73a6053eceSJunchao Zhang   *b = (PetscMUMPSInt)(a);
74a6053eceSJunchao Zhang   PetscFunctionReturn(0);
75a6053eceSJunchao Zhang }
76a6053eceSJunchao Zhang 
77a6053eceSJunchao Zhang /* Put these utility routines here since they are only used in this file */
789fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscOptionsMUMPSInt_Private(PetscOptionItems *PetscOptionsObject,const char opt[],const char text[],const char man[],PetscMUMPSInt currentvalue,PetscMUMPSInt *value,PetscBool *set,PetscMUMPSInt lb,PetscMUMPSInt ub)
79a6053eceSJunchao Zhang {
80a6053eceSJunchao Zhang   PetscInt       myval;
81a6053eceSJunchao Zhang   PetscBool      myset;
82a6053eceSJunchao Zhang   PetscFunctionBegin;
83a6053eceSJunchao Zhang   /* PetscInt's size should be always >= PetscMUMPSInt's. It is safe to call PetscOptionsInt_Private to read a PetscMUMPSInt */
849566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt_Private(PetscOptionsObject,opt,text,man,(PetscInt)currentvalue,&myval,&myset,lb,ub));
859566063dSJacob Faibussowitsch   if (myset) PetscCall(PetscMUMPSIntCast(myval,value));
86a6053eceSJunchao Zhang   if (set) *set = myset;
87a6053eceSJunchao Zhang   PetscFunctionReturn(0);
88a6053eceSJunchao Zhang }
89a6053eceSJunchao Zhang #define PetscOptionsMUMPSInt(a,b,c,d,e,f) PetscOptionsMUMPSInt_Private(PetscOptionsObject,a,b,c,d,e,f,PETSC_MUMPS_INT_MIN,PETSC_MUMPS_INT_MAX)
90a6053eceSJunchao Zhang 
91217d3b1eSJunchao Zhang /* if using PETSc OpenMP support, we only call MUMPS on master ranks. Before/after the call, we change/restore CPUs the master ranks can run on */
923ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
933ab56b82SJunchao Zhang #define PetscMUMPS_c(mumps) \
943ab56b82SJunchao Zhang   do { \
953ab56b82SJunchao Zhang     if (mumps->use_petsc_omp_support) { \
963ab56b82SJunchao Zhang       if (mumps->is_omp_master) { \
979566063dSJacob Faibussowitsch         PetscCall(PetscOmpCtrlOmpRegionOnMasterBegin(mumps->omp_ctrl)); \
983ab56b82SJunchao Zhang         MUMPS_c(&mumps->id); \
999566063dSJacob Faibussowitsch         PetscCall(PetscOmpCtrlOmpRegionOnMasterEnd(mumps->omp_ctrl)); \
1003ab56b82SJunchao Zhang       } \
1019566063dSJacob Faibussowitsch       PetscCall(PetscOmpCtrlBarrier(mumps->omp_ctrl)); \
102c3714a1dSJunchao Zhang       /* Global info is same on all processes so we Bcast it within omp_comm. Local info is specific      \
103c3714a1dSJunchao Zhang          to processes, so we only Bcast info[1], an error code and leave others (since they do not have   \
104c3714a1dSJunchao Zhang          an easy translation between omp_comm and petsc_comm). See MUMPS-5.1.2 manual p82.                   \
105c3714a1dSJunchao Zhang          omp_comm is a small shared memory communicator, hence doing multiple Bcast as shown below is OK. \
106c3714a1dSJunchao Zhang       */ \
1079566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Bcast(mumps->id.infog, 40,MPIU_MUMPSINT, 0,mumps->omp_comm));\
1089566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Bcast(mumps->id.rinfog,20,MPIU_REAL,     0,mumps->omp_comm));\
1099566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Bcast(mumps->id.info,  1, MPIU_MUMPSINT, 0,mumps->omp_comm));\
1103ab56b82SJunchao Zhang     } else { \
1113ab56b82SJunchao Zhang       MUMPS_c(&mumps->id); \
1123ab56b82SJunchao Zhang     } \
1133ab56b82SJunchao Zhang   } while (0)
1143ab56b82SJunchao Zhang #else
1153ab56b82SJunchao Zhang #define PetscMUMPS_c(mumps) \
1163ab56b82SJunchao Zhang   do { MUMPS_c(&mumps->id); } while (0)
1173ab56b82SJunchao Zhang #endif
1183ab56b82SJunchao Zhang 
119940cd9d6SSatish Balay /* declare MumpsScalar */
120940cd9d6SSatish Balay #if defined(PETSC_USE_COMPLEX)
121940cd9d6SSatish Balay #if defined(PETSC_USE_REAL_SINGLE)
122940cd9d6SSatish Balay #define MumpsScalar mumps_complex
123940cd9d6SSatish Balay #else
124940cd9d6SSatish Balay #define MumpsScalar mumps_double_complex
125940cd9d6SSatish Balay #endif
126940cd9d6SSatish Balay #else
127940cd9d6SSatish Balay #define MumpsScalar PetscScalar
128940cd9d6SSatish Balay #endif
1293d472b54SHong Zhang 
130397b6df1SKris Buschelman /* macros s.t. indices match MUMPS documentation */
131397b6df1SKris Buschelman #define ICNTL(I) icntl[(I)-1]
132397b6df1SKris Buschelman #define CNTL(I) cntl[(I)-1]
133397b6df1SKris Buschelman #define INFOG(I) infog[(I)-1]
134a7aca84bSHong Zhang #define INFO(I) info[(I)-1]
135397b6df1SKris Buschelman #define RINFOG(I) rinfog[(I)-1]
136adc1d99fSHong Zhang #define RINFO(I) rinfo[(I)-1]
137397b6df1SKris Buschelman 
138a6053eceSJunchao Zhang typedef struct Mat_MUMPS Mat_MUMPS;
139a6053eceSJunchao Zhang struct Mat_MUMPS {
140397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
1412907cef9SHong Zhang #if defined(PETSC_USE_REAL_SINGLE)
1422907cef9SHong Zhang   CMUMPS_STRUC_C id;
1432907cef9SHong Zhang #else
144397b6df1SKris Buschelman   ZMUMPS_STRUC_C id;
1452907cef9SHong Zhang #endif
1462907cef9SHong Zhang #else
1472907cef9SHong Zhang #if defined(PETSC_USE_REAL_SINGLE)
1482907cef9SHong Zhang   SMUMPS_STRUC_C id;
149397b6df1SKris Buschelman #else
150397b6df1SKris Buschelman   DMUMPS_STRUC_C id;
151397b6df1SKris Buschelman #endif
1522907cef9SHong Zhang #endif
1532907cef9SHong Zhang 
154397b6df1SKris Buschelman   MatStructure   matstruc;
1552d4298aeSJunchao Zhang   PetscMPIInt    myid,petsc_size;
156a6053eceSJunchao Zhang   PetscMUMPSInt  *irn,*jcn;             /* the (i,j,v) triplets passed to mumps. */
157a6053eceSJunchao Zhang   PetscScalar    *val,*val_alloc;       /* For some matrices, we can directly access their data array without a buffer. For others, we need a buffer. So comes val_alloc. */
158a6053eceSJunchao Zhang   PetscInt64     nnz;                   /* number of nonzeros. The type is called selective 64-bit in mumps */
159a6053eceSJunchao Zhang   PetscMUMPSInt  sym;
1602d4298aeSJunchao Zhang   MPI_Comm       mumps_comm;
161a6053eceSJunchao Zhang   PetscMUMPSInt  ICNTL9_pre;            /* check if ICNTL(9) is changed from previous MatSolve */
162801fbe65SHong Zhang   VecScatter     scat_rhs, scat_sol;    /* used by MatSolve() */
16325aac85cSJunchao Zhang   PetscMUMPSInt  ICNTL20;               /* use centralized (0) or distributed (10) dense RHS */
16467602552SJunchao Zhang   PetscMUMPSInt  lrhs_loc,nloc_rhs,*irhs_loc;
16567602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
16667602552SJunchao Zhang   PetscInt       *rhs_nrow,max_nrhs;
16767602552SJunchao Zhang   PetscMPIInt    *rhs_recvcounts,*rhs_disps;
16867602552SJunchao Zhang   PetscScalar    *rhs_loc,*rhs_recvbuf;
16967602552SJunchao Zhang #endif
170801fbe65SHong Zhang   Vec            b_seq,x_seq;
171a6053eceSJunchao Zhang   PetscInt       ninfo,*info;           /* which INFO to display */
172b5fa320bSStefano Zampini   PetscInt       sizeredrhs;
17359ac8732SStefano Zampini   PetscScalar    *schur_sol;
17459ac8732SStefano Zampini   PetscInt       schur_sizesol;
175a6053eceSJunchao Zhang   PetscMUMPSInt  *ia_alloc,*ja_alloc;   /* work arrays used for the CSR struct for sparse rhs */
176a6053eceSJunchao Zhang   PetscInt64     cur_ilen,cur_jlen;     /* current len of ia_alloc[], ja_alloc[] */
177a6053eceSJunchao Zhang   PetscErrorCode (*ConvertToTriples)(Mat,PetscInt,MatReuse,Mat_MUMPS*);
1782205254eSKarl Rupp 
179a6053eceSJunchao Zhang   /* stuff used by petsc/mumps OpenMP support*/
1803ab56b82SJunchao Zhang   PetscBool      use_petsc_omp_support;
1813ab56b82SJunchao Zhang   PetscOmpCtrl   omp_ctrl;              /* an OpenMP controler that blocked processes will release their CPU (MPI_Barrier does not have this guarantee) */
1823ab56b82SJunchao Zhang   MPI_Comm       petsc_comm,omp_comm;   /* petsc_comm is petsc matrix's comm */
183a6053eceSJunchao Zhang   PetscInt64     *recvcount;            /* a collection of nnz on omp_master */
184a6053eceSJunchao Zhang   PetscMPIInt    tag,omp_comm_size;
1853ab56b82SJunchao Zhang   PetscBool      is_omp_master;         /* is this rank the master of omp_comm */
186a6053eceSJunchao Zhang   MPI_Request    *reqs;
187a6053eceSJunchao Zhang };
1883ab56b82SJunchao Zhang 
189a6053eceSJunchao Zhang /* Cast a 1-based CSR represented by (nrow, ia, ja) of type PetscInt to a CSR of type PetscMUMPSInt.
190a6053eceSJunchao Zhang    Here, nrow is number of rows, ia[] is row pointer and ja[] is column indices.
191a6053eceSJunchao Zhang  */
192a6053eceSJunchao Zhang static PetscErrorCode PetscMUMPSIntCSRCast(Mat_MUMPS *mumps,PetscInt nrow,PetscInt *ia,PetscInt *ja,PetscMUMPSInt **ia_mumps,PetscMUMPSInt **ja_mumps,PetscMUMPSInt *nnz_mumps)
193a6053eceSJunchao Zhang {
194a6053eceSJunchao Zhang   PetscInt       nnz=ia[nrow]-1; /* mumps uses 1-based indices. Uses PetscInt instead of PetscInt64 since mumps only uses PetscMUMPSInt for rhs */
195f0c56d0fSKris Buschelman 
196a6053eceSJunchao Zhang   PetscFunctionBegin;
197a6053eceSJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES)
198a6053eceSJunchao Zhang   {
199a6053eceSJunchao Zhang     PetscInt i;
200a6053eceSJunchao Zhang     if (nrow+1 > mumps->cur_ilen) { /* realloc ia_alloc/ja_alloc to fit ia/ja */
2019566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ia_alloc));
2029566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrow+1,&mumps->ia_alloc));
203a6053eceSJunchao Zhang       mumps->cur_ilen = nrow+1;
204a6053eceSJunchao Zhang     }
205a6053eceSJunchao Zhang     if (nnz > mumps->cur_jlen) {
2069566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ja_alloc));
2079566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nnz,&mumps->ja_alloc));
208a6053eceSJunchao Zhang       mumps->cur_jlen = nnz;
209a6053eceSJunchao Zhang     }
2109566063dSJacob Faibussowitsch     for (i=0; i<nrow+1; i++) PetscCall(PetscMUMPSIntCast(ia[i],&(mumps->ia_alloc[i])));
2119566063dSJacob Faibussowitsch     for (i=0; i<nnz; i++)    PetscCall(PetscMUMPSIntCast(ja[i],&(mumps->ja_alloc[i])));
212a6053eceSJunchao Zhang     *ia_mumps = mumps->ia_alloc;
213a6053eceSJunchao Zhang     *ja_mumps = mumps->ja_alloc;
214a6053eceSJunchao Zhang   }
215a6053eceSJunchao Zhang #else
216a6053eceSJunchao Zhang   *ia_mumps = ia;
217a6053eceSJunchao Zhang   *ja_mumps = ja;
218a6053eceSJunchao Zhang #endif
2199566063dSJacob Faibussowitsch   PetscCall(PetscMUMPSIntCast(nnz,nnz_mumps));
220a6053eceSJunchao Zhang   PetscFunctionReturn(0);
221a6053eceSJunchao Zhang }
222b24902e0SBarry Smith 
22359ac8732SStefano Zampini static PetscErrorCode MatMumpsResetSchur_Private(Mat_MUMPS* mumps)
224b5fa320bSStefano Zampini {
225b5fa320bSStefano Zampini   PetscFunctionBegin;
2269566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
2279566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.redrhs));
2289566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->schur_sol));
22959ac8732SStefano Zampini   mumps->id.size_schur = 0;
230b3cb21ddSStefano Zampini   mumps->id.schur_lld  = 0;
23159ac8732SStefano Zampini   mumps->id.ICNTL(19)  = 0;
23259ac8732SStefano Zampini   PetscFunctionReturn(0);
23359ac8732SStefano Zampini }
23459ac8732SStefano Zampini 
235b3cb21ddSStefano Zampini /* solve with rhs in mumps->id.redrhs and return in the same location */
236b3cb21ddSStefano Zampini static PetscErrorCode MatMumpsSolveSchur_Private(Mat F)
23759ac8732SStefano Zampini {
238b3cb21ddSStefano Zampini   Mat_MUMPS            *mumps=(Mat_MUMPS*)F->data;
239b3cb21ddSStefano Zampini   Mat                  S,B,X;
240b3cb21ddSStefano Zampini   MatFactorSchurStatus schurstatus;
241b3cb21ddSStefano Zampini   PetscInt             sizesol;
24259ac8732SStefano Zampini 
24359ac8732SStefano Zampini   PetscFunctionBegin;
2449566063dSJacob Faibussowitsch   PetscCall(MatFactorFactorizeSchurComplement(F));
2459566063dSJacob Faibussowitsch   PetscCall(MatFactorGetSchurComplement(F,&S,&schurstatus));
2469566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF,mumps->id.size_schur,mumps->id.nrhs,(PetscScalar*)mumps->id.redrhs,&B));
2479566063dSJacob Faibussowitsch   PetscCall(MatSetType(B,((PetscObject)S)->type_name));
248a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2499566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(B,S->boundtocpu));
250a3d589ffSStefano Zampini #endif
251b3cb21ddSStefano Zampini   switch (schurstatus) {
252b3cb21ddSStefano Zampini   case MAT_FACTOR_SCHUR_FACTORED:
2539566063dSJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF,mumps->id.size_schur,mumps->id.nrhs,(PetscScalar*)mumps->id.redrhs,&X));
2549566063dSJacob Faibussowitsch     PetscCall(MatSetType(X,((PetscObject)S)->type_name));
255a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2569566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X,S->boundtocpu));
257a3d589ffSStefano Zampini #endif
258b3cb21ddSStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2599566063dSJacob Faibussowitsch       PetscCall(MatMatSolveTranspose(S,B,X));
26059ac8732SStefano Zampini     } else {
2619566063dSJacob Faibussowitsch       PetscCall(MatMatSolve(S,B,X));
26259ac8732SStefano Zampini     }
263b3cb21ddSStefano Zampini     break;
264b3cb21ddSStefano Zampini   case MAT_FACTOR_SCHUR_INVERTED:
265b3cb21ddSStefano Zampini     sizesol = mumps->id.nrhs*mumps->id.size_schur;
26659ac8732SStefano Zampini     if (!mumps->schur_sol || sizesol > mumps->schur_sizesol) {
2679566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->schur_sol));
2689566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(sizesol,&mumps->schur_sol));
26959ac8732SStefano Zampini       mumps->schur_sizesol = sizesol;
270b5fa320bSStefano Zampini     }
2719566063dSJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF,mumps->id.size_schur,mumps->id.nrhs,mumps->schur_sol,&X));
2729566063dSJacob Faibussowitsch     PetscCall(MatSetType(X,((PetscObject)S)->type_name));
273a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2749566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X,S->boundtocpu));
275a3d589ffSStefano Zampini #endif
2769566063dSJacob Faibussowitsch     PetscCall(MatProductCreateWithMat(S,B,NULL,X));
27759ac8732SStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2789566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X,MATPRODUCT_AtB));
279b5fa320bSStefano Zampini     } else {
2809566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X,MATPRODUCT_AB));
281b5fa320bSStefano Zampini     }
2829566063dSJacob Faibussowitsch     PetscCall(MatProductSetFromOptions(X));
2839566063dSJacob Faibussowitsch     PetscCall(MatProductSymbolic(X));
2849566063dSJacob Faibussowitsch     PetscCall(MatProductNumeric(X));
2854417c5e8SHong Zhang 
2869566063dSJacob Faibussowitsch     PetscCall(MatCopy(X,B,SAME_NONZERO_PATTERN));
287b3cb21ddSStefano Zampini     break;
288b3cb21ddSStefano Zampini   default:
28998921bdaSJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)F),PETSC_ERR_SUP,"Unhandled MatFactorSchurStatus %d",F->schur_status);
29059ac8732SStefano Zampini   }
2919566063dSJacob Faibussowitsch   PetscCall(MatFactorRestoreSchurComplement(F,&S,schurstatus));
2929566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
2939566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&X));
294b5fa320bSStefano Zampini   PetscFunctionReturn(0);
295b5fa320bSStefano Zampini }
296b5fa320bSStefano Zampini 
297b3cb21ddSStefano Zampini static PetscErrorCode MatMumpsHandleSchur_Private(Mat F, PetscBool expansion)
298b5fa320bSStefano Zampini {
299b3cb21ddSStefano Zampini   Mat_MUMPS     *mumps=(Mat_MUMPS*)F->data;
300b5fa320bSStefano Zampini 
301b5fa320bSStefano Zampini   PetscFunctionBegin;
302b5fa320bSStefano Zampini   if (!mumps->id.ICNTL(19)) { /* do nothing when Schur complement has not been computed */
303b5fa320bSStefano Zampini     PetscFunctionReturn(0);
304b5fa320bSStefano Zampini   }
305b8f61ee1SStefano Zampini   if (!expansion) { /* prepare for the condensation step */
306b5fa320bSStefano Zampini     PetscInt sizeredrhs = mumps->id.nrhs*mumps->id.size_schur;
307b5fa320bSStefano Zampini     /* allocate MUMPS internal array to store reduced right-hand sides */
308b5fa320bSStefano Zampini     if (!mumps->id.redrhs || sizeredrhs > mumps->sizeredrhs) {
3099566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
310b5fa320bSStefano Zampini       mumps->id.lredrhs = mumps->id.size_schur;
3119566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.nrhs*mumps->id.lredrhs,&mumps->id.redrhs));
312b5fa320bSStefano Zampini       mumps->sizeredrhs = mumps->id.nrhs*mumps->id.lredrhs;
313b5fa320bSStefano Zampini     }
314b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 1; /* condensation phase */
315b5fa320bSStefano Zampini   } else { /* prepare for the expansion step */
316b8f61ee1SStefano Zampini     /* solve Schur complement (this has to be done by the MUMPS user, so basically us) */
3179566063dSJacob Faibussowitsch     PetscCall(MatMumpsSolveSchur_Private(F));
318b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 2; /* expansion phase */
3193ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
32008401ef6SPierre Jolivet     PetscCheck(mumps->id.INFOG(1) >= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in solve phase: INFOG(1)=%d",mumps->id.INFOG(1));
321b5fa320bSStefano Zampini     /* restore defaults */
322b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = -1;
323d3d598ffSStefano Zampini     /* free MUMPS internal array for redrhs if we have solved for multiple rhs in order to save memory space */
324d3d598ffSStefano Zampini     if (mumps->id.nrhs > 1) {
3259566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
326d3d598ffSStefano Zampini       mumps->id.lredrhs = 0;
327d3d598ffSStefano Zampini       mumps->sizeredrhs = 0;
328d3d598ffSStefano Zampini     }
329b5fa320bSStefano Zampini   }
330b5fa320bSStefano Zampini   PetscFunctionReturn(0);
331b5fa320bSStefano Zampini }
332b5fa320bSStefano Zampini 
333397b6df1SKris Buschelman /*
334d341cd04SHong Zhang   MatConvertToTriples_A_B - convert Petsc matrix to triples: row[nz], col[nz], val[nz]
335d341cd04SHong Zhang 
336397b6df1SKris Buschelman   input:
33775480915SPierre Jolivet     A       - matrix in aij,baij or sbaij format
338397b6df1SKris Buschelman     shift   - 0: C style output triple; 1: Fortran style output triple.
339bccb9932SShri Abhyankar     reuse   - MAT_INITIAL_MATRIX: spaces are allocated and values are set for the triple
340bccb9932SShri Abhyankar               MAT_REUSE_MATRIX:   only the values in v array are updated
341397b6df1SKris Buschelman   output:
342397b6df1SKris Buschelman     nnz     - dim of r, c, and v (number of local nonzero entries of A)
343397b6df1SKris Buschelman     r, c, v - row and col index, matrix values (matrix triples)
344eb9baa12SBarry Smith 
345eb9baa12SBarry Smith   The returned values r, c, and sometimes v are obtained in a single PetscMalloc(). Then in MatDestroy_MUMPS() it is
3467ee00b23SStefano Zampini   freed with PetscFree(mumps->irn);  This is not ideal code, the fact that v is ONLY sometimes part of mumps->irn means
347eb9baa12SBarry Smith   that the PetscMalloc() cannot easily be replaced with a PetscMalloc3().
348eb9baa12SBarry Smith 
349397b6df1SKris Buschelman  */
35016ebf90aSShri Abhyankar 
351a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_seqaij_seqaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
352b24902e0SBarry Smith {
353a3d589ffSStefano Zampini   const PetscScalar *av;
354185f6596SHong Zhang   const PetscInt    *ai,*aj,*ajj,M=A->rmap->n;
355a6053eceSJunchao Zhang   PetscInt64        nz,rnz,i,j,k;
356a6053eceSJunchao Zhang   PetscMUMPSInt     *row,*col;
35716ebf90aSShri Abhyankar   Mat_SeqAIJ        *aa=(Mat_SeqAIJ*)A->data;
358397b6df1SKris Buschelman 
359397b6df1SKris Buschelman   PetscFunctionBegin;
3609566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A,&av));
361a6053eceSJunchao Zhang   mumps->val = (PetscScalar*)av;
362bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
3632205254eSKarl Rupp     nz   = aa->nz;
3642205254eSKarl Rupp     ai   = aa->i;
3652205254eSKarl Rupp     aj   = aa->j;
3669566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
367a6053eceSJunchao Zhang     for (i=k=0; i<M; i++) {
36816ebf90aSShri Abhyankar       rnz = ai[i+1] - ai[i];
36967877ebaSShri Abhyankar       ajj = aj + ai[i];
37067877ebaSShri Abhyankar       for (j=0; j<rnz; j++) {
3719566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i+shift,&row[k]));
3729566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift,&col[k]));
373a6053eceSJunchao Zhang         k++;
37416ebf90aSShri Abhyankar       }
37516ebf90aSShri Abhyankar     }
376a6053eceSJunchao Zhang     mumps->irn = row;
377a6053eceSJunchao Zhang     mumps->jcn = col;
378a6053eceSJunchao Zhang     mumps->nnz = nz;
37916ebf90aSShri Abhyankar   }
3809566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A,&av));
38116ebf90aSShri Abhyankar   PetscFunctionReturn(0);
38216ebf90aSShri Abhyankar }
383397b6df1SKris Buschelman 
384a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
3857ee00b23SStefano Zampini {
386a6053eceSJunchao Zhang   PetscInt64     nz,i,j,k,r;
3877ee00b23SStefano Zampini   Mat_SeqSELL    *a=(Mat_SeqSELL*)A->data;
388a6053eceSJunchao Zhang   PetscMUMPSInt  *row,*col;
3897ee00b23SStefano Zampini 
3907ee00b23SStefano Zampini   PetscFunctionBegin;
391a6053eceSJunchao Zhang   mumps->val = a->val;
3927ee00b23SStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
3937ee00b23SStefano Zampini     nz   = a->sliidx[a->totalslices];
3949566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
395a6053eceSJunchao Zhang     for (i=k=0; i<a->totalslices; i++) {
396a6053eceSJunchao Zhang       for (j=a->sliidx[i],r=0; j<a->sliidx[i+1]; j++,r=((r+1)&0x07)) {
3979566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(8*i+r+shift,&row[k++]));
3987ee00b23SStefano Zampini       }
3997ee00b23SStefano Zampini     }
4009566063dSJacob Faibussowitsch     for (i=0;i<nz;i++) PetscCall(PetscMUMPSIntCast(a->colidx[i]+shift,&col[i]));
401a6053eceSJunchao Zhang     mumps->irn = row;
402a6053eceSJunchao Zhang     mumps->jcn = col;
403a6053eceSJunchao Zhang     mumps->nnz = nz;
4047ee00b23SStefano Zampini   }
4057ee00b23SStefano Zampini   PetscFunctionReturn(0);
4067ee00b23SStefano Zampini }
4077ee00b23SStefano Zampini 
408a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
40967877ebaSShri Abhyankar {
41067877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa=(Mat_SeqBAIJ*)A->data;
41133d57670SJed Brown   const PetscInt *ai,*aj,*ajj,bs2 = aa->bs2;
412a6053eceSJunchao Zhang   PetscInt64     M,nz,idx=0,rnz,i,j,k,m;
413a6053eceSJunchao Zhang   PetscInt       bs;
414a6053eceSJunchao Zhang   PetscMUMPSInt  *row,*col;
41567877ebaSShri Abhyankar 
41667877ebaSShri Abhyankar   PetscFunctionBegin;
4179566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A,&bs));
41833d57670SJed Brown   M          = A->rmap->N/bs;
419a6053eceSJunchao Zhang   mumps->val = aa->a;
420bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
421cf3759fdSShri Abhyankar     ai   = aa->i; aj = aa->j;
42267877ebaSShri Abhyankar     nz   = bs2*aa->nz;
4239566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
42467877ebaSShri Abhyankar     for (i=0; i<M; i++) {
42567877ebaSShri Abhyankar       ajj = aj + ai[i];
42667877ebaSShri Abhyankar       rnz = ai[i+1] - ai[i];
42767877ebaSShri Abhyankar       for (k=0; k<rnz; k++) {
42867877ebaSShri Abhyankar         for (j=0; j<bs; j++) {
42967877ebaSShri Abhyankar           for (m=0; m<bs; m++) {
4309566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i*bs + m + shift,&row[idx]));
4319566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs*ajj[k] + j + shift,&col[idx]));
432a6053eceSJunchao Zhang             idx++;
43367877ebaSShri Abhyankar           }
43467877ebaSShri Abhyankar         }
43567877ebaSShri Abhyankar       }
43667877ebaSShri Abhyankar     }
437a6053eceSJunchao Zhang     mumps->irn = row;
438a6053eceSJunchao Zhang     mumps->jcn = col;
439a6053eceSJunchao Zhang     mumps->nnz = nz;
44067877ebaSShri Abhyankar   }
44167877ebaSShri Abhyankar   PetscFunctionReturn(0);
44267877ebaSShri Abhyankar }
44367877ebaSShri Abhyankar 
444a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
44516ebf90aSShri Abhyankar {
44675480915SPierre Jolivet   const PetscInt *ai, *aj,*ajj;
447a6053eceSJunchao Zhang   PetscInt        bs;
448a6053eceSJunchao Zhang   PetscInt64      nz,rnz,i,j,k,m;
449a6053eceSJunchao Zhang   PetscMUMPSInt   *row,*col;
45075480915SPierre Jolivet   PetscScalar     *val;
45116ebf90aSShri Abhyankar   Mat_SeqSBAIJ    *aa=(Mat_SeqSBAIJ*)A->data;
45275480915SPierre Jolivet   const PetscInt  bs2=aa->bs2,mbs=aa->mbs;
45338548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
45438548759SBarry Smith   PetscBool       hermitian;
45538548759SBarry Smith #endif
45616ebf90aSShri Abhyankar 
45716ebf90aSShri Abhyankar   PetscFunctionBegin;
45838548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
4599566063dSJacob Faibussowitsch   PetscCall(MatGetOption(A,MAT_HERMITIAN,&hermitian));
46028b400f6SJacob Faibussowitsch   PetscCheck(!hermitian,PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MUMPS does not support Hermitian symmetric matrices for Choleksy");
46138548759SBarry Smith #endif
4622205254eSKarl Rupp   ai   = aa->i;
4632205254eSKarl Rupp   aj   = aa->j;
4649566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A,&bs));
46575480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
46675480915SPierre Jolivet     nz   = aa->nz;
4679566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(bs2*nz,&row,bs2*nz,&col));
468a6053eceSJunchao Zhang     if (bs>1) {
4699566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(bs2*nz,&mumps->val_alloc));
470a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
47175480915SPierre Jolivet     } else {
472a6053eceSJunchao Zhang       mumps->val = aa->a;
47375480915SPierre Jolivet     }
474a6053eceSJunchao Zhang     mumps->irn = row;
475a6053eceSJunchao Zhang     mumps->jcn = col;
476a6053eceSJunchao Zhang   } else {
477a6053eceSJunchao Zhang     if (bs == 1) mumps->val = aa->a;
478a6053eceSJunchao Zhang     row = mumps->irn;
479a6053eceSJunchao Zhang     col = mumps->jcn;
480a6053eceSJunchao Zhang   }
481a6053eceSJunchao Zhang   val = mumps->val;
482185f6596SHong Zhang 
48316ebf90aSShri Abhyankar   nz = 0;
484a81fe166SPierre Jolivet   if (bs>1) {
48575480915SPierre Jolivet     for (i=0; i<mbs; i++) {
48616ebf90aSShri Abhyankar       rnz = ai[i+1] - ai[i];
48767877ebaSShri Abhyankar       ajj = aj + ai[i];
48875480915SPierre Jolivet       for (j=0; j<rnz; j++) {
48975480915SPierre Jolivet         for (k=0; k<bs; k++) {
49075480915SPierre Jolivet           for (m=0; m<bs; m++) {
491ec4f40fdSPierre Jolivet             if (ajj[j]>i || k>=m) {
49275480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
4939566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i*bs + m + shift,&row[nz]));
4949566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j]*bs + k + shift,&col[nz]));
49575480915SPierre Jolivet               }
49675480915SPierre Jolivet               val[nz++] = aa->a[(ai[i]+j)*bs2 + m + k*bs];
49775480915SPierre Jolivet             }
49875480915SPierre Jolivet           }
49975480915SPierre Jolivet         }
50075480915SPierre Jolivet       }
50175480915SPierre Jolivet     }
502a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
503a81fe166SPierre Jolivet     for (i=0; i<mbs; i++) {
504a81fe166SPierre Jolivet       rnz = ai[i+1] - ai[i];
505a81fe166SPierre Jolivet       ajj = aj + ai[i];
506a81fe166SPierre Jolivet       for (j=0; j<rnz; j++) {
5079566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i+shift,&row[nz]));
5089566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift,&col[nz]));
509a6053eceSJunchao Zhang         nz++;
510a81fe166SPierre Jolivet       }
511a81fe166SPierre Jolivet     }
51208401ef6SPierre Jolivet     PetscCheck(nz == aa->nz,PETSC_COMM_SELF,PETSC_ERR_PLIB,"Different numbers of nonzeros %" PetscInt64_FMT " != %" PetscInt_FMT,nz,aa->nz);
51375480915SPierre Jolivet   }
514a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
51516ebf90aSShri Abhyankar   PetscFunctionReturn(0);
51616ebf90aSShri Abhyankar }
51716ebf90aSShri Abhyankar 
518a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
51916ebf90aSShri Abhyankar {
52067877ebaSShri Abhyankar   const PetscInt    *ai,*aj,*ajj,*adiag,M=A->rmap->n;
521a6053eceSJunchao Zhang   PetscInt64        nz,rnz,i,j;
52267877ebaSShri Abhyankar   const PetscScalar *av,*v1;
52316ebf90aSShri Abhyankar   PetscScalar       *val;
524a6053eceSJunchao Zhang   PetscMUMPSInt     *row,*col;
525829b1710SHong Zhang   Mat_SeqAIJ        *aa=(Mat_SeqAIJ*)A->data;
52629b521d4Sstefano_zampini   PetscBool         missing;
52738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
52838548759SBarry Smith   PetscBool         hermitian;
52938548759SBarry Smith #endif
53016ebf90aSShri Abhyankar 
53116ebf90aSShri Abhyankar   PetscFunctionBegin;
53238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
5339566063dSJacob Faibussowitsch   PetscCall(MatGetOption(A,MAT_HERMITIAN,&hermitian));
53428b400f6SJacob Faibussowitsch   PetscCheck(!hermitian,PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MUMPS does not support Hermitian symmetric matrices for Choleksy");
53538548759SBarry Smith #endif
5369566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A,&av));
537a3d589ffSStefano Zampini   ai    = aa->i; aj = aa->j;
53816ebf90aSShri Abhyankar   adiag = aa->diag;
5399566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A,&missing,NULL));
540bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5417ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
542829b1710SHong Zhang     nz = 0;
54329b521d4Sstefano_zampini     if (missing) {
54429b521d4Sstefano_zampini       for (i=0; i<M; i++) {
54529b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i+1])) {
54629b521d4Sstefano_zampini           for (j=ai[i];j<ai[i+1];j++) {
54729b521d4Sstefano_zampini             if (aj[j] < i) continue;
54829b521d4Sstefano_zampini             nz++;
54929b521d4Sstefano_zampini           }
55029b521d4Sstefano_zampini         } else {
55129b521d4Sstefano_zampini           nz += ai[i+1] - adiag[i];
55229b521d4Sstefano_zampini         }
55329b521d4Sstefano_zampini       }
55429b521d4Sstefano_zampini     } else {
555829b1710SHong Zhang       for (i=0; i<M; i++) nz += ai[i+1] - adiag[i];
55629b521d4Sstefano_zampini     }
5579566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
5589566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz,&val));
559a6053eceSJunchao Zhang     mumps->nnz = nz;
560a6053eceSJunchao Zhang     mumps->irn = row;
561a6053eceSJunchao Zhang     mumps->jcn = col;
562a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
563185f6596SHong Zhang 
56416ebf90aSShri Abhyankar     nz = 0;
56529b521d4Sstefano_zampini     if (missing) {
56629b521d4Sstefano_zampini       for (i=0; i<M; i++) {
56729b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i+1])) {
56829b521d4Sstefano_zampini           for (j=ai[i];j<ai[i+1];j++) {
56929b521d4Sstefano_zampini             if (aj[j] < i) continue;
5709566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i+shift,&row[nz]));
5719566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j]+shift,&col[nz]));
57229b521d4Sstefano_zampini             val[nz] = av[j];
57329b521d4Sstefano_zampini             nz++;
57429b521d4Sstefano_zampini           }
57529b521d4Sstefano_zampini         } else {
57629b521d4Sstefano_zampini           rnz = ai[i+1] - adiag[i];
57729b521d4Sstefano_zampini           ajj = aj + adiag[i];
57829b521d4Sstefano_zampini           v1  = av + adiag[i];
57929b521d4Sstefano_zampini           for (j=0; j<rnz; j++) {
5809566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i+shift,&row[nz]));
5819566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift,&col[nz]));
582a6053eceSJunchao Zhang             val[nz++] = v1[j];
58329b521d4Sstefano_zampini           }
58429b521d4Sstefano_zampini         }
58529b521d4Sstefano_zampini       }
58629b521d4Sstefano_zampini     } else {
58716ebf90aSShri Abhyankar       for (i=0; i<M; i++) {
58816ebf90aSShri Abhyankar         rnz = ai[i+1] - adiag[i];
58967877ebaSShri Abhyankar         ajj = aj + adiag[i];
590cf3759fdSShri Abhyankar         v1  = av + adiag[i];
59167877ebaSShri Abhyankar         for (j=0; j<rnz; j++) {
5929566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i+shift,&row[nz]));
5939566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift,&col[nz]));
594a6053eceSJunchao Zhang           val[nz++] = v1[j];
59516ebf90aSShri Abhyankar         }
59616ebf90aSShri Abhyankar       }
59729b521d4Sstefano_zampini     }
598397b6df1SKris Buschelman   } else {
599a6053eceSJunchao Zhang     nz = 0;
600a6053eceSJunchao Zhang     val = mumps->val;
60129b521d4Sstefano_zampini     if (missing) {
60216ebf90aSShri Abhyankar       for (i=0; i <M; i++) {
60329b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i+1])) {
60429b521d4Sstefano_zampini           for (j=ai[i];j<ai[i+1];j++) {
60529b521d4Sstefano_zampini             if (aj[j] < i) continue;
60629b521d4Sstefano_zampini             val[nz++] = av[j];
60729b521d4Sstefano_zampini           }
60829b521d4Sstefano_zampini         } else {
60916ebf90aSShri Abhyankar           rnz = ai[i+1] - adiag[i];
61067877ebaSShri Abhyankar           v1  = av + adiag[i];
61167877ebaSShri Abhyankar           for (j=0; j<rnz; j++) {
61267877ebaSShri Abhyankar             val[nz++] = v1[j];
61316ebf90aSShri Abhyankar           }
61416ebf90aSShri Abhyankar         }
61516ebf90aSShri Abhyankar       }
61629b521d4Sstefano_zampini     } else {
61716ebf90aSShri Abhyankar       for (i=0; i <M; i++) {
61816ebf90aSShri Abhyankar         rnz = ai[i+1] - adiag[i];
61916ebf90aSShri Abhyankar         v1  = av + adiag[i];
62016ebf90aSShri Abhyankar         for (j=0; j<rnz; j++) {
62116ebf90aSShri Abhyankar           val[nz++] = v1[j];
62216ebf90aSShri Abhyankar         }
62316ebf90aSShri Abhyankar       }
62416ebf90aSShri Abhyankar     }
62529b521d4Sstefano_zampini   }
6269566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A,&av));
62716ebf90aSShri Abhyankar   PetscFunctionReturn(0);
62816ebf90aSShri Abhyankar }
62916ebf90aSShri Abhyankar 
630a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
63116ebf90aSShri Abhyankar {
632a6053eceSJunchao Zhang   const PetscInt    *ai,*aj,*bi,*bj,*garray,*ajj,*bjj;
633a6053eceSJunchao Zhang   PetscInt          bs;
634a6053eceSJunchao Zhang   PetscInt64        rstart,nz,i,j,k,m,jj,irow,countA,countB;
635a6053eceSJunchao Zhang   PetscMUMPSInt     *row,*col;
63616ebf90aSShri Abhyankar   const PetscScalar *av,*bv,*v1,*v2;
63716ebf90aSShri Abhyankar   PetscScalar       *val;
638397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ*)A->data;
639397b6df1SKris Buschelman   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ*)(mat->A)->data;
640397b6df1SKris Buschelman   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ*)(mat->B)->data;
641ec4f40fdSPierre Jolivet   const PetscInt    bs2=aa->bs2,mbs=aa->mbs;
64238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
64338548759SBarry Smith   PetscBool         hermitian;
64438548759SBarry Smith #endif
64516ebf90aSShri Abhyankar 
64616ebf90aSShri Abhyankar   PetscFunctionBegin;
64738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
6489566063dSJacob Faibussowitsch   PetscCall(MatGetOption(A,MAT_HERMITIAN,&hermitian));
64928b400f6SJacob Faibussowitsch   PetscCheck(!hermitian,PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MUMPS does not support Hermitian symmetric matrices for Choleksy");
65038548759SBarry Smith #endif
6519566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A,&bs));
65238548759SBarry Smith   rstart = A->rmap->rstart;
65338548759SBarry Smith   ai = aa->i;
65438548759SBarry Smith   aj = aa->j;
65538548759SBarry Smith   bi = bb->i;
65638548759SBarry Smith   bj = bb->j;
65738548759SBarry Smith   av = aa->a;
65838548759SBarry Smith   bv = bb->a;
659397b6df1SKris Buschelman 
6602205254eSKarl Rupp   garray = mat->garray;
6612205254eSKarl Rupp 
662bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
663a6053eceSJunchao Zhang     nz   = (aa->nz+bb->nz)*bs2; /* just a conservative estimate */
6649566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
6659566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz,&val));
666a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
667a6053eceSJunchao Zhang     mumps->irn = row;
668a6053eceSJunchao Zhang     mumps->jcn = col;
669a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
670397b6df1SKris Buschelman   } else {
671a6053eceSJunchao Zhang     val = mumps->val;
672397b6df1SKris Buschelman   }
673397b6df1SKris Buschelman 
674028e57e8SHong Zhang   jj = 0; irow = rstart;
675ec4f40fdSPierre Jolivet   for (i=0; i<mbs; i++) {
676397b6df1SKris Buschelman     ajj    = aj + ai[i];                 /* ptr to the beginning of this row */
677397b6df1SKris Buschelman     countA = ai[i+1] - ai[i];
678397b6df1SKris Buschelman     countB = bi[i+1] - bi[i];
679397b6df1SKris Buschelman     bjj    = bj + bi[i];
680ec4f40fdSPierre Jolivet     v1     = av + ai[i]*bs2;
681ec4f40fdSPierre Jolivet     v2     = bv + bi[i]*bs2;
682397b6df1SKris Buschelman 
683ec4f40fdSPierre Jolivet     if (bs>1) {
684ec4f40fdSPierre Jolivet       /* A-part */
685ec4f40fdSPierre Jolivet       for (j=0; j<countA; j++) {
686ec4f40fdSPierre Jolivet         for (k=0; k<bs; k++) {
687ec4f40fdSPierre Jolivet           for (m=0; m<bs; m++) {
688ec4f40fdSPierre Jolivet             if (rstart + ajj[j]*bs>irow || k>=m) {
689ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
6909566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift,&row[jj]));
6919566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j]*bs + k + shift,&col[jj]));
692ec4f40fdSPierre Jolivet               }
693ec4f40fdSPierre Jolivet               val[jj++] = v1[j*bs2 + m + k*bs];
694ec4f40fdSPierre Jolivet             }
695ec4f40fdSPierre Jolivet           }
696ec4f40fdSPierre Jolivet         }
697ec4f40fdSPierre Jolivet       }
698ec4f40fdSPierre Jolivet 
699ec4f40fdSPierre Jolivet       /* B-part */
700ec4f40fdSPierre Jolivet       for (j=0; j < countB; j++) {
701ec4f40fdSPierre Jolivet         for (k=0; k<bs; k++) {
702ec4f40fdSPierre Jolivet           for (m=0; m<bs; m++) {
703ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7049566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift,&row[jj]));
7059566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]]*bs + k + shift,&col[jj]));
706ec4f40fdSPierre Jolivet             }
707ec4f40fdSPierre Jolivet             val[jj++] = v2[j*bs2 + m + k*bs];
708ec4f40fdSPierre Jolivet           }
709ec4f40fdSPierre Jolivet         }
710ec4f40fdSPierre Jolivet       }
711ec4f40fdSPierre Jolivet     } else {
712397b6df1SKris Buschelman       /* A-part */
713397b6df1SKris Buschelman       for (j=0; j<countA; j++) {
714bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7159566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift,&row[jj]));
7169566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift,&col[jj]));
717397b6df1SKris Buschelman         }
71816ebf90aSShri Abhyankar         val[jj++] = v1[j];
719397b6df1SKris Buschelman       }
72016ebf90aSShri Abhyankar 
72116ebf90aSShri Abhyankar       /* B-part */
72216ebf90aSShri Abhyankar       for (j=0; j < countB; j++) {
723bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7249566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift,&row[jj]));
7259566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift,&col[jj]));
726397b6df1SKris Buschelman         }
72716ebf90aSShri Abhyankar         val[jj++] = v2[j];
72816ebf90aSShri Abhyankar       }
72916ebf90aSShri Abhyankar     }
730ec4f40fdSPierre Jolivet     irow+=bs;
731ec4f40fdSPierre Jolivet   }
732a6053eceSJunchao Zhang   mumps->nnz = jj;
73316ebf90aSShri Abhyankar   PetscFunctionReturn(0);
73416ebf90aSShri Abhyankar }
73516ebf90aSShri Abhyankar 
736a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
73716ebf90aSShri Abhyankar {
73816ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj,*garray,m=A->rmap->n,*ajj,*bjj;
739a6053eceSJunchao Zhang   PetscInt64        rstart,nz,i,j,jj,irow,countA,countB;
740a6053eceSJunchao Zhang   PetscMUMPSInt     *row,*col;
74116ebf90aSShri Abhyankar   const PetscScalar *av, *bv,*v1,*v2;
74216ebf90aSShri Abhyankar   PetscScalar       *val;
743a3d589ffSStefano Zampini   Mat               Ad,Ao;
744a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
745a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
74616ebf90aSShri Abhyankar 
74716ebf90aSShri Abhyankar   PetscFunctionBegin;
7489566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A,&Ad,&Ao,&garray));
7499566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad,&av));
7509566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao,&bv));
751a3d589ffSStefano Zampini 
752a3d589ffSStefano Zampini   aa = (Mat_SeqAIJ*)(Ad)->data;
753a3d589ffSStefano Zampini   bb = (Mat_SeqAIJ*)(Ao)->data;
75438548759SBarry Smith   ai = aa->i;
75538548759SBarry Smith   aj = aa->j;
75638548759SBarry Smith   bi = bb->i;
75738548759SBarry Smith   bj = bb->j;
75816ebf90aSShri Abhyankar 
759a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7602205254eSKarl Rupp 
761bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
762a6053eceSJunchao Zhang     nz   = (PetscInt64)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7639566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
7649566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz,&val));
765a6053eceSJunchao Zhang     mumps->nnz = nz;
766a6053eceSJunchao Zhang     mumps->irn = row;
767a6053eceSJunchao Zhang     mumps->jcn = col;
768a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
76916ebf90aSShri Abhyankar   } else {
770a6053eceSJunchao Zhang     val = mumps->val;
77116ebf90aSShri Abhyankar   }
77216ebf90aSShri Abhyankar 
77316ebf90aSShri Abhyankar   jj = 0; irow = rstart;
77416ebf90aSShri Abhyankar   for (i=0; i<m; i++) {
77516ebf90aSShri Abhyankar     ajj    = aj + ai[i];                 /* ptr to the beginning of this row */
77616ebf90aSShri Abhyankar     countA = ai[i+1] - ai[i];
77716ebf90aSShri Abhyankar     countB = bi[i+1] - bi[i];
77816ebf90aSShri Abhyankar     bjj    = bj + bi[i];
77916ebf90aSShri Abhyankar     v1     = av + ai[i];
78016ebf90aSShri Abhyankar     v2     = bv + bi[i];
78116ebf90aSShri Abhyankar 
78216ebf90aSShri Abhyankar     /* A-part */
78316ebf90aSShri Abhyankar     for (j=0; j<countA; j++) {
784bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
7859566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift,&row[jj]));
7869566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift,&col[jj]));
78716ebf90aSShri Abhyankar       }
78816ebf90aSShri Abhyankar       val[jj++] = v1[j];
78916ebf90aSShri Abhyankar     }
79016ebf90aSShri Abhyankar 
79116ebf90aSShri Abhyankar     /* B-part */
79216ebf90aSShri Abhyankar     for (j=0; j < countB; j++) {
793bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
7949566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift,&row[jj]));
7959566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift,&col[jj]));
79616ebf90aSShri Abhyankar       }
79716ebf90aSShri Abhyankar       val[jj++] = v2[j];
79816ebf90aSShri Abhyankar     }
79916ebf90aSShri Abhyankar     irow++;
80016ebf90aSShri Abhyankar   }
8019566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad,&av));
8029566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao,&bv));
80316ebf90aSShri Abhyankar   PetscFunctionReturn(0);
80416ebf90aSShri Abhyankar }
80516ebf90aSShri Abhyankar 
806a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
80767877ebaSShri Abhyankar {
80867877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat    = (Mat_MPIBAIJ*)A->data;
80967877ebaSShri Abhyankar   Mat_SeqBAIJ       *aa     = (Mat_SeqBAIJ*)(mat->A)->data;
81067877ebaSShri Abhyankar   Mat_SeqBAIJ       *bb     = (Mat_SeqBAIJ*)(mat->B)->data;
81167877ebaSShri Abhyankar   const PetscInt    *ai     = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j,*ajj, *bjj;
812d985c460SShri Abhyankar   const PetscInt    *garray = mat->garray,mbs=mat->mbs,rstart=A->rmap->rstart;
81333d57670SJed Brown   const PetscInt    bs2=mat->bs2;
814a6053eceSJunchao Zhang   PetscInt          bs;
815a6053eceSJunchao Zhang   PetscInt64        nz,i,j,k,n,jj,irow,countA,countB,idx;
816a6053eceSJunchao Zhang   PetscMUMPSInt     *row,*col;
81767877ebaSShri Abhyankar   const PetscScalar *av=aa->a, *bv=bb->a,*v1,*v2;
81867877ebaSShri Abhyankar   PetscScalar       *val;
81967877ebaSShri Abhyankar 
82067877ebaSShri Abhyankar   PetscFunctionBegin;
8219566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A,&bs));
822bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
82367877ebaSShri Abhyankar     nz   = bs2*(aa->nz + bb->nz);
8249566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
8259566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz,&val));
826a6053eceSJunchao Zhang     mumps->nnz = nz;
827a6053eceSJunchao Zhang     mumps->irn = row;
828a6053eceSJunchao Zhang     mumps->jcn = col;
829a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
83067877ebaSShri Abhyankar   } else {
831a6053eceSJunchao Zhang     val = mumps->val;
83267877ebaSShri Abhyankar   }
83367877ebaSShri Abhyankar 
834d985c460SShri Abhyankar   jj = 0; irow = rstart;
83567877ebaSShri Abhyankar   for (i=0; i<mbs; i++) {
83667877ebaSShri Abhyankar     countA = ai[i+1] - ai[i];
83767877ebaSShri Abhyankar     countB = bi[i+1] - bi[i];
83867877ebaSShri Abhyankar     ajj    = aj + ai[i];
83967877ebaSShri Abhyankar     bjj    = bj + bi[i];
84067877ebaSShri Abhyankar     v1     = av + bs2*ai[i];
84167877ebaSShri Abhyankar     v2     = bv + bs2*bi[i];
84267877ebaSShri Abhyankar 
84367877ebaSShri Abhyankar     idx = 0;
84467877ebaSShri Abhyankar     /* A-part */
84567877ebaSShri Abhyankar     for (k=0; k<countA; k++) {
84667877ebaSShri Abhyankar       for (j=0; j<bs; j++) {
84767877ebaSShri Abhyankar         for (n=0; n<bs; n++) {
848bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8499566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift,&row[jj]));
8509566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(rstart + bs*ajj[k] + j + shift,&col[jj]));
85167877ebaSShri Abhyankar           }
85267877ebaSShri Abhyankar           val[jj++] = v1[idx++];
85367877ebaSShri Abhyankar         }
85467877ebaSShri Abhyankar       }
85567877ebaSShri Abhyankar     }
85667877ebaSShri Abhyankar 
85767877ebaSShri Abhyankar     idx = 0;
85867877ebaSShri Abhyankar     /* B-part */
85967877ebaSShri Abhyankar     for (k=0; k<countB; k++) {
86067877ebaSShri Abhyankar       for (j=0; j<bs; j++) {
86167877ebaSShri Abhyankar         for (n=0; n<bs; n++) {
862bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8639566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift,&row[jj]));
8649566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs*garray[bjj[k]] + j + shift,&col[jj]));
86567877ebaSShri Abhyankar           }
866d985c460SShri Abhyankar           val[jj++] = v2[idx++];
86767877ebaSShri Abhyankar         }
86867877ebaSShri Abhyankar       }
86967877ebaSShri Abhyankar     }
870d985c460SShri Abhyankar     irow += bs;
87167877ebaSShri Abhyankar   }
87267877ebaSShri Abhyankar   PetscFunctionReturn(0);
87367877ebaSShri Abhyankar }
87467877ebaSShri Abhyankar 
875a6053eceSJunchao Zhang PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A,PetscInt shift,MatReuse reuse,Mat_MUMPS *mumps)
87616ebf90aSShri Abhyankar {
87716ebf90aSShri Abhyankar   const PetscInt    *ai, *aj,*adiag, *bi, *bj,*garray,m=A->rmap->n,*ajj,*bjj;
878a6053eceSJunchao Zhang   PetscInt64        rstart,nz,nza,nzb,i,j,jj,irow,countA,countB;
879a6053eceSJunchao Zhang   PetscMUMPSInt     *row,*col;
88016ebf90aSShri Abhyankar   const PetscScalar *av, *bv,*v1,*v2;
88116ebf90aSShri Abhyankar   PetscScalar       *val;
882a3d589ffSStefano Zampini   Mat               Ad,Ao;
883a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
884a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
88538548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
88638548759SBarry Smith   PetscBool         hermitian;
88738548759SBarry Smith #endif
88816ebf90aSShri Abhyankar 
88916ebf90aSShri Abhyankar   PetscFunctionBegin;
89038548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
8919566063dSJacob Faibussowitsch   PetscCall(MatGetOption(A,MAT_HERMITIAN,&hermitian));
89228b400f6SJacob Faibussowitsch   PetscCheck(!hermitian,PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"MUMPS does not support Hermitian symmetric matrices for Choleksy");
89338548759SBarry Smith #endif
8949566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A,&Ad,&Ao,&garray));
8959566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad,&av));
8969566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao,&bv));
897a3d589ffSStefano Zampini 
898a3d589ffSStefano Zampini   aa    = (Mat_SeqAIJ*)(Ad)->data;
899a3d589ffSStefano Zampini   bb    = (Mat_SeqAIJ*)(Ao)->data;
90038548759SBarry Smith   ai    = aa->i;
90138548759SBarry Smith   aj    = aa->j;
90238548759SBarry Smith   adiag = aa->diag;
90338548759SBarry Smith   bi    = bb->i;
90438548759SBarry Smith   bj    = bb->j;
9052205254eSKarl Rupp 
90616ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
90716ebf90aSShri Abhyankar 
908bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
909e0bace9bSHong Zhang     nza = 0;    /* num of upper triangular entries in mat->A, including diagonals */
910e0bace9bSHong Zhang     nzb = 0;    /* num of upper triangular entries in mat->B */
91116ebf90aSShri Abhyankar     for (i=0; i<m; i++) {
912e0bace9bSHong Zhang       nza   += (ai[i+1] - adiag[i]);
91316ebf90aSShri Abhyankar       countB = bi[i+1] - bi[i];
91416ebf90aSShri Abhyankar       bjj    = bj + bi[i];
915e0bace9bSHong Zhang       for (j=0; j<countB; j++) {
916e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
917e0bace9bSHong Zhang       }
918e0bace9bSHong Zhang     }
91916ebf90aSShri Abhyankar 
920e0bace9bSHong Zhang     nz   = nza + nzb; /* total nz of upper triangular part of mat */
9219566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz,&row,nz,&col));
9229566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz,&val));
923a6053eceSJunchao Zhang     mumps->nnz = nz;
924a6053eceSJunchao Zhang     mumps->irn = row;
925a6053eceSJunchao Zhang     mumps->jcn = col;
926a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
92716ebf90aSShri Abhyankar   } else {
928a6053eceSJunchao Zhang     val = mumps->val;
92916ebf90aSShri Abhyankar   }
93016ebf90aSShri Abhyankar 
93116ebf90aSShri Abhyankar   jj = 0; irow = rstart;
93216ebf90aSShri Abhyankar   for (i=0; i<m; i++) {
93316ebf90aSShri Abhyankar     ajj    = aj + adiag[i];                 /* ptr to the beginning of the diagonal of this row */
93416ebf90aSShri Abhyankar     v1     = av + adiag[i];
93516ebf90aSShri Abhyankar     countA = ai[i+1] - adiag[i];
93616ebf90aSShri Abhyankar     countB = bi[i+1] - bi[i];
93716ebf90aSShri Abhyankar     bjj    = bj + bi[i];
93816ebf90aSShri Abhyankar     v2     = bv + bi[i];
93916ebf90aSShri Abhyankar 
94016ebf90aSShri Abhyankar     /* A-part */
94116ebf90aSShri Abhyankar     for (j=0; j<countA; j++) {
942bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9439566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift,&row[jj]));
9449566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift,&col[jj]));
94516ebf90aSShri Abhyankar       }
94616ebf90aSShri Abhyankar       val[jj++] = v1[j];
94716ebf90aSShri Abhyankar     }
94816ebf90aSShri Abhyankar 
94916ebf90aSShri Abhyankar     /* B-part */
95016ebf90aSShri Abhyankar     for (j=0; j < countB; j++) {
95116ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
952bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9539566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift,&row[jj]));
9549566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift,&col[jj]));
95516ebf90aSShri Abhyankar         }
95616ebf90aSShri Abhyankar         val[jj++] = v2[j];
95716ebf90aSShri Abhyankar       }
958397b6df1SKris Buschelman     }
959397b6df1SKris Buschelman     irow++;
960397b6df1SKris Buschelman   }
9619566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad,&av));
9629566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao,&bv));
963397b6df1SKris Buschelman   PetscFunctionReturn(0);
964397b6df1SKris Buschelman }
965397b6df1SKris Buschelman 
966dfbe8321SBarry Smith PetscErrorCode MatDestroy_MUMPS(Mat A)
967dfbe8321SBarry Smith {
968a6053eceSJunchao Zhang   Mat_MUMPS      *mumps=(Mat_MUMPS*)A->data;
969b24902e0SBarry Smith 
970397b6df1SKris Buschelman   PetscFunctionBegin;
9719566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc,mumps->id.isol_loc));
9729566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
9739566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
9749566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
9759566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
9769566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
9779566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn,mumps->jcn));
9789566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
9799566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
9809566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
981a5e57a09SHong Zhang   mumps->id.job = JOB_END;
9823ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
98308401ef6SPierre Jolivet   PetscCheck(mumps->id.INFOG(1) >= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in MatDestroy_MUMPS: INFOG(1)=%d",mumps->id.INFOG(1));
9843ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
98567602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
9869566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
9879566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc,mumps->rhs_recvbuf));
9889566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow,mumps->rhs_recvcounts,mumps->rhs_disps));
98967602552SJunchao Zhang   }
9903ab56b82SJunchao Zhang #endif
9919566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
9929566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
9939566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
9949566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
9959566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
9969566063dSJacob Faibussowitsch   if (mumps->mumps_comm != MPI_COMM_NULL) PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A),&mumps->mumps_comm));
9979566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
998bf0cc555SLisandro Dalcin 
99997969023SHong Zhang   /* clear composed functions */
10009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatFactorGetSolverType_C",NULL));
10019566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatFactorSetSchurIS_C",NULL));
10029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatFactorCreateSchurComplement_C",NULL));
10039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsSetIcntl_C",NULL));
10049566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetIcntl_C",NULL));
10059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsSetCntl_C",NULL));
10069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetCntl_C",NULL));
10079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetInfo_C",NULL));
10089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetInfog_C",NULL));
10099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetRinfo_C",NULL));
10109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetRinfog_C",NULL));
10119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetInverse_C",NULL));
10129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A,"MatMumpsGetInverseTranspose_C",NULL));
1013397b6df1SKris Buschelman   PetscFunctionReturn(0);
1014397b6df1SKris Buschelman }
1015397b6df1SKris Buschelman 
101667602552SJunchao Zhang /* Set up the distributed RHS info for MUMPS. <nrhs> is the number of RHS. <array> points to start of RHS on the local processor. */
101767602552SJunchao Zhang static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A,PetscInt nrhs,const PetscScalar *array)
101867602552SJunchao Zhang {
101967602552SJunchao Zhang   Mat_MUMPS          *mumps=(Mat_MUMPS*)A->data;
102067602552SJunchao Zhang   const PetscMPIInt  ompsize=mumps->omp_comm_size;
102167602552SJunchao Zhang   PetscInt           i,m,M,rstart;
102267602552SJunchao Zhang 
102367602552SJunchao Zhang   PetscFunctionBegin;
10249566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A,&M,NULL));
10259566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A,&m,NULL));
102608401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"PetscInt too long for PetscMUMPSInt");
102767602552SJunchao Zhang   if (ompsize == 1) {
102867602552SJunchao Zhang     if (!mumps->irhs_loc) {
102967602552SJunchao Zhang       mumps->nloc_rhs = m;
10309566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m,&mumps->irhs_loc));
10319566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A,&rstart,NULL));
103267602552SJunchao Zhang       for (i=0; i<m; i++) mumps->irhs_loc[i] = rstart+i+1; /* use 1-based indices */
103367602552SJunchao Zhang     }
103467602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar*)array;
103567602552SJunchao Zhang   } else {
103667602552SJunchao Zhang   #if defined(PETSC_HAVE_OPENMP_SUPPORT)
103767602552SJunchao Zhang     const PetscInt  *ranges;
103867602552SJunchao Zhang     PetscMPIInt     j,k,sendcount,*petsc_ranks,*omp_ranks;
103967602552SJunchao Zhang     MPI_Group       petsc_group,omp_group;
104067602552SJunchao Zhang     PetscScalar     *recvbuf=NULL;
104167602552SJunchao Zhang 
104267602552SJunchao Zhang     if (mumps->is_omp_master) {
104367602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
104467602552SJunchao Zhang       if (!mumps->irhs_loc) {
10459566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize,&omp_ranks,ompsize,&petsc_ranks));
10469566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize,&mumps->rhs_nrow,ompsize,&mumps->rhs_recvcounts,ompsize,&mumps->rhs_disps));
10479566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm,&petsc_group));
10489566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm,&omp_group));
104967602552SJunchao Zhang         for (j=0; j<ompsize; j++) omp_ranks[j] = j;
10509566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group,ompsize,omp_ranks,petsc_group,petsc_ranks));
105167602552SJunchao Zhang 
105267602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
105367602552SJunchao Zhang         mumps->nloc_rhs = 0;
10549566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A,&ranges));
105567602552SJunchao Zhang         for (j=0; j<ompsize; j++) {
105667602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j]+1] - ranges[petsc_ranks[j]];
105767602552SJunchao Zhang           mumps->nloc_rhs   += mumps->rhs_nrow[j];
105867602552SJunchao Zhang         }
10599566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs,&mumps->irhs_loc));
106067602552SJunchao Zhang         for (j=k=0; j<ompsize; j++) {
106167602552SJunchao Zhang           for (i=ranges[petsc_ranks[j]]; i<ranges[petsc_ranks[j]+1]; i++,k++) mumps->irhs_loc[k] = i+1; /* uses 1-based indices */
106267602552SJunchao Zhang         }
106367602552SJunchao Zhang 
10649566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks,petsc_ranks));
10659566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
10669566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
106767602552SJunchao Zhang       }
106867602552SJunchao Zhang 
106967602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
107067602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
10719566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc,mumps->rhs_recvbuf));
10729566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs*nrhs,&mumps->rhs_loc,mumps->nloc_rhs*nrhs,&mumps->rhs_recvbuf));
107367602552SJunchao Zhang         mumps->max_nrhs = nrhs;
107467602552SJunchao Zhang       }
107567602552SJunchao Zhang 
107667602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
10779566063dSJacob Faibussowitsch       for (j=0; j<ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j]*nrhs,&mumps->rhs_recvcounts[j]));
107867602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
107967602552SJunchao Zhang       for (j=1; j<ompsize; j++) {
108067602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j-1] + mumps->rhs_recvcounts[j-1];
108108401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"PetscMPIInt overflow!");
108267602552SJunchao Zhang       }
108367602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
108467602552SJunchao Zhang     }
108567602552SJunchao Zhang 
10869566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m*nrhs,&sendcount));
10879566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array,sendcount,MPIU_SCALAR,recvbuf,mumps->rhs_recvcounts,mumps->rhs_disps,MPIU_SCALAR,0,mumps->omp_comm));
108867602552SJunchao Zhang 
108967602552SJunchao Zhang     if (mumps->is_omp_master) {
109067602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
109167602552SJunchao Zhang         PetscScalar *dst,*dstbase = mumps->rhs_loc;
109267602552SJunchao Zhang         for (j=0; j<ompsize; j++) {
109367602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
109467602552SJunchao Zhang           dst = dstbase;
109567602552SJunchao Zhang           for (i=0; i<nrhs; i++) {
10969566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst,src,mumps->rhs_nrow[j]));
109767602552SJunchao Zhang             src += mumps->rhs_nrow[j];
109867602552SJunchao Zhang             dst += mumps->nloc_rhs;
109967602552SJunchao Zhang           }
110067602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
110167602552SJunchao Zhang         }
110267602552SJunchao Zhang       }
110367602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar*)mumps->rhs_loc;
110467602552SJunchao Zhang     }
110567602552SJunchao Zhang   #endif /* PETSC_HAVE_OPENMP_SUPPORT */
110667602552SJunchao Zhang   }
110767602552SJunchao Zhang   mumps->id.nrhs     = nrhs;
110867602552SJunchao Zhang   mumps->id.nloc_rhs = mumps->nloc_rhs;
110967602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
111067602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
111167602552SJunchao Zhang   PetscFunctionReturn(0);
111267602552SJunchao Zhang }
111367602552SJunchao Zhang 
1114b24902e0SBarry Smith PetscErrorCode MatSolve_MUMPS(Mat A,Vec b,Vec x)
1115b24902e0SBarry Smith {
1116e69c285eSBarry Smith   Mat_MUMPS          *mumps=(Mat_MUMPS*)A->data;
111725aac85cSJunchao Zhang   const PetscScalar  *rarray = NULL;
1118d54de34fSKris Buschelman   PetscScalar        *array;
1119329ec9b3SHong Zhang   IS                 is_iden,is_petsc;
1120329ec9b3SHong Zhang   PetscInt           i;
1121cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1122883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE,cite2 = PETSC_FALSE;
1123397b6df1SKris Buschelman 
1124397b6df1SKris Buschelman   PetscFunctionBegin;
11259566063dSJacob Faibussowitsch   PetscCall(PetscCitationsRegister("@article{MUMPS01,\n  author = {P.~R. Amestoy and I.~S. Duff and J.-Y. L'Excellent and J. Koster},\n  title = {A fully asynchronous multifrontal solver using distributed dynamic scheduling},\n  journal = {SIAM Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",&cite1));
11269566063dSJacob Faibussowitsch   PetscCall(PetscCitationsRegister("@article{MUMPS02,\n  author = {P.~R. Amestoy and A. Guermouche and J.-Y. L'Excellent and S. Pralet},\n  title = {Hybrid scheduling for the parallel solution of linear systems},\n  journal = {Parallel Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",&cite2));
11272aca8efcSHong Zhang 
1128603e8f96SBarry Smith   if (A->factorerrortype) {
11299566063dSJacob Faibussowitsch     PetscCall(PetscInfo(A,"MatSolve is called with singular matrix factor, INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
11309566063dSJacob Faibussowitsch     PetscCall(VecSetInf(x));
11312aca8efcSHong Zhang     PetscFunctionReturn(0);
11322aca8efcSHong Zhang   }
11332aca8efcSHong Zhang 
1134a5e57a09SHong Zhang   mumps->id.nrhs = 1;
11352d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
113625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
113767602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
11389566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b,&rarray));
11399566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A,1,rarray));
114025aac85cSJunchao Zhang     } else {
114141ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
11429566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs,b,mumps->b_seq,INSERT_VALUES,SCATTER_FORWARD));
11439566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs,b,mumps->b_seq,INSERT_VALUES,SCATTER_FORWARD));
114467602552SJunchao Zhang       if (!mumps->myid) {
11459566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq,&array));
114667602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar*)array;
114767602552SJunchao Zhang       }
114825aac85cSJunchao Zhang     }
11493ab56b82SJunchao Zhang   } else {  /* petsc_size == 1 */
115067602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
11519566063dSJacob Faibussowitsch     PetscCall(VecCopy(b,x));
11529566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x,&array));
1153940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar*)array;
1154397b6df1SKris Buschelman   }
1155397b6df1SKris Buschelman 
1156cc86f929SStefano Zampini   /*
1157cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1158cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1159cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1160cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1161cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1162cc86f929SStefano Zampini   */
1163583f777eSStefano Zampini   if (mumps->id.size_schur > 0 && (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2)) {
116408401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1,PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Parallel Schur complements not yet supported from PETSc");
1165cc86f929SStefano Zampini     second_solve = PETSC_TRUE;
11669566063dSJacob Faibussowitsch     PetscCall(MatMumpsHandleSchur_Private(A,PETSC_FALSE));
1167cc86f929SStefano Zampini   }
1168397b6df1SKris Buschelman   /* solve phase */
1169329ec9b3SHong Zhang   /*-------------*/
1170a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
11713ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
117208401ef6SPierre Jolivet   PetscCheck(mumps->id.INFOG(1) >= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in solve phase: INFOG(1)=%d",mumps->id.INFOG(1));
1173397b6df1SKris Buschelman 
1174b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
1175cc86f929SStefano Zampini   if (second_solve) {
11769566063dSJacob Faibussowitsch     PetscCall(MatMumpsHandleSchur_Private(A,PETSC_TRUE));
1177cc86f929SStefano Zampini   }
1178b5fa320bSStefano Zampini 
11792d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to petsc mpi x */
1180a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1181a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
11829566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1183397b6df1SKris Buschelman     }
1184a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1185a6053eceSJunchao Zhang       PetscInt *isol2_loc=NULL;
11869566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF,mumps->id.lsol_loc,0,1,&is_iden)); /* from */
11879566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc,&isol2_loc));
1188a6053eceSJunchao Zhang       for (i=0; i<mumps->id.lsol_loc; i++) isol2_loc[i] = mumps->id.isol_loc[i]-1; /* change Fortran style to C style */
11899566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF,mumps->id.lsol_loc,isol2_loc,PETSC_OWN_POINTER,&is_petsc));  /* to */
11909566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq,is_iden,x,is_petsc,&mumps->scat_sol));
11919566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
11929566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1193a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1194397b6df1SKris Buschelman     }
1195a5e57a09SHong Zhang 
11969566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol,mumps->x_seq,x,INSERT_VALUES,SCATTER_FORWARD));
11979566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol,mumps->x_seq,x,INSERT_VALUES,SCATTER_FORWARD));
1198329ec9b3SHong Zhang   }
1199353d7d71SJunchao Zhang 
120067602552SJunchao Zhang   if (mumps->petsc_size > 1) {
120125aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
12029566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b,&rarray));
120325aac85cSJunchao Zhang     } else if (!mumps->myid) {
12049566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq,&array));
120525aac85cSJunchao Zhang     }
12069566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x,&array));
1207353d7d71SJunchao Zhang 
12089566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(2.0*mumps->id.RINFO(3)));
1209397b6df1SKris Buschelman   PetscFunctionReturn(0);
1210397b6df1SKris Buschelman }
1211397b6df1SKris Buschelman 
121251d5961aSHong Zhang PetscErrorCode MatSolveTranspose_MUMPS(Mat A,Vec b,Vec x)
121351d5961aSHong Zhang {
1214e69c285eSBarry Smith   Mat_MUMPS      *mumps=(Mat_MUMPS*)A->data;
121551d5961aSHong Zhang 
121651d5961aSHong Zhang   PetscFunctionBegin;
1217a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
12189566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A,b,x));
1219a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 1;
122051d5961aSHong Zhang   PetscFunctionReturn(0);
122151d5961aSHong Zhang }
122251d5961aSHong Zhang 
1223e0b74bf9SHong Zhang PetscErrorCode MatMatSolve_MUMPS(Mat A,Mat B,Mat X)
1224e0b74bf9SHong Zhang {
1225b8491c3eSStefano Zampini   Mat               Bt = NULL;
1226a6053eceSJunchao Zhang   PetscBool         denseX,denseB,flg,flgT;
1227e69c285eSBarry Smith   Mat_MUMPS         *mumps=(Mat_MUMPS*)A->data;
1228334c5f61SHong Zhang   PetscInt          i,nrhs,M;
12291683a169SBarry Smith   PetscScalar       *array;
12301683a169SBarry Smith   const PetscScalar *rbray;
1231a6053eceSJunchao Zhang   PetscInt          lsol_loc,nlsol_loc,*idxx,iidx = 0;
1232a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc,*isol_loc_save;
12331683a169SBarry Smith   PetscScalar       *bray,*sol_loc,*sol_loc_save;
1234be818407SHong Zhang   IS                is_to,is_from;
1235beae5ec0SHong Zhang   PetscInt          k,proc,j,m,myrstart;
1236be818407SHong Zhang   const PetscInt    *rstart;
123767602552SJunchao Zhang   Vec               v_mpi,msol_loc;
123867602552SJunchao Zhang   VecScatter        scat_sol;
123967602552SJunchao Zhang   Vec               b_seq;
124067602552SJunchao Zhang   VecScatter        scat_rhs;
1241be818407SHong Zhang   PetscScalar       *aa;
1242be818407SHong Zhang   PetscInt          spnr,*ia,*ja;
1243d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1244bda8bf91SBarry Smith 
1245e0b74bf9SHong Zhang   PetscFunctionBegin;
12469566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X,&denseX,MATSEQDENSE,MATMPIDENSE,NULL));
124728b400f6SJacob Faibussowitsch   PetscCheck(denseX,PetscObjectComm((PetscObject)X),PETSC_ERR_ARG_WRONG,"Matrix X must be MATDENSE matrix");
1248be818407SHong Zhang 
12499566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B,&denseB,MATSEQDENSE,MATMPIDENSE,NULL));
1250a6053eceSJunchao Zhang   if (denseB) {
125108401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Matrix B and X must have same row distribution");
1252be818407SHong Zhang     mumps->id.ICNTL(20)= 0; /* dense RHS */
12530e6b8875SHong Zhang   } else { /* sparse B */
125408401ef6SPierre Jolivet     PetscCheck(X != B,PetscObjectComm((PetscObject)A),PETSC_ERR_ARG_IDN,"X and B must be different matrices");
12559566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)B,MATTRANSPOSEMAT,&flgT));
12560e6b8875SHong Zhang     if (flgT) { /* input B is transpose of actural RHS matrix,
12570e6b8875SHong Zhang                  because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
12589566063dSJacob Faibussowitsch       PetscCall(MatTransposeGetMat(B,&Bt));
12590f52d626SJunchao Zhang     } else SETERRQ(PetscObjectComm((PetscObject)B),PETSC_ERR_ARG_WRONG,"Matrix B must be MATTRANSPOSEMAT matrix");
1260be818407SHong Zhang     mumps->id.ICNTL(20)= 1; /* sparse RHS */
1261b8491c3eSStefano Zampini   }
126287b22cf4SHong Zhang 
12639566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B,&M,&nrhs));
12649481e6e9SHong Zhang   mumps->id.nrhs = nrhs;
12659481e6e9SHong Zhang   mumps->id.lrhs = M;
12662b691707SHong Zhang   mumps->id.rhs  = NULL;
12679481e6e9SHong Zhang 
12682d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1269b8491c3eSStefano Zampini     PetscScalar *aa;
1270b8491c3eSStefano Zampini     PetscInt    spnr,*ia,*ja;
1271e94cce23SStefano Zampini     PetscBool   second_solve = PETSC_FALSE;
1272b8491c3eSStefano Zampini 
12739566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X,&array));
1274b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar*)array;
12752b691707SHong Zhang 
1276a6053eceSJunchao Zhang     if (denseB) {
12772b691707SHong Zhang       /* copy B to X */
12789566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B,&rbray));
12799566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array,rbray,M*nrhs));
12809566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B,&rbray));
12812b691707SHong Zhang     } else { /* sparse B */
12829566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt,&aa));
12839566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt,1,PETSC_FALSE,PETSC_FALSE,&spnr,(const PetscInt**)&ia,(const PetscInt**)&ja,&flg));
128428b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot get IJ structure");
12859566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps,spnr,ia,ja,&mumps->id.irhs_ptr,&mumps->id.irhs_sparse,&mumps->id.nz_rhs));
1286b8491c3eSStefano Zampini       mumps->id.rhs_sparse  = (MumpsScalar*)aa;
1287b8491c3eSStefano Zampini     }
1288e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
1289583f777eSStefano Zampini     if (mumps->id.size_schur > 0 && (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2)) {
1290e94cce23SStefano Zampini       second_solve = PETSC_TRUE;
12919566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A,PETSC_FALSE));
1292e94cce23SStefano Zampini     }
12932cd7d884SHong Zhang     /* solve phase */
12942cd7d884SHong Zhang     /*-------------*/
12952cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
12963ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
129708401ef6SPierre Jolivet     PetscCheck(mumps->id.INFOG(1) >= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in solve phase: INFOG(1)=%d",mumps->id.INFOG(1));
1298b5fa320bSStefano Zampini 
1299b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
1300e94cce23SStefano Zampini     if (second_solve) {
13019566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A,PETSC_TRUE));
1302e94cce23SStefano Zampini     }
1303a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
13049566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt,&aa));
13059566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt,1,PETSC_FALSE,PETSC_FALSE,&spnr,(const PetscInt**)&ia,(const PetscInt**)&ja,&flg));
130628b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot restore IJ structure");
1307b8491c3eSStefano Zampini     }
13089566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X,&array));
1309be818407SHong Zhang     PetscFunctionReturn(0);
1310be818407SHong Zhang   }
1311801fbe65SHong Zhang 
1312be818407SHong Zhang   /*--------- parallel case: MUMPS requires rhs B to be centralized on the host! --------*/
1313aed4548fSBarry Smith   PetscCheck(mumps->petsc_size <= 1 || !mumps->id.ICNTL(19),PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"Parallel Schur complements not yet supported from PETSc");
1314241dbb5eSStefano Zampini 
1315beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
13161683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
13171683a169SBarry Smith   sol_loc_save  = (PetscScalar*)mumps->id.sol_loc;
1318801fbe65SHong Zhang 
1319a1dfcbd9SJunchao Zhang   lsol_loc  = mumps->id.lsol_loc;
132071aed81dSHong Zhang   nlsol_loc = nrhs*lsol_loc;     /* length of sol_loc */
13219566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc,&sol_loc,lsol_loc,&isol_loc));
1322940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar*)sol_loc;
1323801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1324801fbe65SHong Zhang 
13259566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF,1,nlsol_loc,(PetscScalar*)sol_loc,&msol_loc));
13262cd7d884SHong Zhang 
132767602552SJunchao Zhang   if (denseB) {
132825aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
132967602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
13309566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B,&rbray));
13319566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A,nrhs,rbray));
13329566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B,&rbray));
13339566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B,&m,NULL));
13349566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B),1,nrhs*m,nrhs*M,NULL,&v_mpi));
133525aac85cSJunchao Zhang     } else {
133625aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
133780577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
133880577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
133980577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
134080577c12SJunchao Zhang       */
134180577c12SJunchao Zhang 
134267602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1343be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
13449566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B,&m,NULL));
13459566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B,&bray));
13469566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B),1,nrhs*m,nrhs*M,(const PetscScalar*)bray,&v_mpi));
13479566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B,&bray));
13482b691707SHong Zhang 
1349be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1350801fbe65SHong Zhang       if (!mumps->myid) {
1351beae5ec0SHong Zhang         PetscInt *idx;
1352beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
13539566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nrhs*M,&idx));
13549566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B,&rstart));
1355be818407SHong Zhang         k = 0;
13562d4298aeSJunchao Zhang         for (proc=0; proc<mumps->petsc_size; proc++) {
1357be818407SHong Zhang           for (j=0; j<nrhs; j++) {
1358beae5ec0SHong Zhang             for (i=rstart[proc]; i<rstart[proc+1]; i++) idx[k++] = j*M + i;
1359be818407SHong Zhang           }
1360be818407SHong Zhang         }
1361be818407SHong Zhang 
13629566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF,nrhs*M,&b_seq));
13639566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PETSC_COMM_SELF,nrhs*M,idx,PETSC_OWN_POINTER,&is_to));
13649566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF,nrhs*M,0,1,&is_from));
1365801fbe65SHong Zhang       } else {
13669566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF,0,&b_seq));
13679566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF,0,0,1,&is_to));
13689566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF,0,0,1,&is_from));
1369801fbe65SHong Zhang       }
13709566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi,is_from,b_seq,is_to,&scat_rhs));
13719566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs,v_mpi,b_seq,INSERT_VALUES,SCATTER_FORWARD));
13729566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
13739566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
13749566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs,v_mpi,b_seq,INSERT_VALUES,SCATTER_FORWARD));
1375801fbe65SHong Zhang 
1376801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
13779566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq,&bray));
1378940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar*)bray;
13799566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq,&bray));
1380801fbe65SHong Zhang       }
138125aac85cSJunchao Zhang     }
13822b691707SHong Zhang   } else { /* sparse B */
13832b691707SHong Zhang     b = (Mat_MPIAIJ*)Bt->data;
13842b691707SHong Zhang 
1385be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
13869566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X,&m,NULL));
13879566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X,&bray));
13889566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X),1,nrhs*m,nrhs*M,(const PetscScalar*)bray,&v_mpi));
13899566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X,&bray));
13902b691707SHong Zhang 
13912b691707SHong Zhang     if (!mumps->myid) {
13929566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A,&aa));
13939566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A,1,PETSC_FALSE,PETSC_FALSE,&spnr,(const PetscInt**)&ia,(const PetscInt**)&ja,&flg));
139428b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot get IJ structure");
13959566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps,spnr,ia,ja,&mumps->id.irhs_ptr,&mumps->id.irhs_sparse,&mumps->id.nz_rhs));
13962b691707SHong Zhang       mumps->id.rhs_sparse  = (MumpsScalar*)aa;
13972b691707SHong Zhang     } else {
13982b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
13992b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
14002b691707SHong Zhang       mumps->id.nz_rhs      = 0;
14012b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
14022b691707SHong Zhang     }
14032b691707SHong Zhang   }
14042b691707SHong Zhang 
1405801fbe65SHong Zhang   /* solve phase */
1406801fbe65SHong Zhang   /*-------------*/
1407801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
14083ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
140908401ef6SPierre Jolivet   PetscCheck(mumps->id.INFOG(1) >= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in solve phase: INFOG(1)=%d",mumps->id.INFOG(1));
1410801fbe65SHong Zhang 
1411334c5f61SHong Zhang   /* scatter mumps distributed solution to petsc vector v_mpi, which shares local arrays with solution matrix X */
14129566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X,&array));
14139566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi,array));
1414801fbe65SHong Zhang 
1415334c5f61SHong Zhang   /* create scatter scat_sol */
14169566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X,&rstart));
1417beae5ec0SHong Zhang   /* iidx: index for scatter mumps solution to petsc X */
1418beae5ec0SHong Zhang 
14199566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF,nlsol_loc,0,1,&is_from));
14209566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc,&idxx));
1421beae5ec0SHong Zhang   for (i=0; i<lsol_loc; i++) {
1422beae5ec0SHong Zhang     isol_loc[i] -= 1; /* change Fortran style to C style. isol_loc[i+j*lsol_loc] contains x[isol_loc[i]] in j-th vector */
1423beae5ec0SHong Zhang 
14242d4298aeSJunchao Zhang     for (proc=0; proc<mumps->petsc_size; proc++) {
1425beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc+1]) {
1426beae5ec0SHong Zhang         myrstart = rstart[proc];
1427beae5ec0SHong Zhang         k        = isol_loc[i] - myrstart;        /* local index on 1st column of petsc vector X */
1428beae5ec0SHong Zhang         iidx     = k + myrstart*nrhs;             /* maps mumps isol_loc[i] to petsc index in X */
1429beae5ec0SHong Zhang         m        = rstart[proc+1] - rstart[proc]; /* rows of X for this proc */
1430beae5ec0SHong Zhang         break;
1431be818407SHong Zhang       }
1432be818407SHong Zhang     }
1433be818407SHong Zhang 
1434beae5ec0SHong Zhang     for (j=0; j<nrhs; j++) idxx[i+j*lsol_loc] = iidx + j*m;
1435801fbe65SHong Zhang   }
14369566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF,nlsol_loc,idxx,PETSC_COPY_VALUES,&is_to));
14379566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc,is_from,v_mpi,is_to,&scat_sol));
14389566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol,msol_loc,v_mpi,INSERT_VALUES,SCATTER_FORWARD));
14399566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
14409566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
14419566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol,msol_loc,v_mpi,INSERT_VALUES,SCATTER_FORWARD));
14429566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X,&array));
144371aed81dSHong Zhang 
144471aed81dSHong Zhang   /* free spaces */
14451683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar*)sol_loc_save;
144671aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
144771aed81dSHong Zhang 
14489566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc,isol_loc));
14499566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
14509566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
14519566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1452a6053eceSJunchao Zhang   if (!denseB) {
14532b691707SHong Zhang     if (!mumps->myid) {
1454d56c302dSHong Zhang       b = (Mat_MPIAIJ*)Bt->data;
14559566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A,&aa));
14569566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A,1,PETSC_FALSE,PETSC_FALSE,&spnr,(const PetscInt**)&ia,(const PetscInt**)&ja,&flg));
145728b400f6SJacob Faibussowitsch       PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot restore IJ structure");
14582b691707SHong Zhang     }
14592b691707SHong Zhang   } else {
146025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
14619566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
14629566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
146325aac85cSJunchao Zhang     }
14642b691707SHong Zhang   }
14659566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
14669566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(2.0*nrhs*mumps->id.RINFO(3)));
1467e0b74bf9SHong Zhang   PetscFunctionReturn(0);
1468e0b74bf9SHong Zhang }
1469e0b74bf9SHong Zhang 
1470eb3ef3b2SHong Zhang PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A,Mat Bt,Mat X)
1471eb3ef3b2SHong Zhang {
1472eb3ef3b2SHong Zhang   PetscBool      flg;
1473eb3ef3b2SHong Zhang   Mat            B;
1474eb3ef3b2SHong Zhang 
1475eb3ef3b2SHong Zhang   PetscFunctionBegin;
14769566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt,&flg,MATSEQAIJ,MATMPIAIJ,NULL));
147728b400f6SJacob Faibussowitsch   PetscCheck(flg,PetscObjectComm((PetscObject)Bt),PETSC_ERR_ARG_WRONG,"Matrix Bt must be MATAIJ matrix");
1478eb3ef3b2SHong Zhang 
1479eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
14809566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt,&B));
1481eb3ef3b2SHong Zhang 
14829566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A,B,X));
14839566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
1484eb3ef3b2SHong Zhang   PetscFunctionReturn(0);
1485eb3ef3b2SHong Zhang }
1486eb3ef3b2SHong Zhang 
1487ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1488a58c3f20SHong Zhang /*
1489a58c3f20SHong Zhang   input:
1490a58c3f20SHong Zhang    F:        numeric factor
1491a58c3f20SHong Zhang   output:
1492a58c3f20SHong Zhang    nneg:     total number of negative pivots
149319d49a3bSHong Zhang    nzero:    total number of zero pivots
149419d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1495a58c3f20SHong Zhang */
1496a6053eceSJunchao Zhang PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F,PetscInt *nneg,PetscInt *nzero,PetscInt *npos)
1497a58c3f20SHong Zhang {
1498e69c285eSBarry Smith   Mat_MUMPS      *mumps =(Mat_MUMPS*)F->data;
1499c1490034SHong Zhang   PetscMPIInt    size;
1500a58c3f20SHong Zhang 
1501a58c3f20SHong Zhang   PetscFunctionBegin;
15029566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F),&size));
1503bcb30aebSHong Zhang   /* MUMPS 4.3.1 calls ScaLAPACK when ICNTL(13)=0 (default), which does not offer the possibility to compute the inertia of a dense matrix. Set ICNTL(13)=1 to skip ScaLAPACK */
1504aed4548fSBarry Smith   PetscCheck(size <= 1 || mumps->id.ICNTL(13) == 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"ICNTL(13)=%d. -mat_mumps_icntl_13 must be set as 1 for correct global matrix inertia",mumps->id.INFOG(13));
1505ed85ac9fSHong Zhang 
1506710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1507ed85ac9fSHong Zhang   if (nzero || npos) {
150808401ef6SPierre Jolivet     PetscCheck(mumps->id.ICNTL(24) == 1,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"-mat_mumps_icntl_24 must be set as 1 for null pivot row detection");
1509710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1510710ac8efSHong Zhang     if (npos) *npos   = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1511a58c3f20SHong Zhang   }
1512a58c3f20SHong Zhang   PetscFunctionReturn(0);
1513a58c3f20SHong Zhang }
151419d49a3bSHong Zhang #endif
1515a58c3f20SHong Zhang 
15163ab56b82SJunchao Zhang PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse,Mat_MUMPS *mumps)
15173ab56b82SJunchao Zhang {
1518a6053eceSJunchao Zhang   PetscInt       i,nreqs;
1519a6053eceSJunchao Zhang   PetscMUMPSInt  *irn,*jcn;
1520a6053eceSJunchao Zhang   PetscMPIInt    count;
1521a6053eceSJunchao Zhang   PetscInt64     totnnz,remain;
1522a6053eceSJunchao Zhang   const PetscInt osize=mumps->omp_comm_size;
1523a6053eceSJunchao Zhang   PetscScalar    *val;
15243ab56b82SJunchao Zhang 
15253ab56b82SJunchao Zhang   PetscFunctionBegin;
1526a6053eceSJunchao Zhang   if (osize > 1) {
15273ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
15283ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
15299566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize,&mumps->recvcount));
15309566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz,1,MPIU_INT64,mumps->recvcount,1,MPIU_INT64,0/*master*/,mumps->omp_comm));
15313ab56b82SJunchao Zhang 
1532a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
15333ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1534a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1535a6053eceSJunchao Zhang         nreqs = 0;
1536a6053eceSJunchao Zhang         for (i=1; i<osize; i++) nreqs += (mumps->recvcount[i]+PETSC_MPI_INT_MAX-1)/PETSC_MPI_INT_MAX;
1537a6053eceSJunchao Zhang       } else {
1538a6053eceSJunchao Zhang         nreqs = (mumps->nnz+PETSC_MPI_INT_MAX-1)/PETSC_MPI_INT_MAX;
15393ab56b82SJunchao Zhang       }
15409566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nreqs*3,&mumps->reqs)); /* Triple the requests since we send irn, jcn and val seperately */
15413ab56b82SJunchao Zhang 
1542a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1543a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1544a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1545a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1546a6053eceSJunchao Zhang        */
1547a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
15483ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1549a6053eceSJunchao Zhang         for (i=0,totnnz=0; i<osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
15509566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz,&irn,totnnz,&jcn));
15519566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz,&val));
1552a6053eceSJunchao Zhang 
1553a6053eceSJunchao Zhang         /* Self communication */
15549566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn,mumps->irn,mumps->nnz));
15559566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn,mumps->jcn,mumps->nnz));
15569566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val,mumps->val,mumps->nnz));
1557a6053eceSJunchao Zhang 
1558a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
15599566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn,mumps->jcn));
15609566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1561a6053eceSJunchao Zhang         mumps->nnz = totnnz;
15623ab56b82SJunchao Zhang         mumps->irn = irn;
15633ab56b82SJunchao Zhang         mumps->jcn = jcn;
1564a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1565a6053eceSJunchao Zhang 
1566a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
1567a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
1568a6053eceSJunchao Zhang         val += mumps->recvcount[0];
1569a6053eceSJunchao Zhang 
1570a6053eceSJunchao Zhang         /* Remote communication */
1571a6053eceSJunchao Zhang         for (i=1; i<osize; i++) {
1572a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i],PETSC_MPI_INT_MAX);
1573a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1574a6053eceSJunchao Zhang           while (count>0) {
15759566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(irn,count,MPIU_MUMPSINT,i,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
15769566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(jcn,count,MPIU_MUMPSINT,i,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
15779566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val,count,MPIU_SCALAR,  i,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
1578a6053eceSJunchao Zhang             irn    += count;
1579a6053eceSJunchao Zhang             jcn    += count;
1580a6053eceSJunchao Zhang             val    += count;
1581a6053eceSJunchao Zhang             count   = PetscMin(remain,PETSC_MPI_INT_MAX);
1582a6053eceSJunchao Zhang             remain -= count;
1583a6053eceSJunchao Zhang           }
15843ab56b82SJunchao Zhang         }
15853ab56b82SJunchao Zhang       } else {
1586a6053eceSJunchao Zhang         irn    = mumps->irn;
1587a6053eceSJunchao Zhang         jcn    = mumps->jcn;
1588a6053eceSJunchao Zhang         val    = mumps->val;
1589a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz,PETSC_MPI_INT_MAX);
1590a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1591a6053eceSJunchao Zhang         while (count>0) {
15929566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(irn,count,MPIU_MUMPSINT,0,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
15939566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(jcn,count,MPIU_MUMPSINT,0,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
15949566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val,count,MPIU_SCALAR,  0,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
1595a6053eceSJunchao Zhang           irn    += count;
1596a6053eceSJunchao Zhang           jcn    += count;
1597a6053eceSJunchao Zhang           val    += count;
1598a6053eceSJunchao Zhang           count   = PetscMin(remain,PETSC_MPI_INT_MAX);
1599a6053eceSJunchao Zhang           remain -= count;
16003ab56b82SJunchao Zhang         }
16013ab56b82SJunchao Zhang       }
1602a6053eceSJunchao Zhang     } else {
1603a6053eceSJunchao Zhang       nreqs = 0;
1604a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
1605a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
1606a6053eceSJunchao Zhang         for (i=1; i<osize; i++) { /* Remote communication only since self data is already in place */
1607a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i],PETSC_MPI_INT_MAX);
1608a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1609a6053eceSJunchao Zhang           while (count>0) {
16109566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val,count,MPIU_SCALAR,i,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
1611a6053eceSJunchao Zhang             val    += count;
1612a6053eceSJunchao Zhang             count   = PetscMin(remain,PETSC_MPI_INT_MAX);
1613a6053eceSJunchao Zhang             remain -= count;
1614a6053eceSJunchao Zhang           }
1615a6053eceSJunchao Zhang         }
1616a6053eceSJunchao Zhang       } else {
1617a6053eceSJunchao Zhang         val    = mumps->val;
1618a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz,PETSC_MPI_INT_MAX);
1619a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1620a6053eceSJunchao Zhang         while (count>0) {
16219566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val,count,MPIU_SCALAR,0,mumps->tag,mumps->omp_comm,&mumps->reqs[nreqs++]));
1622a6053eceSJunchao Zhang           val    += count;
1623a6053eceSJunchao Zhang           count   = PetscMin(remain,PETSC_MPI_INT_MAX);
1624a6053eceSJunchao Zhang           remain -= count;
1625a6053eceSJunchao Zhang         }
1626a6053eceSJunchao Zhang       }
1627a6053eceSJunchao Zhang     }
16289566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs,mumps->reqs,MPI_STATUSES_IGNORE));
1629a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
1630a6053eceSJunchao Zhang   }
16313ab56b82SJunchao Zhang   PetscFunctionReturn(0);
16323ab56b82SJunchao Zhang }
16333ab56b82SJunchao Zhang 
16340481f469SBarry Smith PetscErrorCode MatFactorNumeric_MUMPS(Mat F,Mat A,const MatFactorInfo *info)
1635af281ebdSHong Zhang {
1636e69c285eSBarry Smith   Mat_MUMPS      *mumps =(Mat_MUMPS*)(F)->data;
1637ace3abfcSBarry Smith   PetscBool      isMPIAIJ;
1638397b6df1SKris Buschelman 
1639397b6df1SKris Buschelman   PetscFunctionBegin;
1640dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
16412aca8efcSHong Zhang     if (mumps->id.INFOG(1) == -6) {
16429566063dSJacob Faibussowitsch       PetscCall(PetscInfo(A,"MatFactorNumeric is called with singular matrix structure, INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
16436baea169SHong Zhang     }
16449566063dSJacob Faibussowitsch     PetscCall(PetscInfo(A,"MatFactorNumeric is called after analysis phase fails, INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
16452aca8efcSHong Zhang     PetscFunctionReturn(0);
16462aca8efcSHong Zhang   }
16476baea169SHong Zhang 
16489566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
16499566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX,mumps));
1650397b6df1SKris Buschelman 
1651397b6df1SKris Buschelman   /* numerical factorization phase */
1652329ec9b3SHong Zhang   /*-------------------------------*/
1653a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
16544e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
1655a5e57a09SHong Zhang     if (!mumps->myid) {
1656940cd9d6SSatish Balay       mumps->id.a = (MumpsScalar*)mumps->val;
1657397b6df1SKris Buschelman     }
1658397b6df1SKris Buschelman   } else {
1659940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar*)mumps->val;
1660397b6df1SKris Buschelman   }
16613ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1662a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
1663c0d63f2fSHong Zhang     if (A->erroriffailure) {
166498921bdaSJacob Faibussowitsch       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in numerical factorization phase: INFOG(1)=%d, INFO(2)=%d",mumps->id.INFOG(1),mumps->id.INFO(2));
1665151787a6SHong Zhang     } else {
1666c0d63f2fSHong Zhang       if (mumps->id.INFOG(1) == -10) { /* numerically singular matrix */
16679566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"matrix is numerically singular, INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1668603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
1669c0d63f2fSHong Zhang       } else if (mumps->id.INFOG(1) == -13) {
16709566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"MUMPS in numerical factorization phase: INFOG(1)=%d, cannot allocate required memory %d megabytes\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1671603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1672c0d63f2fSHong Zhang       } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
16739566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"MUMPS in numerical factorization phase: INFOG(1)=%d, INFO(2)=%d, problem with workarray \n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1674603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_OUTMEMORY;
16752aca8efcSHong Zhang       } else {
16769566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"MUMPS in numerical factorization phase: INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1677603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_OTHER;
1678151787a6SHong Zhang       }
16792aca8efcSHong Zhang     }
1680397b6df1SKris Buschelman   }
1681aed4548fSBarry Smith   PetscCheck(mumps->myid || mumps->id.ICNTL(16) <= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"  mumps->id.ICNTL(16):=%d",mumps->id.INFOG(16));
1682397b6df1SKris Buschelman 
1683b3cb21ddSStefano Zampini   F->assembled    = PETSC_TRUE;
1684d47f36abSHong Zhang 
1685b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
16863cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
1687c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
16883cb7dd0eSStefano Zampini #endif
1689b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
1690b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
16919566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur,MAT_INPLACE_MATRIX,&F->schur));
1692b3cb21ddSStefano Zampini     }
16939566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F,NULL,MAT_FACTOR_SCHUR_UNFACTORED));
1694b3cb21ddSStefano Zampini   }
169567877ebaSShri Abhyankar 
1696066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
1697066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
1698066565c5SStefano Zampini 
16993ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
17002d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
170167877ebaSShri Abhyankar     PetscInt    lsol_loc;
170267877ebaSShri Abhyankar     PetscScalar *sol_loc;
17032205254eSKarl Rupp 
17049566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A,MATMPIAIJ,&isMPIAIJ));
1705c2093ab7SHong Zhang 
1706c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
1707c2093ab7SHong Zhang     if (mumps->x_seq) {
17089566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
17099566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc,mumps->id.isol_loc));
17109566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
1711c2093ab7SHong Zhang     }
1712a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
17139566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc,&sol_loc,lsol_loc,&mumps->id.isol_loc));
1714a5e57a09SHong Zhang     mumps->id.lsol_loc = lsol_loc;
1715940cd9d6SSatish Balay     mumps->id.sol_loc = (MumpsScalar*)sol_loc;
17169566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF,1,lsol_loc,sol_loc,&mumps->x_seq));
171767877ebaSShri Abhyankar   }
17189566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(mumps->id.RINFO(2)));
1719397b6df1SKris Buschelman   PetscFunctionReturn(0);
1720397b6df1SKris Buschelman }
1721397b6df1SKris Buschelman 
17229a2535b5SHong Zhang /* Sets MUMPS options from the options database */
1723*26cc229bSBarry Smith PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
1724dcd589f8SShri Abhyankar {
1725e69c285eSBarry Smith   Mat_MUMPS      *mumps = (Mat_MUMPS*)F->data;
1726a6053eceSJunchao Zhang   PetscMUMPSInt  icntl=0;
172745e3843bSPierre Jolivet   PetscInt       info[80],i,ninfo=80,rbs,cbs;
1728a6053eceSJunchao Zhang   PetscBool      flg=PETSC_FALSE;
1729dcd589f8SShri Abhyankar 
1730dcd589f8SShri Abhyankar   PetscFunctionBegin;
1731*26cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F),((PetscObject)F)->prefix,"MUMPS Options","Mat");
17329566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1","ICNTL(1): output stream for error messages","None",mumps->id.ICNTL(1),&icntl,&flg));
17339a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
17349566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2","ICNTL(2): output stream for diagnostic printing, statistics, and warning","None",mumps->id.ICNTL(2),&icntl,&flg));
17359a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
17369566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_3","ICNTL(3): output stream for global information, collected on the host","None",mumps->id.ICNTL(3),&icntl,&flg));
17379a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
1738dcd589f8SShri Abhyankar 
17399566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4","ICNTL(4): level of printing (0 to 4)","None",mumps->id.ICNTL(4),&icntl,&flg));
17409a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
17419a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
17429a2535b5SHong Zhang 
17439566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_6","ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)","None",mumps->id.ICNTL(6),&icntl,&flg));
17449a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
17459a2535b5SHong Zhang 
17469566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_7","ICNTL(7): computes a symmetric permutation in sequential analysis. 0=AMD, 2=AMF, 3=Scotch, 4=PORD, 5=Metis, 6=QAMD, and 7=auto(default)","None",mumps->id.ICNTL(7),&icntl,&flg));
1747dcd589f8SShri Abhyankar   if (flg) {
1748aed4548fSBarry Smith     PetscCheck(icntl != 1 && icntl >= 0 && icntl <= 7,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Valid values are 0=AMD, 2=AMF, 3=Scotch, 4=PORD, 5=Metis, 6=QAMD, and 7=auto");
1749b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
1750dcd589f8SShri Abhyankar   }
1751e0b74bf9SHong Zhang 
17529566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_8","ICNTL(8): scaling strategy (-2 to 8 or 77)","None",mumps->id.ICNTL(8),&mumps->id.ICNTL(8),NULL));
17539566063dSJacob Faibussowitsch   /* PetscCall(PetscOptionsInt("-mat_mumps_icntl_9","ICNTL(9): computes the solution using A or A^T","None",mumps->id.ICNTL(9),&mumps->id.ICNTL(9),NULL)); handled by MatSolveTranspose_MUMPS() */
17549566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10","ICNTL(10): max num of refinements","None",mumps->id.ICNTL(10),&mumps->id.ICNTL(10),NULL));
17559566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_11","ICNTL(11): statistics related to an error analysis (via -ksp_view)","None",mumps->id.ICNTL(11),&mumps->id.ICNTL(11),NULL));
17569566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_12","ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)","None",mumps->id.ICNTL(12),&mumps->id.ICNTL(12),NULL));
17579566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_13","ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting","None",mumps->id.ICNTL(13),&mumps->id.ICNTL(13),NULL));
17589566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_14","ICNTL(14): percentage increase in the estimated working space","None",mumps->id.ICNTL(14),&mumps->id.ICNTL(14),NULL));
175945e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A,&rbs,&cbs));
176045e3843bSPierre Jolivet   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = -rbs;
176145e3843bSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_15","ICNTL(15): compression of the input matrix resulting from a block format","None",mumps->id.ICNTL(15),&mumps->id.ICNTL(15),&flg));
176245e3843bSPierre Jolivet   if (flg) {
176345e3843bSPierre Jolivet     PetscCheck(mumps->id.ICNTL(15) <= 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"Positive -mat_mumps_icntl_15 not handled");
176445e3843bSPierre Jolivet     PetscCheck((-mumps->id.ICNTL(15) % cbs == 0) && (-mumps->id.ICNTL(15) % rbs == 0),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"The opposite of -mat_mumps_icntl_15 must be a multiple of the column and row blocksizes");
176545e3843bSPierre Jolivet   }
17669566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19","ICNTL(19): computes the Schur complement","None",mumps->id.ICNTL(19),&mumps->id.ICNTL(19),NULL));
176759ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
17689566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
17699566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
177059ac8732SStefano Zampini   }
177125aac85cSJunchao Zhang 
177243f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
177343f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
177425aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
177543f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
177643f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
177743f3b051SJunchao Zhang      In short, we could not use distributed RHS with MPICH until v4.0b1.
177825aac85cSJunchao Zhang    */
177943f3b051SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5,3,0) || (defined(PETSC_HAVE_MPICH_NUMVERSION) && (PETSC_HAVE_MPICH_NUMVERSION < 40000101))
178025aac85cSJunchao Zhang   mumps->ICNTL20 = 0;  /* Centralized dense RHS*/
178143f3b051SJunchao Zhang #else
178243f3b051SJunchao Zhang   mumps->ICNTL20 = 10; /* Distributed dense RHS*/
178325aac85cSJunchao Zhang #endif
17849566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_20","ICNTL(20): give mumps centralized (0) or distributed (10) dense right-hand sides","None",mumps->ICNTL20,&mumps->ICNTL20,&flg));
1785aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 == 10 || mumps->ICNTL20 == 0,PETSC_COMM_SELF,PETSC_ERR_SUP,"ICNTL(20)=%d is not supported by the PETSc/MUMPS interface. Allowed values are 0, 10",(int)mumps->ICNTL20);
178625aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5,3,0)
1787aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10,PETSC_COMM_SELF,PETSC_ERR_SUP,"ICNTL(20)=10 is not supported before MUMPS-5.3.0");
178825aac85cSJunchao Zhang #endif
17899566063dSJacob Faibussowitsch   /* PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_21","ICNTL(21): the distribution (centralized or distributed) of the solution vectors","None",mumps->id.ICNTL(21),&mumps->id.ICNTL(21),NULL)); we only use distributed solution vector */
17909a2535b5SHong Zhang 
17919566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_22","ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)","None",mumps->id.ICNTL(22),&mumps->id.ICNTL(22),NULL));
17929566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_23","ICNTL(23): max size of the working memory (MB) that can allocate per processor","None",mumps->id.ICNTL(23),&mumps->id.ICNTL(23),NULL));
17939566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_24","ICNTL(24): detection of null pivot rows (0 or 1)","None",mumps->id.ICNTL(24),&mumps->id.ICNTL(24),NULL));
17949a2535b5SHong Zhang   if (mumps->id.ICNTL(24)) {
17959a2535b5SHong Zhang     mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */
1796d7ebd59bSHong Zhang   }
1797d7ebd59bSHong Zhang 
17989566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_25","ICNTL(25): computes a solution of a deficient matrix and a null space basis","None",mumps->id.ICNTL(25),&mumps->id.ICNTL(25),NULL));
17999566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_26","ICNTL(26): drives the solution phase if a Schur complement matrix","None",mumps->id.ICNTL(26),&mumps->id.ICNTL(26),NULL));
18009566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_27","ICNTL(27): controls the blocking size for multiple right-hand sides","None",mumps->id.ICNTL(27),&mumps->id.ICNTL(27),NULL));
18019566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_28","ICNTL(28): use 1 for sequential analysis and ictnl(7) ordering, or 2 for parallel analysis and ictnl(29) ordering","None",mumps->id.ICNTL(28),&mumps->id.ICNTL(28),NULL));
18029566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_29","ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis","None",mumps->id.ICNTL(29),&mumps->id.ICNTL(29),NULL));
18039566063dSJacob Faibussowitsch   /* PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_30","ICNTL(30): compute user-specified set of entries in inv(A)","None",mumps->id.ICNTL(30),&mumps->id.ICNTL(30),NULL)); */ /* call MatMumpsGetInverse() directly */
18049566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_31","ICNTL(31): indicates which factors may be discarded during factorization","None",mumps->id.ICNTL(31),&mumps->id.ICNTL(31),NULL));
18059566063dSJacob Faibussowitsch   /* PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_32","ICNTL(32): performs the forward elemination of the right-hand sides during factorization","None",mumps->id.ICNTL(32),&mumps->id.ICNTL(32),NULL));  -- not supported by PETSc API */
18069566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33","ICNTL(33): compute determinant","None",mumps->id.ICNTL(33),&mumps->id.ICNTL(33),NULL));
18079566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_35","ICNTL(35): activates Block Low Rank (BLR) based factorization","None",mumps->id.ICNTL(35),&mumps->id.ICNTL(35),NULL));
18089566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36","ICNTL(36): choice of BLR factorization variant","None",mumps->id.ICNTL(36),&mumps->id.ICNTL(36),NULL));
18099566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_38","ICNTL(38): estimated compression rate of LU factors with BLR","None",mumps->id.ICNTL(38),&mumps->id.ICNTL(38),NULL));
1810dcd589f8SShri Abhyankar 
18119566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1","CNTL(1): relative pivoting threshold","None",mumps->id.CNTL(1),&mumps->id.CNTL(1),NULL));
18129566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2","CNTL(2): stopping criterion of refinement","None",mumps->id.CNTL(2),&mumps->id.CNTL(2),NULL));
18139566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3","CNTL(3): absolute pivoting threshold","None",mumps->id.CNTL(3),&mumps->id.CNTL(3),NULL));
18149566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4","CNTL(4): value for static pivoting","None",mumps->id.CNTL(4),&mumps->id.CNTL(4),NULL));
18159566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5","CNTL(5): fixation for null pivots","None",mumps->id.CNTL(5),&mumps->id.CNTL(5),NULL));
18169566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7","CNTL(7): dropping parameter used during BLR","None",mumps->id.CNTL(7),&mumps->id.CNTL(7),NULL));
1817e5bb22a1SHong Zhang 
18189566063dSJacob Faibussowitsch   PetscCall(PetscOptionsString("-mat_mumps_ooc_tmpdir", "out of core directory", "None", mumps->id.ooc_tmpdir, mumps->id.ooc_tmpdir, sizeof(mumps->id.ooc_tmpdir), NULL));
1819b34f08ffSHong Zhang 
18209566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info","request INFO local to each processor","",info,&ninfo,NULL));
1821b34f08ffSHong Zhang   if (ninfo) {
182208401ef6SPierre Jolivet     PetscCheck(ninfo <= 80,PETSC_COMM_SELF,PETSC_ERR_USER,"number of INFO %" PetscInt_FMT " must <= 80",ninfo);
18239566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo,&mumps->info));
1824b34f08ffSHong Zhang     mumps->ninfo = ninfo;
1825b34f08ffSHong Zhang     for (i=0; i<ninfo; i++) {
1826aed4548fSBarry Smith       PetscCheck(info[i] >= 0 && info[i] <= 80,PETSC_COMM_SELF,PETSC_ERR_USER,"index of INFO %" PetscInt_FMT " must between 1 and 80",ninfo);
18272a808120SBarry Smith       else  mumps->info[i] = info[i];
1828b34f08ffSHong Zhang     }
1829b34f08ffSHong Zhang   }
1830b34f08ffSHong Zhang 
1831d0609cedSBarry Smith   PetscOptionsEnd();
1832dcd589f8SShri Abhyankar   PetscFunctionReturn(0);
1833dcd589f8SShri Abhyankar }
1834dcd589f8SShri Abhyankar 
1835*26cc229bSBarry Smith PetscErrorCode MatSetFromOptions_MUMPS_OpenMP(Mat F,Mat A)
1836dcd589f8SShri Abhyankar {
1837*26cc229bSBarry Smith   Mat_MUMPS      *mumps = (Mat_MUMPS*)F->data;
18387c405c4aSJunchao Zhang   PetscInt       nthreads=0;
1839dcd589f8SShri Abhyankar 
1840dcd589f8SShri Abhyankar   PetscFunctionBegin;
18413ab56b82SJunchao Zhang   mumps->petsc_comm = PetscObjectComm((PetscObject)A);
18429566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(mumps->petsc_comm,&mumps->petsc_size));
18439566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm,&mumps->myid));/* "if (!myid)" still works even if mumps_comm is different */
18443ab56b82SJunchao Zhang 
1845*26cc229bSBarry Smith   PetscCall(PetscOptionsHasName(NULL,((PetscObject)F)->prefix,"-mat_mumps_use_omp_threads",&mumps->use_petsc_omp_support));
18467c405c4aSJunchao Zhang   if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
1847*26cc229bSBarry Smith   PetscCall(PetscOptionsGetInt(NULL,((PetscObject)F)->prefix,"-mat_mumps_use_omp_threads",&nthreads,NULL));
18483ab56b82SJunchao Zhang   if (mumps->use_petsc_omp_support) {
18493ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
18509566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm,nthreads,&mumps->omp_ctrl));
18519566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl,&mumps->omp_comm,&mumps->mumps_comm,&mumps->is_omp_master));
18523ab56b82SJunchao Zhang #else
185398921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"the system does not have PETSc OpenMP support but you added the -%smat_mumps_use_omp_threads option. Configure PETSc with --with-openmp --download-hwloc (or --with-hwloc) to enable it, see more in MATSOLVERMUMPS manual",((PetscObject)A)->prefix?((PetscObject)A)->prefix:"");
18543ab56b82SJunchao Zhang #endif
18553ab56b82SJunchao Zhang   } else {
18563ab56b82SJunchao Zhang     mumps->omp_comm      = PETSC_COMM_SELF;
18573ab56b82SJunchao Zhang     mumps->mumps_comm    = mumps->petsc_comm;
18583ab56b82SJunchao Zhang     mumps->is_omp_master = PETSC_TRUE;
18593ab56b82SJunchao Zhang   }
18609566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(mumps->omp_comm,&mumps->omp_comm_size));
1861a6053eceSJunchao Zhang   mumps->reqs = NULL;
1862a6053eceSJunchao Zhang   mumps->tag  = 0;
18632205254eSKarl Rupp 
186425aac85cSJunchao Zhang   /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
186525aac85cSJunchao Zhang   if (mumps->mumps_comm != MPI_COMM_NULL) {
18669566063dSJacob Faibussowitsch     PetscCall(PetscCommGetComm(PetscObjectComm((PetscObject)A),&mumps->mumps_comm));
186725aac85cSJunchao Zhang   }
186825aac85cSJunchao Zhang 
18692d4298aeSJunchao Zhang   mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
1870f697e70eSHong Zhang   mumps->id.job = JOB_INIT;
1871f697e70eSHong Zhang   mumps->id.par = 1;  /* host participates factorizaton and solve */
1872f697e70eSHong Zhang   mumps->id.sym = mumps->sym;
18733ab56b82SJunchao Zhang 
18743ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1875*26cc229bSBarry Smith   PetscCheck(mumps->id.INFOG(1) >= 0,PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS: INFOG(1)=%d",mumps->id.INFOG(1));
18763ab56b82SJunchao Zhang 
18773ab56b82SJunchao Zhang   /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
18783ab56b82SJunchao Zhang      For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
18793ab56b82SJunchao Zhang    */
18809566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(mumps->id.icntl,40,MPI_INT,  0,mumps->omp_comm));
18819566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15,MPIU_REAL,0,mumps->omp_comm));
1882f697e70eSHong Zhang 
18830298fd71SBarry Smith   mumps->scat_rhs = NULL;
18840298fd71SBarry Smith   mumps->scat_sol = NULL;
18859a2535b5SHong Zhang 
188670544d5fSHong Zhang   /* set PETSc-MUMPS default options - override MUMPS default */
18879a2535b5SHong Zhang   mumps->id.ICNTL(3) = 0;
18889a2535b5SHong Zhang   mumps->id.ICNTL(4) = 0;
18892d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
18909a2535b5SHong Zhang     mumps->id.ICNTL(18) = 0;   /* centralized assembled matrix input */
1891ff8cf4dfSJunchao Zhang     mumps->id.ICNTL(7)  = 7;   /* automatic choice of ordering done by the package */
18929a2535b5SHong Zhang   } else {
18939a2535b5SHong Zhang     mumps->id.ICNTL(18) = 3;   /* distributed assembled matrix input */
189470544d5fSHong Zhang     mumps->id.ICNTL(21) = 1;   /* distributed solution */
18959a2535b5SHong Zhang   }
18966444a565SStefano Zampini 
18976444a565SStefano Zampini   /* schur */
18986444a565SStefano Zampini   mumps->id.size_schur    = 0;
18996444a565SStefano Zampini   mumps->id.listvar_schur = NULL;
19006444a565SStefano Zampini   mumps->id.schur         = NULL;
1901b5fa320bSStefano Zampini   mumps->sizeredrhs       = 0;
190259ac8732SStefano Zampini   mumps->schur_sol        = NULL;
190359ac8732SStefano Zampini   mumps->schur_sizesol    = 0;
1904dcd589f8SShri Abhyankar   PetscFunctionReturn(0);
1905dcd589f8SShri Abhyankar }
1906dcd589f8SShri Abhyankar 
19079a625307SHong Zhang PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F,Mat A,const MatFactorInfo *info,Mat_MUMPS *mumps)
19085cd7cf9dSHong Zhang {
19095cd7cf9dSHong Zhang   PetscFunctionBegin;
19105cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
19115cd7cf9dSHong Zhang     if (A->erroriffailure) {
191298921bdaSJacob Faibussowitsch       SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in analysis phase: INFOG(1)=%d",mumps->id.INFOG(1));
19135cd7cf9dSHong Zhang     } else {
19145cd7cf9dSHong Zhang       if (mumps->id.INFOG(1) == -6) {
19159566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"matrix is singular in structure, INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1916603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
19175cd7cf9dSHong Zhang       } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
19189566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"problem of workspace, INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1919603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1920dbf6bb8dSprj-       } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
19219566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"Empty matrix\n"));
19225cd7cf9dSHong Zhang       } else {
19239566063dSJacob Faibussowitsch         PetscCall(PetscInfo(F,"Error reported by MUMPS in analysis phase: INFOG(1)=%d, INFO(2)=%d\n",mumps->id.INFOG(1),mumps->id.INFO(2)));
1924603e8f96SBarry Smith         F->factorerrortype = MAT_FACTOR_OTHER;
19255cd7cf9dSHong Zhang       }
19265cd7cf9dSHong Zhang     }
19275cd7cf9dSHong Zhang   }
19285cd7cf9dSHong Zhang   PetscFunctionReturn(0);
19295cd7cf9dSHong Zhang }
19305cd7cf9dSHong Zhang 
19310481f469SBarry Smith PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F,Mat A,IS r,IS c,const MatFactorInfo *info)
1932b24902e0SBarry Smith {
1933e69c285eSBarry Smith   Mat_MUMPS      *mumps = (Mat_MUMPS*)F->data;
193467877ebaSShri Abhyankar   Vec            b;
193567877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
1936397b6df1SKris Buschelman 
1937397b6df1SKris Buschelman   PetscFunctionBegin;
1938d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
1939d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
1940d47f36abSHong Zhang     PetscFunctionReturn(0);
1941d47f36abSHong Zhang   }
1942dcd589f8SShri Abhyankar 
19439a2535b5SHong Zhang   /* Set MUMPS options from the options database */
1944*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F,A));
1945dcd589f8SShri Abhyankar 
19469566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
19479566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX,mumps));
1948dcd589f8SShri Abhyankar 
194967877ebaSShri Abhyankar   /* analysis phase */
195067877ebaSShri Abhyankar   /*----------------*/
1951a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
1952a5e57a09SHong Zhang   mumps->id.n   = M;
1953a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
195467877ebaSShri Abhyankar   case 0:  /* centralized assembled matrix input */
1955a5e57a09SHong Zhang     if (!mumps->myid) {
1956a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
1957a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
1958a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
1959a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6)>1) mumps->id.a = (MumpsScalar*)mumps->val;
19604ac6704cSBarry Smith       if (r) {
19614ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
1962a5e57a09SHong Zhang         if (!mumps->myid) {
1963e0b74bf9SHong Zhang           const PetscInt *idx;
1964a6053eceSJunchao Zhang           PetscInt       i;
19652205254eSKarl Rupp 
19669566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M,&mumps->id.perm_in));
19679566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r,&idx));
19689566063dSJacob Faibussowitsch           for (i=0; i<M; i++) PetscCall(PetscMUMPSIntCast(idx[i]+1,&(mumps->id.perm_in[i]))); /* perm_in[]: start from 1, not 0! */
19699566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r,&idx));
1970e0b74bf9SHong Zhang         }
1971e0b74bf9SHong Zhang       }
197267877ebaSShri Abhyankar     }
197367877ebaSShri Abhyankar     break;
197467877ebaSShri Abhyankar   case 3:  /* distributed assembled matrix input (size>1) */
1975a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
1976a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
1977a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
1978a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6)>1) mumps->id.a_loc = (MumpsScalar*)mumps->val;
197925aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
19809566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A,NULL,&b));
19819566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b,&mumps->scat_rhs,&mumps->b_seq));
19829566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
198325aac85cSJunchao Zhang     }
198467877ebaSShri Abhyankar     break;
198567877ebaSShri Abhyankar   }
19863ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
19879566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F,A,info,mumps));
198867877ebaSShri Abhyankar 
1989719d5645SBarry Smith   F->ops->lufactornumeric = MatFactorNumeric_MUMPS;
1990dcd589f8SShri Abhyankar   F->ops->solve           = MatSolve_MUMPS;
199151d5961aSHong Zhang   F->ops->solvetranspose  = MatSolveTranspose_MUMPS;
19924e34a73bSHong Zhang   F->ops->matsolve        = MatMatSolve_MUMPS;
1993eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
1994d47f36abSHong Zhang 
1995d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
1996b24902e0SBarry Smith   PetscFunctionReturn(0);
1997b24902e0SBarry Smith }
1998b24902e0SBarry Smith 
1999450b117fSShri Abhyankar /* Note the Petsc r and c permutations are ignored */
2000450b117fSShri Abhyankar PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F,Mat A,IS r,IS c,const MatFactorInfo *info)
2001450b117fSShri Abhyankar {
2002e69c285eSBarry Smith   Mat_MUMPS      *mumps = (Mat_MUMPS*)F->data;
200367877ebaSShri Abhyankar   Vec            b;
200467877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2005450b117fSShri Abhyankar 
2006450b117fSShri Abhyankar   PetscFunctionBegin;
2007d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2008d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
2009d47f36abSHong Zhang     PetscFunctionReturn(0);
2010d47f36abSHong Zhang   }
2011dcd589f8SShri Abhyankar 
20129a2535b5SHong Zhang   /* Set MUMPS options from the options database */
2013*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F,A));
2014dcd589f8SShri Abhyankar 
20159566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
20169566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX,mumps));
201767877ebaSShri Abhyankar 
201867877ebaSShri Abhyankar   /* analysis phase */
201967877ebaSShri Abhyankar   /*----------------*/
2020a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2021a5e57a09SHong Zhang   mumps->id.n   = M;
2022a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
202367877ebaSShri Abhyankar   case 0:  /* centralized assembled matrix input */
2024a5e57a09SHong Zhang     if (!mumps->myid) {
2025a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2026a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2027a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2028a5e57a09SHong Zhang       if (mumps->id.ICNTL(6)>1) {
2029940cd9d6SSatish Balay         mumps->id.a = (MumpsScalar*)mumps->val;
203067877ebaSShri Abhyankar       }
203167877ebaSShri Abhyankar     }
203267877ebaSShri Abhyankar     break;
203367877ebaSShri Abhyankar   case 3:  /* distributed assembled matrix input (size>1) */
2034a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2035a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2036a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2037a5e57a09SHong Zhang     if (mumps->id.ICNTL(6)>1) {
2038940cd9d6SSatish Balay       mumps->id.a_loc = (MumpsScalar*)mumps->val;
203967877ebaSShri Abhyankar     }
204025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
20419566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A,NULL,&b));
20429566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b,&mumps->scat_rhs,&mumps->b_seq));
20439566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
204425aac85cSJunchao Zhang     }
204567877ebaSShri Abhyankar     break;
204667877ebaSShri Abhyankar   }
20473ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
20489566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F,A,info,mumps));
204967877ebaSShri Abhyankar 
2050450b117fSShri Abhyankar   F->ops->lufactornumeric = MatFactorNumeric_MUMPS;
2051dcd589f8SShri Abhyankar   F->ops->solve           = MatSolve_MUMPS;
205251d5961aSHong Zhang   F->ops->solvetranspose  = MatSolveTranspose_MUMPS;
2053d47f36abSHong Zhang 
2054d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
2055450b117fSShri Abhyankar   PetscFunctionReturn(0);
2056450b117fSShri Abhyankar }
2057b24902e0SBarry Smith 
2058141f4205SHong Zhang /* Note the Petsc r permutation and factor info are ignored */
205967877ebaSShri Abhyankar PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F,Mat A,IS r,const MatFactorInfo *info)
2060b24902e0SBarry Smith {
2061e69c285eSBarry Smith   Mat_MUMPS      *mumps = (Mat_MUMPS*)F->data;
206267877ebaSShri Abhyankar   Vec            b;
206367877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2064397b6df1SKris Buschelman 
2065397b6df1SKris Buschelman   PetscFunctionBegin;
2066d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2067d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
2068d47f36abSHong Zhang     PetscFunctionReturn(0);
2069d47f36abSHong Zhang   }
2070dcd589f8SShri Abhyankar 
20719a2535b5SHong Zhang   /* Set MUMPS options from the options database */
2072*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F,A));
2073dcd589f8SShri Abhyankar 
20749566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
20759566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX,mumps));
2076dcd589f8SShri Abhyankar 
207767877ebaSShri Abhyankar   /* analysis phase */
207867877ebaSShri Abhyankar   /*----------------*/
2079a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2080a5e57a09SHong Zhang   mumps->id.n   = M;
2081a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
208267877ebaSShri Abhyankar   case 0:  /* centralized assembled matrix input */
2083a5e57a09SHong Zhang     if (!mumps->myid) {
2084a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2085a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2086a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2087a5e57a09SHong Zhang       if (mumps->id.ICNTL(6)>1) {
2088940cd9d6SSatish Balay         mumps->id.a = (MumpsScalar*)mumps->val;
208967877ebaSShri Abhyankar       }
209067877ebaSShri Abhyankar     }
209167877ebaSShri Abhyankar     break;
209267877ebaSShri Abhyankar   case 3:  /* distributed assembled matrix input (size>1) */
2093a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2094a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2095a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2096a5e57a09SHong Zhang     if (mumps->id.ICNTL(6)>1) {
2097940cd9d6SSatish Balay       mumps->id.a_loc = (MumpsScalar*)mumps->val;
209867877ebaSShri Abhyankar     }
209925aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
21009566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A,NULL,&b));
21019566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b,&mumps->scat_rhs,&mumps->b_seq));
21029566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
210325aac85cSJunchao Zhang     }
210467877ebaSShri Abhyankar     break;
210567877ebaSShri Abhyankar   }
21063ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
21079566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F,A,info,mumps));
21085cd7cf9dSHong Zhang 
21092792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2110dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
211151d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
21124e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
211323a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
21144e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
21150298fd71SBarry Smith   F->ops->getinertia = NULL;
21164e34a73bSHong Zhang #else
21174e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2118db4efbfdSBarry Smith #endif
2119d47f36abSHong Zhang 
2120d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
2121b24902e0SBarry Smith   PetscFunctionReturn(0);
2122b24902e0SBarry Smith }
2123b24902e0SBarry Smith 
212464e6c443SBarry Smith PetscErrorCode MatView_MUMPS(Mat A,PetscViewer viewer)
212574ed9c26SBarry Smith {
212664e6c443SBarry Smith   PetscBool         iascii;
212764e6c443SBarry Smith   PetscViewerFormat format;
2128e69c285eSBarry Smith   Mat_MUMPS         *mumps=(Mat_MUMPS*)A->data;
2129f6c57405SHong Zhang 
2130f6c57405SHong Zhang   PetscFunctionBegin;
213164e6c443SBarry Smith   /* check if matrix is mumps type */
213264e6c443SBarry Smith   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(0);
213364e6c443SBarry Smith 
21349566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii));
213564e6c443SBarry Smith   if (iascii) {
21369566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer,&format));
213764e6c443SBarry Smith     if (format == PETSC_VIEWER_ASCII_INFO) {
21389566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"MUMPS run parameters:\n"));
21399566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  SYM (matrix type):                   %d\n",mumps->id.sym));
21409566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  PAR (host participation):            %d\n",mumps->id.par));
21419566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(1) (output for error):         %d\n",mumps->id.ICNTL(1)));
21429566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(2) (output of diagnostic msg): %d\n",mumps->id.ICNTL(2)));
21439566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(3) (output for global info):   %d\n",mumps->id.ICNTL(3)));
21449566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(4) (level of printing):        %d\n",mumps->id.ICNTL(4)));
21459566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(5) (input mat struct):         %d\n",mumps->id.ICNTL(5)));
21469566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(6) (matrix prescaling):        %d\n",mumps->id.ICNTL(6)));
21479566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(7) (sequential matrix ordering):%d\n",mumps->id.ICNTL(7)));
21489566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(8) (scaling strategy):        %d\n",mumps->id.ICNTL(8)));
21499566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(10) (max num of refinements):  %d\n",mumps->id.ICNTL(10)));
21509566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(11) (error analysis):          %d\n",mumps->id.ICNTL(11)));
2151a5e57a09SHong Zhang       if (mumps->id.ICNTL(11)>0) {
21529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"    RINFOG(4) (inf norm of input mat):        %g\n",mumps->id.RINFOG(4)));
21539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"    RINFOG(5) (inf norm of solution):         %g\n",mumps->id.RINFOG(5)));
21549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"    RINFOG(6) (inf norm of residual):         %g\n",mumps->id.RINFOG(6)));
21559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n",mumps->id.RINFOG(7),mumps->id.RINFOG(8)));
21569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"    RINFOG(9) (error estimate):               %g \n",mumps->id.RINFOG(9)));
21579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n",mumps->id.RINFOG(10),mumps->id.RINFOG(11)));
2158f6c57405SHong Zhang       }
21599566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(12) (efficiency control):                         %d\n",mumps->id.ICNTL(12)));
21609566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(13) (sequential factorization of the root node):  %d\n",mumps->id.ICNTL(13)));
21619566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(14) (percentage of estimated workspace increase): %d\n",mumps->id.ICNTL(14)));
216245e3843bSPierre Jolivet       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(15) (compression of the input matrix):            %d\n",mumps->id.ICNTL(15)));
2163f6c57405SHong Zhang       /* ICNTL(15-17) not used */
21649566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(18) (input mat struct):                           %d\n",mumps->id.ICNTL(18)));
21659566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(19) (Schur complement info):                      %d\n",mumps->id.ICNTL(19)));
21669566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(20) (RHS sparse pattern):                         %d\n",mumps->id.ICNTL(20)));
21679566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(21) (solution struct):                            %d\n",mumps->id.ICNTL(21)));
21689566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(22) (in-core/out-of-core facility):               %d\n",mumps->id.ICNTL(22)));
21699566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(23) (max size of memory can be allocated locally):%d\n",mumps->id.ICNTL(23)));
2170c0165424SHong Zhang 
21719566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(24) (detection of null pivot rows):               %d\n",mumps->id.ICNTL(24)));
21729566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(25) (computation of a null space basis):          %d\n",mumps->id.ICNTL(25)));
21739566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(26) (Schur options for RHS or solution):          %d\n",mumps->id.ICNTL(26)));
21749566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(27) (blocking size for multiple RHS):             %d\n",mumps->id.ICNTL(27)));
21759566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(28) (use parallel or sequential ordering):        %d\n",mumps->id.ICNTL(28)));
21769566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(29) (parallel ordering):                          %d\n",mumps->id.ICNTL(29)));
217742179a6aSHong Zhang 
21789566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n",mumps->id.ICNTL(30)));
21799566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(31) (factors is discarded in the solve phase):    %d\n",mumps->id.ICNTL(31)));
21809566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(33) (compute determinant):                        %d\n",mumps->id.ICNTL(33)));
21819566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(35) (activate BLR based factorization):           %d\n",mumps->id.ICNTL(35)));
21829566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(36) (choice of BLR factorization variant):        %d\n",mumps->id.ICNTL(36)));
21839566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  ICNTL(38) (estimated compression rate of LU factors):   %d\n",mumps->id.ICNTL(38)));
2184f6c57405SHong Zhang 
21859566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  CNTL(1) (relative pivoting threshold):      %g \n",mumps->id.CNTL(1)));
21869566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  CNTL(2) (stopping criterion of refinement): %g \n",mumps->id.CNTL(2)));
21879566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  CNTL(3) (absolute pivoting threshold):      %g \n",mumps->id.CNTL(3)));
21889566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  CNTL(4) (value of static pivoting):         %g \n",mumps->id.CNTL(4)));
21899566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  CNTL(5) (fixation for null pivots):         %g \n",mumps->id.CNTL(5)));
21909566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer,"  CNTL(7) (dropping parameter for BLR):       %g \n",mumps->id.CNTL(7)));
2191f6c57405SHong Zhang 
2192a5b23f4aSJose E. Roman       /* information local to each processor */
21939566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis): \n"));
21949566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPushSynchronized(viewer));
21959566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"    [%d] %g \n",mumps->myid,mumps->id.RINFO(1)));
21969566063dSJacob Faibussowitsch       PetscCall(PetscViewerFlush(viewer));
21979566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization): \n"));
21989566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"    [%d]  %g \n",mumps->myid,mumps->id.RINFO(2)));
21999566063dSJacob Faibussowitsch       PetscCall(PetscViewerFlush(viewer));
22009566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization): \n"));
22019566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"    [%d]  %g \n",mumps->myid,mumps->id.RINFO(3)));
22029566063dSJacob Faibussowitsch       PetscCall(PetscViewerFlush(viewer));
2203f6c57405SHong Zhang 
22049566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization): \n"));
22059566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"  [%d] %d\n",mumps->myid,mumps->id.INFO(15)));
22069566063dSJacob Faibussowitsch       PetscCall(PetscViewerFlush(viewer));
2207f6c57405SHong Zhang 
22089566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization): \n"));
22099566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"    [%d] %d\n",mumps->myid,mumps->id.INFO(16)));
22109566063dSJacob Faibussowitsch       PetscCall(PetscViewerFlush(viewer));
2211f6c57405SHong Zhang 
22129566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization): \n"));
22139566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"    [%d] %d\n",mumps->myid,mumps->id.INFO(23)));
22149566063dSJacob Faibussowitsch       PetscCall(PetscViewerFlush(viewer));
2215b34f08ffSHong Zhang 
2216a0e18203SThibaut Appel       if (mumps->ninfo && mumps->ninfo <= 80) {
2217b34f08ffSHong Zhang         PetscInt i;
2218b34f08ffSHong Zhang         for (i=0; i<mumps->ninfo; i++) {
22199566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "): \n",mumps->info[i]));
22209566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIISynchronizedPrintf(viewer,"    [%d] %d\n",mumps->myid,mumps->id.INFO(mumps->info[i])));
22219566063dSJacob Faibussowitsch           PetscCall(PetscViewerFlush(viewer));
2222b34f08ffSHong Zhang         }
2223b34f08ffSHong Zhang       }
22249566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPopSynchronized(viewer));
2225f6c57405SHong Zhang 
2226a5e57a09SHong Zhang       if (!mumps->myid) { /* information from the host */
22279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  RINFOG(1) (global estimated flops for the elimination after analysis): %g \n",mumps->id.RINFOG(1)));
22289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  RINFOG(2) (global estimated flops for the assembly after factorization): %g \n",mumps->id.RINFOG(2)));
22299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  RINFOG(3) (global estimated flops for the elimination after factorization): %g \n",mumps->id.RINFOG(3)));
22309566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  (RINFOG(12) RINFOG(13))*2^INFOG(34) (determinant): (%g,%g)*(2^%d)\n",mumps->id.RINFOG(12),mumps->id.RINFOG(13),mumps->id.INFOG(34)));
2231f6c57405SHong Zhang 
22329566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n",mumps->id.INFOG(3)));
22339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n",mumps->id.INFOG(4)));
22349566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(5) (estimated maximum front size in the complete tree): %d\n",mumps->id.INFOG(5)));
22359566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(6) (number of nodes in the complete tree): %d\n",mumps->id.INFOG(6)));
22369566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(7) (ordering option effectively used after analysis): %d\n",mumps->id.INFOG(7)));
22379566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n",mumps->id.INFOG(8)));
22389566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n",mumps->id.INFOG(9)));
22399566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(10) (total integer space store the matrix factors after factorization): %d\n",mumps->id.INFOG(10)));
22409566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(11) (order of largest frontal matrix after factorization): %d\n",mumps->id.INFOG(11)));
22419566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(12) (number of off-diagonal pivots): %d\n",mumps->id.INFOG(12)));
22429566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(13) (number of delayed pivots after factorization): %d\n",mumps->id.INFOG(13)));
22439566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(14) (number of memory compress after factorization): %d\n",mumps->id.INFOG(14)));
22449566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(15) (number of steps of iterative refinement after solution): %d\n",mumps->id.INFOG(15)));
22459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(16) (estimated size (in MB) of all MUMPS internal data for factorization after analysis: value on the most memory consuming processor): %d\n",mumps->id.INFOG(16)));
22469566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(17) (estimated size of all MUMPS internal data for factorization after analysis: sum over all processors): %d\n",mumps->id.INFOG(17)));
22479566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(18) (size of all MUMPS internal data allocated during factorization: value on the most memory consuming processor): %d\n",mumps->id.INFOG(18)));
22489566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(19) (size of all MUMPS internal data allocated during factorization: sum over all processors): %d\n",mumps->id.INFOG(19)));
22499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(20) (estimated number of entries in the factors): %d\n",mumps->id.INFOG(20)));
22509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(21) (size in MB of memory effectively used during factorization - value on the most memory consuming processor): %d\n",mumps->id.INFOG(21)));
22519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(22) (size in MB of memory effectively used during factorization - sum over all processors): %d\n",mumps->id.INFOG(22)));
22529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n",mumps->id.INFOG(23)));
22539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n",mumps->id.INFOG(24)));
22549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n",mumps->id.INFOG(25)));
22559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(28) (after factorization: number of null pivots encountered): %d\n",mumps->id.INFOG(28)));
22569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(29) (after factorization: effective number of entries in the factors (sum over all processors)): %d\n",mumps->id.INFOG(29)));
22579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(30, 31) (after solution: size in Mbytes of memory used during solution phase): %d, %d\n",mumps->id.INFOG(30),mumps->id.INFOG(31)));
22589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(32) (after analysis: type of analysis done): %d\n",mumps->id.INFOG(32)));
22599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(33) (value used for ICNTL(8)): %d\n",mumps->id.INFOG(33)));
22609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(34) (exponent of the determinant if determinant is requested): %d\n",mumps->id.INFOG(34)));
22619566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(35) (after factorization: number of entries taking into account BLR factor compression - sum over all processors): %d\n",mumps->id.INFOG(35)));
22629566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(36) (after analysis: estimated size of all MUMPS internal data for running BLR in-core - value on the most memory consuming processor): %d\n",mumps->id.INFOG(36)));
22639566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(37) (after analysis: estimated size of all MUMPS internal data for running BLR in-core - sum over all processors): %d\n",mumps->id.INFOG(37)));
22649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(38) (after analysis: estimated size of all MUMPS internal data for running BLR out-of-core - value on the most memory consuming processor): %d\n",mumps->id.INFOG(38)));
22659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer,"  INFOG(39) (after analysis: estimated size of all MUMPS internal data for running BLR out-of-core - sum over all processors): %d\n",mumps->id.INFOG(39)));
2266f6c57405SHong Zhang       }
2267f6c57405SHong Zhang     }
2268cb828f0fSHong Zhang   }
2269f6c57405SHong Zhang   PetscFunctionReturn(0);
2270f6c57405SHong Zhang }
2271f6c57405SHong Zhang 
227235bd34faSBarry Smith PetscErrorCode MatGetInfo_MUMPS(Mat A,MatInfoType flag,MatInfo *info)
227335bd34faSBarry Smith {
2274e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)A->data;
227535bd34faSBarry Smith 
227635bd34faSBarry Smith   PetscFunctionBegin;
227735bd34faSBarry Smith   info->block_size        = 1.0;
2278cb828f0fSHong Zhang   info->nz_allocated      = mumps->id.INFOG(20);
2279cb828f0fSHong Zhang   info->nz_used           = mumps->id.INFOG(20);
228035bd34faSBarry Smith   info->nz_unneeded       = 0.0;
228135bd34faSBarry Smith   info->assemblies        = 0.0;
228235bd34faSBarry Smith   info->mallocs           = 0.0;
228335bd34faSBarry Smith   info->memory            = 0.0;
228435bd34faSBarry Smith   info->fill_ratio_given  = 0;
228535bd34faSBarry Smith   info->fill_ratio_needed = 0;
228635bd34faSBarry Smith   info->factor_mallocs    = 0;
228735bd34faSBarry Smith   PetscFunctionReturn(0);
228835bd34faSBarry Smith }
228935bd34faSBarry Smith 
22905ccb76cbSHong Zhang /* -------------------------------------------------------------------------------------------*/
22918e7ba810SStefano Zampini PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
22926444a565SStefano Zampini {
2293e69c285eSBarry Smith   Mat_MUMPS         *mumps =(Mat_MUMPS*)F->data;
2294a3d589ffSStefano Zampini   const PetscScalar *arr;
22958e7ba810SStefano Zampini   const PetscInt    *idxs;
22968e7ba810SStefano Zampini   PetscInt          size,i;
22976444a565SStefano Zampini 
22986444a565SStefano Zampini   PetscFunctionBegin;
22999566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is,&size));
23002d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
23013ab56b82SJunchao Zhang     PetscBool ls,gs; /* gs is false if any rank other than root has non-empty IS */
2302241dbb5eSStefano Zampini 
23033ab56b82SJunchao Zhang     ls   = mumps->myid ? (size ? PETSC_FALSE : PETSC_TRUE) : PETSC_TRUE; /* always true on root; false on others if their size != 0 */
23049566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Allreduce(&ls,&gs,1,MPIU_BOOL,MPI_LAND,mumps->petsc_comm));
230528b400f6SJacob Faibussowitsch     PetscCheck(gs,PETSC_COMM_SELF,PETSC_ERR_SUP,"MUMPS distributed parallel Schur complements not yet supported from PETSc");
2306241dbb5eSStefano Zampini   }
2307b3cb21ddSStefano Zampini 
2308b3cb21ddSStefano Zampini   /* Schur complement matrix */
23099566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
23109566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF,size,size,NULL,&F->schur));
23119566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur,&arr));
2312a3d589ffSStefano Zampini   mumps->id.schur      = (MumpsScalar*)arr;
2313a3d589ffSStefano Zampini   mumps->id.size_schur = size;
2314a3d589ffSStefano Zampini   mumps->id.schur_lld  = size;
23159566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur,&arr));
2316b3cb21ddSStefano Zampini   if (mumps->sym == 1) {
23179566063dSJacob Faibussowitsch     PetscCall(MatSetOption(F->schur,MAT_SPD,PETSC_TRUE));
2318b3cb21ddSStefano Zampini   }
2319b3cb21ddSStefano Zampini 
2320b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
23219566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
23229566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size,&mumps->id.listvar_schur));
23239566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is,&idxs));
23249566063dSJacob Faibussowitsch   for (i=0; i<size; i++) PetscCall(PetscMUMPSIntCast(idxs[i]+1,&(mumps->id.listvar_schur[i])));
23259566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is,&idxs));
23262d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
2327241dbb5eSStefano Zampini     mumps->id.ICNTL(19) = 1; /* MUMPS returns Schur centralized on the host */
2328241dbb5eSStefano Zampini   } else {
23296444a565SStefano Zampini     if (F->factortype == MAT_FACTOR_LU) {
233059ac8732SStefano Zampini       mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
23316444a565SStefano Zampini     } else {
233259ac8732SStefano Zampini       mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
23336444a565SStefano Zampini     }
2334241dbb5eSStefano Zampini   }
233559ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2336b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
23376444a565SStefano Zampini   PetscFunctionReturn(0);
23386444a565SStefano Zampini }
233959ac8732SStefano Zampini 
23406444a565SStefano Zampini /* -------------------------------------------------------------------------------------------*/
23415a05ddb0SStefano Zampini PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F,Mat* S)
23426444a565SStefano Zampini {
23436444a565SStefano Zampini   Mat            St;
2344e69c285eSBarry Smith   Mat_MUMPS      *mumps =(Mat_MUMPS*)F->data;
23456444a565SStefano Zampini   PetscScalar    *array;
23466444a565SStefano Zampini #if defined(PETSC_USE_COMPLEX)
23478ac429a0SStefano Zampini   PetscScalar    im = PetscSqrtScalar((PetscScalar)-1.0);
23486444a565SStefano Zampini #endif
23496444a565SStefano Zampini 
23506444a565SStefano Zampini   PetscFunctionBegin;
235108401ef6SPierre Jolivet   PetscCheck(mumps->id.ICNTL(19),PetscObjectComm((PetscObject)F),PETSC_ERR_ORDER,"Schur complement mode not selected! You should call MatFactorSetSchurIS to enable it");
23529566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF,&St));
23539566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St,PETSC_DECIDE,PETSC_DECIDE,mumps->id.size_schur,mumps->id.size_schur));
23549566063dSJacob Faibussowitsch   PetscCall(MatSetType(St,MATDENSE));
23559566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
23569566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St,&array));
235759ac8732SStefano Zampini   if (!mumps->sym) { /* MUMPS always return a full matrix */
23586444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
23596444a565SStefano Zampini       PetscInt i,j,N=mumps->id.size_schur;
23606444a565SStefano Zampini       for (i=0;i<N;i++) {
23616444a565SStefano Zampini         for (j=0;j<N;j++) {
23626444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
23636444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i*N+j];
23646444a565SStefano Zampini #else
23656444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i*N+j].r + im*mumps->id.schur[i*N+j].i;
23666444a565SStefano Zampini #endif
23676444a565SStefano Zampini           array[j*N+i] = val;
23686444a565SStefano Zampini         }
23696444a565SStefano Zampini       }
23706444a565SStefano Zampini     } else { /* stored by columns */
23719566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array,mumps->id.schur,mumps->id.size_schur*mumps->id.size_schur));
23726444a565SStefano Zampini     }
23736444a565SStefano Zampini   } else { /* either full or lower-triangular (not packed) */
23746444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
23756444a565SStefano Zampini       PetscInt i,j,N=mumps->id.size_schur;
23766444a565SStefano Zampini       for (i=0;i<N;i++) {
23776444a565SStefano Zampini         for (j=i;j<N;j++) {
23786444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
23796444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i*N+j];
23806444a565SStefano Zampini #else
23816444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i*N+j].r + im*mumps->id.schur[i*N+j].i;
23826444a565SStefano Zampini #endif
23836444a565SStefano Zampini           array[i*N+j] = val;
23846444a565SStefano Zampini           array[j*N+i] = val;
23856444a565SStefano Zampini         }
23866444a565SStefano Zampini       }
23876444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
23889566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array,mumps->id.schur,mumps->id.size_schur*mumps->id.size_schur));
23896444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular stored by rows */
23906444a565SStefano Zampini       PetscInt i,j,N=mumps->id.size_schur;
23916444a565SStefano Zampini       for (i=0;i<N;i++) {
23926444a565SStefano Zampini         for (j=0;j<i+1;j++) {
23936444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
23946444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i*N+j];
23956444a565SStefano Zampini #else
23966444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i*N+j].r + im*mumps->id.schur[i*N+j].i;
23976444a565SStefano Zampini #endif
23986444a565SStefano Zampini           array[i*N+j] = val;
23996444a565SStefano Zampini           array[j*N+i] = val;
24006444a565SStefano Zampini         }
24016444a565SStefano Zampini       }
24026444a565SStefano Zampini     }
24036444a565SStefano Zampini   }
24049566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St,&array));
24056444a565SStefano Zampini   *S   = St;
24066444a565SStefano Zampini   PetscFunctionReturn(0);
24076444a565SStefano Zampini }
24086444a565SStefano Zampini 
240959ac8732SStefano Zampini /* -------------------------------------------------------------------------------------------*/
24105ccb76cbSHong Zhang PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F,PetscInt icntl,PetscInt ival)
24115ccb76cbSHong Zhang {
2412e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
24135ccb76cbSHong Zhang 
24145ccb76cbSHong Zhang   PetscFunctionBegin;
24159566063dSJacob Faibussowitsch   PetscCall(PetscMUMPSIntCast(ival,&mumps->id.ICNTL(icntl)));
24165ccb76cbSHong Zhang   PetscFunctionReturn(0);
24175ccb76cbSHong Zhang }
24185ccb76cbSHong Zhang 
2419bc6112feSHong Zhang PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F,PetscInt icntl,PetscInt *ival)
2420bc6112feSHong Zhang {
2421e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
2422bc6112feSHong Zhang 
2423bc6112feSHong Zhang   PetscFunctionBegin;
2424bc6112feSHong Zhang   *ival = mumps->id.ICNTL(icntl);
2425bc6112feSHong Zhang   PetscFunctionReturn(0);
2426bc6112feSHong Zhang }
2427bc6112feSHong Zhang 
24285ccb76cbSHong Zhang /*@
24295ccb76cbSHong Zhang   MatMumpsSetIcntl - Set MUMPS parameter ICNTL()
24305ccb76cbSHong Zhang 
24315ccb76cbSHong Zhang    Logically Collective on Mat
24325ccb76cbSHong Zhang 
24335ccb76cbSHong Zhang    Input Parameters:
24345ccb76cbSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
24355ccb76cbSHong Zhang .  icntl - index of MUMPS parameter array ICNTL()
24365ccb76cbSHong Zhang -  ival - value of MUMPS ICNTL(icntl)
24375ccb76cbSHong Zhang 
24385ccb76cbSHong Zhang   Options Database:
2439147403d9SBarry Smith .   -mat_mumps_icntl_<icntl> <ival> - change the option numbered icntl to ival
24405ccb76cbSHong Zhang 
24415ccb76cbSHong Zhang    Level: beginner
24425ccb76cbSHong Zhang 
244396a0c994SBarry Smith    References:
2444606c0280SSatish Balay .  * - MUMPS Users' Guide
24455ccb76cbSHong Zhang 
2446db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
24475ccb76cbSHong Zhang @*/
24485ccb76cbSHong Zhang PetscErrorCode MatMumpsSetIcntl(Mat F,PetscInt icntl,PetscInt ival)
24495ccb76cbSHong Zhang {
24505ccb76cbSHong Zhang   PetscFunctionBegin;
24512989dfd4SHong Zhang   PetscValidType(F,1);
245228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
24535ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F,icntl,2);
24545ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F,ival,3);
2455cac4c232SBarry Smith   PetscTryMethod(F,"MatMumpsSetIcntl_C",(Mat,PetscInt,PetscInt),(F,icntl,ival));
24565ccb76cbSHong Zhang   PetscFunctionReturn(0);
24575ccb76cbSHong Zhang }
24585ccb76cbSHong Zhang 
2459a21f80fcSHong Zhang /*@
2460a21f80fcSHong Zhang   MatMumpsGetIcntl - Get MUMPS parameter ICNTL()
2461a21f80fcSHong Zhang 
2462a21f80fcSHong Zhang    Logically Collective on Mat
2463a21f80fcSHong Zhang 
2464a21f80fcSHong Zhang    Input Parameters:
2465a21f80fcSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2466a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array ICNTL()
2467a21f80fcSHong Zhang 
2468a21f80fcSHong Zhang   Output Parameter:
2469a21f80fcSHong Zhang .  ival - value of MUMPS ICNTL(icntl)
2470a21f80fcSHong Zhang 
2471a21f80fcSHong Zhang    Level: beginner
2472a21f80fcSHong Zhang 
247396a0c994SBarry Smith    References:
2474606c0280SSatish Balay .  * - MUMPS Users' Guide
2475a21f80fcSHong Zhang 
2476db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2477a21f80fcSHong Zhang @*/
2478bc6112feSHong Zhang PetscErrorCode MatMumpsGetIcntl(Mat F,PetscInt icntl,PetscInt *ival)
2479bc6112feSHong Zhang {
2480bc6112feSHong Zhang   PetscFunctionBegin;
24812989dfd4SHong Zhang   PetscValidType(F,1);
248228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2483bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F,icntl,2);
2484bc6112feSHong Zhang   PetscValidIntPointer(ival,3);
2485cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetIcntl_C",(Mat,PetscInt,PetscInt*),(F,icntl,ival));
2486bc6112feSHong Zhang   PetscFunctionReturn(0);
2487bc6112feSHong Zhang }
2488bc6112feSHong Zhang 
24898928b65cSHong Zhang /* -------------------------------------------------------------------------------------------*/
24908928b65cSHong Zhang PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F,PetscInt icntl,PetscReal val)
24918928b65cSHong Zhang {
2492e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
24938928b65cSHong Zhang 
24948928b65cSHong Zhang   PetscFunctionBegin;
24958928b65cSHong Zhang   mumps->id.CNTL(icntl) = val;
24968928b65cSHong Zhang   PetscFunctionReturn(0);
24978928b65cSHong Zhang }
24988928b65cSHong Zhang 
2499bc6112feSHong Zhang PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F,PetscInt icntl,PetscReal *val)
2500bc6112feSHong Zhang {
2501e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
2502bc6112feSHong Zhang 
2503bc6112feSHong Zhang   PetscFunctionBegin;
2504bc6112feSHong Zhang   *val = mumps->id.CNTL(icntl);
2505bc6112feSHong Zhang   PetscFunctionReturn(0);
2506bc6112feSHong Zhang }
2507bc6112feSHong Zhang 
25088928b65cSHong Zhang /*@
25098928b65cSHong Zhang   MatMumpsSetCntl - Set MUMPS parameter CNTL()
25108928b65cSHong Zhang 
25118928b65cSHong Zhang    Logically Collective on Mat
25128928b65cSHong Zhang 
25138928b65cSHong Zhang    Input Parameters:
25148928b65cSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
25158928b65cSHong Zhang .  icntl - index of MUMPS parameter array CNTL()
25168928b65cSHong Zhang -  val - value of MUMPS CNTL(icntl)
25178928b65cSHong Zhang 
25188928b65cSHong Zhang   Options Database:
2519147403d9SBarry Smith .   -mat_mumps_cntl_<icntl> <val>  - change the option numbered icntl to ival
25208928b65cSHong Zhang 
25218928b65cSHong Zhang    Level: beginner
25228928b65cSHong Zhang 
252396a0c994SBarry Smith    References:
2524606c0280SSatish Balay .  * - MUMPS Users' Guide
25258928b65cSHong Zhang 
2526db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
25278928b65cSHong Zhang @*/
25288928b65cSHong Zhang PetscErrorCode MatMumpsSetCntl(Mat F,PetscInt icntl,PetscReal val)
25298928b65cSHong Zhang {
25308928b65cSHong Zhang   PetscFunctionBegin;
25312989dfd4SHong Zhang   PetscValidType(F,1);
253228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
25338928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F,icntl,2);
2534bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F,val,3);
2535cac4c232SBarry Smith   PetscTryMethod(F,"MatMumpsSetCntl_C",(Mat,PetscInt,PetscReal),(F,icntl,val));
25368928b65cSHong Zhang   PetscFunctionReturn(0);
25378928b65cSHong Zhang }
25388928b65cSHong Zhang 
2539a21f80fcSHong Zhang /*@
2540a21f80fcSHong Zhang   MatMumpsGetCntl - Get MUMPS parameter CNTL()
2541a21f80fcSHong Zhang 
2542a21f80fcSHong Zhang    Logically Collective on Mat
2543a21f80fcSHong Zhang 
2544a21f80fcSHong Zhang    Input Parameters:
2545a21f80fcSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2546a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array CNTL()
2547a21f80fcSHong Zhang 
2548a21f80fcSHong Zhang   Output Parameter:
2549a21f80fcSHong Zhang .  val - value of MUMPS CNTL(icntl)
2550a21f80fcSHong Zhang 
2551a21f80fcSHong Zhang    Level: beginner
2552a21f80fcSHong Zhang 
255396a0c994SBarry Smith    References:
2554606c0280SSatish Balay .  * - MUMPS Users' Guide
2555a21f80fcSHong Zhang 
2556db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2557a21f80fcSHong Zhang @*/
2558bc6112feSHong Zhang PetscErrorCode MatMumpsGetCntl(Mat F,PetscInt icntl,PetscReal *val)
2559bc6112feSHong Zhang {
2560bc6112feSHong Zhang   PetscFunctionBegin;
25612989dfd4SHong Zhang   PetscValidType(F,1);
256228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2563bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F,icntl,2);
2564bc6112feSHong Zhang   PetscValidRealPointer(val,3);
2565cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetCntl_C",(Mat,PetscInt,PetscReal*),(F,icntl,val));
2566bc6112feSHong Zhang   PetscFunctionReturn(0);
2567bc6112feSHong Zhang }
2568bc6112feSHong Zhang 
2569ca810319SHong Zhang PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F,PetscInt icntl,PetscInt *info)
2570bc6112feSHong Zhang {
2571e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
2572bc6112feSHong Zhang 
2573bc6112feSHong Zhang   PetscFunctionBegin;
2574bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
2575bc6112feSHong Zhang   PetscFunctionReturn(0);
2576bc6112feSHong Zhang }
2577bc6112feSHong Zhang 
2578ca810319SHong Zhang PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F,PetscInt icntl,PetscInt *infog)
2579bc6112feSHong Zhang {
2580e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
2581bc6112feSHong Zhang 
2582bc6112feSHong Zhang   PetscFunctionBegin;
2583bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
2584bc6112feSHong Zhang   PetscFunctionReturn(0);
2585bc6112feSHong Zhang }
2586bc6112feSHong Zhang 
2587ca810319SHong Zhang PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F,PetscInt icntl,PetscReal *rinfo)
2588bc6112feSHong Zhang {
2589e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
2590bc6112feSHong Zhang 
2591bc6112feSHong Zhang   PetscFunctionBegin;
2592bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
2593bc6112feSHong Zhang   PetscFunctionReturn(0);
2594bc6112feSHong Zhang }
2595bc6112feSHong Zhang 
2596ca810319SHong Zhang PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F,PetscInt icntl,PetscReal *rinfog)
2597bc6112feSHong Zhang {
2598e69c285eSBarry Smith   Mat_MUMPS *mumps =(Mat_MUMPS*)F->data;
2599bc6112feSHong Zhang 
2600bc6112feSHong Zhang   PetscFunctionBegin;
2601bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
2602bc6112feSHong Zhang   PetscFunctionReturn(0);
2603bc6112feSHong Zhang }
2604bc6112feSHong Zhang 
260589a9c03aSHong Zhang PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F,Mat spRHS)
2606bb599dfdSHong Zhang {
26070e6b8875SHong Zhang   Mat            Bt = NULL,Btseq = NULL;
26080e6b8875SHong Zhang   PetscBool      flg;
2609bb599dfdSHong Zhang   Mat_MUMPS      *mumps =(Mat_MUMPS*)F->data;
2610bb599dfdSHong Zhang   PetscScalar    *aa;
2611f410b75aSHong Zhang   PetscInt       spnr,*ia,*ja,M,nrhs;
2612bb599dfdSHong Zhang 
2613bb599dfdSHong Zhang   PetscFunctionBegin;
2614064a246eSJacob Faibussowitsch   PetscValidPointer(spRHS,2);
26159566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS,MATTRANSPOSEMAT,&flg));
26160e6b8875SHong Zhang   if (flg) {
26179566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(spRHS,&Bt));
26180e6b8875SHong Zhang   } else SETERRQ(PetscObjectComm((PetscObject)spRHS),PETSC_ERR_ARG_WRONG,"Matrix spRHS must be type MATTRANSPOSEMAT matrix");
2619bb599dfdSHong Zhang 
26209566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F,30,1));
2621bb599dfdSHong Zhang 
26222d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
26230e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ*)Bt->data;
26240e6b8875SHong Zhang     Btseq = b->A;
26250e6b8875SHong Zhang   } else {
26260e6b8875SHong Zhang     Btseq = Bt;
26270e6b8875SHong Zhang   }
26280e6b8875SHong Zhang 
26299566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS,&M,&nrhs));
2630f410b75aSHong Zhang   mumps->id.nrhs = nrhs;
2631f410b75aSHong Zhang   mumps->id.lrhs = M;
2632f410b75aSHong Zhang   mumps->id.rhs  = NULL;
2633f410b75aSHong Zhang 
2634e3f2db6aSHong Zhang   if (!mumps->myid) {
26359566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq,&aa));
26369566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq,1,PETSC_FALSE,PETSC_FALSE,&spnr,(const PetscInt**)&ia,(const PetscInt**)&ja,&flg));
263728b400f6SJacob Faibussowitsch     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot get IJ structure");
26389566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps,spnr,ia,ja,&mumps->id.irhs_ptr,&mumps->id.irhs_sparse,&mumps->id.nz_rhs));
2639bb599dfdSHong Zhang     mumps->id.rhs_sparse  = (MumpsScalar*)aa;
2640e3f2db6aSHong Zhang   } else {
2641e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
2642e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
2643e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
2644e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
2645e3f2db6aSHong Zhang   }
2646bb599dfdSHong Zhang   mumps->id.ICNTL(20)   = 1; /* rhs is sparse */
2647e3f2db6aSHong Zhang   mumps->id.ICNTL(21)   = 0; /* solution is in assembled centralized format */
2648bb599dfdSHong Zhang 
2649bb599dfdSHong Zhang   /* solve phase */
2650bb599dfdSHong Zhang   /*-------------*/
2651bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
26523ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
2653e3f2db6aSHong Zhang   if (mumps->id.INFOG(1) < 0)
265498921bdaSJacob Faibussowitsch     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_LIB,"Error reported by MUMPS in solve phase: INFOG(1)=%d INFO(2)=%d",mumps->id.INFOG(1),mumps->id.INFO(2));
265514267174SHong Zhang 
2656e3f2db6aSHong Zhang   if (!mumps->myid) {
26579566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq,&aa));
26589566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq,1,PETSC_FALSE,PETSC_FALSE,&spnr,(const PetscInt**)&ia,(const PetscInt**)&ja,&flg));
265928b400f6SJacob Faibussowitsch     PetscCheck(flg,PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Cannot get IJ structure");
2660e3f2db6aSHong Zhang   }
2661bb599dfdSHong Zhang   PetscFunctionReturn(0);
2662bb599dfdSHong Zhang }
2663bb599dfdSHong Zhang 
2664bb599dfdSHong Zhang /*@
266589a9c03aSHong Zhang   MatMumpsGetInverse - Get user-specified set of entries in inverse of A
2666bb599dfdSHong Zhang 
2667bb599dfdSHong Zhang    Logically Collective on Mat
2668bb599dfdSHong Zhang 
2669bb599dfdSHong Zhang    Input Parameters:
2670bb599dfdSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2671e3f2db6aSHong Zhang -  spRHS - sequential sparse matrix in MATTRANSPOSEMAT format holding specified indices in processor[0]
2672bb599dfdSHong Zhang 
2673bb599dfdSHong Zhang   Output Parameter:
2674e3f2db6aSHong Zhang . spRHS - requested entries of inverse of A
2675bb599dfdSHong Zhang 
2676bb599dfdSHong Zhang    Level: beginner
2677bb599dfdSHong Zhang 
2678bb599dfdSHong Zhang    References:
2679606c0280SSatish Balay .  * - MUMPS Users' Guide
2680bb599dfdSHong Zhang 
2681db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatCreateTranspose()`
2682bb599dfdSHong Zhang @*/
268389a9c03aSHong Zhang PetscErrorCode MatMumpsGetInverse(Mat F,Mat spRHS)
2684bb599dfdSHong Zhang {
2685bb599dfdSHong Zhang   PetscFunctionBegin;
2686bb599dfdSHong Zhang   PetscValidType(F,1);
268728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2688cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetInverse_C",(Mat,Mat),(F,spRHS));
2689bb599dfdSHong Zhang   PetscFunctionReturn(0);
2690bb599dfdSHong Zhang }
2691bb599dfdSHong Zhang 
26920e6b8875SHong Zhang PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F,Mat spRHST)
26930e6b8875SHong Zhang {
26940e6b8875SHong Zhang   Mat            spRHS;
26950e6b8875SHong Zhang 
26960e6b8875SHong Zhang   PetscFunctionBegin;
26979566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST,&spRHS));
26989566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F,spRHS));
26999566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
27000e6b8875SHong Zhang   PetscFunctionReturn(0);
27010e6b8875SHong Zhang }
27020e6b8875SHong Zhang 
27030e6b8875SHong Zhang /*@
2704eef1237cSHong Zhang   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix A^T
27050e6b8875SHong Zhang 
27060e6b8875SHong Zhang    Logically Collective on Mat
27070e6b8875SHong Zhang 
27080e6b8875SHong Zhang    Input Parameters:
27090e6b8875SHong Zhang +  F - the factored matrix of A obtained by calling MatGetFactor() from PETSc-MUMPS interface
27100e6b8875SHong Zhang -  spRHST - sequential sparse matrix in MATAIJ format holding specified indices of A^T in processor[0]
27110e6b8875SHong Zhang 
27120e6b8875SHong Zhang   Output Parameter:
27130e6b8875SHong Zhang . spRHST - requested entries of inverse of A^T
27140e6b8875SHong Zhang 
27150e6b8875SHong Zhang    Level: beginner
27160e6b8875SHong Zhang 
27170e6b8875SHong Zhang    References:
2718606c0280SSatish Balay .  * - MUMPS Users' Guide
27190e6b8875SHong Zhang 
2720db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
27210e6b8875SHong Zhang @*/
27220e6b8875SHong Zhang PetscErrorCode MatMumpsGetInverseTranspose(Mat F,Mat spRHST)
27230e6b8875SHong Zhang {
27240e6b8875SHong Zhang   PetscBool      flg;
27250e6b8875SHong Zhang 
27260e6b8875SHong Zhang   PetscFunctionBegin;
27270e6b8875SHong Zhang   PetscValidType(F,1);
272828b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
27299566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST,&flg,MATSEQAIJ,MATMPIAIJ,NULL));
273028b400f6SJacob Faibussowitsch   PetscCheck(flg,PetscObjectComm((PetscObject)spRHST),PETSC_ERR_ARG_WRONG,"Matrix spRHST must be MATAIJ matrix");
27310e6b8875SHong Zhang 
2732cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetInverseTranspose_C",(Mat,Mat),(F,spRHST));
27330e6b8875SHong Zhang   PetscFunctionReturn(0);
27340e6b8875SHong Zhang }
27350e6b8875SHong Zhang 
2736a21f80fcSHong Zhang /*@
2737a21f80fcSHong Zhang   MatMumpsGetInfo - Get MUMPS parameter INFO()
2738a21f80fcSHong Zhang 
2739a21f80fcSHong Zhang    Logically Collective on Mat
2740a21f80fcSHong Zhang 
2741a21f80fcSHong Zhang    Input Parameters:
2742a21f80fcSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2743a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array INFO()
2744a21f80fcSHong Zhang 
2745a21f80fcSHong Zhang   Output Parameter:
2746a21f80fcSHong Zhang .  ival - value of MUMPS INFO(icntl)
2747a21f80fcSHong Zhang 
2748a21f80fcSHong Zhang    Level: beginner
2749a21f80fcSHong Zhang 
275096a0c994SBarry Smith    References:
2751606c0280SSatish Balay .  * - MUMPS Users' Guide
2752a21f80fcSHong Zhang 
2753db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2754a21f80fcSHong Zhang @*/
2755ca810319SHong Zhang PetscErrorCode MatMumpsGetInfo(Mat F,PetscInt icntl,PetscInt *ival)
2756bc6112feSHong Zhang {
2757bc6112feSHong Zhang   PetscFunctionBegin;
27582989dfd4SHong Zhang   PetscValidType(F,1);
275928b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2760ca810319SHong Zhang   PetscValidIntPointer(ival,3);
2761cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetInfo_C",(Mat,PetscInt,PetscInt*),(F,icntl,ival));
2762bc6112feSHong Zhang   PetscFunctionReturn(0);
2763bc6112feSHong Zhang }
2764bc6112feSHong Zhang 
2765a21f80fcSHong Zhang /*@
2766a21f80fcSHong Zhang   MatMumpsGetInfog - Get MUMPS parameter INFOG()
2767a21f80fcSHong Zhang 
2768a21f80fcSHong Zhang    Logically Collective on Mat
2769a21f80fcSHong Zhang 
2770a21f80fcSHong Zhang    Input Parameters:
2771a21f80fcSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2772a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array INFOG()
2773a21f80fcSHong Zhang 
2774a21f80fcSHong Zhang   Output Parameter:
2775a21f80fcSHong Zhang .  ival - value of MUMPS INFOG(icntl)
2776a21f80fcSHong Zhang 
2777a21f80fcSHong Zhang    Level: beginner
2778a21f80fcSHong Zhang 
277996a0c994SBarry Smith    References:
2780606c0280SSatish Balay .  * - MUMPS Users' Guide
2781a21f80fcSHong Zhang 
2782db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2783a21f80fcSHong Zhang @*/
2784ca810319SHong Zhang PetscErrorCode MatMumpsGetInfog(Mat F,PetscInt icntl,PetscInt *ival)
2785bc6112feSHong Zhang {
2786bc6112feSHong Zhang   PetscFunctionBegin;
27872989dfd4SHong Zhang   PetscValidType(F,1);
278828b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2789ca810319SHong Zhang   PetscValidIntPointer(ival,3);
2790cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetInfog_C",(Mat,PetscInt,PetscInt*),(F,icntl,ival));
2791bc6112feSHong Zhang   PetscFunctionReturn(0);
2792bc6112feSHong Zhang }
2793bc6112feSHong Zhang 
2794a21f80fcSHong Zhang /*@
2795a21f80fcSHong Zhang   MatMumpsGetRinfo - Get MUMPS parameter RINFO()
2796a21f80fcSHong Zhang 
2797a21f80fcSHong Zhang    Logically Collective on Mat
2798a21f80fcSHong Zhang 
2799a21f80fcSHong Zhang    Input Parameters:
2800a21f80fcSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2801a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array RINFO()
2802a21f80fcSHong Zhang 
2803a21f80fcSHong Zhang   Output Parameter:
2804a21f80fcSHong Zhang .  val - value of MUMPS RINFO(icntl)
2805a21f80fcSHong Zhang 
2806a21f80fcSHong Zhang    Level: beginner
2807a21f80fcSHong Zhang 
280896a0c994SBarry Smith    References:
2809606c0280SSatish Balay .  * - MUMPS Users' Guide
2810a21f80fcSHong Zhang 
2811db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
2812a21f80fcSHong Zhang @*/
2813ca810319SHong Zhang PetscErrorCode MatMumpsGetRinfo(Mat F,PetscInt icntl,PetscReal *val)
2814bc6112feSHong Zhang {
2815bc6112feSHong Zhang   PetscFunctionBegin;
28162989dfd4SHong Zhang   PetscValidType(F,1);
281728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2818bc6112feSHong Zhang   PetscValidRealPointer(val,3);
2819cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetRinfo_C",(Mat,PetscInt,PetscReal*),(F,icntl,val));
2820bc6112feSHong Zhang   PetscFunctionReturn(0);
2821bc6112feSHong Zhang }
2822bc6112feSHong Zhang 
2823a21f80fcSHong Zhang /*@
2824a21f80fcSHong Zhang   MatMumpsGetRinfog - Get MUMPS parameter RINFOG()
2825a21f80fcSHong Zhang 
2826a21f80fcSHong Zhang    Logically Collective on Mat
2827a21f80fcSHong Zhang 
2828a21f80fcSHong Zhang    Input Parameters:
2829a21f80fcSHong Zhang +  F - the factored matrix obtained by calling MatGetFactor() from PETSc-MUMPS interface
2830a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array RINFOG()
2831a21f80fcSHong Zhang 
2832a21f80fcSHong Zhang   Output Parameter:
2833a21f80fcSHong Zhang .  val - value of MUMPS RINFOG(icntl)
2834a21f80fcSHong Zhang 
2835a21f80fcSHong Zhang    Level: beginner
2836a21f80fcSHong Zhang 
283796a0c994SBarry Smith    References:
2838606c0280SSatish Balay .  * - MUMPS Users' Guide
2839a21f80fcSHong Zhang 
2840db781477SPatrick Sanan .seealso: `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
2841a21f80fcSHong Zhang @*/
2842ca810319SHong Zhang PetscErrorCode MatMumpsGetRinfog(Mat F,PetscInt icntl,PetscReal *val)
2843bc6112feSHong Zhang {
2844bc6112feSHong Zhang   PetscFunctionBegin;
28452989dfd4SHong Zhang   PetscValidType(F,1);
284628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype,PetscObjectComm((PetscObject)F),PETSC_ERR_ARG_WRONGSTATE,"Only for factored matrix");
2847bc6112feSHong Zhang   PetscValidRealPointer(val,3);
2848cac4c232SBarry Smith   PetscUseMethod(F,"MatMumpsGetRinfog_C",(Mat,PetscInt,PetscReal*),(F,icntl,val));
2849bc6112feSHong Zhang   PetscFunctionReturn(0);
2850bc6112feSHong Zhang }
2851bc6112feSHong Zhang 
285224b6179bSKris Buschelman /*MC
28532692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
285424b6179bSKris Buschelman   distributed and sequential matrices via the external package MUMPS.
285524b6179bSKris Buschelman 
285641c8de11SBarry Smith   Works with MATAIJ and MATSBAIJ matrices
285724b6179bSKris Buschelman 
2858c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
2859c2b89b5dSBarry Smith 
2860217d3b1eSJunchao Zhang   Use ./configure --with-openmp --download-hwloc (or --with-hwloc) to enable running MUMPS in MPI+OpenMP hybrid mode and non-MUMPS in flat-MPI mode. See details below.
2861217d3b1eSJunchao Zhang 
28623ca39a21SBarry Smith   Use -pc_type cholesky or lu -pc_factor_mat_solver_type mumps to use this direct solver
2863c2b89b5dSBarry Smith 
286424b6179bSKris Buschelman   Options Database Keys:
28654422a9fcSPatrick Sanan +  -mat_mumps_icntl_1 - ICNTL(1): output stream for error messages
28664422a9fcSPatrick Sanan .  -mat_mumps_icntl_2 - ICNTL(2): output stream for diagnostic printing, statistics, and warning
28674422a9fcSPatrick Sanan .  -mat_mumps_icntl_3 -  ICNTL(3): output stream for global information, collected on the host
28684422a9fcSPatrick Sanan .  -mat_mumps_icntl_4 -  ICNTL(4): level of printing (0 to 4)
28694422a9fcSPatrick Sanan .  -mat_mumps_icntl_6 - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
2870b53c1a7fSBarry Smith .  -mat_mumps_icntl_7 - ICNTL(7): computes a symmetric permutation in sequential analysis, 0=AMD, 2=AMF, 3=Scotch, 4=PORD, 5=Metis, 6=QAMD, and 7=auto
2871b53c1a7fSBarry Smith                         Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
28724422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
28734422a9fcSPatrick Sanan .  -mat_mumps_icntl_10  - ICNTL(10): max num of refinements
28744422a9fcSPatrick Sanan .  -mat_mumps_icntl_11  - ICNTL(11): statistics related to an error analysis (via -ksp_view)
28754422a9fcSPatrick Sanan .  -mat_mumps_icntl_12  - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
28764422a9fcSPatrick Sanan .  -mat_mumps_icntl_13  - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
28774422a9fcSPatrick Sanan .  -mat_mumps_icntl_14  - ICNTL(14): percentage increase in the estimated working space
287845e3843bSPierre Jolivet .  -mat_mumps_icntl_15  - ICNTL(15): compression of the input matrix resulting from a block format
28794422a9fcSPatrick Sanan .  -mat_mumps_icntl_19  - ICNTL(19): computes the Schur complement
288025aac85cSJunchao Zhang .  -mat_mumps_icntl_20  - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
28814422a9fcSPatrick Sanan .  -mat_mumps_icntl_22  - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
28824422a9fcSPatrick Sanan .  -mat_mumps_icntl_23  - ICNTL(23): max size of the working memory (MB) that can allocate per processor
28834422a9fcSPatrick Sanan .  -mat_mumps_icntl_24  - ICNTL(24): detection of null pivot rows (0 or 1)
28844422a9fcSPatrick Sanan .  -mat_mumps_icntl_25  - ICNTL(25): compute a solution of a deficient matrix and a null space basis
28854422a9fcSPatrick Sanan .  -mat_mumps_icntl_26  - ICNTL(26): drives the solution phase if a Schur complement matrix
28864422a9fcSPatrick Sanan .  -mat_mumps_icntl_28  - ICNTL(28): use 1 for sequential analysis and ictnl(7) ordering, or 2 for parallel analysis and ictnl(29) ordering
28874422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
28884422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
28894422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
28904422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
2891a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
2892a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
2893a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
28944422a9fcSPatrick Sanan .  -mat_mumps_cntl_1  - CNTL(1): relative pivoting threshold
28954422a9fcSPatrick Sanan .  -mat_mumps_cntl_2  -  CNTL(2): stopping criterion of refinement
28964422a9fcSPatrick Sanan .  -mat_mumps_cntl_3 - CNTL(3): absolute pivoting threshold
28974422a9fcSPatrick Sanan .  -mat_mumps_cntl_4 - CNTL(4): value for static pivoting
2898217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5 - CNTL(5): fixation for null pivots
2899a0e18203SThibaut Appel .  -mat_mumps_cntl_7 - CNTL(7): precision of the dropping parameter used during BLR factorization
2900217d3b1eSJunchao Zhang -  -mat_mumps_use_omp_threads [m] - run MUMPS in MPI+OpenMP hybrid mode as if omp_set_num_threads(m) is called before calling MUMPS.
2901217d3b1eSJunchao Zhang                                    Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
290224b6179bSKris Buschelman 
290324b6179bSKris Buschelman   Level: beginner
290424b6179bSKris Buschelman 
290595452b02SPatrick Sanan     Notes:
290638548759SBarry Smith     MUMPS Cholesky does not handle (complex) Hermitian matrices http://mumps.enseeiht.fr/doc/userguide_5.2.1.pdf so using it will error if the matrix is Hermitian.
290738548759SBarry Smith 
2908*26cc229bSBarry Smith     When used within a `KSP`/`PC` solve the options are prefixed with that of the `PC`. Otherwise one can set the options prefix by calling
2909*26cc229bSBarry Smith     `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
2910*26cc229bSBarry Smith 
2911c0decd05SBarry Smith     When a MUMPS factorization fails inside a KSP solve, for example with a KSP_DIVERGED_PC_FAILED, one can find the MUMPS information about the failure by calling
29129fc87aa7SBarry Smith $          KSPGetPC(ksp,&pc);
29139fc87aa7SBarry Smith $          PCFactorGetMatrix(pc,&mat);
29149fc87aa7SBarry Smith $          MatMumpsGetInfo(mat,....);
29159fc87aa7SBarry Smith $          MatMumpsGetInfog(mat,....); etc.
29169fc87aa7SBarry Smith            Or you can run with -ksp_error_if_not_converged and the program will be stopped and the information printed in the error message.
29179fc87aa7SBarry Smith 
2918a5399872SJunchao Zhang   Using MUMPS with 64-bit integers
2919a5399872SJunchao Zhang     MUMPS provides 64-bit integer support in two build modes:
2920a5399872SJunchao Zhang       full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
2921a5399872SJunchao Zhang       requires all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS built the same way with 64-bit integers (for example ILP64 Intel MKL and MPI).
29228fcaa860SBarry Smith 
2923a5399872SJunchao Zhang       selective 64-bit: with the default MUMPS build, 64-bit integers have been introduced where needed. In compressed sparse row (CSR) storage of matrices,
2924a5399872SJunchao Zhang       MUMPS stores column indices in 32-bit, but row offsets in 64-bit, so you can have a huge number of non-zeros, but must have less than 2^31 rows and
2925a5399872SJunchao Zhang       columns. This can lead to significant memory and performance gains with respect to a full 64-bit integer MUMPS version. This requires a regular (32-bit
2926a5399872SJunchao Zhang       integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
2927a5399872SJunchao Zhang 
2928a5399872SJunchao Zhang     With --download-mumps=1, PETSc always build MUMPS in selective 64-bit mode, which can be used by both --with-64-bit-indices=0/1 variants of PETSc.
2929a5399872SJunchao Zhang 
2930a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
29318fcaa860SBarry Smith $     Set OMP_NUM_THREADS and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
29328fcaa860SBarry Smith $     threads per rank, then you may use "export OMP_NUM_THREADS=16 && mpirun -n 4 ./test".
29338fcaa860SBarry Smith 
29348fcaa860SBarry Smith $     -mat_mumps_use_omp_threads [m] and run your code with as many MPI ranks as the number of cores. For example,
29358fcaa860SBarry Smith $     if a compute node has 32 cores and you run on two nodes, you may use "mpirun -n 64 ./test -mat_mumps_use_omp_threads 16"
29368fcaa860SBarry Smith 
29378fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
2938217d3b1eSJunchao Zhang    (i.e., PETSc part) of your code in the so-called flat-MPI (aka pure-MPI) mode, you need to configure PETSc with --with-openmp --download-hwloc
2939217d3b1eSJunchao Zhang    (or --with-hwloc), and have an MPI that supports MPI-3.0's process shared memory (which is usually available). Since MUMPS calls BLAS
29408fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
29418fcaa860SBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if --with-openmp is provided).
2942217d3b1eSJunchao Zhang 
29438fcaa860SBarry Smith    If you run your code through a job submission system, there are caveats in MPI rank mapping. We use MPI_Comm_split_type() to obtain MPI
2944217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
2945217d3b1eSJunchao Zhang    size m and create a communicator called omp_comm for each group. Rank 0 in an omp_comm is called the master rank, and others in the omp_comm
2946217d3b1eSJunchao Zhang    are called slave ranks (or slaves). Only master ranks are seen to MUMPS and slaves are not. We will free CPUs assigned to slaves (might be set
2947217d3b1eSJunchao Zhang    by CPU binding policies in job scripts) and make the CPUs available to the master so that OMP threads spawned by MUMPS can run on the CPUs.
2948217d3b1eSJunchao Zhang    In a multi-socket compute node, MPI rank mapping is an issue. Still use the above example and suppose your compute node has two sockets,
2949217d3b1eSJunchao Zhang    if you interleave MPI ranks on the two sockets, in other words, even ranks are placed on socket 0, and odd ranks are on socket 1, and bind
2950217d3b1eSJunchao Zhang    MPI ranks to cores, then with -mat_mumps_use_omp_threads 16, a master rank (and threads it spawns) will use half cores in socket 0, and half
2951217d3b1eSJunchao Zhang    cores in socket 1, that definitely hurts locality. On the other hand, if you map MPI ranks consecutively on the two sockets, then the
2952217d3b1eSJunchao Zhang    problem will not happen. Therefore, when you use -mat_mumps_use_omp_threads, you need to keep an eye on your MPI rank mapping and CPU binding.
29538fcaa860SBarry Smith    For example, with the Slurm job scheduler, one can use srun --cpu-bind=verbose -m block:block to map consecutive MPI ranks to sockets and
2954217d3b1eSJunchao Zhang    examine the mapping result.
2955217d3b1eSJunchao Zhang 
2956217d3b1eSJunchao Zhang    PETSc does not control thread binding in MUMPS. So to get best performance, one still has to set OMP_PROC_BIND and OMP_PLACES in job scripts,
2957217d3b1eSJunchao Zhang    for example, export OMP_PLACES=threads and export OMP_PROC_BIND=spread. One does not need to export OMP_NUM_THREADS=m in job scripts as PETSc
2958217d3b1eSJunchao Zhang    calls omp_set_num_threads(m) internally before calling MUMPS.
2959217d3b1eSJunchao Zhang 
2960217d3b1eSJunchao Zhang    References:
2961606c0280SSatish Balay +  * - Heroux, Michael A., R. Brightwell, and Michael M. Wolf. "Bi-modal MPI and MPI+ threads computing on scalable multicore systems." IJHPCA (Submitted) (2011).
2962606c0280SSatish Balay -  * - Gutierrez, Samuel K., et al. "Accommodating Thread-Level Heterogeneity in Coupled Parallel Applications." Parallel and Distributed Processing Symposium (IPDPS), 2017 IEEE International. IEEE, 2017.
2963217d3b1eSJunchao Zhang 
2964db781477SPatrick Sanan .seealso: `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `KSPGetPC()`, `PCFactorGetMatrix()`
296541c8de11SBarry Smith 
296624b6179bSKris Buschelman M*/
296724b6179bSKris Buschelman 
2968ea799195SBarry Smith static PetscErrorCode MatFactorGetSolverType_mumps(Mat A,MatSolverType *type)
296935bd34faSBarry Smith {
297035bd34faSBarry Smith   PetscFunctionBegin;
29712692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
297235bd34faSBarry Smith   PetscFunctionReturn(0);
297335bd34faSBarry Smith }
297435bd34faSBarry Smith 
2975bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
2976cc2e6a90SBarry Smith static PetscErrorCode MatGetFactor_aij_mumps(Mat A,MatFactorType ftype,Mat *F)
29772877fffaSHong Zhang {
29782877fffaSHong Zhang   Mat            B;
29792877fffaSHong Zhang   Mat_MUMPS      *mumps;
2980ace3abfcSBarry Smith   PetscBool      isSeqAIJ;
29812c7c0729SBarry Smith   PetscMPIInt    size;
29822877fffaSHong Zhang 
29832877fffaSHong Zhang   PetscFunctionBegin;
2984eb1ec7c1SStefano Zampini  #if defined(PETSC_USE_COMPLEX)
2985aed4548fSBarry Smith   PetscCheck(!A->hermitian || A->symmetric || ftype != MAT_FACTOR_CHOLESKY,PETSC_COMM_SELF,PETSC_ERR_SUP,"Hermitian CHOLESKY Factor is not supported");
2986eb1ec7c1SStefano Zampini  #endif
29872877fffaSHong Zhang   /* Create the factorization matrix */
29889566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A,MATSEQAIJ,&isSeqAIJ));
29899566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A),&B));
29909566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N));
29919566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps",&((PetscObject)B)->type_name));
29929566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
29932877fffaSHong Zhang 
29949566063dSJacob Faibussowitsch   PetscCall(PetscNewLog(B,&mumps));
29952205254eSKarl Rupp 
29962877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
299735bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
29982205254eSKarl Rupp 
29999566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorGetSolverType_C",MatFactorGetSolverType_mumps));
30009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorSetSchurIS_C",MatFactorSetSchurIS_MUMPS));
30019566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorCreateSchurComplement_C",MatFactorCreateSchurComplement_MUMPS));
30029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetIcntl_C",MatMumpsSetIcntl_MUMPS));
30039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetIcntl_C",MatMumpsGetIcntl_MUMPS));
30049566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetCntl_C",MatMumpsSetCntl_MUMPS));
30059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetCntl_C",MatMumpsGetCntl_MUMPS));
30069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfo_C",MatMumpsGetInfo_MUMPS));
30079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfog_C",MatMumpsGetInfog_MUMPS));
30089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfo_C",MatMumpsGetRinfo_MUMPS));
30099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfog_C",MatMumpsGetRinfog_MUMPS));
30109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInverse_C",MatMumpsGetInverse_MUMPS));
30119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInverseTranspose_C",MatMumpsGetInverseTranspose_MUMPS));
30126444a565SStefano Zampini 
3013450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3014450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3015d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3016bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3017bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
30189566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL,(char**)&B->preferredordering[MAT_FACTOR_LU]));
3019746480a1SHong Zhang     mumps->sym = 0;
3020dcd589f8SShri Abhyankar   } else {
302167877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3022450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3023bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3024bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
30259566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL,(char**)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
302659ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
302759ac8732SStefano Zampini     mumps->sym = 2;
302859ac8732SStefano Zampini #else
30296fdc2a6dSBarry Smith     if (A->spd_set && A->spd) mumps->sym = 1;
30306fdc2a6dSBarry Smith     else                      mumps->sym = 2;
303159ac8732SStefano Zampini #endif
3032450b117fSShri Abhyankar   }
30332877fffaSHong Zhang 
303400c67f3bSHong Zhang   /* set solvertype */
30359566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
30369566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS,&B->solvertype));
30379566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A),&size));
30382c7c0729SBarry Smith   if (size == 1) {
30394ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3040f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
30412c7c0729SBarry Smith   }
30422877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3043e69c285eSBarry Smith   B->data         = (void*)mumps;
30442205254eSKarl Rupp 
3045*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS_OpenMP(B,A));
3046746480a1SHong Zhang 
30472877fffaSHong Zhang   *F = B;
3048d47f36abSHong Zhang   mumps->matstruc = DIFFERENT_NONZERO_PATTERN;
30492877fffaSHong Zhang   PetscFunctionReturn(0);
30502877fffaSHong Zhang }
30512877fffaSHong Zhang 
3052bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3053cc2e6a90SBarry Smith static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A,MatFactorType ftype,Mat *F)
30542877fffaSHong Zhang {
30552877fffaSHong Zhang   Mat            B;
30562877fffaSHong Zhang   Mat_MUMPS      *mumps;
3057ace3abfcSBarry Smith   PetscBool      isSeqSBAIJ;
30582c7c0729SBarry Smith   PetscMPIInt    size;
30592877fffaSHong Zhang 
30602877fffaSHong Zhang   PetscFunctionBegin;
3061eb1ec7c1SStefano Zampini  #if defined(PETSC_USE_COMPLEX)
306208401ef6SPierre Jolivet   PetscCheck(!A->hermitian || A->symmetric,PETSC_COMM_SELF,PETSC_ERR_SUP,"Hermitian CHOLESKY Factor is not supported");
3063eb1ec7c1SStefano Zampini  #endif
30649566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A),&B));
30659566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N));
30669566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps",&((PetscObject)B)->type_name));
30679566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3068e69c285eSBarry Smith 
30699566063dSJacob Faibussowitsch   PetscCall(PetscNewLog(B,&mumps));
30709566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A,MATSEQSBAIJ,&isSeqSBAIJ));
3071bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
307216ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3073dcd589f8SShri Abhyankar   } else {
3074bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3075bccb9932SShri Abhyankar   }
3076bccb9932SShri Abhyankar 
307767877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3078bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3079722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
30802205254eSKarl Rupp 
30819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorGetSolverType_C",MatFactorGetSolverType_mumps));
30829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorSetSchurIS_C",MatFactorSetSchurIS_MUMPS));
30839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorCreateSchurComplement_C",MatFactorCreateSchurComplement_MUMPS));
30849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetIcntl_C",MatMumpsSetIcntl_MUMPS));
30859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetIcntl_C",MatMumpsGetIcntl_MUMPS));
30869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetCntl_C",MatMumpsSetCntl_MUMPS));
30879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetCntl_C",MatMumpsGetCntl_MUMPS));
30889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfo_C",MatMumpsGetInfo_MUMPS));
30899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfog_C",MatMumpsGetInfog_MUMPS));
30909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfo_C",MatMumpsGetRinfo_MUMPS));
30919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfog_C",MatMumpsGetRinfog_MUMPS));
30929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInverse_C",MatMumpsGetInverse_MUMPS));
30939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInverseTranspose_C",MatMumpsGetInverseTranspose_MUMPS));
30942205254eSKarl Rupp 
3095f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
309659ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
309759ac8732SStefano Zampini   mumps->sym = 2;
309859ac8732SStefano Zampini #else
30996fdc2a6dSBarry Smith   if (A->spd_set && A->spd) mumps->sym = 1;
31006fdc2a6dSBarry Smith   else                      mumps->sym = 2;
310159ac8732SStefano Zampini #endif
3102a214ac2aSShri Abhyankar 
310300c67f3bSHong Zhang   /* set solvertype */
31049566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
31059566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS,&B->solvertype));
31069566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A),&size));
31072c7c0729SBarry Smith   if (size == 1) {
31084ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3109f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
31102c7c0729SBarry Smith   }
31119566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL,(char**)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3112f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3113e69c285eSBarry Smith   B->data         = (void*)mumps;
31142205254eSKarl Rupp 
3115*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS_OpenMP(B,A));
3116746480a1SHong Zhang 
31172877fffaSHong Zhang   *F = B;
3118d47f36abSHong Zhang   mumps->matstruc = DIFFERENT_NONZERO_PATTERN;
31192877fffaSHong Zhang   PetscFunctionReturn(0);
31202877fffaSHong Zhang }
312197969023SHong Zhang 
3122cc2e6a90SBarry Smith static PetscErrorCode MatGetFactor_baij_mumps(Mat A,MatFactorType ftype,Mat *F)
312367877ebaSShri Abhyankar {
312467877ebaSShri Abhyankar   Mat            B;
312567877ebaSShri Abhyankar   Mat_MUMPS      *mumps;
3126ace3abfcSBarry Smith   PetscBool      isSeqBAIJ;
31272c7c0729SBarry Smith   PetscMPIInt    size;
312867877ebaSShri Abhyankar 
312967877ebaSShri Abhyankar   PetscFunctionBegin;
313067877ebaSShri Abhyankar   /* Create the factorization matrix */
31319566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A,MATSEQBAIJ,&isSeqBAIJ));
31329566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A),&B));
31339566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N));
31349566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps",&((PetscObject)B)->type_name));
31359566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3136450b117fSShri Abhyankar 
31379566063dSJacob Faibussowitsch   PetscCall(PetscNewLog(B,&mumps));
3138450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3139450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3140450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3141bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3142bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3143746480a1SHong Zhang     mumps->sym = 0;
31449566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL,(char**)&B->preferredordering[MAT_FACTOR_LU]));
3145546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3146bccb9932SShri Abhyankar 
3147450b117fSShri Abhyankar   B->ops->view        = MatView_MUMPS;
3148722b6324SPierre Jolivet   B->ops->getinfo     = MatGetInfo_MUMPS;
31492205254eSKarl Rupp 
31509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorGetSolverType_C",MatFactorGetSolverType_mumps));
31519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorSetSchurIS_C",MatFactorSetSchurIS_MUMPS));
31529566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorCreateSchurComplement_C",MatFactorCreateSchurComplement_MUMPS));
31539566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetIcntl_C",MatMumpsSetIcntl_MUMPS));
31549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetIcntl_C",MatMumpsGetIcntl_MUMPS));
31559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetCntl_C",MatMumpsSetCntl_MUMPS));
31569566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetCntl_C",MatMumpsGetCntl_MUMPS));
31579566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfo_C",MatMumpsGetInfo_MUMPS));
31589566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfog_C",MatMumpsGetInfog_MUMPS));
31599566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfo_C",MatMumpsGetRinfo_MUMPS));
31609566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfog_C",MatMumpsGetRinfog_MUMPS));
31619566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInverse_C",MatMumpsGetInverse_MUMPS));
31629566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInverseTranspose_C",MatMumpsGetInverseTranspose_MUMPS));
3163450b117fSShri Abhyankar 
316400c67f3bSHong Zhang   /* set solvertype */
31659566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
31669566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS,&B->solvertype));
31679566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A),&size));
31682c7c0729SBarry Smith   if (size == 1) {
31694ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3170f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
31712c7c0729SBarry Smith   }
31727ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
31737ee00b23SStefano Zampini   B->data         = (void*)mumps;
31747ee00b23SStefano Zampini 
3175*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS_OpenMP(B,A));
31767ee00b23SStefano Zampini 
31777ee00b23SStefano Zampini   *F = B;
3178d47f36abSHong Zhang   mumps->matstruc = DIFFERENT_NONZERO_PATTERN;
31797ee00b23SStefano Zampini   PetscFunctionReturn(0);
31807ee00b23SStefano Zampini }
31817ee00b23SStefano Zampini 
31827ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
31837ee00b23SStefano Zampini static PetscErrorCode MatGetFactor_sell_mumps(Mat A,MatFactorType ftype,Mat *F)
31847ee00b23SStefano Zampini {
31857ee00b23SStefano Zampini   Mat            B;
31867ee00b23SStefano Zampini   Mat_MUMPS      *mumps;
31877ee00b23SStefano Zampini   PetscBool      isSeqSELL;
31882c7c0729SBarry Smith   PetscMPIInt    size;
31897ee00b23SStefano Zampini 
31907ee00b23SStefano Zampini   PetscFunctionBegin;
31917ee00b23SStefano Zampini   /* Create the factorization matrix */
31929566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A,MATSEQSELL,&isSeqSELL));
31939566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A),&B));
31949566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B,A->rmap->n,A->cmap->n,A->rmap->N,A->cmap->N));
31959566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps",&((PetscObject)B)->type_name));
31969566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
31977ee00b23SStefano Zampini 
31989566063dSJacob Faibussowitsch   PetscCall(PetscNewLog(B,&mumps));
31997ee00b23SStefano Zampini 
32007ee00b23SStefano Zampini   B->ops->view        = MatView_MUMPS;
32017ee00b23SStefano Zampini   B->ops->getinfo     = MatGetInfo_MUMPS;
32027ee00b23SStefano Zampini 
32039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorGetSolverType_C",MatFactorGetSolverType_mumps));
32049566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorSetSchurIS_C",MatFactorSetSchurIS_MUMPS));
32059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatFactorCreateSchurComplement_C",MatFactorCreateSchurComplement_MUMPS));
32069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetIcntl_C",MatMumpsSetIcntl_MUMPS));
32079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetIcntl_C",MatMumpsGetIcntl_MUMPS));
32089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsSetCntl_C",MatMumpsSetCntl_MUMPS));
32099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetCntl_C",MatMumpsGetCntl_MUMPS));
32109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfo_C",MatMumpsGetInfo_MUMPS));
32119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetInfog_C",MatMumpsGetInfog_MUMPS));
32129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfo_C",MatMumpsGetRinfo_MUMPS));
32139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B,"MatMumpsGetRinfog_C",MatMumpsGetRinfog_MUMPS));
32147ee00b23SStefano Zampini 
32157ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
32167ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
32177ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
32187ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
32197ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"To be implemented");
32207ee00b23SStefano Zampini     mumps->sym = 0;
32219566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL,(char**)&B->preferredordering[MAT_FACTOR_LU]));
32227ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A),PETSC_ERR_SUP,"To be implemented");
32237ee00b23SStefano Zampini 
32247ee00b23SStefano Zampini   /* set solvertype */
32259566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
32269566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS,&B->solvertype));
32279566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A),&size));
32282c7c0729SBarry Smith   if (size == 1) {
32294ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3230f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
32312c7c0729SBarry Smith   }
3232450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3233e69c285eSBarry Smith   B->data         = (void*)mumps;
32342205254eSKarl Rupp 
3235*26cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS_OpenMP(B,A));
3236746480a1SHong Zhang 
3237450b117fSShri Abhyankar   *F = B;
3238d47f36abSHong Zhang   mumps->matstruc = DIFFERENT_NONZERO_PATTERN;
3239450b117fSShri Abhyankar   PetscFunctionReturn(0);
3240450b117fSShri Abhyankar }
324142c9c57cSBarry Smith 
32423ca39a21SBarry Smith PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
324342c9c57cSBarry Smith {
324442c9c57cSBarry Smith   PetscFunctionBegin;
32459566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATMPIAIJ,MAT_FACTOR_LU,MatGetFactor_aij_mumps));
32469566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATMPIAIJ,MAT_FACTOR_CHOLESKY,MatGetFactor_aij_mumps));
32479566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATMPIBAIJ,MAT_FACTOR_LU,MatGetFactor_baij_mumps));
32489566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATMPIBAIJ,MAT_FACTOR_CHOLESKY,MatGetFactor_baij_mumps));
32499566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATMPISBAIJ,MAT_FACTOR_CHOLESKY,MatGetFactor_sbaij_mumps));
32509566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATSEQAIJ,MAT_FACTOR_LU,MatGetFactor_aij_mumps));
32519566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATSEQAIJ,MAT_FACTOR_CHOLESKY,MatGetFactor_aij_mumps));
32529566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATSEQBAIJ,MAT_FACTOR_LU,MatGetFactor_baij_mumps));
32539566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATSEQBAIJ,MAT_FACTOR_CHOLESKY,MatGetFactor_baij_mumps));
32549566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATSEQSBAIJ,MAT_FACTOR_CHOLESKY,MatGetFactor_sbaij_mumps));
32559566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS,MATSEQSELL,MAT_FACTOR_LU,MatGetFactor_sell_mumps));
325642c9c57cSBarry Smith   PetscFunctionReturn(0);
325742c9c57cSBarry Smith }
3258