xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision 41caa250f4b28587d12e9a5db2cd470c02b6e791)
1397b6df1SKris Buschelman /*
2c2b5dc30SHong Zhang     Provides an interface to the MUMPS sparse solver
3397b6df1SKris Buschelman */
467602552SJunchao Zhang #include <petscpkg_version.h>
59d0448ceSStefano Zampini #include <petscsf.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 
109261f6e4SBarry Smith #define MUMPS_MANUALS "(see users manual https://mumps-solver.org/index.php?page=doc \"Error and warning diagnostics\")"
119261f6e4SBarry Smith 
12397b6df1SKris Buschelman EXTERN_C_BEGIN
13397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
142907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
152907cef9SHong Zhang     #include <cmumps_c.h>
162907cef9SHong Zhang   #else
17c6db04a5SJed Brown     #include <zmumps_c.h>
182907cef9SHong Zhang   #endif
192907cef9SHong Zhang #else
202907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
212907cef9SHong Zhang     #include <smumps_c.h>
22397b6df1SKris Buschelman   #else
23c6db04a5SJed Brown     #include <dmumps_c.h>
24397b6df1SKris Buschelman   #endif
252907cef9SHong Zhang #endif
26397b6df1SKris Buschelman EXTERN_C_END
27397b6df1SKris Buschelman #define JOB_INIT         -1
28413bcc21SPierre Jolivet #define JOB_NULL         0
293d472b54SHong Zhang #define JOB_FACTSYMBOLIC 1
303d472b54SHong Zhang #define JOB_FACTNUMERIC  2
313d472b54SHong Zhang #define JOB_SOLVE        3
32397b6df1SKris Buschelman #define JOB_END          -2
333d472b54SHong Zhang 
342907cef9SHong Zhang /* calls to MUMPS */
352907cef9SHong Zhang #if defined(PETSC_USE_COMPLEX)
362907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
373ab56b82SJunchao Zhang     #define MUMPS_c cmumps_c
382907cef9SHong Zhang   #else
393ab56b82SJunchao Zhang     #define MUMPS_c zmumps_c
402907cef9SHong Zhang   #endif
412907cef9SHong Zhang #else
422907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
433ab56b82SJunchao Zhang     #define MUMPS_c smumps_c
442907cef9SHong Zhang   #else
453ab56b82SJunchao Zhang     #define MUMPS_c dmumps_c
462907cef9SHong Zhang   #endif
472907cef9SHong Zhang #endif
482907cef9SHong Zhang 
49a6053eceSJunchao Zhang /* MUMPS uses MUMPS_INT for nonzero indices such as irn/jcn, irn_loc/jcn_loc and uses int64_t for
50a6053eceSJunchao Zhang    number of nonzeros such as nnz, nnz_loc. We typedef MUMPS_INT to PetscMUMPSInt to follow the
51a6053eceSJunchao Zhang    naming convention in PetscMPIInt, PetscBLASInt etc.
52a6053eceSJunchao Zhang */
53a6053eceSJunchao Zhang typedef MUMPS_INT PetscMUMPSInt;
54a6053eceSJunchao Zhang 
5567602552SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5, 3, 0)
5667602552SJunchao 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 */
57a6053eceSJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
5867602552SJunchao Zhang   #endif
59a6053eceSJunchao Zhang #else
6067602552SJunchao Zhang   #if defined(INTSIZE64) /* INTSIZE64 is a command line macro one used to build MUMPS in full 64-bit mode */
6167602552SJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
6267602552SJunchao Zhang   #endif
6367602552SJunchao Zhang #endif
6467602552SJunchao Zhang 
65a6053eceSJunchao Zhang #define MPIU_MUMPSINT       MPI_INT
66a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MAX 2147483647
67a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MIN -2147483648
68a6053eceSJunchao Zhang 
69a6053eceSJunchao Zhang /* Cast PetscInt to PetscMUMPSInt. Usually there is no overflow since <a> is row/col indices or some small integers*/
70d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscMUMPSIntCast(PetscInt a, PetscMUMPSInt *b)
71d71ae5a4SJacob Faibussowitsch {
72a6053eceSJunchao Zhang   PetscFunctionBegin;
73ece88022SPierre Jolivet #if PetscDefined(USE_64BIT_INDICES)
742c71b3e2SJacob Faibussowitsch   PetscAssert(a <= PETSC_MUMPS_INT_MAX && a >= PETSC_MUMPS_INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
75ece88022SPierre Jolivet #endif
76a6053eceSJunchao Zhang   *b = (PetscMUMPSInt)(a);
773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
78a6053eceSJunchao Zhang }
79a6053eceSJunchao Zhang 
80a6053eceSJunchao Zhang /* Put these utility routines here since they are only used in this file */
81d71ae5a4SJacob 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)
82d71ae5a4SJacob Faibussowitsch {
83a6053eceSJunchao Zhang   PetscInt  myval;
84a6053eceSJunchao Zhang   PetscBool myset;
85a6053eceSJunchao Zhang   PetscFunctionBegin;
86a6053eceSJunchao Zhang   /* PetscInt's size should be always >= PetscMUMPSInt's. It is safe to call PetscOptionsInt_Private to read a PetscMUMPSInt */
879566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, (PetscInt)currentvalue, &myval, &myset, lb, ub));
889566063dSJacob Faibussowitsch   if (myset) PetscCall(PetscMUMPSIntCast(myval, value));
89a6053eceSJunchao Zhang   if (set) *set = myset;
903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
91a6053eceSJunchao Zhang }
92a6053eceSJunchao 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)
93a6053eceSJunchao Zhang 
94217d3b1eSJunchao 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 */
953ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
963ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
973ab56b82SJunchao Zhang     do { \
983ab56b82SJunchao Zhang       if (mumps->use_petsc_omp_support) { \
993ab56b82SJunchao Zhang         if (mumps->is_omp_master) { \
1009566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterBegin(mumps->omp_ctrl)); \
10114ffdc6fSStefano Zampini           PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
10214ffdc6fSStefano Zampini           PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
10314ffdc6fSStefano Zampini           PetscCall(PetscFPTrapPop()); \
1049566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterEnd(mumps->omp_ctrl)); \
1053ab56b82SJunchao Zhang         } \
1069566063dSJacob Faibussowitsch         PetscCall(PetscOmpCtrlBarrier(mumps->omp_ctrl)); \
107c3714a1dSJunchao Zhang         /* Global info is same on all processes so we Bcast it within omp_comm. Local info is specific      \
108c3714a1dSJunchao Zhang          to processes, so we only Bcast info[1], an error code and leave others (since they do not have   \
109c3714a1dSJunchao Zhang          an easy translation between omp_comm and petsc_comm). See MUMPS-5.1.2 manual p82.                   \
110c3714a1dSJunchao Zhang          omp_comm is a small shared memory communicator, hence doing multiple Bcast as shown below is OK. \
111c3714a1dSJunchao Zhang       */ \
112338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.infog, PETSC_STATIC_ARRAY_LENGTH(mumps->id.infog), MPIU_MUMPSINT, 0, mumps->omp_comm)); \
113338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.rinfog, PETSC_STATIC_ARRAY_LENGTH(mumps->id.rinfog), MPIU_REAL, 0, mumps->omp_comm)); \
114338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.info, PETSC_STATIC_ARRAY_LENGTH(mumps->id.info), MPIU_MUMPSINT, 0, mumps->omp_comm)); \
115338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.rinfo, PETSC_STATIC_ARRAY_LENGTH(mumps->id.rinfo), MPIU_REAL, 0, mumps->omp_comm)); \
1163ab56b82SJunchao Zhang       } else { \
11714ffdc6fSStefano Zampini         PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
11814ffdc6fSStefano Zampini         PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
11914ffdc6fSStefano Zampini         PetscCall(PetscFPTrapPop()); \
1203ab56b82SJunchao Zhang       } \
1213ab56b82SJunchao Zhang     } while (0)
1223ab56b82SJunchao Zhang #else
1233ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
124d71ae5a4SJacob Faibussowitsch     do { \
12514ffdc6fSStefano Zampini       PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
12614ffdc6fSStefano Zampini       PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
12714ffdc6fSStefano Zampini       PetscCall(PetscFPTrapPop()); \
128d71ae5a4SJacob Faibussowitsch     } while (0)
1293ab56b82SJunchao Zhang #endif
1303ab56b82SJunchao Zhang 
131940cd9d6SSatish Balay /* declare MumpsScalar */
132940cd9d6SSatish Balay #if defined(PETSC_USE_COMPLEX)
133940cd9d6SSatish Balay   #if defined(PETSC_USE_REAL_SINGLE)
134940cd9d6SSatish Balay     #define MumpsScalar mumps_complex
135940cd9d6SSatish Balay   #else
136940cd9d6SSatish Balay     #define MumpsScalar mumps_double_complex
137940cd9d6SSatish Balay   #endif
138940cd9d6SSatish Balay #else
139940cd9d6SSatish Balay   #define MumpsScalar PetscScalar
140940cd9d6SSatish Balay #endif
1413d472b54SHong Zhang 
142397b6df1SKris Buschelman /* macros s.t. indices match MUMPS documentation */
143397b6df1SKris Buschelman #define ICNTL(I)  icntl[(I)-1]
144397b6df1SKris Buschelman #define CNTL(I)   cntl[(I)-1]
145397b6df1SKris Buschelman #define INFOG(I)  infog[(I)-1]
146a7aca84bSHong Zhang #define INFO(I)   info[(I)-1]
147397b6df1SKris Buschelman #define RINFOG(I) rinfog[(I)-1]
148adc1d99fSHong Zhang #define RINFO(I)  rinfo[(I)-1]
149397b6df1SKris Buschelman 
150a6053eceSJunchao Zhang typedef struct Mat_MUMPS Mat_MUMPS;
151a6053eceSJunchao Zhang struct Mat_MUMPS {
152397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
1532907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1542907cef9SHong Zhang   CMUMPS_STRUC_C id;
1552907cef9SHong Zhang   #else
156397b6df1SKris Buschelman   ZMUMPS_STRUC_C id;
1572907cef9SHong Zhang   #endif
1582907cef9SHong Zhang #else
1592907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1602907cef9SHong Zhang   SMUMPS_STRUC_C id;
161397b6df1SKris Buschelman   #else
162397b6df1SKris Buschelman   DMUMPS_STRUC_C id;
163397b6df1SKris Buschelman   #endif
1642907cef9SHong Zhang #endif
1652907cef9SHong Zhang 
166397b6df1SKris Buschelman   MatStructure   matstruc;
1672d4298aeSJunchao Zhang   PetscMPIInt    myid, petsc_size;
168a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;       /* the (i,j,v) triplets passed to mumps. */
169a6053eceSJunchao 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. */
170a6053eceSJunchao Zhang   PetscInt64     nnz;             /* number of nonzeros. The type is called selective 64-bit in mumps */
171a6053eceSJunchao Zhang   PetscMUMPSInt  sym;
1722d4298aeSJunchao Zhang   MPI_Comm       mumps_comm;
173413bcc21SPierre Jolivet   PetscMUMPSInt *ICNTL_pre;
174413bcc21SPierre Jolivet   PetscReal     *CNTL_pre;
175a6053eceSJunchao Zhang   PetscMUMPSInt  ICNTL9_pre;         /* check if ICNTL(9) is changed from previous MatSolve */
176801fbe65SHong Zhang   VecScatter     scat_rhs, scat_sol; /* used by MatSolve() */
17725aac85cSJunchao Zhang   PetscMUMPSInt  ICNTL20;            /* use centralized (0) or distributed (10) dense RHS */
17867602552SJunchao Zhang   PetscMUMPSInt  lrhs_loc, nloc_rhs, *irhs_loc;
17967602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
18067602552SJunchao Zhang   PetscInt    *rhs_nrow, max_nrhs;
18167602552SJunchao Zhang   PetscMPIInt *rhs_recvcounts, *rhs_disps;
18267602552SJunchao Zhang   PetscScalar *rhs_loc, *rhs_recvbuf;
18367602552SJunchao Zhang #endif
184801fbe65SHong Zhang   Vec            b_seq, x_seq;
185a6053eceSJunchao Zhang   PetscInt       ninfo, *info; /* which INFO to display */
186b5fa320bSStefano Zampini   PetscInt       sizeredrhs;
18759ac8732SStefano Zampini   PetscScalar   *schur_sol;
18859ac8732SStefano Zampini   PetscInt       schur_sizesol;
189a6053eceSJunchao Zhang   PetscMUMPSInt *ia_alloc, *ja_alloc; /* work arrays used for the CSR struct for sparse rhs */
190a6053eceSJunchao Zhang   PetscInt64     cur_ilen, cur_jlen;  /* current len of ia_alloc[], ja_alloc[] */
191a6053eceSJunchao Zhang   PetscErrorCode (*ConvertToTriples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1922205254eSKarl Rupp 
1939d0448ceSStefano Zampini   /* Support for MATNEST */
1949d0448ceSStefano Zampini   PetscErrorCode (**nest_convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1959d0448ceSStefano Zampini   PetscInt64  *nest_vals_start;
1969d0448ceSStefano Zampini   PetscScalar *nest_vals;
1979d0448ceSStefano Zampini 
198a6053eceSJunchao Zhang   /* stuff used by petsc/mumps OpenMP support*/
1993ab56b82SJunchao Zhang   PetscBool    use_petsc_omp_support;
200da81f932SPierre Jolivet   PetscOmpCtrl omp_ctrl;             /* an OpenMP controller that blocked processes will release their CPU (MPI_Barrier does not have this guarantee) */
2013ab56b82SJunchao Zhang   MPI_Comm     petsc_comm, omp_comm; /* petsc_comm is petsc matrix's comm */
202a6053eceSJunchao Zhang   PetscInt64  *recvcount;            /* a collection of nnz on omp_master */
203a6053eceSJunchao Zhang   PetscMPIInt  tag, omp_comm_size;
2043ab56b82SJunchao Zhang   PetscBool    is_omp_master; /* is this rank the master of omp_comm */
205a6053eceSJunchao Zhang   MPI_Request *reqs;
206a6053eceSJunchao Zhang };
2073ab56b82SJunchao Zhang 
208a6053eceSJunchao Zhang /* Cast a 1-based CSR represented by (nrow, ia, ja) of type PetscInt to a CSR of type PetscMUMPSInt.
209a6053eceSJunchao Zhang    Here, nrow is number of rows, ia[] is row pointer and ja[] is column indices.
210a6053eceSJunchao Zhang  */
211d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscMUMPSIntCSRCast(Mat_MUMPS *mumps, PetscInt nrow, PetscInt *ia, PetscInt *ja, PetscMUMPSInt **ia_mumps, PetscMUMPSInt **ja_mumps, PetscMUMPSInt *nnz_mumps)
212d71ae5a4SJacob Faibussowitsch {
213a6053eceSJunchao Zhang   PetscInt nnz = ia[nrow] - 1; /* mumps uses 1-based indices. Uses PetscInt instead of PetscInt64 since mumps only uses PetscMUMPSInt for rhs */
214f0c56d0fSKris Buschelman 
215a6053eceSJunchao Zhang   PetscFunctionBegin;
216a6053eceSJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES)
217a6053eceSJunchao Zhang   {
218a6053eceSJunchao Zhang     PetscInt i;
219a6053eceSJunchao Zhang     if (nrow + 1 > mumps->cur_ilen) { /* realloc ia_alloc/ja_alloc to fit ia/ja */
2209566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ia_alloc));
2219566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrow + 1, &mumps->ia_alloc));
222a6053eceSJunchao Zhang       mumps->cur_ilen = nrow + 1;
223a6053eceSJunchao Zhang     }
224a6053eceSJunchao Zhang     if (nnz > mumps->cur_jlen) {
2259566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ja_alloc));
2269566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nnz, &mumps->ja_alloc));
227a6053eceSJunchao Zhang       mumps->cur_jlen = nnz;
228a6053eceSJunchao Zhang     }
2299566063dSJacob Faibussowitsch     for (i = 0; i < nrow + 1; i++) PetscCall(PetscMUMPSIntCast(ia[i], &(mumps->ia_alloc[i])));
2309566063dSJacob Faibussowitsch     for (i = 0; i < nnz; i++) PetscCall(PetscMUMPSIntCast(ja[i], &(mumps->ja_alloc[i])));
231a6053eceSJunchao Zhang     *ia_mumps = mumps->ia_alloc;
232a6053eceSJunchao Zhang     *ja_mumps = mumps->ja_alloc;
233a6053eceSJunchao Zhang   }
234a6053eceSJunchao Zhang #else
235a6053eceSJunchao Zhang   *ia_mumps = ia;
236a6053eceSJunchao Zhang   *ja_mumps = ja;
237a6053eceSJunchao Zhang #endif
2389566063dSJacob Faibussowitsch   PetscCall(PetscMUMPSIntCast(nnz, nnz_mumps));
2393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
240a6053eceSJunchao Zhang }
241b24902e0SBarry Smith 
242d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsResetSchur_Private(Mat_MUMPS *mumps)
243d71ae5a4SJacob Faibussowitsch {
244b5fa320bSStefano Zampini   PetscFunctionBegin;
2459566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
2469566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.redrhs));
2479566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->schur_sol));
24859ac8732SStefano Zampini   mumps->id.size_schur = 0;
249b3cb21ddSStefano Zampini   mumps->id.schur_lld  = 0;
25059ac8732SStefano Zampini   mumps->id.ICNTL(19)  = 0;
2513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25259ac8732SStefano Zampini }
25359ac8732SStefano Zampini 
254b3cb21ddSStefano Zampini /* solve with rhs in mumps->id.redrhs and return in the same location */
255d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSolveSchur_Private(Mat F)
256d71ae5a4SJacob Faibussowitsch {
257b3cb21ddSStefano Zampini   Mat_MUMPS           *mumps = (Mat_MUMPS *)F->data;
258b3cb21ddSStefano Zampini   Mat                  S, B, X;
259b3cb21ddSStefano Zampini   MatFactorSchurStatus schurstatus;
260b3cb21ddSStefano Zampini   PetscInt             sizesol;
26159ac8732SStefano Zampini 
26259ac8732SStefano Zampini   PetscFunctionBegin;
2639566063dSJacob Faibussowitsch   PetscCall(MatFactorFactorizeSchurComplement(F));
2649566063dSJacob Faibussowitsch   PetscCall(MatFactorGetSchurComplement(F, &S, &schurstatus));
2659566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &B));
2669566063dSJacob Faibussowitsch   PetscCall(MatSetType(B, ((PetscObject)S)->type_name));
267a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2689566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(B, S->boundtocpu));
269a3d589ffSStefano Zampini #endif
270b3cb21ddSStefano Zampini   switch (schurstatus) {
271d71ae5a4SJacob Faibussowitsch   case MAT_FACTOR_SCHUR_FACTORED:
272d71ae5a4SJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &X));
273d71ae5a4SJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
274a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2759566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
276a3d589ffSStefano Zampini #endif
277b3cb21ddSStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2789566063dSJacob Faibussowitsch       PetscCall(MatMatSolveTranspose(S, B, X));
27959ac8732SStefano Zampini     } else {
2809566063dSJacob Faibussowitsch       PetscCall(MatMatSolve(S, B, X));
28159ac8732SStefano Zampini     }
282b3cb21ddSStefano Zampini     break;
283b3cb21ddSStefano Zampini   case MAT_FACTOR_SCHUR_INVERTED:
284b3cb21ddSStefano Zampini     sizesol = mumps->id.nrhs * mumps->id.size_schur;
28559ac8732SStefano Zampini     if (!mumps->schur_sol || sizesol > mumps->schur_sizesol) {
2869566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->schur_sol));
2879566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(sizesol, &mumps->schur_sol));
28859ac8732SStefano Zampini       mumps->schur_sizesol = sizesol;
289b5fa320bSStefano Zampini     }
2909566063dSJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, mumps->schur_sol, &X));
2919566063dSJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
292a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2939566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
294a3d589ffSStefano Zampini #endif
2959566063dSJacob Faibussowitsch     PetscCall(MatProductCreateWithMat(S, B, NULL, X));
29659ac8732SStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2979566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AtB));
298b5fa320bSStefano Zampini     } else {
2999566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AB));
300b5fa320bSStefano Zampini     }
3019566063dSJacob Faibussowitsch     PetscCall(MatProductSetFromOptions(X));
3029566063dSJacob Faibussowitsch     PetscCall(MatProductSymbolic(X));
3039566063dSJacob Faibussowitsch     PetscCall(MatProductNumeric(X));
3044417c5e8SHong Zhang 
3059566063dSJacob Faibussowitsch     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
306b3cb21ddSStefano Zampini     break;
307d71ae5a4SJacob Faibussowitsch   default:
308d71ae5a4SJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)F), PETSC_ERR_SUP, "Unhandled MatFactorSchurStatus %d", F->schur_status);
30959ac8732SStefano Zampini   }
3109566063dSJacob Faibussowitsch   PetscCall(MatFactorRestoreSchurComplement(F, &S, schurstatus));
3119566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
3129566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&X));
3133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
314b5fa320bSStefano Zampini }
315b5fa320bSStefano Zampini 
316d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsHandleSchur_Private(Mat F, PetscBool expansion)
317d71ae5a4SJacob Faibussowitsch {
318b3cb21ddSStefano Zampini   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
319b5fa320bSStefano Zampini 
320b5fa320bSStefano Zampini   PetscFunctionBegin;
321b5fa320bSStefano Zampini   if (!mumps->id.ICNTL(19)) { /* do nothing when Schur complement has not been computed */
3223ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
323b5fa320bSStefano Zampini   }
324b8f61ee1SStefano Zampini   if (!expansion) { /* prepare for the condensation step */
325b5fa320bSStefano Zampini     PetscInt sizeredrhs = mumps->id.nrhs * mumps->id.size_schur;
326b5fa320bSStefano Zampini     /* allocate MUMPS internal array to store reduced right-hand sides */
327b5fa320bSStefano Zampini     if (!mumps->id.redrhs || sizeredrhs > mumps->sizeredrhs) {
3289566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
329b5fa320bSStefano Zampini       mumps->id.lredrhs = mumps->id.size_schur;
3309566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.nrhs * mumps->id.lredrhs, &mumps->id.redrhs));
331b5fa320bSStefano Zampini       mumps->sizeredrhs = mumps->id.nrhs * mumps->id.lredrhs;
332b5fa320bSStefano Zampini     }
333b5fa320bSStefano Zampini   } else { /* prepare for the expansion step */
334b8f61ee1SStefano Zampini     /* solve Schur complement (this has to be done by the MUMPS user, so basically us) */
3359566063dSJacob Faibussowitsch     PetscCall(MatMumpsSolveSchur_Private(F));
336b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 2; /* expansion phase */
3373ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
3389261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in solve: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
339b5fa320bSStefano Zampini     /* restore defaults */
340b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = -1;
341d3d598ffSStefano Zampini     /* free MUMPS internal array for redrhs if we have solved for multiple rhs in order to save memory space */
342d3d598ffSStefano Zampini     if (mumps->id.nrhs > 1) {
3439566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
344d3d598ffSStefano Zampini       mumps->id.lredrhs = 0;
345d3d598ffSStefano Zampini       mumps->sizeredrhs = 0;
346d3d598ffSStefano Zampini     }
347b5fa320bSStefano Zampini   }
3483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
349b5fa320bSStefano Zampini }
350b5fa320bSStefano Zampini 
351397b6df1SKris Buschelman /*
352d341cd04SHong Zhang   MatConvertToTriples_A_B - convert Petsc matrix to triples: row[nz], col[nz], val[nz]
353d341cd04SHong Zhang 
354397b6df1SKris Buschelman   input:
35575480915SPierre Jolivet     A       - matrix in aij,baij or sbaij format
356397b6df1SKris Buschelman     shift   - 0: C style output triple; 1: Fortran style output triple.
357bccb9932SShri Abhyankar     reuse   - MAT_INITIAL_MATRIX: spaces are allocated and values are set for the triple
358bccb9932SShri Abhyankar               MAT_REUSE_MATRIX:   only the values in v array are updated
359397b6df1SKris Buschelman   output:
360397b6df1SKris Buschelman     nnz     - dim of r, c, and v (number of local nonzero entries of A)
361397b6df1SKris Buschelman     r, c, v - row and col index, matrix values (matrix triples)
362eb9baa12SBarry Smith 
363eb9baa12SBarry Smith   The returned values r, c, and sometimes v are obtained in a single PetscMalloc(). Then in MatDestroy_MUMPS() it is
3647ee00b23SStefano Zampini   freed with PetscFree(mumps->irn);  This is not ideal code, the fact that v is ONLY sometimes part of mumps->irn means
365eb9baa12SBarry Smith   that the PetscMalloc() cannot easily be replaced with a PetscMalloc3().
366eb9baa12SBarry Smith 
367397b6df1SKris Buschelman  */
36816ebf90aSShri Abhyankar 
36966976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
370d71ae5a4SJacob Faibussowitsch {
371a3d589ffSStefano Zampini   const PetscScalar *av;
372185f6596SHong Zhang   const PetscInt    *ai, *aj, *ajj, M = A->rmap->n;
373a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j, k;
374a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
37516ebf90aSShri Abhyankar   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
376397b6df1SKris Buschelman 
377397b6df1SKris Buschelman   PetscFunctionBegin;
3789566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
379bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
3802205254eSKarl Rupp     nz = aa->nz;
3812205254eSKarl Rupp     ai = aa->i;
3822205254eSKarl Rupp     aj = aa->j;
3839566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
384a6053eceSJunchao Zhang     for (i = k = 0; i < M; i++) {
38516ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
38667877ebaSShri Abhyankar       ajj = aj + ai[i];
38767877ebaSShri Abhyankar       for (j = 0; j < rnz; j++) {
3889566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[k]));
3899566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[k]));
390a6053eceSJunchao Zhang         k++;
39116ebf90aSShri Abhyankar       }
39216ebf90aSShri Abhyankar     }
39350c845baSStefano Zampini     mumps->val = (PetscScalar *)av;
394a6053eceSJunchao Zhang     mumps->irn = row;
395a6053eceSJunchao Zhang     mumps->jcn = col;
396a6053eceSJunchao Zhang     mumps->nnz = nz;
39750c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, av, aa->nz));
3989566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
3993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
40016ebf90aSShri Abhyankar }
401397b6df1SKris Buschelman 
40266976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
403d71ae5a4SJacob Faibussowitsch {
404a6053eceSJunchao Zhang   PetscInt64     nz, i, j, k, r;
4057ee00b23SStefano Zampini   Mat_SeqSELL   *a = (Mat_SeqSELL *)A->data;
406a6053eceSJunchao Zhang   PetscMUMPSInt *row, *col;
4077ee00b23SStefano Zampini 
4087ee00b23SStefano Zampini   PetscFunctionBegin;
4097ee00b23SStefano Zampini   nz = a->sliidx[a->totalslices];
41050c845baSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4119566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
412a6053eceSJunchao Zhang     for (i = k = 0; i < a->totalslices; i++) {
41348a46eb9SPierre 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++]));
4147ee00b23SStefano Zampini     }
4159566063dSJacob Faibussowitsch     for (i = 0; i < nz; i++) PetscCall(PetscMUMPSIntCast(a->colidx[i] + shift, &col[i]));
416a6053eceSJunchao Zhang     mumps->irn = row;
417a6053eceSJunchao Zhang     mumps->jcn = col;
418a6053eceSJunchao Zhang     mumps->nnz = nz;
41950c845baSStefano Zampini     mumps->val = a->val;
42050c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, a->val, nz));
4213ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4227ee00b23SStefano Zampini }
4237ee00b23SStefano Zampini 
42466976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
425d71ae5a4SJacob Faibussowitsch {
42667877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa = (Mat_SeqBAIJ *)A->data;
42733d57670SJed Brown   const PetscInt *ai, *aj, *ajj, bs2 = aa->bs2;
42850c845baSStefano Zampini   PetscInt64      M, nz = bs2 * aa->nz, idx = 0, rnz, i, j, k, m;
429a6053eceSJunchao Zhang   PetscInt        bs;
430a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
43167877ebaSShri Abhyankar 
43267877ebaSShri Abhyankar   PetscFunctionBegin;
43350c845baSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4349566063dSJacob Faibussowitsch     PetscCall(MatGetBlockSize(A, &bs));
43533d57670SJed Brown     M  = A->rmap->N / bs;
4369371c9d4SSatish Balay     ai = aa->i;
4379371c9d4SSatish Balay     aj = aa->j;
4389566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
43967877ebaSShri Abhyankar     for (i = 0; i < M; i++) {
44067877ebaSShri Abhyankar       ajj = aj + ai[i];
44167877ebaSShri Abhyankar       rnz = ai[i + 1] - ai[i];
44267877ebaSShri Abhyankar       for (k = 0; k < rnz; k++) {
44367877ebaSShri Abhyankar         for (j = 0; j < bs; j++) {
44467877ebaSShri Abhyankar           for (m = 0; m < bs; m++) {
4459566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[idx]));
4469566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * ajj[k] + j + shift, &col[idx]));
447a6053eceSJunchao Zhang             idx++;
44867877ebaSShri Abhyankar           }
44967877ebaSShri Abhyankar         }
45067877ebaSShri Abhyankar       }
45167877ebaSShri Abhyankar     }
452a6053eceSJunchao Zhang     mumps->irn = row;
453a6053eceSJunchao Zhang     mumps->jcn = col;
454a6053eceSJunchao Zhang     mumps->nnz = nz;
45550c845baSStefano Zampini     mumps->val = aa->a;
45650c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, aa->a, nz));
4573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
45867877ebaSShri Abhyankar }
45967877ebaSShri Abhyankar 
46066976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
461d71ae5a4SJacob Faibussowitsch {
46275480915SPierre Jolivet   const PetscInt *ai, *aj, *ajj;
463a6053eceSJunchao Zhang   PetscInt        bs;
464a6053eceSJunchao Zhang   PetscInt64      nz, rnz, i, j, k, m;
465a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
46675480915SPierre Jolivet   PetscScalar    *val;
46716ebf90aSShri Abhyankar   Mat_SeqSBAIJ   *aa  = (Mat_SeqSBAIJ *)A->data;
46875480915SPierre Jolivet   const PetscInt  bs2 = aa->bs2, mbs = aa->mbs;
46938548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
470b94d7dedSBarry Smith   PetscBool isset, hermitian;
47138548759SBarry Smith #endif
47216ebf90aSShri Abhyankar 
47316ebf90aSShri Abhyankar   PetscFunctionBegin;
47438548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
475b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
476b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
47738548759SBarry Smith #endif
4782205254eSKarl Rupp   ai = aa->i;
4792205254eSKarl Rupp   aj = aa->j;
4809566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
48175480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
482f3fa974cSJacob Faibussowitsch     const PetscInt64 alloc_size = aa->nz * bs2;
483f3fa974cSJacob Faibussowitsch 
484f3fa974cSJacob Faibussowitsch     PetscCall(PetscMalloc2(alloc_size, &row, alloc_size, &col));
485a6053eceSJunchao Zhang     if (bs > 1) {
486f3fa974cSJacob Faibussowitsch       PetscCall(PetscMalloc1(alloc_size, &mumps->val_alloc));
487a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
48875480915SPierre Jolivet     } else {
489a6053eceSJunchao Zhang       mumps->val = aa->a;
49075480915SPierre Jolivet     }
491a6053eceSJunchao Zhang     mumps->irn = row;
492a6053eceSJunchao Zhang     mumps->jcn = col;
493a6053eceSJunchao Zhang   } else {
494a6053eceSJunchao Zhang     row = mumps->irn;
495a6053eceSJunchao Zhang     col = mumps->jcn;
496a6053eceSJunchao Zhang   }
497a6053eceSJunchao Zhang   val = mumps->val;
498185f6596SHong Zhang 
49916ebf90aSShri Abhyankar   nz = 0;
500a81fe166SPierre Jolivet   if (bs > 1) {
50175480915SPierre Jolivet     for (i = 0; i < mbs; i++) {
50216ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
50367877ebaSShri Abhyankar       ajj = aj + ai[i];
50475480915SPierre Jolivet       for (j = 0; j < rnz; j++) {
50575480915SPierre Jolivet         for (k = 0; k < bs; k++) {
50675480915SPierre Jolivet           for (m = 0; m < bs; m++) {
507ec4f40fdSPierre Jolivet             if (ajj[j] > i || k >= m) {
50875480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
5099566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[nz]));
5109566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j] * bs + k + shift, &col[nz]));
51175480915SPierre Jolivet               }
51275480915SPierre Jolivet               val[nz++] = aa->a[(ai[i] + j) * bs2 + m + k * bs];
51375480915SPierre Jolivet             }
51475480915SPierre Jolivet           }
51575480915SPierre Jolivet         }
51675480915SPierre Jolivet       }
51775480915SPierre Jolivet     }
518a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
519a81fe166SPierre Jolivet     for (i = 0; i < mbs; i++) {
520a81fe166SPierre Jolivet       rnz = ai[i + 1] - ai[i];
521a81fe166SPierre Jolivet       ajj = aj + ai[i];
522a81fe166SPierre Jolivet       for (j = 0; j < rnz; j++) {
5239566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5249566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
525a6053eceSJunchao Zhang         nz++;
526a81fe166SPierre Jolivet       }
527a81fe166SPierre Jolivet     }
52808401ef6SPierre Jolivet     PetscCheck(nz == aa->nz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different numbers of nonzeros %" PetscInt64_FMT " != %" PetscInt_FMT, nz, aa->nz);
52950c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, aa->a, aa->nz)); /* bs == 1 and MAT_REUSE_MATRIX */
530a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
5313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
53216ebf90aSShri Abhyankar }
53316ebf90aSShri Abhyankar 
53466976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
535d71ae5a4SJacob Faibussowitsch {
53667877ebaSShri Abhyankar   const PetscInt    *ai, *aj, *ajj, *adiag, M = A->rmap->n;
537a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j;
53867877ebaSShri Abhyankar   const PetscScalar *av, *v1;
53916ebf90aSShri Abhyankar   PetscScalar       *val;
540a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
541829b1710SHong Zhang   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
54229b521d4Sstefano_zampini   PetscBool          missing;
54338548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
544b94d7dedSBarry Smith   PetscBool hermitian, isset;
54538548759SBarry Smith #endif
54616ebf90aSShri Abhyankar 
54716ebf90aSShri Abhyankar   PetscFunctionBegin;
54838548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
549b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
550b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
55138548759SBarry Smith #endif
5529566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
5539371c9d4SSatish Balay   ai    = aa->i;
5549371c9d4SSatish Balay   aj    = aa->j;
55516ebf90aSShri Abhyankar   adiag = aa->diag;
5569566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A, &missing, NULL));
557bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5587ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
559829b1710SHong Zhang     nz = 0;
56029b521d4Sstefano_zampini     if (missing) {
56129b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
56229b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
56329b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
56429b521d4Sstefano_zampini             if (aj[j] < i) continue;
56529b521d4Sstefano_zampini             nz++;
56629b521d4Sstefano_zampini           }
56729b521d4Sstefano_zampini         } else {
56829b521d4Sstefano_zampini           nz += ai[i + 1] - adiag[i];
56929b521d4Sstefano_zampini         }
57029b521d4Sstefano_zampini       }
57129b521d4Sstefano_zampini     } else {
572829b1710SHong Zhang       for (i = 0; i < M; i++) nz += ai[i + 1] - adiag[i];
57329b521d4Sstefano_zampini     }
5749566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
5759566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
576a6053eceSJunchao Zhang     mumps->nnz = nz;
577a6053eceSJunchao Zhang     mumps->irn = row;
578a6053eceSJunchao Zhang     mumps->jcn = col;
579a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
580185f6596SHong Zhang 
58116ebf90aSShri Abhyankar     nz = 0;
58229b521d4Sstefano_zampini     if (missing) {
58329b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
58429b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
58529b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
58629b521d4Sstefano_zampini             if (aj[j] < i) continue;
5879566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5889566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j] + shift, &col[nz]));
58929b521d4Sstefano_zampini             val[nz] = av[j];
59029b521d4Sstefano_zampini             nz++;
59129b521d4Sstefano_zampini           }
59229b521d4Sstefano_zampini         } else {
59329b521d4Sstefano_zampini           rnz = ai[i + 1] - adiag[i];
59429b521d4Sstefano_zampini           ajj = aj + adiag[i];
59529b521d4Sstefano_zampini           v1  = av + adiag[i];
59629b521d4Sstefano_zampini           for (j = 0; j < rnz; j++) {
5979566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5989566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
599a6053eceSJunchao Zhang             val[nz++] = v1[j];
60029b521d4Sstefano_zampini           }
60129b521d4Sstefano_zampini         }
60229b521d4Sstefano_zampini       }
60329b521d4Sstefano_zampini     } else {
60416ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
60516ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
60667877ebaSShri Abhyankar         ajj = aj + adiag[i];
607cf3759fdSShri Abhyankar         v1  = av + adiag[i];
60867877ebaSShri Abhyankar         for (j = 0; j < rnz; j++) {
6099566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6109566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
611a6053eceSJunchao Zhang           val[nz++] = v1[j];
61216ebf90aSShri Abhyankar         }
61316ebf90aSShri Abhyankar       }
61429b521d4Sstefano_zampini     }
615397b6df1SKris Buschelman   } else {
616a6053eceSJunchao Zhang     nz  = 0;
617a6053eceSJunchao Zhang     val = mumps->val;
61829b521d4Sstefano_zampini     if (missing) {
61916ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
62029b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
62129b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
62229b521d4Sstefano_zampini             if (aj[j] < i) continue;
62329b521d4Sstefano_zampini             val[nz++] = av[j];
62429b521d4Sstefano_zampini           }
62529b521d4Sstefano_zampini         } else {
62616ebf90aSShri Abhyankar           rnz = ai[i + 1] - adiag[i];
62767877ebaSShri Abhyankar           v1  = av + adiag[i];
628ad540459SPierre Jolivet           for (j = 0; j < rnz; j++) val[nz++] = v1[j];
62916ebf90aSShri Abhyankar         }
63016ebf90aSShri Abhyankar       }
63129b521d4Sstefano_zampini     } else {
63216ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
63316ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
63416ebf90aSShri Abhyankar         v1  = av + adiag[i];
635ad540459SPierre Jolivet         for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63616ebf90aSShri Abhyankar       }
63716ebf90aSShri Abhyankar     }
63829b521d4Sstefano_zampini   }
6399566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
6403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
64116ebf90aSShri Abhyankar }
64216ebf90aSShri Abhyankar 
64366976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
644d71ae5a4SJacob Faibussowitsch {
645a6053eceSJunchao Zhang   const PetscInt    *ai, *aj, *bi, *bj, *garray, *ajj, *bjj;
646a6053eceSJunchao Zhang   PetscInt           bs;
647a6053eceSJunchao Zhang   PetscInt64         rstart, nz, i, j, k, m, jj, irow, countA, countB;
648a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
64916ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
65016ebf90aSShri Abhyankar   PetscScalar       *val;
651397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ *)A->data;
652397b6df1SKris Buschelman   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ *)(mat->A)->data;
653397b6df1SKris Buschelman   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
654ec4f40fdSPierre Jolivet   const PetscInt     bs2 = aa->bs2, mbs = aa->mbs;
65538548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
656b94d7dedSBarry Smith   PetscBool hermitian, isset;
65738548759SBarry Smith #endif
65816ebf90aSShri Abhyankar 
65916ebf90aSShri Abhyankar   PetscFunctionBegin;
66038548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
661b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
662b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
66338548759SBarry Smith #endif
6649566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
66538548759SBarry Smith   rstart = A->rmap->rstart;
66638548759SBarry Smith   ai     = aa->i;
66738548759SBarry Smith   aj     = aa->j;
66838548759SBarry Smith   bi     = bb->i;
66938548759SBarry Smith   bj     = bb->j;
67038548759SBarry Smith   av     = aa->a;
67138548759SBarry Smith   bv     = bb->a;
672397b6df1SKris Buschelman 
6732205254eSKarl Rupp   garray = mat->garray;
6742205254eSKarl Rupp 
675bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
676a6053eceSJunchao Zhang     nz = (aa->nz + bb->nz) * bs2; /* just a conservative estimate */
6779566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
6789566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
679a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
680a6053eceSJunchao Zhang     mumps->irn = row;
681a6053eceSJunchao Zhang     mumps->jcn = col;
682a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
683397b6df1SKris Buschelman   } else {
684a6053eceSJunchao Zhang     val = mumps->val;
685397b6df1SKris Buschelman   }
686397b6df1SKris Buschelman 
6879371c9d4SSatish Balay   jj   = 0;
6889371c9d4SSatish Balay   irow = rstart;
689ec4f40fdSPierre Jolivet   for (i = 0; i < mbs; i++) {
690397b6df1SKris Buschelman     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
691397b6df1SKris Buschelman     countA = ai[i + 1] - ai[i];
692397b6df1SKris Buschelman     countB = bi[i + 1] - bi[i];
693397b6df1SKris Buschelman     bjj    = bj + bi[i];
694ec4f40fdSPierre Jolivet     v1     = av + ai[i] * bs2;
695ec4f40fdSPierre Jolivet     v2     = bv + bi[i] * bs2;
696397b6df1SKris Buschelman 
697ec4f40fdSPierre Jolivet     if (bs > 1) {
698ec4f40fdSPierre Jolivet       /* A-part */
699ec4f40fdSPierre Jolivet       for (j = 0; j < countA; j++) {
700ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
701ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
702ec4f40fdSPierre Jolivet             if (rstart + ajj[j] * bs > irow || k >= m) {
703ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
7049566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7059566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j] * bs + k + shift, &col[jj]));
706ec4f40fdSPierre Jolivet               }
707ec4f40fdSPierre Jolivet               val[jj++] = v1[j * bs2 + m + k * bs];
708ec4f40fdSPierre Jolivet             }
709ec4f40fdSPierre Jolivet           }
710ec4f40fdSPierre Jolivet         }
711ec4f40fdSPierre Jolivet       }
712ec4f40fdSPierre Jolivet 
713ec4f40fdSPierre Jolivet       /* B-part */
714ec4f40fdSPierre Jolivet       for (j = 0; j < countB; j++) {
715ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
716ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
717ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7189566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7199566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]] * bs + k + shift, &col[jj]));
720ec4f40fdSPierre Jolivet             }
721ec4f40fdSPierre Jolivet             val[jj++] = v2[j * bs2 + m + k * bs];
722ec4f40fdSPierre Jolivet           }
723ec4f40fdSPierre Jolivet         }
724ec4f40fdSPierre Jolivet       }
725ec4f40fdSPierre Jolivet     } else {
726397b6df1SKris Buschelman       /* A-part */
727397b6df1SKris Buschelman       for (j = 0; j < countA; j++) {
728bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7299566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7309566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
731397b6df1SKris Buschelman         }
73216ebf90aSShri Abhyankar         val[jj++] = v1[j];
733397b6df1SKris Buschelman       }
73416ebf90aSShri Abhyankar 
73516ebf90aSShri Abhyankar       /* B-part */
73616ebf90aSShri Abhyankar       for (j = 0; j < countB; j++) {
737bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7389566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7399566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
740397b6df1SKris Buschelman         }
74116ebf90aSShri Abhyankar         val[jj++] = v2[j];
74216ebf90aSShri Abhyankar       }
74316ebf90aSShri Abhyankar     }
744ec4f40fdSPierre Jolivet     irow += bs;
745ec4f40fdSPierre Jolivet   }
7465d955bbbSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = jj;
7473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
74816ebf90aSShri Abhyankar }
74916ebf90aSShri Abhyankar 
75066976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
751d71ae5a4SJacob Faibussowitsch {
75216ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
7535d955bbbSStefano Zampini   PetscInt64         rstart, cstart, nz, i, j, jj, irow, countA, countB;
754a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
75516ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
75616ebf90aSShri Abhyankar   PetscScalar       *val;
757a3d589ffSStefano Zampini   Mat                Ad, Ao;
758a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
759a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
76016ebf90aSShri Abhyankar 
76116ebf90aSShri Abhyankar   PetscFunctionBegin;
7629566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
7639566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
7649566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
765a3d589ffSStefano Zampini 
766a3d589ffSStefano Zampini   aa = (Mat_SeqAIJ *)(Ad)->data;
767a3d589ffSStefano Zampini   bb = (Mat_SeqAIJ *)(Ao)->data;
76838548759SBarry Smith   ai = aa->i;
76938548759SBarry Smith   aj = aa->j;
77038548759SBarry Smith   bi = bb->i;
77138548759SBarry Smith   bj = bb->j;
77216ebf90aSShri Abhyankar 
773a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7745d955bbbSStefano Zampini   cstart = A->cmap->rstart;
7752205254eSKarl Rupp 
776bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
777a6053eceSJunchao Zhang     nz = (PetscInt64)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7789566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
7799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
780a6053eceSJunchao Zhang     mumps->nnz = nz;
781a6053eceSJunchao Zhang     mumps->irn = row;
782a6053eceSJunchao Zhang     mumps->jcn = col;
783a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
78416ebf90aSShri Abhyankar   } else {
785a6053eceSJunchao Zhang     val = mumps->val;
78616ebf90aSShri Abhyankar   }
78716ebf90aSShri Abhyankar 
7889371c9d4SSatish Balay   jj   = 0;
7899371c9d4SSatish Balay   irow = rstart;
79016ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
79116ebf90aSShri Abhyankar     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
79216ebf90aSShri Abhyankar     countA = ai[i + 1] - ai[i];
79316ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
79416ebf90aSShri Abhyankar     bjj    = bj + bi[i];
79516ebf90aSShri Abhyankar     v1     = av + ai[i];
79616ebf90aSShri Abhyankar     v2     = bv + bi[i];
79716ebf90aSShri Abhyankar 
79816ebf90aSShri Abhyankar     /* A-part */
79916ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
800bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8019566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8025d955bbbSStefano Zampini         PetscCall(PetscMUMPSIntCast(cstart + ajj[j] + shift, &col[jj]));
80316ebf90aSShri Abhyankar       }
80416ebf90aSShri Abhyankar       val[jj++] = v1[j];
80516ebf90aSShri Abhyankar     }
80616ebf90aSShri Abhyankar 
80716ebf90aSShri Abhyankar     /* B-part */
80816ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
809bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8109566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8119566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
81216ebf90aSShri Abhyankar       }
81316ebf90aSShri Abhyankar       val[jj++] = v2[j];
81416ebf90aSShri Abhyankar     }
81516ebf90aSShri Abhyankar     irow++;
81616ebf90aSShri Abhyankar   }
8179566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
8189566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
8193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82016ebf90aSShri Abhyankar }
82116ebf90aSShri Abhyankar 
82266976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
823d71ae5a4SJacob Faibussowitsch {
82467877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat = (Mat_MPIBAIJ *)A->data;
82567877ebaSShri Abhyankar   Mat_SeqBAIJ       *aa  = (Mat_SeqBAIJ *)(mat->A)->data;
82667877ebaSShri Abhyankar   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
82767877ebaSShri Abhyankar   const PetscInt    *ai = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j, *ajj, *bjj;
8285d955bbbSStefano Zampini   const PetscInt    *garray = mat->garray, mbs = mat->mbs, rstart = A->rmap->rstart, cstart = A->cmap->rstart;
82933d57670SJed Brown   const PetscInt     bs2 = mat->bs2;
830a6053eceSJunchao Zhang   PetscInt           bs;
831a6053eceSJunchao Zhang   PetscInt64         nz, i, j, k, n, jj, irow, countA, countB, idx;
832a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
83367877ebaSShri Abhyankar   const PetscScalar *av = aa->a, *bv = bb->a, *v1, *v2;
83467877ebaSShri Abhyankar   PetscScalar       *val;
83567877ebaSShri Abhyankar 
83667877ebaSShri Abhyankar   PetscFunctionBegin;
8379566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
838bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
83967877ebaSShri Abhyankar     nz = bs2 * (aa->nz + bb->nz);
8409566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
8419566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
842a6053eceSJunchao Zhang     mumps->nnz = nz;
843a6053eceSJunchao Zhang     mumps->irn = row;
844a6053eceSJunchao Zhang     mumps->jcn = col;
845a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
84667877ebaSShri Abhyankar   } else {
847a6053eceSJunchao Zhang     val = mumps->val;
84867877ebaSShri Abhyankar   }
84967877ebaSShri Abhyankar 
8509371c9d4SSatish Balay   jj   = 0;
8519371c9d4SSatish Balay   irow = rstart;
85267877ebaSShri Abhyankar   for (i = 0; i < mbs; i++) {
85367877ebaSShri Abhyankar     countA = ai[i + 1] - ai[i];
85467877ebaSShri Abhyankar     countB = bi[i + 1] - bi[i];
85567877ebaSShri Abhyankar     ajj    = aj + ai[i];
85667877ebaSShri Abhyankar     bjj    = bj + bi[i];
85767877ebaSShri Abhyankar     v1     = av + bs2 * ai[i];
85867877ebaSShri Abhyankar     v2     = bv + bs2 * bi[i];
85967877ebaSShri Abhyankar 
86067877ebaSShri Abhyankar     idx = 0;
86167877ebaSShri Abhyankar     /* A-part */
86267877ebaSShri Abhyankar     for (k = 0; k < countA; k++) {
86367877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
86467877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
865bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8669566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8675d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(cstart + bs * ajj[k] + j + shift, &col[jj]));
86867877ebaSShri Abhyankar           }
86967877ebaSShri Abhyankar           val[jj++] = v1[idx++];
87067877ebaSShri Abhyankar         }
87167877ebaSShri Abhyankar       }
87267877ebaSShri Abhyankar     }
87367877ebaSShri Abhyankar 
87467877ebaSShri Abhyankar     idx = 0;
87567877ebaSShri Abhyankar     /* B-part */
87667877ebaSShri Abhyankar     for (k = 0; k < countB; k++) {
87767877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
87867877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
879bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8809566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8819566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * garray[bjj[k]] + j + shift, &col[jj]));
88267877ebaSShri Abhyankar           }
883d985c460SShri Abhyankar           val[jj++] = v2[idx++];
88467877ebaSShri Abhyankar         }
88567877ebaSShri Abhyankar       }
88667877ebaSShri Abhyankar     }
887d985c460SShri Abhyankar     irow += bs;
88867877ebaSShri Abhyankar   }
8893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
89067877ebaSShri Abhyankar }
89167877ebaSShri Abhyankar 
89266976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
893d71ae5a4SJacob Faibussowitsch {
89416ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *adiag, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
895a6053eceSJunchao Zhang   PetscInt64         rstart, nz, nza, nzb, i, j, jj, irow, countA, countB;
896a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
89716ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
89816ebf90aSShri Abhyankar   PetscScalar       *val;
899a3d589ffSStefano Zampini   Mat                Ad, Ao;
900a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
901a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
90238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
903b94d7dedSBarry Smith   PetscBool hermitian, isset;
90438548759SBarry Smith #endif
90516ebf90aSShri Abhyankar 
90616ebf90aSShri Abhyankar   PetscFunctionBegin;
90738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
908b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
909b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
91038548759SBarry Smith #endif
9119566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
9129566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
9139566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
914a3d589ffSStefano Zampini 
915a3d589ffSStefano Zampini   aa    = (Mat_SeqAIJ *)(Ad)->data;
916a3d589ffSStefano Zampini   bb    = (Mat_SeqAIJ *)(Ao)->data;
91738548759SBarry Smith   ai    = aa->i;
91838548759SBarry Smith   aj    = aa->j;
91938548759SBarry Smith   adiag = aa->diag;
92038548759SBarry Smith   bi    = bb->i;
92138548759SBarry Smith   bj    = bb->j;
9222205254eSKarl Rupp 
92316ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
92416ebf90aSShri Abhyankar 
925bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
926e0bace9bSHong Zhang     nza = 0; /* num of upper triangular entries in mat->A, including diagonals */
927e0bace9bSHong Zhang     nzb = 0; /* num of upper triangular entries in mat->B */
92816ebf90aSShri Abhyankar     for (i = 0; i < m; i++) {
929e0bace9bSHong Zhang       nza += (ai[i + 1] - adiag[i]);
93016ebf90aSShri Abhyankar       countB = bi[i + 1] - bi[i];
93116ebf90aSShri Abhyankar       bjj    = bj + bi[i];
932e0bace9bSHong Zhang       for (j = 0; j < countB; j++) {
933e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
934e0bace9bSHong Zhang       }
935e0bace9bSHong Zhang     }
93616ebf90aSShri Abhyankar 
937e0bace9bSHong Zhang     nz = nza + nzb; /* total nz of upper triangular part of mat */
9389566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
9399566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
940a6053eceSJunchao Zhang     mumps->nnz = nz;
941a6053eceSJunchao Zhang     mumps->irn = row;
942a6053eceSJunchao Zhang     mumps->jcn = col;
943a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
94416ebf90aSShri Abhyankar   } else {
945a6053eceSJunchao Zhang     val = mumps->val;
94616ebf90aSShri Abhyankar   }
94716ebf90aSShri Abhyankar 
9489371c9d4SSatish Balay   jj   = 0;
9499371c9d4SSatish Balay   irow = rstart;
95016ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
95116ebf90aSShri Abhyankar     ajj    = aj + adiag[i]; /* ptr to the beginning of the diagonal of this row */
95216ebf90aSShri Abhyankar     v1     = av + adiag[i];
95316ebf90aSShri Abhyankar     countA = ai[i + 1] - adiag[i];
95416ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
95516ebf90aSShri Abhyankar     bjj    = bj + bi[i];
95616ebf90aSShri Abhyankar     v2     = bv + bi[i];
95716ebf90aSShri Abhyankar 
95816ebf90aSShri Abhyankar     /* A-part */
95916ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
960bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9619566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9629566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
96316ebf90aSShri Abhyankar       }
96416ebf90aSShri Abhyankar       val[jj++] = v1[j];
96516ebf90aSShri Abhyankar     }
96616ebf90aSShri Abhyankar 
96716ebf90aSShri Abhyankar     /* B-part */
96816ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
96916ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
970bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9719566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9729566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
97316ebf90aSShri Abhyankar         }
97416ebf90aSShri Abhyankar         val[jj++] = v2[j];
97516ebf90aSShri Abhyankar       }
976397b6df1SKris Buschelman     }
977397b6df1SKris Buschelman     irow++;
978397b6df1SKris Buschelman   }
9799566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
9809566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
9813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
982397b6df1SKris Buschelman }
983397b6df1SKris Buschelman 
984c3e1b152SPierre Jolivet static PetscErrorCode MatConvertToTriples_diagonal_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
985c3e1b152SPierre Jolivet {
986c3e1b152SPierre Jolivet   const PetscScalar *av;
987c3e1b152SPierre Jolivet   const PetscInt     M = A->rmap->n;
988c3e1b152SPierre Jolivet   PetscInt64         i;
989c3e1b152SPierre Jolivet   PetscMUMPSInt     *row, *col;
990c3e1b152SPierre Jolivet   Vec                v;
991c3e1b152SPierre Jolivet 
992c3e1b152SPierre Jolivet   PetscFunctionBegin;
993c3e1b152SPierre Jolivet   PetscCall(MatDiagonalGetDiagonal(A, &v));
994c3e1b152SPierre Jolivet   PetscCall(VecGetArrayRead(v, &av));
995c3e1b152SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
996c3e1b152SPierre Jolivet     PetscCall(PetscMalloc2(M, &row, M, &col));
997c3e1b152SPierre Jolivet     for (i = 0; i < M; i++) {
998c3e1b152SPierre Jolivet       PetscCall(PetscMUMPSIntCast(i + A->rmap->rstart, &row[i]));
999c3e1b152SPierre Jolivet       col[i] = row[i];
1000c3e1b152SPierre Jolivet     }
1001c3e1b152SPierre Jolivet     mumps->val = (PetscScalar *)av;
1002c3e1b152SPierre Jolivet     mumps->irn = row;
1003c3e1b152SPierre Jolivet     mumps->jcn = col;
1004c3e1b152SPierre Jolivet     mumps->nnz = M;
1005c3e1b152SPierre Jolivet   } else PetscCall(PetscArraycpy(mumps->val, av, M));
1006c3e1b152SPierre Jolivet   PetscCall(VecRestoreArrayRead(v, &av));
1007c3e1b152SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1008c3e1b152SPierre Jolivet }
1009c3e1b152SPierre Jolivet 
101066976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_nest_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
10119d0448ceSStefano Zampini {
10129d0448ceSStefano Zampini   Mat     **mats;
10139d0448ceSStefano Zampini   PetscInt  nr, nc;
10149d0448ceSStefano Zampini   PetscBool chol = mumps->sym ? PETSC_TRUE : PETSC_FALSE;
10159d0448ceSStefano Zampini 
10169d0448ceSStefano Zampini   PetscFunctionBegin;
10179d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
10189d0448ceSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
10199d0448ceSStefano Zampini     PetscMUMPSInt *irns, *jcns;
10209d0448ceSStefano Zampini     PetscScalar   *vals;
10219d0448ceSStefano Zampini     PetscInt64     totnnz, cumnnz, maxnnz;
10229d0448ceSStefano Zampini     PetscInt      *pjcns_w;
10239d0448ceSStefano Zampini     IS            *rows, *cols;
10249d0448ceSStefano Zampini     PetscInt     **rows_idx, **cols_idx;
10259d0448ceSStefano Zampini 
10269d0448ceSStefano Zampini     cumnnz = 0;
10279d0448ceSStefano Zampini     maxnnz = 0;
10285d955bbbSStefano Zampini     PetscCall(PetscMalloc2(nr * nc + 1, &mumps->nest_vals_start, nr * nc, &mumps->nest_convert_to_triples));
10299d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
10309d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
10319d0448ceSStefano Zampini         Mat sub = mats[r][c];
10329d0448ceSStefano Zampini 
10339d0448ceSStefano Zampini         mumps->nest_convert_to_triples[r * nc + c] = NULL;
10349d0448ceSStefano Zampini         if (chol && c < r) continue; /* skip lower-triangular block for Cholesky */
10359d0448ceSStefano Zampini         if (sub) {
10369d0448ceSStefano Zampini           PetscErrorCode (*convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *) = NULL;
1037c3e1b152SPierre Jolivet           PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans, isHTrans = PETSC_FALSE, isDiag;
10389d0448ceSStefano Zampini           MatInfo   info;
10399d0448ceSStefano Zampini 
10405d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
10415d955bbbSStefano Zampini           if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
10425d955bbbSStefano Zampini           else {
10435d955bbbSStefano Zampini             PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
10445d955bbbSStefano Zampini             if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
10455d955bbbSStefano Zampini           }
10469d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
10479d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
10489d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
10499d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
10509d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
10519d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
1052c3e1b152SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATDIAGONAL, &isDiag));
10539d0448ceSStefano Zampini 
10549d0448ceSStefano Zampini           if (chol) {
10559d0448ceSStefano Zampini             if (r == c) {
10569d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqsbaij;
10579d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpisbaij;
10589d0448ceSStefano Zampini               else if (isSeqSBAIJ) convert_to_triples = MatConvertToTriples_seqsbaij_seqsbaij;
10599d0448ceSStefano Zampini               else if (isMPISBAIJ) convert_to_triples = MatConvertToTriples_mpisbaij_mpisbaij;
1060c3e1b152SPierre Jolivet               else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
10619d0448ceSStefano Zampini             } else {
10629d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10639d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10649d0448ceSStefano Zampini               else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10659d0448ceSStefano Zampini               else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
1066c3e1b152SPierre Jolivet               else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
10679d0448ceSStefano Zampini             }
10689d0448ceSStefano Zampini           } else {
10699d0448ceSStefano Zampini             if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10709d0448ceSStefano Zampini             else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10719d0448ceSStefano Zampini             else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10729d0448ceSStefano Zampini             else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
1073c3e1b152SPierre Jolivet             else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
10749d0448ceSStefano Zampini           }
10759d0448ceSStefano Zampini           PetscCheck(convert_to_triples, PetscObjectComm((PetscObject)sub), PETSC_ERR_SUP, "Not for block of type %s", ((PetscObject)sub)->type_name);
10769d0448ceSStefano Zampini           mumps->nest_convert_to_triples[r * nc + c] = convert_to_triples;
10779d0448ceSStefano Zampini           PetscCall(MatGetInfo(sub, MAT_LOCAL, &info));
10789d0448ceSStefano Zampini           cumnnz += (PetscInt64)info.nz_used; /* can be overestimated for Cholesky */
10799d0448ceSStefano Zampini           maxnnz = PetscMax(maxnnz, info.nz_used);
10809d0448ceSStefano Zampini         }
10819d0448ceSStefano Zampini       }
10829d0448ceSStefano Zampini     }
10839d0448ceSStefano Zampini 
10849d0448ceSStefano Zampini     /* Allocate total COO */
10859d0448ceSStefano Zampini     totnnz = cumnnz;
10869d0448ceSStefano Zampini     PetscCall(PetscMalloc2(totnnz, &irns, totnnz, &jcns));
10879d0448ceSStefano Zampini     PetscCall(PetscMalloc1(totnnz, &vals));
10889d0448ceSStefano Zampini 
10899d0448ceSStefano Zampini     /* Handle rows and column maps
10909d0448ceSStefano Zampini        We directly map rows and use an SF for the columns */
10919d0448ceSStefano Zampini     PetscCall(PetscMalloc4(nr, &rows, nc, &cols, nr, &rows_idx, nc, &cols_idx));
10929d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
10939d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetIndices(rows[r], (const PetscInt **)&rows_idx[r]));
10949d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISGetIndices(cols[c], (const PetscInt **)&cols_idx[c]));
10959d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscMalloc1(maxnnz, &pjcns_w));
10965d955bbbSStefano Zampini     else (void)maxnnz;
10979d0448ceSStefano Zampini 
10989d0448ceSStefano Zampini     cumnnz = 0;
10999d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11009d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11019d0448ceSStefano Zampini         Mat             sub  = mats[r][c];
11029d0448ceSStefano Zampini         const PetscInt *ridx = rows_idx[r];
11035d955bbbSStefano Zampini         const PetscInt *cidx = cols_idx[c];
11049d0448ceSStefano Zampini         PetscInt        rst;
11059d0448ceSStefano Zampini         PetscSF         csf;
11065d955bbbSStefano Zampini         PetscBool       isTrans, isHTrans = PETSC_FALSE, swap;
11075d955bbbSStefano Zampini         PetscLayout     cmap;
11089d0448ceSStefano Zampini 
11099d0448ceSStefano Zampini         mumps->nest_vals_start[r * nc + c] = cumnnz;
11109d0448ceSStefano Zampini         if (!mumps->nest_convert_to_triples[r * nc + c]) continue;
11119d0448ceSStefano Zampini 
11125d955bbbSStefano Zampini         /* Extract inner blocks if needed */
11135d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
11145d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
11155d955bbbSStefano Zampini         else {
11165d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
11175d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
11185d955bbbSStefano Zampini         }
11195d955bbbSStefano Zampini         swap = (PetscBool)(isTrans || isHTrans);
11205d955bbbSStefano Zampini 
11215d955bbbSStefano Zampini         /* Get column layout to map off-process columns */
11225d955bbbSStefano Zampini         PetscCall(MatGetLayouts(sub, NULL, &cmap));
11235d955bbbSStefano Zampini 
11245d955bbbSStefano Zampini         /* Get row start to map on-process rows */
11255d955bbbSStefano Zampini         PetscCall(MatGetOwnershipRange(sub, &rst, NULL));
11265d955bbbSStefano Zampini 
11279d0448ceSStefano Zampini         /* Directly use the mumps datastructure and use C ordering for now */
11289d0448ceSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[r * nc + c])(sub, 0, MAT_INITIAL_MATRIX, mumps));
11299d0448ceSStefano Zampini 
11305d955bbbSStefano Zampini         /* Swap the role of rows and columns indices for transposed blocks
11315d955bbbSStefano Zampini            since we need values with global final ordering */
11325d955bbbSStefano Zampini         if (swap) {
11335d955bbbSStefano Zampini           cidx = rows_idx[r];
11345d955bbbSStefano Zampini           ridx = cols_idx[c];
11359d0448ceSStefano Zampini         }
11369d0448ceSStefano Zampini 
11375d955bbbSStefano Zampini         /* Communicate column indices
11385d955bbbSStefano Zampini            This could have been done with a single SF but it would have complicated the code a lot.
11395d955bbbSStefano Zampini            But since we do it only once, we pay the price of setting up an SF for each block */
11405d955bbbSStefano Zampini         if (PetscDefined(USE_64BIT_INDICES)) {
11415d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) pjcns_w[k] = mumps->jcn[k];
11425d955bbbSStefano Zampini         } else pjcns_w = (PetscInt *)(mumps->jcn); /* This cast is needed only to silence warnings for 64bit integers builds */
11439d0448ceSStefano Zampini         PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)A), &csf));
11445d955bbbSStefano Zampini         PetscCall(PetscSFSetGraphLayout(csf, cmap, mumps->nnz, NULL, PETSC_OWN_POINTER, pjcns_w));
11455d955bbbSStefano Zampini         PetscCall(PetscSFBcastBegin(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11465d955bbbSStefano Zampini         PetscCall(PetscSFBcastEnd(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11479d0448ceSStefano Zampini         PetscCall(PetscSFDestroy(&csf));
11489d0448ceSStefano Zampini 
11495d955bbbSStefano Zampini         /* Import indices: use direct map for rows and mapped indices for columns */
11505d955bbbSStefano Zampini         if (swap) {
11515d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11525d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &jcns[cumnnz + k]));
11535d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &irns[cumnnz + k]));
11545d955bbbSStefano Zampini           }
11555d955bbbSStefano Zampini         } else {
11565d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11575d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &irns[cumnnz + k]));
11585d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &jcns[cumnnz + k]));
11595d955bbbSStefano Zampini           }
11605d955bbbSStefano Zampini         }
11615d955bbbSStefano Zampini 
11625d955bbbSStefano Zampini         /* Import values to full COO */
11635d955bbbSStefano Zampini         PetscCall(PetscArraycpy(vals + cumnnz, mumps->val, mumps->nnz));
116450c845baSStefano Zampini         if (isHTrans) { /* conjugate the entries */
116550c845baSStefano Zampini           PetscScalar *v = vals + cumnnz;
116650c845baSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) v[k] = PetscConj(v[k]);
116750c845baSStefano Zampini         }
11689d0448ceSStefano Zampini 
11699d0448ceSStefano Zampini         /* Shift new starting point and sanity check */
11709d0448ceSStefano Zampini         cumnnz += mumps->nnz;
11719d0448ceSStefano Zampini         PetscCheck(cumnnz <= totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Unexpected number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11729d0448ceSStefano Zampini 
11739d0448ceSStefano Zampini         /* Free scratch memory */
11749d0448ceSStefano Zampini         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
11759d0448ceSStefano Zampini         PetscCall(PetscFree(mumps->val_alloc));
11769d0448ceSStefano Zampini         mumps->val = NULL;
11779d0448ceSStefano Zampini         mumps->nnz = 0;
11789d0448ceSStefano Zampini       }
11799d0448ceSStefano Zampini     }
11809d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscFree(pjcns_w));
11819d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISRestoreIndices(rows[r], (const PetscInt **)&rows_idx[r]));
11829d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISRestoreIndices(cols[c], (const PetscInt **)&cols_idx[c]));
11839d0448ceSStefano Zampini     PetscCall(PetscFree4(rows, cols, rows_idx, cols_idx));
11849d0448ceSStefano Zampini     if (!chol) PetscCheck(cumnnz == totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11855d955bbbSStefano Zampini     mumps->nest_vals_start[nr * nc] = cumnnz;
11869d0448ceSStefano Zampini 
11879d0448ceSStefano Zampini     /* Set pointers for final MUMPS data structure */
11889d0448ceSStefano Zampini     mumps->nest_vals = vals;
11899d0448ceSStefano Zampini     mumps->val_alloc = NULL; /* do not use val_alloc since it may be reallocated with the OMP callpath */
11909d0448ceSStefano Zampini     mumps->val       = vals;
11919d0448ceSStefano Zampini     mumps->irn       = irns;
11929d0448ceSStefano Zampini     mumps->jcn       = jcns;
11939d0448ceSStefano Zampini     mumps->nnz       = cumnnz;
11949d0448ceSStefano Zampini   } else {
11959d0448ceSStefano Zampini     PetscScalar *oval = mumps->nest_vals;
11969d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11979d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11985d955bbbSStefano Zampini         PetscBool isTrans, isHTrans = PETSC_FALSE;
11995d955bbbSStefano Zampini         Mat       sub  = mats[r][c];
12005d955bbbSStefano Zampini         PetscInt  midx = r * nc + c;
12015d955bbbSStefano Zampini 
12025d955bbbSStefano Zampini         if (!mumps->nest_convert_to_triples[midx]) continue;
12035d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
12045d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
12055d955bbbSStefano Zampini         else {
12065d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
12075d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
12085d955bbbSStefano Zampini         }
12095d955bbbSStefano Zampini         mumps->val = oval + mumps->nest_vals_start[midx];
12105d955bbbSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[midx])(sub, shift, MAT_REUSE_MATRIX, mumps));
12115d955bbbSStefano Zampini         if (isHTrans) {
12125d955bbbSStefano Zampini           PetscInt nnz = mumps->nest_vals_start[midx + 1] - mumps->nest_vals_start[midx];
12135d955bbbSStefano Zampini           for (PetscInt k = 0; k < nnz; k++) mumps->val[k] = PetscConj(mumps->val[k]);
12145d955bbbSStefano Zampini         }
12159d0448ceSStefano Zampini       }
12169d0448ceSStefano Zampini     }
12179d0448ceSStefano Zampini     mumps->val = oval;
12189d0448ceSStefano Zampini   }
12199d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
12209d0448ceSStefano Zampini }
12219d0448ceSStefano Zampini 
122266976f2fSJacob Faibussowitsch static PetscErrorCode MatDestroy_MUMPS(Mat A)
1223d71ae5a4SJacob Faibussowitsch {
1224a6053eceSJunchao Zhang   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
1225b24902e0SBarry Smith 
1226397b6df1SKris Buschelman   PetscFunctionBegin;
12279566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
12289566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
12299566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
12309566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
12319566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
12329566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
12339566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn, mumps->jcn));
12349566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
12359566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
1236413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->ICNTL_pre));
1237413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->CNTL_pre));
12389566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
1239413bcc21SPierre Jolivet   if (mumps->id.job != JOB_NULL) { /* cannot call PetscMUMPS_c() if JOB_INIT has never been called for this instance */
1240a5e57a09SHong Zhang     mumps->id.job = JOB_END;
12413ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
12429261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in termination: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
1243413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
1244413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) PetscCallMPI(MPI_Comm_free(&mumps->mumps_comm));
1245413bcc21SPierre Jolivet       else PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A), &mumps->mumps_comm));
1246413bcc21SPierre Jolivet     }
1247413bcc21SPierre Jolivet   }
12483ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
124967602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
12509566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
12519566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
12529566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow, mumps->rhs_recvcounts, mumps->rhs_disps));
125367602552SJunchao Zhang   }
12543ab56b82SJunchao Zhang #endif
12559566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
12569566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
12579566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
12589566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
12599566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
12609d0448ceSStefano Zampini   PetscCall(PetscFree2(mumps->nest_vals_start, mumps->nest_convert_to_triples));
12619d0448ceSStefano Zampini   PetscCall(PetscFree(mumps->nest_vals));
12629566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
1263bf0cc555SLisandro Dalcin 
126497969023SHong Zhang   /* clear composed functions */
12659566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorGetSolverType_C", NULL));
12669566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorSetSchurIS_C", NULL));
12679566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorCreateSchurComplement_C", NULL));
12689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetIcntl_C", NULL));
12699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetIcntl_C", NULL));
12709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetCntl_C", NULL));
12719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetCntl_C", NULL));
12729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfo_C", NULL));
12739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfog_C", NULL));
12749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfo_C", NULL));
12759566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfog_C", NULL));
12765c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetNullPivots_C", NULL));
12779566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverse_C", NULL));
12789566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverseTranspose_C", NULL));
12793ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1280397b6df1SKris Buschelman }
1281397b6df1SKris Buschelman 
128267602552SJunchao 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. */
1283d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A, PetscInt nrhs, const PetscScalar *array)
1284d71ae5a4SJacob Faibussowitsch {
128567602552SJunchao Zhang   Mat_MUMPS        *mumps   = (Mat_MUMPS *)A->data;
128667602552SJunchao Zhang   const PetscMPIInt ompsize = mumps->omp_comm_size;
128767602552SJunchao Zhang   PetscInt          i, m, M, rstart;
128867602552SJunchao Zhang 
128967602552SJunchao Zhang   PetscFunctionBegin;
12909566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, NULL));
12919566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, NULL));
129208401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
129367602552SJunchao Zhang   if (ompsize == 1) {
129467602552SJunchao Zhang     if (!mumps->irhs_loc) {
129567602552SJunchao Zhang       mumps->nloc_rhs = m;
12969566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m, &mumps->irhs_loc));
12979566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A, &rstart, NULL));
129867602552SJunchao Zhang       for (i = 0; i < m; i++) mumps->irhs_loc[i] = rstart + i + 1; /* use 1-based indices */
129967602552SJunchao Zhang     }
130067602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar *)array;
130167602552SJunchao Zhang   } else {
130267602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
130367602552SJunchao Zhang     const PetscInt *ranges;
130467602552SJunchao Zhang     PetscMPIInt     j, k, sendcount, *petsc_ranks, *omp_ranks;
130567602552SJunchao Zhang     MPI_Group       petsc_group, omp_group;
130667602552SJunchao Zhang     PetscScalar    *recvbuf = NULL;
130767602552SJunchao Zhang 
130867602552SJunchao Zhang     if (mumps->is_omp_master) {
130967602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
131067602552SJunchao Zhang       if (!mumps->irhs_loc) {
13119566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize, &omp_ranks, ompsize, &petsc_ranks));
13129566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize, &mumps->rhs_nrow, ompsize, &mumps->rhs_recvcounts, ompsize, &mumps->rhs_disps));
13139566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm, &petsc_group));
13149566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm, &omp_group));
131567602552SJunchao Zhang         for (j = 0; j < ompsize; j++) omp_ranks[j] = j;
13169566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group, ompsize, omp_ranks, petsc_group, petsc_ranks));
131767602552SJunchao Zhang 
131867602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
131967602552SJunchao Zhang         mumps->nloc_rhs = 0;
13209566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A, &ranges));
132167602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
132267602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j] + 1] - ranges[petsc_ranks[j]];
132367602552SJunchao Zhang           mumps->nloc_rhs += mumps->rhs_nrow[j];
132467602552SJunchao Zhang         }
13259566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs, &mumps->irhs_loc));
132667602552SJunchao Zhang         for (j = k = 0; j < ompsize; j++) {
132767602552SJunchao 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 */
132867602552SJunchao Zhang         }
132967602552SJunchao Zhang 
13309566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks, petsc_ranks));
13319566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
13329566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
133367602552SJunchao Zhang       }
133467602552SJunchao Zhang 
133567602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
133667602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
13379566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
13389566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs * nrhs, &mumps->rhs_loc, mumps->nloc_rhs * nrhs, &mumps->rhs_recvbuf));
133967602552SJunchao Zhang         mumps->max_nrhs = nrhs;
134067602552SJunchao Zhang       }
134167602552SJunchao Zhang 
134267602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
13439566063dSJacob Faibussowitsch       for (j = 0; j < ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j] * nrhs, &mumps->rhs_recvcounts[j]));
134467602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
134567602552SJunchao Zhang       for (j = 1; j < ompsize; j++) {
134667602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j - 1] + mumps->rhs_recvcounts[j - 1];
134708401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscMPIInt overflow!");
134867602552SJunchao Zhang       }
134967602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
135067602552SJunchao Zhang     }
135167602552SJunchao Zhang 
13529566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m * nrhs, &sendcount));
13539566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array, sendcount, MPIU_SCALAR, recvbuf, mumps->rhs_recvcounts, mumps->rhs_disps, MPIU_SCALAR, 0, mumps->omp_comm));
135467602552SJunchao Zhang 
135567602552SJunchao Zhang     if (mumps->is_omp_master) {
135667602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
135767602552SJunchao Zhang         PetscScalar *dst, *dstbase = mumps->rhs_loc;
135867602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
135967602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
136067602552SJunchao Zhang           dst                    = dstbase;
136167602552SJunchao Zhang           for (i = 0; i < nrhs; i++) {
13629566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst, src, mumps->rhs_nrow[j]));
136367602552SJunchao Zhang             src += mumps->rhs_nrow[j];
136467602552SJunchao Zhang             dst += mumps->nloc_rhs;
136567602552SJunchao Zhang           }
136667602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
136767602552SJunchao Zhang         }
136867602552SJunchao Zhang       }
136967602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar *)mumps->rhs_loc;
137067602552SJunchao Zhang     }
137167602552SJunchao Zhang #endif /* PETSC_HAVE_OPENMP_SUPPORT */
137267602552SJunchao Zhang   }
137367602552SJunchao Zhang   mumps->id.nrhs     = nrhs;
137467602552SJunchao Zhang   mumps->id.nloc_rhs = mumps->nloc_rhs;
137567602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
137667602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
13773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
137867602552SJunchao Zhang }
137967602552SJunchao Zhang 
138066976f2fSJacob Faibussowitsch static PetscErrorCode MatSolve_MUMPS(Mat A, Vec b, Vec x)
1381d71ae5a4SJacob Faibussowitsch {
1382e69c285eSBarry Smith   Mat_MUMPS         *mumps  = (Mat_MUMPS *)A->data;
138325aac85cSJunchao Zhang   const PetscScalar *rarray = NULL;
1384d54de34fSKris Buschelman   PetscScalar       *array;
1385329ec9b3SHong Zhang   IS                 is_iden, is_petsc;
1386329ec9b3SHong Zhang   PetscInt           i;
1387cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1388883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE, cite2 = PETSC_FALSE;
1389397b6df1SKris Buschelman 
1390397b6df1SKris Buschelman   PetscFunctionBegin;
13919371c9d4SSatish 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 "
13929371c9d4SSatish Balay                                    "Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",
13939371c9d4SSatish Balay                                    &cite1));
13949371c9d4SSatish 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 "
13959371c9d4SSatish Balay                                    "Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",
13969371c9d4SSatish Balay                                    &cite2));
13972aca8efcSHong Zhang 
1398603e8f96SBarry Smith   if (A->factorerrortype) {
13999566063dSJacob 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)));
14009566063dSJacob Faibussowitsch     PetscCall(VecSetInf(x));
14013ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
14022aca8efcSHong Zhang   }
14032aca8efcSHong Zhang 
1404a5e57a09SHong Zhang   mumps->id.nrhs = 1;
14052d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
140625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
140767602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
14089566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b, &rarray));
14099566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, 1, rarray));
141025aac85cSJunchao Zhang     } else {
141141ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
14129566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
14139566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
141467602552SJunchao Zhang       if (!mumps->myid) {
14159566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq, &array));
141667602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar *)array;
141767602552SJunchao Zhang       }
141825aac85cSJunchao Zhang     }
14193ab56b82SJunchao Zhang   } else {                   /* petsc_size == 1 */
142067602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
14219566063dSJacob Faibussowitsch     PetscCall(VecCopy(b, x));
14229566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x, &array));
1423940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar *)array;
1424397b6df1SKris Buschelman   }
1425397b6df1SKris Buschelman 
1426cc86f929SStefano Zampini   /*
1427cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1428cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1429cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1430cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1431cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1432cc86f929SStefano Zampini   */
14333e5b40d0SPierre Jolivet   if (mumps->id.size_schur > 0) {
143408401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
14353e5b40d0SPierre Jolivet     if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1436cc86f929SStefano Zampini       second_solve = PETSC_TRUE;
14379566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
14383e5b40d0SPierre Jolivet       mumps->id.ICNTL(26) = 1; /* condensation phase */
14393e5b40d0SPierre Jolivet     } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1440cc86f929SStefano Zampini   }
1441397b6df1SKris Buschelman   /* solve phase */
1442a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
14433ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
14449261f6e4SBarry Smith   PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in solve: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
1445397b6df1SKris Buschelman 
1446b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
14471baa6e33SBarry Smith   if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
14483e5b40d0SPierre Jolivet   else if (mumps->id.ICNTL(26) == 1) {
14493e5b40d0SPierre Jolivet     PetscCall(MatMumpsSolveSchur_Private(A));
14503e5b40d0SPierre Jolivet     for (i = 0; i < mumps->id.size_schur; ++i) {
14513e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
14523e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i];
14533e5b40d0SPierre Jolivet #else
14543e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i].r + PETSC_i * mumps->id.redrhs[i].i;
14553e5b40d0SPierre Jolivet #endif
14563e5b40d0SPierre Jolivet       array[mumps->id.listvar_schur[i] - 1] = val;
14573e5b40d0SPierre Jolivet     }
14583e5b40d0SPierre Jolivet   }
1459b5fa320bSStefano Zampini 
14602d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to petsc mpi x */
1461a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1462a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
14639566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1464397b6df1SKris Buschelman     }
1465a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1466a6053eceSJunchao Zhang       PetscInt *isol2_loc = NULL;
14679566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, mumps->id.lsol_loc, 0, 1, &is_iden)); /* from */
14689566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc, &isol2_loc));
1469a6053eceSJunchao 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 */
14709566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, mumps->id.lsol_loc, isol2_loc, PETSC_OWN_POINTER, &is_petsc)); /* to */
14719566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq, is_iden, x, is_petsc, &mumps->scat_sol));
14729566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
14739566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1474a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1475397b6df1SKris Buschelman     }
1476a5e57a09SHong Zhang 
14779566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
14789566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
1479329ec9b3SHong Zhang   }
1480353d7d71SJunchao Zhang 
148167602552SJunchao Zhang   if (mumps->petsc_size > 1) {
148225aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
14839566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b, &rarray));
148425aac85cSJunchao Zhang     } else if (!mumps->myid) {
14859566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq, &array));
148625aac85cSJunchao Zhang     }
14879566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x, &array));
1488353d7d71SJunchao Zhang 
148964412097SPierre Jolivet   PetscCall(PetscLogFlops(2.0 * PetscMax(0, (mumps->id.INFO(28) >= 0 ? mumps->id.INFO(28) : -1000000 * mumps->id.INFO(28)) - A->cmap->n)));
14903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1491397b6df1SKris Buschelman }
1492397b6df1SKris Buschelman 
149366976f2fSJacob Faibussowitsch static PetscErrorCode MatSolveTranspose_MUMPS(Mat A, Vec b, Vec x)
1494d71ae5a4SJacob Faibussowitsch {
1495e69c285eSBarry Smith   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1496338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
149751d5961aSHong Zhang 
149851d5961aSHong Zhang   PetscFunctionBegin;
1499a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
15009566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A, b, x));
1501338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
15023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
150351d5961aSHong Zhang }
150451d5961aSHong Zhang 
150566976f2fSJacob Faibussowitsch static PetscErrorCode MatMatSolve_MUMPS(Mat A, Mat B, Mat X)
1506d71ae5a4SJacob Faibussowitsch {
1507b8491c3eSStefano Zampini   Mat                Bt = NULL;
1508a6053eceSJunchao Zhang   PetscBool          denseX, denseB, flg, flgT;
1509e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)A->data;
1510334c5f61SHong Zhang   PetscInt           i, nrhs, M;
15111683a169SBarry Smith   PetscScalar       *array;
15121683a169SBarry Smith   const PetscScalar *rbray;
1513a6053eceSJunchao Zhang   PetscInt           lsol_loc, nlsol_loc, *idxx, iidx = 0;
1514a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc, *isol_loc_save;
15151683a169SBarry Smith   PetscScalar       *bray, *sol_loc, *sol_loc_save;
1516be818407SHong Zhang   IS                 is_to, is_from;
1517beae5ec0SHong Zhang   PetscInt           k, proc, j, m, myrstart;
1518be818407SHong Zhang   const PetscInt    *rstart;
151967602552SJunchao Zhang   Vec                v_mpi, msol_loc;
152067602552SJunchao Zhang   VecScatter         scat_sol;
152167602552SJunchao Zhang   Vec                b_seq;
152267602552SJunchao Zhang   VecScatter         scat_rhs;
1523be818407SHong Zhang   PetscScalar       *aa;
1524be818407SHong Zhang   PetscInt           spnr, *ia, *ja;
1525d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1526bda8bf91SBarry Smith 
1527e0b74bf9SHong Zhang   PetscFunctionBegin;
15289566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X, &denseX, MATSEQDENSE, MATMPIDENSE, NULL));
152928b400f6SJacob Faibussowitsch   PetscCheck(denseX, PetscObjectComm((PetscObject)X), PETSC_ERR_ARG_WRONG, "Matrix X must be MATDENSE matrix");
1530be818407SHong Zhang 
15319566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B, &denseB, MATSEQDENSE, MATMPIDENSE, NULL));
1532a6053eceSJunchao Zhang   if (denseB) {
153308401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix B and X must have same row distribution");
1534be818407SHong Zhang     mumps->id.ICNTL(20) = 0; /* dense RHS */
15350e6b8875SHong Zhang   } else {                   /* sparse B */
153608401ef6SPierre Jolivet     PetscCheck(X != B, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_IDN, "X and B must be different matrices");
1537013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)B, MATTRANSPOSEVIRTUAL, &flgT));
1538da81f932SPierre Jolivet     if (flgT) { /* input B is transpose of actual RHS matrix,
15390e6b8875SHong Zhang                  because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
15409566063dSJacob Faibussowitsch       PetscCall(MatTransposeGetMat(B, &Bt));
1541013e2dc7SBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)B), PETSC_ERR_ARG_WRONG, "Matrix B must be MATTRANSPOSEVIRTUAL matrix");
1542be818407SHong Zhang     mumps->id.ICNTL(20) = 1; /* sparse RHS */
1543b8491c3eSStefano Zampini   }
154487b22cf4SHong Zhang 
15459566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, &nrhs));
15469481e6e9SHong Zhang   mumps->id.nrhs = nrhs;
15479481e6e9SHong Zhang   mumps->id.lrhs = M;
15482b691707SHong Zhang   mumps->id.rhs  = NULL;
15499481e6e9SHong Zhang 
15502d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1551b8491c3eSStefano Zampini     PetscScalar *aa;
1552b8491c3eSStefano Zampini     PetscInt     spnr, *ia, *ja;
1553e94cce23SStefano Zampini     PetscBool    second_solve = PETSC_FALSE;
1554b8491c3eSStefano Zampini 
15559566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &array));
1556b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar *)array;
15572b691707SHong Zhang 
1558a6053eceSJunchao Zhang     if (denseB) {
15592b691707SHong Zhang       /* copy B to X */
15609566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
15619566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, rbray, M * nrhs));
15629566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
15632b691707SHong Zhang     } else { /* sparse B */
15649566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt, &aa));
15659566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
156628b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
15679566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
1568b8491c3eSStefano Zampini       mumps->id.rhs_sparse = (MumpsScalar *)aa;
1569b8491c3eSStefano Zampini     }
1570e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
15713e5b40d0SPierre Jolivet     if (mumps->id.size_schur > 0) {
15723e5b40d0SPierre Jolivet       PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
15733e5b40d0SPierre Jolivet       if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1574e94cce23SStefano Zampini         second_solve = PETSC_TRUE;
15759566063dSJacob Faibussowitsch         PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
15763e5b40d0SPierre Jolivet         mumps->id.ICNTL(26) = 1; /* condensation phase */
15773e5b40d0SPierre Jolivet       } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1578e94cce23SStefano Zampini     }
15792cd7d884SHong Zhang     /* solve phase */
15802cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
15813ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
15829261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in solve: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
1583b5fa320bSStefano Zampini 
1584b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
15851baa6e33SBarry Smith     if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
15863e5b40d0SPierre Jolivet     else if (mumps->id.ICNTL(26) == 1) {
15873e5b40d0SPierre Jolivet       PetscCall(MatMumpsSolveSchur_Private(A));
15883e5b40d0SPierre Jolivet       for (j = 0; j < nrhs; ++j)
15893e5b40d0SPierre Jolivet         for (i = 0; i < mumps->id.size_schur; ++i) {
15903e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
15913e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs];
15923e5b40d0SPierre Jolivet #else
15933e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs].r + PETSC_i * mumps->id.redrhs[i + j * mumps->id.lredrhs].i;
15943e5b40d0SPierre Jolivet #endif
15953e5b40d0SPierre Jolivet           array[mumps->id.listvar_schur[i] - 1 + j * M] = val;
15963e5b40d0SPierre Jolivet         }
15973e5b40d0SPierre Jolivet     }
1598a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
15999566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt, &aa));
16009566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
160128b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
1602b8491c3eSStefano Zampini     }
16039566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &array));
16043ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1605be818407SHong Zhang   }
1606801fbe65SHong Zhang 
16072ef1f0ffSBarry Smith   /* parallel case: MUMPS requires rhs B to be centralized on the host! */
1608aed4548fSBarry Smith   PetscCheck(mumps->petsc_size <= 1 || !mumps->id.ICNTL(19), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1609241dbb5eSStefano Zampini 
1610beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
16111683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
16121683a169SBarry Smith   sol_loc_save  = (PetscScalar *)mumps->id.sol_loc;
1613801fbe65SHong Zhang 
1614a1dfcbd9SJunchao Zhang   lsol_loc  = mumps->id.lsol_loc;
161571aed81dSHong Zhang   nlsol_loc = nrhs * lsol_loc; /* length of sol_loc */
16169566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc, &sol_loc, lsol_loc, &isol_loc));
1617940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
1618801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1619801fbe65SHong Zhang 
16209566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, nlsol_loc, (PetscScalar *)sol_loc, &msol_loc));
16212cd7d884SHong Zhang 
162267602552SJunchao Zhang   if (denseB) {
162325aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
162467602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
16259566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
16269566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, nrhs, rbray));
16279566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
16289566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
16299566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, NULL, &v_mpi));
163025aac85cSJunchao Zhang     } else {
163125aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
163280577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
163380577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
163480577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
163580577c12SJunchao Zhang       */
163680577c12SJunchao Zhang 
163767602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1638be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
16399566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
16409566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B, &bray));
16419566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16429566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B, &bray));
16432b691707SHong Zhang 
1644be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1645801fbe65SHong Zhang       if (!mumps->myid) {
1646beae5ec0SHong Zhang         PetscInt *idx;
1647beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
16489566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nrhs * M, &idx));
16499566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B, &rstart));
1650be818407SHong Zhang         k = 0;
16512d4298aeSJunchao Zhang         for (proc = 0; proc < mumps->petsc_size; proc++) {
1652be818407SHong Zhang           for (j = 0; j < nrhs; j++) {
1653beae5ec0SHong Zhang             for (i = rstart[proc]; i < rstart[proc + 1]; i++) idx[k++] = j * M + i;
1654be818407SHong Zhang           }
1655be818407SHong Zhang         }
1656be818407SHong Zhang 
16579566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, nrhs * M, &b_seq));
16589566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nrhs * M, idx, PETSC_OWN_POINTER, &is_to));
16599566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, nrhs * M, 0, 1, &is_from));
1660801fbe65SHong Zhang       } else {
16619566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, 0, &b_seq));
16629566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_to));
16639566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_from));
1664801fbe65SHong Zhang       }
16659566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi, is_from, b_seq, is_to, &scat_rhs));
16669566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
16679566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
16689566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
16699566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
1670801fbe65SHong Zhang 
1671801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
16729566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq, &bray));
1673940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar *)bray;
16749566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq, &bray));
1675801fbe65SHong Zhang       }
167625aac85cSJunchao Zhang     }
16772b691707SHong Zhang   } else { /* sparse B */
16782b691707SHong Zhang     b = (Mat_MPIAIJ *)Bt->data;
16792b691707SHong Zhang 
1680be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
16819566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X, &m, NULL));
16829566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &bray));
16839566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16849566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &bray));
16852b691707SHong Zhang 
16862b691707SHong Zhang     if (!mumps->myid) {
16879566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A, &aa));
16889566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
168928b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
16909566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
16912b691707SHong Zhang       mumps->id.rhs_sparse = (MumpsScalar *)aa;
16922b691707SHong Zhang     } else {
16932b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
16942b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
16952b691707SHong Zhang       mumps->id.nz_rhs      = 0;
16962b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
16972b691707SHong Zhang     }
16982b691707SHong Zhang   }
16992b691707SHong Zhang 
1700801fbe65SHong Zhang   /* solve phase */
1701801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
17023ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
17039261f6e4SBarry Smith   PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in solve: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
1704801fbe65SHong Zhang 
1705334c5f61SHong Zhang   /* scatter mumps distributed solution to petsc vector v_mpi, which shares local arrays with solution matrix X */
17069566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X, &array));
17079566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi, array));
1708801fbe65SHong Zhang 
1709334c5f61SHong Zhang   /* create scatter scat_sol */
17109566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X, &rstart));
1711beae5ec0SHong Zhang   /* iidx: index for scatter mumps solution to petsc X */
1712beae5ec0SHong Zhang 
17139566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, nlsol_loc, 0, 1, &is_from));
17149566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc, &idxx));
1715beae5ec0SHong Zhang   for (i = 0; i < lsol_loc; i++) {
1716beae5ec0SHong 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 */
1717beae5ec0SHong Zhang 
17182d4298aeSJunchao Zhang     for (proc = 0; proc < mumps->petsc_size; proc++) {
1719beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc + 1]) {
1720beae5ec0SHong Zhang         myrstart = rstart[proc];
1721beae5ec0SHong Zhang         k        = isol_loc[i] - myrstart;          /* local index on 1st column of petsc vector X */
1722beae5ec0SHong Zhang         iidx     = k + myrstart * nrhs;             /* maps mumps isol_loc[i] to petsc index in X */
1723beae5ec0SHong Zhang         m        = rstart[proc + 1] - rstart[proc]; /* rows of X for this proc */
1724beae5ec0SHong Zhang         break;
1725be818407SHong Zhang       }
1726be818407SHong Zhang     }
1727be818407SHong Zhang 
1728beae5ec0SHong Zhang     for (j = 0; j < nrhs; j++) idxx[i + j * lsol_loc] = iidx + j * m;
1729801fbe65SHong Zhang   }
17309566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nlsol_loc, idxx, PETSC_COPY_VALUES, &is_to));
17319566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc, is_from, v_mpi, is_to, &scat_sol));
17329566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
17339566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
17349566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
17359566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
17369566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X, &array));
173771aed81dSHong Zhang 
173871aed81dSHong Zhang   /* free spaces */
17391683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar *)sol_loc_save;
174071aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
174171aed81dSHong Zhang 
17429566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc, isol_loc));
17439566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
17449566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
17459566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1746a6053eceSJunchao Zhang   if (!denseB) {
17472b691707SHong Zhang     if (!mumps->myid) {
1748d56c302dSHong Zhang       b = (Mat_MPIAIJ *)Bt->data;
17499566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A, &aa));
17509566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
175128b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
17522b691707SHong Zhang     }
17532b691707SHong Zhang   } else {
175425aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
17559566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
17569566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
175725aac85cSJunchao Zhang     }
17582b691707SHong Zhang   }
17599566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
176064412097SPierre Jolivet   PetscCall(PetscLogFlops(nrhs * PetscMax(0, (2.0 * (mumps->id.INFO(28) >= 0 ? mumps->id.INFO(28) : -1000000 * mumps->id.INFO(28)) - A->cmap->n))));
17613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1762e0b74bf9SHong Zhang }
1763e0b74bf9SHong Zhang 
176466976f2fSJacob Faibussowitsch static PetscErrorCode MatMatSolveTranspose_MUMPS(Mat A, Mat B, Mat X)
1765d71ae5a4SJacob Faibussowitsch {
1766b18964edSHong Zhang   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1767338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
1768b18964edSHong Zhang 
1769b18964edSHong Zhang   PetscFunctionBegin;
1770b18964edSHong Zhang   mumps->id.ICNTL(9) = 0;
1771b18964edSHong Zhang   PetscCall(MatMatSolve_MUMPS(A, B, X));
1772338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
17733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1774b18964edSHong Zhang }
1775b18964edSHong Zhang 
177666976f2fSJacob Faibussowitsch static PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A, Mat Bt, Mat X)
1777d71ae5a4SJacob Faibussowitsch {
1778eb3ef3b2SHong Zhang   PetscBool flg;
1779eb3ef3b2SHong Zhang   Mat       B;
1780eb3ef3b2SHong Zhang 
1781eb3ef3b2SHong Zhang   PetscFunctionBegin;
17829566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
178328b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)Bt), PETSC_ERR_ARG_WRONG, "Matrix Bt must be MATAIJ matrix");
1784eb3ef3b2SHong Zhang 
1785eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
17869566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt, &B));
1787eb3ef3b2SHong Zhang 
17889566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A, B, X));
17899566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
17903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1791eb3ef3b2SHong Zhang }
1792eb3ef3b2SHong Zhang 
1793ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1794a58c3f20SHong Zhang /*
1795a58c3f20SHong Zhang   input:
1796a58c3f20SHong Zhang    F:        numeric factor
1797a58c3f20SHong Zhang   output:
1798a58c3f20SHong Zhang    nneg:     total number of negative pivots
179919d49a3bSHong Zhang    nzero:    total number of zero pivots
180019d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1801a58c3f20SHong Zhang */
180266976f2fSJacob Faibussowitsch static PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F, PetscInt *nneg, PetscInt *nzero, PetscInt *npos)
1803d71ae5a4SJacob Faibussowitsch {
1804e69c285eSBarry Smith   Mat_MUMPS  *mumps = (Mat_MUMPS *)F->data;
1805c1490034SHong Zhang   PetscMPIInt size;
1806a58c3f20SHong Zhang 
1807a58c3f20SHong Zhang   PetscFunctionBegin;
18089566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F), &size));
1809bcb30aebSHong 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 */
1810aed4548fSBarry 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));
1811ed85ac9fSHong Zhang 
1812710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1813ed85ac9fSHong Zhang   if (nzero || npos) {
181408401ef6SPierre 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");
1815710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1816710ac8efSHong Zhang     if (npos) *npos = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1817a58c3f20SHong Zhang   }
18183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1819a58c3f20SHong Zhang }
182019d49a3bSHong Zhang #endif
1821a58c3f20SHong Zhang 
182266976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse, Mat_MUMPS *mumps)
1823d71ae5a4SJacob Faibussowitsch {
1824a6053eceSJunchao Zhang   PetscInt       i, nreqs;
1825a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;
1826a6053eceSJunchao Zhang   PetscMPIInt    count;
1827a6053eceSJunchao Zhang   PetscInt64     totnnz, remain;
1828a6053eceSJunchao Zhang   const PetscInt osize = mumps->omp_comm_size;
1829a6053eceSJunchao Zhang   PetscScalar   *val;
18303ab56b82SJunchao Zhang 
18313ab56b82SJunchao Zhang   PetscFunctionBegin;
1832a6053eceSJunchao Zhang   if (osize > 1) {
18333ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
18343ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
18359566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize, &mumps->recvcount));
18369566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz, 1, MPIU_INT64, mumps->recvcount, 1, MPIU_INT64, 0 /*master*/, mumps->omp_comm));
18373ab56b82SJunchao Zhang 
1838a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
18393ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1840a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1841a6053eceSJunchao Zhang         nreqs = 0;
1842a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) nreqs += (mumps->recvcount[i] + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
1843a6053eceSJunchao Zhang       } else {
1844a6053eceSJunchao Zhang         nreqs = (mumps->nnz + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
18453ab56b82SJunchao Zhang       }
184635cb6cd3SPierre Jolivet       PetscCall(PetscMalloc1(nreqs * 3, &mumps->reqs)); /* Triple the requests since we send irn, jcn and val separately */
18473ab56b82SJunchao Zhang 
1848a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1849a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1850a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1851a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1852a6053eceSJunchao Zhang        */
1853a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
18543ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1855a6053eceSJunchao Zhang         for (i = 0, totnnz = 0; i < osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
18569566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz, &irn, totnnz, &jcn));
18579566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz, &val));
1858a6053eceSJunchao Zhang 
1859a6053eceSJunchao Zhang         /* Self communication */
18609566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn, mumps->irn, mumps->nnz));
18619566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn, mumps->jcn, mumps->nnz));
18629566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val, mumps->val, mumps->nnz));
1863a6053eceSJunchao Zhang 
1864a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
18659566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
18669566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1867a6053eceSJunchao Zhang         mumps->nnz = totnnz;
18683ab56b82SJunchao Zhang         mumps->irn = irn;
18693ab56b82SJunchao Zhang         mumps->jcn = jcn;
1870a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1871a6053eceSJunchao Zhang 
1872a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
1873a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
1874a6053eceSJunchao Zhang         val += mumps->recvcount[0];
1875a6053eceSJunchao Zhang 
1876a6053eceSJunchao Zhang         /* Remote communication */
1877a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) {
1878a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1879a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1880a6053eceSJunchao Zhang           while (count > 0) {
18819566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(irn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18829566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(jcn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18839566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1884a6053eceSJunchao Zhang             irn += count;
1885a6053eceSJunchao Zhang             jcn += count;
1886a6053eceSJunchao Zhang             val += count;
1887a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1888a6053eceSJunchao Zhang             remain -= count;
1889a6053eceSJunchao Zhang           }
18903ab56b82SJunchao Zhang         }
18913ab56b82SJunchao Zhang       } else {
1892a6053eceSJunchao Zhang         irn    = mumps->irn;
1893a6053eceSJunchao Zhang         jcn    = mumps->jcn;
1894a6053eceSJunchao Zhang         val    = mumps->val;
1895a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1896a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1897a6053eceSJunchao Zhang         while (count > 0) {
18989566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(irn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18999566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(jcn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
19009566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1901a6053eceSJunchao Zhang           irn += count;
1902a6053eceSJunchao Zhang           jcn += count;
1903a6053eceSJunchao Zhang           val += count;
1904a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1905a6053eceSJunchao Zhang           remain -= count;
19063ab56b82SJunchao Zhang         }
19073ab56b82SJunchao Zhang       }
1908a6053eceSJunchao Zhang     } else {
1909a6053eceSJunchao Zhang       nreqs = 0;
1910a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
1911a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
1912a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) { /* Remote communication only since self data is already in place */
1913a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1914a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1915a6053eceSJunchao Zhang           while (count > 0) {
19169566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1917a6053eceSJunchao Zhang             val += count;
1918a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1919a6053eceSJunchao Zhang             remain -= count;
1920a6053eceSJunchao Zhang           }
1921a6053eceSJunchao Zhang         }
1922a6053eceSJunchao Zhang       } else {
1923a6053eceSJunchao Zhang         val    = mumps->val;
1924a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1925a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1926a6053eceSJunchao Zhang         while (count > 0) {
19279566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1928a6053eceSJunchao Zhang           val += count;
1929a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1930a6053eceSJunchao Zhang           remain -= count;
1931a6053eceSJunchao Zhang         }
1932a6053eceSJunchao Zhang       }
1933a6053eceSJunchao Zhang     }
19349566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs, mumps->reqs, MPI_STATUSES_IGNORE));
1935a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
1936a6053eceSJunchao Zhang   }
19373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19383ab56b82SJunchao Zhang }
19393ab56b82SJunchao Zhang 
194066976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorNumeric_MUMPS(Mat F, Mat A, const MatFactorInfo *info)
1941d71ae5a4SJacob Faibussowitsch {
1942e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)(F)->data;
1943ace3abfcSBarry Smith   PetscBool  isMPIAIJ;
1944397b6df1SKris Buschelman 
1945397b6df1SKris Buschelman   PetscFunctionBegin;
1946dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
194748a46eb9SPierre 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)));
19489566063dSJacob 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)));
19493ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
19502aca8efcSHong Zhang   }
19516baea169SHong Zhang 
19529566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
19539566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX, mumps));
1954397b6df1SKris Buschelman 
1955397b6df1SKris Buschelman   /* numerical factorization phase */
1956a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
19574e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
1958ad540459SPierre Jolivet     if (!mumps->myid) mumps->id.a = (MumpsScalar *)mumps->val;
1959397b6df1SKris Buschelman   } else {
1960940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar *)mumps->val;
1961397b6df1SKris Buschelman   }
19623ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1963a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
19649261f6e4SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d " MUMPS_MANUALS, mumps->id.INFOG(1), mumps->id.INFO(2));
19659261f6e4SBarry Smith     if (mumps->id.INFOG(1) == -10) {
19669261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: matrix is numerically singular, INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1967603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
1968c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -13) {
19699261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, cannot allocate required memory %d megabytes\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1970603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1971c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
19729261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorizatione: INFOG(1)=%d, INFO(2)=%d, problem with work array\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1973603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
19742aca8efcSHong Zhang     } else {
19759261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1976603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
1977151787a6SHong Zhang     }
19782aca8efcSHong Zhang   }
19799261f6e4SBarry Smith   PetscCheck(mumps->myid || mumps->id.ICNTL(16) <= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in numerical factorization: ICNTL(16)=%d " MUMPS_MANUALS, mumps->id.INFOG(16));
1980397b6df1SKris Buschelman 
1981b3cb21ddSStefano Zampini   F->assembled = PETSC_TRUE;
1982d47f36abSHong Zhang 
1983b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
19843cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
1985c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
19863cb7dd0eSStefano Zampini #endif
1987b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
1988b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
19899566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur, MAT_INPLACE_MATRIX, &F->schur));
1990b3cb21ddSStefano Zampini     }
19919566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F, NULL, MAT_FACTOR_SCHUR_UNFACTORED));
1992b3cb21ddSStefano Zampini   }
199367877ebaSShri Abhyankar 
1994066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
1995066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
1996066565c5SStefano Zampini 
19973ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
19982d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
199967877ebaSShri Abhyankar     PetscInt     lsol_loc;
200067877ebaSShri Abhyankar     PetscScalar *sol_loc;
20012205254eSKarl Rupp 
20029566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A, MATMPIAIJ, &isMPIAIJ));
2003c2093ab7SHong Zhang 
2004c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
2005c2093ab7SHong Zhang     if (mumps->x_seq) {
20069566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
20079566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
20089566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
2009c2093ab7SHong Zhang     }
2010a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
20119566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc, &sol_loc, lsol_loc, &mumps->id.isol_loc));
2012a5e57a09SHong Zhang     mumps->id.lsol_loc = lsol_loc;
2013940cd9d6SSatish Balay     mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
20149566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, lsol_loc, sol_loc, &mumps->x_seq));
201567877ebaSShri Abhyankar   }
20169566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(mumps->id.RINFO(2)));
20173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2018397b6df1SKris Buschelman }
2019397b6df1SKris Buschelman 
20209a2535b5SHong Zhang /* Sets MUMPS options from the options database */
202166976f2fSJacob Faibussowitsch static PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
2022d71ae5a4SJacob Faibussowitsch {
2023e69c285eSBarry Smith   Mat_MUMPS    *mumps = (Mat_MUMPS *)F->data;
2024413bcc21SPierre Jolivet   PetscMUMPSInt icntl = 0, size, *listvar_schur;
202545e3843bSPierre Jolivet   PetscInt      info[80], i, ninfo = 80, rbs, cbs;
2026413bcc21SPierre Jolivet   PetscBool     flg = PETSC_FALSE, schur = (PetscBool)(mumps->id.ICNTL(26) == -1);
2027413bcc21SPierre Jolivet   MumpsScalar  *arr;
2028dcd589f8SShri Abhyankar 
2029dcd589f8SShri Abhyankar   PetscFunctionBegin;
203026cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F), ((PetscObject)F)->prefix, "MUMPS Options", "Mat");
2031413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) { /* MatSetFromOptions_MUMPS() has never been called before */
2032413bcc21SPierre Jolivet     PetscInt nthreads   = 0;
2033413bcc21SPierre Jolivet     PetscInt nCNTL_pre  = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
2034413bcc21SPierre Jolivet     PetscInt nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
2035413bcc21SPierre Jolivet 
2036413bcc21SPierre Jolivet     mumps->petsc_comm = PetscObjectComm((PetscObject)A);
2037413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->petsc_comm, &mumps->petsc_size));
2038413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm, &mumps->myid)); /* "if (!myid)" still works even if mumps_comm is different */
2039413bcc21SPierre Jolivet 
2040413bcc21SPierre Jolivet     PetscCall(PetscOptionsName("-mat_mumps_use_omp_threads", "Convert MPI processes into OpenMP threads", "None", &mumps->use_petsc_omp_support));
2041413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
2042413bcc21SPierre Jolivet     /* do not use PetscOptionsInt() so that the option -mat_mumps_use_omp_threads is not displayed twice in the help */
2043413bcc21SPierre Jolivet     PetscCall(PetscOptionsGetInt(NULL, ((PetscObject)F)->prefix, "-mat_mumps_use_omp_threads", &nthreads, NULL));
2044413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) {
20459371c9d4SSatish 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",
20469371c9d4SSatish Balay                  ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
2047413bcc21SPierre 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 : "");
2048413bcc21SPierre Jolivet #if defined(PETSC_HAVE_OPENMP_SUPPORT)
2049413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm, nthreads, &mumps->omp_ctrl));
2050413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl, &mumps->omp_comm, &mumps->mumps_comm, &mumps->is_omp_master));
2051413bcc21SPierre Jolivet #endif
2052413bcc21SPierre Jolivet     } else {
2053413bcc21SPierre Jolivet       mumps->omp_comm      = PETSC_COMM_SELF;
2054413bcc21SPierre Jolivet       mumps->mumps_comm    = mumps->petsc_comm;
2055413bcc21SPierre Jolivet       mumps->is_omp_master = PETSC_TRUE;
2056413bcc21SPierre Jolivet     }
2057413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->omp_comm, &mumps->omp_comm_size));
2058413bcc21SPierre Jolivet     mumps->reqs = NULL;
2059413bcc21SPierre Jolivet     mumps->tag  = 0;
2060413bcc21SPierre Jolivet 
2061413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
2062413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) {
2063413bcc21SPierre Jolivet         /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
2064413bcc21SPierre Jolivet         MPI_Comm comm;
2065413bcc21SPierre Jolivet         PetscCallMPI(MPI_Comm_dup(mumps->mumps_comm, &comm));
2066413bcc21SPierre Jolivet         mumps->mumps_comm = comm;
2067413bcc21SPierre Jolivet       } else PetscCall(PetscCommGetComm(mumps->petsc_comm, &mumps->mumps_comm));
2068413bcc21SPierre Jolivet     }
2069413bcc21SPierre Jolivet 
2070413bcc21SPierre Jolivet     mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
2071413bcc21SPierre Jolivet     mumps->id.job          = JOB_INIT;
2072413bcc21SPierre Jolivet     mumps->id.par          = 1; /* host participates factorizaton and solve */
2073413bcc21SPierre Jolivet     mumps->id.sym          = mumps->sym;
2074413bcc21SPierre Jolivet 
2075413bcc21SPierre Jolivet     size          = mumps->id.size_schur;
2076413bcc21SPierre Jolivet     arr           = mumps->id.schur;
2077413bcc21SPierre Jolivet     listvar_schur = mumps->id.listvar_schur;
2078413bcc21SPierre Jolivet     PetscMUMPS_c(mumps);
20799261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
2080413bcc21SPierre Jolivet     /* restore cached ICNTL and CNTL values */
2081413bcc21SPierre Jolivet     for (icntl = 0; icntl < nICNTL_pre; ++icntl) mumps->id.ICNTL(mumps->ICNTL_pre[1 + 2 * icntl]) = mumps->ICNTL_pre[2 + 2 * icntl];
2082413bcc21SPierre Jolivet     for (icntl = 0; icntl < nCNTL_pre; ++icntl) mumps->id.CNTL((PetscInt)mumps->CNTL_pre[1 + 2 * icntl]) = mumps->CNTL_pre[2 + 2 * icntl];
2083413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->ICNTL_pre));
2084413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->CNTL_pre));
2085413bcc21SPierre Jolivet 
2086413bcc21SPierre Jolivet     if (schur) {
2087413bcc21SPierre Jolivet       mumps->id.size_schur    = size;
2088413bcc21SPierre Jolivet       mumps->id.schur_lld     = size;
2089413bcc21SPierre Jolivet       mumps->id.schur         = arr;
2090413bcc21SPierre Jolivet       mumps->id.listvar_schur = listvar_schur;
2091413bcc21SPierre Jolivet       if (mumps->petsc_size > 1) {
2092413bcc21SPierre Jolivet         PetscBool gs; /* gs is false if any rank other than root has non-empty IS */
2093413bcc21SPierre Jolivet 
2094413bcc21SPierre Jolivet         mumps->id.ICNTL(19) = 1;                                                                            /* MUMPS returns Schur centralized on the host */
2095413bcc21SPierre 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 */
2096712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &gs, 1, MPIU_BOOL, MPI_LAND, mumps->petsc_comm));
2097413bcc21SPierre Jolivet         PetscCheck(gs, PETSC_COMM_SELF, PETSC_ERR_SUP, "MUMPS distributed parallel Schur complements not yet supported from PETSc");
2098413bcc21SPierre Jolivet       } else {
2099413bcc21SPierre Jolivet         if (F->factortype == MAT_FACTOR_LU) {
2100413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
2101413bcc21SPierre Jolivet         } else {
2102413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
2103413bcc21SPierre Jolivet         }
2104413bcc21SPierre Jolivet       }
2105413bcc21SPierre Jolivet       mumps->id.ICNTL(26) = -1;
2106413bcc21SPierre Jolivet     }
2107413bcc21SPierre Jolivet 
2108413bcc21SPierre Jolivet     /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
2109413bcc21SPierre Jolivet        For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
2110413bcc21SPierre Jolivet      */
2111413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.icntl, 40, MPI_INT, 0, mumps->omp_comm));
2112413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15, MPIU_REAL, 0, mumps->omp_comm));
2113413bcc21SPierre Jolivet 
2114413bcc21SPierre Jolivet     mumps->scat_rhs = NULL;
2115413bcc21SPierre Jolivet     mumps->scat_sol = NULL;
2116413bcc21SPierre Jolivet 
2117413bcc21SPierre Jolivet     /* set PETSc-MUMPS default options - override MUMPS default */
2118413bcc21SPierre Jolivet     mumps->id.ICNTL(3) = 0;
2119413bcc21SPierre Jolivet     mumps->id.ICNTL(4) = 0;
2120413bcc21SPierre Jolivet     if (mumps->petsc_size == 1) {
2121413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 0; /* centralized assembled matrix input */
2122413bcc21SPierre Jolivet       mumps->id.ICNTL(7)  = 7; /* automatic choice of ordering done by the package */
2123413bcc21SPierre Jolivet     } else {
2124413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 3; /* distributed assembled matrix input */
2125413bcc21SPierre Jolivet       mumps->id.ICNTL(21) = 1; /* distributed solution */
2126413bcc21SPierre Jolivet     }
2127413bcc21SPierre Jolivet   }
21289566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1", "ICNTL(1): output stream for error messages", "None", mumps->id.ICNTL(1), &icntl, &flg));
21299a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
21309566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2", "ICNTL(2): output stream for diagnostic printing, statistics, and warning", "None", mumps->id.ICNTL(2), &icntl, &flg));
21319a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
21329566063dSJacob 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));
21339a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
2134dcd589f8SShri Abhyankar 
21359566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4", "ICNTL(4): level of printing (0 to 4)", "None", mumps->id.ICNTL(4), &icntl, &flg));
21369a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
21379a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
21389a2535b5SHong Zhang 
21399566063dSJacob 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));
21409a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
21419a2535b5SHong Zhang 
21429566063dSJacob 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));
2143dcd589f8SShri Abhyankar   if (flg) {
2144aed4548fSBarry 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");
2145b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
2146dcd589f8SShri Abhyankar   }
2147e0b74bf9SHong Zhang 
21489566063dSJacob 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));
21499566063dSJacob 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() */
21509566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10", "ICNTL(10): max num of refinements", "None", mumps->id.ICNTL(10), &mumps->id.ICNTL(10), NULL));
21519566063dSJacob 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));
21529566063dSJacob 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));
21539566063dSJacob 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));
21549566063dSJacob 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));
215545e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A, &rbs, &cbs));
215645e3843bSPierre Jolivet   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = -rbs;
215745e3843bSPierre 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));
215845e3843bSPierre Jolivet   if (flg) {
215945e3843bSPierre Jolivet     PetscCheck(mumps->id.ICNTL(15) <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Positive -mat_mumps_icntl_15 not handled");
216045e3843bSPierre 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");
216145e3843bSPierre Jolivet   }
21629566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19", "ICNTL(19): computes the Schur complement", "None", mumps->id.ICNTL(19), &mumps->id.ICNTL(19), NULL));
216359ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
21649566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
21659566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
216659ac8732SStefano Zampini   }
216725aac85cSJunchao Zhang 
216843f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
216943f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
217025aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
217143f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
217243f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
2173*41caa250SJunchao Zhang      In short, we could not use distributed RHS until with MPICH v4.0b1 or we enabled a workaround in mumps-5.6.2+
217425aac85cSJunchao Zhang    */
2175*41caa250SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5, 6, 2) && defined(PETSC_HAVE_MUMPS_AVOID_MPI_IN_PLACE)
2176*41caa250SJunchao Zhang   mumps->ICNTL20 = 10;
2177*41caa250SJunchao Zhang #elif PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0) || (defined(PETSC_HAVE_MPICH_NUMVERSION) && (PETSC_HAVE_MPICH_NUMVERSION < 40000101))
217825aac85cSJunchao Zhang   mumps->ICNTL20     = 0; /* Centralized dense RHS*/
217943f3b051SJunchao Zhang #else
218043f3b051SJunchao Zhang   mumps->ICNTL20 = 10; /* Distributed dense RHS*/
218125aac85cSJunchao Zhang #endif
21829566063dSJacob 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));
2183aed4548fSBarry 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);
218425aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0)
2185aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10, PETSC_COMM_SELF, PETSC_ERR_SUP, "ICNTL(20)=10 is not supported before MUMPS-5.3.0");
218625aac85cSJunchao Zhang #endif
21879566063dSJacob 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 */
21889a2535b5SHong Zhang 
21899566063dSJacob 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));
21909566063dSJacob 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));
21919566063dSJacob 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));
21929371c9d4SSatish Balay   if (mumps->id.ICNTL(24)) { mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */ }
2193d7ebd59bSHong Zhang 
21949566063dSJacob 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));
21959566063dSJacob 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));
21969566063dSJacob 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));
21979566063dSJacob 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));
21989566063dSJacob 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));
21999566063dSJacob 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 */
22009566063dSJacob 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));
2201145b44c9SPierre Jolivet   /* PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_32","ICNTL(32): performs the forward elimination of the right-hand sides during factorization","None",mumps->id.ICNTL(32),&mumps->id.ICNTL(32),NULL));  -- not supported by PETSc API */
22029566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33", "ICNTL(33): compute determinant", "None", mumps->id.ICNTL(33), &mumps->id.ICNTL(33), NULL));
22039566063dSJacob 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));
22049566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36", "ICNTL(36): choice of BLR factorization variant", "None", mumps->id.ICNTL(36), &mumps->id.ICNTL(36), NULL));
22059566063dSJacob 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));
2206146931dbSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_58", "ICNTL(58): defines options for symbolic factorization", "None", mumps->id.ICNTL(58), &mumps->id.ICNTL(58), NULL));
2207dcd589f8SShri Abhyankar 
22089566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1", "CNTL(1): relative pivoting threshold", "None", mumps->id.CNTL(1), &mumps->id.CNTL(1), NULL));
22099566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2", "CNTL(2): stopping criterion of refinement", "None", mumps->id.CNTL(2), &mumps->id.CNTL(2), NULL));
22109566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3", "CNTL(3): absolute pivoting threshold", "None", mumps->id.CNTL(3), &mumps->id.CNTL(3), NULL));
22119566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4", "CNTL(4): value for static pivoting", "None", mumps->id.CNTL(4), &mumps->id.CNTL(4), NULL));
22129566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5", "CNTL(5): fixation for null pivots", "None", mumps->id.CNTL(5), &mumps->id.CNTL(5), NULL));
22139566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7", "CNTL(7): dropping parameter used during BLR", "None", mumps->id.CNTL(7), &mumps->id.CNTL(7), NULL));
2214e5bb22a1SHong Zhang 
22159566063dSJacob 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));
2216b34f08ffSHong Zhang 
22179566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info", "request INFO local to each processor", "", info, &ninfo, NULL));
2218b34f08ffSHong Zhang   if (ninfo) {
221908401ef6SPierre Jolivet     PetscCheck(ninfo <= 80, PETSC_COMM_SELF, PETSC_ERR_USER, "number of INFO %" PetscInt_FMT " must <= 80", ninfo);
22209566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo, &mumps->info));
2221b34f08ffSHong Zhang     mumps->ninfo = ninfo;
2222b34f08ffSHong Zhang     for (i = 0; i < ninfo; i++) {
2223aed4548fSBarry 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);
2224f7d195e4SLawrence Mitchell       mumps->info[i] = info[i];
2225b34f08ffSHong Zhang     }
2226b34f08ffSHong Zhang   }
2227d0609cedSBarry Smith   PetscOptionsEnd();
22283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2229dcd589f8SShri Abhyankar }
2230dcd589f8SShri Abhyankar 
223166976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F, Mat A, const MatFactorInfo *info, Mat_MUMPS *mumps)
2232d71ae5a4SJacob Faibussowitsch {
22335cd7cf9dSHong Zhang   PetscFunctionBegin;
22345cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
22359261f6e4SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in analysis: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
22365cd7cf9dSHong Zhang     if (mumps->id.INFOG(1) == -6) {
22379261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: matrix is singular, INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
2238603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
22395cd7cf9dSHong Zhang     } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
22409261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: problem with work array, INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
2241603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
2242dbf6bb8dSprj-     } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
22439261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: empty matrix\n"));
22445cd7cf9dSHong Zhang     } else {
22459261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: INFOG(1)=%d, INFO(2)=%d " MUMPS_MANUALS "\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
2246603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
22475cd7cf9dSHong Zhang     }
22485cd7cf9dSHong Zhang   }
22493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22505cd7cf9dSHong Zhang }
22515cd7cf9dSHong Zhang 
225266976f2fSJacob Faibussowitsch static PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2253d71ae5a4SJacob Faibussowitsch {
2254e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
225567877ebaSShri Abhyankar   Vec            b;
225667877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2257397b6df1SKris Buschelman 
2258397b6df1SKris Buschelman   PetscFunctionBegin;
2259d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2260d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
22613ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2262d47f36abSHong Zhang   }
2263dcd589f8SShri Abhyankar 
22649a2535b5SHong Zhang   /* Set MUMPS options from the options database */
226526cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2266dcd589f8SShri Abhyankar 
22679566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
22689566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2269dcd589f8SShri Abhyankar 
227067877ebaSShri Abhyankar   /* analysis phase */
2271a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2272a5e57a09SHong Zhang   mumps->id.n   = M;
2273a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
227467877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2275a5e57a09SHong Zhang     if (!mumps->myid) {
2276a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2277a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2278a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2279a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
22804ac6704cSBarry Smith       if (r) {
22814ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
2282a5e57a09SHong Zhang         if (!mumps->myid) {
2283e0b74bf9SHong Zhang           const PetscInt *idx;
2284a6053eceSJunchao Zhang           PetscInt        i;
22852205254eSKarl Rupp 
22869566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M, &mumps->id.perm_in));
22879566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r, &idx));
22889566063dSJacob Faibussowitsch           for (i = 0; i < M; i++) PetscCall(PetscMUMPSIntCast(idx[i] + 1, &(mumps->id.perm_in[i]))); /* perm_in[]: start from 1, not 0! */
22899566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r, &idx));
2290e0b74bf9SHong Zhang         }
2291e0b74bf9SHong Zhang       }
229267877ebaSShri Abhyankar     }
229367877ebaSShri Abhyankar     break;
229467877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2295a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2296a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2297a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2298a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
229925aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
23009566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23019566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23029566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
230325aac85cSJunchao Zhang     }
230467877ebaSShri Abhyankar     break;
230567877ebaSShri Abhyankar   }
23063ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23079566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
230867877ebaSShri Abhyankar 
2309719d5645SBarry Smith   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2310dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
231151d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
23124e34a73bSHong Zhang   F->ops->matsolve          = MatMatSolve_MUMPS;
2313eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
2314b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2315d47f36abSHong Zhang 
2316d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2318b24902e0SBarry Smith }
2319b24902e0SBarry Smith 
2320450b117fSShri Abhyankar /* Note the Petsc r and c permutations are ignored */
232166976f2fSJacob Faibussowitsch static PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2322d71ae5a4SJacob Faibussowitsch {
2323e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
232467877ebaSShri Abhyankar   Vec            b;
232567877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2326450b117fSShri Abhyankar 
2327450b117fSShri Abhyankar   PetscFunctionBegin;
2328d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2329338d3105SPierre Jolivet     /* F is assembled by a previous call of MatLUFactorSymbolic_BAIJMUMPS() */
23303ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2331d47f36abSHong Zhang   }
2332dcd589f8SShri Abhyankar 
23339a2535b5SHong Zhang   /* Set MUMPS options from the options database */
233426cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2335dcd589f8SShri Abhyankar 
23369566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23379566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
233867877ebaSShri Abhyankar 
233967877ebaSShri Abhyankar   /* analysis phase */
2340a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2341a5e57a09SHong Zhang   mumps->id.n   = M;
2342a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
234367877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2344a5e57a09SHong Zhang     if (!mumps->myid) {
2345a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2346a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2347a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2348ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
234967877ebaSShri Abhyankar     }
235067877ebaSShri Abhyankar     break;
235167877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2352a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2353a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2354a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2355ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
235625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
23579566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23589566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23599566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
236025aac85cSJunchao Zhang     }
236167877ebaSShri Abhyankar     break;
236267877ebaSShri Abhyankar   }
23633ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23649566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
236567877ebaSShri Abhyankar 
2366450b117fSShri Abhyankar   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2367dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
236851d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
2369b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2370d47f36abSHong Zhang 
2371d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2373450b117fSShri Abhyankar }
2374b24902e0SBarry Smith 
2375141f4205SHong Zhang /* Note the Petsc r permutation and factor info are ignored */
237666976f2fSJacob Faibussowitsch static PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F, Mat A, IS r, const MatFactorInfo *info)
2377d71ae5a4SJacob Faibussowitsch {
2378e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
237967877ebaSShri Abhyankar   Vec            b;
238067877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2381397b6df1SKris Buschelman 
2382397b6df1SKris Buschelman   PetscFunctionBegin;
2383d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2384338d3105SPierre Jolivet     /* F is assembled by a previous call of MatCholeskyFactorSymbolic_MUMPS() */
23853ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2386d47f36abSHong Zhang   }
2387dcd589f8SShri Abhyankar 
23889a2535b5SHong Zhang   /* Set MUMPS options from the options database */
238926cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2390dcd589f8SShri Abhyankar 
23919566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23929566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2393dcd589f8SShri Abhyankar 
239467877ebaSShri Abhyankar   /* analysis phase */
2395a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2396a5e57a09SHong Zhang   mumps->id.n   = M;
2397a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
239867877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2399a5e57a09SHong Zhang     if (!mumps->myid) {
2400a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2401a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2402a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2403ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
240467877ebaSShri Abhyankar     }
240567877ebaSShri Abhyankar     break;
240667877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2407a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2408a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2409a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2410ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
241125aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
24129566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
24139566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
24149566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
241525aac85cSJunchao Zhang     }
241667877ebaSShri Abhyankar     break;
241767877ebaSShri Abhyankar   }
24183ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
24199566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
24205cd7cf9dSHong Zhang 
24212792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2422dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
242351d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
24244e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
242523a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
2426b18964edSHong Zhang   F->ops->matsolvetranspose     = MatMatSolveTranspose_MUMPS;
24274e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
24280298fd71SBarry Smith   F->ops->getinertia = NULL;
24294e34a73bSHong Zhang #else
24304e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2431db4efbfdSBarry Smith #endif
2432d47f36abSHong Zhang 
2433d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
24343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2435b24902e0SBarry Smith }
2436b24902e0SBarry Smith 
243766976f2fSJacob Faibussowitsch static PetscErrorCode MatView_MUMPS(Mat A, PetscViewer viewer)
2438d71ae5a4SJacob Faibussowitsch {
243964e6c443SBarry Smith   PetscBool         iascii;
244064e6c443SBarry Smith   PetscViewerFormat format;
2441e69c285eSBarry Smith   Mat_MUMPS        *mumps = (Mat_MUMPS *)A->data;
2442f6c57405SHong Zhang 
2443f6c57405SHong Zhang   PetscFunctionBegin;
244464e6c443SBarry Smith   /* check if matrix is mumps type */
24453ba16761SJacob Faibussowitsch   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(PETSC_SUCCESS);
244664e6c443SBarry Smith 
24479566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
244864e6c443SBarry Smith   if (iascii) {
24499566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
24501511cd71SPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
24519566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "MUMPS run parameters:\n"));
24521511cd71SPierre Jolivet       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
24539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  SYM (matrix type):                   %d\n", mumps->id.sym));
24549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  PAR (host participation):            %d\n", mumps->id.par));
24559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(1) (output for error):         %d\n", mumps->id.ICNTL(1)));
24569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(2) (output of diagnostic msg): %d\n", mumps->id.ICNTL(2)));
24579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(3) (output for global info):   %d\n", mumps->id.ICNTL(3)));
24589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(4) (level of printing):        %d\n", mumps->id.ICNTL(4)));
24599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(5) (input mat struct):         %d\n", mumps->id.ICNTL(5)));
24609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(6) (matrix prescaling):        %d\n", mumps->id.ICNTL(6)));
24619566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(7) (sequential matrix ordering):%d\n", mumps->id.ICNTL(7)));
24629566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(8) (scaling strategy):         %d\n", mumps->id.ICNTL(8)));
24639566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(10) (max num of refinements):  %d\n", mumps->id.ICNTL(10)));
24649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(11) (error analysis):          %d\n", mumps->id.ICNTL(11)));
2465a5e57a09SHong Zhang         if (mumps->id.ICNTL(11) > 0) {
24669566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(4) (inf norm of input mat):        %g\n", mumps->id.RINFOG(4)));
24679566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(5) (inf norm of solution):         %g\n", mumps->id.RINFOG(5)));
24689566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(6) (inf norm of residual):         %g\n", mumps->id.RINFOG(6)));
24699566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n", mumps->id.RINFOG(7), mumps->id.RINFOG(8)));
24709566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(9) (error estimate):               %g\n", mumps->id.RINFOG(9)));
24719566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n", mumps->id.RINFOG(10), mumps->id.RINFOG(11)));
2472f6c57405SHong Zhang         }
24739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(12) (efficiency control):                         %d\n", mumps->id.ICNTL(12)));
24749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(13) (sequential factorization of the root node):  %d\n", mumps->id.ICNTL(13)));
24759566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(14) (percentage of estimated workspace increase): %d\n", mumps->id.ICNTL(14)));
247645e3843bSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(15) (compression of the input matrix):            %d\n", mumps->id.ICNTL(15)));
2477f6c57405SHong Zhang         /* ICNTL(15-17) not used */
24789566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(18) (input mat struct):                           %d\n", mumps->id.ICNTL(18)));
24799566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(19) (Schur complement info):                      %d\n", mumps->id.ICNTL(19)));
24809566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(20) (RHS sparse pattern):                         %d\n", mumps->id.ICNTL(20)));
24819566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(21) (solution struct):                            %d\n", mumps->id.ICNTL(21)));
24829566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(22) (in-core/out-of-core facility):               %d\n", mumps->id.ICNTL(22)));
24839566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(23) (max size of memory can be allocated locally):%d\n", mumps->id.ICNTL(23)));
2484c0165424SHong Zhang 
24859566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(24) (detection of null pivot rows):               %d\n", mumps->id.ICNTL(24)));
24869566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(25) (computation of a null space basis):          %d\n", mumps->id.ICNTL(25)));
24879566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(26) (Schur options for RHS or solution):          %d\n", mumps->id.ICNTL(26)));
24889566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(27) (blocking size for multiple RHS):             %d\n", mumps->id.ICNTL(27)));
24899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(28) (use parallel or sequential ordering):        %d\n", mumps->id.ICNTL(28)));
24909566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(29) (parallel ordering):                          %d\n", mumps->id.ICNTL(29)));
249142179a6aSHong Zhang 
24929566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n", mumps->id.ICNTL(30)));
24939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(31) (factors is discarded in the solve phase):    %d\n", mumps->id.ICNTL(31)));
24949566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(33) (compute determinant):                        %d\n", mumps->id.ICNTL(33)));
24959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(35) (activate BLR based factorization):           %d\n", mumps->id.ICNTL(35)));
24969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(36) (choice of BLR factorization variant):        %d\n", mumps->id.ICNTL(36)));
24979566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(38) (estimated compression rate of LU factors):   %d\n", mumps->id.ICNTL(38)));
2498146931dbSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(58) (options for symbolic factorization):         %d\n", mumps->id.ICNTL(58)));
2499f6c57405SHong Zhang 
25009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(1) (relative pivoting threshold):      %g\n", mumps->id.CNTL(1)));
25019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(2) (stopping criterion of refinement): %g\n", mumps->id.CNTL(2)));
25029566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(3) (absolute pivoting threshold):      %g\n", mumps->id.CNTL(3)));
25039566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(4) (value of static pivoting):         %g\n", mumps->id.CNTL(4)));
25049566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(5) (fixation for null pivots):         %g\n", mumps->id.CNTL(5)));
25059566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(7) (dropping parameter for BLR):       %g\n", mumps->id.CNTL(7)));
2506f6c57405SHong Zhang 
2507a5b23f4aSJose E. Roman         /* information local to each processor */
25089566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis):\n"));
25099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushSynchronized(viewer));
25109566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(1)));
25119566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
25129566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization):\n"));
25139566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(2)));
25149566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
25159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization):\n"));
25169566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(3)));
25179566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2518f6c57405SHong Zhang 
25199566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization):\n"));
25209566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(15)));
25219566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2522f6c57405SHong Zhang 
25239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization):\n"));
25249566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(16)));
25259566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2526f6c57405SHong Zhang 
25279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization):\n"));
25289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(23)));
25299566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2530b34f08ffSHong Zhang 
2531a0e18203SThibaut Appel         if (mumps->ninfo && mumps->ninfo <= 80) {
2532b34f08ffSHong Zhang           PetscInt i;
2533b34f08ffSHong Zhang           for (i = 0; i < mumps->ninfo; i++) {
25349566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "):\n", mumps->info[i]));
25359566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(mumps->info[i])));
25369566063dSJacob Faibussowitsch             PetscCall(PetscViewerFlush(viewer));
2537b34f08ffSHong Zhang           }
2538b34f08ffSHong Zhang         }
25399566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopSynchronized(viewer));
25401511cd71SPierre Jolivet       } else PetscCall(PetscViewerASCIIPrintf(viewer, "  Use -%sksp_view ::ascii_info_detail to display information for all processes\n", ((PetscObject)A)->prefix ? ((PetscObject)A)->prefix : ""));
2541f6c57405SHong Zhang 
25421511cd71SPierre Jolivet       if (mumps->myid == 0) { /* information from the host */
25439566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(1) (global estimated flops for the elimination after analysis): %g\n", mumps->id.RINFOG(1)));
25449566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(2) (global estimated flops for the assembly after factorization): %g\n", mumps->id.RINFOG(2)));
25459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(3) (global estimated flops for the elimination after factorization): %g\n", mumps->id.RINFOG(3)));
25469566063dSJacob 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)));
2547f6c57405SHong Zhang 
25489566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(3)));
25499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(4)));
25509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(5) (estimated maximum front size in the complete tree): %d\n", mumps->id.INFOG(5)));
25519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(6) (number of nodes in the complete tree): %d\n", mumps->id.INFOG(6)));
25529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(7) (ordering option effectively used after analysis): %d\n", mumps->id.INFOG(7)));
25539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n", mumps->id.INFOG(8)));
25549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n", mumps->id.INFOG(9)));
25559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(10) (total integer space store the matrix factors after factorization): %d\n", mumps->id.INFOG(10)));
25569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(11) (order of largest frontal matrix after factorization): %d\n", mumps->id.INFOG(11)));
25579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(12) (number of off-diagonal pivots): %d\n", mumps->id.INFOG(12)));
25589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(13) (number of delayed pivots after factorization): %d\n", mumps->id.INFOG(13)));
25599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(14) (number of memory compress after factorization): %d\n", mumps->id.INFOG(14)));
25609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(15) (number of steps of iterative refinement after solution): %d\n", mumps->id.INFOG(15)));
25619566063dSJacob 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)));
25629566063dSJacob 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)));
25639566063dSJacob 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)));
25649566063dSJacob 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)));
25659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(20) (estimated number of entries in the factors): %d\n", mumps->id.INFOG(20)));
25669566063dSJacob 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)));
25679566063dSJacob 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)));
25689566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n", mumps->id.INFOG(23)));
25699566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n", mumps->id.INFOG(24)));
25709566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n", mumps->id.INFOG(25)));
25719566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(28) (after factorization: number of null pivots encountered): %d\n", mumps->id.INFOG(28)));
25729566063dSJacob 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)));
25739566063dSJacob 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)));
25749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(32) (after analysis: type of analysis done): %d\n", mumps->id.INFOG(32)));
25759566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(33) (value used for ICNTL(8)): %d\n", mumps->id.INFOG(33)));
25769566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(34) (exponent of the determinant if determinant is requested): %d\n", mumps->id.INFOG(34)));
25779566063dSJacob 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)));
25789566063dSJacob 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)));
25799566063dSJacob 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)));
25809566063dSJacob 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)));
25819566063dSJacob 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)));
2582f6c57405SHong Zhang       }
2583f6c57405SHong Zhang     }
2584cb828f0fSHong Zhang   }
25853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2586f6c57405SHong Zhang }
2587f6c57405SHong Zhang 
258866976f2fSJacob Faibussowitsch static PetscErrorCode MatGetInfo_MUMPS(Mat A, MatInfoType flag, MatInfo *info)
2589d71ae5a4SJacob Faibussowitsch {
2590e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
259135bd34faSBarry Smith 
259235bd34faSBarry Smith   PetscFunctionBegin;
259335bd34faSBarry Smith   info->block_size        = 1.0;
259464412097SPierre Jolivet   info->nz_allocated      = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
259564412097SPierre Jolivet   info->nz_used           = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
259635bd34faSBarry Smith   info->nz_unneeded       = 0.0;
259735bd34faSBarry Smith   info->assemblies        = 0.0;
259835bd34faSBarry Smith   info->mallocs           = 0.0;
259935bd34faSBarry Smith   info->memory            = 0.0;
260035bd34faSBarry Smith   info->fill_ratio_given  = 0;
260135bd34faSBarry Smith   info->fill_ratio_needed = 0;
260235bd34faSBarry Smith   info->factor_mallocs    = 0;
26033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
260435bd34faSBarry Smith }
260535bd34faSBarry Smith 
260666976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
2607d71ae5a4SJacob Faibussowitsch {
2608e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)F->data;
2609a3d589ffSStefano Zampini   const PetscScalar *arr;
26108e7ba810SStefano Zampini   const PetscInt    *idxs;
26118e7ba810SStefano Zampini   PetscInt           size, i;
26126444a565SStefano Zampini 
26136444a565SStefano Zampini   PetscFunctionBegin;
26149566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &size));
2615b3cb21ddSStefano Zampini   /* Schur complement matrix */
26169566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
26179566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, size, size, NULL, &F->schur));
26189566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur, &arr));
2619a3d589ffSStefano Zampini   mumps->id.schur      = (MumpsScalar *)arr;
2620a3d589ffSStefano Zampini   mumps->id.size_schur = size;
2621a3d589ffSStefano Zampini   mumps->id.schur_lld  = size;
26229566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur, &arr));
262348a46eb9SPierre Jolivet   if (mumps->sym == 1) PetscCall(MatSetOption(F->schur, MAT_SPD, PETSC_TRUE));
2624b3cb21ddSStefano Zampini 
2625b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
26269566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
26279566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &mumps->id.listvar_schur));
26289566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &idxs));
26299566063dSJacob Faibussowitsch   for (i = 0; i < size; i++) PetscCall(PetscMUMPSIntCast(idxs[i] + 1, &(mumps->id.listvar_schur[i])));
26309566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &idxs));
263159ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2632b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
26333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26346444a565SStefano Zampini }
263559ac8732SStefano Zampini 
263666976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F, Mat *S)
2637d71ae5a4SJacob Faibussowitsch {
26386444a565SStefano Zampini   Mat          St;
2639e69c285eSBarry Smith   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
26406444a565SStefano Zampini   PetscScalar *array;
26416444a565SStefano Zampini 
26426444a565SStefano Zampini   PetscFunctionBegin;
26439261f6e4SBarry Smith   PetscCheck(mumps->id.ICNTL(19), PetscObjectComm((PetscObject)F), PETSC_ERR_ORDER, "Schur complement mode not selected! Call MatFactorSetSchurIS() to enable it");
26449566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF, &St));
26459566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St, PETSC_DECIDE, PETSC_DECIDE, mumps->id.size_schur, mumps->id.size_schur));
26469566063dSJacob Faibussowitsch   PetscCall(MatSetType(St, MATDENSE));
26479566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
26489566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St, &array));
264959ac8732SStefano Zampini   if (!mumps->sym) {                /* MUMPS always return a full matrix */
26506444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
26516444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26526444a565SStefano Zampini       for (i = 0; i < N; i++) {
26536444a565SStefano Zampini         for (j = 0; j < N; j++) {
26546444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26556444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26566444a565SStefano Zampini #else
26573e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26586444a565SStefano Zampini #endif
26596444a565SStefano Zampini           array[j * N + i] = val;
26606444a565SStefano Zampini         }
26616444a565SStefano Zampini       }
26626444a565SStefano Zampini     } else { /* stored by columns */
26639566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26646444a565SStefano Zampini     }
26656444a565SStefano Zampini   } else {                          /* either full or lower-triangular (not packed) */
26666444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
26676444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26686444a565SStefano Zampini       for (i = 0; i < N; i++) {
26696444a565SStefano Zampini         for (j = i; j < N; j++) {
26706444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26716444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26726444a565SStefano Zampini #else
26733e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26746444a565SStefano Zampini #endif
26753e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
26766444a565SStefano Zampini         }
26776444a565SStefano Zampini       }
26786444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
26799566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26806444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular stored by rows */
26816444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26826444a565SStefano Zampini       for (i = 0; i < N; i++) {
26836444a565SStefano Zampini         for (j = 0; j < i + 1; j++) {
26846444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26856444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26866444a565SStefano Zampini #else
26873e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26886444a565SStefano Zampini #endif
26893e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
26906444a565SStefano Zampini         }
26916444a565SStefano Zampini       }
26926444a565SStefano Zampini     }
26936444a565SStefano Zampini   }
26949566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St, &array));
26956444a565SStefano Zampini   *S = St;
26963ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26976444a565SStefano Zampini }
26986444a565SStefano Zampini 
269966976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt ival)
2700d71ae5a4SJacob Faibussowitsch {
2701e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
27025ccb76cbSHong Zhang 
27035ccb76cbSHong Zhang   PetscFunctionBegin;
2704413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {                                       /* need to cache icntl and ival since PetscMUMPS_c() has never been called */
2705413bcc21SPierre Jolivet     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0; /* number of already cached ICNTL */
27069371c9d4SSatish Balay     for (i = 0; i < nICNTL_pre; ++i)
27079371c9d4SSatish Balay       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) break; /* is this ICNTL already cached? */
2708413bcc21SPierre Jolivet     if (i == nICNTL_pre) {                             /* not already cached */
2709413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscMUMPSInt) * (2 * nICNTL_pre + 3), &mumps->ICNTL_pre));
2710413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscMUMPSInt) * 3, &mumps->ICNTL_pre));
2711413bcc21SPierre Jolivet       mumps->ICNTL_pre[0]++;
2712413bcc21SPierre Jolivet     }
2713413bcc21SPierre Jolivet     mumps->ICNTL_pre[1 + 2 * i] = icntl;
2714413bcc21SPierre Jolivet     PetscCall(PetscMUMPSIntCast(ival, mumps->ICNTL_pre + 2 + 2 * i));
2715413bcc21SPierre Jolivet   } else PetscCall(PetscMUMPSIntCast(ival, &mumps->id.ICNTL(icntl)));
27163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27175ccb76cbSHong Zhang }
27185ccb76cbSHong Zhang 
271966976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt *ival)
2720d71ae5a4SJacob Faibussowitsch {
2721e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2722bc6112feSHong Zhang 
2723bc6112feSHong Zhang   PetscFunctionBegin;
272436df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
272536df9881Sjeremy theler     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
272636df9881Sjeremy theler     *ival = 0;
272736df9881Sjeremy theler     for (i = 0; i < nICNTL_pre; ++i) {
272836df9881Sjeremy theler       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) *ival = mumps->ICNTL_pre[2 + 2 * i];
272936df9881Sjeremy theler     }
273036df9881Sjeremy theler   } else *ival = mumps->id.ICNTL(icntl);
27313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2732bc6112feSHong Zhang }
2733bc6112feSHong Zhang 
27345ccb76cbSHong Zhang /*@
27355ccb76cbSHong Zhang   MatMumpsSetIcntl - Set MUMPS parameter ICNTL()
27365ccb76cbSHong Zhang 
2737c3339decSBarry Smith   Logically Collective
27385ccb76cbSHong Zhang 
27395ccb76cbSHong Zhang   Input Parameters:
274011a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
27415ccb76cbSHong Zhang . icntl - index of MUMPS parameter array ICNTL()
27425ccb76cbSHong Zhang - ival  - value of MUMPS ICNTL(icntl)
27435ccb76cbSHong Zhang 
27443c7db156SBarry Smith   Options Database Key:
2745147403d9SBarry Smith . -mat_mumps_icntl_<icntl> <ival> - change the option numbered icntl to ival
27465ccb76cbSHong Zhang 
27475ccb76cbSHong Zhang   Level: beginner
27485ccb76cbSHong Zhang 
274996a0c994SBarry Smith   References:
2750606c0280SSatish Balay .  * - MUMPS Users' Guide
27515ccb76cbSHong Zhang 
27521cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
27535ccb76cbSHong Zhang @*/
2754d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl(Mat F, PetscInt icntl, PetscInt ival)
2755d71ae5a4SJacob Faibussowitsch {
27565ccb76cbSHong Zhang   PetscFunctionBegin;
27572989dfd4SHong Zhang   PetscValidType(F, 1);
275828b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
27595ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27605ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, ival, 3);
2761146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2762cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetIcntl_C", (Mat, PetscInt, PetscInt), (F, icntl, ival));
27633ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27645ccb76cbSHong Zhang }
27655ccb76cbSHong Zhang 
2766a21f80fcSHong Zhang /*@
2767a21f80fcSHong Zhang   MatMumpsGetIcntl - Get MUMPS parameter ICNTL()
2768a21f80fcSHong Zhang 
2769c3339decSBarry Smith   Logically Collective
2770a21f80fcSHong Zhang 
2771a21f80fcSHong Zhang   Input Parameters:
277211a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2773a21f80fcSHong Zhang - icntl - index of MUMPS parameter array ICNTL()
2774a21f80fcSHong Zhang 
2775a21f80fcSHong Zhang   Output Parameter:
2776a21f80fcSHong Zhang . ival - value of MUMPS ICNTL(icntl)
2777a21f80fcSHong Zhang 
2778a21f80fcSHong Zhang   Level: beginner
2779a21f80fcSHong Zhang 
278096a0c994SBarry Smith   References:
2781606c0280SSatish Balay .  * - MUMPS Users' Guide
2782a21f80fcSHong Zhang 
27831cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2784a21f80fcSHong Zhang @*/
2785d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl(Mat F, PetscInt icntl, PetscInt *ival)
2786d71ae5a4SJacob Faibussowitsch {
2787bc6112feSHong Zhang   PetscFunctionBegin;
27882989dfd4SHong Zhang   PetscValidType(F, 1);
278928b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2790bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27914f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
2792146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2793cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetIcntl_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
27943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2795bc6112feSHong Zhang }
2796bc6112feSHong Zhang 
279766976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal val)
2798d71ae5a4SJacob Faibussowitsch {
2799e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
28008928b65cSHong Zhang 
28018928b65cSHong Zhang   PetscFunctionBegin;
2802413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {
2803413bcc21SPierre Jolivet     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
28049371c9d4SSatish Balay     for (i = 0; i < nCNTL_pre; ++i)
28059371c9d4SSatish Balay       if (mumps->CNTL_pre[1 + 2 * i] == icntl) break;
2806413bcc21SPierre Jolivet     if (i == nCNTL_pre) {
2807413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscReal) * (2 * nCNTL_pre + 3), &mumps->CNTL_pre));
2808413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscReal) * 3, &mumps->CNTL_pre));
2809413bcc21SPierre Jolivet       mumps->CNTL_pre[0]++;
2810413bcc21SPierre Jolivet     }
2811413bcc21SPierre Jolivet     mumps->CNTL_pre[1 + 2 * i] = icntl;
2812413bcc21SPierre Jolivet     mumps->CNTL_pre[2 + 2 * i] = val;
2813413bcc21SPierre Jolivet   } else mumps->id.CNTL(icntl) = val;
28143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28158928b65cSHong Zhang }
28168928b65cSHong Zhang 
281766976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal *val)
2818d71ae5a4SJacob Faibussowitsch {
2819e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2820bc6112feSHong Zhang 
2821bc6112feSHong Zhang   PetscFunctionBegin;
282236df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
282336df9881Sjeremy theler     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
282436df9881Sjeremy theler     *val = 0.0;
282536df9881Sjeremy theler     for (i = 0; i < nCNTL_pre; ++i) {
282636df9881Sjeremy theler       if (mumps->CNTL_pre[1 + 2 * i] == icntl) *val = mumps->CNTL_pre[2 + 2 * i];
282736df9881Sjeremy theler     }
282836df9881Sjeremy theler   } else *val = mumps->id.CNTL(icntl);
28293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2830bc6112feSHong Zhang }
2831bc6112feSHong Zhang 
28328928b65cSHong Zhang /*@
28338928b65cSHong Zhang   MatMumpsSetCntl - Set MUMPS parameter CNTL()
28348928b65cSHong Zhang 
2835c3339decSBarry Smith   Logically Collective
28368928b65cSHong Zhang 
28378928b65cSHong Zhang   Input Parameters:
283811a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
28398928b65cSHong Zhang . icntl - index of MUMPS parameter array CNTL()
28408928b65cSHong Zhang - val   - value of MUMPS CNTL(icntl)
28418928b65cSHong Zhang 
28423c7db156SBarry Smith   Options Database Key:
2843147403d9SBarry Smith . -mat_mumps_cntl_<icntl> <val> - change the option numbered icntl to ival
28448928b65cSHong Zhang 
28458928b65cSHong Zhang   Level: beginner
28468928b65cSHong Zhang 
284796a0c994SBarry Smith   References:
2848606c0280SSatish Balay .  * - MUMPS Users' Guide
28498928b65cSHong Zhang 
28501cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
28518928b65cSHong Zhang @*/
2852d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl(Mat F, PetscInt icntl, PetscReal val)
2853d71ae5a4SJacob Faibussowitsch {
28548928b65cSHong Zhang   PetscFunctionBegin;
28552989dfd4SHong Zhang   PetscValidType(F, 1);
285628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
28578928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2858bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F, val, 3);
2859413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2860cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetCntl_C", (Mat, PetscInt, PetscReal), (F, icntl, val));
28613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28628928b65cSHong Zhang }
28638928b65cSHong Zhang 
2864a21f80fcSHong Zhang /*@
2865a21f80fcSHong Zhang   MatMumpsGetCntl - Get MUMPS parameter CNTL()
2866a21f80fcSHong Zhang 
2867c3339decSBarry Smith   Logically Collective
2868a21f80fcSHong Zhang 
2869a21f80fcSHong Zhang   Input Parameters:
287011a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2871a21f80fcSHong Zhang - icntl - index of MUMPS parameter array CNTL()
2872a21f80fcSHong Zhang 
2873a21f80fcSHong Zhang   Output Parameter:
2874a21f80fcSHong Zhang . val - value of MUMPS CNTL(icntl)
2875a21f80fcSHong Zhang 
2876a21f80fcSHong Zhang   Level: beginner
2877a21f80fcSHong Zhang 
287896a0c994SBarry Smith   References:
2879606c0280SSatish Balay .  * - MUMPS Users' Guide
2880a21f80fcSHong Zhang 
28811cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2882a21f80fcSHong Zhang @*/
2883d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl(Mat F, PetscInt icntl, PetscReal *val)
2884d71ae5a4SJacob Faibussowitsch {
2885bc6112feSHong Zhang   PetscFunctionBegin;
28862989dfd4SHong Zhang   PetscValidType(F, 1);
288728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2888bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
28894f572ea9SToby Isaac   PetscAssertPointer(val, 3);
2890413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2891cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetCntl_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
28923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2893bc6112feSHong Zhang }
2894bc6112feSHong Zhang 
289566976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F, PetscInt icntl, PetscInt *info)
2896d71ae5a4SJacob Faibussowitsch {
2897e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2898bc6112feSHong Zhang 
2899bc6112feSHong Zhang   PetscFunctionBegin;
2900bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
29013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2902bc6112feSHong Zhang }
2903bc6112feSHong Zhang 
290466976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F, PetscInt icntl, PetscInt *infog)
2905d71ae5a4SJacob Faibussowitsch {
2906e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2907bc6112feSHong Zhang 
2908bc6112feSHong Zhang   PetscFunctionBegin;
2909bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
29103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2911bc6112feSHong Zhang }
2912bc6112feSHong Zhang 
291366976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfo)
2914d71ae5a4SJacob Faibussowitsch {
2915e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2916bc6112feSHong Zhang 
2917bc6112feSHong Zhang   PetscFunctionBegin;
2918bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
29193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2920bc6112feSHong Zhang }
2921bc6112feSHong Zhang 
292266976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfog)
2923d71ae5a4SJacob Faibussowitsch {
2924e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2925bc6112feSHong Zhang 
2926bc6112feSHong Zhang   PetscFunctionBegin;
2927bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
29283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2929bc6112feSHong Zhang }
2930bc6112feSHong Zhang 
293166976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetNullPivots_MUMPS(Mat F, PetscInt *size, PetscInt **array)
29325c0bae8cSAshish Patel {
29335c0bae8cSAshish Patel   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
29345c0bae8cSAshish Patel 
29355c0bae8cSAshish Patel   PetscFunctionBegin;
29365c0bae8cSAshish 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");
29375c0bae8cSAshish Patel   *size  = 0;
29385c0bae8cSAshish Patel   *array = NULL;
29395c0bae8cSAshish Patel   if (!mumps->myid) {
29405c0bae8cSAshish Patel     *size = mumps->id.INFOG(28);
29415c0bae8cSAshish Patel     PetscCall(PetscMalloc1(*size, array));
29425c0bae8cSAshish Patel     for (int i = 0; i < *size; i++) (*array)[i] = mumps->id.pivnul_list[i] - 1;
29435c0bae8cSAshish Patel   }
29445c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
29455c0bae8cSAshish Patel }
29465c0bae8cSAshish Patel 
294766976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F, Mat spRHS)
2948d71ae5a4SJacob Faibussowitsch {
29490e6b8875SHong Zhang   Mat          Bt = NULL, Btseq = NULL;
29500e6b8875SHong Zhang   PetscBool    flg;
2951bb599dfdSHong Zhang   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
2952bb599dfdSHong Zhang   PetscScalar *aa;
2953f410b75aSHong Zhang   PetscInt     spnr, *ia, *ja, M, nrhs;
2954bb599dfdSHong Zhang 
2955bb599dfdSHong Zhang   PetscFunctionBegin;
29564f572ea9SToby Isaac   PetscAssertPointer(spRHS, 2);
2957013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS, MATTRANSPOSEVIRTUAL, &flg));
29580e6b8875SHong Zhang   if (flg) {
29599566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(spRHS, &Bt));
2960013e2dc7SBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)spRHS), PETSC_ERR_ARG_WRONG, "Matrix spRHS must be type MATTRANSPOSEVIRTUAL matrix");
2961bb599dfdSHong Zhang 
29629566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F, 30, 1));
2963bb599dfdSHong Zhang 
29642d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
29650e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ *)Bt->data;
29660e6b8875SHong Zhang     Btseq         = b->A;
29670e6b8875SHong Zhang   } else {
29680e6b8875SHong Zhang     Btseq = Bt;
29690e6b8875SHong Zhang   }
29700e6b8875SHong Zhang 
29719566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS, &M, &nrhs));
2972f410b75aSHong Zhang   mumps->id.nrhs = nrhs;
2973f410b75aSHong Zhang   mumps->id.lrhs = M;
2974f410b75aSHong Zhang   mumps->id.rhs  = NULL;
2975f410b75aSHong Zhang 
2976e3f2db6aSHong Zhang   if (!mumps->myid) {
29779566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq, &aa));
29789566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
297928b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
29809566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
2981bb599dfdSHong Zhang     mumps->id.rhs_sparse = (MumpsScalar *)aa;
2982e3f2db6aSHong Zhang   } else {
2983e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
2984e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
2985e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
2986e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
2987e3f2db6aSHong Zhang   }
2988bb599dfdSHong Zhang   mumps->id.ICNTL(20) = 1; /* rhs is sparse */
2989e3f2db6aSHong Zhang   mumps->id.ICNTL(21) = 0; /* solution is in assembled centralized format */
2990bb599dfdSHong Zhang 
2991bb599dfdSHong Zhang   /* solve phase */
2992bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
29933ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
29949261f6e4SBarry Smith   PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in solve: INFOG(1)=%d INFO(2)=%d " MUMPS_MANUALS, mumps->id.INFOG(1), mumps->id.INFO(2));
299514267174SHong Zhang 
2996e3f2db6aSHong Zhang   if (!mumps->myid) {
29979566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq, &aa));
29989566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
299928b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
3000e3f2db6aSHong Zhang   }
30013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3002bb599dfdSHong Zhang }
3003bb599dfdSHong Zhang 
3004bb599dfdSHong Zhang /*@
30052ef1f0ffSBarry Smith   MatMumpsGetInverse - Get user-specified set of entries in inverse of `A`
3006bb599dfdSHong Zhang 
3007c3339decSBarry Smith   Logically Collective
3008bb599dfdSHong Zhang 
300920f4b53cSBarry Smith   Input Parameter:
301020f4b53cSBarry Smith . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3011bb599dfdSHong Zhang 
3012bb599dfdSHong Zhang   Output Parameter:
301320f4b53cSBarry Smith . spRHS - sequential sparse matrix in `MATTRANSPOSEVIRTUAL` format with requested entries of inverse of `A`
3014bb599dfdSHong Zhang 
3015bb599dfdSHong Zhang   Level: beginner
3016bb599dfdSHong Zhang 
3017bb599dfdSHong Zhang   References:
3018606c0280SSatish Balay .  * - MUMPS Users' Guide
3019bb599dfdSHong Zhang 
30201cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`
3021bb599dfdSHong Zhang @*/
3022d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse(Mat F, Mat spRHS)
3023d71ae5a4SJacob Faibussowitsch {
3024bb599dfdSHong Zhang   PetscFunctionBegin;
3025bb599dfdSHong Zhang   PetscValidType(F, 1);
302628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
3027cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverse_C", (Mat, Mat), (F, spRHS));
30283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3029bb599dfdSHong Zhang }
3030bb599dfdSHong Zhang 
303166976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F, Mat spRHST)
3032d71ae5a4SJacob Faibussowitsch {
30330e6b8875SHong Zhang   Mat spRHS;
30340e6b8875SHong Zhang 
30350e6b8875SHong Zhang   PetscFunctionBegin;
30369566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST, &spRHS));
30379566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F, spRHS));
30389566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
30393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30400e6b8875SHong Zhang }
30410e6b8875SHong Zhang 
30420e6b8875SHong Zhang /*@
30432ef1f0ffSBarry Smith   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix `A`^T
30440e6b8875SHong Zhang 
3045c3339decSBarry Smith   Logically Collective
30460e6b8875SHong Zhang 
304720f4b53cSBarry Smith   Input Parameter:
304820f4b53cSBarry Smith . F - the factored matrix of A obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
30490e6b8875SHong Zhang 
30500e6b8875SHong Zhang   Output Parameter:
305120f4b53cSBarry Smith . spRHST - sequential sparse matrix in `MATAIJ` format containing the requested entries of inverse of `A`^T
30520e6b8875SHong Zhang 
30530e6b8875SHong Zhang   Level: beginner
30540e6b8875SHong Zhang 
30550e6b8875SHong Zhang   References:
3056606c0280SSatish Balay .  * - MUMPS Users' Guide
30570e6b8875SHong Zhang 
30581cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
30590e6b8875SHong Zhang @*/
3060d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose(Mat F, Mat spRHST)
3061d71ae5a4SJacob Faibussowitsch {
30620e6b8875SHong Zhang   PetscBool flg;
30630e6b8875SHong Zhang 
30640e6b8875SHong Zhang   PetscFunctionBegin;
30650e6b8875SHong Zhang   PetscValidType(F, 1);
306628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30679566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
306828b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)spRHST), PETSC_ERR_ARG_WRONG, "Matrix spRHST must be MATAIJ matrix");
30690e6b8875SHong Zhang 
3070cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverseTranspose_C", (Mat, Mat), (F, spRHST));
30713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30720e6b8875SHong Zhang }
30730e6b8875SHong Zhang 
3074a21f80fcSHong Zhang /*@
3075a21f80fcSHong Zhang   MatMumpsGetInfo - Get MUMPS parameter INFO()
3076a21f80fcSHong Zhang 
3077c3339decSBarry Smith   Logically Collective
3078a21f80fcSHong Zhang 
3079a21f80fcSHong Zhang   Input Parameters:
308011a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3081a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFO()
3082a21f80fcSHong Zhang 
3083a21f80fcSHong Zhang   Output Parameter:
3084a21f80fcSHong Zhang . ival - value of MUMPS INFO(icntl)
3085a21f80fcSHong Zhang 
3086a21f80fcSHong Zhang   Level: beginner
3087a21f80fcSHong Zhang 
308896a0c994SBarry Smith   References:
3089606c0280SSatish Balay .  * - MUMPS Users' Guide
3090a21f80fcSHong Zhang 
30911cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3092a21f80fcSHong Zhang @*/
3093d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo(Mat F, PetscInt icntl, PetscInt *ival)
3094d71ae5a4SJacob Faibussowitsch {
3095bc6112feSHong Zhang   PetscFunctionBegin;
30962989dfd4SHong Zhang   PetscValidType(F, 1);
309728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30984f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3099cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfo_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
31003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3101bc6112feSHong Zhang }
3102bc6112feSHong Zhang 
3103a21f80fcSHong Zhang /*@
3104a21f80fcSHong Zhang   MatMumpsGetInfog - Get MUMPS parameter INFOG()
3105a21f80fcSHong Zhang 
3106c3339decSBarry Smith   Logically Collective
3107a21f80fcSHong Zhang 
3108a21f80fcSHong Zhang   Input Parameters:
310911a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3110a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFOG()
3111a21f80fcSHong Zhang 
3112a21f80fcSHong Zhang   Output Parameter:
3113a21f80fcSHong Zhang . ival - value of MUMPS INFOG(icntl)
3114a21f80fcSHong Zhang 
3115a21f80fcSHong Zhang   Level: beginner
3116a21f80fcSHong Zhang 
311796a0c994SBarry Smith   References:
3118606c0280SSatish Balay .  * - MUMPS Users' Guide
3119a21f80fcSHong Zhang 
31201cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3121a21f80fcSHong Zhang @*/
3122d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog(Mat F, PetscInt icntl, PetscInt *ival)
3123d71ae5a4SJacob Faibussowitsch {
3124bc6112feSHong Zhang   PetscFunctionBegin;
31252989dfd4SHong Zhang   PetscValidType(F, 1);
312628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31274f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3128cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfog_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
31293ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3130bc6112feSHong Zhang }
3131bc6112feSHong Zhang 
3132a21f80fcSHong Zhang /*@
3133a21f80fcSHong Zhang   MatMumpsGetRinfo - Get MUMPS parameter RINFO()
3134a21f80fcSHong Zhang 
3135c3339decSBarry Smith   Logically Collective
3136a21f80fcSHong Zhang 
3137a21f80fcSHong Zhang   Input Parameters:
313811a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3139a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFO()
3140a21f80fcSHong Zhang 
3141a21f80fcSHong Zhang   Output Parameter:
3142a21f80fcSHong Zhang . val - value of MUMPS RINFO(icntl)
3143a21f80fcSHong Zhang 
3144a21f80fcSHong Zhang   Level: beginner
3145a21f80fcSHong Zhang 
314696a0c994SBarry Smith   References:
3147606c0280SSatish Balay .  * - MUMPS Users' Guide
3148a21f80fcSHong Zhang 
31491cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
3150a21f80fcSHong Zhang @*/
3151d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo(Mat F, PetscInt icntl, PetscReal *val)
3152d71ae5a4SJacob Faibussowitsch {
3153bc6112feSHong Zhang   PetscFunctionBegin;
31542989dfd4SHong Zhang   PetscValidType(F, 1);
315528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31564f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3157cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfo_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3159bc6112feSHong Zhang }
3160bc6112feSHong Zhang 
3161a21f80fcSHong Zhang /*@
3162a21f80fcSHong Zhang   MatMumpsGetRinfog - Get MUMPS parameter RINFOG()
3163a21f80fcSHong Zhang 
3164c3339decSBarry Smith   Logically Collective
3165a21f80fcSHong Zhang 
3166a21f80fcSHong Zhang   Input Parameters:
316711a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3168a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFOG()
3169a21f80fcSHong Zhang 
3170a21f80fcSHong Zhang   Output Parameter:
3171a21f80fcSHong Zhang . val - value of MUMPS RINFOG(icntl)
3172a21f80fcSHong Zhang 
3173a21f80fcSHong Zhang   Level: beginner
3174a21f80fcSHong Zhang 
317596a0c994SBarry Smith   References:
3176606c0280SSatish Balay .  * - MUMPS Users' Guide
3177a21f80fcSHong Zhang 
31781cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
3179a21f80fcSHong Zhang @*/
3180d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog(Mat F, PetscInt icntl, PetscReal *val)
3181d71ae5a4SJacob Faibussowitsch {
3182bc6112feSHong Zhang   PetscFunctionBegin;
31832989dfd4SHong Zhang   PetscValidType(F, 1);
318428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31854f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3186cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfog_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3188bc6112feSHong Zhang }
3189bc6112feSHong Zhang 
31905c0bae8cSAshish Patel /*@
31915c0bae8cSAshish Patel   MatMumpsGetNullPivots - Get MUMPS parameter PIVNUL_LIST()
31925c0bae8cSAshish Patel 
31935c0bae8cSAshish Patel   Logically Collective
31945c0bae8cSAshish Patel 
31955c0bae8cSAshish Patel   Input Parameter:
31965c0bae8cSAshish Patel . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
31975c0bae8cSAshish Patel 
31985c0bae8cSAshish Patel   Output Parameters:
31995c0bae8cSAshish Patel + size  - local size of the array. The size of the array is non-zero only on the host.
32005c0bae8cSAshish 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
32015c0bae8cSAshish Patel            for freeing this array.
32025c0bae8cSAshish Patel 
32035c0bae8cSAshish Patel   Level: beginner
32045c0bae8cSAshish Patel 
32055c0bae8cSAshish Patel   References:
32065c0bae8cSAshish Patel .  * - MUMPS Users' Guide
32075c0bae8cSAshish Patel 
32081cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
32095c0bae8cSAshish Patel @*/
32105c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots(Mat F, PetscInt *size, PetscInt **array)
32115c0bae8cSAshish Patel {
32125c0bae8cSAshish Patel   PetscFunctionBegin;
32135c0bae8cSAshish Patel   PetscValidType(F, 1);
32145c0bae8cSAshish Patel   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
32154f572ea9SToby Isaac   PetscAssertPointer(size, 2);
32164f572ea9SToby Isaac   PetscAssertPointer(array, 3);
32175c0bae8cSAshish Patel   PetscUseMethod(F, "MatMumpsGetNullPivots_C", (Mat, PetscInt *, PetscInt **), (F, size, array));
32185c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
32195c0bae8cSAshish Patel }
32205c0bae8cSAshish Patel 
322124b6179bSKris Buschelman /*MC
32222692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
322324b6179bSKris Buschelman   distributed and sequential matrices via the external package MUMPS.
322424b6179bSKris Buschelman 
322511a5261eSBarry Smith   Works with `MATAIJ` and `MATSBAIJ` matrices
322624b6179bSKris Buschelman 
3227c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
3228c2b89b5dSBarry Smith 
32292ef1f0ffSBarry 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.
32302ef1f0ffSBarry Smith   See details below.
3231217d3b1eSJunchao Zhang 
32322ef1f0ffSBarry Smith   Use `-pc_type cholesky` or `lu` `-pc_factor_mat_solver_type mumps` to use this direct solver
3233c2b89b5dSBarry Smith 
323424b6179bSKris Buschelman   Options Database Keys:
32354422a9fcSPatrick Sanan +  -mat_mumps_icntl_1 - ICNTL(1): output stream for error messages
32364422a9fcSPatrick Sanan .  -mat_mumps_icntl_2 - ICNTL(2): output stream for diagnostic printing, statistics, and warning
32374422a9fcSPatrick Sanan .  -mat_mumps_icntl_3 -  ICNTL(3): output stream for global information, collected on the host
32384422a9fcSPatrick Sanan .  -mat_mumps_icntl_4 -  ICNTL(4): level of printing (0 to 4)
32394422a9fcSPatrick Sanan .  -mat_mumps_icntl_6 - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
3240b53c1a7fSBarry 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
3241b53c1a7fSBarry Smith                         Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
32424422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
32434422a9fcSPatrick Sanan .  -mat_mumps_icntl_10  - ICNTL(10): max num of refinements
32444422a9fcSPatrick Sanan .  -mat_mumps_icntl_11  - ICNTL(11): statistics related to an error analysis (via -ksp_view)
32454422a9fcSPatrick Sanan .  -mat_mumps_icntl_12  - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
32464422a9fcSPatrick Sanan .  -mat_mumps_icntl_13  - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
32474422a9fcSPatrick Sanan .  -mat_mumps_icntl_14  - ICNTL(14): percentage increase in the estimated working space
324845e3843bSPierre Jolivet .  -mat_mumps_icntl_15  - ICNTL(15): compression of the input matrix resulting from a block format
32494422a9fcSPatrick Sanan .  -mat_mumps_icntl_19  - ICNTL(19): computes the Schur complement
325025aac85cSJunchao Zhang .  -mat_mumps_icntl_20  - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
32514422a9fcSPatrick Sanan .  -mat_mumps_icntl_22  - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
32524422a9fcSPatrick Sanan .  -mat_mumps_icntl_23  - ICNTL(23): max size of the working memory (MB) that can allocate per processor
32534422a9fcSPatrick Sanan .  -mat_mumps_icntl_24  - ICNTL(24): detection of null pivot rows (0 or 1)
32544422a9fcSPatrick Sanan .  -mat_mumps_icntl_25  - ICNTL(25): compute a solution of a deficient matrix and a null space basis
32554422a9fcSPatrick Sanan .  -mat_mumps_icntl_26  - ICNTL(26): drives the solution phase if a Schur complement matrix
32564422a9fcSPatrick 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
32574422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
32584422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
32594422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
32604422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
3261a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
3262a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
3263a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
3264146931dbSPierre Jolivet .  -mat_mumps_icntl_58 - ICNTL(58): options for symbolic factorization
32654422a9fcSPatrick Sanan .  -mat_mumps_cntl_1  - CNTL(1): relative pivoting threshold
32664422a9fcSPatrick Sanan .  -mat_mumps_cntl_2  -  CNTL(2): stopping criterion of refinement
32674422a9fcSPatrick Sanan .  -mat_mumps_cntl_3 - CNTL(3): absolute pivoting threshold
32684422a9fcSPatrick Sanan .  -mat_mumps_cntl_4 - CNTL(4): value for static pivoting
3269217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5 - CNTL(5): fixation for null pivots
3270a0e18203SThibaut Appel .  -mat_mumps_cntl_7 - CNTL(7): precision of the dropping parameter used during BLR factorization
3271217d3b1eSJunchao 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.
3272217d3b1eSJunchao Zhang                                    Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
327324b6179bSKris Buschelman 
327424b6179bSKris Buschelman   Level: beginner
327524b6179bSKris Buschelman 
327695452b02SPatrick Sanan     Notes:
32772ef1f0ffSBarry 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
32782ef1f0ffSBarry Smith     error if the matrix is Hermitian.
327938548759SBarry Smith 
328026cc229bSBarry 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
328126cc229bSBarry Smith     `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
328226cc229bSBarry Smith 
32832ef1f0ffSBarry 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
32842ef1f0ffSBarry Smith     the failure with
32852ef1f0ffSBarry Smith .vb
32862ef1f0ffSBarry Smith           KSPGetPC(ksp,&pc);
32872ef1f0ffSBarry Smith           PCFactorGetMatrix(pc,&mat);
32882ef1f0ffSBarry Smith           MatMumpsGetInfo(mat,....);
32892ef1f0ffSBarry Smith           MatMumpsGetInfog(mat,....); etc.
32902ef1f0ffSBarry Smith .ve
32912ef1f0ffSBarry Smith     Or run with `-ksp_error_if_not_converged` and the program will be stopped and the information printed in the error message.
32929fc87aa7SBarry Smith 
3293a5399872SJunchao Zhang     MUMPS provides 64-bit integer support in two build modes:
3294a5399872SJunchao Zhang       full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
3295a5399872SJunchao 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).
32968fcaa860SBarry Smith 
3297a5399872SJunchao 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,
3298a5399872SJunchao 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
3299a5399872SJunchao 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
3300a5399872SJunchao Zhang       integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
3301a5399872SJunchao Zhang 
3302a5399872SJunchao 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.
3303a5399872SJunchao Zhang 
3304a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
33052ef1f0ffSBarry Smith .vb
33062ef1f0ffSBarry Smith      Set OMP_NUM_THREADS and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
33072ef1f0ffSBarry Smith      threads per rank, then you may use "export OMP_NUM_THREADS=16 && mpirun -n 4 ./test".
33082ef1f0ffSBarry Smith .ve
33098fcaa860SBarry Smith 
33102ef1f0ffSBarry Smith .vb
33112ef1f0ffSBarry Smith      -mat_mumps_use_omp_threads [m] and run your code with as many MPI ranks as the number of cores. For example,
33122ef1f0ffSBarry 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"
33132ef1f0ffSBarry Smith .ve
33148fcaa860SBarry Smith 
33158fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
33162ef1f0ffSBarry 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`
33172ef1f0ffSBarry 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
33188fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
33198fcaa860SBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if --with-openmp is provided).
3320217d3b1eSJunchao Zhang 
33218fcaa860SBarry 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
3322217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
3323217d3b1eSJunchao 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
3324217d3b1eSJunchao 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
3325217d3b1eSJunchao 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.
3326217d3b1eSJunchao 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,
3327217d3b1eSJunchao 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
3328217d3b1eSJunchao 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
3329217d3b1eSJunchao 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
3330217d3b1eSJunchao 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.
33318fcaa860SBarry 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
3332217d3b1eSJunchao Zhang    examine the mapping result.
3333217d3b1eSJunchao Zhang 
333411a5261eSBarry 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,
333511a5261eSBarry 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
333611a5261eSBarry Smith    calls `omp_set_num_threads`(m) internally before calling MUMPS.
3337217d3b1eSJunchao Zhang 
3338217d3b1eSJunchao Zhang    References:
3339606c0280SSatish Balay +  * - Heroux, Michael A., R. Brightwell, and Michael M. Wolf. "Bi-modal MPI and MPI+ threads computing on scalable multicore systems." IJHPCA (Submitted) (2011).
3340606c0280SSatish 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.
3341217d3b1eSJunchao Zhang 
33421cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `KSPGetPC()`, `PCFactorGetMatrix()`
334324b6179bSKris Buschelman M*/
334424b6179bSKris Buschelman 
3345d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatFactorGetSolverType_mumps(Mat A, MatSolverType *type)
3346d71ae5a4SJacob Faibussowitsch {
334735bd34faSBarry Smith   PetscFunctionBegin;
33482692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
33493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
335035bd34faSBarry Smith }
335135bd34faSBarry Smith 
3352bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
3353d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_aij_mumps(Mat A, MatFactorType ftype, Mat *F)
3354d71ae5a4SJacob Faibussowitsch {
33552877fffaSHong Zhang   Mat         B;
33562877fffaSHong Zhang   Mat_MUMPS  *mumps;
3357c3e1b152SPierre Jolivet   PetscBool   isSeqAIJ, isDiag;
33582c7c0729SBarry Smith   PetscMPIInt size;
33592877fffaSHong Zhang 
33602877fffaSHong Zhang   PetscFunctionBegin;
3361eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
336203e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
336303e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
336403e5aca4SStefano Zampini     *F = NULL;
336503e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
336603e5aca4SStefano Zampini   }
3367eb1ec7c1SStefano Zampini #endif
33682877fffaSHong Zhang   /* Create the factorization matrix */
33699566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATSEQAIJ, &isSeqAIJ));
3370c3e1b152SPierre Jolivet   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATDIAGONAL, &isDiag));
33719566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
33729566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
33739566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
33749566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
33752877fffaSHong Zhang 
33764dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
33772205254eSKarl Rupp 
33782877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
337935bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
33802205254eSKarl Rupp 
33819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
33829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
33839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
33849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
33859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
33869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
33879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
33889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
33899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
33909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
33919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
33925c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
33939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
33949566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
33956444a565SStefano Zampini 
3396450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3397450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3398d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3399bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3400c3e1b152SPierre Jolivet     else if (isDiag) mumps->ConvertToTriples = MatConvertToTriples_diagonal_xaij;
3401bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
34029566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3403746480a1SHong Zhang     mumps->sym = 0;
3404dcd589f8SShri Abhyankar   } else {
340567877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3406450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3407bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3408c3e1b152SPierre Jolivet     else if (isDiag) mumps->ConvertToTriples = MatConvertToTriples_diagonal_xaij;
3409bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
34109566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
341159ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
341259ac8732SStefano Zampini     mumps->sym = 2;
341359ac8732SStefano Zampini #else
3414b94d7dedSBarry Smith     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
34156fdc2a6dSBarry Smith     else mumps->sym = 2;
341659ac8732SStefano Zampini #endif
3417450b117fSShri Abhyankar   }
34182877fffaSHong Zhang 
341900c67f3bSHong Zhang   /* set solvertype */
34209566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
34219566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
34229566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
34232c7c0729SBarry Smith   if (size == 1) {
34244ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3425f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
34262c7c0729SBarry Smith   }
34272877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3428e69c285eSBarry Smith   B->data         = (void *)mumps;
34292205254eSKarl Rupp 
34302877fffaSHong Zhang   *F               = B;
3431413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3432413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3433413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3434d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
34353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34362877fffaSHong Zhang }
34372877fffaSHong Zhang 
3438bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3439d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A, MatFactorType ftype, Mat *F)
3440d71ae5a4SJacob Faibussowitsch {
34412877fffaSHong Zhang   Mat         B;
34422877fffaSHong Zhang   Mat_MUMPS  *mumps;
3443ace3abfcSBarry Smith   PetscBool   isSeqSBAIJ;
34442c7c0729SBarry Smith   PetscMPIInt size;
34452877fffaSHong Zhang 
34462877fffaSHong Zhang   PetscFunctionBegin;
3447eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
344803e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
344903e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
345003e5aca4SStefano Zampini     *F = NULL;
345103e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
345203e5aca4SStefano Zampini   }
3453eb1ec7c1SStefano Zampini #endif
34549566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
34559566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
34569566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
34579566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3458e69c285eSBarry Smith 
34594dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
34609566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSBAIJ, &isSeqSBAIJ));
3461bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
346216ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3463dcd589f8SShri Abhyankar   } else {
3464bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3465bccb9932SShri Abhyankar   }
3466bccb9932SShri Abhyankar 
346767877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3468bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3469722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
34702205254eSKarl Rupp 
34719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
34729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
34739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
34749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
34759566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
34769566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
34779566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
34789566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
34799566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
34809566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
34819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
34825c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
34839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
34849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
34852205254eSKarl Rupp 
3486f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
348759ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
348859ac8732SStefano Zampini   mumps->sym = 2;
348959ac8732SStefano Zampini #else
3490b94d7dedSBarry Smith   if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
34916fdc2a6dSBarry Smith   else mumps->sym = 2;
349259ac8732SStefano Zampini #endif
3493a214ac2aSShri Abhyankar 
349400c67f3bSHong Zhang   /* set solvertype */
34959566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
34969566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
34979566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
34982c7c0729SBarry Smith   if (size == 1) {
34994ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3500f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35012c7c0729SBarry Smith   }
35029566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3503f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3504e69c285eSBarry Smith   B->data         = (void *)mumps;
35052205254eSKarl Rupp 
35062877fffaSHong Zhang   *F               = B;
3507413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3508413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3509413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3510d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
35122877fffaSHong Zhang }
351397969023SHong Zhang 
3514d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_baij_mumps(Mat A, MatFactorType ftype, Mat *F)
3515d71ae5a4SJacob Faibussowitsch {
351667877ebaSShri Abhyankar   Mat         B;
351767877ebaSShri Abhyankar   Mat_MUMPS  *mumps;
3518ace3abfcSBarry Smith   PetscBool   isSeqBAIJ;
35192c7c0729SBarry Smith   PetscMPIInt size;
352067877ebaSShri Abhyankar 
352167877ebaSShri Abhyankar   PetscFunctionBegin;
352267877ebaSShri Abhyankar   /* Create the factorization matrix */
35239566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQBAIJ, &isSeqBAIJ));
35249566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35259566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
35269566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
35279566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3528450b117fSShri Abhyankar 
35294dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
3530450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3531450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3532450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3533bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3534bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3535746480a1SHong Zhang     mumps->sym = 0;
35369566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3537546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3538bccb9932SShri Abhyankar 
3539450b117fSShri Abhyankar   B->ops->view    = MatView_MUMPS;
3540722b6324SPierre Jolivet   B->ops->getinfo = MatGetInfo_MUMPS;
35412205254eSKarl Rupp 
35429566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35439566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35449566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35459566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
35469566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
35479566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
35489566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
35499566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
35509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
35519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
35529566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
35535c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
35549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
35559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
3556450b117fSShri Abhyankar 
355700c67f3bSHong Zhang   /* set solvertype */
35589566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
35599566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
35609566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
35612c7c0729SBarry Smith   if (size == 1) {
35624ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3563f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35642c7c0729SBarry Smith   }
35657ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
35667ee00b23SStefano Zampini   B->data         = (void *)mumps;
35677ee00b23SStefano Zampini 
35687ee00b23SStefano Zampini   *F               = B;
3569413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3570413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3571413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3572d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
35747ee00b23SStefano Zampini }
35757ee00b23SStefano Zampini 
35767ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
3577d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sell_mumps(Mat A, MatFactorType ftype, Mat *F)
3578d71ae5a4SJacob Faibussowitsch {
35797ee00b23SStefano Zampini   Mat         B;
35807ee00b23SStefano Zampini   Mat_MUMPS  *mumps;
35817ee00b23SStefano Zampini   PetscBool   isSeqSELL;
35822c7c0729SBarry Smith   PetscMPIInt size;
35837ee00b23SStefano Zampini 
35847ee00b23SStefano Zampini   PetscFunctionBegin;
35857ee00b23SStefano Zampini   /* Create the factorization matrix */
35869566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSELL, &isSeqSELL));
35879566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35889566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
35899566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
35909566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
35917ee00b23SStefano Zampini 
35924dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
35937ee00b23SStefano Zampini 
35947ee00b23SStefano Zampini   B->ops->view    = MatView_MUMPS;
35957ee00b23SStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
35967ee00b23SStefano Zampini 
35979566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35989566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35999566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
36009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
36019566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
36029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
36039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
36049566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
36059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
36069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
36079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
36085c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
36097ee00b23SStefano Zampini 
36107ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
36117ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
36127ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
36137ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
36147ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
36157ee00b23SStefano Zampini     mumps->sym = 0;
36169566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
36177ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
36187ee00b23SStefano Zampini 
36197ee00b23SStefano Zampini   /* set solvertype */
36209566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
36219566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
36229566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
36232c7c0729SBarry Smith   if (size == 1) {
36244ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3625f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
36262c7c0729SBarry Smith   }
3627450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3628e69c285eSBarry Smith   B->data         = (void *)mumps;
36292205254eSKarl Rupp 
3630450b117fSShri Abhyankar   *F               = B;
3631413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3632413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3633413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3634d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
36353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3636450b117fSShri Abhyankar }
363742c9c57cSBarry Smith 
36389d0448ceSStefano Zampini /* MatGetFactor for MATNEST matrices */
36399d0448ceSStefano Zampini static PetscErrorCode MatGetFactor_nest_mumps(Mat A, MatFactorType ftype, Mat *F)
36409d0448ceSStefano Zampini {
36419d0448ceSStefano Zampini   Mat         B, **mats;
36429d0448ceSStefano Zampini   Mat_MUMPS  *mumps;
36439d0448ceSStefano Zampini   PetscInt    nr, nc;
36449d0448ceSStefano Zampini   PetscMPIInt size;
364503e5aca4SStefano Zampini   PetscBool   flg = PETSC_TRUE;
36469d0448ceSStefano Zampini 
36479d0448ceSStefano Zampini   PetscFunctionBegin;
36489d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
364903e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
365003e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
365103e5aca4SStefano Zampini     *F = NULL;
365203e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
365303e5aca4SStefano Zampini   }
36549d0448ceSStefano Zampini #endif
36559d0448ceSStefano Zampini 
365603e5aca4SStefano Zampini   /* Return if some condition is not satisfied */
365703e5aca4SStefano Zampini   *F = NULL;
36589d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
36599d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY) {
36609d0448ceSStefano Zampini     IS       *rows, *cols;
36619d0448ceSStefano Zampini     PetscInt *m, *M;
36629d0448ceSStefano Zampini 
36639d0448ceSStefano Zampini     PetscCheck(nr == nc, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MAT_FACTOR_CHOLESKY not supported for nest sizes %" PetscInt_FMT " != %" PetscInt_FMT ". Use MAT_FACTOR_LU.", nr, nc);
36649d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &rows, nc, &cols));
36659d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
36669d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++) PetscCall(ISEqualUnsorted(rows[r], cols[r], &flg));
366703e5aca4SStefano Zampini     if (!flg) {
366803e5aca4SStefano Zampini       PetscCall(PetscFree2(rows, cols));
366903e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for unequal row and column maps. Use MAT_FACTOR_LU.\n"));
367003e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
367103e5aca4SStefano Zampini     }
36729d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &m, nr, &M));
36739d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetMinMax(rows[r], &m[r], &M[r]));
36749d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++)
36759d0448ceSStefano Zampini       for (PetscInt k = r + 1; flg && k < nr; k++)
36769d0448ceSStefano Zampini         if ((m[k] <= m[r] && m[r] <= M[k]) || (m[k] <= M[r] && M[r] <= M[k])) flg = PETSC_FALSE;
36779d0448ceSStefano Zampini     PetscCall(PetscFree2(m, M));
36789d0448ceSStefano Zampini     PetscCall(PetscFree2(rows, cols));
367903e5aca4SStefano Zampini     if (!flg) {
368003e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for intersecting row maps. Use MAT_FACTOR_LU.\n"));
368103e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
368203e5aca4SStefano Zampini     }
36839d0448ceSStefano Zampini   }
36849d0448ceSStefano Zampini 
36859d0448ceSStefano Zampini   for (PetscInt r = 0; r < nr; r++) {
36869d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) {
36879d0448ceSStefano Zampini       Mat       sub = mats[r][c];
3688c3e1b152SPierre Jolivet       PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans, isDiag;
36899d0448ceSStefano Zampini 
36909d0448ceSStefano Zampini       if (!sub || (ftype == MAT_FACTOR_CHOLESKY && c < r)) continue;
36915d955bbbSStefano Zampini       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
36925d955bbbSStefano Zampini       if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
36935d955bbbSStefano Zampini       else {
36945d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isTrans));
36955d955bbbSStefano Zampini         if (isTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
36965d955bbbSStefano Zampini       }
36979d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
36989d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
36999d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
37009d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
37019d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
37029d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
3703c3e1b152SPierre Jolivet       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATDIAGONAL, &isDiag));
37049d0448ceSStefano Zampini       if (ftype == MAT_FACTOR_CHOLESKY) {
3705dcab004fSPierre Jolivet         if (r == c) {
3706c3e1b152SPierre Jolivet           if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isSeqSBAIJ && !isMPISBAIJ && !isDiag) {
370703e5aca4SStefano Zampini             PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
370803e5aca4SStefano Zampini             flg = PETSC_FALSE;
3709dcab004fSPierre Jolivet           }
3710c3e1b152SPierre Jolivet         } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isDiag) {
371103e5aca4SStefano Zampini           PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for off-diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
371203e5aca4SStefano Zampini           flg = PETSC_FALSE;
371303e5aca4SStefano Zampini         }
3714c3e1b152SPierre Jolivet       } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isDiag) {
371503e5aca4SStefano Zampini         PetscCall(PetscInfo(sub, "MAT_LU_FACTOR not supported for block of type %s.\n", ((PetscObject)sub)->type_name));
371603e5aca4SStefano Zampini         flg = PETSC_FALSE;
37179d0448ceSStefano Zampini       }
37189d0448ceSStefano Zampini     }
371903e5aca4SStefano Zampini   }
372003e5aca4SStefano Zampini   if (!flg) PetscFunctionReturn(PETSC_SUCCESS);
37219d0448ceSStefano Zampini 
37229d0448ceSStefano Zampini   /* Create the factorization matrix */
37239d0448ceSStefano Zampini   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
37249d0448ceSStefano Zampini   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
37259d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
37269d0448ceSStefano Zampini   PetscCall(MatSetUp(B));
37279d0448ceSStefano Zampini 
37289d0448ceSStefano Zampini   PetscCall(PetscNew(&mumps));
37299d0448ceSStefano Zampini 
37309d0448ceSStefano Zampini   B->ops->view    = MatView_MUMPS;
37319d0448ceSStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
37329d0448ceSStefano Zampini 
37339d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
37349d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
37359d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
37369d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
37379d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
37389d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
37399d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
37409d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
37419d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
37429d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
37439d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
37449d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
37459d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
37469d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
37479d0448ceSStefano Zampini 
37489d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_LU) {
37499d0448ceSStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
37509d0448ceSStefano Zampini     B->factortype            = MAT_FACTOR_LU;
37519d0448ceSStefano Zampini     mumps->sym               = 0;
37529d0448ceSStefano Zampini   } else {
37539d0448ceSStefano Zampini     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
37549d0448ceSStefano Zampini     B->factortype                  = MAT_FACTOR_CHOLESKY;
37559d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
37569d0448ceSStefano Zampini     mumps->sym = 2;
37579d0448ceSStefano Zampini #else
37589d0448ceSStefano Zampini     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
37599d0448ceSStefano Zampini     else mumps->sym = 2;
37609d0448ceSStefano Zampini #endif
37619d0448ceSStefano Zampini   }
37629d0448ceSStefano Zampini   mumps->ConvertToTriples = MatConvertToTriples_nest_xaij;
37639d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[ftype]));
37649d0448ceSStefano Zampini 
37659d0448ceSStefano Zampini   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
37669d0448ceSStefano Zampini   if (size == 1) {
37679d0448ceSStefano Zampini     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
37689d0448ceSStefano Zampini     B->canuseordering = PETSC_TRUE;
37699d0448ceSStefano Zampini   }
37709d0448ceSStefano Zampini 
37719d0448ceSStefano Zampini   /* set solvertype */
37729d0448ceSStefano Zampini   PetscCall(PetscFree(B->solvertype));
37739d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
37749d0448ceSStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
37759d0448ceSStefano Zampini   B->data         = (void *)mumps;
37769d0448ceSStefano Zampini 
37779d0448ceSStefano Zampini   *F               = B;
37789d0448ceSStefano Zampini   mumps->id.job    = JOB_NULL;
37799d0448ceSStefano Zampini   mumps->ICNTL_pre = NULL;
37809d0448ceSStefano Zampini   mumps->CNTL_pre  = NULL;
37819d0448ceSStefano Zampini   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
37829d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37839d0448ceSStefano Zampini }
37849d0448ceSStefano Zampini 
3785d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
3786d71ae5a4SJacob Faibussowitsch {
378742c9c57cSBarry Smith   PetscFunctionBegin;
37889566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37899566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37909566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37919566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37929566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPISBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37939566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37949566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37959566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37969566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37979566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37989566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSELL, MAT_FACTOR_LU, MatGetFactor_sell_mumps));
3799c3e1b152SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATDIAGONAL, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
3800c3e1b152SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATDIAGONAL, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
38019d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_LU, MatGetFactor_nest_mumps));
38029d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_CHOLESKY, MatGetFactor_nest_mumps));
38033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
380442c9c57cSBarry Smith }
3805