xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision 3e5b40d05d5df51c8bf9b11f428c5a4540c49d18)
11c2a3de1SBarry Smith 
2397b6df1SKris Buschelman /*
3c2b5dc30SHong Zhang     Provides an interface to the MUMPS sparse solver
4397b6df1SKris Buschelman */
567602552SJunchao Zhang #include <petscpkg_version.h>
69d0448ceSStefano Zampini #include <petscsf.h>
7c6db04a5SJed Brown #include <../src/mat/impls/aij/mpi/mpiaij.h> /*I  "petscmat.h"  I*/
8c6db04a5SJed Brown #include <../src/mat/impls/sbaij/mpi/mpisbaij.h>
97ee00b23SStefano Zampini #include <../src/mat/impls/sell/mpi/mpisell.h>
10397b6df1SKris Buschelman 
119261f6e4SBarry Smith #define MUMPS_MANUALS "(see users manual https://mumps-solver.org/index.php?page=doc \"Error and warning diagnostics\")"
129261f6e4SBarry Smith 
13397b6df1SKris Buschelman EXTERN_C_BEGIN
14397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
152907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
162907cef9SHong Zhang     #include <cmumps_c.h>
172907cef9SHong Zhang   #else
18c6db04a5SJed Brown     #include <zmumps_c.h>
192907cef9SHong Zhang   #endif
202907cef9SHong Zhang #else
212907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
222907cef9SHong Zhang     #include <smumps_c.h>
23397b6df1SKris Buschelman   #else
24c6db04a5SJed Brown     #include <dmumps_c.h>
25397b6df1SKris Buschelman   #endif
262907cef9SHong Zhang #endif
27397b6df1SKris Buschelman EXTERN_C_END
28397b6df1SKris Buschelman #define JOB_INIT         -1
29413bcc21SPierre Jolivet #define JOB_NULL         0
303d472b54SHong Zhang #define JOB_FACTSYMBOLIC 1
313d472b54SHong Zhang #define JOB_FACTNUMERIC  2
323d472b54SHong Zhang #define JOB_SOLVE        3
33397b6df1SKris Buschelman #define JOB_END          -2
343d472b54SHong Zhang 
352907cef9SHong Zhang /* calls to MUMPS */
362907cef9SHong Zhang #if defined(PETSC_USE_COMPLEX)
372907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
383ab56b82SJunchao Zhang     #define MUMPS_c cmumps_c
392907cef9SHong Zhang   #else
403ab56b82SJunchao Zhang     #define MUMPS_c zmumps_c
412907cef9SHong Zhang   #endif
422907cef9SHong Zhang #else
432907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
443ab56b82SJunchao Zhang     #define MUMPS_c smumps_c
452907cef9SHong Zhang   #else
463ab56b82SJunchao Zhang     #define MUMPS_c dmumps_c
472907cef9SHong Zhang   #endif
482907cef9SHong Zhang #endif
492907cef9SHong Zhang 
50a6053eceSJunchao Zhang /* MUMPS uses MUMPS_INT for nonzero indices such as irn/jcn, irn_loc/jcn_loc and uses int64_t for
51a6053eceSJunchao Zhang    number of nonzeros such as nnz, nnz_loc. We typedef MUMPS_INT to PetscMUMPSInt to follow the
52a6053eceSJunchao Zhang    naming convention in PetscMPIInt, PetscBLASInt etc.
53a6053eceSJunchao Zhang */
54a6053eceSJunchao Zhang typedef MUMPS_INT PetscMUMPSInt;
55a6053eceSJunchao Zhang 
5667602552SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5, 3, 0)
5767602552SJunchao 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 */
58a6053eceSJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
5967602552SJunchao Zhang   #endif
60a6053eceSJunchao Zhang #else
6167602552SJunchao Zhang   #if defined(INTSIZE64) /* INTSIZE64 is a command line macro one used to build MUMPS in full 64-bit mode */
6267602552SJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
6367602552SJunchao Zhang   #endif
6467602552SJunchao Zhang #endif
6567602552SJunchao Zhang 
66a6053eceSJunchao Zhang #define MPIU_MUMPSINT       MPI_INT
67a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MAX 2147483647
68a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MIN -2147483648
69a6053eceSJunchao Zhang 
70a6053eceSJunchao Zhang /* Cast PetscInt to PetscMUMPSInt. Usually there is no overflow since <a> is row/col indices or some small integers*/
71d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscMUMPSIntCast(PetscInt a, PetscMUMPSInt *b)
72d71ae5a4SJacob Faibussowitsch {
73a6053eceSJunchao Zhang   PetscFunctionBegin;
74ece88022SPierre Jolivet #if PetscDefined(USE_64BIT_INDICES)
752c71b3e2SJacob Faibussowitsch   PetscAssert(a <= PETSC_MUMPS_INT_MAX && a >= PETSC_MUMPS_INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
76ece88022SPierre Jolivet #endif
77a6053eceSJunchao Zhang   *b = (PetscMUMPSInt)(a);
783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
79a6053eceSJunchao Zhang }
80a6053eceSJunchao Zhang 
81a6053eceSJunchao Zhang /* Put these utility routines here since they are only used in this file */
82d71ae5a4SJacob 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)
83d71ae5a4SJacob Faibussowitsch {
84a6053eceSJunchao Zhang   PetscInt  myval;
85a6053eceSJunchao Zhang   PetscBool myset;
86a6053eceSJunchao Zhang   PetscFunctionBegin;
87a6053eceSJunchao Zhang   /* PetscInt's size should be always >= PetscMUMPSInt's. It is safe to call PetscOptionsInt_Private to read a PetscMUMPSInt */
889566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, (PetscInt)currentvalue, &myval, &myset, lb, ub));
899566063dSJacob Faibussowitsch   if (myset) PetscCall(PetscMUMPSIntCast(myval, value));
90a6053eceSJunchao Zhang   if (set) *set = myset;
913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
92a6053eceSJunchao Zhang }
93a6053eceSJunchao 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)
94a6053eceSJunchao Zhang 
95217d3b1eSJunchao 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 */
963ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
973ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
983ab56b82SJunchao Zhang     do { \
993ab56b82SJunchao Zhang       if (mumps->use_petsc_omp_support) { \
1003ab56b82SJunchao Zhang         if (mumps->is_omp_master) { \
1019566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterBegin(mumps->omp_ctrl)); \
10214ffdc6fSStefano Zampini           PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
10314ffdc6fSStefano Zampini           PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
10414ffdc6fSStefano Zampini           PetscCall(PetscFPTrapPop()); \
1059566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterEnd(mumps->omp_ctrl)); \
1063ab56b82SJunchao Zhang         } \
1079566063dSJacob Faibussowitsch         PetscCall(PetscOmpCtrlBarrier(mumps->omp_ctrl)); \
108c3714a1dSJunchao Zhang         /* Global info is same on all processes so we Bcast it within omp_comm. Local info is specific      \
109c3714a1dSJunchao Zhang          to processes, so we only Bcast info[1], an error code and leave others (since they do not have   \
110c3714a1dSJunchao Zhang          an easy translation between omp_comm and petsc_comm). See MUMPS-5.1.2 manual p82.                   \
111c3714a1dSJunchao Zhang          omp_comm is a small shared memory communicator, hence doing multiple Bcast as shown below is OK. \
112c3714a1dSJunchao Zhang       */ \
113338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.infog, PETSC_STATIC_ARRAY_LENGTH(mumps->id.infog), MPIU_MUMPSINT, 0, mumps->omp_comm)); \
114338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.rinfog, PETSC_STATIC_ARRAY_LENGTH(mumps->id.rinfog), MPIU_REAL, 0, mumps->omp_comm)); \
115338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.info, PETSC_STATIC_ARRAY_LENGTH(mumps->id.info), MPIU_MUMPSINT, 0, mumps->omp_comm)); \
116338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.rinfo, PETSC_STATIC_ARRAY_LENGTH(mumps->id.rinfo), MPIU_REAL, 0, mumps->omp_comm)); \
1173ab56b82SJunchao Zhang       } else { \
11814ffdc6fSStefano Zampini         PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
11914ffdc6fSStefano Zampini         PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
12014ffdc6fSStefano Zampini         PetscCall(PetscFPTrapPop()); \
1213ab56b82SJunchao Zhang       } \
1223ab56b82SJunchao Zhang     } while (0)
1233ab56b82SJunchao Zhang #else
1243ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
125d71ae5a4SJacob Faibussowitsch     do { \
12614ffdc6fSStefano Zampini       PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
12714ffdc6fSStefano Zampini       PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
12814ffdc6fSStefano Zampini       PetscCall(PetscFPTrapPop()); \
129d71ae5a4SJacob Faibussowitsch     } while (0)
1303ab56b82SJunchao Zhang #endif
1313ab56b82SJunchao Zhang 
132940cd9d6SSatish Balay /* declare MumpsScalar */
133940cd9d6SSatish Balay #if defined(PETSC_USE_COMPLEX)
134940cd9d6SSatish Balay   #if defined(PETSC_USE_REAL_SINGLE)
135940cd9d6SSatish Balay     #define MumpsScalar mumps_complex
136940cd9d6SSatish Balay   #else
137940cd9d6SSatish Balay     #define MumpsScalar mumps_double_complex
138940cd9d6SSatish Balay   #endif
139940cd9d6SSatish Balay #else
140940cd9d6SSatish Balay   #define MumpsScalar PetscScalar
141940cd9d6SSatish Balay #endif
1423d472b54SHong Zhang 
143397b6df1SKris Buschelman /* macros s.t. indices match MUMPS documentation */
144397b6df1SKris Buschelman #define ICNTL(I)  icntl[(I)-1]
145397b6df1SKris Buschelman #define CNTL(I)   cntl[(I)-1]
146397b6df1SKris Buschelman #define INFOG(I)  infog[(I)-1]
147a7aca84bSHong Zhang #define INFO(I)   info[(I)-1]
148397b6df1SKris Buschelman #define RINFOG(I) rinfog[(I)-1]
149adc1d99fSHong Zhang #define RINFO(I)  rinfo[(I)-1]
150397b6df1SKris Buschelman 
151a6053eceSJunchao Zhang typedef struct Mat_MUMPS Mat_MUMPS;
152a6053eceSJunchao Zhang struct Mat_MUMPS {
153397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
1542907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1552907cef9SHong Zhang   CMUMPS_STRUC_C id;
1562907cef9SHong Zhang   #else
157397b6df1SKris Buschelman   ZMUMPS_STRUC_C id;
1582907cef9SHong Zhang   #endif
1592907cef9SHong Zhang #else
1602907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1612907cef9SHong Zhang   SMUMPS_STRUC_C id;
162397b6df1SKris Buschelman   #else
163397b6df1SKris Buschelman   DMUMPS_STRUC_C id;
164397b6df1SKris Buschelman   #endif
1652907cef9SHong Zhang #endif
1662907cef9SHong Zhang 
167397b6df1SKris Buschelman   MatStructure   matstruc;
1682d4298aeSJunchao Zhang   PetscMPIInt    myid, petsc_size;
169a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;       /* the (i,j,v) triplets passed to mumps. */
170a6053eceSJunchao 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. */
171a6053eceSJunchao Zhang   PetscInt64     nnz;             /* number of nonzeros. The type is called selective 64-bit in mumps */
172a6053eceSJunchao Zhang   PetscMUMPSInt  sym;
1732d4298aeSJunchao Zhang   MPI_Comm       mumps_comm;
174413bcc21SPierre Jolivet   PetscMUMPSInt *ICNTL_pre;
175413bcc21SPierre Jolivet   PetscReal     *CNTL_pre;
176a6053eceSJunchao Zhang   PetscMUMPSInt  ICNTL9_pre;         /* check if ICNTL(9) is changed from previous MatSolve */
177801fbe65SHong Zhang   VecScatter     scat_rhs, scat_sol; /* used by MatSolve() */
17825aac85cSJunchao Zhang   PetscMUMPSInt  ICNTL20;            /* use centralized (0) or distributed (10) dense RHS */
17967602552SJunchao Zhang   PetscMUMPSInt  lrhs_loc, nloc_rhs, *irhs_loc;
18067602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
18167602552SJunchao Zhang   PetscInt    *rhs_nrow, max_nrhs;
18267602552SJunchao Zhang   PetscMPIInt *rhs_recvcounts, *rhs_disps;
18367602552SJunchao Zhang   PetscScalar *rhs_loc, *rhs_recvbuf;
18467602552SJunchao Zhang #endif
185801fbe65SHong Zhang   Vec            b_seq, x_seq;
186a6053eceSJunchao Zhang   PetscInt       ninfo, *info; /* which INFO to display */
187b5fa320bSStefano Zampini   PetscInt       sizeredrhs;
18859ac8732SStefano Zampini   PetscScalar   *schur_sol;
18959ac8732SStefano Zampini   PetscInt       schur_sizesol;
190a6053eceSJunchao Zhang   PetscMUMPSInt *ia_alloc, *ja_alloc; /* work arrays used for the CSR struct for sparse rhs */
191a6053eceSJunchao Zhang   PetscInt64     cur_ilen, cur_jlen;  /* current len of ia_alloc[], ja_alloc[] */
192a6053eceSJunchao Zhang   PetscErrorCode (*ConvertToTriples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1932205254eSKarl Rupp 
1949d0448ceSStefano Zampini   /* Support for MATNEST */
1959d0448ceSStefano Zampini   PetscErrorCode (**nest_convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1969d0448ceSStefano Zampini   PetscInt64  *nest_vals_start;
1979d0448ceSStefano Zampini   PetscScalar *nest_vals;
1989d0448ceSStefano Zampini 
199a6053eceSJunchao Zhang   /* stuff used by petsc/mumps OpenMP support*/
2003ab56b82SJunchao Zhang   PetscBool    use_petsc_omp_support;
201da81f932SPierre Jolivet   PetscOmpCtrl omp_ctrl;             /* an OpenMP controller that blocked processes will release their CPU (MPI_Barrier does not have this guarantee) */
2023ab56b82SJunchao Zhang   MPI_Comm     petsc_comm, omp_comm; /* petsc_comm is petsc matrix's comm */
203a6053eceSJunchao Zhang   PetscInt64  *recvcount;            /* a collection of nnz on omp_master */
204a6053eceSJunchao Zhang   PetscMPIInt  tag, omp_comm_size;
2053ab56b82SJunchao Zhang   PetscBool    is_omp_master; /* is this rank the master of omp_comm */
206a6053eceSJunchao Zhang   MPI_Request *reqs;
207a6053eceSJunchao Zhang };
2083ab56b82SJunchao Zhang 
209a6053eceSJunchao Zhang /* Cast a 1-based CSR represented by (nrow, ia, ja) of type PetscInt to a CSR of type PetscMUMPSInt.
210a6053eceSJunchao Zhang    Here, nrow is number of rows, ia[] is row pointer and ja[] is column indices.
211a6053eceSJunchao Zhang  */
212d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscMUMPSIntCSRCast(Mat_MUMPS *mumps, PetscInt nrow, PetscInt *ia, PetscInt *ja, PetscMUMPSInt **ia_mumps, PetscMUMPSInt **ja_mumps, PetscMUMPSInt *nnz_mumps)
213d71ae5a4SJacob Faibussowitsch {
214a6053eceSJunchao Zhang   PetscInt nnz = ia[nrow] - 1; /* mumps uses 1-based indices. Uses PetscInt instead of PetscInt64 since mumps only uses PetscMUMPSInt for rhs */
215f0c56d0fSKris Buschelman 
216a6053eceSJunchao Zhang   PetscFunctionBegin;
217a6053eceSJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES)
218a6053eceSJunchao Zhang   {
219a6053eceSJunchao Zhang     PetscInt i;
220a6053eceSJunchao Zhang     if (nrow + 1 > mumps->cur_ilen) { /* realloc ia_alloc/ja_alloc to fit ia/ja */
2219566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ia_alloc));
2229566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrow + 1, &mumps->ia_alloc));
223a6053eceSJunchao Zhang       mumps->cur_ilen = nrow + 1;
224a6053eceSJunchao Zhang     }
225a6053eceSJunchao Zhang     if (nnz > mumps->cur_jlen) {
2269566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ja_alloc));
2279566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nnz, &mumps->ja_alloc));
228a6053eceSJunchao Zhang       mumps->cur_jlen = nnz;
229a6053eceSJunchao Zhang     }
2309566063dSJacob Faibussowitsch     for (i = 0; i < nrow + 1; i++) PetscCall(PetscMUMPSIntCast(ia[i], &(mumps->ia_alloc[i])));
2319566063dSJacob Faibussowitsch     for (i = 0; i < nnz; i++) PetscCall(PetscMUMPSIntCast(ja[i], &(mumps->ja_alloc[i])));
232a6053eceSJunchao Zhang     *ia_mumps = mumps->ia_alloc;
233a6053eceSJunchao Zhang     *ja_mumps = mumps->ja_alloc;
234a6053eceSJunchao Zhang   }
235a6053eceSJunchao Zhang #else
236a6053eceSJunchao Zhang   *ia_mumps = ia;
237a6053eceSJunchao Zhang   *ja_mumps = ja;
238a6053eceSJunchao Zhang #endif
2399566063dSJacob Faibussowitsch   PetscCall(PetscMUMPSIntCast(nnz, nnz_mumps));
2403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
241a6053eceSJunchao Zhang }
242b24902e0SBarry Smith 
243d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsResetSchur_Private(Mat_MUMPS *mumps)
244d71ae5a4SJacob Faibussowitsch {
245b5fa320bSStefano Zampini   PetscFunctionBegin;
2469566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
2479566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.redrhs));
2489566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->schur_sol));
24959ac8732SStefano Zampini   mumps->id.size_schur = 0;
250b3cb21ddSStefano Zampini   mumps->id.schur_lld  = 0;
25159ac8732SStefano Zampini   mumps->id.ICNTL(19)  = 0;
2523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25359ac8732SStefano Zampini }
25459ac8732SStefano Zampini 
255b3cb21ddSStefano Zampini /* solve with rhs in mumps->id.redrhs and return in the same location */
256d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSolveSchur_Private(Mat F)
257d71ae5a4SJacob Faibussowitsch {
258b3cb21ddSStefano Zampini   Mat_MUMPS           *mumps = (Mat_MUMPS *)F->data;
259b3cb21ddSStefano Zampini   Mat                  S, B, X;
260b3cb21ddSStefano Zampini   MatFactorSchurStatus schurstatus;
261b3cb21ddSStefano Zampini   PetscInt             sizesol;
26259ac8732SStefano Zampini 
26359ac8732SStefano Zampini   PetscFunctionBegin;
2649566063dSJacob Faibussowitsch   PetscCall(MatFactorFactorizeSchurComplement(F));
2659566063dSJacob Faibussowitsch   PetscCall(MatFactorGetSchurComplement(F, &S, &schurstatus));
2669566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &B));
2679566063dSJacob Faibussowitsch   PetscCall(MatSetType(B, ((PetscObject)S)->type_name));
268a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2699566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(B, S->boundtocpu));
270a3d589ffSStefano Zampini #endif
271b3cb21ddSStefano Zampini   switch (schurstatus) {
272d71ae5a4SJacob Faibussowitsch   case MAT_FACTOR_SCHUR_FACTORED:
273d71ae5a4SJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &X));
274d71ae5a4SJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
275a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2769566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
277a3d589ffSStefano Zampini #endif
278b3cb21ddSStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2799566063dSJacob Faibussowitsch       PetscCall(MatMatSolveTranspose(S, B, X));
28059ac8732SStefano Zampini     } else {
2819566063dSJacob Faibussowitsch       PetscCall(MatMatSolve(S, B, X));
28259ac8732SStefano Zampini     }
283b3cb21ddSStefano Zampini     break;
284b3cb21ddSStefano Zampini   case MAT_FACTOR_SCHUR_INVERTED:
285b3cb21ddSStefano Zampini     sizesol = mumps->id.nrhs * mumps->id.size_schur;
28659ac8732SStefano Zampini     if (!mumps->schur_sol || sizesol > mumps->schur_sizesol) {
2879566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->schur_sol));
2889566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(sizesol, &mumps->schur_sol));
28959ac8732SStefano Zampini       mumps->schur_sizesol = sizesol;
290b5fa320bSStefano Zampini     }
2919566063dSJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, mumps->schur_sol, &X));
2929566063dSJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
293a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2949566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
295a3d589ffSStefano Zampini #endif
2969566063dSJacob Faibussowitsch     PetscCall(MatProductCreateWithMat(S, B, NULL, X));
29759ac8732SStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2989566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AtB));
299b5fa320bSStefano Zampini     } else {
3009566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AB));
301b5fa320bSStefano Zampini     }
3029566063dSJacob Faibussowitsch     PetscCall(MatProductSetFromOptions(X));
3039566063dSJacob Faibussowitsch     PetscCall(MatProductSymbolic(X));
3049566063dSJacob Faibussowitsch     PetscCall(MatProductNumeric(X));
3054417c5e8SHong Zhang 
3069566063dSJacob Faibussowitsch     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
307b3cb21ddSStefano Zampini     break;
308d71ae5a4SJacob Faibussowitsch   default:
309d71ae5a4SJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)F), PETSC_ERR_SUP, "Unhandled MatFactorSchurStatus %d", F->schur_status);
31059ac8732SStefano Zampini   }
3119566063dSJacob Faibussowitsch   PetscCall(MatFactorRestoreSchurComplement(F, &S, schurstatus));
3129566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
3139566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&X));
3143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
315b5fa320bSStefano Zampini }
316b5fa320bSStefano Zampini 
317d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsHandleSchur_Private(Mat F, PetscBool expansion)
318d71ae5a4SJacob Faibussowitsch {
319b3cb21ddSStefano Zampini   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
320b5fa320bSStefano Zampini 
321b5fa320bSStefano Zampini   PetscFunctionBegin;
322b5fa320bSStefano Zampini   if (!mumps->id.ICNTL(19)) { /* do nothing when Schur complement has not been computed */
3233ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
324b5fa320bSStefano Zampini   }
325b8f61ee1SStefano Zampini   if (!expansion) { /* prepare for the condensation step */
326b5fa320bSStefano Zampini     PetscInt sizeredrhs = mumps->id.nrhs * mumps->id.size_schur;
327b5fa320bSStefano Zampini     /* allocate MUMPS internal array to store reduced right-hand sides */
328b5fa320bSStefano Zampini     if (!mumps->id.redrhs || sizeredrhs > mumps->sizeredrhs) {
3299566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
330b5fa320bSStefano Zampini       mumps->id.lredrhs = mumps->id.size_schur;
3319566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.nrhs * mumps->id.lredrhs, &mumps->id.redrhs));
332b5fa320bSStefano Zampini       mumps->sizeredrhs = mumps->id.nrhs * mumps->id.lredrhs;
333b5fa320bSStefano Zampini     }
334b5fa320bSStefano Zampini   } else { /* prepare for the expansion step */
335b8f61ee1SStefano Zampini     /* solve Schur complement (this has to be done by the MUMPS user, so basically us) */
3369566063dSJacob Faibussowitsch     PetscCall(MatMumpsSolveSchur_Private(F));
337b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 2; /* expansion phase */
3383ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
3399261f6e4SBarry 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));
340b5fa320bSStefano Zampini     /* restore defaults */
341b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = -1;
342d3d598ffSStefano Zampini     /* free MUMPS internal array for redrhs if we have solved for multiple rhs in order to save memory space */
343d3d598ffSStefano Zampini     if (mumps->id.nrhs > 1) {
3449566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
345d3d598ffSStefano Zampini       mumps->id.lredrhs = 0;
346d3d598ffSStefano Zampini       mumps->sizeredrhs = 0;
347d3d598ffSStefano Zampini     }
348b5fa320bSStefano Zampini   }
3493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
350b5fa320bSStefano Zampini }
351b5fa320bSStefano Zampini 
352397b6df1SKris Buschelman /*
353d341cd04SHong Zhang   MatConvertToTriples_A_B - convert Petsc matrix to triples: row[nz], col[nz], val[nz]
354d341cd04SHong Zhang 
355397b6df1SKris Buschelman   input:
35675480915SPierre Jolivet     A       - matrix in aij,baij or sbaij format
357397b6df1SKris Buschelman     shift   - 0: C style output triple; 1: Fortran style output triple.
358bccb9932SShri Abhyankar     reuse   - MAT_INITIAL_MATRIX: spaces are allocated and values are set for the triple
359bccb9932SShri Abhyankar               MAT_REUSE_MATRIX:   only the values in v array are updated
360397b6df1SKris Buschelman   output:
361397b6df1SKris Buschelman     nnz     - dim of r, c, and v (number of local nonzero entries of A)
362397b6df1SKris Buschelman     r, c, v - row and col index, matrix values (matrix triples)
363eb9baa12SBarry Smith 
364eb9baa12SBarry Smith   The returned values r, c, and sometimes v are obtained in a single PetscMalloc(). Then in MatDestroy_MUMPS() it is
3657ee00b23SStefano Zampini   freed with PetscFree(mumps->irn);  This is not ideal code, the fact that v is ONLY sometimes part of mumps->irn means
366eb9baa12SBarry Smith   that the PetscMalloc() cannot easily be replaced with a PetscMalloc3().
367eb9baa12SBarry Smith 
368397b6df1SKris Buschelman  */
36916ebf90aSShri Abhyankar 
370d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
371d71ae5a4SJacob Faibussowitsch {
372a3d589ffSStefano Zampini   const PetscScalar *av;
373185f6596SHong Zhang   const PetscInt    *ai, *aj, *ajj, M = A->rmap->n;
374a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j, k;
375a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
37616ebf90aSShri Abhyankar   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
377397b6df1SKris Buschelman 
378397b6df1SKris Buschelman   PetscFunctionBegin;
3799566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
380a6053eceSJunchao Zhang   mumps->val = (PetscScalar *)av;
381bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
3822205254eSKarl Rupp     nz = aa->nz;
3832205254eSKarl Rupp     ai = aa->i;
3842205254eSKarl Rupp     aj = aa->j;
3859566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
386a6053eceSJunchao Zhang     for (i = k = 0; i < M; i++) {
38716ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
38867877ebaSShri Abhyankar       ajj = aj + ai[i];
38967877ebaSShri Abhyankar       for (j = 0; j < rnz; j++) {
3909566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[k]));
3919566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[k]));
392a6053eceSJunchao Zhang         k++;
39316ebf90aSShri Abhyankar       }
39416ebf90aSShri Abhyankar     }
395a6053eceSJunchao Zhang     mumps->irn = row;
396a6053eceSJunchao Zhang     mumps->jcn = col;
397a6053eceSJunchao Zhang     mumps->nnz = nz;
39816ebf90aSShri Abhyankar   }
3999566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
4003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
40116ebf90aSShri Abhyankar }
402397b6df1SKris Buschelman 
403d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
404d71ae5a4SJacob Faibussowitsch {
405a6053eceSJunchao Zhang   PetscInt64     nz, i, j, k, r;
4067ee00b23SStefano Zampini   Mat_SeqSELL   *a = (Mat_SeqSELL *)A->data;
407a6053eceSJunchao Zhang   PetscMUMPSInt *row, *col;
4087ee00b23SStefano Zampini 
4097ee00b23SStefano Zampini   PetscFunctionBegin;
410a6053eceSJunchao Zhang   mumps->val = a->val;
4117ee00b23SStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4127ee00b23SStefano Zampini     nz = a->sliidx[a->totalslices];
4139566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
414a6053eceSJunchao Zhang     for (i = k = 0; i < a->totalslices; i++) {
41548a46eb9SPierre 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++]));
4167ee00b23SStefano Zampini     }
4179566063dSJacob Faibussowitsch     for (i = 0; i < nz; i++) PetscCall(PetscMUMPSIntCast(a->colidx[i] + shift, &col[i]));
418a6053eceSJunchao Zhang     mumps->irn = row;
419a6053eceSJunchao Zhang     mumps->jcn = col;
420a6053eceSJunchao Zhang     mumps->nnz = nz;
4217ee00b23SStefano Zampini   }
4223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4237ee00b23SStefano Zampini }
4247ee00b23SStefano Zampini 
425d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
426d71ae5a4SJacob Faibussowitsch {
42767877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa = (Mat_SeqBAIJ *)A->data;
42833d57670SJed Brown   const PetscInt *ai, *aj, *ajj, bs2 = aa->bs2;
429a6053eceSJunchao Zhang   PetscInt64      M, nz, idx = 0, rnz, i, j, k, m;
430a6053eceSJunchao Zhang   PetscInt        bs;
431a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
43267877ebaSShri Abhyankar 
43367877ebaSShri Abhyankar   PetscFunctionBegin;
4349566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
43533d57670SJed Brown   M          = A->rmap->N / bs;
436a6053eceSJunchao Zhang   mumps->val = aa->a;
437bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
4389371c9d4SSatish Balay     ai = aa->i;
4399371c9d4SSatish Balay     aj = aa->j;
44067877ebaSShri Abhyankar     nz = bs2 * aa->nz;
4419566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
44267877ebaSShri Abhyankar     for (i = 0; i < M; i++) {
44367877ebaSShri Abhyankar       ajj = aj + ai[i];
44467877ebaSShri Abhyankar       rnz = ai[i + 1] - ai[i];
44567877ebaSShri Abhyankar       for (k = 0; k < rnz; k++) {
44667877ebaSShri Abhyankar         for (j = 0; j < bs; j++) {
44767877ebaSShri Abhyankar           for (m = 0; m < bs; m++) {
4489566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[idx]));
4499566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * ajj[k] + j + shift, &col[idx]));
450a6053eceSJunchao Zhang             idx++;
45167877ebaSShri Abhyankar           }
45267877ebaSShri Abhyankar         }
45367877ebaSShri Abhyankar       }
45467877ebaSShri Abhyankar     }
455a6053eceSJunchao Zhang     mumps->irn = row;
456a6053eceSJunchao Zhang     mumps->jcn = col;
457a6053eceSJunchao Zhang     mumps->nnz = nz;
45867877ebaSShri Abhyankar   }
4593ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46067877ebaSShri Abhyankar }
46167877ebaSShri Abhyankar 
462d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
463d71ae5a4SJacob Faibussowitsch {
46475480915SPierre Jolivet   const PetscInt *ai, *aj, *ajj;
465a6053eceSJunchao Zhang   PetscInt        bs;
466a6053eceSJunchao Zhang   PetscInt64      nz, rnz, i, j, k, m;
467a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
46875480915SPierre Jolivet   PetscScalar    *val;
46916ebf90aSShri Abhyankar   Mat_SeqSBAIJ   *aa  = (Mat_SeqSBAIJ *)A->data;
47075480915SPierre Jolivet   const PetscInt  bs2 = aa->bs2, mbs = aa->mbs;
47138548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
472b94d7dedSBarry Smith   PetscBool isset, hermitian;
47338548759SBarry Smith #endif
47416ebf90aSShri Abhyankar 
47516ebf90aSShri Abhyankar   PetscFunctionBegin;
47638548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
477b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
478b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
47938548759SBarry Smith #endif
4802205254eSKarl Rupp   ai = aa->i;
4812205254eSKarl Rupp   aj = aa->j;
4829566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
48375480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
484f3fa974cSJacob Faibussowitsch     const PetscInt64 alloc_size = aa->nz * bs2;
485f3fa974cSJacob Faibussowitsch 
486f3fa974cSJacob Faibussowitsch     PetscCall(PetscMalloc2(alloc_size, &row, alloc_size, &col));
487a6053eceSJunchao Zhang     if (bs > 1) {
488f3fa974cSJacob Faibussowitsch       PetscCall(PetscMalloc1(alloc_size, &mumps->val_alloc));
489a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
49075480915SPierre Jolivet     } else {
491a6053eceSJunchao Zhang       mumps->val = aa->a;
49275480915SPierre Jolivet     }
493a6053eceSJunchao Zhang     mumps->irn = row;
494a6053eceSJunchao Zhang     mumps->jcn = col;
495a6053eceSJunchao Zhang   } else {
496a6053eceSJunchao Zhang     if (bs == 1) mumps->val = aa->a;
497a6053eceSJunchao Zhang     row = mumps->irn;
498a6053eceSJunchao Zhang     col = mumps->jcn;
499a6053eceSJunchao Zhang   }
500a6053eceSJunchao Zhang   val = mumps->val;
501185f6596SHong Zhang 
50216ebf90aSShri Abhyankar   nz = 0;
503a81fe166SPierre Jolivet   if (bs > 1) {
50475480915SPierre Jolivet     for (i = 0; i < mbs; i++) {
50516ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
50667877ebaSShri Abhyankar       ajj = aj + ai[i];
50775480915SPierre Jolivet       for (j = 0; j < rnz; j++) {
50875480915SPierre Jolivet         for (k = 0; k < bs; k++) {
50975480915SPierre Jolivet           for (m = 0; m < bs; m++) {
510ec4f40fdSPierre Jolivet             if (ajj[j] > i || k >= m) {
51175480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
5129566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[nz]));
5139566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j] * bs + k + shift, &col[nz]));
51475480915SPierre Jolivet               }
51575480915SPierre Jolivet               val[nz++] = aa->a[(ai[i] + j) * bs2 + m + k * bs];
51675480915SPierre Jolivet             }
51775480915SPierre Jolivet           }
51875480915SPierre Jolivet         }
51975480915SPierre Jolivet       }
52075480915SPierre Jolivet     }
521a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
522a81fe166SPierre Jolivet     for (i = 0; i < mbs; i++) {
523a81fe166SPierre Jolivet       rnz = ai[i + 1] - ai[i];
524a81fe166SPierre Jolivet       ajj = aj + ai[i];
525a81fe166SPierre Jolivet       for (j = 0; j < rnz; j++) {
5269566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5279566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
528a6053eceSJunchao Zhang         nz++;
529a81fe166SPierre Jolivet       }
530a81fe166SPierre Jolivet     }
53108401ef6SPierre Jolivet     PetscCheck(nz == aa->nz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different numbers of nonzeros %" PetscInt64_FMT " != %" PetscInt_FMT, nz, aa->nz);
53275480915SPierre Jolivet   }
533a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
5343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
53516ebf90aSShri Abhyankar }
53616ebf90aSShri Abhyankar 
537d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
538d71ae5a4SJacob Faibussowitsch {
53967877ebaSShri Abhyankar   const PetscInt    *ai, *aj, *ajj, *adiag, M = A->rmap->n;
540a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j;
54167877ebaSShri Abhyankar   const PetscScalar *av, *v1;
54216ebf90aSShri Abhyankar   PetscScalar       *val;
543a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
544829b1710SHong Zhang   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
54529b521d4Sstefano_zampini   PetscBool          missing;
54638548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
547b94d7dedSBarry Smith   PetscBool hermitian, isset;
54838548759SBarry Smith #endif
54916ebf90aSShri Abhyankar 
55016ebf90aSShri Abhyankar   PetscFunctionBegin;
55138548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
552b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
553b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
55438548759SBarry Smith #endif
5559566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
5569371c9d4SSatish Balay   ai    = aa->i;
5579371c9d4SSatish Balay   aj    = aa->j;
55816ebf90aSShri Abhyankar   adiag = aa->diag;
5599566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A, &missing, NULL));
560bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5617ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
562829b1710SHong Zhang     nz = 0;
56329b521d4Sstefano_zampini     if (missing) {
56429b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
56529b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
56629b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
56729b521d4Sstefano_zampini             if (aj[j] < i) continue;
56829b521d4Sstefano_zampini             nz++;
56929b521d4Sstefano_zampini           }
57029b521d4Sstefano_zampini         } else {
57129b521d4Sstefano_zampini           nz += ai[i + 1] - adiag[i];
57229b521d4Sstefano_zampini         }
57329b521d4Sstefano_zampini       }
57429b521d4Sstefano_zampini     } else {
575829b1710SHong Zhang       for (i = 0; i < M; i++) nz += ai[i + 1] - adiag[i];
57629b521d4Sstefano_zampini     }
5779566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
5789566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
579a6053eceSJunchao Zhang     mumps->nnz = nz;
580a6053eceSJunchao Zhang     mumps->irn = row;
581a6053eceSJunchao Zhang     mumps->jcn = col;
582a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
583185f6596SHong Zhang 
58416ebf90aSShri Abhyankar     nz = 0;
58529b521d4Sstefano_zampini     if (missing) {
58629b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
58729b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
58829b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
58929b521d4Sstefano_zampini             if (aj[j] < i) continue;
5909566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5919566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j] + shift, &col[nz]));
59229b521d4Sstefano_zampini             val[nz] = av[j];
59329b521d4Sstefano_zampini             nz++;
59429b521d4Sstefano_zampini           }
59529b521d4Sstefano_zampini         } else {
59629b521d4Sstefano_zampini           rnz = ai[i + 1] - adiag[i];
59729b521d4Sstefano_zampini           ajj = aj + adiag[i];
59829b521d4Sstefano_zampini           v1  = av + adiag[i];
59929b521d4Sstefano_zampini           for (j = 0; j < rnz; j++) {
6009566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6019566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
602a6053eceSJunchao Zhang             val[nz++] = v1[j];
60329b521d4Sstefano_zampini           }
60429b521d4Sstefano_zampini         }
60529b521d4Sstefano_zampini       }
60629b521d4Sstefano_zampini     } else {
60716ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
60816ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
60967877ebaSShri Abhyankar         ajj = aj + adiag[i];
610cf3759fdSShri Abhyankar         v1  = av + adiag[i];
61167877ebaSShri Abhyankar         for (j = 0; j < rnz; j++) {
6129566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6139566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
614a6053eceSJunchao Zhang           val[nz++] = v1[j];
61516ebf90aSShri Abhyankar         }
61616ebf90aSShri Abhyankar       }
61729b521d4Sstefano_zampini     }
618397b6df1SKris Buschelman   } else {
619a6053eceSJunchao Zhang     nz  = 0;
620a6053eceSJunchao Zhang     val = mumps->val;
62129b521d4Sstefano_zampini     if (missing) {
62216ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
62329b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
62429b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
62529b521d4Sstefano_zampini             if (aj[j] < i) continue;
62629b521d4Sstefano_zampini             val[nz++] = av[j];
62729b521d4Sstefano_zampini           }
62829b521d4Sstefano_zampini         } else {
62916ebf90aSShri Abhyankar           rnz = ai[i + 1] - adiag[i];
63067877ebaSShri Abhyankar           v1  = av + adiag[i];
631ad540459SPierre Jolivet           for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63216ebf90aSShri Abhyankar         }
63316ebf90aSShri Abhyankar       }
63429b521d4Sstefano_zampini     } else {
63516ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
63616ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
63716ebf90aSShri Abhyankar         v1  = av + adiag[i];
638ad540459SPierre Jolivet         for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63916ebf90aSShri Abhyankar       }
64016ebf90aSShri Abhyankar     }
64129b521d4Sstefano_zampini   }
6429566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
6433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
64416ebf90aSShri Abhyankar }
64516ebf90aSShri Abhyankar 
646d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
647d71ae5a4SJacob Faibussowitsch {
648a6053eceSJunchao Zhang   const PetscInt    *ai, *aj, *bi, *bj, *garray, *ajj, *bjj;
649a6053eceSJunchao Zhang   PetscInt           bs;
650a6053eceSJunchao Zhang   PetscInt64         rstart, nz, i, j, k, m, jj, irow, countA, countB;
651a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
65216ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
65316ebf90aSShri Abhyankar   PetscScalar       *val;
654397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ *)A->data;
655397b6df1SKris Buschelman   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ *)(mat->A)->data;
656397b6df1SKris Buschelman   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
657ec4f40fdSPierre Jolivet   const PetscInt     bs2 = aa->bs2, mbs = aa->mbs;
65838548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
659b94d7dedSBarry Smith   PetscBool hermitian, isset;
66038548759SBarry Smith #endif
66116ebf90aSShri Abhyankar 
66216ebf90aSShri Abhyankar   PetscFunctionBegin;
66338548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
664b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
665b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
66638548759SBarry Smith #endif
6679566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
66838548759SBarry Smith   rstart = A->rmap->rstart;
66938548759SBarry Smith   ai     = aa->i;
67038548759SBarry Smith   aj     = aa->j;
67138548759SBarry Smith   bi     = bb->i;
67238548759SBarry Smith   bj     = bb->j;
67338548759SBarry Smith   av     = aa->a;
67438548759SBarry Smith   bv     = bb->a;
675397b6df1SKris Buschelman 
6762205254eSKarl Rupp   garray = mat->garray;
6772205254eSKarl Rupp 
678bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
679a6053eceSJunchao Zhang     nz = (aa->nz + bb->nz) * bs2; /* just a conservative estimate */
6809566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
6819566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
682a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
683a6053eceSJunchao Zhang     mumps->irn = row;
684a6053eceSJunchao Zhang     mumps->jcn = col;
685a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
686397b6df1SKris Buschelman   } else {
687a6053eceSJunchao Zhang     val = mumps->val;
688397b6df1SKris Buschelman   }
689397b6df1SKris Buschelman 
6909371c9d4SSatish Balay   jj   = 0;
6919371c9d4SSatish Balay   irow = rstart;
692ec4f40fdSPierre Jolivet   for (i = 0; i < mbs; i++) {
693397b6df1SKris Buschelman     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
694397b6df1SKris Buschelman     countA = ai[i + 1] - ai[i];
695397b6df1SKris Buschelman     countB = bi[i + 1] - bi[i];
696397b6df1SKris Buschelman     bjj    = bj + bi[i];
697ec4f40fdSPierre Jolivet     v1     = av + ai[i] * bs2;
698ec4f40fdSPierre Jolivet     v2     = bv + bi[i] * bs2;
699397b6df1SKris Buschelman 
700ec4f40fdSPierre Jolivet     if (bs > 1) {
701ec4f40fdSPierre Jolivet       /* A-part */
702ec4f40fdSPierre Jolivet       for (j = 0; j < countA; j++) {
703ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
704ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
705ec4f40fdSPierre Jolivet             if (rstart + ajj[j] * bs > irow || k >= m) {
706ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
7079566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7089566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j] * bs + k + shift, &col[jj]));
709ec4f40fdSPierre Jolivet               }
710ec4f40fdSPierre Jolivet               val[jj++] = v1[j * bs2 + m + k * bs];
711ec4f40fdSPierre Jolivet             }
712ec4f40fdSPierre Jolivet           }
713ec4f40fdSPierre Jolivet         }
714ec4f40fdSPierre Jolivet       }
715ec4f40fdSPierre Jolivet 
716ec4f40fdSPierre Jolivet       /* B-part */
717ec4f40fdSPierre Jolivet       for (j = 0; j < countB; j++) {
718ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
719ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
720ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7219566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7229566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]] * bs + k + shift, &col[jj]));
723ec4f40fdSPierre Jolivet             }
724ec4f40fdSPierre Jolivet             val[jj++] = v2[j * bs2 + m + k * bs];
725ec4f40fdSPierre Jolivet           }
726ec4f40fdSPierre Jolivet         }
727ec4f40fdSPierre Jolivet       }
728ec4f40fdSPierre Jolivet     } else {
729397b6df1SKris Buschelman       /* A-part */
730397b6df1SKris Buschelman       for (j = 0; j < countA; j++) {
731bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7329566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7339566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
734397b6df1SKris Buschelman         }
73516ebf90aSShri Abhyankar         val[jj++] = v1[j];
736397b6df1SKris Buschelman       }
73716ebf90aSShri Abhyankar 
73816ebf90aSShri Abhyankar       /* B-part */
73916ebf90aSShri Abhyankar       for (j = 0; j < countB; j++) {
740bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7419566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7429566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
743397b6df1SKris Buschelman         }
74416ebf90aSShri Abhyankar         val[jj++] = v2[j];
74516ebf90aSShri Abhyankar       }
74616ebf90aSShri Abhyankar     }
747ec4f40fdSPierre Jolivet     irow += bs;
748ec4f40fdSPierre Jolivet   }
7495d955bbbSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = jj;
7503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
75116ebf90aSShri Abhyankar }
75216ebf90aSShri Abhyankar 
753d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
754d71ae5a4SJacob Faibussowitsch {
75516ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
7565d955bbbSStefano Zampini   PetscInt64         rstart, cstart, nz, i, j, jj, irow, countA, countB;
757a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
75816ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
75916ebf90aSShri Abhyankar   PetscScalar       *val;
760a3d589ffSStefano Zampini   Mat                Ad, Ao;
761a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
762a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
76316ebf90aSShri Abhyankar 
76416ebf90aSShri Abhyankar   PetscFunctionBegin;
7659566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
7669566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
7679566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
768a3d589ffSStefano Zampini 
769a3d589ffSStefano Zampini   aa = (Mat_SeqAIJ *)(Ad)->data;
770a3d589ffSStefano Zampini   bb = (Mat_SeqAIJ *)(Ao)->data;
77138548759SBarry Smith   ai = aa->i;
77238548759SBarry Smith   aj = aa->j;
77338548759SBarry Smith   bi = bb->i;
77438548759SBarry Smith   bj = bb->j;
77516ebf90aSShri Abhyankar 
776a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7775d955bbbSStefano Zampini   cstart = A->cmap->rstart;
7782205254eSKarl Rupp 
779bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
780a6053eceSJunchao Zhang     nz = (PetscInt64)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7819566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
7829566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
783a6053eceSJunchao Zhang     mumps->nnz = nz;
784a6053eceSJunchao Zhang     mumps->irn = row;
785a6053eceSJunchao Zhang     mumps->jcn = col;
786a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
78716ebf90aSShri Abhyankar   } else {
788a6053eceSJunchao Zhang     val = mumps->val;
78916ebf90aSShri Abhyankar   }
79016ebf90aSShri Abhyankar 
7919371c9d4SSatish Balay   jj   = 0;
7929371c9d4SSatish Balay   irow = rstart;
79316ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
79416ebf90aSShri Abhyankar     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
79516ebf90aSShri Abhyankar     countA = ai[i + 1] - ai[i];
79616ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
79716ebf90aSShri Abhyankar     bjj    = bj + bi[i];
79816ebf90aSShri Abhyankar     v1     = av + ai[i];
79916ebf90aSShri Abhyankar     v2     = bv + bi[i];
80016ebf90aSShri Abhyankar 
80116ebf90aSShri Abhyankar     /* A-part */
80216ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
803bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8049566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8055d955bbbSStefano Zampini         PetscCall(PetscMUMPSIntCast(cstart + ajj[j] + shift, &col[jj]));
80616ebf90aSShri Abhyankar       }
80716ebf90aSShri Abhyankar       val[jj++] = v1[j];
80816ebf90aSShri Abhyankar     }
80916ebf90aSShri Abhyankar 
81016ebf90aSShri Abhyankar     /* B-part */
81116ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
812bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8139566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8149566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
81516ebf90aSShri Abhyankar       }
81616ebf90aSShri Abhyankar       val[jj++] = v2[j];
81716ebf90aSShri Abhyankar     }
81816ebf90aSShri Abhyankar     irow++;
81916ebf90aSShri Abhyankar   }
8209566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
8219566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
8223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82316ebf90aSShri Abhyankar }
82416ebf90aSShri Abhyankar 
825d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
826d71ae5a4SJacob Faibussowitsch {
82767877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat = (Mat_MPIBAIJ *)A->data;
82867877ebaSShri Abhyankar   Mat_SeqBAIJ       *aa  = (Mat_SeqBAIJ *)(mat->A)->data;
82967877ebaSShri Abhyankar   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
83067877ebaSShri Abhyankar   const PetscInt    *ai = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j, *ajj, *bjj;
8315d955bbbSStefano Zampini   const PetscInt    *garray = mat->garray, mbs = mat->mbs, rstart = A->rmap->rstart, cstart = A->cmap->rstart;
83233d57670SJed Brown   const PetscInt     bs2 = mat->bs2;
833a6053eceSJunchao Zhang   PetscInt           bs;
834a6053eceSJunchao Zhang   PetscInt64         nz, i, j, k, n, jj, irow, countA, countB, idx;
835a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
83667877ebaSShri Abhyankar   const PetscScalar *av = aa->a, *bv = bb->a, *v1, *v2;
83767877ebaSShri Abhyankar   PetscScalar       *val;
83867877ebaSShri Abhyankar 
83967877ebaSShri Abhyankar   PetscFunctionBegin;
8409566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
841bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
84267877ebaSShri Abhyankar     nz = bs2 * (aa->nz + bb->nz);
8439566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
8449566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
845a6053eceSJunchao Zhang     mumps->nnz = nz;
846a6053eceSJunchao Zhang     mumps->irn = row;
847a6053eceSJunchao Zhang     mumps->jcn = col;
848a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
84967877ebaSShri Abhyankar   } else {
850a6053eceSJunchao Zhang     val = mumps->val;
85167877ebaSShri Abhyankar   }
85267877ebaSShri Abhyankar 
8539371c9d4SSatish Balay   jj   = 0;
8549371c9d4SSatish Balay   irow = rstart;
85567877ebaSShri Abhyankar   for (i = 0; i < mbs; i++) {
85667877ebaSShri Abhyankar     countA = ai[i + 1] - ai[i];
85767877ebaSShri Abhyankar     countB = bi[i + 1] - bi[i];
85867877ebaSShri Abhyankar     ajj    = aj + ai[i];
85967877ebaSShri Abhyankar     bjj    = bj + bi[i];
86067877ebaSShri Abhyankar     v1     = av + bs2 * ai[i];
86167877ebaSShri Abhyankar     v2     = bv + bs2 * bi[i];
86267877ebaSShri Abhyankar 
86367877ebaSShri Abhyankar     idx = 0;
86467877ebaSShri Abhyankar     /* A-part */
86567877ebaSShri Abhyankar     for (k = 0; k < countA; k++) {
86667877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
86767877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
868bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8699566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8705d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(cstart + bs * ajj[k] + j + shift, &col[jj]));
87167877ebaSShri Abhyankar           }
87267877ebaSShri Abhyankar           val[jj++] = v1[idx++];
87367877ebaSShri Abhyankar         }
87467877ebaSShri Abhyankar       }
87567877ebaSShri Abhyankar     }
87667877ebaSShri Abhyankar 
87767877ebaSShri Abhyankar     idx = 0;
87867877ebaSShri Abhyankar     /* B-part */
87967877ebaSShri Abhyankar     for (k = 0; k < countB; k++) {
88067877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
88167877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
882bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8839566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8849566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * garray[bjj[k]] + j + shift, &col[jj]));
88567877ebaSShri Abhyankar           }
886d985c460SShri Abhyankar           val[jj++] = v2[idx++];
88767877ebaSShri Abhyankar         }
88867877ebaSShri Abhyankar       }
88967877ebaSShri Abhyankar     }
890d985c460SShri Abhyankar     irow += bs;
89167877ebaSShri Abhyankar   }
8923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
89367877ebaSShri Abhyankar }
89467877ebaSShri Abhyankar 
895d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
896d71ae5a4SJacob Faibussowitsch {
89716ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *adiag, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
898a6053eceSJunchao Zhang   PetscInt64         rstart, nz, nza, nzb, i, j, jj, irow, countA, countB;
899a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
90016ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
90116ebf90aSShri Abhyankar   PetscScalar       *val;
902a3d589ffSStefano Zampini   Mat                Ad, Ao;
903a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
904a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
90538548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
906b94d7dedSBarry Smith   PetscBool hermitian, isset;
90738548759SBarry Smith #endif
90816ebf90aSShri Abhyankar 
90916ebf90aSShri Abhyankar   PetscFunctionBegin;
91038548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
911b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
912b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
91338548759SBarry Smith #endif
9149566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
9159566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
9169566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
917a3d589ffSStefano Zampini 
918a3d589ffSStefano Zampini   aa    = (Mat_SeqAIJ *)(Ad)->data;
919a3d589ffSStefano Zampini   bb    = (Mat_SeqAIJ *)(Ao)->data;
92038548759SBarry Smith   ai    = aa->i;
92138548759SBarry Smith   aj    = aa->j;
92238548759SBarry Smith   adiag = aa->diag;
92338548759SBarry Smith   bi    = bb->i;
92438548759SBarry Smith   bj    = bb->j;
9252205254eSKarl Rupp 
92616ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
92716ebf90aSShri Abhyankar 
928bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
929e0bace9bSHong Zhang     nza = 0; /* num of upper triangular entries in mat->A, including diagonals */
930e0bace9bSHong Zhang     nzb = 0; /* num of upper triangular entries in mat->B */
93116ebf90aSShri Abhyankar     for (i = 0; i < m; i++) {
932e0bace9bSHong Zhang       nza += (ai[i + 1] - adiag[i]);
93316ebf90aSShri Abhyankar       countB = bi[i + 1] - bi[i];
93416ebf90aSShri Abhyankar       bjj    = bj + bi[i];
935e0bace9bSHong Zhang       for (j = 0; j < countB; j++) {
936e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
937e0bace9bSHong Zhang       }
938e0bace9bSHong Zhang     }
93916ebf90aSShri Abhyankar 
940e0bace9bSHong Zhang     nz = nza + nzb; /* total nz of upper triangular part of mat */
9419566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
9429566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
943a6053eceSJunchao Zhang     mumps->nnz = nz;
944a6053eceSJunchao Zhang     mumps->irn = row;
945a6053eceSJunchao Zhang     mumps->jcn = col;
946a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
94716ebf90aSShri Abhyankar   } else {
948a6053eceSJunchao Zhang     val = mumps->val;
94916ebf90aSShri Abhyankar   }
95016ebf90aSShri Abhyankar 
9519371c9d4SSatish Balay   jj   = 0;
9529371c9d4SSatish Balay   irow = rstart;
95316ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
95416ebf90aSShri Abhyankar     ajj    = aj + adiag[i]; /* ptr to the beginning of the diagonal of this row */
95516ebf90aSShri Abhyankar     v1     = av + adiag[i];
95616ebf90aSShri Abhyankar     countA = ai[i + 1] - adiag[i];
95716ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
95816ebf90aSShri Abhyankar     bjj    = bj + bi[i];
95916ebf90aSShri Abhyankar     v2     = bv + bi[i];
96016ebf90aSShri Abhyankar 
96116ebf90aSShri Abhyankar     /* A-part */
96216ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
963bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9649566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9659566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
96616ebf90aSShri Abhyankar       }
96716ebf90aSShri Abhyankar       val[jj++] = v1[j];
96816ebf90aSShri Abhyankar     }
96916ebf90aSShri Abhyankar 
97016ebf90aSShri Abhyankar     /* B-part */
97116ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
97216ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
973bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9749566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9759566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
97616ebf90aSShri Abhyankar         }
97716ebf90aSShri Abhyankar         val[jj++] = v2[j];
97816ebf90aSShri Abhyankar       }
979397b6df1SKris Buschelman     }
980397b6df1SKris Buschelman     irow++;
981397b6df1SKris Buschelman   }
9829566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
9839566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
9843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
985397b6df1SKris Buschelman }
986397b6df1SKris Buschelman 
9879d0448ceSStefano Zampini PetscErrorCode MatConvertToTriples_nest_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
9889d0448ceSStefano Zampini {
9899d0448ceSStefano Zampini   Mat     **mats;
9909d0448ceSStefano Zampini   PetscInt  nr, nc;
9919d0448ceSStefano Zampini   PetscBool chol = mumps->sym ? PETSC_TRUE : PETSC_FALSE;
9929d0448ceSStefano Zampini 
9939d0448ceSStefano Zampini   PetscFunctionBegin;
9949d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
9959d0448ceSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
9969d0448ceSStefano Zampini     PetscMUMPSInt *irns, *jcns;
9979d0448ceSStefano Zampini     PetscScalar   *vals;
9989d0448ceSStefano Zampini     PetscInt64     totnnz, cumnnz, maxnnz;
9999d0448ceSStefano Zampini     PetscInt      *pjcns_w;
10009d0448ceSStefano Zampini     IS            *rows, *cols;
10019d0448ceSStefano Zampini     PetscInt     **rows_idx, **cols_idx;
10029d0448ceSStefano Zampini 
10039d0448ceSStefano Zampini     cumnnz = 0;
10049d0448ceSStefano Zampini     maxnnz = 0;
10055d955bbbSStefano Zampini     PetscCall(PetscMalloc2(nr * nc + 1, &mumps->nest_vals_start, nr * nc, &mumps->nest_convert_to_triples));
10069d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
10079d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
10089d0448ceSStefano Zampini         Mat sub = mats[r][c];
10099d0448ceSStefano Zampini 
10109d0448ceSStefano Zampini         mumps->nest_convert_to_triples[r * nc + c] = NULL;
10119d0448ceSStefano Zampini         if (chol && c < r) continue; /* skip lower-triangular block for Cholesky */
10129d0448ceSStefano Zampini         if (sub) {
10139d0448ceSStefano Zampini           PetscErrorCode (*convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *) = NULL;
10145d955bbbSStefano Zampini           PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans, isHTrans = PETSC_FALSE;
10159d0448ceSStefano Zampini           MatInfo   info;
10169d0448ceSStefano Zampini 
10175d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
10185d955bbbSStefano Zampini           if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
10195d955bbbSStefano Zampini           else {
10205d955bbbSStefano Zampini             PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
10215d955bbbSStefano Zampini             if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
10225d955bbbSStefano Zampini           }
10239d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
10249d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
10259d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
10269d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
10279d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
10289d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
10299d0448ceSStefano Zampini 
10309d0448ceSStefano Zampini           if (chol) {
10319d0448ceSStefano Zampini             if (r == c) {
10329d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqsbaij;
10339d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpisbaij;
10349d0448ceSStefano Zampini               else if (isSeqSBAIJ) convert_to_triples = MatConvertToTriples_seqsbaij_seqsbaij;
10359d0448ceSStefano Zampini               else if (isMPISBAIJ) convert_to_triples = MatConvertToTriples_mpisbaij_mpisbaij;
10369d0448ceSStefano Zampini             } else {
10379d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10389d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10399d0448ceSStefano Zampini               else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10409d0448ceSStefano Zampini               else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
10419d0448ceSStefano Zampini             }
10429d0448ceSStefano Zampini           } else {
10439d0448ceSStefano Zampini             if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10449d0448ceSStefano Zampini             else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10459d0448ceSStefano Zampini             else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10469d0448ceSStefano Zampini             else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
10479d0448ceSStefano Zampini           }
10489d0448ceSStefano Zampini           PetscCheck(convert_to_triples, PetscObjectComm((PetscObject)sub), PETSC_ERR_SUP, "Not for block of type %s", ((PetscObject)sub)->type_name);
10499d0448ceSStefano Zampini           mumps->nest_convert_to_triples[r * nc + c] = convert_to_triples;
10509d0448ceSStefano Zampini           PetscCall(MatGetInfo(sub, MAT_LOCAL, &info));
10519d0448ceSStefano Zampini           cumnnz += (PetscInt64)info.nz_used; /* can be overestimated for Cholesky */
10529d0448ceSStefano Zampini           maxnnz = PetscMax(maxnnz, info.nz_used);
10539d0448ceSStefano Zampini         }
10549d0448ceSStefano Zampini       }
10559d0448ceSStefano Zampini     }
10569d0448ceSStefano Zampini 
10579d0448ceSStefano Zampini     /* Allocate total COO */
10589d0448ceSStefano Zampini     totnnz = cumnnz;
10599d0448ceSStefano Zampini     PetscCall(PetscMalloc2(totnnz, &irns, totnnz, &jcns));
10609d0448ceSStefano Zampini     PetscCall(PetscMalloc1(totnnz, &vals));
10619d0448ceSStefano Zampini 
10629d0448ceSStefano Zampini     /* Handle rows and column maps
10639d0448ceSStefano Zampini        We directly map rows and use an SF for the columns */
10649d0448ceSStefano Zampini     PetscCall(PetscMalloc4(nr, &rows, nc, &cols, nr, &rows_idx, nc, &cols_idx));
10659d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
10669d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetIndices(rows[r], (const PetscInt **)&rows_idx[r]));
10679d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISGetIndices(cols[c], (const PetscInt **)&cols_idx[c]));
10689d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscMalloc1(maxnnz, &pjcns_w));
10695d955bbbSStefano Zampini     else (void)maxnnz;
10709d0448ceSStefano Zampini 
10719d0448ceSStefano Zampini     cumnnz = 0;
10729d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
10739d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
10749d0448ceSStefano Zampini         Mat             sub  = mats[r][c];
10759d0448ceSStefano Zampini         const PetscInt *ridx = rows_idx[r];
10765d955bbbSStefano Zampini         const PetscInt *cidx = cols_idx[c];
10779d0448ceSStefano Zampini         PetscInt        rst;
10789d0448ceSStefano Zampini         PetscSF         csf;
10795d955bbbSStefano Zampini         PetscBool       isTrans, isHTrans = PETSC_FALSE, swap;
10805d955bbbSStefano Zampini         PetscLayout     cmap;
10819d0448ceSStefano Zampini 
10829d0448ceSStefano Zampini         mumps->nest_vals_start[r * nc + c] = cumnnz;
10839d0448ceSStefano Zampini         if (!mumps->nest_convert_to_triples[r * nc + c]) continue;
10849d0448ceSStefano Zampini 
10855d955bbbSStefano Zampini         /* Extract inner blocks if needed */
10865d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
10875d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
10885d955bbbSStefano Zampini         else {
10895d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
10905d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
10915d955bbbSStefano Zampini         }
10925d955bbbSStefano Zampini         swap = (PetscBool)(isTrans || isHTrans);
10935d955bbbSStefano Zampini 
10945d955bbbSStefano Zampini         /* Get column layout to map off-process columns */
10955d955bbbSStefano Zampini         PetscCall(MatGetLayouts(sub, NULL, &cmap));
10965d955bbbSStefano Zampini 
10975d955bbbSStefano Zampini         /* Get row start to map on-process rows */
10985d955bbbSStefano Zampini         PetscCall(MatGetOwnershipRange(sub, &rst, NULL));
10995d955bbbSStefano Zampini 
11009d0448ceSStefano Zampini         /* Directly use the mumps datastructure and use C ordering for now */
11019d0448ceSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[r * nc + c])(sub, 0, MAT_INITIAL_MATRIX, mumps));
11029d0448ceSStefano Zampini 
11035d955bbbSStefano Zampini         /* Swap the role of rows and columns indices for transposed blocks
11045d955bbbSStefano Zampini            since we need values with global final ordering */
11055d955bbbSStefano Zampini         if (swap) {
11065d955bbbSStefano Zampini           cidx = rows_idx[r];
11075d955bbbSStefano Zampini           ridx = cols_idx[c];
11089d0448ceSStefano Zampini         }
11099d0448ceSStefano Zampini 
11105d955bbbSStefano Zampini         /* Communicate column indices
11115d955bbbSStefano Zampini            This could have been done with a single SF but it would have complicated the code a lot.
11125d955bbbSStefano Zampini            But since we do it only once, we pay the price of setting up an SF for each block */
11135d955bbbSStefano Zampini         if (PetscDefined(USE_64BIT_INDICES)) {
11145d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) pjcns_w[k] = mumps->jcn[k];
11155d955bbbSStefano Zampini         } else pjcns_w = (PetscInt *)(mumps->jcn); /* This cast is needed only to silence warnings for 64bit integers builds */
11169d0448ceSStefano Zampini         PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)A), &csf));
11175d955bbbSStefano Zampini         PetscCall(PetscSFSetGraphLayout(csf, cmap, mumps->nnz, NULL, PETSC_OWN_POINTER, pjcns_w));
11185d955bbbSStefano Zampini         PetscCall(PetscSFBcastBegin(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11195d955bbbSStefano Zampini         PetscCall(PetscSFBcastEnd(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11209d0448ceSStefano Zampini         PetscCall(PetscSFDestroy(&csf));
11219d0448ceSStefano Zampini 
11225d955bbbSStefano Zampini         /* Import indices: use direct map for rows and mapped indices for columns */
11235d955bbbSStefano Zampini         if (swap) {
11245d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11255d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &jcns[cumnnz + k]));
11265d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &irns[cumnnz + k]));
11275d955bbbSStefano Zampini           }
11285d955bbbSStefano Zampini         } else {
11295d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11305d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &irns[cumnnz + k]));
11315d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &jcns[cumnnz + k]));
11325d955bbbSStefano Zampini           }
11335d955bbbSStefano Zampini         }
11345d955bbbSStefano Zampini 
11355d955bbbSStefano Zampini         /* Import values to full COO */
11365d955bbbSStefano Zampini         if (isHTrans) { /* conjugate the entries */
11375d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) mumps->val[k] = PetscConj(mumps->val[k]);
11385d955bbbSStefano Zampini         }
11395d955bbbSStefano Zampini         PetscCall(PetscArraycpy(vals + cumnnz, mumps->val, mumps->nnz));
11409d0448ceSStefano Zampini 
11419d0448ceSStefano Zampini         /* Shift new starting point and sanity check */
11429d0448ceSStefano Zampini         cumnnz += mumps->nnz;
11439d0448ceSStefano Zampini         PetscCheck(cumnnz <= totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Unexpected number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11449d0448ceSStefano Zampini 
11459d0448ceSStefano Zampini         /* Free scratch memory */
11469d0448ceSStefano Zampini         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
11479d0448ceSStefano Zampini         PetscCall(PetscFree(mumps->val_alloc));
11489d0448ceSStefano Zampini         mumps->val = NULL;
11499d0448ceSStefano Zampini         mumps->nnz = 0;
11509d0448ceSStefano Zampini       }
11519d0448ceSStefano Zampini     }
11529d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscFree(pjcns_w));
11539d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISRestoreIndices(rows[r], (const PetscInt **)&rows_idx[r]));
11549d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISRestoreIndices(cols[c], (const PetscInt **)&cols_idx[c]));
11559d0448ceSStefano Zampini     PetscCall(PetscFree4(rows, cols, rows_idx, cols_idx));
11569d0448ceSStefano Zampini     if (!chol) PetscCheck(cumnnz == totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11575d955bbbSStefano Zampini     mumps->nest_vals_start[nr * nc] = cumnnz;
11589d0448ceSStefano Zampini 
11599d0448ceSStefano Zampini     /* Set pointers for final MUMPS data structure */
11609d0448ceSStefano Zampini     mumps->nest_vals = vals;
11619d0448ceSStefano Zampini     mumps->val_alloc = NULL; /* do not use val_alloc since it may be reallocated with the OMP callpath */
11629d0448ceSStefano Zampini     mumps->val       = vals;
11639d0448ceSStefano Zampini     mumps->irn       = irns;
11649d0448ceSStefano Zampini     mumps->jcn       = jcns;
11659d0448ceSStefano Zampini     mumps->nnz       = cumnnz;
11669d0448ceSStefano Zampini   } else {
11679d0448ceSStefano Zampini     PetscScalar *oval = mumps->nest_vals;
11689d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11699d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11705d955bbbSStefano Zampini         PetscBool isTrans, isHTrans = PETSC_FALSE;
11715d955bbbSStefano Zampini         Mat       sub  = mats[r][c];
11725d955bbbSStefano Zampini         PetscInt  midx = r * nc + c;
11735d955bbbSStefano Zampini 
11745d955bbbSStefano Zampini         if (!mumps->nest_convert_to_triples[midx]) continue;
11755d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
11765d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
11775d955bbbSStefano Zampini         else {
11785d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
11795d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
11805d955bbbSStefano Zampini         }
11815d955bbbSStefano Zampini         mumps->val = oval + mumps->nest_vals_start[midx];
11825d955bbbSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[midx])(sub, shift, MAT_REUSE_MATRIX, mumps));
11835d955bbbSStefano Zampini         if (isHTrans) {
11845d955bbbSStefano Zampini           PetscInt nnz = mumps->nest_vals_start[midx + 1] - mumps->nest_vals_start[midx];
11855d955bbbSStefano Zampini           for (PetscInt k = 0; k < nnz; k++) mumps->val[k] = PetscConj(mumps->val[k]);
11865d955bbbSStefano Zampini         }
11879d0448ceSStefano Zampini       }
11889d0448ceSStefano Zampini     }
11899d0448ceSStefano Zampini     mumps->val = oval;
11909d0448ceSStefano Zampini   }
11919d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
11929d0448ceSStefano Zampini }
11939d0448ceSStefano Zampini 
1194d71ae5a4SJacob Faibussowitsch PetscErrorCode MatDestroy_MUMPS(Mat A)
1195d71ae5a4SJacob Faibussowitsch {
1196a6053eceSJunchao Zhang   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
1197b24902e0SBarry Smith 
1198397b6df1SKris Buschelman   PetscFunctionBegin;
11999566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
12009566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
12019566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
12029566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
12039566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
12049566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
12059566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn, mumps->jcn));
12069566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
12079566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
1208413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->ICNTL_pre));
1209413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->CNTL_pre));
12109566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
1211413bcc21SPierre Jolivet   if (mumps->id.job != JOB_NULL) { /* cannot call PetscMUMPS_c() if JOB_INIT has never been called for this instance */
1212a5e57a09SHong Zhang     mumps->id.job = JOB_END;
12133ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
12149261f6e4SBarry 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));
1215413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
1216413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) PetscCallMPI(MPI_Comm_free(&mumps->mumps_comm));
1217413bcc21SPierre Jolivet       else PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A), &mumps->mumps_comm));
1218413bcc21SPierre Jolivet     }
1219413bcc21SPierre Jolivet   }
12203ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
122167602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
12229566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
12239566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
12249566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow, mumps->rhs_recvcounts, mumps->rhs_disps));
122567602552SJunchao Zhang   }
12263ab56b82SJunchao Zhang #endif
12279566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
12289566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
12299566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
12309566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
12319566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
12329d0448ceSStefano Zampini   PetscCall(PetscFree2(mumps->nest_vals_start, mumps->nest_convert_to_triples));
12339d0448ceSStefano Zampini   PetscCall(PetscFree(mumps->nest_vals));
12349566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
1235bf0cc555SLisandro Dalcin 
123697969023SHong Zhang   /* clear composed functions */
12379566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorGetSolverType_C", NULL));
12389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorSetSchurIS_C", NULL));
12399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorCreateSchurComplement_C", NULL));
12409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetIcntl_C", NULL));
12419566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetIcntl_C", NULL));
12429566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetCntl_C", NULL));
12439566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetCntl_C", NULL));
12449566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfo_C", NULL));
12459566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfog_C", NULL));
12469566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfo_C", NULL));
12479566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfog_C", NULL));
12485c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetNullPivots_C", NULL));
12499566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverse_C", NULL));
12509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverseTranspose_C", NULL));
12513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1252397b6df1SKris Buschelman }
1253397b6df1SKris Buschelman 
125467602552SJunchao 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. */
1255d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A, PetscInt nrhs, const PetscScalar *array)
1256d71ae5a4SJacob Faibussowitsch {
125767602552SJunchao Zhang   Mat_MUMPS        *mumps   = (Mat_MUMPS *)A->data;
125867602552SJunchao Zhang   const PetscMPIInt ompsize = mumps->omp_comm_size;
125967602552SJunchao Zhang   PetscInt          i, m, M, rstart;
126067602552SJunchao Zhang 
126167602552SJunchao Zhang   PetscFunctionBegin;
12629566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, NULL));
12639566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, NULL));
126408401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
126567602552SJunchao Zhang   if (ompsize == 1) {
126667602552SJunchao Zhang     if (!mumps->irhs_loc) {
126767602552SJunchao Zhang       mumps->nloc_rhs = m;
12689566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m, &mumps->irhs_loc));
12699566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A, &rstart, NULL));
127067602552SJunchao Zhang       for (i = 0; i < m; i++) mumps->irhs_loc[i] = rstart + i + 1; /* use 1-based indices */
127167602552SJunchao Zhang     }
127267602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar *)array;
127367602552SJunchao Zhang   } else {
127467602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
127567602552SJunchao Zhang     const PetscInt *ranges;
127667602552SJunchao Zhang     PetscMPIInt     j, k, sendcount, *petsc_ranks, *omp_ranks;
127767602552SJunchao Zhang     MPI_Group       petsc_group, omp_group;
127867602552SJunchao Zhang     PetscScalar    *recvbuf = NULL;
127967602552SJunchao Zhang 
128067602552SJunchao Zhang     if (mumps->is_omp_master) {
128167602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
128267602552SJunchao Zhang       if (!mumps->irhs_loc) {
12839566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize, &omp_ranks, ompsize, &petsc_ranks));
12849566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize, &mumps->rhs_nrow, ompsize, &mumps->rhs_recvcounts, ompsize, &mumps->rhs_disps));
12859566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm, &petsc_group));
12869566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm, &omp_group));
128767602552SJunchao Zhang         for (j = 0; j < ompsize; j++) omp_ranks[j] = j;
12889566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group, ompsize, omp_ranks, petsc_group, petsc_ranks));
128967602552SJunchao Zhang 
129067602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
129167602552SJunchao Zhang         mumps->nloc_rhs = 0;
12929566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A, &ranges));
129367602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
129467602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j] + 1] - ranges[petsc_ranks[j]];
129567602552SJunchao Zhang           mumps->nloc_rhs += mumps->rhs_nrow[j];
129667602552SJunchao Zhang         }
12979566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs, &mumps->irhs_loc));
129867602552SJunchao Zhang         for (j = k = 0; j < ompsize; j++) {
129967602552SJunchao 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 */
130067602552SJunchao Zhang         }
130167602552SJunchao Zhang 
13029566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks, petsc_ranks));
13039566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
13049566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
130567602552SJunchao Zhang       }
130667602552SJunchao Zhang 
130767602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
130867602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
13099566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
13109566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs * nrhs, &mumps->rhs_loc, mumps->nloc_rhs * nrhs, &mumps->rhs_recvbuf));
131167602552SJunchao Zhang         mumps->max_nrhs = nrhs;
131267602552SJunchao Zhang       }
131367602552SJunchao Zhang 
131467602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
13159566063dSJacob Faibussowitsch       for (j = 0; j < ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j] * nrhs, &mumps->rhs_recvcounts[j]));
131667602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
131767602552SJunchao Zhang       for (j = 1; j < ompsize; j++) {
131867602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j - 1] + mumps->rhs_recvcounts[j - 1];
131908401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscMPIInt overflow!");
132067602552SJunchao Zhang       }
132167602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
132267602552SJunchao Zhang     }
132367602552SJunchao Zhang 
13249566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m * nrhs, &sendcount));
13259566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array, sendcount, MPIU_SCALAR, recvbuf, mumps->rhs_recvcounts, mumps->rhs_disps, MPIU_SCALAR, 0, mumps->omp_comm));
132667602552SJunchao Zhang 
132767602552SJunchao Zhang     if (mumps->is_omp_master) {
132867602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
132967602552SJunchao Zhang         PetscScalar *dst, *dstbase = mumps->rhs_loc;
133067602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
133167602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
133267602552SJunchao Zhang           dst                    = dstbase;
133367602552SJunchao Zhang           for (i = 0; i < nrhs; i++) {
13349566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst, src, mumps->rhs_nrow[j]));
133567602552SJunchao Zhang             src += mumps->rhs_nrow[j];
133667602552SJunchao Zhang             dst += mumps->nloc_rhs;
133767602552SJunchao Zhang           }
133867602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
133967602552SJunchao Zhang         }
134067602552SJunchao Zhang       }
134167602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar *)mumps->rhs_loc;
134267602552SJunchao Zhang     }
134367602552SJunchao Zhang #endif /* PETSC_HAVE_OPENMP_SUPPORT */
134467602552SJunchao Zhang   }
134567602552SJunchao Zhang   mumps->id.nrhs     = nrhs;
134667602552SJunchao Zhang   mumps->id.nloc_rhs = mumps->nloc_rhs;
134767602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
134867602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
13493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
135067602552SJunchao Zhang }
135167602552SJunchao Zhang 
1352d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSolve_MUMPS(Mat A, Vec b, Vec x)
1353d71ae5a4SJacob Faibussowitsch {
1354e69c285eSBarry Smith   Mat_MUMPS         *mumps  = (Mat_MUMPS *)A->data;
135525aac85cSJunchao Zhang   const PetscScalar *rarray = NULL;
1356d54de34fSKris Buschelman   PetscScalar       *array;
1357329ec9b3SHong Zhang   IS                 is_iden, is_petsc;
1358329ec9b3SHong Zhang   PetscInt           i;
1359cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1360883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE, cite2 = PETSC_FALSE;
1361397b6df1SKris Buschelman 
1362397b6df1SKris Buschelman   PetscFunctionBegin;
13639371c9d4SSatish 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 "
13649371c9d4SSatish Balay                                    "Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",
13659371c9d4SSatish Balay                                    &cite1));
13669371c9d4SSatish 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 "
13679371c9d4SSatish Balay                                    "Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",
13689371c9d4SSatish Balay                                    &cite2));
13692aca8efcSHong Zhang 
1370603e8f96SBarry Smith   if (A->factorerrortype) {
13719566063dSJacob 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)));
13729566063dSJacob Faibussowitsch     PetscCall(VecSetInf(x));
13733ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
13742aca8efcSHong Zhang   }
13752aca8efcSHong Zhang 
1376a5e57a09SHong Zhang   mumps->id.nrhs = 1;
13772d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
137825aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
137967602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
13809566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b, &rarray));
13819566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, 1, rarray));
138225aac85cSJunchao Zhang     } else {
138341ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
13849566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
13859566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
138667602552SJunchao Zhang       if (!mumps->myid) {
13879566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq, &array));
138867602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar *)array;
138967602552SJunchao Zhang       }
139025aac85cSJunchao Zhang     }
13913ab56b82SJunchao Zhang   } else {                   /* petsc_size == 1 */
139267602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
13939566063dSJacob Faibussowitsch     PetscCall(VecCopy(b, x));
13949566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x, &array));
1395940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar *)array;
1396397b6df1SKris Buschelman   }
1397397b6df1SKris Buschelman 
1398cc86f929SStefano Zampini   /*
1399cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1400cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1401cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1402cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1403cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1404cc86f929SStefano Zampini   */
1405*3e5b40d0SPierre Jolivet   if (mumps->id.size_schur > 0) {
140608401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1407*3e5b40d0SPierre Jolivet     if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1408cc86f929SStefano Zampini       second_solve = PETSC_TRUE;
14099566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1410*3e5b40d0SPierre Jolivet       mumps->id.ICNTL(26) = 1; /* condensation phase */
1411*3e5b40d0SPierre Jolivet     } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1412cc86f929SStefano Zampini   }
1413397b6df1SKris Buschelman   /* solve phase */
1414a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
14153ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
14169261f6e4SBarry 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));
1417397b6df1SKris Buschelman 
1418b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
14191baa6e33SBarry Smith   if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
1420*3e5b40d0SPierre Jolivet   else if (mumps->id.ICNTL(26) == 1) {
1421*3e5b40d0SPierre Jolivet     PetscCall(MatMumpsSolveSchur_Private(A));
1422*3e5b40d0SPierre Jolivet     for (i = 0; i < mumps->id.size_schur; ++i) {
1423*3e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
1424*3e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i];
1425*3e5b40d0SPierre Jolivet #else
1426*3e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i].r + PETSC_i * mumps->id.redrhs[i].i;
1427*3e5b40d0SPierre Jolivet #endif
1428*3e5b40d0SPierre Jolivet       array[mumps->id.listvar_schur[i] - 1] = val;
1429*3e5b40d0SPierre Jolivet     }
1430*3e5b40d0SPierre Jolivet   }
1431b5fa320bSStefano Zampini 
14322d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to petsc mpi x */
1433a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1434a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
14359566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1436397b6df1SKris Buschelman     }
1437a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1438a6053eceSJunchao Zhang       PetscInt *isol2_loc = NULL;
14399566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, mumps->id.lsol_loc, 0, 1, &is_iden)); /* from */
14409566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc, &isol2_loc));
1441a6053eceSJunchao 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 */
14429566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, mumps->id.lsol_loc, isol2_loc, PETSC_OWN_POINTER, &is_petsc)); /* to */
14439566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq, is_iden, x, is_petsc, &mumps->scat_sol));
14449566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
14459566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1446a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1447397b6df1SKris Buschelman     }
1448a5e57a09SHong Zhang 
14499566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
14509566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
1451329ec9b3SHong Zhang   }
1452353d7d71SJunchao Zhang 
145367602552SJunchao Zhang   if (mumps->petsc_size > 1) {
145425aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
14559566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b, &rarray));
145625aac85cSJunchao Zhang     } else if (!mumps->myid) {
14579566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq, &array));
145825aac85cSJunchao Zhang     }
14599566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x, &array));
1460353d7d71SJunchao Zhang 
146164412097SPierre Jolivet   PetscCall(PetscLogFlops(2.0 * PetscMax(0, (mumps->id.INFO(28) >= 0 ? mumps->id.INFO(28) : -1000000 * mumps->id.INFO(28)) - A->cmap->n)));
14623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1463397b6df1SKris Buschelman }
1464397b6df1SKris Buschelman 
1465d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSolveTranspose_MUMPS(Mat A, Vec b, Vec x)
1466d71ae5a4SJacob Faibussowitsch {
1467e69c285eSBarry Smith   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1468338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
146951d5961aSHong Zhang 
147051d5961aSHong Zhang   PetscFunctionBegin;
1471a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
14729566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A, b, x));
1473338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
14743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
147551d5961aSHong Zhang }
147651d5961aSHong Zhang 
1477d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatSolve_MUMPS(Mat A, Mat B, Mat X)
1478d71ae5a4SJacob Faibussowitsch {
1479b8491c3eSStefano Zampini   Mat                Bt = NULL;
1480a6053eceSJunchao Zhang   PetscBool          denseX, denseB, flg, flgT;
1481e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)A->data;
1482334c5f61SHong Zhang   PetscInt           i, nrhs, M;
14831683a169SBarry Smith   PetscScalar       *array;
14841683a169SBarry Smith   const PetscScalar *rbray;
1485a6053eceSJunchao Zhang   PetscInt           lsol_loc, nlsol_loc, *idxx, iidx = 0;
1486a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc, *isol_loc_save;
14871683a169SBarry Smith   PetscScalar       *bray, *sol_loc, *sol_loc_save;
1488be818407SHong Zhang   IS                 is_to, is_from;
1489beae5ec0SHong Zhang   PetscInt           k, proc, j, m, myrstart;
1490be818407SHong Zhang   const PetscInt    *rstart;
149167602552SJunchao Zhang   Vec                v_mpi, msol_loc;
149267602552SJunchao Zhang   VecScatter         scat_sol;
149367602552SJunchao Zhang   Vec                b_seq;
149467602552SJunchao Zhang   VecScatter         scat_rhs;
1495be818407SHong Zhang   PetscScalar       *aa;
1496be818407SHong Zhang   PetscInt           spnr, *ia, *ja;
1497d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1498bda8bf91SBarry Smith 
1499e0b74bf9SHong Zhang   PetscFunctionBegin;
15009566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X, &denseX, MATSEQDENSE, MATMPIDENSE, NULL));
150128b400f6SJacob Faibussowitsch   PetscCheck(denseX, PetscObjectComm((PetscObject)X), PETSC_ERR_ARG_WRONG, "Matrix X must be MATDENSE matrix");
1502be818407SHong Zhang 
15039566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B, &denseB, MATSEQDENSE, MATMPIDENSE, NULL));
1504a6053eceSJunchao Zhang   if (denseB) {
150508401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix B and X must have same row distribution");
1506be818407SHong Zhang     mumps->id.ICNTL(20) = 0; /* dense RHS */
15070e6b8875SHong Zhang   } else {                   /* sparse B */
150808401ef6SPierre Jolivet     PetscCheck(X != B, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_IDN, "X and B must be different matrices");
1509013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)B, MATTRANSPOSEVIRTUAL, &flgT));
1510da81f932SPierre Jolivet     if (flgT) { /* input B is transpose of actual RHS matrix,
15110e6b8875SHong Zhang                  because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
15129566063dSJacob Faibussowitsch       PetscCall(MatTransposeGetMat(B, &Bt));
1513013e2dc7SBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)B), PETSC_ERR_ARG_WRONG, "Matrix B must be MATTRANSPOSEVIRTUAL matrix");
1514be818407SHong Zhang     mumps->id.ICNTL(20) = 1; /* sparse RHS */
1515b8491c3eSStefano Zampini   }
151687b22cf4SHong Zhang 
15179566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, &nrhs));
15189481e6e9SHong Zhang   mumps->id.nrhs = nrhs;
15199481e6e9SHong Zhang   mumps->id.lrhs = M;
15202b691707SHong Zhang   mumps->id.rhs  = NULL;
15219481e6e9SHong Zhang 
15222d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1523b8491c3eSStefano Zampini     PetscScalar *aa;
1524b8491c3eSStefano Zampini     PetscInt     spnr, *ia, *ja;
1525e94cce23SStefano Zampini     PetscBool    second_solve = PETSC_FALSE;
1526b8491c3eSStefano Zampini 
15279566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &array));
1528b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar *)array;
15292b691707SHong Zhang 
1530a6053eceSJunchao Zhang     if (denseB) {
15312b691707SHong Zhang       /* copy B to X */
15329566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
15339566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, rbray, M * nrhs));
15349566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
15352b691707SHong Zhang     } else { /* sparse B */
15369566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt, &aa));
15379566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
153828b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
15399566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
1540b8491c3eSStefano Zampini       mumps->id.rhs_sparse = (MumpsScalar *)aa;
1541b8491c3eSStefano Zampini     }
1542e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
1543*3e5b40d0SPierre Jolivet     if (mumps->id.size_schur > 0) {
1544*3e5b40d0SPierre Jolivet       PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1545*3e5b40d0SPierre Jolivet       if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1546e94cce23SStefano Zampini         second_solve = PETSC_TRUE;
15479566063dSJacob Faibussowitsch         PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1548*3e5b40d0SPierre Jolivet         mumps->id.ICNTL(26) = 1; /* condensation phase */
1549*3e5b40d0SPierre Jolivet       } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1550e94cce23SStefano Zampini     }
15512cd7d884SHong Zhang     /* solve phase */
15522cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
15533ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
15549261f6e4SBarry 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));
1555b5fa320bSStefano Zampini 
1556b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
15571baa6e33SBarry Smith     if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
1558*3e5b40d0SPierre Jolivet     else if (mumps->id.ICNTL(26) == 1) {
1559*3e5b40d0SPierre Jolivet       PetscCall(MatMumpsSolveSchur_Private(A));
1560*3e5b40d0SPierre Jolivet       for (j = 0; j < nrhs; ++j)
1561*3e5b40d0SPierre Jolivet         for (i = 0; i < mumps->id.size_schur; ++i) {
1562*3e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
1563*3e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs];
1564*3e5b40d0SPierre Jolivet #else
1565*3e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs].r + PETSC_i * mumps->id.redrhs[i + j * mumps->id.lredrhs].i;
1566*3e5b40d0SPierre Jolivet #endif
1567*3e5b40d0SPierre Jolivet           array[mumps->id.listvar_schur[i] - 1 + j * M] = val;
1568*3e5b40d0SPierre Jolivet         }
1569*3e5b40d0SPierre Jolivet     }
1570a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
15719566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt, &aa));
15729566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
157328b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
1574b8491c3eSStefano Zampini     }
15759566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &array));
15763ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1577be818407SHong Zhang   }
1578801fbe65SHong Zhang 
15792ef1f0ffSBarry Smith   /* parallel case: MUMPS requires rhs B to be centralized on the host! */
1580aed4548fSBarry Smith   PetscCheck(mumps->petsc_size <= 1 || !mumps->id.ICNTL(19), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1581241dbb5eSStefano Zampini 
1582beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
15831683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
15841683a169SBarry Smith   sol_loc_save  = (PetscScalar *)mumps->id.sol_loc;
1585801fbe65SHong Zhang 
1586a1dfcbd9SJunchao Zhang   lsol_loc  = mumps->id.lsol_loc;
158771aed81dSHong Zhang   nlsol_loc = nrhs * lsol_loc; /* length of sol_loc */
15889566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc, &sol_loc, lsol_loc, &isol_loc));
1589940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
1590801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1591801fbe65SHong Zhang 
15929566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, nlsol_loc, (PetscScalar *)sol_loc, &msol_loc));
15932cd7d884SHong Zhang 
159467602552SJunchao Zhang   if (denseB) {
159525aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
159667602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
15979566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
15989566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, nrhs, rbray));
15999566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
16009566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
16019566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, NULL, &v_mpi));
160225aac85cSJunchao Zhang     } else {
160325aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
160480577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
160580577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
160680577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
160780577c12SJunchao Zhang       */
160880577c12SJunchao Zhang 
160967602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1610be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
16119566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
16129566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B, &bray));
16139566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16149566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B, &bray));
16152b691707SHong Zhang 
1616be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1617801fbe65SHong Zhang       if (!mumps->myid) {
1618beae5ec0SHong Zhang         PetscInt *idx;
1619beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
16209566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nrhs * M, &idx));
16219566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B, &rstart));
1622be818407SHong Zhang         k = 0;
16232d4298aeSJunchao Zhang         for (proc = 0; proc < mumps->petsc_size; proc++) {
1624be818407SHong Zhang           for (j = 0; j < nrhs; j++) {
1625beae5ec0SHong Zhang             for (i = rstart[proc]; i < rstart[proc + 1]; i++) idx[k++] = j * M + i;
1626be818407SHong Zhang           }
1627be818407SHong Zhang         }
1628be818407SHong Zhang 
16299566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, nrhs * M, &b_seq));
16309566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nrhs * M, idx, PETSC_OWN_POINTER, &is_to));
16319566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, nrhs * M, 0, 1, &is_from));
1632801fbe65SHong Zhang       } else {
16339566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, 0, &b_seq));
16349566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_to));
16359566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_from));
1636801fbe65SHong Zhang       }
16379566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi, is_from, b_seq, is_to, &scat_rhs));
16389566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
16399566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
16409566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
16419566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
1642801fbe65SHong Zhang 
1643801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
16449566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq, &bray));
1645940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar *)bray;
16469566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq, &bray));
1647801fbe65SHong Zhang       }
164825aac85cSJunchao Zhang     }
16492b691707SHong Zhang   } else { /* sparse B */
16502b691707SHong Zhang     b = (Mat_MPIAIJ *)Bt->data;
16512b691707SHong Zhang 
1652be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
16539566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X, &m, NULL));
16549566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &bray));
16559566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16569566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &bray));
16572b691707SHong Zhang 
16582b691707SHong Zhang     if (!mumps->myid) {
16599566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A, &aa));
16609566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
166128b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
16629566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
16632b691707SHong Zhang       mumps->id.rhs_sparse = (MumpsScalar *)aa;
16642b691707SHong Zhang     } else {
16652b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
16662b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
16672b691707SHong Zhang       mumps->id.nz_rhs      = 0;
16682b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
16692b691707SHong Zhang     }
16702b691707SHong Zhang   }
16712b691707SHong Zhang 
1672801fbe65SHong Zhang   /* solve phase */
1673801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
16743ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
16759261f6e4SBarry 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));
1676801fbe65SHong Zhang 
1677334c5f61SHong Zhang   /* scatter mumps distributed solution to petsc vector v_mpi, which shares local arrays with solution matrix X */
16789566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X, &array));
16799566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi, array));
1680801fbe65SHong Zhang 
1681334c5f61SHong Zhang   /* create scatter scat_sol */
16829566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X, &rstart));
1683beae5ec0SHong Zhang   /* iidx: index for scatter mumps solution to petsc X */
1684beae5ec0SHong Zhang 
16859566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, nlsol_loc, 0, 1, &is_from));
16869566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc, &idxx));
1687beae5ec0SHong Zhang   for (i = 0; i < lsol_loc; i++) {
1688beae5ec0SHong 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 */
1689beae5ec0SHong Zhang 
16902d4298aeSJunchao Zhang     for (proc = 0; proc < mumps->petsc_size; proc++) {
1691beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc + 1]) {
1692beae5ec0SHong Zhang         myrstart = rstart[proc];
1693beae5ec0SHong Zhang         k        = isol_loc[i] - myrstart;          /* local index on 1st column of petsc vector X */
1694beae5ec0SHong Zhang         iidx     = k + myrstart * nrhs;             /* maps mumps isol_loc[i] to petsc index in X */
1695beae5ec0SHong Zhang         m        = rstart[proc + 1] - rstart[proc]; /* rows of X for this proc */
1696beae5ec0SHong Zhang         break;
1697be818407SHong Zhang       }
1698be818407SHong Zhang     }
1699be818407SHong Zhang 
1700beae5ec0SHong Zhang     for (j = 0; j < nrhs; j++) idxx[i + j * lsol_loc] = iidx + j * m;
1701801fbe65SHong Zhang   }
17029566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nlsol_loc, idxx, PETSC_COPY_VALUES, &is_to));
17039566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc, is_from, v_mpi, is_to, &scat_sol));
17049566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
17059566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
17069566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
17079566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
17089566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X, &array));
170971aed81dSHong Zhang 
171071aed81dSHong Zhang   /* free spaces */
17111683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar *)sol_loc_save;
171271aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
171371aed81dSHong Zhang 
17149566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc, isol_loc));
17159566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
17169566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
17179566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1718a6053eceSJunchao Zhang   if (!denseB) {
17192b691707SHong Zhang     if (!mumps->myid) {
1720d56c302dSHong Zhang       b = (Mat_MPIAIJ *)Bt->data;
17219566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A, &aa));
17229566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
172328b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
17242b691707SHong Zhang     }
17252b691707SHong Zhang   } else {
172625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
17279566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
17289566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
172925aac85cSJunchao Zhang     }
17302b691707SHong Zhang   }
17319566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
173264412097SPierre 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))));
17333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1734e0b74bf9SHong Zhang }
1735e0b74bf9SHong Zhang 
1736d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatSolveTranspose_MUMPS(Mat A, Mat B, Mat X)
1737d71ae5a4SJacob Faibussowitsch {
1738b18964edSHong Zhang   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1739338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
1740b18964edSHong Zhang 
1741b18964edSHong Zhang   PetscFunctionBegin;
1742b18964edSHong Zhang   mumps->id.ICNTL(9) = 0;
1743b18964edSHong Zhang   PetscCall(MatMatSolve_MUMPS(A, B, X));
1744338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
17453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1746b18964edSHong Zhang }
1747b18964edSHong Zhang 
1748d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A, Mat Bt, Mat X)
1749d71ae5a4SJacob Faibussowitsch {
1750eb3ef3b2SHong Zhang   PetscBool flg;
1751eb3ef3b2SHong Zhang   Mat       B;
1752eb3ef3b2SHong Zhang 
1753eb3ef3b2SHong Zhang   PetscFunctionBegin;
17549566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
175528b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)Bt), PETSC_ERR_ARG_WRONG, "Matrix Bt must be MATAIJ matrix");
1756eb3ef3b2SHong Zhang 
1757eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
17589566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt, &B));
1759eb3ef3b2SHong Zhang 
17609566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A, B, X));
17619566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
17623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1763eb3ef3b2SHong Zhang }
1764eb3ef3b2SHong Zhang 
1765ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1766a58c3f20SHong Zhang /*
1767a58c3f20SHong Zhang   input:
1768a58c3f20SHong Zhang    F:        numeric factor
1769a58c3f20SHong Zhang   output:
1770a58c3f20SHong Zhang    nneg:     total number of negative pivots
177119d49a3bSHong Zhang    nzero:    total number of zero pivots
177219d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1773a58c3f20SHong Zhang */
1774d71ae5a4SJacob Faibussowitsch PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F, PetscInt *nneg, PetscInt *nzero, PetscInt *npos)
1775d71ae5a4SJacob Faibussowitsch {
1776e69c285eSBarry Smith   Mat_MUMPS  *mumps = (Mat_MUMPS *)F->data;
1777c1490034SHong Zhang   PetscMPIInt size;
1778a58c3f20SHong Zhang 
1779a58c3f20SHong Zhang   PetscFunctionBegin;
17809566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F), &size));
1781bcb30aebSHong 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 */
1782aed4548fSBarry 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));
1783ed85ac9fSHong Zhang 
1784710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1785ed85ac9fSHong Zhang   if (nzero || npos) {
178608401ef6SPierre 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");
1787710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1788710ac8efSHong Zhang     if (npos) *npos = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1789a58c3f20SHong Zhang   }
17903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1791a58c3f20SHong Zhang }
179219d49a3bSHong Zhang #endif
1793a58c3f20SHong Zhang 
1794d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse, Mat_MUMPS *mumps)
1795d71ae5a4SJacob Faibussowitsch {
1796a6053eceSJunchao Zhang   PetscInt       i, nreqs;
1797a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;
1798a6053eceSJunchao Zhang   PetscMPIInt    count;
1799a6053eceSJunchao Zhang   PetscInt64     totnnz, remain;
1800a6053eceSJunchao Zhang   const PetscInt osize = mumps->omp_comm_size;
1801a6053eceSJunchao Zhang   PetscScalar   *val;
18023ab56b82SJunchao Zhang 
18033ab56b82SJunchao Zhang   PetscFunctionBegin;
1804a6053eceSJunchao Zhang   if (osize > 1) {
18053ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
18063ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
18079566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize, &mumps->recvcount));
18089566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz, 1, MPIU_INT64, mumps->recvcount, 1, MPIU_INT64, 0 /*master*/, mumps->omp_comm));
18093ab56b82SJunchao Zhang 
1810a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
18113ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1812a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1813a6053eceSJunchao Zhang         nreqs = 0;
1814a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) nreqs += (mumps->recvcount[i] + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
1815a6053eceSJunchao Zhang       } else {
1816a6053eceSJunchao Zhang         nreqs = (mumps->nnz + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
18173ab56b82SJunchao Zhang       }
181835cb6cd3SPierre Jolivet       PetscCall(PetscMalloc1(nreqs * 3, &mumps->reqs)); /* Triple the requests since we send irn, jcn and val separately */
18193ab56b82SJunchao Zhang 
1820a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1821a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1822a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1823a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1824a6053eceSJunchao Zhang        */
1825a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
18263ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1827a6053eceSJunchao Zhang         for (i = 0, totnnz = 0; i < osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
18289566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz, &irn, totnnz, &jcn));
18299566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz, &val));
1830a6053eceSJunchao Zhang 
1831a6053eceSJunchao Zhang         /* Self communication */
18329566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn, mumps->irn, mumps->nnz));
18339566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn, mumps->jcn, mumps->nnz));
18349566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val, mumps->val, mumps->nnz));
1835a6053eceSJunchao Zhang 
1836a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
18379566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
18389566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1839a6053eceSJunchao Zhang         mumps->nnz = totnnz;
18403ab56b82SJunchao Zhang         mumps->irn = irn;
18413ab56b82SJunchao Zhang         mumps->jcn = jcn;
1842a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1843a6053eceSJunchao Zhang 
1844a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
1845a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
1846a6053eceSJunchao Zhang         val += mumps->recvcount[0];
1847a6053eceSJunchao Zhang 
1848a6053eceSJunchao Zhang         /* Remote communication */
1849a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) {
1850a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1851a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1852a6053eceSJunchao Zhang           while (count > 0) {
18539566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(irn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18549566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(jcn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18559566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1856a6053eceSJunchao Zhang             irn += count;
1857a6053eceSJunchao Zhang             jcn += count;
1858a6053eceSJunchao Zhang             val += count;
1859a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1860a6053eceSJunchao Zhang             remain -= count;
1861a6053eceSJunchao Zhang           }
18623ab56b82SJunchao Zhang         }
18633ab56b82SJunchao Zhang       } else {
1864a6053eceSJunchao Zhang         irn    = mumps->irn;
1865a6053eceSJunchao Zhang         jcn    = mumps->jcn;
1866a6053eceSJunchao Zhang         val    = mumps->val;
1867a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1868a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1869a6053eceSJunchao Zhang         while (count > 0) {
18709566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(irn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18719566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(jcn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18729566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1873a6053eceSJunchao Zhang           irn += count;
1874a6053eceSJunchao Zhang           jcn += count;
1875a6053eceSJunchao Zhang           val += count;
1876a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1877a6053eceSJunchao Zhang           remain -= count;
18783ab56b82SJunchao Zhang         }
18793ab56b82SJunchao Zhang       }
1880a6053eceSJunchao Zhang     } else {
1881a6053eceSJunchao Zhang       nreqs = 0;
1882a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
1883a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
1884a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) { /* Remote communication only since self data is already in place */
1885a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1886a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1887a6053eceSJunchao Zhang           while (count > 0) {
18889566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1889a6053eceSJunchao Zhang             val += count;
1890a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1891a6053eceSJunchao Zhang             remain -= count;
1892a6053eceSJunchao Zhang           }
1893a6053eceSJunchao Zhang         }
1894a6053eceSJunchao Zhang       } else {
1895a6053eceSJunchao Zhang         val    = mumps->val;
1896a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1897a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1898a6053eceSJunchao Zhang         while (count > 0) {
18999566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1900a6053eceSJunchao Zhang           val += count;
1901a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1902a6053eceSJunchao Zhang           remain -= count;
1903a6053eceSJunchao Zhang         }
1904a6053eceSJunchao Zhang       }
1905a6053eceSJunchao Zhang     }
19069566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs, mumps->reqs, MPI_STATUSES_IGNORE));
1907a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
1908a6053eceSJunchao Zhang   }
19093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19103ab56b82SJunchao Zhang }
19113ab56b82SJunchao Zhang 
1912d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorNumeric_MUMPS(Mat F, Mat A, const MatFactorInfo *info)
1913d71ae5a4SJacob Faibussowitsch {
1914e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)(F)->data;
1915ace3abfcSBarry Smith   PetscBool  isMPIAIJ;
1916397b6df1SKris Buschelman 
1917397b6df1SKris Buschelman   PetscFunctionBegin;
1918dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
191948a46eb9SPierre 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)));
19209566063dSJacob 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)));
19213ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
19222aca8efcSHong Zhang   }
19236baea169SHong Zhang 
19249566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
19259566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX, mumps));
1926397b6df1SKris Buschelman 
1927397b6df1SKris Buschelman   /* numerical factorization phase */
1928a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
19294e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
1930ad540459SPierre Jolivet     if (!mumps->myid) mumps->id.a = (MumpsScalar *)mumps->val;
1931397b6df1SKris Buschelman   } else {
1932940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar *)mumps->val;
1933397b6df1SKris Buschelman   }
19343ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1935a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
19369261f6e4SBarry 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));
19379261f6e4SBarry Smith     if (mumps->id.INFOG(1) == -10) {
19389261f6e4SBarry 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)));
1939603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
1940c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -13) {
19419261f6e4SBarry 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)));
1942603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1943c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
19449261f6e4SBarry 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)));
1945603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
19462aca8efcSHong Zhang     } else {
19479261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1948603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
1949151787a6SHong Zhang     }
19502aca8efcSHong Zhang   }
19519261f6e4SBarry 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));
1952397b6df1SKris Buschelman 
1953b3cb21ddSStefano Zampini   F->assembled = PETSC_TRUE;
1954d47f36abSHong Zhang 
1955b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
19563cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
1957c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
19583cb7dd0eSStefano Zampini #endif
1959b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
1960b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
19619566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur, MAT_INPLACE_MATRIX, &F->schur));
1962b3cb21ddSStefano Zampini     }
19639566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F, NULL, MAT_FACTOR_SCHUR_UNFACTORED));
1964b3cb21ddSStefano Zampini   }
196567877ebaSShri Abhyankar 
1966066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
1967066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
1968066565c5SStefano Zampini 
19693ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
19702d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
197167877ebaSShri Abhyankar     PetscInt     lsol_loc;
197267877ebaSShri Abhyankar     PetscScalar *sol_loc;
19732205254eSKarl Rupp 
19749566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A, MATMPIAIJ, &isMPIAIJ));
1975c2093ab7SHong Zhang 
1976c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
1977c2093ab7SHong Zhang     if (mumps->x_seq) {
19789566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
19799566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
19809566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
1981c2093ab7SHong Zhang     }
1982a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
19839566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc, &sol_loc, lsol_loc, &mumps->id.isol_loc));
1984a5e57a09SHong Zhang     mumps->id.lsol_loc = lsol_loc;
1985940cd9d6SSatish Balay     mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
19869566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, lsol_loc, sol_loc, &mumps->x_seq));
198767877ebaSShri Abhyankar   }
19889566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(mumps->id.RINFO(2)));
19893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1990397b6df1SKris Buschelman }
1991397b6df1SKris Buschelman 
19929a2535b5SHong Zhang /* Sets MUMPS options from the options database */
1993d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
1994d71ae5a4SJacob Faibussowitsch {
1995e69c285eSBarry Smith   Mat_MUMPS    *mumps = (Mat_MUMPS *)F->data;
1996413bcc21SPierre Jolivet   PetscMUMPSInt icntl = 0, size, *listvar_schur;
199745e3843bSPierre Jolivet   PetscInt      info[80], i, ninfo = 80, rbs, cbs;
1998413bcc21SPierre Jolivet   PetscBool     flg = PETSC_FALSE, schur = (PetscBool)(mumps->id.ICNTL(26) == -1);
1999413bcc21SPierre Jolivet   MumpsScalar  *arr;
2000dcd589f8SShri Abhyankar 
2001dcd589f8SShri Abhyankar   PetscFunctionBegin;
200226cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F), ((PetscObject)F)->prefix, "MUMPS Options", "Mat");
2003413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) { /* MatSetFromOptions_MUMPS() has never been called before */
2004413bcc21SPierre Jolivet     PetscInt nthreads   = 0;
2005413bcc21SPierre Jolivet     PetscInt nCNTL_pre  = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
2006413bcc21SPierre Jolivet     PetscInt nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
2007413bcc21SPierre Jolivet 
2008413bcc21SPierre Jolivet     mumps->petsc_comm = PetscObjectComm((PetscObject)A);
2009413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->petsc_comm, &mumps->petsc_size));
2010413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm, &mumps->myid)); /* "if (!myid)" still works even if mumps_comm is different */
2011413bcc21SPierre Jolivet 
2012413bcc21SPierre Jolivet     PetscCall(PetscOptionsName("-mat_mumps_use_omp_threads", "Convert MPI processes into OpenMP threads", "None", &mumps->use_petsc_omp_support));
2013413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
2014413bcc21SPierre Jolivet     /* do not use PetscOptionsInt() so that the option -mat_mumps_use_omp_threads is not displayed twice in the help */
2015413bcc21SPierre Jolivet     PetscCall(PetscOptionsGetInt(NULL, ((PetscObject)F)->prefix, "-mat_mumps_use_omp_threads", &nthreads, NULL));
2016413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) {
20179371c9d4SSatish 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",
20189371c9d4SSatish Balay                  ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
2019413bcc21SPierre 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 : "");
2020413bcc21SPierre Jolivet #if defined(PETSC_HAVE_OPENMP_SUPPORT)
2021413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm, nthreads, &mumps->omp_ctrl));
2022413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl, &mumps->omp_comm, &mumps->mumps_comm, &mumps->is_omp_master));
2023413bcc21SPierre Jolivet #endif
2024413bcc21SPierre Jolivet     } else {
2025413bcc21SPierre Jolivet       mumps->omp_comm      = PETSC_COMM_SELF;
2026413bcc21SPierre Jolivet       mumps->mumps_comm    = mumps->petsc_comm;
2027413bcc21SPierre Jolivet       mumps->is_omp_master = PETSC_TRUE;
2028413bcc21SPierre Jolivet     }
2029413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->omp_comm, &mumps->omp_comm_size));
2030413bcc21SPierre Jolivet     mumps->reqs = NULL;
2031413bcc21SPierre Jolivet     mumps->tag  = 0;
2032413bcc21SPierre Jolivet 
2033413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
2034413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) {
2035413bcc21SPierre Jolivet         /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
2036413bcc21SPierre Jolivet         MPI_Comm comm;
2037413bcc21SPierre Jolivet         PetscCallMPI(MPI_Comm_dup(mumps->mumps_comm, &comm));
2038413bcc21SPierre Jolivet         mumps->mumps_comm = comm;
2039413bcc21SPierre Jolivet       } else PetscCall(PetscCommGetComm(mumps->petsc_comm, &mumps->mumps_comm));
2040413bcc21SPierre Jolivet     }
2041413bcc21SPierre Jolivet 
2042413bcc21SPierre Jolivet     mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
2043413bcc21SPierre Jolivet     mumps->id.job          = JOB_INIT;
2044413bcc21SPierre Jolivet     mumps->id.par          = 1; /* host participates factorizaton and solve */
2045413bcc21SPierre Jolivet     mumps->id.sym          = mumps->sym;
2046413bcc21SPierre Jolivet 
2047413bcc21SPierre Jolivet     size          = mumps->id.size_schur;
2048413bcc21SPierre Jolivet     arr           = mumps->id.schur;
2049413bcc21SPierre Jolivet     listvar_schur = mumps->id.listvar_schur;
2050413bcc21SPierre Jolivet     PetscMUMPS_c(mumps);
20519261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
2052413bcc21SPierre Jolivet     /* restore cached ICNTL and CNTL values */
2053413bcc21SPierre Jolivet     for (icntl = 0; icntl < nICNTL_pre; ++icntl) mumps->id.ICNTL(mumps->ICNTL_pre[1 + 2 * icntl]) = mumps->ICNTL_pre[2 + 2 * icntl];
2054413bcc21SPierre Jolivet     for (icntl = 0; icntl < nCNTL_pre; ++icntl) mumps->id.CNTL((PetscInt)mumps->CNTL_pre[1 + 2 * icntl]) = mumps->CNTL_pre[2 + 2 * icntl];
2055413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->ICNTL_pre));
2056413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->CNTL_pre));
2057413bcc21SPierre Jolivet 
2058413bcc21SPierre Jolivet     if (schur) {
2059413bcc21SPierre Jolivet       mumps->id.size_schur    = size;
2060413bcc21SPierre Jolivet       mumps->id.schur_lld     = size;
2061413bcc21SPierre Jolivet       mumps->id.schur         = arr;
2062413bcc21SPierre Jolivet       mumps->id.listvar_schur = listvar_schur;
2063413bcc21SPierre Jolivet       if (mumps->petsc_size > 1) {
2064413bcc21SPierre Jolivet         PetscBool gs; /* gs is false if any rank other than root has non-empty IS */
2065413bcc21SPierre Jolivet 
2066413bcc21SPierre Jolivet         mumps->id.ICNTL(19) = 1;                                                                            /* MUMPS returns Schur centralized on the host */
2067413bcc21SPierre 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 */
2068712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &gs, 1, MPIU_BOOL, MPI_LAND, mumps->petsc_comm));
2069413bcc21SPierre Jolivet         PetscCheck(gs, PETSC_COMM_SELF, PETSC_ERR_SUP, "MUMPS distributed parallel Schur complements not yet supported from PETSc");
2070413bcc21SPierre Jolivet       } else {
2071413bcc21SPierre Jolivet         if (F->factortype == MAT_FACTOR_LU) {
2072413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
2073413bcc21SPierre Jolivet         } else {
2074413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
2075413bcc21SPierre Jolivet         }
2076413bcc21SPierre Jolivet       }
2077413bcc21SPierre Jolivet       mumps->id.ICNTL(26) = -1;
2078413bcc21SPierre Jolivet     }
2079413bcc21SPierre Jolivet 
2080413bcc21SPierre Jolivet     /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
2081413bcc21SPierre Jolivet        For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
2082413bcc21SPierre Jolivet      */
2083413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.icntl, 40, MPI_INT, 0, mumps->omp_comm));
2084413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15, MPIU_REAL, 0, mumps->omp_comm));
2085413bcc21SPierre Jolivet 
2086413bcc21SPierre Jolivet     mumps->scat_rhs = NULL;
2087413bcc21SPierre Jolivet     mumps->scat_sol = NULL;
2088413bcc21SPierre Jolivet 
2089413bcc21SPierre Jolivet     /* set PETSc-MUMPS default options - override MUMPS default */
2090413bcc21SPierre Jolivet     mumps->id.ICNTL(3) = 0;
2091413bcc21SPierre Jolivet     mumps->id.ICNTL(4) = 0;
2092413bcc21SPierre Jolivet     if (mumps->petsc_size == 1) {
2093413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 0; /* centralized assembled matrix input */
2094413bcc21SPierre Jolivet       mumps->id.ICNTL(7)  = 7; /* automatic choice of ordering done by the package */
2095413bcc21SPierre Jolivet     } else {
2096413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 3; /* distributed assembled matrix input */
2097413bcc21SPierre Jolivet       mumps->id.ICNTL(21) = 1; /* distributed solution */
2098413bcc21SPierre Jolivet     }
2099413bcc21SPierre Jolivet   }
21009566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1", "ICNTL(1): output stream for error messages", "None", mumps->id.ICNTL(1), &icntl, &flg));
21019a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
21029566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2", "ICNTL(2): output stream for diagnostic printing, statistics, and warning", "None", mumps->id.ICNTL(2), &icntl, &flg));
21039a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
21049566063dSJacob 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));
21059a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
2106dcd589f8SShri Abhyankar 
21079566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4", "ICNTL(4): level of printing (0 to 4)", "None", mumps->id.ICNTL(4), &icntl, &flg));
21089a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
21099a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
21109a2535b5SHong Zhang 
21119566063dSJacob 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));
21129a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
21139a2535b5SHong Zhang 
21149566063dSJacob 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));
2115dcd589f8SShri Abhyankar   if (flg) {
2116aed4548fSBarry 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");
2117b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
2118dcd589f8SShri Abhyankar   }
2119e0b74bf9SHong Zhang 
21209566063dSJacob 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));
21219566063dSJacob 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() */
21229566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10", "ICNTL(10): max num of refinements", "None", mumps->id.ICNTL(10), &mumps->id.ICNTL(10), NULL));
21239566063dSJacob 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));
21249566063dSJacob 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));
21259566063dSJacob 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));
21269566063dSJacob 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));
212745e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A, &rbs, &cbs));
212845e3843bSPierre Jolivet   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = -rbs;
212945e3843bSPierre 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));
213045e3843bSPierre Jolivet   if (flg) {
213145e3843bSPierre Jolivet     PetscCheck(mumps->id.ICNTL(15) <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Positive -mat_mumps_icntl_15 not handled");
213245e3843bSPierre 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");
213345e3843bSPierre Jolivet   }
21349566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19", "ICNTL(19): computes the Schur complement", "None", mumps->id.ICNTL(19), &mumps->id.ICNTL(19), NULL));
213559ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
21369566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
21379566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
213859ac8732SStefano Zampini   }
213925aac85cSJunchao Zhang 
214043f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
214143f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
214225aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
214343f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
214443f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
214543f3b051SJunchao Zhang      In short, we could not use distributed RHS with MPICH until v4.0b1.
214625aac85cSJunchao Zhang    */
214743f3b051SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0) || (defined(PETSC_HAVE_MPICH_NUMVERSION) && (PETSC_HAVE_MPICH_NUMVERSION < 40000101))
214825aac85cSJunchao Zhang   mumps->ICNTL20 = 0; /* Centralized dense RHS*/
214943f3b051SJunchao Zhang #else
215043f3b051SJunchao Zhang   mumps->ICNTL20     = 10; /* Distributed dense RHS*/
215125aac85cSJunchao Zhang #endif
21529566063dSJacob 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));
2153aed4548fSBarry 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);
215425aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0)
2155aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10, PETSC_COMM_SELF, PETSC_ERR_SUP, "ICNTL(20)=10 is not supported before MUMPS-5.3.0");
215625aac85cSJunchao Zhang #endif
21579566063dSJacob 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 */
21589a2535b5SHong Zhang 
21599566063dSJacob 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));
21609566063dSJacob 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));
21619566063dSJacob 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));
21629371c9d4SSatish Balay   if (mumps->id.ICNTL(24)) { mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */ }
2163d7ebd59bSHong Zhang 
21649566063dSJacob 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));
21659566063dSJacob 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));
21669566063dSJacob 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));
21679566063dSJacob 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));
21689566063dSJacob 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));
21699566063dSJacob 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 */
21709566063dSJacob 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));
2171145b44c9SPierre 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 */
21729566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33", "ICNTL(33): compute determinant", "None", mumps->id.ICNTL(33), &mumps->id.ICNTL(33), NULL));
21739566063dSJacob 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));
21749566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36", "ICNTL(36): choice of BLR factorization variant", "None", mumps->id.ICNTL(36), &mumps->id.ICNTL(36), NULL));
21759566063dSJacob 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));
2176146931dbSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_58", "ICNTL(58): defines options for symbolic factorization", "None", mumps->id.ICNTL(58), &mumps->id.ICNTL(58), NULL));
2177dcd589f8SShri Abhyankar 
21789566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1", "CNTL(1): relative pivoting threshold", "None", mumps->id.CNTL(1), &mumps->id.CNTL(1), NULL));
21799566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2", "CNTL(2): stopping criterion of refinement", "None", mumps->id.CNTL(2), &mumps->id.CNTL(2), NULL));
21809566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3", "CNTL(3): absolute pivoting threshold", "None", mumps->id.CNTL(3), &mumps->id.CNTL(3), NULL));
21819566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4", "CNTL(4): value for static pivoting", "None", mumps->id.CNTL(4), &mumps->id.CNTL(4), NULL));
21829566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5", "CNTL(5): fixation for null pivots", "None", mumps->id.CNTL(5), &mumps->id.CNTL(5), NULL));
21839566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7", "CNTL(7): dropping parameter used during BLR", "None", mumps->id.CNTL(7), &mumps->id.CNTL(7), NULL));
2184e5bb22a1SHong Zhang 
21859566063dSJacob 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));
2186b34f08ffSHong Zhang 
21879566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info", "request INFO local to each processor", "", info, &ninfo, NULL));
2188b34f08ffSHong Zhang   if (ninfo) {
218908401ef6SPierre Jolivet     PetscCheck(ninfo <= 80, PETSC_COMM_SELF, PETSC_ERR_USER, "number of INFO %" PetscInt_FMT " must <= 80", ninfo);
21909566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo, &mumps->info));
2191b34f08ffSHong Zhang     mumps->ninfo = ninfo;
2192b34f08ffSHong Zhang     for (i = 0; i < ninfo; i++) {
2193aed4548fSBarry 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);
2194f7d195e4SLawrence Mitchell       mumps->info[i] = info[i];
2195b34f08ffSHong Zhang     }
2196b34f08ffSHong Zhang   }
2197d0609cedSBarry Smith   PetscOptionsEnd();
21983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2199dcd589f8SShri Abhyankar }
2200dcd589f8SShri Abhyankar 
2201d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F, Mat A, const MatFactorInfo *info, Mat_MUMPS *mumps)
2202d71ae5a4SJacob Faibussowitsch {
22035cd7cf9dSHong Zhang   PetscFunctionBegin;
22045cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
22059261f6e4SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in analysis: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
22065cd7cf9dSHong Zhang     if (mumps->id.INFOG(1) == -6) {
22079261f6e4SBarry 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)));
2208603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
22095cd7cf9dSHong Zhang     } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
22109261f6e4SBarry 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)));
2211603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
2212dbf6bb8dSprj-     } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
22139261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: empty matrix\n"));
22145cd7cf9dSHong Zhang     } else {
22159261f6e4SBarry 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)));
2216603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
22175cd7cf9dSHong Zhang     }
22185cd7cf9dSHong Zhang   }
22193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22205cd7cf9dSHong Zhang }
22215cd7cf9dSHong Zhang 
2222d71ae5a4SJacob Faibussowitsch PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2223d71ae5a4SJacob Faibussowitsch {
2224e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
222567877ebaSShri Abhyankar   Vec            b;
222667877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2227397b6df1SKris Buschelman 
2228397b6df1SKris Buschelman   PetscFunctionBegin;
2229d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2230d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
22313ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2232d47f36abSHong Zhang   }
2233dcd589f8SShri Abhyankar 
22349a2535b5SHong Zhang   /* Set MUMPS options from the options database */
223526cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2236dcd589f8SShri Abhyankar 
22379566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
22389566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2239dcd589f8SShri Abhyankar 
224067877ebaSShri Abhyankar   /* analysis phase */
2241a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2242a5e57a09SHong Zhang   mumps->id.n   = M;
2243a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
224467877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2245a5e57a09SHong Zhang     if (!mumps->myid) {
2246a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2247a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2248a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2249a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
22504ac6704cSBarry Smith       if (r) {
22514ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
2252a5e57a09SHong Zhang         if (!mumps->myid) {
2253e0b74bf9SHong Zhang           const PetscInt *idx;
2254a6053eceSJunchao Zhang           PetscInt        i;
22552205254eSKarl Rupp 
22569566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M, &mumps->id.perm_in));
22579566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r, &idx));
22589566063dSJacob Faibussowitsch           for (i = 0; i < M; i++) PetscCall(PetscMUMPSIntCast(idx[i] + 1, &(mumps->id.perm_in[i]))); /* perm_in[]: start from 1, not 0! */
22599566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r, &idx));
2260e0b74bf9SHong Zhang         }
2261e0b74bf9SHong Zhang       }
226267877ebaSShri Abhyankar     }
226367877ebaSShri Abhyankar     break;
226467877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2265a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2266a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2267a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2268a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
226925aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
22709566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
22719566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
22729566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
227325aac85cSJunchao Zhang     }
227467877ebaSShri Abhyankar     break;
227567877ebaSShri Abhyankar   }
22763ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
22779566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
227867877ebaSShri Abhyankar 
2279719d5645SBarry Smith   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2280dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
228151d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
22824e34a73bSHong Zhang   F->ops->matsolve          = MatMatSolve_MUMPS;
2283eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
2284b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2285d47f36abSHong Zhang 
2286d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
22873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2288b24902e0SBarry Smith }
2289b24902e0SBarry Smith 
2290450b117fSShri Abhyankar /* Note the Petsc r and c permutations are ignored */
2291d71ae5a4SJacob Faibussowitsch PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2292d71ae5a4SJacob Faibussowitsch {
2293e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
229467877ebaSShri Abhyankar   Vec            b;
229567877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2296450b117fSShri Abhyankar 
2297450b117fSShri Abhyankar   PetscFunctionBegin;
2298d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2299338d3105SPierre Jolivet     /* F is assembled by a previous call of MatLUFactorSymbolic_BAIJMUMPS() */
23003ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2301d47f36abSHong Zhang   }
2302dcd589f8SShri Abhyankar 
23039a2535b5SHong Zhang   /* Set MUMPS options from the options database */
230426cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2305dcd589f8SShri Abhyankar 
23069566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23079566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
230867877ebaSShri Abhyankar 
230967877ebaSShri Abhyankar   /* analysis phase */
2310a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2311a5e57a09SHong Zhang   mumps->id.n   = M;
2312a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
231367877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2314a5e57a09SHong Zhang     if (!mumps->myid) {
2315a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2316a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2317a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2318ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
231967877ebaSShri Abhyankar     }
232067877ebaSShri Abhyankar     break;
232167877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2322a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2323a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2324a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2325ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
232625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
23279566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23289566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23299566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
233025aac85cSJunchao Zhang     }
233167877ebaSShri Abhyankar     break;
233267877ebaSShri Abhyankar   }
23333ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23349566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
233567877ebaSShri Abhyankar 
2336450b117fSShri Abhyankar   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2337dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
233851d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
2339b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2340d47f36abSHong Zhang 
2341d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2343450b117fSShri Abhyankar }
2344b24902e0SBarry Smith 
2345141f4205SHong Zhang /* Note the Petsc r permutation and factor info are ignored */
2346d71ae5a4SJacob Faibussowitsch PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F, Mat A, IS r, const MatFactorInfo *info)
2347d71ae5a4SJacob Faibussowitsch {
2348e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
234967877ebaSShri Abhyankar   Vec            b;
235067877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2351397b6df1SKris Buschelman 
2352397b6df1SKris Buschelman   PetscFunctionBegin;
2353d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2354338d3105SPierre Jolivet     /* F is assembled by a previous call of MatCholeskyFactorSymbolic_MUMPS() */
23553ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2356d47f36abSHong Zhang   }
2357dcd589f8SShri Abhyankar 
23589a2535b5SHong Zhang   /* Set MUMPS options from the options database */
235926cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2360dcd589f8SShri Abhyankar 
23619566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23629566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2363dcd589f8SShri Abhyankar 
236467877ebaSShri Abhyankar   /* analysis phase */
2365a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2366a5e57a09SHong Zhang   mumps->id.n   = M;
2367a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
236867877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2369a5e57a09SHong Zhang     if (!mumps->myid) {
2370a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2371a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2372a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2373ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
237467877ebaSShri Abhyankar     }
237567877ebaSShri Abhyankar     break;
237667877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2377a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2378a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2379a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2380ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
238125aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
23829566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23839566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23849566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
238525aac85cSJunchao Zhang     }
238667877ebaSShri Abhyankar     break;
238767877ebaSShri Abhyankar   }
23883ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23899566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
23905cd7cf9dSHong Zhang 
23912792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2392dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
239351d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
23944e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
239523a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
2396b18964edSHong Zhang   F->ops->matsolvetranspose     = MatMatSolveTranspose_MUMPS;
23974e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
23980298fd71SBarry Smith   F->ops->getinertia = NULL;
23994e34a73bSHong Zhang #else
24004e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2401db4efbfdSBarry Smith #endif
2402d47f36abSHong Zhang 
2403d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
24043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2405b24902e0SBarry Smith }
2406b24902e0SBarry Smith 
2407d71ae5a4SJacob Faibussowitsch PetscErrorCode MatView_MUMPS(Mat A, PetscViewer viewer)
2408d71ae5a4SJacob Faibussowitsch {
240964e6c443SBarry Smith   PetscBool         iascii;
241064e6c443SBarry Smith   PetscViewerFormat format;
2411e69c285eSBarry Smith   Mat_MUMPS        *mumps = (Mat_MUMPS *)A->data;
2412f6c57405SHong Zhang 
2413f6c57405SHong Zhang   PetscFunctionBegin;
241464e6c443SBarry Smith   /* check if matrix is mumps type */
24153ba16761SJacob Faibussowitsch   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(PETSC_SUCCESS);
241664e6c443SBarry Smith 
24179566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
241864e6c443SBarry Smith   if (iascii) {
24199566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
24201511cd71SPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
24219566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "MUMPS run parameters:\n"));
24221511cd71SPierre Jolivet       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
24239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  SYM (matrix type):                   %d\n", mumps->id.sym));
24249566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  PAR (host participation):            %d\n", mumps->id.par));
24259566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(1) (output for error):         %d\n", mumps->id.ICNTL(1)));
24269566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(2) (output of diagnostic msg): %d\n", mumps->id.ICNTL(2)));
24279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(3) (output for global info):   %d\n", mumps->id.ICNTL(3)));
24289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(4) (level of printing):        %d\n", mumps->id.ICNTL(4)));
24299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(5) (input mat struct):         %d\n", mumps->id.ICNTL(5)));
24309566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(6) (matrix prescaling):        %d\n", mumps->id.ICNTL(6)));
24319566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(7) (sequential matrix ordering):%d\n", mumps->id.ICNTL(7)));
24329566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(8) (scaling strategy):         %d\n", mumps->id.ICNTL(8)));
24339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(10) (max num of refinements):  %d\n", mumps->id.ICNTL(10)));
24349566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(11) (error analysis):          %d\n", mumps->id.ICNTL(11)));
2435a5e57a09SHong Zhang         if (mumps->id.ICNTL(11) > 0) {
24369566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(4) (inf norm of input mat):        %g\n", mumps->id.RINFOG(4)));
24379566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(5) (inf norm of solution):         %g\n", mumps->id.RINFOG(5)));
24389566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(6) (inf norm of residual):         %g\n", mumps->id.RINFOG(6)));
24399566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n", mumps->id.RINFOG(7), mumps->id.RINFOG(8)));
24409566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(9) (error estimate):               %g\n", mumps->id.RINFOG(9)));
24419566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n", mumps->id.RINFOG(10), mumps->id.RINFOG(11)));
2442f6c57405SHong Zhang         }
24439566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(12) (efficiency control):                         %d\n", mumps->id.ICNTL(12)));
24449566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(13) (sequential factorization of the root node):  %d\n", mumps->id.ICNTL(13)));
24459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(14) (percentage of estimated workspace increase): %d\n", mumps->id.ICNTL(14)));
244645e3843bSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(15) (compression of the input matrix):            %d\n", mumps->id.ICNTL(15)));
2447f6c57405SHong Zhang         /* ICNTL(15-17) not used */
24489566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(18) (input mat struct):                           %d\n", mumps->id.ICNTL(18)));
24499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(19) (Schur complement info):                      %d\n", mumps->id.ICNTL(19)));
24509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(20) (RHS sparse pattern):                         %d\n", mumps->id.ICNTL(20)));
24519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(21) (solution struct):                            %d\n", mumps->id.ICNTL(21)));
24529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(22) (in-core/out-of-core facility):               %d\n", mumps->id.ICNTL(22)));
24539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(23) (max size of memory can be allocated locally):%d\n", mumps->id.ICNTL(23)));
2454c0165424SHong Zhang 
24559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(24) (detection of null pivot rows):               %d\n", mumps->id.ICNTL(24)));
24569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(25) (computation of a null space basis):          %d\n", mumps->id.ICNTL(25)));
24579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(26) (Schur options for RHS or solution):          %d\n", mumps->id.ICNTL(26)));
24589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(27) (blocking size for multiple RHS):             %d\n", mumps->id.ICNTL(27)));
24599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(28) (use parallel or sequential ordering):        %d\n", mumps->id.ICNTL(28)));
24609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(29) (parallel ordering):                          %d\n", mumps->id.ICNTL(29)));
246142179a6aSHong Zhang 
24629566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n", mumps->id.ICNTL(30)));
24639566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(31) (factors is discarded in the solve phase):    %d\n", mumps->id.ICNTL(31)));
24649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(33) (compute determinant):                        %d\n", mumps->id.ICNTL(33)));
24659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(35) (activate BLR based factorization):           %d\n", mumps->id.ICNTL(35)));
24669566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(36) (choice of BLR factorization variant):        %d\n", mumps->id.ICNTL(36)));
24679566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(38) (estimated compression rate of LU factors):   %d\n", mumps->id.ICNTL(38)));
2468146931dbSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(58) (options for symbolic factorization):         %d\n", mumps->id.ICNTL(58)));
2469f6c57405SHong Zhang 
24709566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(1) (relative pivoting threshold):      %g\n", mumps->id.CNTL(1)));
24719566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(2) (stopping criterion of refinement): %g\n", mumps->id.CNTL(2)));
24729566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(3) (absolute pivoting threshold):      %g\n", mumps->id.CNTL(3)));
24739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(4) (value of static pivoting):         %g\n", mumps->id.CNTL(4)));
24749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(5) (fixation for null pivots):         %g\n", mumps->id.CNTL(5)));
24759566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(7) (dropping parameter for BLR):       %g\n", mumps->id.CNTL(7)));
2476f6c57405SHong Zhang 
2477a5b23f4aSJose E. Roman         /* information local to each processor */
24789566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis):\n"));
24799566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushSynchronized(viewer));
24809566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(1)));
24819566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
24829566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization):\n"));
24839566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(2)));
24849566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
24859566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization):\n"));
24869566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(3)));
24879566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2488f6c57405SHong Zhang 
24899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization):\n"));
24909566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(15)));
24919566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2492f6c57405SHong Zhang 
24939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization):\n"));
24949566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(16)));
24959566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2496f6c57405SHong Zhang 
24979566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization):\n"));
24989566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(23)));
24999566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2500b34f08ffSHong Zhang 
2501a0e18203SThibaut Appel         if (mumps->ninfo && mumps->ninfo <= 80) {
2502b34f08ffSHong Zhang           PetscInt i;
2503b34f08ffSHong Zhang           for (i = 0; i < mumps->ninfo; i++) {
25049566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "):\n", mumps->info[i]));
25059566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(mumps->info[i])));
25069566063dSJacob Faibussowitsch             PetscCall(PetscViewerFlush(viewer));
2507b34f08ffSHong Zhang           }
2508b34f08ffSHong Zhang         }
25099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopSynchronized(viewer));
25101511cd71SPierre Jolivet       } else PetscCall(PetscViewerASCIIPrintf(viewer, "  Use -%sksp_view ::ascii_info_detail to display information for all processes\n", ((PetscObject)A)->prefix ? ((PetscObject)A)->prefix : ""));
2511f6c57405SHong Zhang 
25121511cd71SPierre Jolivet       if (mumps->myid == 0) { /* information from the host */
25139566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(1) (global estimated flops for the elimination after analysis): %g\n", mumps->id.RINFOG(1)));
25149566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(2) (global estimated flops for the assembly after factorization): %g\n", mumps->id.RINFOG(2)));
25159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(3) (global estimated flops for the elimination after factorization): %g\n", mumps->id.RINFOG(3)));
25169566063dSJacob 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)));
2517f6c57405SHong Zhang 
25189566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(3)));
25199566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(4)));
25209566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(5) (estimated maximum front size in the complete tree): %d\n", mumps->id.INFOG(5)));
25219566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(6) (number of nodes in the complete tree): %d\n", mumps->id.INFOG(6)));
25229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(7) (ordering option effectively used after analysis): %d\n", mumps->id.INFOG(7)));
25239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n", mumps->id.INFOG(8)));
25249566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n", mumps->id.INFOG(9)));
25259566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(10) (total integer space store the matrix factors after factorization): %d\n", mumps->id.INFOG(10)));
25269566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(11) (order of largest frontal matrix after factorization): %d\n", mumps->id.INFOG(11)));
25279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(12) (number of off-diagonal pivots): %d\n", mumps->id.INFOG(12)));
25289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(13) (number of delayed pivots after factorization): %d\n", mumps->id.INFOG(13)));
25299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(14) (number of memory compress after factorization): %d\n", mumps->id.INFOG(14)));
25309566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(15) (number of steps of iterative refinement after solution): %d\n", mumps->id.INFOG(15)));
25319566063dSJacob 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)));
25329566063dSJacob 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)));
25339566063dSJacob 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)));
25349566063dSJacob 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)));
25359566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(20) (estimated number of entries in the factors): %d\n", mumps->id.INFOG(20)));
25369566063dSJacob 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)));
25379566063dSJacob 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)));
25389566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n", mumps->id.INFOG(23)));
25399566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n", mumps->id.INFOG(24)));
25409566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n", mumps->id.INFOG(25)));
25419566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(28) (after factorization: number of null pivots encountered): %d\n", mumps->id.INFOG(28)));
25429566063dSJacob 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)));
25439566063dSJacob 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)));
25449566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(32) (after analysis: type of analysis done): %d\n", mumps->id.INFOG(32)));
25459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(33) (value used for ICNTL(8)): %d\n", mumps->id.INFOG(33)));
25469566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(34) (exponent of the determinant if determinant is requested): %d\n", mumps->id.INFOG(34)));
25479566063dSJacob 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)));
25489566063dSJacob 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)));
25499566063dSJacob 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)));
25509566063dSJacob 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)));
25519566063dSJacob 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)));
2552f6c57405SHong Zhang       }
2553f6c57405SHong Zhang     }
2554cb828f0fSHong Zhang   }
25553ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2556f6c57405SHong Zhang }
2557f6c57405SHong Zhang 
2558d71ae5a4SJacob Faibussowitsch PetscErrorCode MatGetInfo_MUMPS(Mat A, MatInfoType flag, MatInfo *info)
2559d71ae5a4SJacob Faibussowitsch {
2560e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
256135bd34faSBarry Smith 
256235bd34faSBarry Smith   PetscFunctionBegin;
256335bd34faSBarry Smith   info->block_size        = 1.0;
256464412097SPierre Jolivet   info->nz_allocated      = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
256564412097SPierre Jolivet   info->nz_used           = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
256635bd34faSBarry Smith   info->nz_unneeded       = 0.0;
256735bd34faSBarry Smith   info->assemblies        = 0.0;
256835bd34faSBarry Smith   info->mallocs           = 0.0;
256935bd34faSBarry Smith   info->memory            = 0.0;
257035bd34faSBarry Smith   info->fill_ratio_given  = 0;
257135bd34faSBarry Smith   info->fill_ratio_needed = 0;
257235bd34faSBarry Smith   info->factor_mallocs    = 0;
25733ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
257435bd34faSBarry Smith }
257535bd34faSBarry Smith 
2576d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
2577d71ae5a4SJacob Faibussowitsch {
2578e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)F->data;
2579a3d589ffSStefano Zampini   const PetscScalar *arr;
25808e7ba810SStefano Zampini   const PetscInt    *idxs;
25818e7ba810SStefano Zampini   PetscInt           size, i;
25826444a565SStefano Zampini 
25836444a565SStefano Zampini   PetscFunctionBegin;
25849566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &size));
2585b3cb21ddSStefano Zampini   /* Schur complement matrix */
25869566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
25879566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, size, size, NULL, &F->schur));
25889566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur, &arr));
2589a3d589ffSStefano Zampini   mumps->id.schur      = (MumpsScalar *)arr;
2590a3d589ffSStefano Zampini   mumps->id.size_schur = size;
2591a3d589ffSStefano Zampini   mumps->id.schur_lld  = size;
25929566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur, &arr));
259348a46eb9SPierre Jolivet   if (mumps->sym == 1) PetscCall(MatSetOption(F->schur, MAT_SPD, PETSC_TRUE));
2594b3cb21ddSStefano Zampini 
2595b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
25969566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
25979566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &mumps->id.listvar_schur));
25989566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &idxs));
25999566063dSJacob Faibussowitsch   for (i = 0; i < size; i++) PetscCall(PetscMUMPSIntCast(idxs[i] + 1, &(mumps->id.listvar_schur[i])));
26009566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &idxs));
260159ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2602b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
26033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26046444a565SStefano Zampini }
260559ac8732SStefano Zampini 
2606d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F, Mat *S)
2607d71ae5a4SJacob Faibussowitsch {
26086444a565SStefano Zampini   Mat          St;
2609e69c285eSBarry Smith   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
26106444a565SStefano Zampini   PetscScalar *array;
26116444a565SStefano Zampini 
26126444a565SStefano Zampini   PetscFunctionBegin;
26139261f6e4SBarry Smith   PetscCheck(mumps->id.ICNTL(19), PetscObjectComm((PetscObject)F), PETSC_ERR_ORDER, "Schur complement mode not selected! Call MatFactorSetSchurIS() to enable it");
26149566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF, &St));
26159566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St, PETSC_DECIDE, PETSC_DECIDE, mumps->id.size_schur, mumps->id.size_schur));
26169566063dSJacob Faibussowitsch   PetscCall(MatSetType(St, MATDENSE));
26179566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
26189566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St, &array));
261959ac8732SStefano Zampini   if (!mumps->sym) {                /* MUMPS always return a full matrix */
26206444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
26216444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26226444a565SStefano Zampini       for (i = 0; i < N; i++) {
26236444a565SStefano Zampini         for (j = 0; j < N; j++) {
26246444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26256444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26266444a565SStefano Zampini #else
2627*3e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26286444a565SStefano Zampini #endif
26296444a565SStefano Zampini           array[j * N + i] = val;
26306444a565SStefano Zampini         }
26316444a565SStefano Zampini       }
26326444a565SStefano Zampini     } else { /* stored by columns */
26339566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26346444a565SStefano Zampini     }
26356444a565SStefano Zampini   } else {                          /* either full or lower-triangular (not packed) */
26366444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
26376444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26386444a565SStefano Zampini       for (i = 0; i < N; i++) {
26396444a565SStefano Zampini         for (j = i; j < N; j++) {
26406444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26416444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26426444a565SStefano Zampini #else
2643*3e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26446444a565SStefano Zampini #endif
2645*3e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
26466444a565SStefano Zampini         }
26476444a565SStefano Zampini       }
26486444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
26499566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26506444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular 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 < i + 1; j++) {
26546444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26556444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26566444a565SStefano Zampini #else
2657*3e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26586444a565SStefano Zampini #endif
2659*3e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
26606444a565SStefano Zampini         }
26616444a565SStefano Zampini       }
26626444a565SStefano Zampini     }
26636444a565SStefano Zampini   }
26649566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St, &array));
26656444a565SStefano Zampini   *S = St;
26663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26676444a565SStefano Zampini }
26686444a565SStefano Zampini 
2669d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt ival)
2670d71ae5a4SJacob Faibussowitsch {
2671e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
26725ccb76cbSHong Zhang 
26735ccb76cbSHong Zhang   PetscFunctionBegin;
2674413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {                                       /* need to cache icntl and ival since PetscMUMPS_c() has never been called */
2675413bcc21SPierre Jolivet     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0; /* number of already cached ICNTL */
26769371c9d4SSatish Balay     for (i = 0; i < nICNTL_pre; ++i)
26779371c9d4SSatish Balay       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) break; /* is this ICNTL already cached? */
2678413bcc21SPierre Jolivet     if (i == nICNTL_pre) {                             /* not already cached */
2679413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscMUMPSInt) * (2 * nICNTL_pre + 3), &mumps->ICNTL_pre));
2680413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscMUMPSInt) * 3, &mumps->ICNTL_pre));
2681413bcc21SPierre Jolivet       mumps->ICNTL_pre[0]++;
2682413bcc21SPierre Jolivet     }
2683413bcc21SPierre Jolivet     mumps->ICNTL_pre[1 + 2 * i] = icntl;
2684413bcc21SPierre Jolivet     PetscCall(PetscMUMPSIntCast(ival, mumps->ICNTL_pre + 2 + 2 * i));
2685413bcc21SPierre Jolivet   } else PetscCall(PetscMUMPSIntCast(ival, &mumps->id.ICNTL(icntl)));
26863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26875ccb76cbSHong Zhang }
26885ccb76cbSHong Zhang 
2689d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt *ival)
2690d71ae5a4SJacob Faibussowitsch {
2691e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2692bc6112feSHong Zhang 
2693bc6112feSHong Zhang   PetscFunctionBegin;
269436df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
269536df9881Sjeremy theler     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
269636df9881Sjeremy theler     *ival = 0;
269736df9881Sjeremy theler     for (i = 0; i < nICNTL_pre; ++i) {
269836df9881Sjeremy theler       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) *ival = mumps->ICNTL_pre[2 + 2 * i];
269936df9881Sjeremy theler     }
270036df9881Sjeremy theler   } else *ival = mumps->id.ICNTL(icntl);
27013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2702bc6112feSHong Zhang }
2703bc6112feSHong Zhang 
27045ccb76cbSHong Zhang /*@
27055ccb76cbSHong Zhang   MatMumpsSetIcntl - Set MUMPS parameter ICNTL()
27065ccb76cbSHong Zhang 
2707c3339decSBarry Smith   Logically Collective
27085ccb76cbSHong Zhang 
27095ccb76cbSHong Zhang   Input Parameters:
271011a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
27115ccb76cbSHong Zhang . icntl - index of MUMPS parameter array ICNTL()
27125ccb76cbSHong Zhang - ival  - value of MUMPS ICNTL(icntl)
27135ccb76cbSHong Zhang 
27143c7db156SBarry Smith   Options Database Key:
2715147403d9SBarry Smith . -mat_mumps_icntl_<icntl> <ival> - change the option numbered icntl to ival
27165ccb76cbSHong Zhang 
27175ccb76cbSHong Zhang   Level: beginner
27185ccb76cbSHong Zhang 
271996a0c994SBarry Smith   References:
2720606c0280SSatish Balay .  * - MUMPS Users' Guide
27215ccb76cbSHong Zhang 
27221cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
27235ccb76cbSHong Zhang @*/
2724d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl(Mat F, PetscInt icntl, PetscInt ival)
2725d71ae5a4SJacob Faibussowitsch {
27265ccb76cbSHong Zhang   PetscFunctionBegin;
27272989dfd4SHong Zhang   PetscValidType(F, 1);
272828b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
27295ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27305ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, ival, 3);
2731146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2732cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetIcntl_C", (Mat, PetscInt, PetscInt), (F, icntl, ival));
27333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27345ccb76cbSHong Zhang }
27355ccb76cbSHong Zhang 
2736a21f80fcSHong Zhang /*@
2737a21f80fcSHong Zhang   MatMumpsGetIcntl - Get MUMPS parameter ICNTL()
2738a21f80fcSHong Zhang 
2739c3339decSBarry Smith   Logically Collective
2740a21f80fcSHong Zhang 
2741a21f80fcSHong Zhang   Input Parameters:
274211a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2743a21f80fcSHong Zhang - icntl - index of MUMPS parameter array ICNTL()
2744a21f80fcSHong Zhang 
2745a21f80fcSHong Zhang   Output Parameter:
2746a21f80fcSHong Zhang . ival - value of MUMPS ICNTL(icntl)
2747a21f80fcSHong Zhang 
2748a21f80fcSHong Zhang   Level: beginner
2749a21f80fcSHong Zhang 
275096a0c994SBarry Smith   References:
2751606c0280SSatish Balay .  * - MUMPS Users' Guide
2752a21f80fcSHong Zhang 
27531cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2754a21f80fcSHong Zhang @*/
2755d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl(Mat F, PetscInt icntl, PetscInt *ival)
2756d71ae5a4SJacob Faibussowitsch {
2757bc6112feSHong Zhang   PetscFunctionBegin;
27582989dfd4SHong Zhang   PetscValidType(F, 1);
275928b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2760bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27614f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
2762146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2763cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetIcntl_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
27643ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2765bc6112feSHong Zhang }
2766bc6112feSHong Zhang 
2767d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal val)
2768d71ae5a4SJacob Faibussowitsch {
2769e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
27708928b65cSHong Zhang 
27718928b65cSHong Zhang   PetscFunctionBegin;
2772413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {
2773413bcc21SPierre Jolivet     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
27749371c9d4SSatish Balay     for (i = 0; i < nCNTL_pre; ++i)
27759371c9d4SSatish Balay       if (mumps->CNTL_pre[1 + 2 * i] == icntl) break;
2776413bcc21SPierre Jolivet     if (i == nCNTL_pre) {
2777413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscReal) * (2 * nCNTL_pre + 3), &mumps->CNTL_pre));
2778413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscReal) * 3, &mumps->CNTL_pre));
2779413bcc21SPierre Jolivet       mumps->CNTL_pre[0]++;
2780413bcc21SPierre Jolivet     }
2781413bcc21SPierre Jolivet     mumps->CNTL_pre[1 + 2 * i] = icntl;
2782413bcc21SPierre Jolivet     mumps->CNTL_pre[2 + 2 * i] = val;
2783413bcc21SPierre Jolivet   } else mumps->id.CNTL(icntl) = val;
27843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27858928b65cSHong Zhang }
27868928b65cSHong Zhang 
2787d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal *val)
2788d71ae5a4SJacob Faibussowitsch {
2789e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2790bc6112feSHong Zhang 
2791bc6112feSHong Zhang   PetscFunctionBegin;
279236df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
279336df9881Sjeremy theler     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
279436df9881Sjeremy theler     *val = 0.0;
279536df9881Sjeremy theler     for (i = 0; i < nCNTL_pre; ++i) {
279636df9881Sjeremy theler       if (mumps->CNTL_pre[1 + 2 * i] == icntl) *val = mumps->CNTL_pre[2 + 2 * i];
279736df9881Sjeremy theler     }
279836df9881Sjeremy theler   } else *val = mumps->id.CNTL(icntl);
27993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2800bc6112feSHong Zhang }
2801bc6112feSHong Zhang 
28028928b65cSHong Zhang /*@
28038928b65cSHong Zhang   MatMumpsSetCntl - Set MUMPS parameter CNTL()
28048928b65cSHong Zhang 
2805c3339decSBarry Smith   Logically Collective
28068928b65cSHong Zhang 
28078928b65cSHong Zhang   Input Parameters:
280811a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
28098928b65cSHong Zhang . icntl - index of MUMPS parameter array CNTL()
28108928b65cSHong Zhang - val   - value of MUMPS CNTL(icntl)
28118928b65cSHong Zhang 
28123c7db156SBarry Smith   Options Database Key:
2813147403d9SBarry Smith . -mat_mumps_cntl_<icntl> <val> - change the option numbered icntl to ival
28148928b65cSHong Zhang 
28158928b65cSHong Zhang   Level: beginner
28168928b65cSHong Zhang 
281796a0c994SBarry Smith   References:
2818606c0280SSatish Balay .  * - MUMPS Users' Guide
28198928b65cSHong Zhang 
28201cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
28218928b65cSHong Zhang @*/
2822d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl(Mat F, PetscInt icntl, PetscReal val)
2823d71ae5a4SJacob Faibussowitsch {
28248928b65cSHong Zhang   PetscFunctionBegin;
28252989dfd4SHong Zhang   PetscValidType(F, 1);
282628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
28278928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2828bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F, val, 3);
2829413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2830cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetCntl_C", (Mat, PetscInt, PetscReal), (F, icntl, val));
28313ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28328928b65cSHong Zhang }
28338928b65cSHong Zhang 
2834a21f80fcSHong Zhang /*@
2835a21f80fcSHong Zhang   MatMumpsGetCntl - Get MUMPS parameter CNTL()
2836a21f80fcSHong Zhang 
2837c3339decSBarry Smith   Logically Collective
2838a21f80fcSHong Zhang 
2839a21f80fcSHong Zhang   Input Parameters:
284011a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2841a21f80fcSHong Zhang - icntl - index of MUMPS parameter array CNTL()
2842a21f80fcSHong Zhang 
2843a21f80fcSHong Zhang   Output Parameter:
2844a21f80fcSHong Zhang . val - value of MUMPS CNTL(icntl)
2845a21f80fcSHong Zhang 
2846a21f80fcSHong Zhang   Level: beginner
2847a21f80fcSHong Zhang 
284896a0c994SBarry Smith   References:
2849606c0280SSatish Balay .  * - MUMPS Users' Guide
2850a21f80fcSHong Zhang 
28511cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2852a21f80fcSHong Zhang @*/
2853d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl(Mat F, PetscInt icntl, PetscReal *val)
2854d71ae5a4SJacob Faibussowitsch {
2855bc6112feSHong Zhang   PetscFunctionBegin;
28562989dfd4SHong Zhang   PetscValidType(F, 1);
285728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2858bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
28594f572ea9SToby Isaac   PetscAssertPointer(val, 3);
2860413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2861cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetCntl_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
28623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2863bc6112feSHong Zhang }
2864bc6112feSHong Zhang 
2865d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F, PetscInt icntl, PetscInt *info)
2866d71ae5a4SJacob Faibussowitsch {
2867e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2868bc6112feSHong Zhang 
2869bc6112feSHong Zhang   PetscFunctionBegin;
2870bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
28713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2872bc6112feSHong Zhang }
2873bc6112feSHong Zhang 
2874d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F, PetscInt icntl, PetscInt *infog)
2875d71ae5a4SJacob Faibussowitsch {
2876e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2877bc6112feSHong Zhang 
2878bc6112feSHong Zhang   PetscFunctionBegin;
2879bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
28803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2881bc6112feSHong Zhang }
2882bc6112feSHong Zhang 
2883d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfo)
2884d71ae5a4SJacob Faibussowitsch {
2885e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2886bc6112feSHong Zhang 
2887bc6112feSHong Zhang   PetscFunctionBegin;
2888bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
28893ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2890bc6112feSHong Zhang }
2891bc6112feSHong Zhang 
2892d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfog)
2893d71ae5a4SJacob Faibussowitsch {
2894e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2895bc6112feSHong Zhang 
2896bc6112feSHong Zhang   PetscFunctionBegin;
2897bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
28983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2899bc6112feSHong Zhang }
2900bc6112feSHong Zhang 
29015c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots_MUMPS(Mat F, PetscInt *size, PetscInt **array)
29025c0bae8cSAshish Patel {
29035c0bae8cSAshish Patel   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
29045c0bae8cSAshish Patel 
29055c0bae8cSAshish Patel   PetscFunctionBegin;
29065c0bae8cSAshish 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");
29075c0bae8cSAshish Patel   *size  = 0;
29085c0bae8cSAshish Patel   *array = NULL;
29095c0bae8cSAshish Patel   if (!mumps->myid) {
29105c0bae8cSAshish Patel     *size = mumps->id.INFOG(28);
29115c0bae8cSAshish Patel     PetscCall(PetscMalloc1(*size, array));
29125c0bae8cSAshish Patel     for (int i = 0; i < *size; i++) (*array)[i] = mumps->id.pivnul_list[i] - 1;
29135c0bae8cSAshish Patel   }
29145c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
29155c0bae8cSAshish Patel }
29165c0bae8cSAshish Patel 
2917d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F, Mat spRHS)
2918d71ae5a4SJacob Faibussowitsch {
29190e6b8875SHong Zhang   Mat          Bt = NULL, Btseq = NULL;
29200e6b8875SHong Zhang   PetscBool    flg;
2921bb599dfdSHong Zhang   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
2922bb599dfdSHong Zhang   PetscScalar *aa;
2923f410b75aSHong Zhang   PetscInt     spnr, *ia, *ja, M, nrhs;
2924bb599dfdSHong Zhang 
2925bb599dfdSHong Zhang   PetscFunctionBegin;
29264f572ea9SToby Isaac   PetscAssertPointer(spRHS, 2);
2927013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS, MATTRANSPOSEVIRTUAL, &flg));
29280e6b8875SHong Zhang   if (flg) {
29299566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(spRHS, &Bt));
2930013e2dc7SBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)spRHS), PETSC_ERR_ARG_WRONG, "Matrix spRHS must be type MATTRANSPOSEVIRTUAL matrix");
2931bb599dfdSHong Zhang 
29329566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F, 30, 1));
2933bb599dfdSHong Zhang 
29342d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
29350e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ *)Bt->data;
29360e6b8875SHong Zhang     Btseq         = b->A;
29370e6b8875SHong Zhang   } else {
29380e6b8875SHong Zhang     Btseq = Bt;
29390e6b8875SHong Zhang   }
29400e6b8875SHong Zhang 
29419566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS, &M, &nrhs));
2942f410b75aSHong Zhang   mumps->id.nrhs = nrhs;
2943f410b75aSHong Zhang   mumps->id.lrhs = M;
2944f410b75aSHong Zhang   mumps->id.rhs  = NULL;
2945f410b75aSHong Zhang 
2946e3f2db6aSHong Zhang   if (!mumps->myid) {
29479566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq, &aa));
29489566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
294928b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
29509566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
2951bb599dfdSHong Zhang     mumps->id.rhs_sparse = (MumpsScalar *)aa;
2952e3f2db6aSHong Zhang   } else {
2953e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
2954e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
2955e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
2956e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
2957e3f2db6aSHong Zhang   }
2958bb599dfdSHong Zhang   mumps->id.ICNTL(20) = 1; /* rhs is sparse */
2959e3f2db6aSHong Zhang   mumps->id.ICNTL(21) = 0; /* solution is in assembled centralized format */
2960bb599dfdSHong Zhang 
2961bb599dfdSHong Zhang   /* solve phase */
2962bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
29633ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
29649261f6e4SBarry 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));
296514267174SHong Zhang 
2966e3f2db6aSHong Zhang   if (!mumps->myid) {
29679566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq, &aa));
29689566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
296928b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
2970e3f2db6aSHong Zhang   }
29713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2972bb599dfdSHong Zhang }
2973bb599dfdSHong Zhang 
2974bb599dfdSHong Zhang /*@
29752ef1f0ffSBarry Smith   MatMumpsGetInverse - Get user-specified set of entries in inverse of `A`
2976bb599dfdSHong Zhang 
2977c3339decSBarry Smith   Logically Collective
2978bb599dfdSHong Zhang 
297920f4b53cSBarry Smith   Input Parameter:
298020f4b53cSBarry Smith . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2981bb599dfdSHong Zhang 
2982bb599dfdSHong Zhang   Output Parameter:
298320f4b53cSBarry Smith . spRHS - sequential sparse matrix in `MATTRANSPOSEVIRTUAL` format with requested entries of inverse of `A`
2984bb599dfdSHong Zhang 
2985bb599dfdSHong Zhang   Level: beginner
2986bb599dfdSHong Zhang 
2987bb599dfdSHong Zhang   References:
2988606c0280SSatish Balay .  * - MUMPS Users' Guide
2989bb599dfdSHong Zhang 
29901cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`
2991bb599dfdSHong Zhang @*/
2992d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse(Mat F, Mat spRHS)
2993d71ae5a4SJacob Faibussowitsch {
2994bb599dfdSHong Zhang   PetscFunctionBegin;
2995bb599dfdSHong Zhang   PetscValidType(F, 1);
299628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2997cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverse_C", (Mat, Mat), (F, spRHS));
29983ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2999bb599dfdSHong Zhang }
3000bb599dfdSHong Zhang 
3001d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F, Mat spRHST)
3002d71ae5a4SJacob Faibussowitsch {
30030e6b8875SHong Zhang   Mat spRHS;
30040e6b8875SHong Zhang 
30050e6b8875SHong Zhang   PetscFunctionBegin;
30069566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST, &spRHS));
30079566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F, spRHS));
30089566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
30093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30100e6b8875SHong Zhang }
30110e6b8875SHong Zhang 
30120e6b8875SHong Zhang /*@
30132ef1f0ffSBarry Smith   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix `A`^T
30140e6b8875SHong Zhang 
3015c3339decSBarry Smith   Logically Collective
30160e6b8875SHong Zhang 
301720f4b53cSBarry Smith   Input Parameter:
301820f4b53cSBarry Smith . F - the factored matrix of A obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
30190e6b8875SHong Zhang 
30200e6b8875SHong Zhang   Output Parameter:
302120f4b53cSBarry Smith . spRHST - sequential sparse matrix in `MATAIJ` format containing the requested entries of inverse of `A`^T
30220e6b8875SHong Zhang 
30230e6b8875SHong Zhang   Level: beginner
30240e6b8875SHong Zhang 
30250e6b8875SHong Zhang   References:
3026606c0280SSatish Balay .  * - MUMPS Users' Guide
30270e6b8875SHong Zhang 
30281cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
30290e6b8875SHong Zhang @*/
3030d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose(Mat F, Mat spRHST)
3031d71ae5a4SJacob Faibussowitsch {
30320e6b8875SHong Zhang   PetscBool flg;
30330e6b8875SHong Zhang 
30340e6b8875SHong Zhang   PetscFunctionBegin;
30350e6b8875SHong Zhang   PetscValidType(F, 1);
303628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30379566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
303828b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)spRHST), PETSC_ERR_ARG_WRONG, "Matrix spRHST must be MATAIJ matrix");
30390e6b8875SHong Zhang 
3040cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverseTranspose_C", (Mat, Mat), (F, spRHST));
30413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30420e6b8875SHong Zhang }
30430e6b8875SHong Zhang 
3044a21f80fcSHong Zhang /*@
3045a21f80fcSHong Zhang   MatMumpsGetInfo - Get MUMPS parameter INFO()
3046a21f80fcSHong Zhang 
3047c3339decSBarry Smith   Logically Collective
3048a21f80fcSHong Zhang 
3049a21f80fcSHong Zhang   Input Parameters:
305011a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3051a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFO()
3052a21f80fcSHong Zhang 
3053a21f80fcSHong Zhang   Output Parameter:
3054a21f80fcSHong Zhang . ival - value of MUMPS INFO(icntl)
3055a21f80fcSHong Zhang 
3056a21f80fcSHong Zhang   Level: beginner
3057a21f80fcSHong Zhang 
305896a0c994SBarry Smith   References:
3059606c0280SSatish Balay .  * - MUMPS Users' Guide
3060a21f80fcSHong Zhang 
30611cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3062a21f80fcSHong Zhang @*/
3063d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo(Mat F, PetscInt icntl, PetscInt *ival)
3064d71ae5a4SJacob Faibussowitsch {
3065bc6112feSHong Zhang   PetscFunctionBegin;
30662989dfd4SHong Zhang   PetscValidType(F, 1);
306728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30684f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3069cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfo_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
30703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3071bc6112feSHong Zhang }
3072bc6112feSHong Zhang 
3073a21f80fcSHong Zhang /*@
3074a21f80fcSHong Zhang   MatMumpsGetInfog - Get MUMPS parameter INFOG()
3075a21f80fcSHong Zhang 
3076c3339decSBarry Smith   Logically Collective
3077a21f80fcSHong Zhang 
3078a21f80fcSHong Zhang   Input Parameters:
307911a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3080a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFOG()
3081a21f80fcSHong Zhang 
3082a21f80fcSHong Zhang   Output Parameter:
3083a21f80fcSHong Zhang . ival - value of MUMPS INFOG(icntl)
3084a21f80fcSHong Zhang 
3085a21f80fcSHong Zhang   Level: beginner
3086a21f80fcSHong Zhang 
308796a0c994SBarry Smith   References:
3088606c0280SSatish Balay .  * - MUMPS Users' Guide
3089a21f80fcSHong Zhang 
30901cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3091a21f80fcSHong Zhang @*/
3092d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog(Mat F, PetscInt icntl, PetscInt *ival)
3093d71ae5a4SJacob Faibussowitsch {
3094bc6112feSHong Zhang   PetscFunctionBegin;
30952989dfd4SHong Zhang   PetscValidType(F, 1);
309628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30974f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3098cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfog_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
30993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3100bc6112feSHong Zhang }
3101bc6112feSHong Zhang 
3102a21f80fcSHong Zhang /*@
3103a21f80fcSHong Zhang   MatMumpsGetRinfo - Get MUMPS parameter RINFO()
3104a21f80fcSHong Zhang 
3105c3339decSBarry Smith   Logically Collective
3106a21f80fcSHong Zhang 
3107a21f80fcSHong Zhang   Input Parameters:
310811a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3109a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFO()
3110a21f80fcSHong Zhang 
3111a21f80fcSHong Zhang   Output Parameter:
3112a21f80fcSHong Zhang . val - value of MUMPS RINFO(icntl)
3113a21f80fcSHong Zhang 
3114a21f80fcSHong Zhang   Level: beginner
3115a21f80fcSHong Zhang 
311696a0c994SBarry Smith   References:
3117606c0280SSatish Balay .  * - MUMPS Users' Guide
3118a21f80fcSHong Zhang 
31191cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
3120a21f80fcSHong Zhang @*/
3121d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo(Mat F, PetscInt icntl, PetscReal *val)
3122d71ae5a4SJacob Faibussowitsch {
3123bc6112feSHong Zhang   PetscFunctionBegin;
31242989dfd4SHong Zhang   PetscValidType(F, 1);
312528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31264f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3127cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfo_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3129bc6112feSHong Zhang }
3130bc6112feSHong Zhang 
3131a21f80fcSHong Zhang /*@
3132a21f80fcSHong Zhang   MatMumpsGetRinfog - Get MUMPS parameter RINFOG()
3133a21f80fcSHong Zhang 
3134c3339decSBarry Smith   Logically Collective
3135a21f80fcSHong Zhang 
3136a21f80fcSHong Zhang   Input Parameters:
313711a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3138a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFOG()
3139a21f80fcSHong Zhang 
3140a21f80fcSHong Zhang   Output Parameter:
3141a21f80fcSHong Zhang . val - value of MUMPS RINFOG(icntl)
3142a21f80fcSHong Zhang 
3143a21f80fcSHong Zhang   Level: beginner
3144a21f80fcSHong Zhang 
314596a0c994SBarry Smith   References:
3146606c0280SSatish Balay .  * - MUMPS Users' Guide
3147a21f80fcSHong Zhang 
31481cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
3149a21f80fcSHong Zhang @*/
3150d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog(Mat F, PetscInt icntl, PetscReal *val)
3151d71ae5a4SJacob Faibussowitsch {
3152bc6112feSHong Zhang   PetscFunctionBegin;
31532989dfd4SHong Zhang   PetscValidType(F, 1);
315428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31554f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3156cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfog_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3158bc6112feSHong Zhang }
3159bc6112feSHong Zhang 
31605c0bae8cSAshish Patel /*@
31615c0bae8cSAshish Patel   MatMumpsGetNullPivots - Get MUMPS parameter PIVNUL_LIST()
31625c0bae8cSAshish Patel 
31635c0bae8cSAshish Patel   Logically Collective
31645c0bae8cSAshish Patel 
31655c0bae8cSAshish Patel   Input Parameter:
31665c0bae8cSAshish Patel . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
31675c0bae8cSAshish Patel 
31685c0bae8cSAshish Patel   Output Parameters:
31695c0bae8cSAshish Patel + size  - local size of the array. The size of the array is non-zero only on the host.
31705c0bae8cSAshish 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
31715c0bae8cSAshish Patel            for freeing this array.
31725c0bae8cSAshish Patel 
31735c0bae8cSAshish Patel   Level: beginner
31745c0bae8cSAshish Patel 
31755c0bae8cSAshish Patel   References:
31765c0bae8cSAshish Patel .  * - MUMPS Users' Guide
31775c0bae8cSAshish Patel 
31781cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
31795c0bae8cSAshish Patel @*/
31805c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots(Mat F, PetscInt *size, PetscInt **array)
31815c0bae8cSAshish Patel {
31825c0bae8cSAshish Patel   PetscFunctionBegin;
31835c0bae8cSAshish Patel   PetscValidType(F, 1);
31845c0bae8cSAshish Patel   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31854f572ea9SToby Isaac   PetscAssertPointer(size, 2);
31864f572ea9SToby Isaac   PetscAssertPointer(array, 3);
31875c0bae8cSAshish Patel   PetscUseMethod(F, "MatMumpsGetNullPivots_C", (Mat, PetscInt *, PetscInt **), (F, size, array));
31885c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
31895c0bae8cSAshish Patel }
31905c0bae8cSAshish Patel 
319124b6179bSKris Buschelman /*MC
31922692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
319324b6179bSKris Buschelman   distributed and sequential matrices via the external package MUMPS.
319424b6179bSKris Buschelman 
319511a5261eSBarry Smith   Works with `MATAIJ` and `MATSBAIJ` matrices
319624b6179bSKris Buschelman 
3197c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
3198c2b89b5dSBarry Smith 
31992ef1f0ffSBarry 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.
32002ef1f0ffSBarry Smith   See details below.
3201217d3b1eSJunchao Zhang 
32022ef1f0ffSBarry Smith   Use `-pc_type cholesky` or `lu` `-pc_factor_mat_solver_type mumps` to use this direct solver
3203c2b89b5dSBarry Smith 
320424b6179bSKris Buschelman   Options Database Keys:
32054422a9fcSPatrick Sanan +  -mat_mumps_icntl_1 - ICNTL(1): output stream for error messages
32064422a9fcSPatrick Sanan .  -mat_mumps_icntl_2 - ICNTL(2): output stream for diagnostic printing, statistics, and warning
32074422a9fcSPatrick Sanan .  -mat_mumps_icntl_3 -  ICNTL(3): output stream for global information, collected on the host
32084422a9fcSPatrick Sanan .  -mat_mumps_icntl_4 -  ICNTL(4): level of printing (0 to 4)
32094422a9fcSPatrick Sanan .  -mat_mumps_icntl_6 - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
3210b53c1a7fSBarry 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
3211b53c1a7fSBarry Smith                         Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
32124422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
32134422a9fcSPatrick Sanan .  -mat_mumps_icntl_10  - ICNTL(10): max num of refinements
32144422a9fcSPatrick Sanan .  -mat_mumps_icntl_11  - ICNTL(11): statistics related to an error analysis (via -ksp_view)
32154422a9fcSPatrick Sanan .  -mat_mumps_icntl_12  - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
32164422a9fcSPatrick Sanan .  -mat_mumps_icntl_13  - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
32174422a9fcSPatrick Sanan .  -mat_mumps_icntl_14  - ICNTL(14): percentage increase in the estimated working space
321845e3843bSPierre Jolivet .  -mat_mumps_icntl_15  - ICNTL(15): compression of the input matrix resulting from a block format
32194422a9fcSPatrick Sanan .  -mat_mumps_icntl_19  - ICNTL(19): computes the Schur complement
322025aac85cSJunchao Zhang .  -mat_mumps_icntl_20  - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
32214422a9fcSPatrick Sanan .  -mat_mumps_icntl_22  - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
32224422a9fcSPatrick Sanan .  -mat_mumps_icntl_23  - ICNTL(23): max size of the working memory (MB) that can allocate per processor
32234422a9fcSPatrick Sanan .  -mat_mumps_icntl_24  - ICNTL(24): detection of null pivot rows (0 or 1)
32244422a9fcSPatrick Sanan .  -mat_mumps_icntl_25  - ICNTL(25): compute a solution of a deficient matrix and a null space basis
32254422a9fcSPatrick Sanan .  -mat_mumps_icntl_26  - ICNTL(26): drives the solution phase if a Schur complement matrix
32264422a9fcSPatrick 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
32274422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
32284422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
32294422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
32304422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
3231a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
3232a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
3233a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
3234146931dbSPierre Jolivet .  -mat_mumps_icntl_58 - ICNTL(58): options for symbolic factorization
32354422a9fcSPatrick Sanan .  -mat_mumps_cntl_1  - CNTL(1): relative pivoting threshold
32364422a9fcSPatrick Sanan .  -mat_mumps_cntl_2  -  CNTL(2): stopping criterion of refinement
32374422a9fcSPatrick Sanan .  -mat_mumps_cntl_3 - CNTL(3): absolute pivoting threshold
32384422a9fcSPatrick Sanan .  -mat_mumps_cntl_4 - CNTL(4): value for static pivoting
3239217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5 - CNTL(5): fixation for null pivots
3240a0e18203SThibaut Appel .  -mat_mumps_cntl_7 - CNTL(7): precision of the dropping parameter used during BLR factorization
3241217d3b1eSJunchao 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.
3242217d3b1eSJunchao Zhang                                    Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
324324b6179bSKris Buschelman 
324424b6179bSKris Buschelman   Level: beginner
324524b6179bSKris Buschelman 
324695452b02SPatrick Sanan     Notes:
32472ef1f0ffSBarry 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
32482ef1f0ffSBarry Smith     error if the matrix is Hermitian.
324938548759SBarry Smith 
325026cc229bSBarry 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
325126cc229bSBarry Smith     `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
325226cc229bSBarry Smith 
32532ef1f0ffSBarry 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
32542ef1f0ffSBarry Smith     the failure with
32552ef1f0ffSBarry Smith .vb
32562ef1f0ffSBarry Smith           KSPGetPC(ksp,&pc);
32572ef1f0ffSBarry Smith           PCFactorGetMatrix(pc,&mat);
32582ef1f0ffSBarry Smith           MatMumpsGetInfo(mat,....);
32592ef1f0ffSBarry Smith           MatMumpsGetInfog(mat,....); etc.
32602ef1f0ffSBarry Smith .ve
32612ef1f0ffSBarry Smith     Or run with `-ksp_error_if_not_converged` and the program will be stopped and the information printed in the error message.
32629fc87aa7SBarry Smith 
3263a5399872SJunchao Zhang     MUMPS provides 64-bit integer support in two build modes:
3264a5399872SJunchao Zhang       full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
3265a5399872SJunchao 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).
32668fcaa860SBarry Smith 
3267a5399872SJunchao 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,
3268a5399872SJunchao 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
3269a5399872SJunchao 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
3270a5399872SJunchao Zhang       integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
3271a5399872SJunchao Zhang 
3272a5399872SJunchao 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.
3273a5399872SJunchao Zhang 
3274a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
32752ef1f0ffSBarry Smith .vb
32762ef1f0ffSBarry Smith      Set OMP_NUM_THREADS and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
32772ef1f0ffSBarry Smith      threads per rank, then you may use "export OMP_NUM_THREADS=16 && mpirun -n 4 ./test".
32782ef1f0ffSBarry Smith .ve
32798fcaa860SBarry Smith 
32802ef1f0ffSBarry Smith .vb
32812ef1f0ffSBarry Smith      -mat_mumps_use_omp_threads [m] and run your code with as many MPI ranks as the number of cores. For example,
32822ef1f0ffSBarry 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"
32832ef1f0ffSBarry Smith .ve
32848fcaa860SBarry Smith 
32858fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
32862ef1f0ffSBarry 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`
32872ef1f0ffSBarry 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
32888fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
32898fcaa860SBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if --with-openmp is provided).
3290217d3b1eSJunchao Zhang 
32918fcaa860SBarry 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
3292217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
3293217d3b1eSJunchao 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
3294217d3b1eSJunchao 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
3295217d3b1eSJunchao 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.
3296217d3b1eSJunchao 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,
3297217d3b1eSJunchao 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
3298217d3b1eSJunchao 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
3299217d3b1eSJunchao 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
3300217d3b1eSJunchao 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.
33018fcaa860SBarry 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
3302217d3b1eSJunchao Zhang    examine the mapping result.
3303217d3b1eSJunchao Zhang 
330411a5261eSBarry 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,
330511a5261eSBarry 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
330611a5261eSBarry Smith    calls `omp_set_num_threads`(m) internally before calling MUMPS.
3307217d3b1eSJunchao Zhang 
3308217d3b1eSJunchao Zhang    References:
3309606c0280SSatish Balay +  * - Heroux, Michael A., R. Brightwell, and Michael M. Wolf. "Bi-modal MPI and MPI+ threads computing on scalable multicore systems." IJHPCA (Submitted) (2011).
3310606c0280SSatish 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.
3311217d3b1eSJunchao Zhang 
33121cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `KSPGetPC()`, `PCFactorGetMatrix()`
331324b6179bSKris Buschelman M*/
331424b6179bSKris Buschelman 
3315d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatFactorGetSolverType_mumps(Mat A, MatSolverType *type)
3316d71ae5a4SJacob Faibussowitsch {
331735bd34faSBarry Smith   PetscFunctionBegin;
33182692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
33193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
332035bd34faSBarry Smith }
332135bd34faSBarry Smith 
3322bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
3323d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_aij_mumps(Mat A, MatFactorType ftype, Mat *F)
3324d71ae5a4SJacob Faibussowitsch {
33252877fffaSHong Zhang   Mat         B;
33262877fffaSHong Zhang   Mat_MUMPS  *mumps;
3327ace3abfcSBarry Smith   PetscBool   isSeqAIJ;
33282c7c0729SBarry Smith   PetscMPIInt size;
33292877fffaSHong Zhang 
33302877fffaSHong Zhang   PetscFunctionBegin;
3331eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
333203e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
333303e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
333403e5aca4SStefano Zampini     *F = NULL;
333503e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
333603e5aca4SStefano Zampini   }
3337eb1ec7c1SStefano Zampini #endif
33382877fffaSHong Zhang   /* Create the factorization matrix */
33399566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATSEQAIJ, &isSeqAIJ));
33409566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
33419566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
33429566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
33439566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
33442877fffaSHong Zhang 
33454dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
33462205254eSKarl Rupp 
33472877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
334835bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
33492205254eSKarl Rupp 
33509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
33519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
33529566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
33539566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
33549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
33559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
33569566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
33579566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
33589566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
33599566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
33609566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
33615c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
33629566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
33639566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
33646444a565SStefano Zampini 
3365450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3366450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3367d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3368bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3369bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
33709566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3371746480a1SHong Zhang     mumps->sym = 0;
3372dcd589f8SShri Abhyankar   } else {
337367877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3374450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3375bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3376bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
33779566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
337859ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
337959ac8732SStefano Zampini     mumps->sym = 2;
338059ac8732SStefano Zampini #else
3381b94d7dedSBarry Smith     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
33826fdc2a6dSBarry Smith     else mumps->sym = 2;
338359ac8732SStefano Zampini #endif
3384450b117fSShri Abhyankar   }
33852877fffaSHong Zhang 
338600c67f3bSHong Zhang   /* set solvertype */
33879566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
33889566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
33899566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
33902c7c0729SBarry Smith   if (size == 1) {
33914ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3392f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
33932c7c0729SBarry Smith   }
33942877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3395e69c285eSBarry Smith   B->data         = (void *)mumps;
33962205254eSKarl Rupp 
33972877fffaSHong Zhang   *F               = B;
3398413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3399413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3400413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3401d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
34023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34032877fffaSHong Zhang }
34042877fffaSHong Zhang 
3405bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3406d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A, MatFactorType ftype, Mat *F)
3407d71ae5a4SJacob Faibussowitsch {
34082877fffaSHong Zhang   Mat         B;
34092877fffaSHong Zhang   Mat_MUMPS  *mumps;
3410ace3abfcSBarry Smith   PetscBool   isSeqSBAIJ;
34112c7c0729SBarry Smith   PetscMPIInt size;
34122877fffaSHong Zhang 
34132877fffaSHong Zhang   PetscFunctionBegin;
3414eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
341503e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
341603e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
341703e5aca4SStefano Zampini     *F = NULL;
341803e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
341903e5aca4SStefano Zampini   }
3420eb1ec7c1SStefano Zampini #endif
34219566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
34229566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
34239566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
34249566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3425e69c285eSBarry Smith 
34264dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
34279566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSBAIJ, &isSeqSBAIJ));
3428bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
342916ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3430dcd589f8SShri Abhyankar   } else {
3431bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3432bccb9932SShri Abhyankar   }
3433bccb9932SShri Abhyankar 
343467877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3435bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3436722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
34372205254eSKarl Rupp 
34389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
34399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
34409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
34419566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
34429566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
34439566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
34449566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
34459566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
34469566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
34479566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
34489566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
34495c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
34509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
34519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
34522205254eSKarl Rupp 
3453f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
345459ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
345559ac8732SStefano Zampini   mumps->sym = 2;
345659ac8732SStefano Zampini #else
3457b94d7dedSBarry Smith   if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
34586fdc2a6dSBarry Smith   else mumps->sym = 2;
345959ac8732SStefano Zampini #endif
3460a214ac2aSShri Abhyankar 
346100c67f3bSHong Zhang   /* set solvertype */
34629566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
34639566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
34649566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
34652c7c0729SBarry Smith   if (size == 1) {
34664ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3467f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
34682c7c0729SBarry Smith   }
34699566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3470f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3471e69c285eSBarry Smith   B->data         = (void *)mumps;
34722205254eSKarl Rupp 
34732877fffaSHong Zhang   *F               = B;
3474413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3475413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3476413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3477d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
34783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34792877fffaSHong Zhang }
348097969023SHong Zhang 
3481d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_baij_mumps(Mat A, MatFactorType ftype, Mat *F)
3482d71ae5a4SJacob Faibussowitsch {
348367877ebaSShri Abhyankar   Mat         B;
348467877ebaSShri Abhyankar   Mat_MUMPS  *mumps;
3485ace3abfcSBarry Smith   PetscBool   isSeqBAIJ;
34862c7c0729SBarry Smith   PetscMPIInt size;
348767877ebaSShri Abhyankar 
348867877ebaSShri Abhyankar   PetscFunctionBegin;
348967877ebaSShri Abhyankar   /* Create the factorization matrix */
34909566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQBAIJ, &isSeqBAIJ));
34919566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
34929566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
34939566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
34949566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3495450b117fSShri Abhyankar 
34964dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
3497450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3498450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3499450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3500bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3501bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3502746480a1SHong Zhang     mumps->sym = 0;
35039566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3504546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3505bccb9932SShri Abhyankar 
3506450b117fSShri Abhyankar   B->ops->view    = MatView_MUMPS;
3507722b6324SPierre Jolivet   B->ops->getinfo = MatGetInfo_MUMPS;
35082205254eSKarl Rupp 
35099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
35139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
35149566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
35159566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
35169566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
35179566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
35189566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
35199566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
35205c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
35219566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
35229566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
3523450b117fSShri Abhyankar 
352400c67f3bSHong Zhang   /* set solvertype */
35259566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
35269566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
35279566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
35282c7c0729SBarry Smith   if (size == 1) {
35294ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3530f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35312c7c0729SBarry Smith   }
35327ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
35337ee00b23SStefano Zampini   B->data         = (void *)mumps;
35347ee00b23SStefano Zampini 
35357ee00b23SStefano Zampini   *F               = B;
3536413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3537413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3538413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3539d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
35417ee00b23SStefano Zampini }
35427ee00b23SStefano Zampini 
35437ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
3544d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sell_mumps(Mat A, MatFactorType ftype, Mat *F)
3545d71ae5a4SJacob Faibussowitsch {
35467ee00b23SStefano Zampini   Mat         B;
35477ee00b23SStefano Zampini   Mat_MUMPS  *mumps;
35487ee00b23SStefano Zampini   PetscBool   isSeqSELL;
35492c7c0729SBarry Smith   PetscMPIInt size;
35507ee00b23SStefano Zampini 
35517ee00b23SStefano Zampini   PetscFunctionBegin;
35527ee00b23SStefano Zampini   /* Create the factorization matrix */
35539566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSELL, &isSeqSELL));
35549566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35559566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
35569566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
35579566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
35587ee00b23SStefano Zampini 
35594dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
35607ee00b23SStefano Zampini 
35617ee00b23SStefano Zampini   B->ops->view    = MatView_MUMPS;
35627ee00b23SStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
35637ee00b23SStefano Zampini 
35649566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35659566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35669566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35679566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
35689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
35699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
35709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
35719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
35729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
35739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
35749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
35755c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
35767ee00b23SStefano Zampini 
35777ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
35787ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
35797ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
35807ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
35817ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
35827ee00b23SStefano Zampini     mumps->sym = 0;
35839566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
35847ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
35857ee00b23SStefano Zampini 
35867ee00b23SStefano Zampini   /* set solvertype */
35879566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
35889566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
35899566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
35902c7c0729SBarry Smith   if (size == 1) {
35914ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3592f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35932c7c0729SBarry Smith   }
3594450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3595e69c285eSBarry Smith   B->data         = (void *)mumps;
35962205254eSKarl Rupp 
3597450b117fSShri Abhyankar   *F               = B;
3598413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3599413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3600413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3601d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
36023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3603450b117fSShri Abhyankar }
360442c9c57cSBarry Smith 
36059d0448ceSStefano Zampini /* MatGetFactor for MATNEST matrices */
36069d0448ceSStefano Zampini static PetscErrorCode MatGetFactor_nest_mumps(Mat A, MatFactorType ftype, Mat *F)
36079d0448ceSStefano Zampini {
36089d0448ceSStefano Zampini   Mat         B, **mats;
36099d0448ceSStefano Zampini   Mat_MUMPS  *mumps;
36109d0448ceSStefano Zampini   PetscInt    nr, nc;
36119d0448ceSStefano Zampini   PetscMPIInt size;
361203e5aca4SStefano Zampini   PetscBool   flg = PETSC_TRUE;
36139d0448ceSStefano Zampini 
36149d0448ceSStefano Zampini   PetscFunctionBegin;
36159d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
361603e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
361703e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
361803e5aca4SStefano Zampini     *F = NULL;
361903e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
362003e5aca4SStefano Zampini   }
36219d0448ceSStefano Zampini #endif
36229d0448ceSStefano Zampini 
362303e5aca4SStefano Zampini   /* Return if some condition is not satisfied */
362403e5aca4SStefano Zampini   *F = NULL;
36259d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
36269d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY) {
36279d0448ceSStefano Zampini     IS       *rows, *cols;
36289d0448ceSStefano Zampini     PetscInt *m, *M;
36299d0448ceSStefano Zampini 
36309d0448ceSStefano 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);
36319d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &rows, nc, &cols));
36329d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
36339d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++) PetscCall(ISEqualUnsorted(rows[r], cols[r], &flg));
363403e5aca4SStefano Zampini     if (!flg) {
363503e5aca4SStefano Zampini       PetscCall(PetscFree2(rows, cols));
363603e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for unequal row and column maps. Use MAT_FACTOR_LU.\n"));
363703e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
363803e5aca4SStefano Zampini     }
36399d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &m, nr, &M));
36409d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetMinMax(rows[r], &m[r], &M[r]));
36419d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++)
36429d0448ceSStefano Zampini       for (PetscInt k = r + 1; flg && k < nr; k++)
36439d0448ceSStefano Zampini         if ((m[k] <= m[r] && m[r] <= M[k]) || (m[k] <= M[r] && M[r] <= M[k])) flg = PETSC_FALSE;
36449d0448ceSStefano Zampini     PetscCall(PetscFree2(m, M));
36459d0448ceSStefano Zampini     PetscCall(PetscFree2(rows, cols));
364603e5aca4SStefano Zampini     if (!flg) {
364703e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for intersecting row maps. Use MAT_FACTOR_LU.\n"));
364803e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
364903e5aca4SStefano Zampini     }
36509d0448ceSStefano Zampini   }
36519d0448ceSStefano Zampini 
36529d0448ceSStefano Zampini   for (PetscInt r = 0; r < nr; r++) {
36539d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) {
36549d0448ceSStefano Zampini       Mat       sub = mats[r][c];
36555d955bbbSStefano Zampini       PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans;
36569d0448ceSStefano Zampini 
36579d0448ceSStefano Zampini       if (!sub || (ftype == MAT_FACTOR_CHOLESKY && c < r)) continue;
36585d955bbbSStefano Zampini       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
36595d955bbbSStefano Zampini       if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
36605d955bbbSStefano Zampini       else {
36615d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isTrans));
36625d955bbbSStefano Zampini         if (isTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
36635d955bbbSStefano Zampini       }
36649d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
36659d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
36669d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
36679d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
36689d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
36699d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
36709d0448ceSStefano Zampini       if (ftype == MAT_FACTOR_CHOLESKY) {
367103e5aca4SStefano Zampini         if (r == c && !isSeqAIJ && !isMPIAIJ && !isSeqSBAIJ && !isMPISBAIJ) {
367203e5aca4SStefano Zampini           PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
367303e5aca4SStefano Zampini           flg = PETSC_FALSE;
367403e5aca4SStefano Zampini         } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ) {
367503e5aca4SStefano Zampini           PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for off-diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
367603e5aca4SStefano Zampini           flg = PETSC_FALSE;
367703e5aca4SStefano Zampini         }
367803e5aca4SStefano Zampini       } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ) {
367903e5aca4SStefano Zampini         PetscCall(PetscInfo(sub, "MAT_LU_FACTOR not supported for block of type %s.\n", ((PetscObject)sub)->type_name));
368003e5aca4SStefano Zampini         flg = PETSC_FALSE;
36819d0448ceSStefano Zampini       }
36829d0448ceSStefano Zampini     }
368303e5aca4SStefano Zampini   }
368403e5aca4SStefano Zampini   if (!flg) PetscFunctionReturn(PETSC_SUCCESS);
36859d0448ceSStefano Zampini 
36869d0448ceSStefano Zampini   /* Create the factorization matrix */
36879d0448ceSStefano Zampini   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
36889d0448ceSStefano Zampini   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
36899d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
36909d0448ceSStefano Zampini   PetscCall(MatSetUp(B));
36919d0448ceSStefano Zampini 
36929d0448ceSStefano Zampini   PetscCall(PetscNew(&mumps));
36939d0448ceSStefano Zampini 
36949d0448ceSStefano Zampini   B->ops->view    = MatView_MUMPS;
36959d0448ceSStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
36969d0448ceSStefano Zampini 
36979d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
36989d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
36999d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
37009d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
37019d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
37029d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
37039d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
37049d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
37059d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
37069d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
37079d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
37089d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
37099d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
37109d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
37119d0448ceSStefano Zampini 
37129d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_LU) {
37139d0448ceSStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
37149d0448ceSStefano Zampini     B->factortype            = MAT_FACTOR_LU;
37159d0448ceSStefano Zampini     mumps->sym               = 0;
37169d0448ceSStefano Zampini   } else {
37179d0448ceSStefano Zampini     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
37189d0448ceSStefano Zampini     B->factortype                  = MAT_FACTOR_CHOLESKY;
37199d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
37209d0448ceSStefano Zampini     mumps->sym = 2;
37219d0448ceSStefano Zampini #else
37229d0448ceSStefano Zampini     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
37239d0448ceSStefano Zampini     else mumps->sym = 2;
37249d0448ceSStefano Zampini #endif
37259d0448ceSStefano Zampini   }
37269d0448ceSStefano Zampini   mumps->ConvertToTriples = MatConvertToTriples_nest_xaij;
37279d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[ftype]));
37289d0448ceSStefano Zampini 
37299d0448ceSStefano Zampini   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
37309d0448ceSStefano Zampini   if (size == 1) {
37319d0448ceSStefano Zampini     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
37329d0448ceSStefano Zampini     B->canuseordering = PETSC_TRUE;
37339d0448ceSStefano Zampini   }
37349d0448ceSStefano Zampini 
37359d0448ceSStefano Zampini   /* set solvertype */
37369d0448ceSStefano Zampini   PetscCall(PetscFree(B->solvertype));
37379d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
37389d0448ceSStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
37399d0448ceSStefano Zampini   B->data         = (void *)mumps;
37409d0448ceSStefano Zampini 
37419d0448ceSStefano Zampini   *F               = B;
37429d0448ceSStefano Zampini   mumps->id.job    = JOB_NULL;
37439d0448ceSStefano Zampini   mumps->ICNTL_pre = NULL;
37449d0448ceSStefano Zampini   mumps->CNTL_pre  = NULL;
37459d0448ceSStefano Zampini   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
37469d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37479d0448ceSStefano Zampini }
37489d0448ceSStefano Zampini 
3749d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
3750d71ae5a4SJacob Faibussowitsch {
375142c9c57cSBarry Smith   PetscFunctionBegin;
37529566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37539566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37549566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37559566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37569566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPISBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37579566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37589566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37599566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37609566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37619566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37629566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSELL, MAT_FACTOR_LU, MatGetFactor_sell_mumps));
37639d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_LU, MatGetFactor_nest_mumps));
37649d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_CHOLESKY, MatGetFactor_nest_mumps));
37653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
376642c9c57cSBarry Smith }
3767