xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision 36df9881c0c58d993e32442391c97ec4e84645c0)
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
26413bcc21SPierre Jolivet #define JOB_NULL         0
273d472b54SHong Zhang #define JOB_FACTSYMBOLIC 1
283d472b54SHong Zhang #define JOB_FACTNUMERIC  2
293d472b54SHong Zhang #define JOB_SOLVE        3
30397b6df1SKris Buschelman #define JOB_END          -2
313d472b54SHong Zhang 
322907cef9SHong Zhang /* calls to MUMPS */
332907cef9SHong Zhang #if defined(PETSC_USE_COMPLEX)
342907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
353ab56b82SJunchao Zhang     #define MUMPS_c cmumps_c
362907cef9SHong Zhang   #else
373ab56b82SJunchao Zhang     #define MUMPS_c zmumps_c
382907cef9SHong Zhang   #endif
392907cef9SHong Zhang #else
402907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
413ab56b82SJunchao Zhang     #define MUMPS_c smumps_c
422907cef9SHong Zhang   #else
433ab56b82SJunchao Zhang     #define MUMPS_c dmumps_c
442907cef9SHong Zhang   #endif
452907cef9SHong Zhang #endif
462907cef9SHong Zhang 
47a6053eceSJunchao Zhang /* MUMPS uses MUMPS_INT for nonzero indices such as irn/jcn, irn_loc/jcn_loc and uses int64_t for
48a6053eceSJunchao Zhang    number of nonzeros such as nnz, nnz_loc. We typedef MUMPS_INT to PetscMUMPSInt to follow the
49a6053eceSJunchao Zhang    naming convention in PetscMPIInt, PetscBLASInt etc.
50a6053eceSJunchao Zhang */
51a6053eceSJunchao Zhang typedef MUMPS_INT PetscMUMPSInt;
52a6053eceSJunchao Zhang 
5367602552SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5, 3, 0)
5467602552SJunchao 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 */
55a6053eceSJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
5667602552SJunchao Zhang   #endif
57a6053eceSJunchao Zhang #else
5867602552SJunchao Zhang   #if defined(INTSIZE64) /* INTSIZE64 is a command line macro one used to build MUMPS in full 64-bit mode */
5967602552SJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
6067602552SJunchao Zhang   #endif
6167602552SJunchao Zhang #endif
6267602552SJunchao Zhang 
63a6053eceSJunchao Zhang #define MPIU_MUMPSINT       MPI_INT
64a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MAX 2147483647
65a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MIN -2147483648
66a6053eceSJunchao Zhang 
67a6053eceSJunchao Zhang /* Cast PetscInt to PetscMUMPSInt. Usually there is no overflow since <a> is row/col indices or some small integers*/
68d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscMUMPSIntCast(PetscInt a, PetscMUMPSInt *b)
69d71ae5a4SJacob Faibussowitsch {
70a6053eceSJunchao Zhang   PetscFunctionBegin;
71ece88022SPierre Jolivet #if PetscDefined(USE_64BIT_INDICES)
722c71b3e2SJacob Faibussowitsch   PetscAssert(a <= PETSC_MUMPS_INT_MAX && a >= PETSC_MUMPS_INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
73ece88022SPierre Jolivet #endif
74a6053eceSJunchao Zhang   *b = (PetscMUMPSInt)(a);
753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
76a6053eceSJunchao Zhang }
77a6053eceSJunchao Zhang 
78a6053eceSJunchao Zhang /* Put these utility routines here since they are only used in this file */
79d71ae5a4SJacob 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)
80d71ae5a4SJacob Faibussowitsch {
81a6053eceSJunchao Zhang   PetscInt  myval;
82a6053eceSJunchao Zhang   PetscBool myset;
83a6053eceSJunchao Zhang   PetscFunctionBegin;
84a6053eceSJunchao Zhang   /* PetscInt's size should be always >= PetscMUMPSInt's. It is safe to call PetscOptionsInt_Private to read a PetscMUMPSInt */
859566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, (PetscInt)currentvalue, &myval, &myset, lb, ub));
869566063dSJacob Faibussowitsch   if (myset) PetscCall(PetscMUMPSIntCast(myval, value));
87a6053eceSJunchao Zhang   if (set) *set = myset;
883ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
89a6053eceSJunchao Zhang }
90a6053eceSJunchao 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)
91a6053eceSJunchao Zhang 
92217d3b1eSJunchao 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 */
933ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
943ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
953ab56b82SJunchao Zhang     do { \
963ab56b82SJunchao Zhang       if (mumps->use_petsc_omp_support) { \
973ab56b82SJunchao Zhang         if (mumps->is_omp_master) { \
989566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterBegin(mumps->omp_ctrl)); \
993ab56b82SJunchao Zhang           MUMPS_c(&mumps->id); \
1009566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterEnd(mumps->omp_ctrl)); \
1013ab56b82SJunchao Zhang         } \
1029566063dSJacob Faibussowitsch         PetscCall(PetscOmpCtrlBarrier(mumps->omp_ctrl)); \
103c3714a1dSJunchao Zhang         /* Global info is same on all processes so we Bcast it within omp_comm. Local info is specific      \
104c3714a1dSJunchao Zhang          to processes, so we only Bcast info[1], an error code and leave others (since they do not have   \
105c3714a1dSJunchao Zhang          an easy translation between omp_comm and petsc_comm). See MUMPS-5.1.2 manual p82.                   \
106c3714a1dSJunchao Zhang          omp_comm is a small shared memory communicator, hence doing multiple Bcast as shown below is OK. \
107c3714a1dSJunchao Zhang       */ \
1089566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Bcast(mumps->id.infog, 40, MPIU_MUMPSINT, 0, mumps->omp_comm)); \
1099566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Bcast(mumps->id.rinfog, 20, MPIU_REAL, 0, mumps->omp_comm)); \
1109566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Bcast(mumps->id.info, 1, MPIU_MUMPSINT, 0, mumps->omp_comm)); \
1113ab56b82SJunchao Zhang       } else { \
1123ab56b82SJunchao Zhang         MUMPS_c(&mumps->id); \
1133ab56b82SJunchao Zhang       } \
1143ab56b82SJunchao Zhang     } while (0)
1153ab56b82SJunchao Zhang #else
1163ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
117d71ae5a4SJacob Faibussowitsch     do { \
118d71ae5a4SJacob Faibussowitsch       MUMPS_c(&mumps->id); \
119d71ae5a4SJacob Faibussowitsch     } while (0)
1203ab56b82SJunchao Zhang #endif
1213ab56b82SJunchao Zhang 
122940cd9d6SSatish Balay /* declare MumpsScalar */
123940cd9d6SSatish Balay #if defined(PETSC_USE_COMPLEX)
124940cd9d6SSatish Balay   #if defined(PETSC_USE_REAL_SINGLE)
125940cd9d6SSatish Balay     #define MumpsScalar mumps_complex
126940cd9d6SSatish Balay   #else
127940cd9d6SSatish Balay     #define MumpsScalar mumps_double_complex
128940cd9d6SSatish Balay   #endif
129940cd9d6SSatish Balay #else
130940cd9d6SSatish Balay   #define MumpsScalar PetscScalar
131940cd9d6SSatish Balay #endif
1323d472b54SHong Zhang 
133397b6df1SKris Buschelman /* macros s.t. indices match MUMPS documentation */
134397b6df1SKris Buschelman #define ICNTL(I)  icntl[(I)-1]
135397b6df1SKris Buschelman #define CNTL(I)   cntl[(I)-1]
136397b6df1SKris Buschelman #define INFOG(I)  infog[(I)-1]
137a7aca84bSHong Zhang #define INFO(I)   info[(I)-1]
138397b6df1SKris Buschelman #define RINFOG(I) rinfog[(I)-1]
139adc1d99fSHong Zhang #define RINFO(I)  rinfo[(I)-1]
140397b6df1SKris Buschelman 
141a6053eceSJunchao Zhang typedef struct Mat_MUMPS Mat_MUMPS;
142a6053eceSJunchao Zhang struct Mat_MUMPS {
143397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
1442907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1452907cef9SHong Zhang   CMUMPS_STRUC_C id;
1462907cef9SHong Zhang   #else
147397b6df1SKris Buschelman   ZMUMPS_STRUC_C id;
1482907cef9SHong Zhang   #endif
1492907cef9SHong Zhang #else
1502907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1512907cef9SHong Zhang   SMUMPS_STRUC_C id;
152397b6df1SKris Buschelman   #else
153397b6df1SKris Buschelman   DMUMPS_STRUC_C id;
154397b6df1SKris Buschelman   #endif
1552907cef9SHong Zhang #endif
1562907cef9SHong Zhang 
157397b6df1SKris Buschelman   MatStructure   matstruc;
1582d4298aeSJunchao Zhang   PetscMPIInt    myid, petsc_size;
159a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;       /* the (i,j,v) triplets passed to mumps. */
160a6053eceSJunchao 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. */
161a6053eceSJunchao Zhang   PetscInt64     nnz;             /* number of nonzeros. The type is called selective 64-bit in mumps */
162a6053eceSJunchao Zhang   PetscMUMPSInt  sym;
1632d4298aeSJunchao Zhang   MPI_Comm       mumps_comm;
164413bcc21SPierre Jolivet   PetscMUMPSInt *ICNTL_pre;
165413bcc21SPierre Jolivet   PetscReal     *CNTL_pre;
166a6053eceSJunchao Zhang   PetscMUMPSInt  ICNTL9_pre;         /* check if ICNTL(9) is changed from previous MatSolve */
167801fbe65SHong Zhang   VecScatter     scat_rhs, scat_sol; /* used by MatSolve() */
16825aac85cSJunchao Zhang   PetscMUMPSInt  ICNTL20;            /* use centralized (0) or distributed (10) dense RHS */
16967602552SJunchao Zhang   PetscMUMPSInt  lrhs_loc, nloc_rhs, *irhs_loc;
17067602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
17167602552SJunchao Zhang   PetscInt    *rhs_nrow, max_nrhs;
17267602552SJunchao Zhang   PetscMPIInt *rhs_recvcounts, *rhs_disps;
17367602552SJunchao Zhang   PetscScalar *rhs_loc, *rhs_recvbuf;
17467602552SJunchao Zhang #endif
175801fbe65SHong Zhang   Vec            b_seq, x_seq;
176a6053eceSJunchao Zhang   PetscInt       ninfo, *info; /* which INFO to display */
177b5fa320bSStefano Zampini   PetscInt       sizeredrhs;
17859ac8732SStefano Zampini   PetscScalar   *schur_sol;
17959ac8732SStefano Zampini   PetscInt       schur_sizesol;
180a6053eceSJunchao Zhang   PetscMUMPSInt *ia_alloc, *ja_alloc; /* work arrays used for the CSR struct for sparse rhs */
181a6053eceSJunchao Zhang   PetscInt64     cur_ilen, cur_jlen;  /* current len of ia_alloc[], ja_alloc[] */
182a6053eceSJunchao Zhang   PetscErrorCode (*ConvertToTriples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1832205254eSKarl Rupp 
184a6053eceSJunchao Zhang   /* stuff used by petsc/mumps OpenMP support*/
1853ab56b82SJunchao Zhang   PetscBool    use_petsc_omp_support;
186da81f932SPierre Jolivet   PetscOmpCtrl omp_ctrl;             /* an OpenMP controller that blocked processes will release their CPU (MPI_Barrier does not have this guarantee) */
1873ab56b82SJunchao Zhang   MPI_Comm     petsc_comm, omp_comm; /* petsc_comm is petsc matrix's comm */
188a6053eceSJunchao Zhang   PetscInt64  *recvcount;            /* a collection of nnz on omp_master */
189a6053eceSJunchao Zhang   PetscMPIInt  tag, omp_comm_size;
1903ab56b82SJunchao Zhang   PetscBool    is_omp_master; /* is this rank the master of omp_comm */
191a6053eceSJunchao Zhang   MPI_Request *reqs;
192a6053eceSJunchao Zhang };
1933ab56b82SJunchao Zhang 
194a6053eceSJunchao Zhang /* Cast a 1-based CSR represented by (nrow, ia, ja) of type PetscInt to a CSR of type PetscMUMPSInt.
195a6053eceSJunchao Zhang    Here, nrow is number of rows, ia[] is row pointer and ja[] is column indices.
196a6053eceSJunchao Zhang  */
197d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscMUMPSIntCSRCast(Mat_MUMPS *mumps, PetscInt nrow, PetscInt *ia, PetscInt *ja, PetscMUMPSInt **ia_mumps, PetscMUMPSInt **ja_mumps, PetscMUMPSInt *nnz_mumps)
198d71ae5a4SJacob Faibussowitsch {
199a6053eceSJunchao Zhang   PetscInt nnz = ia[nrow] - 1; /* mumps uses 1-based indices. Uses PetscInt instead of PetscInt64 since mumps only uses PetscMUMPSInt for rhs */
200f0c56d0fSKris Buschelman 
201a6053eceSJunchao Zhang   PetscFunctionBegin;
202a6053eceSJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES)
203a6053eceSJunchao Zhang   {
204a6053eceSJunchao Zhang     PetscInt i;
205a6053eceSJunchao Zhang     if (nrow + 1 > mumps->cur_ilen) { /* realloc ia_alloc/ja_alloc to fit ia/ja */
2069566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ia_alloc));
2079566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrow + 1, &mumps->ia_alloc));
208a6053eceSJunchao Zhang       mumps->cur_ilen = nrow + 1;
209a6053eceSJunchao Zhang     }
210a6053eceSJunchao Zhang     if (nnz > mumps->cur_jlen) {
2119566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ja_alloc));
2129566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nnz, &mumps->ja_alloc));
213a6053eceSJunchao Zhang       mumps->cur_jlen = nnz;
214a6053eceSJunchao Zhang     }
2159566063dSJacob Faibussowitsch     for (i = 0; i < nrow + 1; i++) PetscCall(PetscMUMPSIntCast(ia[i], &(mumps->ia_alloc[i])));
2169566063dSJacob Faibussowitsch     for (i = 0; i < nnz; i++) PetscCall(PetscMUMPSIntCast(ja[i], &(mumps->ja_alloc[i])));
217a6053eceSJunchao Zhang     *ia_mumps = mumps->ia_alloc;
218a6053eceSJunchao Zhang     *ja_mumps = mumps->ja_alloc;
219a6053eceSJunchao Zhang   }
220a6053eceSJunchao Zhang #else
221a6053eceSJunchao Zhang   *ia_mumps          = ia;
222a6053eceSJunchao Zhang   *ja_mumps          = ja;
223a6053eceSJunchao Zhang #endif
2249566063dSJacob Faibussowitsch   PetscCall(PetscMUMPSIntCast(nnz, nnz_mumps));
2253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
226a6053eceSJunchao Zhang }
227b24902e0SBarry Smith 
228d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsResetSchur_Private(Mat_MUMPS *mumps)
229d71ae5a4SJacob Faibussowitsch {
230b5fa320bSStefano Zampini   PetscFunctionBegin;
2319566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
2329566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.redrhs));
2339566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->schur_sol));
23459ac8732SStefano Zampini   mumps->id.size_schur = 0;
235b3cb21ddSStefano Zampini   mumps->id.schur_lld  = 0;
23659ac8732SStefano Zampini   mumps->id.ICNTL(19)  = 0;
2373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23859ac8732SStefano Zampini }
23959ac8732SStefano Zampini 
240b3cb21ddSStefano Zampini /* solve with rhs in mumps->id.redrhs and return in the same location */
241d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSolveSchur_Private(Mat F)
242d71ae5a4SJacob Faibussowitsch {
243b3cb21ddSStefano Zampini   Mat_MUMPS           *mumps = (Mat_MUMPS *)F->data;
244b3cb21ddSStefano Zampini   Mat                  S, B, X;
245b3cb21ddSStefano Zampini   MatFactorSchurStatus schurstatus;
246b3cb21ddSStefano Zampini   PetscInt             sizesol;
24759ac8732SStefano Zampini 
24859ac8732SStefano Zampini   PetscFunctionBegin;
2499566063dSJacob Faibussowitsch   PetscCall(MatFactorFactorizeSchurComplement(F));
2509566063dSJacob Faibussowitsch   PetscCall(MatFactorGetSchurComplement(F, &S, &schurstatus));
2519566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &B));
2529566063dSJacob Faibussowitsch   PetscCall(MatSetType(B, ((PetscObject)S)->type_name));
253a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2549566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(B, S->boundtocpu));
255a3d589ffSStefano Zampini #endif
256b3cb21ddSStefano Zampini   switch (schurstatus) {
257d71ae5a4SJacob Faibussowitsch   case MAT_FACTOR_SCHUR_FACTORED:
258d71ae5a4SJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &X));
259d71ae5a4SJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
260a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2619566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
262a3d589ffSStefano Zampini #endif
263b3cb21ddSStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2649566063dSJacob Faibussowitsch       PetscCall(MatMatSolveTranspose(S, B, X));
26559ac8732SStefano Zampini     } else {
2669566063dSJacob Faibussowitsch       PetscCall(MatMatSolve(S, B, X));
26759ac8732SStefano Zampini     }
268b3cb21ddSStefano Zampini     break;
269b3cb21ddSStefano Zampini   case MAT_FACTOR_SCHUR_INVERTED:
270b3cb21ddSStefano Zampini     sizesol = mumps->id.nrhs * mumps->id.size_schur;
27159ac8732SStefano Zampini     if (!mumps->schur_sol || sizesol > mumps->schur_sizesol) {
2729566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->schur_sol));
2739566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(sizesol, &mumps->schur_sol));
27459ac8732SStefano Zampini       mumps->schur_sizesol = sizesol;
275b5fa320bSStefano Zampini     }
2769566063dSJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, mumps->schur_sol, &X));
2779566063dSJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
278a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2799566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
280a3d589ffSStefano Zampini #endif
2819566063dSJacob Faibussowitsch     PetscCall(MatProductCreateWithMat(S, B, NULL, X));
28259ac8732SStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2839566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AtB));
284b5fa320bSStefano Zampini     } else {
2859566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AB));
286b5fa320bSStefano Zampini     }
2879566063dSJacob Faibussowitsch     PetscCall(MatProductSetFromOptions(X));
2889566063dSJacob Faibussowitsch     PetscCall(MatProductSymbolic(X));
2899566063dSJacob Faibussowitsch     PetscCall(MatProductNumeric(X));
2904417c5e8SHong Zhang 
2919566063dSJacob Faibussowitsch     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
292b3cb21ddSStefano Zampini     break;
293d71ae5a4SJacob Faibussowitsch   default:
294d71ae5a4SJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)F), PETSC_ERR_SUP, "Unhandled MatFactorSchurStatus %d", F->schur_status);
29559ac8732SStefano Zampini   }
2969566063dSJacob Faibussowitsch   PetscCall(MatFactorRestoreSchurComplement(F, &S, schurstatus));
2979566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
2989566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&X));
2993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
300b5fa320bSStefano Zampini }
301b5fa320bSStefano Zampini 
302d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsHandleSchur_Private(Mat F, PetscBool expansion)
303d71ae5a4SJacob Faibussowitsch {
304b3cb21ddSStefano Zampini   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
305b5fa320bSStefano Zampini 
306b5fa320bSStefano Zampini   PetscFunctionBegin;
307b5fa320bSStefano Zampini   if (!mumps->id.ICNTL(19)) { /* do nothing when Schur complement has not been computed */
3083ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
309b5fa320bSStefano Zampini   }
310b8f61ee1SStefano Zampini   if (!expansion) { /* prepare for the condensation step */
311b5fa320bSStefano Zampini     PetscInt sizeredrhs = mumps->id.nrhs * mumps->id.size_schur;
312b5fa320bSStefano Zampini     /* allocate MUMPS internal array to store reduced right-hand sides */
313b5fa320bSStefano Zampini     if (!mumps->id.redrhs || sizeredrhs > mumps->sizeredrhs) {
3149566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
315b5fa320bSStefano Zampini       mumps->id.lredrhs = mumps->id.size_schur;
3169566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.nrhs * mumps->id.lredrhs, &mumps->id.redrhs));
317b5fa320bSStefano Zampini       mumps->sizeredrhs = mumps->id.nrhs * mumps->id.lredrhs;
318b5fa320bSStefano Zampini     }
319b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 1; /* condensation phase */
320b5fa320bSStefano Zampini   } else {                   /* prepare for the expansion step */
321b8f61ee1SStefano Zampini     /* solve Schur complement (this has to be done by the MUMPS user, so basically us) */
3229566063dSJacob Faibussowitsch     PetscCall(MatMumpsSolveSchur_Private(F));
323b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 2; /* expansion phase */
3243ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
32508401ef6SPierre 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));
326b5fa320bSStefano Zampini     /* restore defaults */
327b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = -1;
328d3d598ffSStefano Zampini     /* free MUMPS internal array for redrhs if we have solved for multiple rhs in order to save memory space */
329d3d598ffSStefano Zampini     if (mumps->id.nrhs > 1) {
3309566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
331d3d598ffSStefano Zampini       mumps->id.lredrhs = 0;
332d3d598ffSStefano Zampini       mumps->sizeredrhs = 0;
333d3d598ffSStefano Zampini     }
334b5fa320bSStefano Zampini   }
3353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
336b5fa320bSStefano Zampini }
337b5fa320bSStefano Zampini 
338397b6df1SKris Buschelman /*
339d341cd04SHong Zhang   MatConvertToTriples_A_B - convert Petsc matrix to triples: row[nz], col[nz], val[nz]
340d341cd04SHong Zhang 
341397b6df1SKris Buschelman   input:
34275480915SPierre Jolivet     A       - matrix in aij,baij or sbaij format
343397b6df1SKris Buschelman     shift   - 0: C style output triple; 1: Fortran style output triple.
344bccb9932SShri Abhyankar     reuse   - MAT_INITIAL_MATRIX: spaces are allocated and values are set for the triple
345bccb9932SShri Abhyankar               MAT_REUSE_MATRIX:   only the values in v array are updated
346397b6df1SKris Buschelman   output:
347397b6df1SKris Buschelman     nnz     - dim of r, c, and v (number of local nonzero entries of A)
348397b6df1SKris Buschelman     r, c, v - row and col index, matrix values (matrix triples)
349eb9baa12SBarry Smith 
350eb9baa12SBarry Smith   The returned values r, c, and sometimes v are obtained in a single PetscMalloc(). Then in MatDestroy_MUMPS() it is
3517ee00b23SStefano Zampini   freed with PetscFree(mumps->irn);  This is not ideal code, the fact that v is ONLY sometimes part of mumps->irn means
352eb9baa12SBarry Smith   that the PetscMalloc() cannot easily be replaced with a PetscMalloc3().
353eb9baa12SBarry Smith 
354397b6df1SKris Buschelman  */
35516ebf90aSShri Abhyankar 
356d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
357d71ae5a4SJacob Faibussowitsch {
358a3d589ffSStefano Zampini   const PetscScalar *av;
359185f6596SHong Zhang   const PetscInt    *ai, *aj, *ajj, M = A->rmap->n;
360a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j, k;
361a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
36216ebf90aSShri Abhyankar   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
363397b6df1SKris Buschelman 
364397b6df1SKris Buschelman   PetscFunctionBegin;
3659566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
366a6053eceSJunchao Zhang   mumps->val = (PetscScalar *)av;
367bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
3682205254eSKarl Rupp     nz = aa->nz;
3692205254eSKarl Rupp     ai = aa->i;
3702205254eSKarl Rupp     aj = aa->j;
3719566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
372a6053eceSJunchao Zhang     for (i = k = 0; i < M; i++) {
37316ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
37467877ebaSShri Abhyankar       ajj = aj + ai[i];
37567877ebaSShri Abhyankar       for (j = 0; j < rnz; j++) {
3769566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[k]));
3779566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[k]));
378a6053eceSJunchao Zhang         k++;
37916ebf90aSShri Abhyankar       }
38016ebf90aSShri Abhyankar     }
381a6053eceSJunchao Zhang     mumps->irn = row;
382a6053eceSJunchao Zhang     mumps->jcn = col;
383a6053eceSJunchao Zhang     mumps->nnz = nz;
38416ebf90aSShri Abhyankar   }
3859566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
3863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
38716ebf90aSShri Abhyankar }
388397b6df1SKris Buschelman 
389d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
390d71ae5a4SJacob Faibussowitsch {
391a6053eceSJunchao Zhang   PetscInt64     nz, i, j, k, r;
3927ee00b23SStefano Zampini   Mat_SeqSELL   *a = (Mat_SeqSELL *)A->data;
393a6053eceSJunchao Zhang   PetscMUMPSInt *row, *col;
3947ee00b23SStefano Zampini 
3957ee00b23SStefano Zampini   PetscFunctionBegin;
396a6053eceSJunchao Zhang   mumps->val = a->val;
3977ee00b23SStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
3987ee00b23SStefano Zampini     nz = a->sliidx[a->totalslices];
3999566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
400a6053eceSJunchao Zhang     for (i = k = 0; i < a->totalslices; i++) {
40148a46eb9SPierre Jolivet       for (j = a->sliidx[i], r = 0; j < a->sliidx[i + 1]; j++, r = ((r + 1) & 0x07)) PetscCall(PetscMUMPSIntCast(8 * i + r + shift, &row[k++]));
4027ee00b23SStefano Zampini     }
4039566063dSJacob Faibussowitsch     for (i = 0; i < nz; i++) PetscCall(PetscMUMPSIntCast(a->colidx[i] + shift, &col[i]));
404a6053eceSJunchao Zhang     mumps->irn = row;
405a6053eceSJunchao Zhang     mumps->jcn = col;
406a6053eceSJunchao Zhang     mumps->nnz = nz;
4077ee00b23SStefano Zampini   }
4083ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4097ee00b23SStefano Zampini }
4107ee00b23SStefano Zampini 
411d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
412d71ae5a4SJacob Faibussowitsch {
41367877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa = (Mat_SeqBAIJ *)A->data;
41433d57670SJed Brown   const PetscInt *ai, *aj, *ajj, bs2 = aa->bs2;
415a6053eceSJunchao Zhang   PetscInt64      M, nz, idx = 0, rnz, i, j, k, m;
416a6053eceSJunchao Zhang   PetscInt        bs;
417a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
41867877ebaSShri Abhyankar 
41967877ebaSShri Abhyankar   PetscFunctionBegin;
4209566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
42133d57670SJed Brown   M          = A->rmap->N / bs;
422a6053eceSJunchao Zhang   mumps->val = aa->a;
423bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
4249371c9d4SSatish Balay     ai = aa->i;
4259371c9d4SSatish Balay     aj = aa->j;
42667877ebaSShri Abhyankar     nz = bs2 * aa->nz;
4279566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
42867877ebaSShri Abhyankar     for (i = 0; i < M; i++) {
42967877ebaSShri Abhyankar       ajj = aj + ai[i];
43067877ebaSShri Abhyankar       rnz = ai[i + 1] - ai[i];
43167877ebaSShri Abhyankar       for (k = 0; k < rnz; k++) {
43267877ebaSShri Abhyankar         for (j = 0; j < bs; j++) {
43367877ebaSShri Abhyankar           for (m = 0; m < bs; m++) {
4349566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[idx]));
4359566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * ajj[k] + j + shift, &col[idx]));
436a6053eceSJunchao Zhang             idx++;
43767877ebaSShri Abhyankar           }
43867877ebaSShri Abhyankar         }
43967877ebaSShri Abhyankar       }
44067877ebaSShri Abhyankar     }
441a6053eceSJunchao Zhang     mumps->irn = row;
442a6053eceSJunchao Zhang     mumps->jcn = col;
443a6053eceSJunchao Zhang     mumps->nnz = nz;
44467877ebaSShri Abhyankar   }
4453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
44667877ebaSShri Abhyankar }
44767877ebaSShri Abhyankar 
448d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
449d71ae5a4SJacob Faibussowitsch {
45075480915SPierre Jolivet   const PetscInt *ai, *aj, *ajj;
451a6053eceSJunchao Zhang   PetscInt        bs;
452a6053eceSJunchao Zhang   PetscInt64      nz, rnz, i, j, k, m;
453a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
45475480915SPierre Jolivet   PetscScalar    *val;
45516ebf90aSShri Abhyankar   Mat_SeqSBAIJ   *aa  = (Mat_SeqSBAIJ *)A->data;
45675480915SPierre Jolivet   const PetscInt  bs2 = aa->bs2, mbs = aa->mbs;
45738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
458b94d7dedSBarry Smith   PetscBool isset, hermitian;
45938548759SBarry Smith #endif
46016ebf90aSShri Abhyankar 
46116ebf90aSShri Abhyankar   PetscFunctionBegin;
46238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
463b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
464b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
46538548759SBarry Smith #endif
4662205254eSKarl Rupp   ai = aa->i;
4672205254eSKarl Rupp   aj = aa->j;
4689566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
46975480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
470f3fa974cSJacob Faibussowitsch     const PetscInt64 alloc_size = aa->nz * bs2;
471f3fa974cSJacob Faibussowitsch 
472f3fa974cSJacob Faibussowitsch     PetscCall(PetscMalloc2(alloc_size, &row, alloc_size, &col));
473a6053eceSJunchao Zhang     if (bs > 1) {
474f3fa974cSJacob Faibussowitsch       PetscCall(PetscMalloc1(alloc_size, &mumps->val_alloc));
475a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
47675480915SPierre Jolivet     } else {
477a6053eceSJunchao Zhang       mumps->val = aa->a;
47875480915SPierre Jolivet     }
479a6053eceSJunchao Zhang     mumps->irn = row;
480a6053eceSJunchao Zhang     mumps->jcn = col;
481a6053eceSJunchao Zhang   } else {
482a6053eceSJunchao Zhang     if (bs == 1) mumps->val = aa->a;
483a6053eceSJunchao Zhang     row = mumps->irn;
484a6053eceSJunchao Zhang     col = mumps->jcn;
485a6053eceSJunchao Zhang   }
486a6053eceSJunchao Zhang   val = mumps->val;
487185f6596SHong Zhang 
48816ebf90aSShri Abhyankar   nz = 0;
489a81fe166SPierre Jolivet   if (bs > 1) {
49075480915SPierre Jolivet     for (i = 0; i < mbs; i++) {
49116ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
49267877ebaSShri Abhyankar       ajj = aj + ai[i];
49375480915SPierre Jolivet       for (j = 0; j < rnz; j++) {
49475480915SPierre Jolivet         for (k = 0; k < bs; k++) {
49575480915SPierre Jolivet           for (m = 0; m < bs; m++) {
496ec4f40fdSPierre Jolivet             if (ajj[j] > i || k >= m) {
49775480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
4989566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[nz]));
4999566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j] * bs + k + shift, &col[nz]));
50075480915SPierre Jolivet               }
50175480915SPierre Jolivet               val[nz++] = aa->a[(ai[i] + j) * bs2 + m + k * bs];
50275480915SPierre Jolivet             }
50375480915SPierre Jolivet           }
50475480915SPierre Jolivet         }
50575480915SPierre Jolivet       }
50675480915SPierre Jolivet     }
507a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
508a81fe166SPierre Jolivet     for (i = 0; i < mbs; i++) {
509a81fe166SPierre Jolivet       rnz = ai[i + 1] - ai[i];
510a81fe166SPierre Jolivet       ajj = aj + ai[i];
511a81fe166SPierre Jolivet       for (j = 0; j < rnz; j++) {
5129566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5139566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
514a6053eceSJunchao Zhang         nz++;
515a81fe166SPierre Jolivet       }
516a81fe166SPierre Jolivet     }
51708401ef6SPierre Jolivet     PetscCheck(nz == aa->nz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different numbers of nonzeros %" PetscInt64_FMT " != %" PetscInt_FMT, nz, aa->nz);
51875480915SPierre Jolivet   }
519a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
5203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
52116ebf90aSShri Abhyankar }
52216ebf90aSShri Abhyankar 
523d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
524d71ae5a4SJacob Faibussowitsch {
52567877ebaSShri Abhyankar   const PetscInt    *ai, *aj, *ajj, *adiag, M = A->rmap->n;
526a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j;
52767877ebaSShri Abhyankar   const PetscScalar *av, *v1;
52816ebf90aSShri Abhyankar   PetscScalar       *val;
529a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
530829b1710SHong Zhang   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
53129b521d4Sstefano_zampini   PetscBool          missing;
53238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
533b94d7dedSBarry Smith   PetscBool hermitian, isset;
53438548759SBarry Smith #endif
53516ebf90aSShri Abhyankar 
53616ebf90aSShri Abhyankar   PetscFunctionBegin;
53738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
538b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
539b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
54038548759SBarry Smith #endif
5419566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
5429371c9d4SSatish Balay   ai    = aa->i;
5439371c9d4SSatish Balay   aj    = aa->j;
54416ebf90aSShri Abhyankar   adiag = aa->diag;
5459566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A, &missing, NULL));
546bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5477ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
548829b1710SHong Zhang     nz = 0;
54929b521d4Sstefano_zampini     if (missing) {
55029b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
55129b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
55229b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
55329b521d4Sstefano_zampini             if (aj[j] < i) continue;
55429b521d4Sstefano_zampini             nz++;
55529b521d4Sstefano_zampini           }
55629b521d4Sstefano_zampini         } else {
55729b521d4Sstefano_zampini           nz += ai[i + 1] - adiag[i];
55829b521d4Sstefano_zampini         }
55929b521d4Sstefano_zampini       }
56029b521d4Sstefano_zampini     } else {
561829b1710SHong Zhang       for (i = 0; i < M; i++) nz += ai[i + 1] - adiag[i];
56229b521d4Sstefano_zampini     }
5639566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
5649566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
565a6053eceSJunchao Zhang     mumps->nnz = nz;
566a6053eceSJunchao Zhang     mumps->irn = row;
567a6053eceSJunchao Zhang     mumps->jcn = col;
568a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
569185f6596SHong Zhang 
57016ebf90aSShri Abhyankar     nz = 0;
57129b521d4Sstefano_zampini     if (missing) {
57229b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
57329b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
57429b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
57529b521d4Sstefano_zampini             if (aj[j] < i) continue;
5769566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5779566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j] + shift, &col[nz]));
57829b521d4Sstefano_zampini             val[nz] = av[j];
57929b521d4Sstefano_zampini             nz++;
58029b521d4Sstefano_zampini           }
58129b521d4Sstefano_zampini         } else {
58229b521d4Sstefano_zampini           rnz = ai[i + 1] - adiag[i];
58329b521d4Sstefano_zampini           ajj = aj + adiag[i];
58429b521d4Sstefano_zampini           v1  = av + adiag[i];
58529b521d4Sstefano_zampini           for (j = 0; j < rnz; j++) {
5869566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5879566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
588a6053eceSJunchao Zhang             val[nz++] = v1[j];
58929b521d4Sstefano_zampini           }
59029b521d4Sstefano_zampini         }
59129b521d4Sstefano_zampini       }
59229b521d4Sstefano_zampini     } else {
59316ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
59416ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
59567877ebaSShri Abhyankar         ajj = aj + adiag[i];
596cf3759fdSShri Abhyankar         v1  = av + adiag[i];
59767877ebaSShri Abhyankar         for (j = 0; j < rnz; j++) {
5989566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5999566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
600a6053eceSJunchao Zhang           val[nz++] = v1[j];
60116ebf90aSShri Abhyankar         }
60216ebf90aSShri Abhyankar       }
60329b521d4Sstefano_zampini     }
604397b6df1SKris Buschelman   } else {
605a6053eceSJunchao Zhang     nz  = 0;
606a6053eceSJunchao Zhang     val = mumps->val;
60729b521d4Sstefano_zampini     if (missing) {
60816ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
60929b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
61029b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
61129b521d4Sstefano_zampini             if (aj[j] < i) continue;
61229b521d4Sstefano_zampini             val[nz++] = av[j];
61329b521d4Sstefano_zampini           }
61429b521d4Sstefano_zampini         } else {
61516ebf90aSShri Abhyankar           rnz = ai[i + 1] - adiag[i];
61667877ebaSShri Abhyankar           v1  = av + adiag[i];
617ad540459SPierre Jolivet           for (j = 0; j < rnz; j++) val[nz++] = v1[j];
61816ebf90aSShri Abhyankar         }
61916ebf90aSShri Abhyankar       }
62029b521d4Sstefano_zampini     } else {
62116ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
62216ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
62316ebf90aSShri Abhyankar         v1  = av + adiag[i];
624ad540459SPierre Jolivet         for (j = 0; j < rnz; j++) val[nz++] = v1[j];
62516ebf90aSShri Abhyankar       }
62616ebf90aSShri Abhyankar     }
62729b521d4Sstefano_zampini   }
6289566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
6293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
63016ebf90aSShri Abhyankar }
63116ebf90aSShri Abhyankar 
632d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
633d71ae5a4SJacob Faibussowitsch {
634a6053eceSJunchao Zhang   const PetscInt    *ai, *aj, *bi, *bj, *garray, *ajj, *bjj;
635a6053eceSJunchao Zhang   PetscInt           bs;
636a6053eceSJunchao Zhang   PetscInt64         rstart, nz, i, j, k, m, jj, irow, countA, countB;
637a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
63816ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
63916ebf90aSShri Abhyankar   PetscScalar       *val;
640397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ *)A->data;
641397b6df1SKris Buschelman   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ *)(mat->A)->data;
642397b6df1SKris Buschelman   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
643ec4f40fdSPierre Jolivet   const PetscInt     bs2 = aa->bs2, mbs = aa->mbs;
64438548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
645b94d7dedSBarry Smith   PetscBool hermitian, isset;
64638548759SBarry Smith #endif
64716ebf90aSShri Abhyankar 
64816ebf90aSShri Abhyankar   PetscFunctionBegin;
64938548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
650b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
651b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
65238548759SBarry Smith #endif
6539566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
65438548759SBarry Smith   rstart = A->rmap->rstart;
65538548759SBarry Smith   ai     = aa->i;
65638548759SBarry Smith   aj     = aa->j;
65738548759SBarry Smith   bi     = bb->i;
65838548759SBarry Smith   bj     = bb->j;
65938548759SBarry Smith   av     = aa->a;
66038548759SBarry Smith   bv     = bb->a;
661397b6df1SKris Buschelman 
6622205254eSKarl Rupp   garray = mat->garray;
6632205254eSKarl Rupp 
664bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
665a6053eceSJunchao Zhang     nz = (aa->nz + bb->nz) * bs2; /* just a conservative estimate */
6669566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
6679566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
668a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
669a6053eceSJunchao Zhang     mumps->irn = row;
670a6053eceSJunchao Zhang     mumps->jcn = col;
671a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
672397b6df1SKris Buschelman   } else {
673a6053eceSJunchao Zhang     val = mumps->val;
674397b6df1SKris Buschelman   }
675397b6df1SKris Buschelman 
6769371c9d4SSatish Balay   jj   = 0;
6779371c9d4SSatish Balay   irow = rstart;
678ec4f40fdSPierre Jolivet   for (i = 0; i < mbs; i++) {
679397b6df1SKris Buschelman     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
680397b6df1SKris Buschelman     countA = ai[i + 1] - ai[i];
681397b6df1SKris Buschelman     countB = bi[i + 1] - bi[i];
682397b6df1SKris Buschelman     bjj    = bj + bi[i];
683ec4f40fdSPierre Jolivet     v1     = av + ai[i] * bs2;
684ec4f40fdSPierre Jolivet     v2     = bv + bi[i] * bs2;
685397b6df1SKris Buschelman 
686ec4f40fdSPierre Jolivet     if (bs > 1) {
687ec4f40fdSPierre Jolivet       /* A-part */
688ec4f40fdSPierre Jolivet       for (j = 0; j < countA; j++) {
689ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
690ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
691ec4f40fdSPierre Jolivet             if (rstart + ajj[j] * bs > irow || k >= m) {
692ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
6939566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
6949566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j] * bs + k + shift, &col[jj]));
695ec4f40fdSPierre Jolivet               }
696ec4f40fdSPierre Jolivet               val[jj++] = v1[j * bs2 + m + k * bs];
697ec4f40fdSPierre Jolivet             }
698ec4f40fdSPierre Jolivet           }
699ec4f40fdSPierre Jolivet         }
700ec4f40fdSPierre Jolivet       }
701ec4f40fdSPierre Jolivet 
702ec4f40fdSPierre Jolivet       /* B-part */
703ec4f40fdSPierre Jolivet       for (j = 0; j < countB; j++) {
704ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
705ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
706ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7079566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7089566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]] * bs + k + shift, &col[jj]));
709ec4f40fdSPierre Jolivet             }
710ec4f40fdSPierre Jolivet             val[jj++] = v2[j * bs2 + m + k * bs];
711ec4f40fdSPierre Jolivet           }
712ec4f40fdSPierre Jolivet         }
713ec4f40fdSPierre Jolivet       }
714ec4f40fdSPierre Jolivet     } else {
715397b6df1SKris Buschelman       /* A-part */
716397b6df1SKris Buschelman       for (j = 0; j < countA; j++) {
717bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7189566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7199566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
720397b6df1SKris Buschelman         }
72116ebf90aSShri Abhyankar         val[jj++] = v1[j];
722397b6df1SKris Buschelman       }
72316ebf90aSShri Abhyankar 
72416ebf90aSShri Abhyankar       /* B-part */
72516ebf90aSShri Abhyankar       for (j = 0; j < countB; j++) {
726bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7279566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7289566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
729397b6df1SKris Buschelman         }
73016ebf90aSShri Abhyankar         val[jj++] = v2[j];
73116ebf90aSShri Abhyankar       }
73216ebf90aSShri Abhyankar     }
733ec4f40fdSPierre Jolivet     irow += bs;
734ec4f40fdSPierre Jolivet   }
735a6053eceSJunchao Zhang   mumps->nnz = jj;
7363ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
73716ebf90aSShri Abhyankar }
73816ebf90aSShri Abhyankar 
739d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
740d71ae5a4SJacob Faibussowitsch {
74116ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
742a6053eceSJunchao Zhang   PetscInt64         rstart, nz, i, j, jj, irow, countA, countB;
743a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
74416ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
74516ebf90aSShri Abhyankar   PetscScalar       *val;
746a3d589ffSStefano Zampini   Mat                Ad, Ao;
747a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
748a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
74916ebf90aSShri Abhyankar 
75016ebf90aSShri Abhyankar   PetscFunctionBegin;
7519566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
7529566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
7539566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
754a3d589ffSStefano Zampini 
755a3d589ffSStefano Zampini   aa = (Mat_SeqAIJ *)(Ad)->data;
756a3d589ffSStefano Zampini   bb = (Mat_SeqAIJ *)(Ao)->data;
75738548759SBarry Smith   ai = aa->i;
75838548759SBarry Smith   aj = aa->j;
75938548759SBarry Smith   bi = bb->i;
76038548759SBarry Smith   bj = bb->j;
76116ebf90aSShri Abhyankar 
762a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7632205254eSKarl Rupp 
764bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
765a6053eceSJunchao Zhang     nz = (PetscInt64)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7669566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
7679566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
768a6053eceSJunchao Zhang     mumps->nnz = nz;
769a6053eceSJunchao Zhang     mumps->irn = row;
770a6053eceSJunchao Zhang     mumps->jcn = col;
771a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
77216ebf90aSShri Abhyankar   } else {
773a6053eceSJunchao Zhang     val = mumps->val;
77416ebf90aSShri Abhyankar   }
77516ebf90aSShri Abhyankar 
7769371c9d4SSatish Balay   jj   = 0;
7779371c9d4SSatish Balay   irow = rstart;
77816ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
77916ebf90aSShri Abhyankar     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
78016ebf90aSShri Abhyankar     countA = ai[i + 1] - ai[i];
78116ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
78216ebf90aSShri Abhyankar     bjj    = bj + bi[i];
78316ebf90aSShri Abhyankar     v1     = av + ai[i];
78416ebf90aSShri Abhyankar     v2     = bv + bi[i];
78516ebf90aSShri Abhyankar 
78616ebf90aSShri Abhyankar     /* A-part */
78716ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
788bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
7899566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7909566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
79116ebf90aSShri Abhyankar       }
79216ebf90aSShri Abhyankar       val[jj++] = v1[j];
79316ebf90aSShri Abhyankar     }
79416ebf90aSShri Abhyankar 
79516ebf90aSShri Abhyankar     /* B-part */
79616ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
797bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
7989566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7999566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
80016ebf90aSShri Abhyankar       }
80116ebf90aSShri Abhyankar       val[jj++] = v2[j];
80216ebf90aSShri Abhyankar     }
80316ebf90aSShri Abhyankar     irow++;
80416ebf90aSShri Abhyankar   }
8059566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
8069566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
8073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
80816ebf90aSShri Abhyankar }
80916ebf90aSShri Abhyankar 
810d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
811d71ae5a4SJacob Faibussowitsch {
81267877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat = (Mat_MPIBAIJ *)A->data;
81367877ebaSShri Abhyankar   Mat_SeqBAIJ       *aa  = (Mat_SeqBAIJ *)(mat->A)->data;
81467877ebaSShri Abhyankar   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
81567877ebaSShri Abhyankar   const PetscInt    *ai = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j, *ajj, *bjj;
816d985c460SShri Abhyankar   const PetscInt    *garray = mat->garray, mbs = mat->mbs, rstart = A->rmap->rstart;
81733d57670SJed Brown   const PetscInt     bs2 = mat->bs2;
818a6053eceSJunchao Zhang   PetscInt           bs;
819a6053eceSJunchao Zhang   PetscInt64         nz, i, j, k, n, jj, irow, countA, countB, idx;
820a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
82167877ebaSShri Abhyankar   const PetscScalar *av = aa->a, *bv = bb->a, *v1, *v2;
82267877ebaSShri Abhyankar   PetscScalar       *val;
82367877ebaSShri Abhyankar 
82467877ebaSShri Abhyankar   PetscFunctionBegin;
8259566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
826bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
82767877ebaSShri Abhyankar     nz = bs2 * (aa->nz + bb->nz);
8289566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
8299566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
830a6053eceSJunchao Zhang     mumps->nnz = nz;
831a6053eceSJunchao Zhang     mumps->irn = row;
832a6053eceSJunchao Zhang     mumps->jcn = col;
833a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
83467877ebaSShri Abhyankar   } else {
835a6053eceSJunchao Zhang     val = mumps->val;
83667877ebaSShri Abhyankar   }
83767877ebaSShri Abhyankar 
8389371c9d4SSatish Balay   jj   = 0;
8399371c9d4SSatish Balay   irow = rstart;
84067877ebaSShri Abhyankar   for (i = 0; i < mbs; i++) {
84167877ebaSShri Abhyankar     countA = ai[i + 1] - ai[i];
84267877ebaSShri Abhyankar     countB = bi[i + 1] - bi[i];
84367877ebaSShri Abhyankar     ajj    = aj + ai[i];
84467877ebaSShri Abhyankar     bjj    = bj + bi[i];
84567877ebaSShri Abhyankar     v1     = av + bs2 * ai[i];
84667877ebaSShri Abhyankar     v2     = bv + bs2 * bi[i];
84767877ebaSShri Abhyankar 
84867877ebaSShri Abhyankar     idx = 0;
84967877ebaSShri Abhyankar     /* A-part */
85067877ebaSShri Abhyankar     for (k = 0; k < countA; k++) {
85167877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
85267877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
853bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8549566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8559566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(rstart + bs * ajj[k] + j + shift, &col[jj]));
85667877ebaSShri Abhyankar           }
85767877ebaSShri Abhyankar           val[jj++] = v1[idx++];
85867877ebaSShri Abhyankar         }
85967877ebaSShri Abhyankar       }
86067877ebaSShri Abhyankar     }
86167877ebaSShri Abhyankar 
86267877ebaSShri Abhyankar     idx = 0;
86367877ebaSShri Abhyankar     /* B-part */
86467877ebaSShri Abhyankar     for (k = 0; k < countB; k++) {
86567877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
86667877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
867bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8689566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8699566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * garray[bjj[k]] + j + shift, &col[jj]));
87067877ebaSShri Abhyankar           }
871d985c460SShri Abhyankar           val[jj++] = v2[idx++];
87267877ebaSShri Abhyankar         }
87367877ebaSShri Abhyankar       }
87467877ebaSShri Abhyankar     }
875d985c460SShri Abhyankar     irow += bs;
87667877ebaSShri Abhyankar   }
8773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
87867877ebaSShri Abhyankar }
87967877ebaSShri Abhyankar 
880d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
881d71ae5a4SJacob Faibussowitsch {
88216ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *adiag, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
883a6053eceSJunchao Zhang   PetscInt64         rstart, nz, nza, nzb, i, j, jj, irow, countA, countB;
884a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
88516ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
88616ebf90aSShri Abhyankar   PetscScalar       *val;
887a3d589ffSStefano Zampini   Mat                Ad, Ao;
888a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
889a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
89038548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
891b94d7dedSBarry Smith   PetscBool hermitian, isset;
89238548759SBarry Smith #endif
89316ebf90aSShri Abhyankar 
89416ebf90aSShri Abhyankar   PetscFunctionBegin;
89538548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
896b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
897b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
89838548759SBarry Smith #endif
8999566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
9009566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
9019566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
902a3d589ffSStefano Zampini 
903a3d589ffSStefano Zampini   aa    = (Mat_SeqAIJ *)(Ad)->data;
904a3d589ffSStefano Zampini   bb    = (Mat_SeqAIJ *)(Ao)->data;
90538548759SBarry Smith   ai    = aa->i;
90638548759SBarry Smith   aj    = aa->j;
90738548759SBarry Smith   adiag = aa->diag;
90838548759SBarry Smith   bi    = bb->i;
90938548759SBarry Smith   bj    = bb->j;
9102205254eSKarl Rupp 
91116ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
91216ebf90aSShri Abhyankar 
913bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
914e0bace9bSHong Zhang     nza = 0; /* num of upper triangular entries in mat->A, including diagonals */
915e0bace9bSHong Zhang     nzb = 0; /* num of upper triangular entries in mat->B */
91616ebf90aSShri Abhyankar     for (i = 0; i < m; i++) {
917e0bace9bSHong Zhang       nza += (ai[i + 1] - adiag[i]);
91816ebf90aSShri Abhyankar       countB = bi[i + 1] - bi[i];
91916ebf90aSShri Abhyankar       bjj    = bj + bi[i];
920e0bace9bSHong Zhang       for (j = 0; j < countB; j++) {
921e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
922e0bace9bSHong Zhang       }
923e0bace9bSHong Zhang     }
92416ebf90aSShri Abhyankar 
925e0bace9bSHong Zhang     nz = nza + nzb; /* total nz of upper triangular part of mat */
9269566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
9279566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
928a6053eceSJunchao Zhang     mumps->nnz = nz;
929a6053eceSJunchao Zhang     mumps->irn = row;
930a6053eceSJunchao Zhang     mumps->jcn = col;
931a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
93216ebf90aSShri Abhyankar   } else {
933a6053eceSJunchao Zhang     val = mumps->val;
93416ebf90aSShri Abhyankar   }
93516ebf90aSShri Abhyankar 
9369371c9d4SSatish Balay   jj   = 0;
9379371c9d4SSatish Balay   irow = rstart;
93816ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
93916ebf90aSShri Abhyankar     ajj    = aj + adiag[i]; /* ptr to the beginning of the diagonal of this row */
94016ebf90aSShri Abhyankar     v1     = av + adiag[i];
94116ebf90aSShri Abhyankar     countA = ai[i + 1] - adiag[i];
94216ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
94316ebf90aSShri Abhyankar     bjj    = bj + bi[i];
94416ebf90aSShri Abhyankar     v2     = bv + bi[i];
94516ebf90aSShri Abhyankar 
94616ebf90aSShri Abhyankar     /* A-part */
94716ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
948bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9499566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9509566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
95116ebf90aSShri Abhyankar       }
95216ebf90aSShri Abhyankar       val[jj++] = v1[j];
95316ebf90aSShri Abhyankar     }
95416ebf90aSShri Abhyankar 
95516ebf90aSShri Abhyankar     /* B-part */
95616ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
95716ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
958bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9599566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9609566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
96116ebf90aSShri Abhyankar         }
96216ebf90aSShri Abhyankar         val[jj++] = v2[j];
96316ebf90aSShri Abhyankar       }
964397b6df1SKris Buschelman     }
965397b6df1SKris Buschelman     irow++;
966397b6df1SKris Buschelman   }
9679566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
9689566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
9693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
970397b6df1SKris Buschelman }
971397b6df1SKris Buschelman 
972d71ae5a4SJacob Faibussowitsch PetscErrorCode MatDestroy_MUMPS(Mat A)
973d71ae5a4SJacob Faibussowitsch {
974a6053eceSJunchao Zhang   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
975b24902e0SBarry Smith 
976397b6df1SKris Buschelman   PetscFunctionBegin;
9779566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
9789566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
9799566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
9809566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
9819566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
9829566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
9839566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn, mumps->jcn));
9849566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
9859566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
986413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->ICNTL_pre));
987413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->CNTL_pre));
9889566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
989413bcc21SPierre Jolivet   if (mumps->id.job != JOB_NULL) { /* cannot call PetscMUMPS_c() if JOB_INIT has never been called for this instance */
990a5e57a09SHong Zhang     mumps->id.job = JOB_END;
9913ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
99208401ef6SPierre 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));
993413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
994413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) PetscCallMPI(MPI_Comm_free(&mumps->mumps_comm));
995413bcc21SPierre Jolivet       else PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A), &mumps->mumps_comm));
996413bcc21SPierre Jolivet     }
997413bcc21SPierre Jolivet   }
9983ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
99967602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
10009566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
10019566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
10029566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow, mumps->rhs_recvcounts, mumps->rhs_disps));
100367602552SJunchao Zhang   }
10043ab56b82SJunchao Zhang #endif
10059566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
10069566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
10079566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
10089566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
10099566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
10109566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
1011bf0cc555SLisandro Dalcin 
101297969023SHong Zhang   /* clear composed functions */
10139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorGetSolverType_C", NULL));
10149566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorSetSchurIS_C", NULL));
10159566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorCreateSchurComplement_C", NULL));
10169566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetIcntl_C", NULL));
10179566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetIcntl_C", NULL));
10189566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetCntl_C", NULL));
10199566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetCntl_C", NULL));
10209566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfo_C", NULL));
10219566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfog_C", NULL));
10229566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfo_C", NULL));
10239566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfog_C", NULL));
10245c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetNullPivots_C", NULL));
10259566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverse_C", NULL));
10269566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverseTranspose_C", NULL));
10273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1028397b6df1SKris Buschelman }
1029397b6df1SKris Buschelman 
103067602552SJunchao 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. */
1031d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A, PetscInt nrhs, const PetscScalar *array)
1032d71ae5a4SJacob Faibussowitsch {
103367602552SJunchao Zhang   Mat_MUMPS        *mumps   = (Mat_MUMPS *)A->data;
103467602552SJunchao Zhang   const PetscMPIInt ompsize = mumps->omp_comm_size;
103567602552SJunchao Zhang   PetscInt          i, m, M, rstart;
103667602552SJunchao Zhang 
103767602552SJunchao Zhang   PetscFunctionBegin;
10389566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, NULL));
10399566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, NULL));
104008401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
104167602552SJunchao Zhang   if (ompsize == 1) {
104267602552SJunchao Zhang     if (!mumps->irhs_loc) {
104367602552SJunchao Zhang       mumps->nloc_rhs = m;
10449566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m, &mumps->irhs_loc));
10459566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A, &rstart, NULL));
104667602552SJunchao Zhang       for (i = 0; i < m; i++) mumps->irhs_loc[i] = rstart + i + 1; /* use 1-based indices */
104767602552SJunchao Zhang     }
104867602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar *)array;
104967602552SJunchao Zhang   } else {
105067602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
105167602552SJunchao Zhang     const PetscInt *ranges;
105267602552SJunchao Zhang     PetscMPIInt     j, k, sendcount, *petsc_ranks, *omp_ranks;
105367602552SJunchao Zhang     MPI_Group       petsc_group, omp_group;
105467602552SJunchao Zhang     PetscScalar    *recvbuf = NULL;
105567602552SJunchao Zhang 
105667602552SJunchao Zhang     if (mumps->is_omp_master) {
105767602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
105867602552SJunchao Zhang       if (!mumps->irhs_loc) {
10599566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize, &omp_ranks, ompsize, &petsc_ranks));
10609566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize, &mumps->rhs_nrow, ompsize, &mumps->rhs_recvcounts, ompsize, &mumps->rhs_disps));
10619566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm, &petsc_group));
10629566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm, &omp_group));
106367602552SJunchao Zhang         for (j = 0; j < ompsize; j++) omp_ranks[j] = j;
10649566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group, ompsize, omp_ranks, petsc_group, petsc_ranks));
106567602552SJunchao Zhang 
106667602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
106767602552SJunchao Zhang         mumps->nloc_rhs = 0;
10689566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A, &ranges));
106967602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
107067602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j] + 1] - ranges[petsc_ranks[j]];
107167602552SJunchao Zhang           mumps->nloc_rhs += mumps->rhs_nrow[j];
107267602552SJunchao Zhang         }
10739566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs, &mumps->irhs_loc));
107467602552SJunchao Zhang         for (j = k = 0; j < ompsize; j++) {
107567602552SJunchao 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 */
107667602552SJunchao Zhang         }
107767602552SJunchao Zhang 
10789566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks, petsc_ranks));
10799566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
10809566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
108167602552SJunchao Zhang       }
108267602552SJunchao Zhang 
108367602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
108467602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
10859566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
10869566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs * nrhs, &mumps->rhs_loc, mumps->nloc_rhs * nrhs, &mumps->rhs_recvbuf));
108767602552SJunchao Zhang         mumps->max_nrhs = nrhs;
108867602552SJunchao Zhang       }
108967602552SJunchao Zhang 
109067602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
10919566063dSJacob Faibussowitsch       for (j = 0; j < ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j] * nrhs, &mumps->rhs_recvcounts[j]));
109267602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
109367602552SJunchao Zhang       for (j = 1; j < ompsize; j++) {
109467602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j - 1] + mumps->rhs_recvcounts[j - 1];
109508401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscMPIInt overflow!");
109667602552SJunchao Zhang       }
109767602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
109867602552SJunchao Zhang     }
109967602552SJunchao Zhang 
11009566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m * nrhs, &sendcount));
11019566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array, sendcount, MPIU_SCALAR, recvbuf, mumps->rhs_recvcounts, mumps->rhs_disps, MPIU_SCALAR, 0, mumps->omp_comm));
110267602552SJunchao Zhang 
110367602552SJunchao Zhang     if (mumps->is_omp_master) {
110467602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
110567602552SJunchao Zhang         PetscScalar *dst, *dstbase = mumps->rhs_loc;
110667602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
110767602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
110867602552SJunchao Zhang           dst                    = dstbase;
110967602552SJunchao Zhang           for (i = 0; i < nrhs; i++) {
11109566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst, src, mumps->rhs_nrow[j]));
111167602552SJunchao Zhang             src += mumps->rhs_nrow[j];
111267602552SJunchao Zhang             dst += mumps->nloc_rhs;
111367602552SJunchao Zhang           }
111467602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
111567602552SJunchao Zhang         }
111667602552SJunchao Zhang       }
111767602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar *)mumps->rhs_loc;
111867602552SJunchao Zhang     }
111967602552SJunchao Zhang #endif /* PETSC_HAVE_OPENMP_SUPPORT */
112067602552SJunchao Zhang   }
112167602552SJunchao Zhang   mumps->id.nrhs     = nrhs;
112267602552SJunchao Zhang   mumps->id.nloc_rhs = mumps->nloc_rhs;
112367602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
112467602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
11253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
112667602552SJunchao Zhang }
112767602552SJunchao Zhang 
1128d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSolve_MUMPS(Mat A, Vec b, Vec x)
1129d71ae5a4SJacob Faibussowitsch {
1130e69c285eSBarry Smith   Mat_MUMPS         *mumps  = (Mat_MUMPS *)A->data;
113125aac85cSJunchao Zhang   const PetscScalar *rarray = NULL;
1132d54de34fSKris Buschelman   PetscScalar       *array;
1133329ec9b3SHong Zhang   IS                 is_iden, is_petsc;
1134329ec9b3SHong Zhang   PetscInt           i;
1135cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1136883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE, cite2 = PETSC_FALSE;
1137397b6df1SKris Buschelman 
1138397b6df1SKris Buschelman   PetscFunctionBegin;
11399371c9d4SSatish Balay   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 "
11409371c9d4SSatish Balay                                    "Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",
11419371c9d4SSatish Balay                                    &cite1));
11429371c9d4SSatish Balay   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 "
11439371c9d4SSatish Balay                                    "Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",
11449371c9d4SSatish Balay                                    &cite2));
11452aca8efcSHong Zhang 
1146603e8f96SBarry Smith   if (A->factorerrortype) {
11479566063dSJacob 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)));
11489566063dSJacob Faibussowitsch     PetscCall(VecSetInf(x));
11493ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
11502aca8efcSHong Zhang   }
11512aca8efcSHong Zhang 
1152a5e57a09SHong Zhang   mumps->id.nrhs = 1;
11532d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
115425aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
115567602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
11569566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b, &rarray));
11579566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, 1, rarray));
115825aac85cSJunchao Zhang     } else {
115941ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
11609566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
11619566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
116267602552SJunchao Zhang       if (!mumps->myid) {
11639566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq, &array));
116467602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar *)array;
116567602552SJunchao Zhang       }
116625aac85cSJunchao Zhang     }
11673ab56b82SJunchao Zhang   } else {                   /* petsc_size == 1 */
116867602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
11699566063dSJacob Faibussowitsch     PetscCall(VecCopy(b, x));
11709566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x, &array));
1171940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar *)array;
1172397b6df1SKris Buschelman   }
1173397b6df1SKris Buschelman 
1174cc86f929SStefano Zampini   /*
1175cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1176cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1177cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1178cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1179cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1180cc86f929SStefano Zampini   */
1181583f777eSStefano Zampini   if (mumps->id.size_schur > 0 && (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2)) {
118208401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1183cc86f929SStefano Zampini     second_solve = PETSC_TRUE;
11849566063dSJacob Faibussowitsch     PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1185cc86f929SStefano Zampini   }
1186397b6df1SKris Buschelman   /* solve phase */
1187a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
11883ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
118908401ef6SPierre 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));
1190397b6df1SKris Buschelman 
1191b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
11921baa6e33SBarry Smith   if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
1193b5fa320bSStefano Zampini 
11942d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to petsc mpi x */
1195a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1196a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
11979566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1198397b6df1SKris Buschelman     }
1199a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1200a6053eceSJunchao Zhang       PetscInt *isol2_loc = NULL;
12019566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, mumps->id.lsol_loc, 0, 1, &is_iden)); /* from */
12029566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc, &isol2_loc));
1203a6053eceSJunchao 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 */
12049566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, mumps->id.lsol_loc, isol2_loc, PETSC_OWN_POINTER, &is_petsc)); /* to */
12059566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq, is_iden, x, is_petsc, &mumps->scat_sol));
12069566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
12079566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1208a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1209397b6df1SKris Buschelman     }
1210a5e57a09SHong Zhang 
12119566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
12129566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
1213329ec9b3SHong Zhang   }
1214353d7d71SJunchao Zhang 
121567602552SJunchao Zhang   if (mumps->petsc_size > 1) {
121625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
12179566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b, &rarray));
121825aac85cSJunchao Zhang     } else if (!mumps->myid) {
12199566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq, &array));
122025aac85cSJunchao Zhang     }
12219566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x, &array));
1222353d7d71SJunchao Zhang 
12239566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(2.0 * mumps->id.RINFO(3)));
12243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1225397b6df1SKris Buschelman }
1226397b6df1SKris Buschelman 
1227d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSolveTranspose_MUMPS(Mat A, Vec b, Vec x)
1228d71ae5a4SJacob Faibussowitsch {
1229e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
123051d5961aSHong Zhang 
123151d5961aSHong Zhang   PetscFunctionBegin;
1232a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
12339566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A, b, x));
1234a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 1;
12353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
123651d5961aSHong Zhang }
123751d5961aSHong Zhang 
1238d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatSolve_MUMPS(Mat A, Mat B, Mat X)
1239d71ae5a4SJacob Faibussowitsch {
1240b8491c3eSStefano Zampini   Mat                Bt = NULL;
1241a6053eceSJunchao Zhang   PetscBool          denseX, denseB, flg, flgT;
1242e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)A->data;
1243334c5f61SHong Zhang   PetscInt           i, nrhs, M;
12441683a169SBarry Smith   PetscScalar       *array;
12451683a169SBarry Smith   const PetscScalar *rbray;
1246a6053eceSJunchao Zhang   PetscInt           lsol_loc, nlsol_loc, *idxx, iidx = 0;
1247a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc, *isol_loc_save;
12481683a169SBarry Smith   PetscScalar       *bray, *sol_loc, *sol_loc_save;
1249be818407SHong Zhang   IS                 is_to, is_from;
1250beae5ec0SHong Zhang   PetscInt           k, proc, j, m, myrstart;
1251be818407SHong Zhang   const PetscInt    *rstart;
125267602552SJunchao Zhang   Vec                v_mpi, msol_loc;
125367602552SJunchao Zhang   VecScatter         scat_sol;
125467602552SJunchao Zhang   Vec                b_seq;
125567602552SJunchao Zhang   VecScatter         scat_rhs;
1256be818407SHong Zhang   PetscScalar       *aa;
1257be818407SHong Zhang   PetscInt           spnr, *ia, *ja;
1258d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1259bda8bf91SBarry Smith 
1260e0b74bf9SHong Zhang   PetscFunctionBegin;
12619566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X, &denseX, MATSEQDENSE, MATMPIDENSE, NULL));
126228b400f6SJacob Faibussowitsch   PetscCheck(denseX, PetscObjectComm((PetscObject)X), PETSC_ERR_ARG_WRONG, "Matrix X must be MATDENSE matrix");
1263be818407SHong Zhang 
12649566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B, &denseB, MATSEQDENSE, MATMPIDENSE, NULL));
1265a6053eceSJunchao Zhang   if (denseB) {
126608401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix B and X must have same row distribution");
1267be818407SHong Zhang     mumps->id.ICNTL(20) = 0; /* dense RHS */
12680e6b8875SHong Zhang   } else {                   /* sparse B */
126908401ef6SPierre Jolivet     PetscCheck(X != B, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_IDN, "X and B must be different matrices");
1270013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)B, MATTRANSPOSEVIRTUAL, &flgT));
1271da81f932SPierre Jolivet     if (flgT) { /* input B is transpose of actual RHS matrix,
12720e6b8875SHong Zhang                  because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
12739566063dSJacob Faibussowitsch       PetscCall(MatTransposeGetMat(B, &Bt));
1274013e2dc7SBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)B), PETSC_ERR_ARG_WRONG, "Matrix B must be MATTRANSPOSEVIRTUAL matrix");
1275be818407SHong Zhang     mumps->id.ICNTL(20) = 1; /* sparse RHS */
1276b8491c3eSStefano Zampini   }
127787b22cf4SHong Zhang 
12789566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, &nrhs));
12799481e6e9SHong Zhang   mumps->id.nrhs = nrhs;
12809481e6e9SHong Zhang   mumps->id.lrhs = M;
12812b691707SHong Zhang   mumps->id.rhs  = NULL;
12829481e6e9SHong Zhang 
12832d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1284b8491c3eSStefano Zampini     PetscScalar *aa;
1285b8491c3eSStefano Zampini     PetscInt     spnr, *ia, *ja;
1286e94cce23SStefano Zampini     PetscBool    second_solve = PETSC_FALSE;
1287b8491c3eSStefano Zampini 
12889566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &array));
1289b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar *)array;
12902b691707SHong Zhang 
1291a6053eceSJunchao Zhang     if (denseB) {
12922b691707SHong Zhang       /* copy B to X */
12939566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
12949566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, rbray, M * nrhs));
12959566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
12962b691707SHong Zhang     } else { /* sparse B */
12979566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt, &aa));
12989566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
129928b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
13009566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
1301b8491c3eSStefano Zampini       mumps->id.rhs_sparse = (MumpsScalar *)aa;
1302b8491c3eSStefano Zampini     }
1303e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
1304583f777eSStefano Zampini     if (mumps->id.size_schur > 0 && (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2)) {
1305e94cce23SStefano Zampini       second_solve = PETSC_TRUE;
13069566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1307e94cce23SStefano Zampini     }
13082cd7d884SHong Zhang     /* solve phase */
13092cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
13103ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
131108401ef6SPierre 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));
1312b5fa320bSStefano Zampini 
1313b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
13141baa6e33SBarry Smith     if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
1315a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
13169566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt, &aa));
13179566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
131828b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
1319b8491c3eSStefano Zampini     }
13209566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &array));
13213ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1322be818407SHong Zhang   }
1323801fbe65SHong Zhang 
13242ef1f0ffSBarry Smith   /* parallel case: MUMPS requires rhs B to be centralized on the host! */
1325aed4548fSBarry Smith   PetscCheck(mumps->petsc_size <= 1 || !mumps->id.ICNTL(19), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1326241dbb5eSStefano Zampini 
1327beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
13281683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
13291683a169SBarry Smith   sol_loc_save  = (PetscScalar *)mumps->id.sol_loc;
1330801fbe65SHong Zhang 
1331a1dfcbd9SJunchao Zhang   lsol_loc  = mumps->id.lsol_loc;
133271aed81dSHong Zhang   nlsol_loc = nrhs * lsol_loc; /* length of sol_loc */
13339566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc, &sol_loc, lsol_loc, &isol_loc));
1334940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
1335801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1336801fbe65SHong Zhang 
13379566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, nlsol_loc, (PetscScalar *)sol_loc, &msol_loc));
13382cd7d884SHong Zhang 
133967602552SJunchao Zhang   if (denseB) {
134025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
134167602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
13429566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
13439566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, nrhs, rbray));
13449566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
13459566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
13469566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, NULL, &v_mpi));
134725aac85cSJunchao Zhang     } else {
134825aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
134980577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
135080577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
135180577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
135280577c12SJunchao Zhang       */
135380577c12SJunchao Zhang 
135467602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1355be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
13569566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
13579566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B, &bray));
13589566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
13599566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B, &bray));
13602b691707SHong Zhang 
1361be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1362801fbe65SHong Zhang       if (!mumps->myid) {
1363beae5ec0SHong Zhang         PetscInt *idx;
1364beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
13659566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nrhs * M, &idx));
13669566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B, &rstart));
1367be818407SHong Zhang         k = 0;
13682d4298aeSJunchao Zhang         for (proc = 0; proc < mumps->petsc_size; proc++) {
1369be818407SHong Zhang           for (j = 0; j < nrhs; j++) {
1370beae5ec0SHong Zhang             for (i = rstart[proc]; i < rstart[proc + 1]; i++) idx[k++] = j * M + i;
1371be818407SHong Zhang           }
1372be818407SHong Zhang         }
1373be818407SHong Zhang 
13749566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, nrhs * M, &b_seq));
13759566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nrhs * M, idx, PETSC_OWN_POINTER, &is_to));
13769566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, nrhs * M, 0, 1, &is_from));
1377801fbe65SHong Zhang       } else {
13789566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, 0, &b_seq));
13799566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_to));
13809566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_from));
1381801fbe65SHong Zhang       }
13829566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi, is_from, b_seq, is_to, &scat_rhs));
13839566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
13849566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
13859566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
13869566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
1387801fbe65SHong Zhang 
1388801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
13899566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq, &bray));
1390940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar *)bray;
13919566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq, &bray));
1392801fbe65SHong Zhang       }
139325aac85cSJunchao Zhang     }
13942b691707SHong Zhang   } else { /* sparse B */
13952b691707SHong Zhang     b = (Mat_MPIAIJ *)Bt->data;
13962b691707SHong Zhang 
1397be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
13989566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X, &m, NULL));
13999566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &bray));
14009566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
14019566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &bray));
14022b691707SHong Zhang 
14032b691707SHong Zhang     if (!mumps->myid) {
14049566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A, &aa));
14059566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
140628b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
14079566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
14082b691707SHong Zhang       mumps->id.rhs_sparse = (MumpsScalar *)aa;
14092b691707SHong Zhang     } else {
14102b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
14112b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
14122b691707SHong Zhang       mumps->id.nz_rhs      = 0;
14132b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
14142b691707SHong Zhang     }
14152b691707SHong Zhang   }
14162b691707SHong Zhang 
1417801fbe65SHong Zhang   /* solve phase */
1418801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
14193ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
142008401ef6SPierre 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));
1421801fbe65SHong Zhang 
1422334c5f61SHong Zhang   /* scatter mumps distributed solution to petsc vector v_mpi, which shares local arrays with solution matrix X */
14239566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X, &array));
14249566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi, array));
1425801fbe65SHong Zhang 
1426334c5f61SHong Zhang   /* create scatter scat_sol */
14279566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X, &rstart));
1428beae5ec0SHong Zhang   /* iidx: index for scatter mumps solution to petsc X */
1429beae5ec0SHong Zhang 
14309566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, nlsol_loc, 0, 1, &is_from));
14319566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc, &idxx));
1432beae5ec0SHong Zhang   for (i = 0; i < lsol_loc; i++) {
1433beae5ec0SHong 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 */
1434beae5ec0SHong Zhang 
14352d4298aeSJunchao Zhang     for (proc = 0; proc < mumps->petsc_size; proc++) {
1436beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc + 1]) {
1437beae5ec0SHong Zhang         myrstart = rstart[proc];
1438beae5ec0SHong Zhang         k        = isol_loc[i] - myrstart;          /* local index on 1st column of petsc vector X */
1439beae5ec0SHong Zhang         iidx     = k + myrstart * nrhs;             /* maps mumps isol_loc[i] to petsc index in X */
1440beae5ec0SHong Zhang         m        = rstart[proc + 1] - rstart[proc]; /* rows of X for this proc */
1441beae5ec0SHong Zhang         break;
1442be818407SHong Zhang       }
1443be818407SHong Zhang     }
1444be818407SHong Zhang 
1445beae5ec0SHong Zhang     for (j = 0; j < nrhs; j++) idxx[i + j * lsol_loc] = iidx + j * m;
1446801fbe65SHong Zhang   }
14479566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nlsol_loc, idxx, PETSC_COPY_VALUES, &is_to));
14489566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc, is_from, v_mpi, is_to, &scat_sol));
14499566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
14509566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
14519566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
14529566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
14539566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X, &array));
145471aed81dSHong Zhang 
145571aed81dSHong Zhang   /* free spaces */
14561683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar *)sol_loc_save;
145771aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
145871aed81dSHong Zhang 
14599566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc, isol_loc));
14609566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
14619566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
14629566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1463a6053eceSJunchao Zhang   if (!denseB) {
14642b691707SHong Zhang     if (!mumps->myid) {
1465d56c302dSHong Zhang       b = (Mat_MPIAIJ *)Bt->data;
14669566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A, &aa));
14679566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
146828b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
14692b691707SHong Zhang     }
14702b691707SHong Zhang   } else {
147125aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
14729566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
14739566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
147425aac85cSJunchao Zhang     }
14752b691707SHong Zhang   }
14769566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
14779566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(2.0 * nrhs * mumps->id.RINFO(3)));
14783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1479e0b74bf9SHong Zhang }
1480e0b74bf9SHong Zhang 
1481d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatSolveTranspose_MUMPS(Mat A, Mat B, Mat X)
1482d71ae5a4SJacob Faibussowitsch {
1483b18964edSHong Zhang   Mat_MUMPS    *mumps    = (Mat_MUMPS *)A->data;
1484b18964edSHong Zhang   PetscMUMPSInt oldvalue = mumps->id.ICNTL(9);
1485b18964edSHong Zhang 
1486b18964edSHong Zhang   PetscFunctionBegin;
1487b18964edSHong Zhang   mumps->id.ICNTL(9) = 0;
1488b18964edSHong Zhang   PetscCall(MatMatSolve_MUMPS(A, B, X));
1489b18964edSHong Zhang   mumps->id.ICNTL(9) = oldvalue;
14903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1491b18964edSHong Zhang }
1492b18964edSHong Zhang 
1493d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A, Mat Bt, Mat X)
1494d71ae5a4SJacob Faibussowitsch {
1495eb3ef3b2SHong Zhang   PetscBool flg;
1496eb3ef3b2SHong Zhang   Mat       B;
1497eb3ef3b2SHong Zhang 
1498eb3ef3b2SHong Zhang   PetscFunctionBegin;
14999566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
150028b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)Bt), PETSC_ERR_ARG_WRONG, "Matrix Bt must be MATAIJ matrix");
1501eb3ef3b2SHong Zhang 
1502eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
15039566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt, &B));
1504eb3ef3b2SHong Zhang 
15059566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A, B, X));
15069566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
15073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1508eb3ef3b2SHong Zhang }
1509eb3ef3b2SHong Zhang 
1510ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1511a58c3f20SHong Zhang /*
1512a58c3f20SHong Zhang   input:
1513a58c3f20SHong Zhang    F:        numeric factor
1514a58c3f20SHong Zhang   output:
1515a58c3f20SHong Zhang    nneg:     total number of negative pivots
151619d49a3bSHong Zhang    nzero:    total number of zero pivots
151719d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1518a58c3f20SHong Zhang */
1519d71ae5a4SJacob Faibussowitsch PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F, PetscInt *nneg, PetscInt *nzero, PetscInt *npos)
1520d71ae5a4SJacob Faibussowitsch {
1521e69c285eSBarry Smith   Mat_MUMPS  *mumps = (Mat_MUMPS *)F->data;
1522c1490034SHong Zhang   PetscMPIInt size;
1523a58c3f20SHong Zhang 
1524a58c3f20SHong Zhang   PetscFunctionBegin;
15259566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F), &size));
1526bcb30aebSHong 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 */
1527aed4548fSBarry 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));
1528ed85ac9fSHong Zhang 
1529710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1530ed85ac9fSHong Zhang   if (nzero || npos) {
153108401ef6SPierre 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");
1532710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1533710ac8efSHong Zhang     if (npos) *npos = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1534a58c3f20SHong Zhang   }
15353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1536a58c3f20SHong Zhang }
153719d49a3bSHong Zhang #endif
1538a58c3f20SHong Zhang 
1539d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse, Mat_MUMPS *mumps)
1540d71ae5a4SJacob Faibussowitsch {
1541a6053eceSJunchao Zhang   PetscInt       i, nreqs;
1542a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;
1543a6053eceSJunchao Zhang   PetscMPIInt    count;
1544a6053eceSJunchao Zhang   PetscInt64     totnnz, remain;
1545a6053eceSJunchao Zhang   const PetscInt osize = mumps->omp_comm_size;
1546a6053eceSJunchao Zhang   PetscScalar   *val;
15473ab56b82SJunchao Zhang 
15483ab56b82SJunchao Zhang   PetscFunctionBegin;
1549a6053eceSJunchao Zhang   if (osize > 1) {
15503ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
15513ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
15529566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize, &mumps->recvcount));
15539566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz, 1, MPIU_INT64, mumps->recvcount, 1, MPIU_INT64, 0 /*master*/, mumps->omp_comm));
15543ab56b82SJunchao Zhang 
1555a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
15563ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1557a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1558a6053eceSJunchao Zhang         nreqs = 0;
1559a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) nreqs += (mumps->recvcount[i] + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
1560a6053eceSJunchao Zhang       } else {
1561a6053eceSJunchao Zhang         nreqs = (mumps->nnz + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
15623ab56b82SJunchao Zhang       }
156335cb6cd3SPierre Jolivet       PetscCall(PetscMalloc1(nreqs * 3, &mumps->reqs)); /* Triple the requests since we send irn, jcn and val separately */
15643ab56b82SJunchao Zhang 
1565a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1566a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1567a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1568a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1569a6053eceSJunchao Zhang        */
1570a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
15713ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1572a6053eceSJunchao Zhang         for (i = 0, totnnz = 0; i < osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
15739566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz, &irn, totnnz, &jcn));
15749566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz, &val));
1575a6053eceSJunchao Zhang 
1576a6053eceSJunchao Zhang         /* Self communication */
15779566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn, mumps->irn, mumps->nnz));
15789566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn, mumps->jcn, mumps->nnz));
15799566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val, mumps->val, mumps->nnz));
1580a6053eceSJunchao Zhang 
1581a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
15829566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
15839566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1584a6053eceSJunchao Zhang         mumps->nnz = totnnz;
15853ab56b82SJunchao Zhang         mumps->irn = irn;
15863ab56b82SJunchao Zhang         mumps->jcn = jcn;
1587a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1588a6053eceSJunchao Zhang 
1589a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
1590a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
1591a6053eceSJunchao Zhang         val += mumps->recvcount[0];
1592a6053eceSJunchao Zhang 
1593a6053eceSJunchao Zhang         /* Remote communication */
1594a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) {
1595a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1596a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1597a6053eceSJunchao Zhang           while (count > 0) {
15989566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(irn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
15999566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(jcn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
16009566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1601a6053eceSJunchao Zhang             irn += count;
1602a6053eceSJunchao Zhang             jcn += count;
1603a6053eceSJunchao Zhang             val += count;
1604a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1605a6053eceSJunchao Zhang             remain -= count;
1606a6053eceSJunchao Zhang           }
16073ab56b82SJunchao Zhang         }
16083ab56b82SJunchao Zhang       } else {
1609a6053eceSJunchao Zhang         irn    = mumps->irn;
1610a6053eceSJunchao Zhang         jcn    = mumps->jcn;
1611a6053eceSJunchao Zhang         val    = mumps->val;
1612a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1613a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1614a6053eceSJunchao Zhang         while (count > 0) {
16159566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(irn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
16169566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(jcn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
16179566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1618a6053eceSJunchao Zhang           irn += count;
1619a6053eceSJunchao Zhang           jcn += count;
1620a6053eceSJunchao Zhang           val += count;
1621a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1622a6053eceSJunchao Zhang           remain -= count;
16233ab56b82SJunchao Zhang         }
16243ab56b82SJunchao Zhang       }
1625a6053eceSJunchao Zhang     } else {
1626a6053eceSJunchao Zhang       nreqs = 0;
1627a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
1628a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
1629a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) { /* Remote communication only since self data is already in place */
1630a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1631a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1632a6053eceSJunchao Zhang           while (count > 0) {
16339566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1634a6053eceSJunchao Zhang             val += count;
1635a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1636a6053eceSJunchao Zhang             remain -= count;
1637a6053eceSJunchao Zhang           }
1638a6053eceSJunchao Zhang         }
1639a6053eceSJunchao Zhang       } else {
1640a6053eceSJunchao Zhang         val    = mumps->val;
1641a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1642a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1643a6053eceSJunchao Zhang         while (count > 0) {
16449566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1645a6053eceSJunchao Zhang           val += count;
1646a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1647a6053eceSJunchao Zhang           remain -= count;
1648a6053eceSJunchao Zhang         }
1649a6053eceSJunchao Zhang       }
1650a6053eceSJunchao Zhang     }
16519566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs, mumps->reqs, MPI_STATUSES_IGNORE));
1652a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
1653a6053eceSJunchao Zhang   }
16543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
16553ab56b82SJunchao Zhang }
16563ab56b82SJunchao Zhang 
1657d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorNumeric_MUMPS(Mat F, Mat A, const MatFactorInfo *info)
1658d71ae5a4SJacob Faibussowitsch {
1659e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)(F)->data;
1660ace3abfcSBarry Smith   PetscBool  isMPIAIJ;
1661397b6df1SKris Buschelman 
1662397b6df1SKris Buschelman   PetscFunctionBegin;
1663dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
166448a46eb9SPierre Jolivet     if (mumps->id.INFOG(1) == -6) 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)));
16659566063dSJacob 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)));
16663ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
16672aca8efcSHong Zhang   }
16686baea169SHong Zhang 
16699566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
16709566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX, mumps));
1671397b6df1SKris Buschelman 
1672397b6df1SKris Buschelman   /* numerical factorization phase */
1673a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
16744e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
1675ad540459SPierre Jolivet     if (!mumps->myid) mumps->id.a = (MumpsScalar *)mumps->val;
1676397b6df1SKris Buschelman   } else {
1677940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar *)mumps->val;
1678397b6df1SKris Buschelman   }
16793ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1680a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
16817a46b595SBarry Smith     PetscCheck(!A->erroriffailure, 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));
1682c0d63f2fSHong Zhang     if (mumps->id.INFOG(1) == -10) { /* numerically singular matrix */
16839566063dSJacob Faibussowitsch       PetscCall(PetscInfo(F, "matrix is numerically singular, INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1684603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
1685c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -13) {
16869566063dSJacob 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)));
1687603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1688c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
16899566063dSJacob 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)));
1690603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
16912aca8efcSHong Zhang     } else {
16929566063dSJacob Faibussowitsch       PetscCall(PetscInfo(F, "MUMPS in numerical factorization phase: INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1693603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
1694151787a6SHong Zhang     }
16952aca8efcSHong Zhang   }
1696aed4548fSBarry Smith   PetscCheck(mumps->myid || mumps->id.ICNTL(16) <= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "  mumps->id.ICNTL(16):=%d", mumps->id.INFOG(16));
1697397b6df1SKris Buschelman 
1698b3cb21ddSStefano Zampini   F->assembled = PETSC_TRUE;
1699d47f36abSHong Zhang 
1700b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
17013cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
1702c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
17033cb7dd0eSStefano Zampini #endif
1704b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
1705b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
17069566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur, MAT_INPLACE_MATRIX, &F->schur));
1707b3cb21ddSStefano Zampini     }
17089566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F, NULL, MAT_FACTOR_SCHUR_UNFACTORED));
1709b3cb21ddSStefano Zampini   }
171067877ebaSShri Abhyankar 
1711066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
1712066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
1713066565c5SStefano Zampini 
17143ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
17152d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
171667877ebaSShri Abhyankar     PetscInt     lsol_loc;
171767877ebaSShri Abhyankar     PetscScalar *sol_loc;
17182205254eSKarl Rupp 
17199566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A, MATMPIAIJ, &isMPIAIJ));
1720c2093ab7SHong Zhang 
1721c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
1722c2093ab7SHong Zhang     if (mumps->x_seq) {
17239566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
17249566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
17259566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
1726c2093ab7SHong Zhang     }
1727a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
17289566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc, &sol_loc, lsol_loc, &mumps->id.isol_loc));
1729a5e57a09SHong Zhang     mumps->id.lsol_loc = lsol_loc;
1730940cd9d6SSatish Balay     mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
17319566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, lsol_loc, sol_loc, &mumps->x_seq));
173267877ebaSShri Abhyankar   }
17339566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(mumps->id.RINFO(2)));
17343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1735397b6df1SKris Buschelman }
1736397b6df1SKris Buschelman 
17379a2535b5SHong Zhang /* Sets MUMPS options from the options database */
1738d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
1739d71ae5a4SJacob Faibussowitsch {
1740e69c285eSBarry Smith   Mat_MUMPS    *mumps = (Mat_MUMPS *)F->data;
1741413bcc21SPierre Jolivet   PetscMUMPSInt icntl = 0, size, *listvar_schur;
174245e3843bSPierre Jolivet   PetscInt      info[80], i, ninfo = 80, rbs, cbs;
1743413bcc21SPierre Jolivet   PetscBool     flg = PETSC_FALSE, schur = (PetscBool)(mumps->id.ICNTL(26) == -1);
1744413bcc21SPierre Jolivet   MumpsScalar  *arr;
1745dcd589f8SShri Abhyankar 
1746dcd589f8SShri Abhyankar   PetscFunctionBegin;
174726cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F), ((PetscObject)F)->prefix, "MUMPS Options", "Mat");
1748413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) { /* MatSetFromOptions_MUMPS() has never been called before */
1749413bcc21SPierre Jolivet     PetscInt nthreads   = 0;
1750413bcc21SPierre Jolivet     PetscInt nCNTL_pre  = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
1751413bcc21SPierre Jolivet     PetscInt nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
1752413bcc21SPierre Jolivet 
1753413bcc21SPierre Jolivet     mumps->petsc_comm = PetscObjectComm((PetscObject)A);
1754413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->petsc_comm, &mumps->petsc_size));
1755413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm, &mumps->myid)); /* "if (!myid)" still works even if mumps_comm is different */
1756413bcc21SPierre Jolivet 
1757413bcc21SPierre Jolivet     PetscCall(PetscOptionsName("-mat_mumps_use_omp_threads", "Convert MPI processes into OpenMP threads", "None", &mumps->use_petsc_omp_support));
1758413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
1759413bcc21SPierre Jolivet     /* do not use PetscOptionsInt() so that the option -mat_mumps_use_omp_threads is not displayed twice in the help */
1760413bcc21SPierre Jolivet     PetscCall(PetscOptionsGetInt(NULL, ((PetscObject)F)->prefix, "-mat_mumps_use_omp_threads", &nthreads, NULL));
1761413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) {
17629371c9d4SSatish Balay       PetscCheck(PetscDefined(HAVE_OPENMP_SUPPORT), 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",
17639371c9d4SSatish Balay                  ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
1764413bcc21SPierre Jolivet       PetscCheck(!schur, PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use -%smat_mumps_use_omp_threads with the Schur complement feature", ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
1765413bcc21SPierre Jolivet #if defined(PETSC_HAVE_OPENMP_SUPPORT)
1766413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm, nthreads, &mumps->omp_ctrl));
1767413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl, &mumps->omp_comm, &mumps->mumps_comm, &mumps->is_omp_master));
1768413bcc21SPierre Jolivet #endif
1769413bcc21SPierre Jolivet     } else {
1770413bcc21SPierre Jolivet       mumps->omp_comm      = PETSC_COMM_SELF;
1771413bcc21SPierre Jolivet       mumps->mumps_comm    = mumps->petsc_comm;
1772413bcc21SPierre Jolivet       mumps->is_omp_master = PETSC_TRUE;
1773413bcc21SPierre Jolivet     }
1774413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->omp_comm, &mumps->omp_comm_size));
1775413bcc21SPierre Jolivet     mumps->reqs = NULL;
1776413bcc21SPierre Jolivet     mumps->tag  = 0;
1777413bcc21SPierre Jolivet 
1778413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
1779413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) {
1780413bcc21SPierre Jolivet         /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
1781413bcc21SPierre Jolivet         MPI_Comm comm;
1782413bcc21SPierre Jolivet         PetscCallMPI(MPI_Comm_dup(mumps->mumps_comm, &comm));
1783413bcc21SPierre Jolivet         mumps->mumps_comm = comm;
1784413bcc21SPierre Jolivet       } else PetscCall(PetscCommGetComm(mumps->petsc_comm, &mumps->mumps_comm));
1785413bcc21SPierre Jolivet     }
1786413bcc21SPierre Jolivet 
1787413bcc21SPierre Jolivet     mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
1788413bcc21SPierre Jolivet     mumps->id.job          = JOB_INIT;
1789413bcc21SPierre Jolivet     mumps->id.par          = 1; /* host participates factorizaton and solve */
1790413bcc21SPierre Jolivet     mumps->id.sym          = mumps->sym;
1791413bcc21SPierre Jolivet 
1792413bcc21SPierre Jolivet     size          = mumps->id.size_schur;
1793413bcc21SPierre Jolivet     arr           = mumps->id.schur;
1794413bcc21SPierre Jolivet     listvar_schur = mumps->id.listvar_schur;
1795413bcc21SPierre Jolivet     PetscMUMPS_c(mumps);
1796413bcc21SPierre Jolivet     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "Error reported by MUMPS: INFOG(1)=%d", mumps->id.INFOG(1));
1797413bcc21SPierre Jolivet     /* restore cached ICNTL and CNTL values */
1798413bcc21SPierre Jolivet     for (icntl = 0; icntl < nICNTL_pre; ++icntl) mumps->id.ICNTL(mumps->ICNTL_pre[1 + 2 * icntl]) = mumps->ICNTL_pre[2 + 2 * icntl];
1799413bcc21SPierre Jolivet     for (icntl = 0; icntl < nCNTL_pre; ++icntl) mumps->id.CNTL((PetscInt)mumps->CNTL_pre[1 + 2 * icntl]) = mumps->CNTL_pre[2 + 2 * icntl];
1800413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->ICNTL_pre));
1801413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->CNTL_pre));
1802413bcc21SPierre Jolivet 
1803413bcc21SPierre Jolivet     if (schur) {
1804413bcc21SPierre Jolivet       mumps->id.size_schur    = size;
1805413bcc21SPierre Jolivet       mumps->id.schur_lld     = size;
1806413bcc21SPierre Jolivet       mumps->id.schur         = arr;
1807413bcc21SPierre Jolivet       mumps->id.listvar_schur = listvar_schur;
1808413bcc21SPierre Jolivet       if (mumps->petsc_size > 1) {
1809413bcc21SPierre Jolivet         PetscBool gs; /* gs is false if any rank other than root has non-empty IS */
1810413bcc21SPierre Jolivet 
1811413bcc21SPierre Jolivet         mumps->id.ICNTL(19) = 1;                                                                            /* MUMPS returns Schur centralized on the host */
1812413bcc21SPierre Jolivet         gs                  = mumps->myid ? (mumps->id.size_schur ? PETSC_FALSE : PETSC_TRUE) : PETSC_TRUE; /* always true on root; false on others if their size != 0 */
1813413bcc21SPierre Jolivet         PetscCallMPI(MPI_Allreduce(MPI_IN_PLACE, &gs, 1, MPIU_BOOL, MPI_LAND, mumps->petsc_comm));
1814413bcc21SPierre Jolivet         PetscCheck(gs, PETSC_COMM_SELF, PETSC_ERR_SUP, "MUMPS distributed parallel Schur complements not yet supported from PETSc");
1815413bcc21SPierre Jolivet       } else {
1816413bcc21SPierre Jolivet         if (F->factortype == MAT_FACTOR_LU) {
1817413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
1818413bcc21SPierre Jolivet         } else {
1819413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
1820413bcc21SPierre Jolivet         }
1821413bcc21SPierre Jolivet       }
1822413bcc21SPierre Jolivet       mumps->id.ICNTL(26) = -1;
1823413bcc21SPierre Jolivet     }
1824413bcc21SPierre Jolivet 
1825413bcc21SPierre Jolivet     /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
1826413bcc21SPierre Jolivet        For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
1827413bcc21SPierre Jolivet      */
1828413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.icntl, 40, MPI_INT, 0, mumps->omp_comm));
1829413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15, MPIU_REAL, 0, mumps->omp_comm));
1830413bcc21SPierre Jolivet 
1831413bcc21SPierre Jolivet     mumps->scat_rhs = NULL;
1832413bcc21SPierre Jolivet     mumps->scat_sol = NULL;
1833413bcc21SPierre Jolivet 
1834413bcc21SPierre Jolivet     /* set PETSc-MUMPS default options - override MUMPS default */
1835413bcc21SPierre Jolivet     mumps->id.ICNTL(3) = 0;
1836413bcc21SPierre Jolivet     mumps->id.ICNTL(4) = 0;
1837413bcc21SPierre Jolivet     if (mumps->petsc_size == 1) {
1838413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 0; /* centralized assembled matrix input */
1839413bcc21SPierre Jolivet       mumps->id.ICNTL(7)  = 7; /* automatic choice of ordering done by the package */
1840413bcc21SPierre Jolivet     } else {
1841413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 3; /* distributed assembled matrix input */
1842413bcc21SPierre Jolivet       mumps->id.ICNTL(21) = 1; /* distributed solution */
1843413bcc21SPierre Jolivet     }
1844413bcc21SPierre Jolivet   }
18459566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1", "ICNTL(1): output stream for error messages", "None", mumps->id.ICNTL(1), &icntl, &flg));
18469a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
18479566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2", "ICNTL(2): output stream for diagnostic printing, statistics, and warning", "None", mumps->id.ICNTL(2), &icntl, &flg));
18489a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
18499566063dSJacob 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));
18509a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
1851dcd589f8SShri Abhyankar 
18529566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4", "ICNTL(4): level of printing (0 to 4)", "None", mumps->id.ICNTL(4), &icntl, &flg));
18539a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
18549a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
18559a2535b5SHong Zhang 
18569566063dSJacob 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));
18579a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
18589a2535b5SHong Zhang 
18599566063dSJacob 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));
1860dcd589f8SShri Abhyankar   if (flg) {
1861aed4548fSBarry 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");
1862b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
1863dcd589f8SShri Abhyankar   }
1864e0b74bf9SHong Zhang 
18659566063dSJacob 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));
18669566063dSJacob 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() */
18679566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10", "ICNTL(10): max num of refinements", "None", mumps->id.ICNTL(10), &mumps->id.ICNTL(10), NULL));
18689566063dSJacob 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));
18699566063dSJacob 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));
18709566063dSJacob 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));
18719566063dSJacob 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));
187245e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A, &rbs, &cbs));
187345e3843bSPierre Jolivet   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = -rbs;
187445e3843bSPierre 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));
187545e3843bSPierre Jolivet   if (flg) {
187645e3843bSPierre Jolivet     PetscCheck(mumps->id.ICNTL(15) <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Positive -mat_mumps_icntl_15 not handled");
187745e3843bSPierre 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");
187845e3843bSPierre Jolivet   }
18799566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19", "ICNTL(19): computes the Schur complement", "None", mumps->id.ICNTL(19), &mumps->id.ICNTL(19), NULL));
188059ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
18819566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
18829566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
188359ac8732SStefano Zampini   }
188425aac85cSJunchao Zhang 
188543f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
188643f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
188725aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
188843f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
188943f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
189043f3b051SJunchao Zhang      In short, we could not use distributed RHS with MPICH until v4.0b1.
189125aac85cSJunchao Zhang    */
189243f3b051SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0) || (defined(PETSC_HAVE_MPICH_NUMVERSION) && (PETSC_HAVE_MPICH_NUMVERSION < 40000101))
189325aac85cSJunchao Zhang   mumps->ICNTL20 = 0; /* Centralized dense RHS*/
189443f3b051SJunchao Zhang #else
189543f3b051SJunchao Zhang   mumps->ICNTL20     = 10; /* Distributed dense RHS*/
189625aac85cSJunchao Zhang #endif
18979566063dSJacob 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));
1898aed4548fSBarry 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);
189925aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0)
1900aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10, PETSC_COMM_SELF, PETSC_ERR_SUP, "ICNTL(20)=10 is not supported before MUMPS-5.3.0");
190125aac85cSJunchao Zhang #endif
19029566063dSJacob 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 */
19039a2535b5SHong Zhang 
19049566063dSJacob 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));
19059566063dSJacob 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));
19069566063dSJacob 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));
19079371c9d4SSatish Balay   if (mumps->id.ICNTL(24)) { mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */ }
1908d7ebd59bSHong Zhang 
19099566063dSJacob 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));
19109566063dSJacob 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));
19119566063dSJacob 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));
19129566063dSJacob 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));
19139566063dSJacob 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));
19149566063dSJacob 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 */
19159566063dSJacob 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));
19169566063dSJacob 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 */
19179566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33", "ICNTL(33): compute determinant", "None", mumps->id.ICNTL(33), &mumps->id.ICNTL(33), NULL));
19189566063dSJacob 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));
19199566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36", "ICNTL(36): choice of BLR factorization variant", "None", mumps->id.ICNTL(36), &mumps->id.ICNTL(36), NULL));
19209566063dSJacob 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));
1921dcd589f8SShri Abhyankar 
19229566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1", "CNTL(1): relative pivoting threshold", "None", mumps->id.CNTL(1), &mumps->id.CNTL(1), NULL));
19239566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2", "CNTL(2): stopping criterion of refinement", "None", mumps->id.CNTL(2), &mumps->id.CNTL(2), NULL));
19249566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3", "CNTL(3): absolute pivoting threshold", "None", mumps->id.CNTL(3), &mumps->id.CNTL(3), NULL));
19259566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4", "CNTL(4): value for static pivoting", "None", mumps->id.CNTL(4), &mumps->id.CNTL(4), NULL));
19269566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5", "CNTL(5): fixation for null pivots", "None", mumps->id.CNTL(5), &mumps->id.CNTL(5), NULL));
19279566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7", "CNTL(7): dropping parameter used during BLR", "None", mumps->id.CNTL(7), &mumps->id.CNTL(7), NULL));
1928e5bb22a1SHong Zhang 
19299566063dSJacob 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));
1930b34f08ffSHong Zhang 
19319566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info", "request INFO local to each processor", "", info, &ninfo, NULL));
1932b34f08ffSHong Zhang   if (ninfo) {
193308401ef6SPierre Jolivet     PetscCheck(ninfo <= 80, PETSC_COMM_SELF, PETSC_ERR_USER, "number of INFO %" PetscInt_FMT " must <= 80", ninfo);
19349566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo, &mumps->info));
1935b34f08ffSHong Zhang     mumps->ninfo = ninfo;
1936b34f08ffSHong Zhang     for (i = 0; i < ninfo; i++) {
1937aed4548fSBarry 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);
1938f7d195e4SLawrence Mitchell       mumps->info[i] = info[i];
1939b34f08ffSHong Zhang     }
1940b34f08ffSHong Zhang   }
1941d0609cedSBarry Smith   PetscOptionsEnd();
19423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1943dcd589f8SShri Abhyankar }
1944dcd589f8SShri Abhyankar 
1945d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F, Mat A, const MatFactorInfo *info, Mat_MUMPS *mumps)
1946d71ae5a4SJacob Faibussowitsch {
19475cd7cf9dSHong Zhang   PetscFunctionBegin;
19485cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
19497a46b595SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "Error reported by MUMPS in analysis phase: INFOG(1)=%d", mumps->id.INFOG(1));
19505cd7cf9dSHong Zhang     if (mumps->id.INFOG(1) == -6) {
19519566063dSJacob Faibussowitsch       PetscCall(PetscInfo(F, "matrix is singular in structure, INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1952603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
19535cd7cf9dSHong Zhang     } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
19549566063dSJacob Faibussowitsch       PetscCall(PetscInfo(F, "problem of workspace, INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1955603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1956dbf6bb8dSprj-     } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
19579566063dSJacob Faibussowitsch       PetscCall(PetscInfo(F, "Empty matrix\n"));
19585cd7cf9dSHong Zhang     } else {
19599566063dSJacob 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)));
1960603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
19615cd7cf9dSHong Zhang     }
19625cd7cf9dSHong Zhang   }
19633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19645cd7cf9dSHong Zhang }
19655cd7cf9dSHong Zhang 
1966d71ae5a4SJacob Faibussowitsch PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
1967d71ae5a4SJacob Faibussowitsch {
1968e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
196967877ebaSShri Abhyankar   Vec            b;
197067877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
1971397b6df1SKris Buschelman 
1972397b6df1SKris Buschelman   PetscFunctionBegin;
1973d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
1974d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
19753ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1976d47f36abSHong Zhang   }
1977dcd589f8SShri Abhyankar 
19789a2535b5SHong Zhang   /* Set MUMPS options from the options database */
197926cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
1980dcd589f8SShri Abhyankar 
19819566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
19829566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
1983dcd589f8SShri Abhyankar 
198467877ebaSShri Abhyankar   /* analysis phase */
1985a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
1986a5e57a09SHong Zhang   mumps->id.n   = M;
1987a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
198867877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
1989a5e57a09SHong Zhang     if (!mumps->myid) {
1990a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
1991a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
1992a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
1993a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
19944ac6704cSBarry Smith       if (r) {
19954ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
1996a5e57a09SHong Zhang         if (!mumps->myid) {
1997e0b74bf9SHong Zhang           const PetscInt *idx;
1998a6053eceSJunchao Zhang           PetscInt        i;
19992205254eSKarl Rupp 
20009566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M, &mumps->id.perm_in));
20019566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r, &idx));
20029566063dSJacob Faibussowitsch           for (i = 0; i < M; i++) PetscCall(PetscMUMPSIntCast(idx[i] + 1, &(mumps->id.perm_in[i]))); /* perm_in[]: start from 1, not 0! */
20039566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r, &idx));
2004e0b74bf9SHong Zhang         }
2005e0b74bf9SHong Zhang       }
200667877ebaSShri Abhyankar     }
200767877ebaSShri Abhyankar     break;
200867877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2009a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2010a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2011a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2012a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
201325aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
20149566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
20159566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
20169566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
201725aac85cSJunchao Zhang     }
201867877ebaSShri Abhyankar     break;
201967877ebaSShri Abhyankar   }
20203ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
20219566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
202267877ebaSShri Abhyankar 
2023719d5645SBarry Smith   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2024dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
202551d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
20264e34a73bSHong Zhang   F->ops->matsolve          = MatMatSolve_MUMPS;
2027eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
2028b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2029d47f36abSHong Zhang 
2030d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
20313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2032b24902e0SBarry Smith }
2033b24902e0SBarry Smith 
2034450b117fSShri Abhyankar /* Note the Petsc r and c permutations are ignored */
2035d71ae5a4SJacob Faibussowitsch PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2036d71ae5a4SJacob Faibussowitsch {
2037e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
203867877ebaSShri Abhyankar   Vec            b;
203967877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2040450b117fSShri Abhyankar 
2041450b117fSShri Abhyankar   PetscFunctionBegin;
2042d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2043d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
20443ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2045d47f36abSHong Zhang   }
2046dcd589f8SShri Abhyankar 
20479a2535b5SHong Zhang   /* Set MUMPS options from the options database */
204826cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2049dcd589f8SShri Abhyankar 
20509566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
20519566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
205267877ebaSShri Abhyankar 
205367877ebaSShri Abhyankar   /* analysis phase */
2054a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2055a5e57a09SHong Zhang   mumps->id.n   = M;
2056a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
205767877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2058a5e57a09SHong Zhang     if (!mumps->myid) {
2059a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2060a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2061a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2062ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
206367877ebaSShri Abhyankar     }
206467877ebaSShri Abhyankar     break;
206567877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2066a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2067a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2068a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2069ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
207025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
20719566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
20729566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
20739566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
207425aac85cSJunchao Zhang     }
207567877ebaSShri Abhyankar     break;
207667877ebaSShri Abhyankar   }
20773ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
20789566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
207967877ebaSShri Abhyankar 
2080450b117fSShri Abhyankar   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2081dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
208251d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
2083b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2084d47f36abSHong Zhang 
2085d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
20863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2087450b117fSShri Abhyankar }
2088b24902e0SBarry Smith 
2089141f4205SHong Zhang /* Note the Petsc r permutation and factor info are ignored */
2090d71ae5a4SJacob Faibussowitsch PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F, Mat A, IS r, const MatFactorInfo *info)
2091d71ae5a4SJacob Faibussowitsch {
2092e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
209367877ebaSShri Abhyankar   Vec            b;
209467877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2095397b6df1SKris Buschelman 
2096397b6df1SKris Buschelman   PetscFunctionBegin;
2097d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2098d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
20993ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2100d47f36abSHong Zhang   }
2101dcd589f8SShri Abhyankar 
21029a2535b5SHong Zhang   /* Set MUMPS options from the options database */
210326cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2104dcd589f8SShri Abhyankar 
21059566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
21069566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2107dcd589f8SShri Abhyankar 
210867877ebaSShri Abhyankar   /* analysis phase */
2109a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2110a5e57a09SHong Zhang   mumps->id.n   = M;
2111a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
211267877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2113a5e57a09SHong Zhang     if (!mumps->myid) {
2114a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2115a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2116a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2117ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
211867877ebaSShri Abhyankar     }
211967877ebaSShri Abhyankar     break;
212067877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2121a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2122a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2123a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2124ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
212525aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
21269566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
21279566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
21289566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
212925aac85cSJunchao Zhang     }
213067877ebaSShri Abhyankar     break;
213167877ebaSShri Abhyankar   }
21323ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
21339566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
21345cd7cf9dSHong Zhang 
21352792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2136dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
213751d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
21384e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
213923a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
2140b18964edSHong Zhang   F->ops->matsolvetranspose     = MatMatSolveTranspose_MUMPS;
21414e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
21420298fd71SBarry Smith   F->ops->getinertia = NULL;
21434e34a73bSHong Zhang #else
21444e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2145db4efbfdSBarry Smith #endif
2146d47f36abSHong Zhang 
2147d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
21483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2149b24902e0SBarry Smith }
2150b24902e0SBarry Smith 
2151d71ae5a4SJacob Faibussowitsch PetscErrorCode MatView_MUMPS(Mat A, PetscViewer viewer)
2152d71ae5a4SJacob Faibussowitsch {
215364e6c443SBarry Smith   PetscBool         iascii;
215464e6c443SBarry Smith   PetscViewerFormat format;
2155e69c285eSBarry Smith   Mat_MUMPS        *mumps = (Mat_MUMPS *)A->data;
2156f6c57405SHong Zhang 
2157f6c57405SHong Zhang   PetscFunctionBegin;
215864e6c443SBarry Smith   /* check if matrix is mumps type */
21593ba16761SJacob Faibussowitsch   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(PETSC_SUCCESS);
216064e6c443SBarry Smith 
21619566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
216264e6c443SBarry Smith   if (iascii) {
21639566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
21641511cd71SPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
21659566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "MUMPS run parameters:\n"));
21661511cd71SPierre Jolivet       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
21679566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  SYM (matrix type):                   %d\n", mumps->id.sym));
21689566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  PAR (host participation):            %d\n", mumps->id.par));
21699566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(1) (output for error):         %d\n", mumps->id.ICNTL(1)));
21709566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(2) (output of diagnostic msg): %d\n", mumps->id.ICNTL(2)));
21719566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(3) (output for global info):   %d\n", mumps->id.ICNTL(3)));
21729566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(4) (level of printing):        %d\n", mumps->id.ICNTL(4)));
21739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(5) (input mat struct):         %d\n", mumps->id.ICNTL(5)));
21749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(6) (matrix prescaling):        %d\n", mumps->id.ICNTL(6)));
21759566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(7) (sequential matrix ordering):%d\n", mumps->id.ICNTL(7)));
21769566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(8) (scaling strategy):         %d\n", mumps->id.ICNTL(8)));
21779566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(10) (max num of refinements):  %d\n", mumps->id.ICNTL(10)));
21789566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(11) (error analysis):          %d\n", mumps->id.ICNTL(11)));
2179a5e57a09SHong Zhang         if (mumps->id.ICNTL(11) > 0) {
21809566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(4) (inf norm of input mat):        %g\n", mumps->id.RINFOG(4)));
21819566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(5) (inf norm of solution):         %g\n", mumps->id.RINFOG(5)));
21829566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(6) (inf norm of residual):         %g\n", mumps->id.RINFOG(6)));
21839566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n", mumps->id.RINFOG(7), mumps->id.RINFOG(8)));
21849566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(9) (error estimate):               %g\n", mumps->id.RINFOG(9)));
21859566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n", mumps->id.RINFOG(10), mumps->id.RINFOG(11)));
2186f6c57405SHong Zhang         }
21879566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(12) (efficiency control):                         %d\n", mumps->id.ICNTL(12)));
21889566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(13) (sequential factorization of the root node):  %d\n", mumps->id.ICNTL(13)));
21899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(14) (percentage of estimated workspace increase): %d\n", mumps->id.ICNTL(14)));
219045e3843bSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(15) (compression of the input matrix):            %d\n", mumps->id.ICNTL(15)));
2191f6c57405SHong Zhang         /* ICNTL(15-17) not used */
21929566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(18) (input mat struct):                           %d\n", mumps->id.ICNTL(18)));
21939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(19) (Schur complement info):                      %d\n", mumps->id.ICNTL(19)));
21949566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(20) (RHS sparse pattern):                         %d\n", mumps->id.ICNTL(20)));
21959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(21) (solution struct):                            %d\n", mumps->id.ICNTL(21)));
21969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(22) (in-core/out-of-core facility):               %d\n", mumps->id.ICNTL(22)));
21979566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(23) (max size of memory can be allocated locally):%d\n", mumps->id.ICNTL(23)));
2198c0165424SHong Zhang 
21999566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(24) (detection of null pivot rows):               %d\n", mumps->id.ICNTL(24)));
22009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(25) (computation of a null space basis):          %d\n", mumps->id.ICNTL(25)));
22019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(26) (Schur options for RHS or solution):          %d\n", mumps->id.ICNTL(26)));
22029566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(27) (blocking size for multiple RHS):             %d\n", mumps->id.ICNTL(27)));
22039566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(28) (use parallel or sequential ordering):        %d\n", mumps->id.ICNTL(28)));
22049566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(29) (parallel ordering):                          %d\n", mumps->id.ICNTL(29)));
220542179a6aSHong Zhang 
22069566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n", mumps->id.ICNTL(30)));
22079566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(31) (factors is discarded in the solve phase):    %d\n", mumps->id.ICNTL(31)));
22089566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(33) (compute determinant):                        %d\n", mumps->id.ICNTL(33)));
22099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(35) (activate BLR based factorization):           %d\n", mumps->id.ICNTL(35)));
22109566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(36) (choice of BLR factorization variant):        %d\n", mumps->id.ICNTL(36)));
22119566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(38) (estimated compression rate of LU factors):   %d\n", mumps->id.ICNTL(38)));
2212f6c57405SHong Zhang 
22139566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(1) (relative pivoting threshold):      %g\n", mumps->id.CNTL(1)));
22149566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(2) (stopping criterion of refinement): %g\n", mumps->id.CNTL(2)));
22159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(3) (absolute pivoting threshold):      %g\n", mumps->id.CNTL(3)));
22169566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(4) (value of static pivoting):         %g\n", mumps->id.CNTL(4)));
22179566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(5) (fixation for null pivots):         %g\n", mumps->id.CNTL(5)));
22189566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(7) (dropping parameter for BLR):       %g\n", mumps->id.CNTL(7)));
2219f6c57405SHong Zhang 
2220a5b23f4aSJose E. Roman         /* information local to each processor */
22219566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis):\n"));
22229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushSynchronized(viewer));
22239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(1)));
22249566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
22259566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization):\n"));
22269566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(2)));
22279566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
22289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization):\n"));
22299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(3)));
22309566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2231f6c57405SHong Zhang 
22329566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization):\n"));
22339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(15)));
22349566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2235f6c57405SHong Zhang 
22369566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization):\n"));
22379566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(16)));
22389566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2239f6c57405SHong Zhang 
22409566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization):\n"));
22419566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(23)));
22429566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2243b34f08ffSHong Zhang 
2244a0e18203SThibaut Appel         if (mumps->ninfo && mumps->ninfo <= 80) {
2245b34f08ffSHong Zhang           PetscInt i;
2246b34f08ffSHong Zhang           for (i = 0; i < mumps->ninfo; i++) {
22479566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "):\n", mumps->info[i]));
22489566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(mumps->info[i])));
22499566063dSJacob Faibussowitsch             PetscCall(PetscViewerFlush(viewer));
2250b34f08ffSHong Zhang           }
2251b34f08ffSHong Zhang         }
22529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopSynchronized(viewer));
22531511cd71SPierre Jolivet       } else PetscCall(PetscViewerASCIIPrintf(viewer, "  Use -%sksp_view ::ascii_info_detail to display information for all processes\n", ((PetscObject)A)->prefix ? ((PetscObject)A)->prefix : ""));
2254f6c57405SHong Zhang 
22551511cd71SPierre Jolivet       if (mumps->myid == 0) { /* information from the host */
22569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(1) (global estimated flops for the elimination after analysis): %g\n", mumps->id.RINFOG(1)));
22579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(2) (global estimated flops for the assembly after factorization): %g\n", mumps->id.RINFOG(2)));
22589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(3) (global estimated flops for the elimination after factorization): %g\n", mumps->id.RINFOG(3)));
22599566063dSJacob 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)));
2260f6c57405SHong Zhang 
22619566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(3)));
22629566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(4)));
22639566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(5) (estimated maximum front size in the complete tree): %d\n", mumps->id.INFOG(5)));
22649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(6) (number of nodes in the complete tree): %d\n", mumps->id.INFOG(6)));
22659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(7) (ordering option effectively used after analysis): %d\n", mumps->id.INFOG(7)));
22669566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n", mumps->id.INFOG(8)));
22679566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n", mumps->id.INFOG(9)));
22689566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(10) (total integer space store the matrix factors after factorization): %d\n", mumps->id.INFOG(10)));
22699566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(11) (order of largest frontal matrix after factorization): %d\n", mumps->id.INFOG(11)));
22709566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(12) (number of off-diagonal pivots): %d\n", mumps->id.INFOG(12)));
22719566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(13) (number of delayed pivots after factorization): %d\n", mumps->id.INFOG(13)));
22729566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(14) (number of memory compress after factorization): %d\n", mumps->id.INFOG(14)));
22739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(15) (number of steps of iterative refinement after solution): %d\n", mumps->id.INFOG(15)));
22749566063dSJacob 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)));
22759566063dSJacob 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)));
22769566063dSJacob 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)));
22779566063dSJacob 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)));
22789566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(20) (estimated number of entries in the factors): %d\n", mumps->id.INFOG(20)));
22799566063dSJacob 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)));
22809566063dSJacob 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)));
22819566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n", mumps->id.INFOG(23)));
22829566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n", mumps->id.INFOG(24)));
22839566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n", mumps->id.INFOG(25)));
22849566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(28) (after factorization: number of null pivots encountered): %d\n", mumps->id.INFOG(28)));
22859566063dSJacob 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)));
22869566063dSJacob 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)));
22879566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(32) (after analysis: type of analysis done): %d\n", mumps->id.INFOG(32)));
22889566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(33) (value used for ICNTL(8)): %d\n", mumps->id.INFOG(33)));
22899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(34) (exponent of the determinant if determinant is requested): %d\n", mumps->id.INFOG(34)));
22909566063dSJacob 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)));
22919566063dSJacob 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)));
22929566063dSJacob 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)));
22939566063dSJacob 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)));
22949566063dSJacob 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)));
2295f6c57405SHong Zhang       }
2296f6c57405SHong Zhang     }
2297cb828f0fSHong Zhang   }
22983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2299f6c57405SHong Zhang }
2300f6c57405SHong Zhang 
2301d71ae5a4SJacob Faibussowitsch PetscErrorCode MatGetInfo_MUMPS(Mat A, MatInfoType flag, MatInfo *info)
2302d71ae5a4SJacob Faibussowitsch {
2303e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
230435bd34faSBarry Smith 
230535bd34faSBarry Smith   PetscFunctionBegin;
230635bd34faSBarry Smith   info->block_size        = 1.0;
2307cb828f0fSHong Zhang   info->nz_allocated      = mumps->id.INFOG(20);
2308cb828f0fSHong Zhang   info->nz_used           = mumps->id.INFOG(20);
230935bd34faSBarry Smith   info->nz_unneeded       = 0.0;
231035bd34faSBarry Smith   info->assemblies        = 0.0;
231135bd34faSBarry Smith   info->mallocs           = 0.0;
231235bd34faSBarry Smith   info->memory            = 0.0;
231335bd34faSBarry Smith   info->fill_ratio_given  = 0;
231435bd34faSBarry Smith   info->fill_ratio_needed = 0;
231535bd34faSBarry Smith   info->factor_mallocs    = 0;
23163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
231735bd34faSBarry Smith }
231835bd34faSBarry Smith 
2319d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
2320d71ae5a4SJacob Faibussowitsch {
2321e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)F->data;
2322a3d589ffSStefano Zampini   const PetscScalar *arr;
23238e7ba810SStefano Zampini   const PetscInt    *idxs;
23248e7ba810SStefano Zampini   PetscInt           size, i;
23256444a565SStefano Zampini 
23266444a565SStefano Zampini   PetscFunctionBegin;
23279566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &size));
2328b3cb21ddSStefano Zampini   /* Schur complement matrix */
23299566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
23309566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, size, size, NULL, &F->schur));
23319566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur, &arr));
2332a3d589ffSStefano Zampini   mumps->id.schur      = (MumpsScalar *)arr;
2333a3d589ffSStefano Zampini   mumps->id.size_schur = size;
2334a3d589ffSStefano Zampini   mumps->id.schur_lld  = size;
23359566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur, &arr));
233648a46eb9SPierre Jolivet   if (mumps->sym == 1) PetscCall(MatSetOption(F->schur, MAT_SPD, PETSC_TRUE));
2337b3cb21ddSStefano Zampini 
2338b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
23399566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
23409566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &mumps->id.listvar_schur));
23419566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &idxs));
23429566063dSJacob Faibussowitsch   for (i = 0; i < size; i++) PetscCall(PetscMUMPSIntCast(idxs[i] + 1, &(mumps->id.listvar_schur[i])));
23439566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &idxs));
234459ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2345b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
23463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
23476444a565SStefano Zampini }
234859ac8732SStefano Zampini 
2349d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F, Mat *S)
2350d71ae5a4SJacob Faibussowitsch {
23516444a565SStefano Zampini   Mat          St;
2352e69c285eSBarry Smith   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
23536444a565SStefano Zampini   PetscScalar *array;
23546444a565SStefano Zampini #if defined(PETSC_USE_COMPLEX)
23558ac429a0SStefano Zampini   PetscScalar im = PetscSqrtScalar((PetscScalar)-1.0);
23566444a565SStefano Zampini #endif
23576444a565SStefano Zampini 
23586444a565SStefano Zampini   PetscFunctionBegin;
235908401ef6SPierre Jolivet   PetscCheck(mumps->id.ICNTL(19), PetscObjectComm((PetscObject)F), PETSC_ERR_ORDER, "Schur complement mode not selected! You should call MatFactorSetSchurIS to enable it");
23609566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF, &St));
23619566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St, PETSC_DECIDE, PETSC_DECIDE, mumps->id.size_schur, mumps->id.size_schur));
23629566063dSJacob Faibussowitsch   PetscCall(MatSetType(St, MATDENSE));
23639566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
23649566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St, &array));
236559ac8732SStefano Zampini   if (!mumps->sym) {                /* MUMPS always return a full matrix */
23666444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
23676444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
23686444a565SStefano Zampini       for (i = 0; i < N; i++) {
23696444a565SStefano Zampini         for (j = 0; j < N; j++) {
23706444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
23716444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
23726444a565SStefano Zampini #else
23736444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j].r + im * mumps->id.schur[i * N + j].i;
23746444a565SStefano Zampini #endif
23756444a565SStefano Zampini           array[j * N + i] = val;
23766444a565SStefano Zampini         }
23776444a565SStefano Zampini       }
23786444a565SStefano Zampini     } else { /* stored by columns */
23799566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
23806444a565SStefano Zampini     }
23816444a565SStefano Zampini   } else {                          /* either full or lower-triangular (not packed) */
23826444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
23836444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
23846444a565SStefano Zampini       for (i = 0; i < N; i++) {
23856444a565SStefano Zampini         for (j = i; j < N; j++) {
23866444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
23876444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
23886444a565SStefano Zampini #else
23896444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j].r + im * mumps->id.schur[i * N + j].i;
23906444a565SStefano Zampini #endif
23916444a565SStefano Zampini           array[i * N + j] = val;
23926444a565SStefano Zampini           array[j * N + i] = val;
23936444a565SStefano Zampini         }
23946444a565SStefano Zampini       }
23956444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
23969566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
23976444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular stored by rows */
23986444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
23996444a565SStefano Zampini       for (i = 0; i < N; i++) {
24006444a565SStefano Zampini         for (j = 0; j < i + 1; j++) {
24016444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
24026444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
24036444a565SStefano Zampini #else
24046444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j].r + im * mumps->id.schur[i * N + j].i;
24056444a565SStefano Zampini #endif
24066444a565SStefano Zampini           array[i * N + j] = val;
24076444a565SStefano Zampini           array[j * N + i] = val;
24086444a565SStefano Zampini         }
24096444a565SStefano Zampini       }
24106444a565SStefano Zampini     }
24116444a565SStefano Zampini   }
24129566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St, &array));
24136444a565SStefano Zampini   *S = St;
24143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24156444a565SStefano Zampini }
24166444a565SStefano Zampini 
2417d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt ival)
2418d71ae5a4SJacob Faibussowitsch {
2419e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
24205ccb76cbSHong Zhang 
24215ccb76cbSHong Zhang   PetscFunctionBegin;
2422413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {                                       /* need to cache icntl and ival since PetscMUMPS_c() has never been called */
2423413bcc21SPierre Jolivet     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0; /* number of already cached ICNTL */
24249371c9d4SSatish Balay     for (i = 0; i < nICNTL_pre; ++i)
24259371c9d4SSatish Balay       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) break; /* is this ICNTL already cached? */
2426413bcc21SPierre Jolivet     if (i == nICNTL_pre) {                             /* not already cached */
2427413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscMUMPSInt) * (2 * nICNTL_pre + 3), &mumps->ICNTL_pre));
2428413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscMUMPSInt) * 3, &mumps->ICNTL_pre));
2429413bcc21SPierre Jolivet       mumps->ICNTL_pre[0]++;
2430413bcc21SPierre Jolivet     }
2431413bcc21SPierre Jolivet     mumps->ICNTL_pre[1 + 2 * i] = icntl;
2432413bcc21SPierre Jolivet     PetscCall(PetscMUMPSIntCast(ival, mumps->ICNTL_pre + 2 + 2 * i));
2433413bcc21SPierre Jolivet   } else PetscCall(PetscMUMPSIntCast(ival, &mumps->id.ICNTL(icntl)));
24343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24355ccb76cbSHong Zhang }
24365ccb76cbSHong Zhang 
2437d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt *ival)
2438d71ae5a4SJacob Faibussowitsch {
2439e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2440bc6112feSHong Zhang 
2441bc6112feSHong Zhang   PetscFunctionBegin;
2442*36df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
2443*36df9881Sjeremy theler     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
2444*36df9881Sjeremy theler     *ival = 0;
2445*36df9881Sjeremy theler     for (i = 0; i < nICNTL_pre; ++i) {
2446*36df9881Sjeremy theler       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) *ival = mumps->ICNTL_pre[2 + 2 * i];
2447*36df9881Sjeremy theler     }
2448*36df9881Sjeremy theler   } else *ival = mumps->id.ICNTL(icntl);
24493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2450bc6112feSHong Zhang }
2451bc6112feSHong Zhang 
24525ccb76cbSHong Zhang /*@
24535ccb76cbSHong Zhang   MatMumpsSetIcntl - Set MUMPS parameter ICNTL()
24545ccb76cbSHong Zhang 
2455c3339decSBarry Smith    Logically Collective
24565ccb76cbSHong Zhang 
24575ccb76cbSHong Zhang    Input Parameters:
245811a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
24595ccb76cbSHong Zhang .  icntl - index of MUMPS parameter array ICNTL()
24605ccb76cbSHong Zhang -  ival - value of MUMPS ICNTL(icntl)
24615ccb76cbSHong Zhang 
24623c7db156SBarry Smith   Options Database Key:
2463147403d9SBarry Smith .   -mat_mumps_icntl_<icntl> <ival> - change the option numbered icntl to ival
24645ccb76cbSHong Zhang 
24655ccb76cbSHong Zhang    Level: beginner
24665ccb76cbSHong Zhang 
246796a0c994SBarry Smith    References:
2468606c0280SSatish Balay .  * - MUMPS Users' Guide
24695ccb76cbSHong Zhang 
24702ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
24715ccb76cbSHong Zhang @*/
2472d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl(Mat F, PetscInt icntl, PetscInt ival)
2473d71ae5a4SJacob Faibussowitsch {
24745ccb76cbSHong Zhang   PetscFunctionBegin;
24752989dfd4SHong Zhang   PetscValidType(F, 1);
247628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
24775ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
24785ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, ival, 3);
2479413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 38, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2480cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetIcntl_C", (Mat, PetscInt, PetscInt), (F, icntl, ival));
24813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24825ccb76cbSHong Zhang }
24835ccb76cbSHong Zhang 
2484a21f80fcSHong Zhang /*@
2485a21f80fcSHong Zhang   MatMumpsGetIcntl - Get MUMPS parameter ICNTL()
2486a21f80fcSHong Zhang 
2487c3339decSBarry Smith    Logically Collective
2488a21f80fcSHong Zhang 
2489a21f80fcSHong Zhang    Input Parameters:
249011a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2491a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array ICNTL()
2492a21f80fcSHong Zhang 
2493a21f80fcSHong Zhang   Output Parameter:
2494a21f80fcSHong Zhang .  ival - value of MUMPS ICNTL(icntl)
2495a21f80fcSHong Zhang 
2496a21f80fcSHong Zhang    Level: beginner
2497a21f80fcSHong Zhang 
249896a0c994SBarry Smith    References:
2499606c0280SSatish Balay .  * - MUMPS Users' Guide
2500a21f80fcSHong Zhang 
25012ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2502a21f80fcSHong Zhang @*/
2503d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl(Mat F, PetscInt icntl, PetscInt *ival)
2504d71ae5a4SJacob Faibussowitsch {
2505bc6112feSHong Zhang   PetscFunctionBegin;
25062989dfd4SHong Zhang   PetscValidType(F, 1);
250728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2508bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2509bc6112feSHong Zhang   PetscValidIntPointer(ival, 3);
2510413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 38, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2511cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetIcntl_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
25123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2513bc6112feSHong Zhang }
2514bc6112feSHong Zhang 
2515d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal val)
2516d71ae5a4SJacob Faibussowitsch {
2517e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
25188928b65cSHong Zhang 
25198928b65cSHong Zhang   PetscFunctionBegin;
2520413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {
2521413bcc21SPierre Jolivet     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
25229371c9d4SSatish Balay     for (i = 0; i < nCNTL_pre; ++i)
25239371c9d4SSatish Balay       if (mumps->CNTL_pre[1 + 2 * i] == icntl) break;
2524413bcc21SPierre Jolivet     if (i == nCNTL_pre) {
2525413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscReal) * (2 * nCNTL_pre + 3), &mumps->CNTL_pre));
2526413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscReal) * 3, &mumps->CNTL_pre));
2527413bcc21SPierre Jolivet       mumps->CNTL_pre[0]++;
2528413bcc21SPierre Jolivet     }
2529413bcc21SPierre Jolivet     mumps->CNTL_pre[1 + 2 * i] = icntl;
2530413bcc21SPierre Jolivet     mumps->CNTL_pre[2 + 2 * i] = val;
2531413bcc21SPierre Jolivet   } else mumps->id.CNTL(icntl) = val;
25323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25338928b65cSHong Zhang }
25348928b65cSHong Zhang 
2535d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal *val)
2536d71ae5a4SJacob Faibussowitsch {
2537e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2538bc6112feSHong Zhang 
2539bc6112feSHong Zhang   PetscFunctionBegin;
2540*36df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
2541*36df9881Sjeremy theler     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
2542*36df9881Sjeremy theler     *val = 0.0;
2543*36df9881Sjeremy theler     for (i = 0; i < nCNTL_pre; ++i) {
2544*36df9881Sjeremy theler       if (mumps->CNTL_pre[1 + 2 * i] == icntl) *val = mumps->CNTL_pre[2 + 2 * i];
2545*36df9881Sjeremy theler     }
2546*36df9881Sjeremy theler   } else *val = mumps->id.CNTL(icntl);
25473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2548bc6112feSHong Zhang }
2549bc6112feSHong Zhang 
25508928b65cSHong Zhang /*@
25518928b65cSHong Zhang   MatMumpsSetCntl - Set MUMPS parameter CNTL()
25528928b65cSHong Zhang 
2553c3339decSBarry Smith    Logically Collective
25548928b65cSHong Zhang 
25558928b65cSHong Zhang    Input Parameters:
255611a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
25578928b65cSHong Zhang .  icntl - index of MUMPS parameter array CNTL()
25588928b65cSHong Zhang -  val - value of MUMPS CNTL(icntl)
25598928b65cSHong Zhang 
25603c7db156SBarry Smith   Options Database Key:
2561147403d9SBarry Smith .   -mat_mumps_cntl_<icntl> <val>  - change the option numbered icntl to ival
25628928b65cSHong Zhang 
25638928b65cSHong Zhang    Level: beginner
25648928b65cSHong Zhang 
256596a0c994SBarry Smith    References:
2566606c0280SSatish Balay .  * - MUMPS Users' Guide
25678928b65cSHong Zhang 
25682ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
25698928b65cSHong Zhang @*/
2570d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl(Mat F, PetscInt icntl, PetscReal val)
2571d71ae5a4SJacob Faibussowitsch {
25728928b65cSHong Zhang   PetscFunctionBegin;
25732989dfd4SHong Zhang   PetscValidType(F, 1);
257428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
25758928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2576bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F, val, 3);
2577413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2578cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetCntl_C", (Mat, PetscInt, PetscReal), (F, icntl, val));
25793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25808928b65cSHong Zhang }
25818928b65cSHong Zhang 
2582a21f80fcSHong Zhang /*@
2583a21f80fcSHong Zhang   MatMumpsGetCntl - Get MUMPS parameter CNTL()
2584a21f80fcSHong Zhang 
2585c3339decSBarry Smith    Logically Collective
2586a21f80fcSHong Zhang 
2587a21f80fcSHong Zhang    Input Parameters:
258811a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2589a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array CNTL()
2590a21f80fcSHong Zhang 
2591a21f80fcSHong Zhang   Output Parameter:
2592a21f80fcSHong Zhang .  val - value of MUMPS CNTL(icntl)
2593a21f80fcSHong Zhang 
2594a21f80fcSHong Zhang    Level: beginner
2595a21f80fcSHong Zhang 
259696a0c994SBarry Smith    References:
2597606c0280SSatish Balay .  * - MUMPS Users' Guide
2598a21f80fcSHong Zhang 
25992ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2600a21f80fcSHong Zhang @*/
2601d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl(Mat F, PetscInt icntl, PetscReal *val)
2602d71ae5a4SJacob Faibussowitsch {
2603bc6112feSHong Zhang   PetscFunctionBegin;
26042989dfd4SHong Zhang   PetscValidType(F, 1);
260528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2606bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2607bc6112feSHong Zhang   PetscValidRealPointer(val, 3);
2608413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2609cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetCntl_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
26103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2611bc6112feSHong Zhang }
2612bc6112feSHong Zhang 
2613d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F, PetscInt icntl, PetscInt *info)
2614d71ae5a4SJacob Faibussowitsch {
2615e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2616bc6112feSHong Zhang 
2617bc6112feSHong Zhang   PetscFunctionBegin;
2618bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
26193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2620bc6112feSHong Zhang }
2621bc6112feSHong Zhang 
2622d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F, PetscInt icntl, PetscInt *infog)
2623d71ae5a4SJacob Faibussowitsch {
2624e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2625bc6112feSHong Zhang 
2626bc6112feSHong Zhang   PetscFunctionBegin;
2627bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
26283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2629bc6112feSHong Zhang }
2630bc6112feSHong Zhang 
2631d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfo)
2632d71ae5a4SJacob Faibussowitsch {
2633e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2634bc6112feSHong Zhang 
2635bc6112feSHong Zhang   PetscFunctionBegin;
2636bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
26373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2638bc6112feSHong Zhang }
2639bc6112feSHong Zhang 
2640d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfog)
2641d71ae5a4SJacob Faibussowitsch {
2642e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2643bc6112feSHong Zhang 
2644bc6112feSHong Zhang   PetscFunctionBegin;
2645bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
26463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2647bc6112feSHong Zhang }
2648bc6112feSHong Zhang 
26495c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots_MUMPS(Mat F, PetscInt *size, PetscInt **array)
26505c0bae8cSAshish Patel {
26515c0bae8cSAshish Patel   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
26525c0bae8cSAshish Patel 
26535c0bae8cSAshish Patel   PetscFunctionBegin;
26545c0bae8cSAshish Patel   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");
26555c0bae8cSAshish Patel   *size  = 0;
26565c0bae8cSAshish Patel   *array = NULL;
26575c0bae8cSAshish Patel   if (!mumps->myid) {
26585c0bae8cSAshish Patel     *size = mumps->id.INFOG(28);
26595c0bae8cSAshish Patel     PetscCall(PetscMalloc1(*size, array));
26605c0bae8cSAshish Patel     for (int i = 0; i < *size; i++) (*array)[i] = mumps->id.pivnul_list[i] - 1;
26615c0bae8cSAshish Patel   }
26625c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
26635c0bae8cSAshish Patel }
26645c0bae8cSAshish Patel 
2665d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F, Mat spRHS)
2666d71ae5a4SJacob Faibussowitsch {
26670e6b8875SHong Zhang   Mat          Bt = NULL, Btseq = NULL;
26680e6b8875SHong Zhang   PetscBool    flg;
2669bb599dfdSHong Zhang   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
2670bb599dfdSHong Zhang   PetscScalar *aa;
2671f410b75aSHong Zhang   PetscInt     spnr, *ia, *ja, M, nrhs;
2672bb599dfdSHong Zhang 
2673bb599dfdSHong Zhang   PetscFunctionBegin;
2674064a246eSJacob Faibussowitsch   PetscValidPointer(spRHS, 2);
2675013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS, MATTRANSPOSEVIRTUAL, &flg));
26760e6b8875SHong Zhang   if (flg) {
26779566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(spRHS, &Bt));
2678013e2dc7SBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)spRHS), PETSC_ERR_ARG_WRONG, "Matrix spRHS must be type MATTRANSPOSEVIRTUAL matrix");
2679bb599dfdSHong Zhang 
26809566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F, 30, 1));
2681bb599dfdSHong Zhang 
26822d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
26830e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ *)Bt->data;
26840e6b8875SHong Zhang     Btseq         = b->A;
26850e6b8875SHong Zhang   } else {
26860e6b8875SHong Zhang     Btseq = Bt;
26870e6b8875SHong Zhang   }
26880e6b8875SHong Zhang 
26899566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS, &M, &nrhs));
2690f410b75aSHong Zhang   mumps->id.nrhs = nrhs;
2691f410b75aSHong Zhang   mumps->id.lrhs = M;
2692f410b75aSHong Zhang   mumps->id.rhs  = NULL;
2693f410b75aSHong Zhang 
2694e3f2db6aSHong Zhang   if (!mumps->myid) {
26959566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq, &aa));
26969566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
269728b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
26989566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
2699bb599dfdSHong Zhang     mumps->id.rhs_sparse = (MumpsScalar *)aa;
2700e3f2db6aSHong Zhang   } else {
2701e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
2702e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
2703e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
2704e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
2705e3f2db6aSHong Zhang   }
2706bb599dfdSHong Zhang   mumps->id.ICNTL(20) = 1; /* rhs is sparse */
2707e3f2db6aSHong Zhang   mumps->id.ICNTL(21) = 0; /* solution is in assembled centralized format */
2708bb599dfdSHong Zhang 
2709bb599dfdSHong Zhang   /* solve phase */
2710bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
27113ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
2712049d1499SBarry Smith   PetscCheck(mumps->id.INFOG(1) >= 0, 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));
271314267174SHong Zhang 
2714e3f2db6aSHong Zhang   if (!mumps->myid) {
27159566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq, &aa));
27169566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
271728b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
2718e3f2db6aSHong Zhang   }
27193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2720bb599dfdSHong Zhang }
2721bb599dfdSHong Zhang 
2722bb599dfdSHong Zhang /*@
27232ef1f0ffSBarry Smith   MatMumpsGetInverse - Get user-specified set of entries in inverse of `A`
2724bb599dfdSHong Zhang 
2725c3339decSBarry Smith    Logically Collective
2726bb599dfdSHong Zhang 
272720f4b53cSBarry Smith    Input Parameter:
272820f4b53cSBarry Smith .  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2729bb599dfdSHong Zhang 
2730bb599dfdSHong Zhang   Output Parameter:
273120f4b53cSBarry Smith . spRHS - sequential sparse matrix in `MATTRANSPOSEVIRTUAL` format with requested entries of inverse of `A`
2732bb599dfdSHong Zhang 
2733bb599dfdSHong Zhang    Level: beginner
2734bb599dfdSHong Zhang 
2735bb599dfdSHong Zhang    References:
2736606c0280SSatish Balay .  * - MUMPS Users' Guide
2737bb599dfdSHong Zhang 
27382ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`
2739bb599dfdSHong Zhang @*/
2740d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse(Mat F, Mat spRHS)
2741d71ae5a4SJacob Faibussowitsch {
2742bb599dfdSHong Zhang   PetscFunctionBegin;
2743bb599dfdSHong Zhang   PetscValidType(F, 1);
274428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2745cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverse_C", (Mat, Mat), (F, spRHS));
27463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2747bb599dfdSHong Zhang }
2748bb599dfdSHong Zhang 
2749d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F, Mat spRHST)
2750d71ae5a4SJacob Faibussowitsch {
27510e6b8875SHong Zhang   Mat spRHS;
27520e6b8875SHong Zhang 
27530e6b8875SHong Zhang   PetscFunctionBegin;
27549566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST, &spRHS));
27559566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F, spRHS));
27569566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
27573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27580e6b8875SHong Zhang }
27590e6b8875SHong Zhang 
27600e6b8875SHong Zhang /*@
27612ef1f0ffSBarry Smith   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix `A`^T
27620e6b8875SHong Zhang 
2763c3339decSBarry Smith    Logically Collective
27640e6b8875SHong Zhang 
276520f4b53cSBarry Smith    Input Parameter:
276620f4b53cSBarry Smith .  F - the factored matrix of A obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
27670e6b8875SHong Zhang 
27680e6b8875SHong Zhang   Output Parameter:
276920f4b53cSBarry Smith . spRHST - sequential sparse matrix in `MATAIJ` format containing the requested entries of inverse of `A`^T
27700e6b8875SHong Zhang 
27710e6b8875SHong Zhang    Level: beginner
27720e6b8875SHong Zhang 
27730e6b8875SHong Zhang    References:
2774606c0280SSatish Balay .  * - MUMPS Users' Guide
27750e6b8875SHong Zhang 
27762ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
27770e6b8875SHong Zhang @*/
2778d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose(Mat F, Mat spRHST)
2779d71ae5a4SJacob Faibussowitsch {
27800e6b8875SHong Zhang   PetscBool flg;
27810e6b8875SHong Zhang 
27820e6b8875SHong Zhang   PetscFunctionBegin;
27830e6b8875SHong Zhang   PetscValidType(F, 1);
278428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
27859566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
278628b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)spRHST), PETSC_ERR_ARG_WRONG, "Matrix spRHST must be MATAIJ matrix");
27870e6b8875SHong Zhang 
2788cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverseTranspose_C", (Mat, Mat), (F, spRHST));
27893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27900e6b8875SHong Zhang }
27910e6b8875SHong Zhang 
2792a21f80fcSHong Zhang /*@
2793a21f80fcSHong Zhang   MatMumpsGetInfo - Get MUMPS parameter INFO()
2794a21f80fcSHong Zhang 
2795c3339decSBarry Smith    Logically Collective
2796a21f80fcSHong Zhang 
2797a21f80fcSHong Zhang    Input Parameters:
279811a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2799a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array INFO()
2800a21f80fcSHong Zhang 
2801a21f80fcSHong Zhang   Output Parameter:
2802a21f80fcSHong Zhang .  ival - value of MUMPS INFO(icntl)
2803a21f80fcSHong Zhang 
2804a21f80fcSHong Zhang    Level: beginner
2805a21f80fcSHong Zhang 
280696a0c994SBarry Smith    References:
2807606c0280SSatish Balay .  * - MUMPS Users' Guide
2808a21f80fcSHong Zhang 
28092ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2810a21f80fcSHong Zhang @*/
2811d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo(Mat F, PetscInt icntl, PetscInt *ival)
2812d71ae5a4SJacob Faibussowitsch {
2813bc6112feSHong Zhang   PetscFunctionBegin;
28142989dfd4SHong Zhang   PetscValidType(F, 1);
281528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2816ca810319SHong Zhang   PetscValidIntPointer(ival, 3);
2817cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfo_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
28183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2819bc6112feSHong Zhang }
2820bc6112feSHong Zhang 
2821a21f80fcSHong Zhang /*@
2822a21f80fcSHong Zhang   MatMumpsGetInfog - Get MUMPS parameter INFOG()
2823a21f80fcSHong Zhang 
2824c3339decSBarry Smith    Logically Collective
2825a21f80fcSHong Zhang 
2826a21f80fcSHong Zhang    Input Parameters:
282711a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2828a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array INFOG()
2829a21f80fcSHong Zhang 
2830a21f80fcSHong Zhang   Output Parameter:
2831a21f80fcSHong Zhang .  ival - value of MUMPS INFOG(icntl)
2832a21f80fcSHong Zhang 
2833a21f80fcSHong Zhang    Level: beginner
2834a21f80fcSHong Zhang 
283596a0c994SBarry Smith    References:
2836606c0280SSatish Balay .  * - MUMPS Users' Guide
2837a21f80fcSHong Zhang 
28382ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2839a21f80fcSHong Zhang @*/
2840d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog(Mat F, PetscInt icntl, PetscInt *ival)
2841d71ae5a4SJacob Faibussowitsch {
2842bc6112feSHong Zhang   PetscFunctionBegin;
28432989dfd4SHong Zhang   PetscValidType(F, 1);
284428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2845ca810319SHong Zhang   PetscValidIntPointer(ival, 3);
2846cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfog_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
28473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2848bc6112feSHong Zhang }
2849bc6112feSHong Zhang 
2850a21f80fcSHong Zhang /*@
2851a21f80fcSHong Zhang   MatMumpsGetRinfo - Get MUMPS parameter RINFO()
2852a21f80fcSHong Zhang 
2853c3339decSBarry Smith    Logically Collective
2854a21f80fcSHong Zhang 
2855a21f80fcSHong Zhang    Input Parameters:
285611a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2857a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array RINFO()
2858a21f80fcSHong Zhang 
2859a21f80fcSHong Zhang   Output Parameter:
2860a21f80fcSHong Zhang .  val - value of MUMPS RINFO(icntl)
2861a21f80fcSHong Zhang 
2862a21f80fcSHong Zhang    Level: beginner
2863a21f80fcSHong Zhang 
286496a0c994SBarry Smith    References:
2865606c0280SSatish Balay .  * - MUMPS Users' Guide
2866a21f80fcSHong Zhang 
28672ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
2868a21f80fcSHong Zhang @*/
2869d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo(Mat F, PetscInt icntl, PetscReal *val)
2870d71ae5a4SJacob Faibussowitsch {
2871bc6112feSHong Zhang   PetscFunctionBegin;
28722989dfd4SHong Zhang   PetscValidType(F, 1);
287328b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2874bc6112feSHong Zhang   PetscValidRealPointer(val, 3);
2875cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfo_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
28763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2877bc6112feSHong Zhang }
2878bc6112feSHong Zhang 
2879a21f80fcSHong Zhang /*@
2880a21f80fcSHong Zhang   MatMumpsGetRinfog - Get MUMPS parameter RINFOG()
2881a21f80fcSHong Zhang 
2882c3339decSBarry Smith    Logically Collective
2883a21f80fcSHong Zhang 
2884a21f80fcSHong Zhang    Input Parameters:
288511a5261eSBarry Smith +  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2886a21f80fcSHong Zhang -  icntl - index of MUMPS parameter array RINFOG()
2887a21f80fcSHong Zhang 
2888a21f80fcSHong Zhang   Output Parameter:
2889a21f80fcSHong Zhang .  val - value of MUMPS RINFOG(icntl)
2890a21f80fcSHong Zhang 
2891a21f80fcSHong Zhang    Level: beginner
2892a21f80fcSHong Zhang 
289396a0c994SBarry Smith    References:
2894606c0280SSatish Balay .  * - MUMPS Users' Guide
2895a21f80fcSHong Zhang 
28962ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
2897a21f80fcSHong Zhang @*/
2898d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog(Mat F, PetscInt icntl, PetscReal *val)
2899d71ae5a4SJacob Faibussowitsch {
2900bc6112feSHong Zhang   PetscFunctionBegin;
29012989dfd4SHong Zhang   PetscValidType(F, 1);
290228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2903bc6112feSHong Zhang   PetscValidRealPointer(val, 3);
2904cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfog_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
29053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2906bc6112feSHong Zhang }
2907bc6112feSHong Zhang 
29085c0bae8cSAshish Patel /*@
29095c0bae8cSAshish Patel   MatMumpsGetNullPivots - Get MUMPS parameter PIVNUL_LIST()
29105c0bae8cSAshish Patel 
29115c0bae8cSAshish Patel    Logically Collective
29125c0bae8cSAshish Patel 
29135c0bae8cSAshish Patel    Input Parameter:
29145c0bae8cSAshish Patel .  F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
29155c0bae8cSAshish Patel 
29165c0bae8cSAshish Patel   Output Parameters:
29175c0bae8cSAshish Patel +  size - local size of the array. The size of the array is non-zero only on the host.
29185c0bae8cSAshish Patel -  array - array of rows with null pivot, these rows follow 0-based indexing. The array gets allocated within the function and the user is responsible
29195c0bae8cSAshish Patel            for freeing this array.
29205c0bae8cSAshish Patel 
29215c0bae8cSAshish Patel    Level: beginner
29225c0bae8cSAshish Patel 
29235c0bae8cSAshish Patel    References:
29245c0bae8cSAshish Patel .  * - MUMPS Users' Guide
29255c0bae8cSAshish Patel 
29265c0bae8cSAshish Patel .seealso: [](chapter_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
29275c0bae8cSAshish Patel @*/
29285c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots(Mat F, PetscInt *size, PetscInt **array)
29295c0bae8cSAshish Patel {
29305c0bae8cSAshish Patel   PetscFunctionBegin;
29315c0bae8cSAshish Patel   PetscValidType(F, 1);
29325c0bae8cSAshish Patel   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
29335c0bae8cSAshish Patel   PetscValidIntPointer(size, 3);
29345c0bae8cSAshish Patel   PetscValidPointer(array, 4);
29355c0bae8cSAshish Patel   PetscUseMethod(F, "MatMumpsGetNullPivots_C", (Mat, PetscInt *, PetscInt **), (F, size, array));
29365c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
29375c0bae8cSAshish Patel }
29385c0bae8cSAshish Patel 
293924b6179bSKris Buschelman /*MC
29402692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
294124b6179bSKris Buschelman   distributed and sequential matrices via the external package MUMPS.
294224b6179bSKris Buschelman 
294311a5261eSBarry Smith   Works with `MATAIJ` and `MATSBAIJ` matrices
294424b6179bSKris Buschelman 
2945c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
2946c2b89b5dSBarry Smith 
29472ef1f0ffSBarry Smith   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.
29482ef1f0ffSBarry Smith   See details below.
2949217d3b1eSJunchao Zhang 
29502ef1f0ffSBarry Smith   Use `-pc_type cholesky` or `lu` `-pc_factor_mat_solver_type mumps` to use this direct solver
2951c2b89b5dSBarry Smith 
295224b6179bSKris Buschelman   Options Database Keys:
29534422a9fcSPatrick Sanan +  -mat_mumps_icntl_1 - ICNTL(1): output stream for error messages
29544422a9fcSPatrick Sanan .  -mat_mumps_icntl_2 - ICNTL(2): output stream for diagnostic printing, statistics, and warning
29554422a9fcSPatrick Sanan .  -mat_mumps_icntl_3 -  ICNTL(3): output stream for global information, collected on the host
29564422a9fcSPatrick Sanan .  -mat_mumps_icntl_4 -  ICNTL(4): level of printing (0 to 4)
29574422a9fcSPatrick Sanan .  -mat_mumps_icntl_6 - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
2958b53c1a7fSBarry 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
2959b53c1a7fSBarry Smith                         Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
29604422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
29614422a9fcSPatrick Sanan .  -mat_mumps_icntl_10  - ICNTL(10): max num of refinements
29624422a9fcSPatrick Sanan .  -mat_mumps_icntl_11  - ICNTL(11): statistics related to an error analysis (via -ksp_view)
29634422a9fcSPatrick Sanan .  -mat_mumps_icntl_12  - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
29644422a9fcSPatrick Sanan .  -mat_mumps_icntl_13  - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
29654422a9fcSPatrick Sanan .  -mat_mumps_icntl_14  - ICNTL(14): percentage increase in the estimated working space
296645e3843bSPierre Jolivet .  -mat_mumps_icntl_15  - ICNTL(15): compression of the input matrix resulting from a block format
29674422a9fcSPatrick Sanan .  -mat_mumps_icntl_19  - ICNTL(19): computes the Schur complement
296825aac85cSJunchao Zhang .  -mat_mumps_icntl_20  - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
29694422a9fcSPatrick Sanan .  -mat_mumps_icntl_22  - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
29704422a9fcSPatrick Sanan .  -mat_mumps_icntl_23  - ICNTL(23): max size of the working memory (MB) that can allocate per processor
29714422a9fcSPatrick Sanan .  -mat_mumps_icntl_24  - ICNTL(24): detection of null pivot rows (0 or 1)
29724422a9fcSPatrick Sanan .  -mat_mumps_icntl_25  - ICNTL(25): compute a solution of a deficient matrix and a null space basis
29734422a9fcSPatrick Sanan .  -mat_mumps_icntl_26  - ICNTL(26): drives the solution phase if a Schur complement matrix
29744422a9fcSPatrick 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
29754422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
29764422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
29774422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
29784422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
2979a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
2980a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
2981a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
29824422a9fcSPatrick Sanan .  -mat_mumps_cntl_1  - CNTL(1): relative pivoting threshold
29834422a9fcSPatrick Sanan .  -mat_mumps_cntl_2  -  CNTL(2): stopping criterion of refinement
29844422a9fcSPatrick Sanan .  -mat_mumps_cntl_3 - CNTL(3): absolute pivoting threshold
29854422a9fcSPatrick Sanan .  -mat_mumps_cntl_4 - CNTL(4): value for static pivoting
2986217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5 - CNTL(5): fixation for null pivots
2987a0e18203SThibaut Appel .  -mat_mumps_cntl_7 - CNTL(7): precision of the dropping parameter used during BLR factorization
2988217d3b1eSJunchao 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.
2989217d3b1eSJunchao Zhang                                    Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
299024b6179bSKris Buschelman 
299124b6179bSKris Buschelman   Level: beginner
299224b6179bSKris Buschelman 
299395452b02SPatrick Sanan     Notes:
29942ef1f0ffSBarry Smith     MUMPS Cholesky does not handle (complex) Hermitian matrices (see User's Guide at https://mumps-solver.org/index.php?page=doc) so using it will
29952ef1f0ffSBarry Smith     error if the matrix is Hermitian.
299638548759SBarry Smith 
299726cc229bSBarry 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
299826cc229bSBarry Smith     `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
299926cc229bSBarry Smith 
30002ef1f0ffSBarry 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
30012ef1f0ffSBarry Smith     the failure with
30022ef1f0ffSBarry Smith .vb
30032ef1f0ffSBarry Smith           KSPGetPC(ksp,&pc);
30042ef1f0ffSBarry Smith           PCFactorGetMatrix(pc,&mat);
30052ef1f0ffSBarry Smith           MatMumpsGetInfo(mat,....);
30062ef1f0ffSBarry Smith           MatMumpsGetInfog(mat,....); etc.
30072ef1f0ffSBarry Smith .ve
30082ef1f0ffSBarry Smith     Or run with `-ksp_error_if_not_converged` and the program will be stopped and the information printed in the error message.
30099fc87aa7SBarry Smith 
3010a5399872SJunchao Zhang     MUMPS provides 64-bit integer support in two build modes:
3011a5399872SJunchao Zhang       full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
3012a5399872SJunchao 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).
30138fcaa860SBarry Smith 
3014a5399872SJunchao 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,
3015a5399872SJunchao 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
3016a5399872SJunchao 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
3017a5399872SJunchao Zhang       integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
3018a5399872SJunchao Zhang 
3019a5399872SJunchao 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.
3020a5399872SJunchao Zhang 
3021a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
30222ef1f0ffSBarry Smith .vb
30232ef1f0ffSBarry Smith      Set OMP_NUM_THREADS and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
30242ef1f0ffSBarry Smith      threads per rank, then you may use "export OMP_NUM_THREADS=16 && mpirun -n 4 ./test".
30252ef1f0ffSBarry Smith .ve
30268fcaa860SBarry Smith 
30272ef1f0ffSBarry Smith .vb
30282ef1f0ffSBarry Smith      -mat_mumps_use_omp_threads [m] and run your code with as many MPI ranks as the number of cores. For example,
30292ef1f0ffSBarry 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"
30302ef1f0ffSBarry Smith .ve
30318fcaa860SBarry Smith 
30328fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
30332ef1f0ffSBarry Smith    (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`
30342ef1f0ffSBarry Smith    (or `--with-hwloc`), and have an MPI that supports MPI-3.0's process shared memory (which is usually available). Since MUMPS calls BLAS
30358fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
30368fcaa860SBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if --with-openmp is provided).
3037217d3b1eSJunchao Zhang 
30388fcaa860SBarry 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
3039217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
3040217d3b1eSJunchao 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
3041217d3b1eSJunchao 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
3042217d3b1eSJunchao 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.
3043217d3b1eSJunchao 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,
3044217d3b1eSJunchao 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
3045217d3b1eSJunchao 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
3046217d3b1eSJunchao 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
3047217d3b1eSJunchao 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.
30488fcaa860SBarry 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
3049217d3b1eSJunchao Zhang    examine the mapping result.
3050217d3b1eSJunchao Zhang 
305111a5261eSBarry Smith    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,
305211a5261eSBarry Smith    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
305311a5261eSBarry Smith    calls `omp_set_num_threads`(m) internally before calling MUMPS.
3054217d3b1eSJunchao Zhang 
3055217d3b1eSJunchao Zhang    References:
3056606c0280SSatish Balay +  * - Heroux, Michael A., R. Brightwell, and Michael M. Wolf. "Bi-modal MPI and MPI+ threads computing on scalable multicore systems." IJHPCA (Submitted) (2011).
3057606c0280SSatish 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.
3058217d3b1eSJunchao Zhang 
30592ef1f0ffSBarry Smith .seealso: [](chapter_matrices), `Mat`, `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `KSPGetPC()`, `PCFactorGetMatrix()`
306024b6179bSKris Buschelman M*/
306124b6179bSKris Buschelman 
3062d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatFactorGetSolverType_mumps(Mat A, MatSolverType *type)
3063d71ae5a4SJacob Faibussowitsch {
306435bd34faSBarry Smith   PetscFunctionBegin;
30652692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
30663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
306735bd34faSBarry Smith }
306835bd34faSBarry Smith 
3069bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
3070d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_aij_mumps(Mat A, MatFactorType ftype, Mat *F)
3071d71ae5a4SJacob Faibussowitsch {
30722877fffaSHong Zhang   Mat         B;
30732877fffaSHong Zhang   Mat_MUMPS  *mumps;
3074ace3abfcSBarry Smith   PetscBool   isSeqAIJ;
30752c7c0729SBarry Smith   PetscMPIInt size;
30762877fffaSHong Zhang 
30772877fffaSHong Zhang   PetscFunctionBegin;
3078eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
3079b94d7dedSBarry Smith   PetscCheck(A->hermitian != PETSC_BOOL3_TRUE || A->symmetric == PETSC_BOOL3_TRUE || ftype != MAT_FACTOR_CHOLESKY, PETSC_COMM_SELF, PETSC_ERR_SUP, "Hermitian CHOLESKY Factor is not supported");
3080eb1ec7c1SStefano Zampini #endif
30812877fffaSHong Zhang   /* Create the factorization matrix */
30829566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATSEQAIJ, &isSeqAIJ));
30839566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
30849566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
30859566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
30869566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
30872877fffaSHong Zhang 
30884dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
30892205254eSKarl Rupp 
30902877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
309135bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
30922205254eSKarl Rupp 
30939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
30949566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
30959566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
30969566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
30979566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
30989566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
30999566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
31009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
31019566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
31029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
31039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
31045c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
31059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
31069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
31076444a565SStefano Zampini 
3108450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3109450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3110d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3111bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3112bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
31139566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3114746480a1SHong Zhang     mumps->sym = 0;
3115dcd589f8SShri Abhyankar   } else {
311667877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3117450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3118bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3119bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
31209566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
312159ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
312259ac8732SStefano Zampini     mumps->sym = 2;
312359ac8732SStefano Zampini #else
3124b94d7dedSBarry Smith     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
31256fdc2a6dSBarry Smith     else mumps->sym = 2;
312659ac8732SStefano Zampini #endif
3127450b117fSShri Abhyankar   }
31282877fffaSHong Zhang 
312900c67f3bSHong Zhang   /* set solvertype */
31309566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
31319566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
31329566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
31332c7c0729SBarry Smith   if (size == 1) {
31344ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3135f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
31362c7c0729SBarry Smith   }
31372877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3138e69c285eSBarry Smith   B->data         = (void *)mumps;
31392205254eSKarl Rupp 
31402877fffaSHong Zhang   *F               = B;
3141413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3142413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3143413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3144d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
31453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
31462877fffaSHong Zhang }
31472877fffaSHong Zhang 
3148bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3149d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A, MatFactorType ftype, Mat *F)
3150d71ae5a4SJacob Faibussowitsch {
31512877fffaSHong Zhang   Mat         B;
31522877fffaSHong Zhang   Mat_MUMPS  *mumps;
3153ace3abfcSBarry Smith   PetscBool   isSeqSBAIJ;
31542c7c0729SBarry Smith   PetscMPIInt size;
31552877fffaSHong Zhang 
31562877fffaSHong Zhang   PetscFunctionBegin;
3157eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
3158b94d7dedSBarry Smith   PetscCheck(A->hermitian != PETSC_BOOL3_TRUE || A->symmetric == PETSC_BOOL3_TRUE, PETSC_COMM_SELF, PETSC_ERR_SUP, "Hermitian CHOLESKY Factor is not supported");
3159eb1ec7c1SStefano Zampini #endif
31609566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
31619566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
31629566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
31639566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3164e69c285eSBarry Smith 
31654dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
31669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSBAIJ, &isSeqSBAIJ));
3167bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
316816ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3169dcd589f8SShri Abhyankar   } else {
3170bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3171bccb9932SShri Abhyankar   }
3172bccb9932SShri Abhyankar 
317367877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3174bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3175722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
31762205254eSKarl Rupp 
31779566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
31789566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
31799566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
31809566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
31819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
31829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
31839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
31849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
31859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
31869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
31879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
31885c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
31899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
31909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
31912205254eSKarl Rupp 
3192f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
319359ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
319459ac8732SStefano Zampini   mumps->sym = 2;
319559ac8732SStefano Zampini #else
3196b94d7dedSBarry Smith   if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
31976fdc2a6dSBarry Smith   else mumps->sym = 2;
319859ac8732SStefano Zampini #endif
3199a214ac2aSShri Abhyankar 
320000c67f3bSHong Zhang   /* set solvertype */
32019566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
32029566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
32039566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
32042c7c0729SBarry Smith   if (size == 1) {
32054ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3206f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
32072c7c0729SBarry Smith   }
32089566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3209f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3210e69c285eSBarry Smith   B->data         = (void *)mumps;
32112205254eSKarl Rupp 
32122877fffaSHong Zhang   *F               = B;
3213413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3214413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3215413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3216d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
32173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32182877fffaSHong Zhang }
321997969023SHong Zhang 
3220d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_baij_mumps(Mat A, MatFactorType ftype, Mat *F)
3221d71ae5a4SJacob Faibussowitsch {
322267877ebaSShri Abhyankar   Mat         B;
322367877ebaSShri Abhyankar   Mat_MUMPS  *mumps;
3224ace3abfcSBarry Smith   PetscBool   isSeqBAIJ;
32252c7c0729SBarry Smith   PetscMPIInt size;
322667877ebaSShri Abhyankar 
322767877ebaSShri Abhyankar   PetscFunctionBegin;
322867877ebaSShri Abhyankar   /* Create the factorization matrix */
32299566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQBAIJ, &isSeqBAIJ));
32309566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
32319566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
32329566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
32339566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3234450b117fSShri Abhyankar 
32354dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
3236450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3237450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3238450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3239bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3240bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3241746480a1SHong Zhang     mumps->sym = 0;
32429566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3243546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3244bccb9932SShri Abhyankar 
3245450b117fSShri Abhyankar   B->ops->view    = MatView_MUMPS;
3246722b6324SPierre Jolivet   B->ops->getinfo = MatGetInfo_MUMPS;
32472205254eSKarl Rupp 
32489566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
32499566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
32509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
32519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
32529566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
32539566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
32549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
32559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
32569566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
32579566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
32589566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
32595c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
32609566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
32619566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
3262450b117fSShri Abhyankar 
326300c67f3bSHong Zhang   /* set solvertype */
32649566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
32659566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
32669566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
32672c7c0729SBarry Smith   if (size == 1) {
32684ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3269f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
32702c7c0729SBarry Smith   }
32717ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
32727ee00b23SStefano Zampini   B->data         = (void *)mumps;
32737ee00b23SStefano Zampini 
32747ee00b23SStefano Zampini   *F               = B;
3275413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3276413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3277413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3278d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
32793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32807ee00b23SStefano Zampini }
32817ee00b23SStefano Zampini 
32827ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
3283d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sell_mumps(Mat A, MatFactorType ftype, Mat *F)
3284d71ae5a4SJacob Faibussowitsch {
32857ee00b23SStefano Zampini   Mat         B;
32867ee00b23SStefano Zampini   Mat_MUMPS  *mumps;
32877ee00b23SStefano Zampini   PetscBool   isSeqSELL;
32882c7c0729SBarry Smith   PetscMPIInt size;
32897ee00b23SStefano Zampini 
32907ee00b23SStefano Zampini   PetscFunctionBegin;
32917ee00b23SStefano Zampini   /* Create the factorization matrix */
32929566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSELL, &isSeqSELL));
32939566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
32949566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
32959566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
32969566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
32977ee00b23SStefano Zampini 
32984dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
32997ee00b23SStefano Zampini 
33007ee00b23SStefano Zampini   B->ops->view    = MatView_MUMPS;
33017ee00b23SStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
33027ee00b23SStefano Zampini 
33039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
33049566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
33059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
33069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
33079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
33089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
33099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
33109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
33119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
33129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
33139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
33145c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
33157ee00b23SStefano Zampini 
33167ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
33177ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
33187ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
33197ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
33207ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
33217ee00b23SStefano Zampini     mumps->sym = 0;
33229566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
33237ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
33247ee00b23SStefano Zampini 
33257ee00b23SStefano Zampini   /* set solvertype */
33269566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
33279566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
33289566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
33292c7c0729SBarry Smith   if (size == 1) {
33304ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3331f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
33322c7c0729SBarry Smith   }
3333450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3334e69c285eSBarry Smith   B->data         = (void *)mumps;
33352205254eSKarl Rupp 
3336450b117fSShri Abhyankar   *F               = B;
3337413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3338413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3339413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3340d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
33413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3342450b117fSShri Abhyankar }
334342c9c57cSBarry Smith 
3344d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
3345d71ae5a4SJacob Faibussowitsch {
334642c9c57cSBarry Smith   PetscFunctionBegin;
33479566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
33489566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
33499566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
33509566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
33519566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPISBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
33529566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
33539566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
33549566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
33559566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
33569566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
33579566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSELL, MAT_FACTOR_LU, MatGetFactor_sell_mumps));
33583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
335942c9c57cSBarry Smith }
3360