xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision 96eb7ee0a5daccfd5e9ba9f7a95d4d8b9800596a)
1397b6df1SKris Buschelman /*
2c2b5dc30SHong Zhang     Provides an interface to the MUMPS sparse solver
3397b6df1SKris Buschelman */
467602552SJunchao Zhang #include <petscpkg_version.h>
59d0448ceSStefano Zampini #include <petscsf.h>
6c6db04a5SJed Brown #include <../src/mat/impls/aij/mpi/mpiaij.h> /*I  "petscmat.h"  I*/
7c6db04a5SJed Brown #include <../src/mat/impls/sbaij/mpi/mpisbaij.h>
87ee00b23SStefano Zampini #include <../src/mat/impls/sell/mpi/mpisell.h>
9397b6df1SKris Buschelman 
109261f6e4SBarry Smith #define MUMPS_MANUALS "(see users manual https://mumps-solver.org/index.php?page=doc \"Error and warning diagnostics\")"
119261f6e4SBarry Smith 
12397b6df1SKris Buschelman EXTERN_C_BEGIN
13397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
142907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
152907cef9SHong Zhang     #include <cmumps_c.h>
162907cef9SHong Zhang   #else
17c6db04a5SJed Brown     #include <zmumps_c.h>
182907cef9SHong Zhang   #endif
192907cef9SHong Zhang #else
202907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
212907cef9SHong Zhang     #include <smumps_c.h>
22397b6df1SKris Buschelman   #else
23c6db04a5SJed Brown     #include <dmumps_c.h>
24397b6df1SKris Buschelman   #endif
252907cef9SHong Zhang #endif
26397b6df1SKris Buschelman EXTERN_C_END
27397b6df1SKris Buschelman #define JOB_INIT         -1
28413bcc21SPierre Jolivet #define JOB_NULL         0
293d472b54SHong Zhang #define JOB_FACTSYMBOLIC 1
303d472b54SHong Zhang #define JOB_FACTNUMERIC  2
313d472b54SHong Zhang #define JOB_SOLVE        3
32397b6df1SKris Buschelman #define JOB_END          -2
333d472b54SHong Zhang 
342907cef9SHong Zhang /* calls to MUMPS */
352907cef9SHong Zhang #if defined(PETSC_USE_COMPLEX)
362907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
373ab56b82SJunchao Zhang     #define MUMPS_c cmumps_c
382907cef9SHong Zhang   #else
393ab56b82SJunchao Zhang     #define MUMPS_c zmumps_c
402907cef9SHong Zhang   #endif
412907cef9SHong Zhang #else
422907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
433ab56b82SJunchao Zhang     #define MUMPS_c smumps_c
442907cef9SHong Zhang   #else
453ab56b82SJunchao Zhang     #define MUMPS_c dmumps_c
462907cef9SHong Zhang   #endif
472907cef9SHong Zhang #endif
482907cef9SHong Zhang 
49a6053eceSJunchao Zhang /* MUMPS uses MUMPS_INT for nonzero indices such as irn/jcn, irn_loc/jcn_loc and uses int64_t for
50a6053eceSJunchao Zhang    number of nonzeros such as nnz, nnz_loc. We typedef MUMPS_INT to PetscMUMPSInt to follow the
51a6053eceSJunchao Zhang    naming convention in PetscMPIInt, PetscBLASInt etc.
52a6053eceSJunchao Zhang */
53a6053eceSJunchao Zhang typedef MUMPS_INT PetscMUMPSInt;
54a6053eceSJunchao Zhang 
5567602552SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5, 3, 0)
5667602552SJunchao Zhang   #if defined(MUMPS_INTSIZE64) /* MUMPS_INTSIZE64 is in MUMPS headers if it is built in full 64-bit mode, therefore the macro is more reliable */
57f0b74427SPierre Jolivet     #error "PETSc has not been tested with full 64-bit MUMPS and we choose to error out"
5867602552SJunchao Zhang   #endif
59a6053eceSJunchao Zhang #else
6067602552SJunchao Zhang   #if defined(INTSIZE64) /* INTSIZE64 is a command line macro one used to build MUMPS in full 64-bit mode */
61f0b74427SPierre Jolivet     #error "PETSc has not been tested with full 64-bit MUMPS and we choose to error out"
6267602552SJunchao Zhang   #endif
6367602552SJunchao Zhang #endif
6467602552SJunchao Zhang 
65a6053eceSJunchao Zhang #define MPIU_MUMPSINT       MPI_INT
66a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MAX 2147483647
67a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MIN -2147483648
68a6053eceSJunchao Zhang 
69a6053eceSJunchao Zhang /* Cast PetscInt to PetscMUMPSInt. Usually there is no overflow since <a> is row/col indices or some small integers*/
706497c311SBarry Smith static inline PetscErrorCode PetscMUMPSIntCast(PetscCount a, PetscMUMPSInt *b)
71d71ae5a4SJacob Faibussowitsch {
72a6053eceSJunchao Zhang   PetscFunctionBegin;
73ece88022SPierre Jolivet #if PetscDefined(USE_64BIT_INDICES)
742c71b3e2SJacob Faibussowitsch   PetscAssert(a <= PETSC_MUMPS_INT_MAX && a >= PETSC_MUMPS_INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
75ece88022SPierre Jolivet #endif
7657508eceSPierre Jolivet   *b = (PetscMUMPSInt)a;
773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
78a6053eceSJunchao Zhang }
79a6053eceSJunchao Zhang 
80a6053eceSJunchao Zhang /* Put these utility routines here since they are only used in this file */
81ce78bad3SBarry Smith static inline PetscErrorCode PetscOptionsMUMPSInt_Private(PetscOptionItems PetscOptionsObject, const char opt[], const char text[], const char man[], PetscMUMPSInt currentvalue, PetscMUMPSInt *value, PetscBool *set, PetscMUMPSInt lb, PetscMUMPSInt ub)
82d71ae5a4SJacob Faibussowitsch {
83a6053eceSJunchao Zhang   PetscInt  myval;
84a6053eceSJunchao Zhang   PetscBool myset;
854d86920dSPierre Jolivet 
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. */
1716497c311SBarry Smith   PetscCount     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 */
1916497c311SBarry Smith   PetscCount     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 *);
1966497c311SBarry Smith   PetscCount  *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) */
202f0b74427SPierre Jolivet   MPI_Comm     petsc_comm, omp_comm; /* petsc_comm is PETSc matrix's comm */
2036497c311SBarry Smith   PetscCount  *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  */
212d2a308c1SPierre Jolivet static PetscErrorCode PetscMUMPSIntCSRCast(PETSC_UNUSED Mat_MUMPS *mumps, PetscInt nrow, PetscInt *ia, PetscInt *ja, PetscMUMPSInt **ia_mumps, PetscMUMPSInt **ja_mumps, PetscMUMPSInt *nnz_mumps)
213d71ae5a4SJacob Faibussowitsch {
2146497c311SBarry Smith   PetscInt nnz = ia[nrow] - 1; /* mumps uses 1-based indices. Uses PetscInt instead of PetscCount 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     }
230f4f49eeaSPierre Jolivet     for (i = 0; i < nrow + 1; i++) PetscCall(PetscMUMPSIntCast(ia[i], &mumps->ia_alloc[i]));
231f4f49eeaSPierre Jolivet     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 /*
353f0b74427SPierre Jolivet   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 
37066976f2fSJacob Faibussowitsch static 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;
3746497c311SBarry Smith   PetscCount         nz, rnz, 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));
380bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
3812205254eSKarl Rupp     nz = aa->nz;
3822205254eSKarl Rupp     ai = aa->i;
3832205254eSKarl Rupp     aj = aa->j;
3849566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
3856497c311SBarry Smith     for (PetscCount i = k = 0; i < M; i++) {
38616ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
38767877ebaSShri Abhyankar       ajj = aj + ai[i];
3886497c311SBarry Smith       for (PetscCount j = 0; j < rnz; j++) {
3899566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[k]));
3909566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[k]));
391a6053eceSJunchao Zhang         k++;
39216ebf90aSShri Abhyankar       }
39316ebf90aSShri Abhyankar     }
39450c845baSStefano Zampini     mumps->val = (PetscScalar *)av;
395a6053eceSJunchao Zhang     mumps->irn = row;
396a6053eceSJunchao Zhang     mumps->jcn = col;
397a6053eceSJunchao Zhang     mumps->nnz = nz;
398127cd276SPierre Jolivet   } else if (mumps->nest_vals) PetscCall(PetscArraycpy(mumps->val, av, aa->nz)); /* MatConvertToTriples_nest_xaij() allocates mumps->val outside of MatConvertToTriples_seqaij_seqaij(), so one needs to copy the memory */
399127cd276SPierre Jolivet   else mumps->val = (PetscScalar *)av;                                           /* in the default case, mumps->val is never allocated, one just needs to update the mumps->val pointer */
4009566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
4013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
40216ebf90aSShri Abhyankar }
403397b6df1SKris Buschelman 
40466976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
405d71ae5a4SJacob Faibussowitsch {
4066497c311SBarry Smith   PetscCount     nz, i, j, k, r;
4077ee00b23SStefano Zampini   Mat_SeqSELL   *a = (Mat_SeqSELL *)A->data;
408a6053eceSJunchao Zhang   PetscMUMPSInt *row, *col;
4097ee00b23SStefano Zampini 
4107ee00b23SStefano Zampini   PetscFunctionBegin;
4117ee00b23SStefano Zampini   nz = a->sliidx[a->totalslices];
41250c845baSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
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;
42150c845baSStefano Zampini     mumps->val = a->val;
422127cd276SPierre Jolivet   } else if (mumps->nest_vals) PetscCall(PetscArraycpy(mumps->val, a->val, nz)); /* MatConvertToTriples_nest_xaij() allocates mumps->val outside of MatConvertToTriples_seqsell_seqaij(), so one needs to copy the memory */
423127cd276SPierre Jolivet   else mumps->val = a->val;                                                      /* in the default case, mumps->val is never allocated, one just needs to update the mumps->val pointer */
4243ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4257ee00b23SStefano Zampini }
4267ee00b23SStefano Zampini 
42766976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
428d71ae5a4SJacob Faibussowitsch {
42967877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa = (Mat_SeqBAIJ *)A->data;
43033d57670SJed Brown   const PetscInt *ai, *aj, *ajj, bs2 = aa->bs2;
4316497c311SBarry Smith   PetscCount      M, nz = bs2 * aa->nz, idx = 0, rnz, i, j, k, m;
432a6053eceSJunchao Zhang   PetscInt        bs;
433a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
43467877ebaSShri Abhyankar 
43567877ebaSShri Abhyankar   PetscFunctionBegin;
43650c845baSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4379566063dSJacob Faibussowitsch     PetscCall(MatGetBlockSize(A, &bs));
43833d57670SJed Brown     M  = A->rmap->N / bs;
4399371c9d4SSatish Balay     ai = aa->i;
4409371c9d4SSatish Balay     aj = aa->j;
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;
45850c845baSStefano Zampini     mumps->val = aa->a;
459127cd276SPierre Jolivet   } else if (mumps->nest_vals) PetscCall(PetscArraycpy(mumps->val, aa->a, nz)); /* MatConvertToTriples_nest_xaij() allocates mumps->val outside of MatConvertToTriples_seqbaij_seqaij(), so one needs to copy the memory */
460127cd276SPierre Jolivet   else mumps->val = aa->a;                                                      /* in the default case, mumps->val is never allocated, one just needs to update the mumps->val pointer */
4613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46267877ebaSShri Abhyankar }
46367877ebaSShri Abhyankar 
46466976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
465d71ae5a4SJacob Faibussowitsch {
46675480915SPierre Jolivet   const PetscInt *ai, *aj, *ajj;
467a6053eceSJunchao Zhang   PetscInt        bs;
4686497c311SBarry Smith   PetscCount      nz, rnz, i, j, k, m;
469a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
47075480915SPierre Jolivet   PetscScalar    *val;
47116ebf90aSShri Abhyankar   Mat_SeqSBAIJ   *aa  = (Mat_SeqSBAIJ *)A->data;
47275480915SPierre Jolivet   const PetscInt  bs2 = aa->bs2, mbs = aa->mbs;
47338548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
474b94d7dedSBarry Smith   PetscBool isset, hermitian;
47538548759SBarry Smith #endif
47616ebf90aSShri Abhyankar 
47716ebf90aSShri Abhyankar   PetscFunctionBegin;
47838548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
479b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
480b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
48138548759SBarry Smith #endif
4822205254eSKarl Rupp   ai = aa->i;
4832205254eSKarl Rupp   aj = aa->j;
4849566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
48575480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
4866497c311SBarry Smith     const PetscCount alloc_size = aa->nz * bs2;
487f3fa974cSJacob Faibussowitsch 
488f3fa974cSJacob Faibussowitsch     PetscCall(PetscMalloc2(alloc_size, &row, alloc_size, &col));
489a6053eceSJunchao Zhang     if (bs > 1) {
490f3fa974cSJacob Faibussowitsch       PetscCall(PetscMalloc1(alloc_size, &mumps->val_alloc));
491a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
49275480915SPierre Jolivet     } else {
493a6053eceSJunchao Zhang       mumps->val = aa->a;
49475480915SPierre Jolivet     }
495a6053eceSJunchao Zhang     mumps->irn = row;
496a6053eceSJunchao Zhang     mumps->jcn = col;
497a6053eceSJunchao Zhang   } else {
498a6053eceSJunchao Zhang     row = mumps->irn;
499a6053eceSJunchao Zhang     col = mumps->jcn;
500a6053eceSJunchao Zhang   }
501a6053eceSJunchao Zhang   val = mumps->val;
502185f6596SHong Zhang 
50316ebf90aSShri Abhyankar   nz = 0;
504a81fe166SPierre Jolivet   if (bs > 1) {
50575480915SPierre Jolivet     for (i = 0; i < mbs; i++) {
50616ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
50767877ebaSShri Abhyankar       ajj = aj + ai[i];
50875480915SPierre Jolivet       for (j = 0; j < rnz; j++) {
50975480915SPierre Jolivet         for (k = 0; k < bs; k++) {
51075480915SPierre Jolivet           for (m = 0; m < bs; m++) {
511ec4f40fdSPierre Jolivet             if (ajj[j] > i || k >= m) {
51275480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
5139566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[nz]));
5149566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j] * bs + k + shift, &col[nz]));
51575480915SPierre Jolivet               }
51675480915SPierre Jolivet               val[nz++] = aa->a[(ai[i] + j) * bs2 + m + k * bs];
51775480915SPierre Jolivet             }
51875480915SPierre Jolivet           }
51975480915SPierre Jolivet         }
52075480915SPierre Jolivet       }
52175480915SPierre Jolivet     }
522a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
523a81fe166SPierre Jolivet     for (i = 0; i < mbs; i++) {
524a81fe166SPierre Jolivet       rnz = ai[i + 1] - ai[i];
525a81fe166SPierre Jolivet       ajj = aj + ai[i];
526a81fe166SPierre Jolivet       for (j = 0; j < rnz; j++) {
5279566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5289566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
529a6053eceSJunchao Zhang         nz++;
530a81fe166SPierre Jolivet       }
531a81fe166SPierre Jolivet     }
5326497c311SBarry Smith     PetscCheck(nz == aa->nz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different numbers of nonzeros %" PetscCount_FMT " != %" PetscInt_FMT, nz, aa->nz);
533127cd276SPierre Jolivet   } else if (mumps->nest_vals)
534127cd276SPierre Jolivet     PetscCall(PetscArraycpy(mumps->val, aa->a, aa->nz)); /* bs == 1 and MAT_REUSE_MATRIX, MatConvertToTriples_nest_xaij() allocates mumps->val outside of MatConvertToTriples_seqsbaij_seqsbaij(), so one needs to copy the memory */
535127cd276SPierre Jolivet   else mumps->val = aa->a;                               /* in the default case, mumps->val is never allocated, one just needs to update the mumps->val pointer */
536a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
5373ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
53816ebf90aSShri Abhyankar }
53916ebf90aSShri Abhyankar 
54066976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
541d71ae5a4SJacob Faibussowitsch {
54267877ebaSShri Abhyankar   const PetscInt    *ai, *aj, *ajj, *adiag, M = A->rmap->n;
5436497c311SBarry Smith   PetscCount         nz, rnz, i, j;
54467877ebaSShri Abhyankar   const PetscScalar *av, *v1;
54516ebf90aSShri Abhyankar   PetscScalar       *val;
546a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
547829b1710SHong Zhang   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
54829b521d4Sstefano_zampini   PetscBool          missing;
54938548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
550b94d7dedSBarry Smith   PetscBool hermitian, isset;
55138548759SBarry Smith #endif
55216ebf90aSShri Abhyankar 
55316ebf90aSShri Abhyankar   PetscFunctionBegin;
55438548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
555b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
556b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
55738548759SBarry Smith #endif
5589566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
5599371c9d4SSatish Balay   ai    = aa->i;
5609371c9d4SSatish Balay   aj    = aa->j;
56116ebf90aSShri Abhyankar   adiag = aa->diag;
5629566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A, &missing, NULL));
563bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5647ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
565829b1710SHong Zhang     nz = 0;
56629b521d4Sstefano_zampini     if (missing) {
56729b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
56829b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
56929b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
57029b521d4Sstefano_zampini             if (aj[j] < i) continue;
57129b521d4Sstefano_zampini             nz++;
57229b521d4Sstefano_zampini           }
57329b521d4Sstefano_zampini         } else {
57429b521d4Sstefano_zampini           nz += ai[i + 1] - adiag[i];
57529b521d4Sstefano_zampini         }
57629b521d4Sstefano_zampini       }
57729b521d4Sstefano_zampini     } else {
578829b1710SHong Zhang       for (i = 0; i < M; i++) nz += ai[i + 1] - adiag[i];
57929b521d4Sstefano_zampini     }
5809566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
5819566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
582a6053eceSJunchao Zhang     mumps->nnz = nz;
583a6053eceSJunchao Zhang     mumps->irn = row;
584a6053eceSJunchao Zhang     mumps->jcn = col;
585a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
586185f6596SHong Zhang 
58716ebf90aSShri Abhyankar     nz = 0;
58829b521d4Sstefano_zampini     if (missing) {
58929b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
59029b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
59129b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
59229b521d4Sstefano_zampini             if (aj[j] < i) continue;
5939566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5949566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j] + shift, &col[nz]));
59529b521d4Sstefano_zampini             val[nz] = av[j];
59629b521d4Sstefano_zampini             nz++;
59729b521d4Sstefano_zampini           }
59829b521d4Sstefano_zampini         } else {
59929b521d4Sstefano_zampini           rnz = ai[i + 1] - adiag[i];
60029b521d4Sstefano_zampini           ajj = aj + adiag[i];
60129b521d4Sstefano_zampini           v1  = av + adiag[i];
60229b521d4Sstefano_zampini           for (j = 0; j < rnz; j++) {
6039566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6049566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
605a6053eceSJunchao Zhang             val[nz++] = v1[j];
60629b521d4Sstefano_zampini           }
60729b521d4Sstefano_zampini         }
60829b521d4Sstefano_zampini       }
60929b521d4Sstefano_zampini     } else {
61016ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
61116ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
61267877ebaSShri Abhyankar         ajj = aj + adiag[i];
613cf3759fdSShri Abhyankar         v1  = av + adiag[i];
61467877ebaSShri Abhyankar         for (j = 0; j < rnz; j++) {
6159566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6169566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
617a6053eceSJunchao Zhang           val[nz++] = v1[j];
61816ebf90aSShri Abhyankar         }
61916ebf90aSShri Abhyankar       }
62029b521d4Sstefano_zampini     }
621397b6df1SKris Buschelman   } else {
622a6053eceSJunchao Zhang     nz  = 0;
623a6053eceSJunchao Zhang     val = mumps->val;
62429b521d4Sstefano_zampini     if (missing) {
62516ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
62629b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
62729b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
62829b521d4Sstefano_zampini             if (aj[j] < i) continue;
62929b521d4Sstefano_zampini             val[nz++] = av[j];
63029b521d4Sstefano_zampini           }
63129b521d4Sstefano_zampini         } else {
63216ebf90aSShri Abhyankar           rnz = ai[i + 1] - adiag[i];
63367877ebaSShri Abhyankar           v1  = av + adiag[i];
634ad540459SPierre Jolivet           for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63516ebf90aSShri Abhyankar         }
63616ebf90aSShri Abhyankar       }
63729b521d4Sstefano_zampini     } else {
63816ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
63916ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
64016ebf90aSShri Abhyankar         v1  = av + adiag[i];
641ad540459SPierre Jolivet         for (j = 0; j < rnz; j++) val[nz++] = v1[j];
64216ebf90aSShri Abhyankar       }
64316ebf90aSShri Abhyankar     }
64429b521d4Sstefano_zampini   }
6459566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
6463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
64716ebf90aSShri Abhyankar }
64816ebf90aSShri Abhyankar 
64966976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
650d71ae5a4SJacob Faibussowitsch {
651a6053eceSJunchao Zhang   const PetscInt    *ai, *aj, *bi, *bj, *garray, *ajj, *bjj;
652a6053eceSJunchao Zhang   PetscInt           bs;
6536497c311SBarry Smith   PetscCount         rstart, nz, i, j, k, m, jj, irow, countA, countB;
654a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
65516ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
65616ebf90aSShri Abhyankar   PetscScalar       *val;
657397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ *)A->data;
658f4f49eeaSPierre Jolivet   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ *)mat->A->data;
659f4f49eeaSPierre Jolivet   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)mat->B->data;
660ec4f40fdSPierre Jolivet   const PetscInt     bs2 = aa->bs2, mbs = aa->mbs;
66138548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
662b94d7dedSBarry Smith   PetscBool hermitian, isset;
66338548759SBarry Smith #endif
66416ebf90aSShri Abhyankar 
66516ebf90aSShri Abhyankar   PetscFunctionBegin;
66638548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
667b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
668b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
66938548759SBarry Smith #endif
6709566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
67138548759SBarry Smith   rstart = A->rmap->rstart;
67238548759SBarry Smith   ai     = aa->i;
67338548759SBarry Smith   aj     = aa->j;
67438548759SBarry Smith   bi     = bb->i;
67538548759SBarry Smith   bj     = bb->j;
67638548759SBarry Smith   av     = aa->a;
67738548759SBarry Smith   bv     = bb->a;
678397b6df1SKris Buschelman 
6792205254eSKarl Rupp   garray = mat->garray;
6802205254eSKarl Rupp 
681bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
682a6053eceSJunchao Zhang     nz = (aa->nz + bb->nz) * bs2; /* just a conservative estimate */
6839566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
6849566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
685a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
686a6053eceSJunchao Zhang     mumps->irn = row;
687a6053eceSJunchao Zhang     mumps->jcn = col;
688a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
689397b6df1SKris Buschelman   } else {
690a6053eceSJunchao Zhang     val = mumps->val;
691397b6df1SKris Buschelman   }
692397b6df1SKris Buschelman 
6939371c9d4SSatish Balay   jj   = 0;
6949371c9d4SSatish Balay   irow = rstart;
695ec4f40fdSPierre Jolivet   for (i = 0; i < mbs; i++) {
696397b6df1SKris Buschelman     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
697397b6df1SKris Buschelman     countA = ai[i + 1] - ai[i];
698397b6df1SKris Buschelman     countB = bi[i + 1] - bi[i];
699397b6df1SKris Buschelman     bjj    = bj + bi[i];
700ec4f40fdSPierre Jolivet     v1     = av + ai[i] * bs2;
701ec4f40fdSPierre Jolivet     v2     = bv + bi[i] * bs2;
702397b6df1SKris Buschelman 
703ec4f40fdSPierre Jolivet     if (bs > 1) {
704ec4f40fdSPierre Jolivet       /* A-part */
705ec4f40fdSPierre Jolivet       for (j = 0; j < countA; j++) {
706ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
707ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
708ec4f40fdSPierre Jolivet             if (rstart + ajj[j] * bs > irow || k >= m) {
709ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
7109566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7119566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j] * bs + k + shift, &col[jj]));
712ec4f40fdSPierre Jolivet               }
713ec4f40fdSPierre Jolivet               val[jj++] = v1[j * bs2 + m + k * bs];
714ec4f40fdSPierre Jolivet             }
715ec4f40fdSPierre Jolivet           }
716ec4f40fdSPierre Jolivet         }
717ec4f40fdSPierre Jolivet       }
718ec4f40fdSPierre Jolivet 
719ec4f40fdSPierre Jolivet       /* B-part */
720ec4f40fdSPierre Jolivet       for (j = 0; j < countB; j++) {
721ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
722ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
723ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7249566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7259566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]] * bs + k + shift, &col[jj]));
726ec4f40fdSPierre Jolivet             }
727ec4f40fdSPierre Jolivet             val[jj++] = v2[j * bs2 + m + k * bs];
728ec4f40fdSPierre Jolivet           }
729ec4f40fdSPierre Jolivet         }
730ec4f40fdSPierre Jolivet       }
731ec4f40fdSPierre Jolivet     } else {
732397b6df1SKris Buschelman       /* A-part */
733397b6df1SKris Buschelman       for (j = 0; j < countA; j++) {
734bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7359566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7369566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
737397b6df1SKris Buschelman         }
73816ebf90aSShri Abhyankar         val[jj++] = v1[j];
739397b6df1SKris Buschelman       }
74016ebf90aSShri Abhyankar 
74116ebf90aSShri Abhyankar       /* B-part */
74216ebf90aSShri Abhyankar       for (j = 0; j < countB; j++) {
743bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7449566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7459566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
746397b6df1SKris Buschelman         }
74716ebf90aSShri Abhyankar         val[jj++] = v2[j];
74816ebf90aSShri Abhyankar       }
74916ebf90aSShri Abhyankar     }
750ec4f40fdSPierre Jolivet     irow += bs;
751ec4f40fdSPierre Jolivet   }
7525d955bbbSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = jj;
7533ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
75416ebf90aSShri Abhyankar }
75516ebf90aSShri Abhyankar 
75666976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
757d71ae5a4SJacob Faibussowitsch {
75816ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
7596497c311SBarry Smith   PetscCount         rstart, cstart, nz, i, j, jj, irow, countA, countB;
760a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
76116ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
76216ebf90aSShri Abhyankar   PetscScalar       *val;
763a3d589ffSStefano Zampini   Mat                Ad, Ao;
764a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
765a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
76616ebf90aSShri Abhyankar 
76716ebf90aSShri Abhyankar   PetscFunctionBegin;
7689566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
7699566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
7709566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
771a3d589ffSStefano Zampini 
77257508eceSPierre Jolivet   aa = (Mat_SeqAIJ *)Ad->data;
77357508eceSPierre Jolivet   bb = (Mat_SeqAIJ *)Ao->data;
77438548759SBarry Smith   ai = aa->i;
77538548759SBarry Smith   aj = aa->j;
77638548759SBarry Smith   bi = bb->i;
77738548759SBarry Smith   bj = bb->j;
77816ebf90aSShri Abhyankar 
779a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7805d955bbbSStefano Zampini   cstart = A->cmap->rstart;
7812205254eSKarl Rupp 
782bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
7836497c311SBarry Smith     nz = (PetscCount)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7849566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
7859566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
786a6053eceSJunchao Zhang     mumps->nnz = nz;
787a6053eceSJunchao Zhang     mumps->irn = row;
788a6053eceSJunchao Zhang     mumps->jcn = col;
789a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
79016ebf90aSShri Abhyankar   } else {
791a6053eceSJunchao Zhang     val = mumps->val;
79216ebf90aSShri Abhyankar   }
79316ebf90aSShri Abhyankar 
7949371c9d4SSatish Balay   jj   = 0;
7959371c9d4SSatish Balay   irow = rstart;
79616ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
79716ebf90aSShri Abhyankar     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
79816ebf90aSShri Abhyankar     countA = ai[i + 1] - ai[i];
79916ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
80016ebf90aSShri Abhyankar     bjj    = bj + bi[i];
80116ebf90aSShri Abhyankar     v1     = av + ai[i];
80216ebf90aSShri Abhyankar     v2     = bv + bi[i];
80316ebf90aSShri Abhyankar 
80416ebf90aSShri Abhyankar     /* A-part */
80516ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
806bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8079566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8085d955bbbSStefano Zampini         PetscCall(PetscMUMPSIntCast(cstart + ajj[j] + shift, &col[jj]));
80916ebf90aSShri Abhyankar       }
81016ebf90aSShri Abhyankar       val[jj++] = v1[j];
81116ebf90aSShri Abhyankar     }
81216ebf90aSShri Abhyankar 
81316ebf90aSShri Abhyankar     /* B-part */
81416ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
815bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8169566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8179566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
81816ebf90aSShri Abhyankar       }
81916ebf90aSShri Abhyankar       val[jj++] = v2[j];
82016ebf90aSShri Abhyankar     }
82116ebf90aSShri Abhyankar     irow++;
82216ebf90aSShri Abhyankar   }
8239566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
8249566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
8253ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82616ebf90aSShri Abhyankar }
82716ebf90aSShri Abhyankar 
82866976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
829d71ae5a4SJacob Faibussowitsch {
83067877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat = (Mat_MPIBAIJ *)A->data;
831f4f49eeaSPierre Jolivet   Mat_SeqBAIJ       *aa  = (Mat_SeqBAIJ *)mat->A->data;
832f4f49eeaSPierre Jolivet   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)mat->B->data;
83367877ebaSShri Abhyankar   const PetscInt    *ai = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j, *ajj, *bjj;
8345d955bbbSStefano Zampini   const PetscInt    *garray = mat->garray, mbs = mat->mbs, rstart = A->rmap->rstart, cstart = A->cmap->rstart;
83533d57670SJed Brown   const PetscInt     bs2 = mat->bs2;
836a6053eceSJunchao Zhang   PetscInt           bs;
8376497c311SBarry Smith   PetscCount         nz, i, j, k, n, jj, irow, countA, countB, idx;
838a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
83967877ebaSShri Abhyankar   const PetscScalar *av = aa->a, *bv = bb->a, *v1, *v2;
84067877ebaSShri Abhyankar   PetscScalar       *val;
84167877ebaSShri Abhyankar 
84267877ebaSShri Abhyankar   PetscFunctionBegin;
8439566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
844bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
84567877ebaSShri Abhyankar     nz = bs2 * (aa->nz + bb->nz);
8469566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
8479566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
848a6053eceSJunchao Zhang     mumps->nnz = nz;
849a6053eceSJunchao Zhang     mumps->irn = row;
850a6053eceSJunchao Zhang     mumps->jcn = col;
851a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
85267877ebaSShri Abhyankar   } else {
853a6053eceSJunchao Zhang     val = mumps->val;
85467877ebaSShri Abhyankar   }
85567877ebaSShri Abhyankar 
8569371c9d4SSatish Balay   jj   = 0;
8579371c9d4SSatish Balay   irow = rstart;
85867877ebaSShri Abhyankar   for (i = 0; i < mbs; i++) {
85967877ebaSShri Abhyankar     countA = ai[i + 1] - ai[i];
86067877ebaSShri Abhyankar     countB = bi[i + 1] - bi[i];
86167877ebaSShri Abhyankar     ajj    = aj + ai[i];
86267877ebaSShri Abhyankar     bjj    = bj + bi[i];
86367877ebaSShri Abhyankar     v1     = av + bs2 * ai[i];
86467877ebaSShri Abhyankar     v2     = bv + bs2 * bi[i];
86567877ebaSShri Abhyankar 
86667877ebaSShri Abhyankar     idx = 0;
86767877ebaSShri Abhyankar     /* A-part */
86867877ebaSShri Abhyankar     for (k = 0; k < countA; k++) {
86967877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
87067877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
871bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8729566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8735d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(cstart + bs * ajj[k] + j + shift, &col[jj]));
87467877ebaSShri Abhyankar           }
87567877ebaSShri Abhyankar           val[jj++] = v1[idx++];
87667877ebaSShri Abhyankar         }
87767877ebaSShri Abhyankar       }
87867877ebaSShri Abhyankar     }
87967877ebaSShri Abhyankar 
88067877ebaSShri Abhyankar     idx = 0;
88167877ebaSShri Abhyankar     /* B-part */
88267877ebaSShri Abhyankar     for (k = 0; k < countB; k++) {
88367877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
88467877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
885bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8869566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8879566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * garray[bjj[k]] + j + shift, &col[jj]));
88867877ebaSShri Abhyankar           }
889d985c460SShri Abhyankar           val[jj++] = v2[idx++];
89067877ebaSShri Abhyankar         }
89167877ebaSShri Abhyankar       }
89267877ebaSShri Abhyankar     }
893d985c460SShri Abhyankar     irow += bs;
89467877ebaSShri Abhyankar   }
8953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
89667877ebaSShri Abhyankar }
89767877ebaSShri Abhyankar 
89866976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
899d71ae5a4SJacob Faibussowitsch {
90016ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *adiag, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
9016497c311SBarry Smith   PetscCount         rstart, nz, nza, nzb, i, j, jj, irow, countA, countB;
902a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
90316ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
90416ebf90aSShri Abhyankar   PetscScalar       *val;
905a3d589ffSStefano Zampini   Mat                Ad, Ao;
906a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
907a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
90838548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
909b94d7dedSBarry Smith   PetscBool hermitian, isset;
91038548759SBarry Smith #endif
91116ebf90aSShri Abhyankar 
91216ebf90aSShri Abhyankar   PetscFunctionBegin;
91338548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
914b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
915b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
91638548759SBarry Smith #endif
9179566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
9189566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
9199566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
920a3d589ffSStefano Zampini 
92157508eceSPierre Jolivet   aa    = (Mat_SeqAIJ *)Ad->data;
92257508eceSPierre Jolivet   bb    = (Mat_SeqAIJ *)Ao->data;
92338548759SBarry Smith   ai    = aa->i;
92438548759SBarry Smith   aj    = aa->j;
92538548759SBarry Smith   adiag = aa->diag;
92638548759SBarry Smith   bi    = bb->i;
92738548759SBarry Smith   bj    = bb->j;
9282205254eSKarl Rupp 
92916ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
93016ebf90aSShri Abhyankar 
931bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
932e0bace9bSHong Zhang     nza = 0; /* num of upper triangular entries in mat->A, including diagonals */
933e0bace9bSHong Zhang     nzb = 0; /* num of upper triangular entries in mat->B */
93416ebf90aSShri Abhyankar     for (i = 0; i < m; i++) {
935e0bace9bSHong Zhang       nza += (ai[i + 1] - adiag[i]);
93616ebf90aSShri Abhyankar       countB = bi[i + 1] - bi[i];
93716ebf90aSShri Abhyankar       bjj    = bj + bi[i];
938e0bace9bSHong Zhang       for (j = 0; j < countB; j++) {
939e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
940e0bace9bSHong Zhang       }
941e0bace9bSHong Zhang     }
94216ebf90aSShri Abhyankar 
943e0bace9bSHong Zhang     nz = nza + nzb; /* total nz of upper triangular part of mat */
9449566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
9459566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
946a6053eceSJunchao Zhang     mumps->nnz = nz;
947a6053eceSJunchao Zhang     mumps->irn = row;
948a6053eceSJunchao Zhang     mumps->jcn = col;
949a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
95016ebf90aSShri Abhyankar   } else {
951a6053eceSJunchao Zhang     val = mumps->val;
95216ebf90aSShri Abhyankar   }
95316ebf90aSShri Abhyankar 
9549371c9d4SSatish Balay   jj   = 0;
9559371c9d4SSatish Balay   irow = rstart;
95616ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
95716ebf90aSShri Abhyankar     ajj    = aj + adiag[i]; /* ptr to the beginning of the diagonal of this row */
95816ebf90aSShri Abhyankar     v1     = av + adiag[i];
95916ebf90aSShri Abhyankar     countA = ai[i + 1] - adiag[i];
96016ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
96116ebf90aSShri Abhyankar     bjj    = bj + bi[i];
96216ebf90aSShri Abhyankar     v2     = bv + bi[i];
96316ebf90aSShri Abhyankar 
96416ebf90aSShri Abhyankar     /* A-part */
96516ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
966bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9679566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9689566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
96916ebf90aSShri Abhyankar       }
97016ebf90aSShri Abhyankar       val[jj++] = v1[j];
97116ebf90aSShri Abhyankar     }
97216ebf90aSShri Abhyankar 
97316ebf90aSShri Abhyankar     /* B-part */
97416ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
97516ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
976bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9779566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9789566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
97916ebf90aSShri Abhyankar         }
98016ebf90aSShri Abhyankar         val[jj++] = v2[j];
98116ebf90aSShri Abhyankar       }
982397b6df1SKris Buschelman     }
983397b6df1SKris Buschelman     irow++;
984397b6df1SKris Buschelman   }
9859566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
9869566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
9873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
988397b6df1SKris Buschelman }
989397b6df1SKris Buschelman 
990d2a308c1SPierre Jolivet static PetscErrorCode MatConvertToTriples_diagonal_xaij(Mat A, PETSC_UNUSED PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
991c3e1b152SPierre Jolivet {
992c3e1b152SPierre Jolivet   const PetscScalar *av;
993c3e1b152SPierre Jolivet   const PetscInt     M = A->rmap->n;
9946497c311SBarry Smith   PetscCount         i;
995c3e1b152SPierre Jolivet   PetscMUMPSInt     *row, *col;
996c3e1b152SPierre Jolivet   Vec                v;
997c3e1b152SPierre Jolivet 
998c3e1b152SPierre Jolivet   PetscFunctionBegin;
999c3e1b152SPierre Jolivet   PetscCall(MatDiagonalGetDiagonal(A, &v));
1000c3e1b152SPierre Jolivet   PetscCall(VecGetArrayRead(v, &av));
1001c3e1b152SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
1002c3e1b152SPierre Jolivet     PetscCall(PetscMalloc2(M, &row, M, &col));
1003c3e1b152SPierre Jolivet     for (i = 0; i < M; i++) {
1004c3e1b152SPierre Jolivet       PetscCall(PetscMUMPSIntCast(i + A->rmap->rstart, &row[i]));
1005c3e1b152SPierre Jolivet       col[i] = row[i];
1006c3e1b152SPierre Jolivet     }
1007c3e1b152SPierre Jolivet     mumps->val = (PetscScalar *)av;
1008c3e1b152SPierre Jolivet     mumps->irn = row;
1009c3e1b152SPierre Jolivet     mumps->jcn = col;
1010c3e1b152SPierre Jolivet     mumps->nnz = M;
1011127cd276SPierre Jolivet   } else if (mumps->nest_vals) PetscCall(PetscArraycpy(mumps->val, av, M)); /* MatConvertToTriples_nest_xaij() allocates mumps->val outside of MatConvertToTriples_diagonal_xaij(), so one needs to copy the memory */
1012127cd276SPierre Jolivet   else mumps->val = (PetscScalar *)av;                                      /* in the default case, mumps->val is never allocated, one just needs to update the mumps->val pointer */
1013c3e1b152SPierre Jolivet   PetscCall(VecRestoreArrayRead(v, &av));
1014c3e1b152SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1015c3e1b152SPierre Jolivet }
1016c3e1b152SPierre Jolivet 
1017d2a308c1SPierre Jolivet static PetscErrorCode MatConvertToTriples_dense_xaij(Mat A, PETSC_UNUSED PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
10184b9405b2SPierre Jolivet {
10194b9405b2SPierre Jolivet   PetscScalar   *v;
10204b9405b2SPierre Jolivet   const PetscInt m = A->rmap->n, N = A->cmap->N;
10214b9405b2SPierre Jolivet   PetscInt       lda;
10226497c311SBarry Smith   PetscCount     i, j;
10234b9405b2SPierre Jolivet   PetscMUMPSInt *row, *col;
10244b9405b2SPierre Jolivet 
10254b9405b2SPierre Jolivet   PetscFunctionBegin;
10264b9405b2SPierre Jolivet   PetscCall(MatDenseGetArray(A, &v));
10274b9405b2SPierre Jolivet   PetscCall(MatDenseGetLDA(A, &lda));
10284b9405b2SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
10294b9405b2SPierre Jolivet     PetscCall(PetscMalloc2(m * N, &row, m * N, &col));
10304b9405b2SPierre Jolivet     for (i = 0; i < m; i++) {
10314b9405b2SPierre Jolivet       col[i] = 0;
10324b9405b2SPierre Jolivet       PetscCall(PetscMUMPSIntCast(i + A->rmap->rstart, &row[i]));
10334b9405b2SPierre Jolivet     }
10344b9405b2SPierre Jolivet     for (j = 1; j < N; j++) {
10354b9405b2SPierre Jolivet       for (i = 0; i < m; i++) PetscCall(PetscMUMPSIntCast(j, col + i + m * j));
10364b9405b2SPierre Jolivet       PetscCall(PetscArraycpy(row + m * j, row + m * (j - 1), m));
10374b9405b2SPierre Jolivet     }
10384b9405b2SPierre Jolivet     if (lda == m) mumps->val = v;
10394b9405b2SPierre Jolivet     else {
10404b9405b2SPierre Jolivet       PetscCall(PetscMalloc1(m * N, &mumps->val));
10414b9405b2SPierre Jolivet       mumps->val_alloc = mumps->val;
10424b9405b2SPierre Jolivet       for (j = 0; j < N; j++) PetscCall(PetscArraycpy(mumps->val + m * j, v + lda * j, m));
10434b9405b2SPierre Jolivet     }
10444b9405b2SPierre Jolivet     mumps->irn = row;
10454b9405b2SPierre Jolivet     mumps->jcn = col;
10464b9405b2SPierre Jolivet     mumps->nnz = m * N;
10474b9405b2SPierre Jolivet   } else {
10484b9405b2SPierre Jolivet     if (lda == m && !mumps->nest_vals) mumps->val = v;
10494b9405b2SPierre Jolivet     else {
10504b9405b2SPierre Jolivet       for (j = 0; j < N; j++) PetscCall(PetscArraycpy(mumps->val + m * j, v + lda * j, m));
10514b9405b2SPierre Jolivet     }
10524b9405b2SPierre Jolivet   }
10534b9405b2SPierre Jolivet   PetscCall(MatDenseRestoreArray(A, &v));
10544b9405b2SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
10554b9405b2SPierre Jolivet }
10564b9405b2SPierre Jolivet 
105753587d93SPierre Jolivet // If the input Mat (sub) is either MATTRANSPOSEVIRTUAL or MATHERMITIANTRANSPOSEVIRTUAL, this function gets the parent Mat until it is not a
105853587d93SPierre Jolivet // MATTRANSPOSEVIRTUAL or MATHERMITIANTRANSPOSEVIRTUAL itself and returns the appropriate shift, scaling, and whether the parent Mat should be conjugated
105953587d93SPierre Jolivet // and its rows and columns permuted
106053587d93SPierre Jolivet // TODO FIXME: this should not be in this file and should instead be refactored where the same logic applies, e.g., MatAXPY_Dense_Nest()
106153587d93SPierre Jolivet static PetscErrorCode MatGetTranspose_TransposeVirtual(Mat *sub, PetscBool *conjugate, PetscScalar *vshift, PetscScalar *vscale, PetscBool *swap)
106253587d93SPierre Jolivet {
106353587d93SPierre Jolivet   Mat         A;
106453587d93SPierre Jolivet   PetscScalar s[2];
106553587d93SPierre Jolivet   PetscBool   isTrans, isHTrans, compare;
106653587d93SPierre Jolivet 
106753587d93SPierre Jolivet   PetscFunctionBegin;
106853587d93SPierre Jolivet   do {
106953587d93SPierre Jolivet     PetscCall(PetscObjectTypeCompare((PetscObject)*sub, MATTRANSPOSEVIRTUAL, &isTrans));
107053587d93SPierre Jolivet     if (isTrans) {
107153587d93SPierre Jolivet       PetscCall(MatTransposeGetMat(*sub, &A));
107253587d93SPierre Jolivet       isHTrans = PETSC_FALSE;
107353587d93SPierre Jolivet     } else {
107453587d93SPierre Jolivet       PetscCall(PetscObjectTypeCompare((PetscObject)*sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
107553587d93SPierre Jolivet       if (isHTrans) PetscCall(MatHermitianTransposeGetMat(*sub, &A));
107653587d93SPierre Jolivet     }
107753587d93SPierre Jolivet     compare = (PetscBool)(isTrans || isHTrans);
107853587d93SPierre Jolivet     if (compare) {
107953587d93SPierre Jolivet       if (vshift && vscale) {
108053587d93SPierre Jolivet         PetscCall(MatShellGetScalingShifts(*sub, s, s + 1, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
108153587d93SPierre Jolivet         if (!*conjugate) {
108253587d93SPierre Jolivet           *vshift += s[0] * *vscale;
108353587d93SPierre Jolivet           *vscale *= s[1];
108453587d93SPierre Jolivet         } else {
108553587d93SPierre Jolivet           *vshift += PetscConj(s[0]) * *vscale;
108653587d93SPierre Jolivet           *vscale *= PetscConj(s[1]);
108753587d93SPierre Jolivet         }
108853587d93SPierre Jolivet       }
108953587d93SPierre Jolivet       if (swap) *swap = (PetscBool)!*swap;
109053587d93SPierre Jolivet       if (isHTrans && conjugate) *conjugate = (PetscBool)!*conjugate;
109153587d93SPierre Jolivet       *sub = A;
109253587d93SPierre Jolivet     }
109353587d93SPierre Jolivet   } while (compare);
109453587d93SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
109553587d93SPierre Jolivet }
109653587d93SPierre Jolivet 
109766976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_nest_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
10989d0448ceSStefano Zampini {
10999d0448ceSStefano Zampini   Mat     **mats;
11009d0448ceSStefano Zampini   PetscInt  nr, nc;
11019d0448ceSStefano Zampini   PetscBool chol = mumps->sym ? PETSC_TRUE : PETSC_FALSE;
11029d0448ceSStefano Zampini 
11039d0448ceSStefano Zampini   PetscFunctionBegin;
11049d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
11059d0448ceSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
11069d0448ceSStefano Zampini     PetscMUMPSInt *irns, *jcns;
11079d0448ceSStefano Zampini     PetscScalar   *vals;
11086497c311SBarry Smith     PetscCount     totnnz, cumnnz, maxnnz;
110993d70b8aSPierre Jolivet     PetscInt      *pjcns_w, Mbs = 0;
11109d0448ceSStefano Zampini     IS            *rows, *cols;
11119d0448ceSStefano Zampini     PetscInt     **rows_idx, **cols_idx;
11129d0448ceSStefano Zampini 
11139d0448ceSStefano Zampini     cumnnz = 0;
11149d0448ceSStefano Zampini     maxnnz = 0;
11155d955bbbSStefano Zampini     PetscCall(PetscMalloc2(nr * nc + 1, &mumps->nest_vals_start, nr * nc, &mumps->nest_convert_to_triples));
11169d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11179d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11189d0448ceSStefano Zampini         Mat sub = mats[r][c];
11199d0448ceSStefano Zampini 
11209d0448ceSStefano Zampini         mumps->nest_convert_to_triples[r * nc + c] = NULL;
11219d0448ceSStefano Zampini         if (chol && c < r) continue; /* skip lower-triangular block for Cholesky */
11229d0448ceSStefano Zampini         if (sub) {
11239d0448ceSStefano Zampini           PetscErrorCode (*convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *) = NULL;
112453587d93SPierre Jolivet           PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isDiag, isDense;
11259d0448ceSStefano Zampini           MatInfo   info;
11269d0448ceSStefano Zampini 
112753587d93SPierre Jolivet           PetscCall(MatGetTranspose_TransposeVirtual(&sub, NULL, NULL, NULL, NULL));
11289d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
11299d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
11309d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
11319d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
11329d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
11339d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
1134c3e1b152SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATDIAGONAL, &isDiag));
11354b9405b2SPierre Jolivet           PetscCall(PetscObjectTypeCompareAny((PetscObject)sub, &isDense, MATSEQDENSE, MATMPIDENSE, NULL));
11369d0448ceSStefano Zampini 
11379d0448ceSStefano Zampini           if (chol) {
11389d0448ceSStefano Zampini             if (r == c) {
11399d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqsbaij;
11409d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpisbaij;
11419d0448ceSStefano Zampini               else if (isSeqSBAIJ) convert_to_triples = MatConvertToTriples_seqsbaij_seqsbaij;
11429d0448ceSStefano Zampini               else if (isMPISBAIJ) convert_to_triples = MatConvertToTriples_mpisbaij_mpisbaij;
1143c3e1b152SPierre Jolivet               else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
11444b9405b2SPierre Jolivet               else if (isDense) convert_to_triples = MatConvertToTriples_dense_xaij;
11459d0448ceSStefano Zampini             } else {
11469d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
11479d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
11489d0448ceSStefano Zampini               else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
11499d0448ceSStefano Zampini               else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
1150c3e1b152SPierre Jolivet               else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
11514b9405b2SPierre Jolivet               else if (isDense) convert_to_triples = MatConvertToTriples_dense_xaij;
11529d0448ceSStefano Zampini             }
11539d0448ceSStefano Zampini           } else {
11549d0448ceSStefano Zampini             if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
11559d0448ceSStefano Zampini             else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
11569d0448ceSStefano Zampini             else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
11579d0448ceSStefano Zampini             else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
1158c3e1b152SPierre Jolivet             else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
11594b9405b2SPierre Jolivet             else if (isDense) convert_to_triples = MatConvertToTriples_dense_xaij;
11609d0448ceSStefano Zampini           }
11619d0448ceSStefano Zampini           PetscCheck(convert_to_triples, PetscObjectComm((PetscObject)sub), PETSC_ERR_SUP, "Not for block of type %s", ((PetscObject)sub)->type_name);
11629d0448ceSStefano Zampini           mumps->nest_convert_to_triples[r * nc + c] = convert_to_triples;
11639d0448ceSStefano Zampini           PetscCall(MatGetInfo(sub, MAT_LOCAL, &info));
11646497c311SBarry Smith           cumnnz += (PetscCount)info.nz_used; /* can be overestimated for Cholesky */
11659d0448ceSStefano Zampini           maxnnz = PetscMax(maxnnz, info.nz_used);
11669d0448ceSStefano Zampini         }
11679d0448ceSStefano Zampini       }
11689d0448ceSStefano Zampini     }
11699d0448ceSStefano Zampini 
11709d0448ceSStefano Zampini     /* Allocate total COO */
11719d0448ceSStefano Zampini     totnnz = cumnnz;
11729d0448ceSStefano Zampini     PetscCall(PetscMalloc2(totnnz, &irns, totnnz, &jcns));
11739d0448ceSStefano Zampini     PetscCall(PetscMalloc1(totnnz, &vals));
11749d0448ceSStefano Zampini 
11759d0448ceSStefano Zampini     /* Handle rows and column maps
11769d0448ceSStefano Zampini        We directly map rows and use an SF for the columns */
11779d0448ceSStefano Zampini     PetscCall(PetscMalloc4(nr, &rows, nc, &cols, nr, &rows_idx, nc, &cols_idx));
11789d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
11799d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetIndices(rows[r], (const PetscInt **)&rows_idx[r]));
11809d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISGetIndices(cols[c], (const PetscInt **)&cols_idx[c]));
11819d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscMalloc1(maxnnz, &pjcns_w));
11825d955bbbSStefano Zampini     else (void)maxnnz;
11839d0448ceSStefano Zampini 
11849d0448ceSStefano Zampini     cumnnz = 0;
11859d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11869d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11879d0448ceSStefano Zampini         Mat             sub    = mats[r][c];
11889d0448ceSStefano Zampini         const PetscInt *ridx   = rows_idx[r];
11895d955bbbSStefano Zampini         const PetscInt *cidx   = cols_idx[c];
119053587d93SPierre Jolivet         PetscScalar     vscale = 1.0, vshift = 0.0;
119193d70b8aSPierre Jolivet         PetscInt        rst, size, bs;
11929d0448ceSStefano Zampini         PetscSF         csf;
119353587d93SPierre Jolivet         PetscBool       conjugate = PETSC_FALSE, swap = PETSC_FALSE;
11945d955bbbSStefano Zampini         PetscLayout     cmap;
11956497c311SBarry Smith         PetscInt        innz;
11969d0448ceSStefano Zampini 
11979d0448ceSStefano Zampini         mumps->nest_vals_start[r * nc + c] = cumnnz;
119893d70b8aSPierre Jolivet         if (c == r) {
119993d70b8aSPierre Jolivet           PetscCall(ISGetSize(rows[r], &size));
120093d70b8aSPierre Jolivet           if (!mumps->nest_convert_to_triples[r * nc + c]) {
120193d70b8aSPierre Jolivet             for (PetscInt c = 0; c < nc && !sub; ++c) sub = mats[r][c]; // diagonal Mat is NULL, so start over from the beginning of the current row
120293d70b8aSPierre Jolivet           }
120393d70b8aSPierre Jolivet           PetscCall(MatGetBlockSize(sub, &bs));
120493d70b8aSPierre Jolivet           Mbs += size / bs;
120593d70b8aSPierre Jolivet         }
12069d0448ceSStefano Zampini         if (!mumps->nest_convert_to_triples[r * nc + c]) continue;
12079d0448ceSStefano Zampini 
12085d955bbbSStefano Zampini         /* Extract inner blocks if needed */
120953587d93SPierre Jolivet         PetscCall(MatGetTranspose_TransposeVirtual(&sub, &conjugate, &vshift, &vscale, &swap));
121053587d93SPierre Jolivet         PetscCheck(vshift == 0.0, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Nonzero shift in parent MatShell");
12115d955bbbSStefano Zampini 
12125d955bbbSStefano Zampini         /* Get column layout to map off-process columns */
12135d955bbbSStefano Zampini         PetscCall(MatGetLayouts(sub, NULL, &cmap));
12145d955bbbSStefano Zampini 
12155d955bbbSStefano Zampini         /* Get row start to map on-process rows */
12165d955bbbSStefano Zampini         PetscCall(MatGetOwnershipRange(sub, &rst, NULL));
12175d955bbbSStefano Zampini 
12189d0448ceSStefano Zampini         /* Directly use the mumps datastructure and use C ordering for now */
12199d0448ceSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[r * nc + c])(sub, 0, MAT_INITIAL_MATRIX, mumps));
12209d0448ceSStefano Zampini 
12215d955bbbSStefano Zampini         /* Swap the role of rows and columns indices for transposed blocks
12225d955bbbSStefano Zampini            since we need values with global final ordering */
12235d955bbbSStefano Zampini         if (swap) {
12245d955bbbSStefano Zampini           cidx = rows_idx[r];
12255d955bbbSStefano Zampini           ridx = cols_idx[c];
12269d0448ceSStefano Zampini         }
12279d0448ceSStefano Zampini 
12285d955bbbSStefano Zampini         /* Communicate column indices
12295d955bbbSStefano Zampini            This could have been done with a single SF but it would have complicated the code a lot.
12305d955bbbSStefano Zampini            But since we do it only once, we pay the price of setting up an SF for each block */
12315d955bbbSStefano Zampini         if (PetscDefined(USE_64BIT_INDICES)) {
12325d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) pjcns_w[k] = mumps->jcn[k];
1233f4f49eeaSPierre Jolivet         } else pjcns_w = (PetscInt *)mumps->jcn; /* This cast is needed only to silence warnings for 64bit integers builds */
12349d0448ceSStefano Zampini         PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)A), &csf));
12356497c311SBarry Smith         PetscCall(PetscIntCast(mumps->nnz, &innz));
12366497c311SBarry Smith         PetscCall(PetscSFSetGraphLayout(csf, cmap, innz, NULL, PETSC_OWN_POINTER, pjcns_w));
12375d955bbbSStefano Zampini         PetscCall(PetscSFBcastBegin(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
12385d955bbbSStefano Zampini         PetscCall(PetscSFBcastEnd(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
12399d0448ceSStefano Zampini         PetscCall(PetscSFDestroy(&csf));
12409d0448ceSStefano Zampini 
12415d955bbbSStefano Zampini         /* Import indices: use direct map for rows and mapped indices for columns */
12425d955bbbSStefano Zampini         if (swap) {
12435d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
12445d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &jcns[cumnnz + k]));
12455d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &irns[cumnnz + k]));
12465d955bbbSStefano Zampini           }
12475d955bbbSStefano Zampini         } else {
12485d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
12495d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &irns[cumnnz + k]));
12505d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &jcns[cumnnz + k]));
12515d955bbbSStefano Zampini           }
12525d955bbbSStefano Zampini         }
12535d955bbbSStefano Zampini 
12545d955bbbSStefano Zampini         /* Import values to full COO */
125553587d93SPierre Jolivet         if (conjugate) { /* conjugate the entries */
125650c845baSStefano Zampini           PetscScalar *v = vals + cumnnz;
125753587d93SPierre Jolivet           for (PetscInt k = 0; k < mumps->nnz; k++) v[k] = vscale * PetscConj(mumps->val[k]);
125853587d93SPierre Jolivet         } else if (vscale != 1.0) {
125953587d93SPierre Jolivet           PetscScalar *v = vals + cumnnz;
126053587d93SPierre Jolivet           for (PetscInt k = 0; k < mumps->nnz; k++) v[k] = vscale * mumps->val[k];
126153587d93SPierre Jolivet         } else PetscCall(PetscArraycpy(vals + cumnnz, mumps->val, mumps->nnz));
12629d0448ceSStefano Zampini 
12639d0448ceSStefano Zampini         /* Shift new starting point and sanity check */
12649d0448ceSStefano Zampini         cumnnz += mumps->nnz;
12656497c311SBarry Smith         PetscCheck(cumnnz <= totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Unexpected number of nonzeros %" PetscCount_FMT " != %" PetscCount_FMT, cumnnz, totnnz);
12669d0448ceSStefano Zampini 
12679d0448ceSStefano Zampini         /* Free scratch memory */
12689d0448ceSStefano Zampini         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
12699d0448ceSStefano Zampini         PetscCall(PetscFree(mumps->val_alloc));
12709d0448ceSStefano Zampini         mumps->val = NULL;
12719d0448ceSStefano Zampini         mumps->nnz = 0;
12729d0448ceSStefano Zampini       }
12739d0448ceSStefano Zampini     }
127493d70b8aSPierre Jolivet     if (mumps->id.ICNTL(15) == 1) {
127593d70b8aSPierre Jolivet       if (Mbs != A->rmap->N) {
127693d70b8aSPierre Jolivet         PetscMPIInt rank, size;
127793d70b8aSPierre Jolivet 
127893d70b8aSPierre Jolivet         PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)A), &rank));
127993d70b8aSPierre Jolivet         PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
128093d70b8aSPierre Jolivet         if (rank == 0) {
128193d70b8aSPierre Jolivet           PetscInt shift = 0;
128293d70b8aSPierre Jolivet 
128393d70b8aSPierre Jolivet           PetscCall(PetscMUMPSIntCast(Mbs, &mumps->id.nblk));
128493d70b8aSPierre Jolivet           PetscCall(PetscFree(mumps->id.blkptr));
128593d70b8aSPierre Jolivet           PetscCall(PetscMalloc1(Mbs + 1, &mumps->id.blkptr));
128693d70b8aSPierre Jolivet           mumps->id.blkptr[0] = 1;
128793d70b8aSPierre Jolivet           for (PetscInt i = 0; i < size; ++i) {
128893d70b8aSPierre Jolivet             for (PetscInt r = 0; r < nr; r++) {
128993d70b8aSPierre Jolivet               Mat             sub = mats[r][r];
129093d70b8aSPierre Jolivet               const PetscInt *ranges;
129193d70b8aSPierre Jolivet               PetscInt        bs;
129293d70b8aSPierre Jolivet 
129393d70b8aSPierre Jolivet               for (PetscInt c = 0; c < nc && !sub; ++c) sub = mats[r][c]; // diagonal Mat is NULL, so start over from the beginning of the current row
129493d70b8aSPierre Jolivet               PetscCall(MatGetOwnershipRanges(sub, &ranges));
129593d70b8aSPierre Jolivet               PetscCall(MatGetBlockSize(sub, &bs));
129693d70b8aSPierre Jolivet               for (PetscInt j = 0, start = mumps->id.blkptr[shift] + bs; j < ranges[i + 1] - ranges[i]; j += bs) PetscCall(PetscMUMPSIntCast(start + j, mumps->id.blkptr + shift + j / bs + 1));
129793d70b8aSPierre Jolivet               shift += (ranges[i + 1] - ranges[i]) / bs;
129893d70b8aSPierre Jolivet             }
129993d70b8aSPierre Jolivet           }
130093d70b8aSPierre Jolivet         }
130193d70b8aSPierre Jolivet       } else mumps->id.ICNTL(15) = 0;
130293d70b8aSPierre Jolivet     }
13039d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscFree(pjcns_w));
13049d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISRestoreIndices(rows[r], (const PetscInt **)&rows_idx[r]));
13059d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISRestoreIndices(cols[c], (const PetscInt **)&cols_idx[c]));
13069d0448ceSStefano Zampini     PetscCall(PetscFree4(rows, cols, rows_idx, cols_idx));
13076497c311SBarry Smith     if (!chol) PetscCheck(cumnnz == totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different number of nonzeros %" PetscCount_FMT " != %" PetscCount_FMT, cumnnz, totnnz);
13085d955bbbSStefano Zampini     mumps->nest_vals_start[nr * nc] = cumnnz;
13099d0448ceSStefano Zampini 
13109d0448ceSStefano Zampini     /* Set pointers for final MUMPS data structure */
13119d0448ceSStefano Zampini     mumps->nest_vals = vals;
13129d0448ceSStefano Zampini     mumps->val_alloc = NULL; /* do not use val_alloc since it may be reallocated with the OMP callpath */
13139d0448ceSStefano Zampini     mumps->val       = vals;
13149d0448ceSStefano Zampini     mumps->irn       = irns;
13159d0448ceSStefano Zampini     mumps->jcn       = jcns;
13169d0448ceSStefano Zampini     mumps->nnz       = cumnnz;
13179d0448ceSStefano Zampini   } else {
13189d0448ceSStefano Zampini     PetscScalar *oval = mumps->nest_vals;
13199d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
13209d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
132153587d93SPierre Jolivet         PetscBool   conjugate = PETSC_FALSE;
13225d955bbbSStefano Zampini         Mat         sub       = mats[r][c];
132353587d93SPierre Jolivet         PetscScalar vscale = 1.0, vshift = 0.0;
13245d955bbbSStefano Zampini         PetscInt    midx = r * nc + c;
13255d955bbbSStefano Zampini 
13265d955bbbSStefano Zampini         if (!mumps->nest_convert_to_triples[midx]) continue;
132753587d93SPierre Jolivet         PetscCall(MatGetTranspose_TransposeVirtual(&sub, &conjugate, &vshift, &vscale, NULL));
132853587d93SPierre Jolivet         PetscCheck(vshift == 0.0, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Nonzero shift in parent MatShell");
13295d955bbbSStefano Zampini         mumps->val = oval + mumps->nest_vals_start[midx];
13305d955bbbSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[midx])(sub, shift, MAT_REUSE_MATRIX, mumps));
133153587d93SPierre Jolivet         if (conjugate) {
13326497c311SBarry Smith           PetscCount nnz = mumps->nest_vals_start[midx + 1] - mumps->nest_vals_start[midx];
133353587d93SPierre Jolivet           for (PetscCount k = 0; k < nnz; k++) mumps->val[k] = vscale * PetscConj(mumps->val[k]);
133453587d93SPierre Jolivet         } else if (vscale != 1.0) {
133553587d93SPierre Jolivet           PetscCount nnz = mumps->nest_vals_start[midx + 1] - mumps->nest_vals_start[midx];
133653587d93SPierre Jolivet           for (PetscCount k = 0; k < nnz; k++) mumps->val[k] *= vscale;
13375d955bbbSStefano Zampini         }
13389d0448ceSStefano Zampini       }
13399d0448ceSStefano Zampini     }
13409d0448ceSStefano Zampini     mumps->val = oval;
13419d0448ceSStefano Zampini   }
13429d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
13439d0448ceSStefano Zampini }
13449d0448ceSStefano Zampini 
134566976f2fSJacob Faibussowitsch static PetscErrorCode MatDestroy_MUMPS(Mat A)
1346d71ae5a4SJacob Faibussowitsch {
1347a6053eceSJunchao Zhang   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
1348b24902e0SBarry Smith 
1349397b6df1SKris Buschelman   PetscFunctionBegin;
13509566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
13519566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
13529566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
13539566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
13549566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
13559566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
135693d70b8aSPierre Jolivet   PetscCall(PetscFree(mumps->id.blkvar));
135793d70b8aSPierre Jolivet   PetscCall(PetscFree(mumps->id.blkptr));
13589566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn, mumps->jcn));
13599566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
13609566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
1361413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->ICNTL_pre));
1362413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->CNTL_pre));
13639566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
1364413bcc21SPierre Jolivet   if (mumps->id.job != JOB_NULL) { /* cannot call PetscMUMPS_c() if JOB_INIT has never been called for this instance */
1365a5e57a09SHong Zhang     mumps->id.job = JOB_END;
13663ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
13679261f6e4SBarry 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));
1368413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
1369413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) PetscCallMPI(MPI_Comm_free(&mumps->mumps_comm));
1370413bcc21SPierre Jolivet       else PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A), &mumps->mumps_comm));
1371413bcc21SPierre Jolivet     }
1372413bcc21SPierre Jolivet   }
13733ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
137467602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
13759566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
13769566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
13779566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow, mumps->rhs_recvcounts, mumps->rhs_disps));
137867602552SJunchao Zhang   }
13793ab56b82SJunchao Zhang #endif
13809566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
13819566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
13829566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
13839566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
13849566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
13859d0448ceSStefano Zampini   PetscCall(PetscFree2(mumps->nest_vals_start, mumps->nest_convert_to_triples));
13869d0448ceSStefano Zampini   PetscCall(PetscFree(mumps->nest_vals));
13879566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
1388bf0cc555SLisandro Dalcin 
138997969023SHong Zhang   /* clear composed functions */
13909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorGetSolverType_C", NULL));
13919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorSetSchurIS_C", NULL));
13929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorCreateSchurComplement_C", NULL));
13939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetIcntl_C", NULL));
13949566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetIcntl_C", NULL));
13959566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetCntl_C", NULL));
13969566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetCntl_C", NULL));
13979566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfo_C", NULL));
13989566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfog_C", NULL));
13999566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfo_C", NULL));
14009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfog_C", NULL));
14015c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetNullPivots_C", NULL));
14029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverse_C", NULL));
14039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverseTranspose_C", NULL));
140493d70b8aSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetBlk_C", NULL));
14053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1406397b6df1SKris Buschelman }
1407397b6df1SKris Buschelman 
140867602552SJunchao 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. */
1409d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A, PetscInt nrhs, const PetscScalar *array)
1410d71ae5a4SJacob Faibussowitsch {
141167602552SJunchao Zhang   Mat_MUMPS        *mumps   = (Mat_MUMPS *)A->data;
141267602552SJunchao Zhang   const PetscMPIInt ompsize = mumps->omp_comm_size;
141367602552SJunchao Zhang   PetscInt          i, m, M, rstart;
141467602552SJunchao Zhang 
141567602552SJunchao Zhang   PetscFunctionBegin;
14169566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, NULL));
14179566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, NULL));
141808401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
141967602552SJunchao Zhang   if (ompsize == 1) {
142067602552SJunchao Zhang     if (!mumps->irhs_loc) {
14216497c311SBarry Smith       mumps->nloc_rhs = (PetscMUMPSInt)m;
14229566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m, &mumps->irhs_loc));
14239566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A, &rstart, NULL));
14246497c311SBarry Smith       for (i = 0; i < m; i++) PetscCall(PetscMUMPSIntCast(rstart + i + 1, &mumps->irhs_loc[i])); /* use 1-based indices */
142567602552SJunchao Zhang     }
142667602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar *)array;
142767602552SJunchao Zhang   } else {
142867602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
142967602552SJunchao Zhang     const PetscInt *ranges;
143067602552SJunchao Zhang     PetscMPIInt     j, k, sendcount, *petsc_ranks, *omp_ranks;
143167602552SJunchao Zhang     MPI_Group       petsc_group, omp_group;
143267602552SJunchao Zhang     PetscScalar    *recvbuf = NULL;
143367602552SJunchao Zhang 
143467602552SJunchao Zhang     if (mumps->is_omp_master) {
143567602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
143667602552SJunchao Zhang       if (!mumps->irhs_loc) {
14379566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize, &omp_ranks, ompsize, &petsc_ranks));
14389566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize, &mumps->rhs_nrow, ompsize, &mumps->rhs_recvcounts, ompsize, &mumps->rhs_disps));
14399566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm, &petsc_group));
14409566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm, &omp_group));
144167602552SJunchao Zhang         for (j = 0; j < ompsize; j++) omp_ranks[j] = j;
14429566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group, ompsize, omp_ranks, petsc_group, petsc_ranks));
144367602552SJunchao Zhang 
144467602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
144567602552SJunchao Zhang         mumps->nloc_rhs = 0;
14469566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A, &ranges));
144767602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
144867602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j] + 1] - ranges[petsc_ranks[j]];
144967602552SJunchao Zhang           mumps->nloc_rhs += mumps->rhs_nrow[j];
145067602552SJunchao Zhang         }
14519566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs, &mumps->irhs_loc));
145267602552SJunchao Zhang         for (j = k = 0; j < ompsize; j++) {
145367602552SJunchao 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 */
145467602552SJunchao Zhang         }
145567602552SJunchao Zhang 
14569566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks, petsc_ranks));
14579566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
14589566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
145967602552SJunchao Zhang       }
146067602552SJunchao Zhang 
146167602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
146267602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
14639566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
14649566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs * nrhs, &mumps->rhs_loc, mumps->nloc_rhs * nrhs, &mumps->rhs_recvbuf));
146567602552SJunchao Zhang         mumps->max_nrhs = nrhs;
146667602552SJunchao Zhang       }
146767602552SJunchao Zhang 
146867602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
14699566063dSJacob Faibussowitsch       for (j = 0; j < ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j] * nrhs, &mumps->rhs_recvcounts[j]));
147067602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
147167602552SJunchao Zhang       for (j = 1; j < ompsize; j++) {
147267602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j - 1] + mumps->rhs_recvcounts[j - 1];
147308401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscMPIInt overflow!");
147467602552SJunchao Zhang       }
147567602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
147667602552SJunchao Zhang     }
147767602552SJunchao Zhang 
14789566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m * nrhs, &sendcount));
14799566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array, sendcount, MPIU_SCALAR, recvbuf, mumps->rhs_recvcounts, mumps->rhs_disps, MPIU_SCALAR, 0, mumps->omp_comm));
148067602552SJunchao Zhang 
148167602552SJunchao Zhang     if (mumps->is_omp_master) {
148267602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
148367602552SJunchao Zhang         PetscScalar *dst, *dstbase = mumps->rhs_loc;
148467602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
148567602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
148667602552SJunchao Zhang           dst                    = dstbase;
148767602552SJunchao Zhang           for (i = 0; i < nrhs; i++) {
14889566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst, src, mumps->rhs_nrow[j]));
148967602552SJunchao Zhang             src += mumps->rhs_nrow[j];
149067602552SJunchao Zhang             dst += mumps->nloc_rhs;
149167602552SJunchao Zhang           }
149267602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
149367602552SJunchao Zhang         }
149467602552SJunchao Zhang       }
149567602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar *)mumps->rhs_loc;
149667602552SJunchao Zhang     }
149767602552SJunchao Zhang #endif /* PETSC_HAVE_OPENMP_SUPPORT */
149867602552SJunchao Zhang   }
14996497c311SBarry Smith   mumps->id.nrhs     = (PetscMUMPSInt)nrhs;
15006497c311SBarry Smith   mumps->id.nloc_rhs = (PetscMUMPSInt)mumps->nloc_rhs;
150167602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
150267602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
15033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
150467602552SJunchao Zhang }
150567602552SJunchao Zhang 
150666976f2fSJacob Faibussowitsch static PetscErrorCode MatSolve_MUMPS(Mat A, Vec b, Vec x)
1507d71ae5a4SJacob Faibussowitsch {
1508e69c285eSBarry Smith   Mat_MUMPS         *mumps  = (Mat_MUMPS *)A->data;
150925aac85cSJunchao Zhang   const PetscScalar *rarray = NULL;
1510d54de34fSKris Buschelman   PetscScalar       *array;
1511329ec9b3SHong Zhang   IS                 is_iden, is_petsc;
1512329ec9b3SHong Zhang   PetscInt           i;
1513cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1514883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE, cite2 = PETSC_FALSE;
1515397b6df1SKris Buschelman 
1516397b6df1SKris Buschelman   PetscFunctionBegin;
15179371c9d4SSatish 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 "
15189371c9d4SSatish Balay                                    "Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",
15199371c9d4SSatish Balay                                    &cite1));
15209371c9d4SSatish 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 "
15219371c9d4SSatish Balay                                    "Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",
15229371c9d4SSatish Balay                                    &cite2));
15232aca8efcSHong Zhang 
1524f480ea8aSBarry Smith   PetscCall(VecFlag(x, A->factorerrortype));
1525603e8f96SBarry Smith   if (A->factorerrortype) {
15269566063dSJacob 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)));
15273ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
15282aca8efcSHong Zhang   }
15292aca8efcSHong Zhang 
1530a5e57a09SHong Zhang   mumps->id.nrhs = 1;
15312d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
153225aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
153367602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
15349566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b, &rarray));
15359566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, 1, rarray));
153625aac85cSJunchao Zhang     } else {
153741ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
15389566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
15399566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
154067602552SJunchao Zhang       if (!mumps->myid) {
15419566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq, &array));
154267602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar *)array;
154367602552SJunchao Zhang       }
154425aac85cSJunchao Zhang     }
15453ab56b82SJunchao Zhang   } else {                   /* petsc_size == 1 */
154667602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
15479566063dSJacob Faibussowitsch     PetscCall(VecCopy(b, x));
15489566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x, &array));
1549940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar *)array;
1550397b6df1SKris Buschelman   }
1551397b6df1SKris Buschelman 
1552cc86f929SStefano Zampini   /*
1553cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1554cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1555cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1556cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1557cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1558cc86f929SStefano Zampini   */
15593e5b40d0SPierre Jolivet   if (mumps->id.size_schur > 0) {
156008401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
15613e5b40d0SPierre Jolivet     if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1562cc86f929SStefano Zampini       second_solve = PETSC_TRUE;
15639566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
15643e5b40d0SPierre Jolivet       mumps->id.ICNTL(26) = 1; /* condensation phase */
15653e5b40d0SPierre Jolivet     } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1566cc86f929SStefano Zampini   }
1567397b6df1SKris Buschelman   /* solve phase */
1568a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
15693ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
15709261f6e4SBarry 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));
1571397b6df1SKris Buschelman 
1572b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
15731baa6e33SBarry Smith   if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
15743e5b40d0SPierre Jolivet   else if (mumps->id.ICNTL(26) == 1) {
15753e5b40d0SPierre Jolivet     PetscCall(MatMumpsSolveSchur_Private(A));
15763e5b40d0SPierre Jolivet     for (i = 0; i < mumps->id.size_schur; ++i) {
15773e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
15783e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i];
15793e5b40d0SPierre Jolivet #else
15803e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i].r + PETSC_i * mumps->id.redrhs[i].i;
15813e5b40d0SPierre Jolivet #endif
15823e5b40d0SPierre Jolivet       array[mumps->id.listvar_schur[i] - 1] = val;
15833e5b40d0SPierre Jolivet     }
15843e5b40d0SPierre Jolivet   }
1585b5fa320bSStefano Zampini 
1586f0b74427SPierre Jolivet   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to PETSc mpi x */
1587a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1588a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
15899566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1590397b6df1SKris Buschelman     }
1591a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1592a6053eceSJunchao Zhang       PetscInt *isol2_loc = NULL;
15939566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, mumps->id.lsol_loc, 0, 1, &is_iden)); /* from */
15949566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc, &isol2_loc));
1595a6053eceSJunchao 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 */
15969566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, mumps->id.lsol_loc, isol2_loc, PETSC_OWN_POINTER, &is_petsc)); /* to */
15979566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq, is_iden, x, is_petsc, &mumps->scat_sol));
15989566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
15999566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1600a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1601397b6df1SKris Buschelman     }
1602a5e57a09SHong Zhang 
16039566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
16049566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
1605329ec9b3SHong Zhang   }
1606353d7d71SJunchao Zhang 
160767602552SJunchao Zhang   if (mumps->petsc_size > 1) {
160825aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
16099566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b, &rarray));
161025aac85cSJunchao Zhang     } else if (!mumps->myid) {
16119566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq, &array));
161225aac85cSJunchao Zhang     }
16139566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x, &array));
1614353d7d71SJunchao Zhang 
161564412097SPierre Jolivet   PetscCall(PetscLogFlops(2.0 * PetscMax(0, (mumps->id.INFO(28) >= 0 ? mumps->id.INFO(28) : -1000000 * mumps->id.INFO(28)) - A->cmap->n)));
16163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1617397b6df1SKris Buschelman }
1618397b6df1SKris Buschelman 
161966976f2fSJacob Faibussowitsch static PetscErrorCode MatSolveTranspose_MUMPS(Mat A, Vec b, Vec x)
1620d71ae5a4SJacob Faibussowitsch {
1621e69c285eSBarry Smith   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1622338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
162351d5961aSHong Zhang 
162451d5961aSHong Zhang   PetscFunctionBegin;
1625a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
16269566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A, b, x));
1627338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
16283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
162951d5961aSHong Zhang }
163051d5961aSHong Zhang 
163166976f2fSJacob Faibussowitsch static PetscErrorCode MatMatSolve_MUMPS(Mat A, Mat B, Mat X)
1632d71ae5a4SJacob Faibussowitsch {
1633b8491c3eSStefano Zampini   Mat                Bt = NULL;
1634a6053eceSJunchao Zhang   PetscBool          denseX, denseB, flg, flgT;
1635e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)A->data;
1636917c3dccSPierre Jolivet   PetscInt           i, nrhs, M, nrhsM;
16371683a169SBarry Smith   PetscScalar       *array;
16381683a169SBarry Smith   const PetscScalar *rbray;
1639a6053eceSJunchao Zhang   PetscInt           lsol_loc, nlsol_loc, *idxx, iidx = 0;
1640a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc, *isol_loc_save;
16411683a169SBarry Smith   PetscScalar       *bray, *sol_loc, *sol_loc_save;
1642be818407SHong Zhang   IS                 is_to, is_from;
1643beae5ec0SHong Zhang   PetscInt           k, proc, j, m, myrstart;
1644be818407SHong Zhang   const PetscInt    *rstart;
164567602552SJunchao Zhang   Vec                v_mpi, msol_loc;
164667602552SJunchao Zhang   VecScatter         scat_sol;
164767602552SJunchao Zhang   Vec                b_seq;
164867602552SJunchao Zhang   VecScatter         scat_rhs;
1649be818407SHong Zhang   PetscScalar       *aa;
1650be818407SHong Zhang   PetscInt           spnr, *ia, *ja;
1651d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1652bda8bf91SBarry Smith 
1653e0b74bf9SHong Zhang   PetscFunctionBegin;
16549566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X, &denseX, MATSEQDENSE, MATMPIDENSE, NULL));
165528b400f6SJacob Faibussowitsch   PetscCheck(denseX, PetscObjectComm((PetscObject)X), PETSC_ERR_ARG_WRONG, "Matrix X must be MATDENSE matrix");
1656be818407SHong Zhang 
16579566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B, &denseB, MATSEQDENSE, MATMPIDENSE, NULL));
1658a6053eceSJunchao Zhang   if (denseB) {
165908401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix B and X must have same row distribution");
1660be818407SHong Zhang     mumps->id.ICNTL(20) = 0; /* dense RHS */
16610e6b8875SHong Zhang   } else {                   /* sparse B */
166208401ef6SPierre Jolivet     PetscCheck(X != B, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_IDN, "X and B must be different matrices");
1663013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)B, MATTRANSPOSEVIRTUAL, &flgT));
166453587d93SPierre Jolivet     PetscCheck(flgT, PetscObjectComm((PetscObject)B), PETSC_ERR_ARG_WRONG, "Matrix B must be MATTRANSPOSEVIRTUAL matrix");
166553587d93SPierre Jolivet     PetscCall(MatShellGetScalingShifts(B, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
166653587d93SPierre Jolivet     /* input B is transpose of actual RHS matrix,
16670e6b8875SHong Zhang      because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
16689566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(B, &Bt));
1669be818407SHong Zhang     mumps->id.ICNTL(20) = 1; /* sparse RHS */
1670b8491c3eSStefano Zampini   }
167187b22cf4SHong Zhang 
16729566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, &nrhs));
1673917c3dccSPierre Jolivet   PetscCall(PetscIntMultError(nrhs, M, &nrhsM));
16746497c311SBarry Smith   mumps->id.nrhs = (PetscMUMPSInt)nrhs;
16756497c311SBarry Smith   mumps->id.lrhs = (PetscMUMPSInt)M;
16762b691707SHong Zhang   mumps->id.rhs  = NULL;
16779481e6e9SHong Zhang 
16782d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1679b8491c3eSStefano Zampini     PetscScalar *aa;
1680b8491c3eSStefano Zampini     PetscInt     spnr, *ia, *ja;
1681e94cce23SStefano Zampini     PetscBool    second_solve = PETSC_FALSE;
1682b8491c3eSStefano Zampini 
16839566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &array));
1684b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar *)array;
16852b691707SHong Zhang 
1686a6053eceSJunchao Zhang     if (denseB) {
16872b691707SHong Zhang       /* copy B to X */
16889566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
1689917c3dccSPierre Jolivet       PetscCall(PetscArraycpy(array, rbray, nrhsM));
16909566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
16912b691707SHong Zhang     } else { /* sparse B */
16929566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt, &aa));
16939566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
169428b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
16959566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
1696b8491c3eSStefano Zampini       mumps->id.rhs_sparse = (MumpsScalar *)aa;
1697b8491c3eSStefano Zampini     }
1698e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
16993e5b40d0SPierre Jolivet     if (mumps->id.size_schur > 0) {
17003e5b40d0SPierre Jolivet       if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1701e94cce23SStefano Zampini         second_solve = PETSC_TRUE;
17029566063dSJacob Faibussowitsch         PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
17033e5b40d0SPierre Jolivet         mumps->id.ICNTL(26) = 1; /* condensation phase */
17043e5b40d0SPierre Jolivet       } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1705e94cce23SStefano Zampini     }
17062cd7d884SHong Zhang     /* solve phase */
17072cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
17083ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
17099261f6e4SBarry 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));
1710b5fa320bSStefano Zampini 
1711b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
17121baa6e33SBarry Smith     if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
17133e5b40d0SPierre Jolivet     else if (mumps->id.ICNTL(26) == 1) {
17143e5b40d0SPierre Jolivet       PetscCall(MatMumpsSolveSchur_Private(A));
17153e5b40d0SPierre Jolivet       for (j = 0; j < nrhs; ++j)
17163e5b40d0SPierre Jolivet         for (i = 0; i < mumps->id.size_schur; ++i) {
17173e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
17183e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs];
17193e5b40d0SPierre Jolivet #else
17203e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs].r + PETSC_i * mumps->id.redrhs[i + j * mumps->id.lredrhs].i;
17213e5b40d0SPierre Jolivet #endif
17223e5b40d0SPierre Jolivet           array[mumps->id.listvar_schur[i] - 1 + j * M] = val;
17233e5b40d0SPierre Jolivet         }
17243e5b40d0SPierre Jolivet     }
1725a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
17269566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt, &aa));
17279566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
172828b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
1729b8491c3eSStefano Zampini     }
17309566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &array));
17313ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1732be818407SHong Zhang   }
1733801fbe65SHong Zhang 
17342ef1f0ffSBarry Smith   /* parallel case: MUMPS requires rhs B to be centralized on the host! */
173550a7cd33SPierre Jolivet   PetscCheck(!mumps->id.ICNTL(19), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1736241dbb5eSStefano Zampini 
1737beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
17381683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
17391683a169SBarry Smith   sol_loc_save  = (PetscScalar *)mumps->id.sol_loc;
1740801fbe65SHong Zhang 
1741a1dfcbd9SJunchao Zhang   lsol_loc = mumps->id.lsol_loc;
1742917c3dccSPierre Jolivet   PetscCall(PetscIntMultError(nrhs, lsol_loc, &nlsol_loc)); /* length of sol_loc */
17439566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc, &sol_loc, lsol_loc, &isol_loc));
1744940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
1745801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1746801fbe65SHong Zhang 
17479566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, nlsol_loc, (PetscScalar *)sol_loc, &msol_loc));
17482cd7d884SHong Zhang 
174967602552SJunchao Zhang   if (denseB) {
175025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
175167602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
17529566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
17539566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, nrhs, rbray));
17549566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
17559566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
1756917c3dccSPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhsM, NULL, &v_mpi));
175725aac85cSJunchao Zhang     } else {
175825aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
175980577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
176080577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
176180577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
176280577c12SJunchao Zhang       */
176380577c12SJunchao Zhang 
176467602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1765be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
17669566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
17679566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B, &bray));
1768917c3dccSPierre Jolivet       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhsM, (const PetscScalar *)bray, &v_mpi));
17699566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B, &bray));
17702b691707SHong Zhang 
1771be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1772801fbe65SHong Zhang       if (!mumps->myid) {
1773beae5ec0SHong Zhang         PetscInt *idx;
1774beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
1775917c3dccSPierre Jolivet         PetscCall(PetscMalloc1(nrhsM, &idx));
17769566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B, &rstart));
1777917c3dccSPierre Jolivet         for (proc = 0, k = 0; proc < mumps->petsc_size; proc++) {
1778be818407SHong Zhang           for (j = 0; j < nrhs; j++) {
1779beae5ec0SHong Zhang             for (i = rstart[proc]; i < rstart[proc + 1]; i++) idx[k++] = j * M + i;
1780be818407SHong Zhang           }
1781be818407SHong Zhang         }
1782be818407SHong Zhang 
1783917c3dccSPierre Jolivet         PetscCall(VecCreateSeq(PETSC_COMM_SELF, nrhsM, &b_seq));
1784917c3dccSPierre Jolivet         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nrhsM, idx, PETSC_OWN_POINTER, &is_to));
1785917c3dccSPierre Jolivet         PetscCall(ISCreateStride(PETSC_COMM_SELF, nrhsM, 0, 1, &is_from));
1786801fbe65SHong Zhang       } else {
17879566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, 0, &b_seq));
17889566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_to));
17899566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_from));
1790801fbe65SHong Zhang       }
17919566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi, is_from, b_seq, is_to, &scat_rhs));
17929566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
17939566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
17949566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
17959566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
1796801fbe65SHong Zhang 
1797801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
17989566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq, &bray));
1799940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar *)bray;
18009566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq, &bray));
1801801fbe65SHong Zhang       }
180225aac85cSJunchao Zhang     }
18032b691707SHong Zhang   } else { /* sparse B */
18042b691707SHong Zhang     b = (Mat_MPIAIJ *)Bt->data;
18052b691707SHong Zhang 
1806be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
18079566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X, &m, NULL));
18089566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &bray));
1809917c3dccSPierre Jolivet     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X), 1, nrhs * m, nrhsM, (const PetscScalar *)bray, &v_mpi));
18109566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &bray));
18112b691707SHong Zhang 
18122b691707SHong Zhang     if (!mumps->myid) {
18139566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A, &aa));
18149566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
181528b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
18169566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
18172b691707SHong Zhang       mumps->id.rhs_sparse = (MumpsScalar *)aa;
18182b691707SHong Zhang     } else {
18192b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
18202b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
18212b691707SHong Zhang       mumps->id.nz_rhs      = 0;
18222b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
18232b691707SHong Zhang     }
18242b691707SHong Zhang   }
18252b691707SHong Zhang 
1826801fbe65SHong Zhang   /* solve phase */
1827801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
18283ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
18299261f6e4SBarry 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));
1830801fbe65SHong Zhang 
1831f0b74427SPierre Jolivet   /* scatter mumps distributed solution to PETSc vector v_mpi, which shares local arrays with solution matrix X */
18329566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X, &array));
18339566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi, array));
1834801fbe65SHong Zhang 
1835334c5f61SHong Zhang   /* create scatter scat_sol */
18369566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X, &rstart));
1837f0b74427SPierre Jolivet   /* iidx: index for scatter mumps solution to PETSc X */
1838beae5ec0SHong Zhang 
18399566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, nlsol_loc, 0, 1, &is_from));
18409566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc, &idxx));
1841beae5ec0SHong Zhang   for (i = 0; i < lsol_loc; i++) {
1842beae5ec0SHong 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 */
1843beae5ec0SHong Zhang 
18442d4298aeSJunchao Zhang     for (proc = 0; proc < mumps->petsc_size; proc++) {
1845beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc + 1]) {
1846beae5ec0SHong Zhang         myrstart = rstart[proc];
1847f0b74427SPierre Jolivet         k        = isol_loc[i] - myrstart;          /* local index on 1st column of PETSc vector X */
1848f0b74427SPierre Jolivet         iidx     = k + myrstart * nrhs;             /* maps mumps isol_loc[i] to PETSc index in X */
1849beae5ec0SHong Zhang         m        = rstart[proc + 1] - rstart[proc]; /* rows of X for this proc */
1850beae5ec0SHong Zhang         break;
1851be818407SHong Zhang       }
1852be818407SHong Zhang     }
1853be818407SHong Zhang 
1854beae5ec0SHong Zhang     for (j = 0; j < nrhs; j++) idxx[i + j * lsol_loc] = iidx + j * m;
1855801fbe65SHong Zhang   }
18569566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nlsol_loc, idxx, PETSC_COPY_VALUES, &is_to));
18579566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc, is_from, v_mpi, is_to, &scat_sol));
18589566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
18599566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
18609566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
18619566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
18629566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X, &array));
186371aed81dSHong Zhang 
186471aed81dSHong Zhang   /* free spaces */
18651683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar *)sol_loc_save;
186671aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
186771aed81dSHong Zhang 
18689566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc, isol_loc));
18699566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
18709566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
18719566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1872a6053eceSJunchao Zhang   if (!denseB) {
18732b691707SHong Zhang     if (!mumps->myid) {
1874d56c302dSHong Zhang       b = (Mat_MPIAIJ *)Bt->data;
18759566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A, &aa));
18769566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
187728b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
18782b691707SHong Zhang     }
18792b691707SHong Zhang   } else {
188025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
18819566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
18829566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
188325aac85cSJunchao Zhang     }
18842b691707SHong Zhang   }
18859566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
188657508eceSPierre 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)));
18873ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1888e0b74bf9SHong Zhang }
1889e0b74bf9SHong Zhang 
189066976f2fSJacob Faibussowitsch static PetscErrorCode MatMatSolveTranspose_MUMPS(Mat A, Mat B, Mat X)
1891d71ae5a4SJacob Faibussowitsch {
1892b18964edSHong Zhang   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1893338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
1894b18964edSHong Zhang 
1895b18964edSHong Zhang   PetscFunctionBegin;
1896b18964edSHong Zhang   mumps->id.ICNTL(9) = 0;
1897b18964edSHong Zhang   PetscCall(MatMatSolve_MUMPS(A, B, X));
1898338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
18993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1900b18964edSHong Zhang }
1901b18964edSHong Zhang 
190266976f2fSJacob Faibussowitsch static PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A, Mat Bt, Mat X)
1903d71ae5a4SJacob Faibussowitsch {
1904eb3ef3b2SHong Zhang   PetscBool flg;
1905eb3ef3b2SHong Zhang   Mat       B;
1906eb3ef3b2SHong Zhang 
1907eb3ef3b2SHong Zhang   PetscFunctionBegin;
19089566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
190928b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)Bt), PETSC_ERR_ARG_WRONG, "Matrix Bt must be MATAIJ matrix");
1910eb3ef3b2SHong Zhang 
1911eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
19129566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt, &B));
1913eb3ef3b2SHong Zhang 
19149566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A, B, X));
19159566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
19163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1917eb3ef3b2SHong Zhang }
1918eb3ef3b2SHong Zhang 
1919ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1920a58c3f20SHong Zhang /*
1921a58c3f20SHong Zhang   input:
1922a58c3f20SHong Zhang    F:        numeric factor
1923a58c3f20SHong Zhang   output:
1924a58c3f20SHong Zhang    nneg:     total number of negative pivots
192519d49a3bSHong Zhang    nzero:    total number of zero pivots
192619d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1927a58c3f20SHong Zhang */
192866976f2fSJacob Faibussowitsch static PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F, PetscInt *nneg, PetscInt *nzero, PetscInt *npos)
1929d71ae5a4SJacob Faibussowitsch {
1930e69c285eSBarry Smith   Mat_MUMPS  *mumps = (Mat_MUMPS *)F->data;
1931c1490034SHong Zhang   PetscMPIInt size;
1932a58c3f20SHong Zhang 
1933a58c3f20SHong Zhang   PetscFunctionBegin;
19349566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F), &size));
1935bcb30aebSHong 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 */
1936aed4548fSBarry 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));
1937ed85ac9fSHong Zhang 
1938710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1939ed85ac9fSHong Zhang   if (nzero || npos) {
194008401ef6SPierre 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");
1941710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1942710ac8efSHong Zhang     if (npos) *npos = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1943a58c3f20SHong Zhang   }
19443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1945a58c3f20SHong Zhang }
194619d49a3bSHong Zhang #endif
1947a58c3f20SHong Zhang 
194866976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse, Mat_MUMPS *mumps)
1949d71ae5a4SJacob Faibussowitsch {
19506497c311SBarry Smith   PetscMPIInt    nreqs;
1951a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;
1952a6053eceSJunchao Zhang   PetscMPIInt    count;
19536497c311SBarry Smith   PetscCount     totnnz, remain;
1954a6053eceSJunchao Zhang   const PetscInt osize = mumps->omp_comm_size;
1955a6053eceSJunchao Zhang   PetscScalar   *val;
19563ab56b82SJunchao Zhang 
19573ab56b82SJunchao Zhang   PetscFunctionBegin;
1958a6053eceSJunchao Zhang   if (osize > 1) {
19593ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
19603ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
19619566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize, &mumps->recvcount));
19629566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz, 1, MPIU_INT64, mumps->recvcount, 1, MPIU_INT64, 0 /*master*/, mumps->omp_comm));
19633ab56b82SJunchao Zhang 
1964a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
19653ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1966a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1967a6053eceSJunchao Zhang         nreqs = 0;
19686497c311SBarry Smith         for (PetscMPIInt i = 1; i < osize; i++) nreqs += (mumps->recvcount[i] + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
1969a6053eceSJunchao Zhang       } else {
19706497c311SBarry Smith         nreqs = (PetscMPIInt)(((mumps->nnz + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX));
19713ab56b82SJunchao Zhang       }
197235cb6cd3SPierre Jolivet       PetscCall(PetscMalloc1(nreqs * 3, &mumps->reqs)); /* Triple the requests since we send irn, jcn and val separately */
19733ab56b82SJunchao Zhang 
1974a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1975a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1976a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1977a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1978a6053eceSJunchao Zhang        */
1979a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
19803ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
19816497c311SBarry Smith         totnnz = 0;
19826497c311SBarry Smith 
19836497c311SBarry Smith         for (PetscMPIInt i = 0; i < osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
19849566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz, &irn, totnnz, &jcn));
19859566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz, &val));
1986a6053eceSJunchao Zhang 
1987a6053eceSJunchao Zhang         /* Self communication */
19889566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn, mumps->irn, mumps->nnz));
19899566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn, mumps->jcn, mumps->nnz));
19909566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val, mumps->val, mumps->nnz));
1991a6053eceSJunchao Zhang 
1992a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
19939566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
19949566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1995a6053eceSJunchao Zhang         mumps->nnz = totnnz;
19963ab56b82SJunchao Zhang         mumps->irn = irn;
19973ab56b82SJunchao Zhang         mumps->jcn = jcn;
1998a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1999a6053eceSJunchao Zhang 
2000a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
2001a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
2002a6053eceSJunchao Zhang         val += mumps->recvcount[0];
2003a6053eceSJunchao Zhang 
2004a6053eceSJunchao Zhang         /* Remote communication */
20056497c311SBarry Smith         for (PetscMPIInt i = 1; i < osize; i++) {
20066497c311SBarry Smith           count  = (PetscMPIInt)PetscMin(mumps->recvcount[i], (PetscMPIInt)PETSC_MPI_INT_MAX);
2007a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
2008a6053eceSJunchao Zhang           while (count > 0) {
20096497c311SBarry Smith             PetscCallMPI(MPIU_Irecv(irn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
20106497c311SBarry Smith             PetscCallMPI(MPIU_Irecv(jcn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
20116497c311SBarry Smith             PetscCallMPI(MPIU_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
2012a6053eceSJunchao Zhang             irn += count;
2013a6053eceSJunchao Zhang             jcn += count;
2014a6053eceSJunchao Zhang             val += count;
20156497c311SBarry Smith             count = (PetscMPIInt)PetscMin(remain, (PetscMPIInt)PETSC_MPI_INT_MAX);
2016a6053eceSJunchao Zhang             remain -= count;
2017a6053eceSJunchao Zhang           }
20183ab56b82SJunchao Zhang         }
20193ab56b82SJunchao Zhang       } else {
2020a6053eceSJunchao Zhang         irn    = mumps->irn;
2021a6053eceSJunchao Zhang         jcn    = mumps->jcn;
2022a6053eceSJunchao Zhang         val    = mumps->val;
20236497c311SBarry Smith         count  = (PetscMPIInt)PetscMin(mumps->nnz, (PetscMPIInt)PETSC_MPI_INT_MAX);
2024a6053eceSJunchao Zhang         remain = mumps->nnz - count;
2025a6053eceSJunchao Zhang         while (count > 0) {
20266497c311SBarry Smith           PetscCallMPI(MPIU_Isend(irn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
20276497c311SBarry Smith           PetscCallMPI(MPIU_Isend(jcn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
20286497c311SBarry Smith           PetscCallMPI(MPIU_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
2029a6053eceSJunchao Zhang           irn += count;
2030a6053eceSJunchao Zhang           jcn += count;
2031a6053eceSJunchao Zhang           val += count;
20326497c311SBarry Smith           count = (PetscMPIInt)PetscMin(remain, (PetscMPIInt)PETSC_MPI_INT_MAX);
2033a6053eceSJunchao Zhang           remain -= count;
20343ab56b82SJunchao Zhang         }
20353ab56b82SJunchao Zhang       }
2036a6053eceSJunchao Zhang     } else {
2037a6053eceSJunchao Zhang       nreqs = 0;
2038a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
2039a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
20406497c311SBarry Smith         for (PetscMPIInt i = 1; i < osize; i++) { /* Remote communication only since self data is already in place */
20416497c311SBarry Smith           count  = (PetscMPIInt)PetscMin(mumps->recvcount[i], (PetscMPIInt)PETSC_MPI_INT_MAX);
2042a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
2043a6053eceSJunchao Zhang           while (count > 0) {
20446497c311SBarry Smith             PetscCallMPI(MPIU_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
2045a6053eceSJunchao Zhang             val += count;
20466497c311SBarry Smith             count = (PetscMPIInt)PetscMin(remain, (PetscMPIInt)PETSC_MPI_INT_MAX);
2047a6053eceSJunchao Zhang             remain -= count;
2048a6053eceSJunchao Zhang           }
2049a6053eceSJunchao Zhang         }
2050a6053eceSJunchao Zhang       } else {
2051a6053eceSJunchao Zhang         val    = mumps->val;
20526497c311SBarry Smith         count  = (PetscMPIInt)PetscMin(mumps->nnz, (PetscMPIInt)PETSC_MPI_INT_MAX);
2053a6053eceSJunchao Zhang         remain = mumps->nnz - count;
2054a6053eceSJunchao Zhang         while (count > 0) {
20556497c311SBarry Smith           PetscCallMPI(MPIU_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
2056a6053eceSJunchao Zhang           val += count;
20576497c311SBarry Smith           count = (PetscMPIInt)PetscMin(remain, (PetscMPIInt)PETSC_MPI_INT_MAX);
2058a6053eceSJunchao Zhang           remain -= count;
2059a6053eceSJunchao Zhang         }
2060a6053eceSJunchao Zhang       }
2061a6053eceSJunchao Zhang     }
20629566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs, mumps->reqs, MPI_STATUSES_IGNORE));
2063a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
2064a6053eceSJunchao Zhang   }
20653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
20663ab56b82SJunchao Zhang }
20673ab56b82SJunchao Zhang 
2068d2a308c1SPierre Jolivet static PetscErrorCode MatFactorNumeric_MUMPS(Mat F, Mat A, PETSC_UNUSED const MatFactorInfo *info)
2069d71ae5a4SJacob Faibussowitsch {
207057508eceSPierre Jolivet   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2071ace3abfcSBarry Smith   PetscBool  isMPIAIJ;
2072397b6df1SKris Buschelman 
2073397b6df1SKris Buschelman   PetscFunctionBegin;
2074dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
207548a46eb9SPierre 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)));
20769566063dSJacob 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)));
20773ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
20782aca8efcSHong Zhang   }
20796baea169SHong Zhang 
20809566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
20819566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX, mumps));
2082397b6df1SKris Buschelman 
2083397b6df1SKris Buschelman   /* numerical factorization phase */
2084a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
20854e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
2086ad540459SPierre Jolivet     if (!mumps->myid) mumps->id.a = (MumpsScalar *)mumps->val;
2087397b6df1SKris Buschelman   } else {
2088940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar *)mumps->val;
2089397b6df1SKris Buschelman   }
20903ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
2091a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
20929261f6e4SBarry 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));
20939261f6e4SBarry Smith     if (mumps->id.INFOG(1) == -10) {
20949261f6e4SBarry 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)));
2095603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
2096c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -13) {
20979261f6e4SBarry 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)));
2098603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
2099c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
2100bdcd51b8SPierre Jolivet       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d, problem with work array\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
2101603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
21022aca8efcSHong Zhang     } else {
21039261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
2104603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
2105151787a6SHong Zhang     }
21062aca8efcSHong Zhang   }
21079261f6e4SBarry 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));
2108397b6df1SKris Buschelman 
2109b3cb21ddSStefano Zampini   F->assembled = PETSC_TRUE;
2110d47f36abSHong Zhang 
2111b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
21123cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
2113c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
21143cb7dd0eSStefano Zampini #endif
2115b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
2116b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
21179566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur, MAT_INPLACE_MATRIX, &F->schur));
2118b3cb21ddSStefano Zampini     }
21199566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F, NULL, MAT_FACTOR_SCHUR_UNFACTORED));
2120b3cb21ddSStefano Zampini   }
212167877ebaSShri Abhyankar 
2122066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
2123066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
2124066565c5SStefano Zampini 
21253ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
21262d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
212767877ebaSShri Abhyankar     PetscInt     lsol_loc;
212867877ebaSShri Abhyankar     PetscScalar *sol_loc;
21292205254eSKarl Rupp 
21309566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A, MATMPIAIJ, &isMPIAIJ));
2131c2093ab7SHong Zhang 
2132c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
2133c2093ab7SHong Zhang     if (mumps->x_seq) {
21349566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
21359566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
21369566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
2137c2093ab7SHong Zhang     }
2138a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
21399566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc, &sol_loc, lsol_loc, &mumps->id.isol_loc));
21406497c311SBarry Smith     mumps->id.lsol_loc = (PetscMUMPSInt)lsol_loc;
2141940cd9d6SSatish Balay     mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
21429566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, lsol_loc, sol_loc, &mumps->x_seq));
214367877ebaSShri Abhyankar   }
2144d2a308c1SPierre Jolivet   PetscCall(PetscLogFlops((double)mumps->id.RINFO(2)));
21453ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2146397b6df1SKris Buschelman }
2147397b6df1SKris Buschelman 
21489a2535b5SHong Zhang /* Sets MUMPS options from the options database */
214966976f2fSJacob Faibussowitsch static PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
2150d71ae5a4SJacob Faibussowitsch {
2151e69c285eSBarry Smith   Mat_MUMPS    *mumps = (Mat_MUMPS *)F->data;
2152413bcc21SPierre Jolivet   PetscMUMPSInt icntl = 0, size, *listvar_schur;
215345e3843bSPierre Jolivet   PetscInt      info[80], i, ninfo = 80, rbs, cbs;
2154413bcc21SPierre Jolivet   PetscBool     flg = PETSC_FALSE, schur = (PetscBool)(mumps->id.ICNTL(26) == -1);
2155413bcc21SPierre Jolivet   MumpsScalar  *arr;
2156dcd589f8SShri Abhyankar 
2157dcd589f8SShri Abhyankar   PetscFunctionBegin;
215826cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F), ((PetscObject)F)->prefix, "MUMPS Options", "Mat");
2159413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) { /* MatSetFromOptions_MUMPS() has never been called before */
2160413bcc21SPierre Jolivet     PetscInt      nthreads   = 0;
2161413bcc21SPierre Jolivet     PetscInt      nCNTL_pre  = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
2162413bcc21SPierre Jolivet     PetscInt      nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
216393d70b8aSPierre Jolivet     PetscMUMPSInt nblk, *blkvar, *blkptr;
2164413bcc21SPierre Jolivet 
2165413bcc21SPierre Jolivet     mumps->petsc_comm = PetscObjectComm((PetscObject)A);
2166413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->petsc_comm, &mumps->petsc_size));
2167413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm, &mumps->myid)); /* "if (!myid)" still works even if mumps_comm is different */
2168413bcc21SPierre Jolivet 
2169413bcc21SPierre Jolivet     PetscCall(PetscOptionsName("-mat_mumps_use_omp_threads", "Convert MPI processes into OpenMP threads", "None", &mumps->use_petsc_omp_support));
2170413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
2171413bcc21SPierre Jolivet     /* do not use PetscOptionsInt() so that the option -mat_mumps_use_omp_threads is not displayed twice in the help */
2172413bcc21SPierre Jolivet     PetscCall(PetscOptionsGetInt(NULL, ((PetscObject)F)->prefix, "-mat_mumps_use_omp_threads", &nthreads, NULL));
2173413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) {
2174413bcc21SPierre 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 : "");
2175413bcc21SPierre Jolivet #if defined(PETSC_HAVE_OPENMP_SUPPORT)
2176413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm, nthreads, &mumps->omp_ctrl));
2177413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl, &mumps->omp_comm, &mumps->mumps_comm, &mumps->is_omp_master));
2178ea17275aSJose E. Roman #else
2179ea17275aSJose E. Roman       SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP_SYS, "The system does not have PETSc OpenMP support but you added the -%smat_mumps_use_omp_threads option. Configure PETSc with --with-openmp --download-hwloc (or --with-hwloc) to enable it, see more in MATSOLVERMUMPS manual",
2180ea17275aSJose E. Roman               ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
2181413bcc21SPierre Jolivet #endif
2182413bcc21SPierre Jolivet     } else {
2183413bcc21SPierre Jolivet       mumps->omp_comm      = PETSC_COMM_SELF;
2184413bcc21SPierre Jolivet       mumps->mumps_comm    = mumps->petsc_comm;
2185413bcc21SPierre Jolivet       mumps->is_omp_master = PETSC_TRUE;
2186413bcc21SPierre Jolivet     }
2187413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->omp_comm, &mumps->omp_comm_size));
2188413bcc21SPierre Jolivet     mumps->reqs = NULL;
2189413bcc21SPierre Jolivet     mumps->tag  = 0;
2190413bcc21SPierre Jolivet 
2191413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
2192413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) {
2193413bcc21SPierre Jolivet         /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
2194413bcc21SPierre Jolivet         MPI_Comm comm;
2195413bcc21SPierre Jolivet         PetscCallMPI(MPI_Comm_dup(mumps->mumps_comm, &comm));
2196413bcc21SPierre Jolivet         mumps->mumps_comm = comm;
2197413bcc21SPierre Jolivet       } else PetscCall(PetscCommGetComm(mumps->petsc_comm, &mumps->mumps_comm));
2198413bcc21SPierre Jolivet     }
2199413bcc21SPierre Jolivet 
2200413bcc21SPierre Jolivet     mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
2201413bcc21SPierre Jolivet     mumps->id.job          = JOB_INIT;
2202413bcc21SPierre Jolivet     mumps->id.par          = 1; /* host participates factorizaton and solve */
2203413bcc21SPierre Jolivet     mumps->id.sym          = mumps->sym;
2204413bcc21SPierre Jolivet 
2205413bcc21SPierre Jolivet     size          = mumps->id.size_schur;
2206413bcc21SPierre Jolivet     arr           = mumps->id.schur;
2207413bcc21SPierre Jolivet     listvar_schur = mumps->id.listvar_schur;
220893d70b8aSPierre Jolivet     nblk          = mumps->id.nblk;
220993d70b8aSPierre Jolivet     blkvar        = mumps->id.blkvar;
221093d70b8aSPierre Jolivet     blkptr        = mumps->id.blkptr;
2211*96eb7ee0SStefano Zampini     if (PetscDefined(USE_DEBUG)) {
2212*96eb7ee0SStefano Zampini       for (PetscInt i = 0; i < size; i++)
2213*96eb7ee0SStefano Zampini         PetscCheck(listvar_schur[i] - 1 >= 0 && listvar_schur[i] - 1 < A->rmap->N, PETSC_COMM_SELF, PETSC_ERR_USER, "Invalid Schur index at position %" PetscInt_FMT "! %" PetscInt_FMT " must be in [0, %" PetscInt_FMT ")", i, (PetscInt)listvar_schur[i] - 1,
2214*96eb7ee0SStefano Zampini                    A->rmap->N);
2215*96eb7ee0SStefano Zampini     }
2216*96eb7ee0SStefano Zampini 
2217413bcc21SPierre Jolivet     PetscMUMPS_c(mumps);
22189261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
221951ad14ebSPierre Jolivet 
222051ad14ebSPierre Jolivet     /* set PETSc-MUMPS default options - override MUMPS default */
222151ad14ebSPierre Jolivet     mumps->id.ICNTL(3) = 0;
222251ad14ebSPierre Jolivet     mumps->id.ICNTL(4) = 0;
222351ad14ebSPierre Jolivet     if (mumps->petsc_size == 1) {
222451ad14ebSPierre Jolivet       mumps->id.ICNTL(18) = 0; /* centralized assembled matrix input */
222551ad14ebSPierre Jolivet       mumps->id.ICNTL(7)  = 7; /* automatic choice of ordering done by the package */
222651ad14ebSPierre Jolivet     } else {
222751ad14ebSPierre Jolivet       mumps->id.ICNTL(18) = 3; /* distributed assembled matrix input */
222851ad14ebSPierre Jolivet       mumps->id.ICNTL(21) = 1; /* distributed solution */
222951ad14ebSPierre Jolivet     }
223093d70b8aSPierre Jolivet     if (nblk && blkptr) {
223193d70b8aSPierre Jolivet       mumps->id.ICNTL(15) = 1;
223293d70b8aSPierre Jolivet       mumps->id.nblk      = nblk;
223393d70b8aSPierre Jolivet       mumps->id.blkvar    = blkvar;
223493d70b8aSPierre Jolivet       mumps->id.blkptr    = blkptr;
223593d70b8aSPierre Jolivet     }
223651ad14ebSPierre Jolivet 
2237413bcc21SPierre Jolivet     /* restore cached ICNTL and CNTL values */
2238413bcc21SPierre Jolivet     for (icntl = 0; icntl < nICNTL_pre; ++icntl) mumps->id.ICNTL(mumps->ICNTL_pre[1 + 2 * icntl]) = mumps->ICNTL_pre[2 + 2 * icntl];
2239413bcc21SPierre Jolivet     for (icntl = 0; icntl < nCNTL_pre; ++icntl) mumps->id.CNTL((PetscInt)mumps->CNTL_pre[1 + 2 * icntl]) = mumps->CNTL_pre[2 + 2 * icntl];
2240413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->ICNTL_pre));
2241413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->CNTL_pre));
2242413bcc21SPierre Jolivet 
2243413bcc21SPierre Jolivet     if (schur) {
2244413bcc21SPierre Jolivet       mumps->id.size_schur    = size;
2245413bcc21SPierre Jolivet       mumps->id.schur_lld     = size;
2246413bcc21SPierre Jolivet       mumps->id.schur         = arr;
2247413bcc21SPierre Jolivet       mumps->id.listvar_schur = listvar_schur;
2248413bcc21SPierre Jolivet       if (mumps->petsc_size > 1) {
2249413bcc21SPierre Jolivet         PetscBool gs; /* gs is false if any rank other than root has non-empty IS */
2250413bcc21SPierre Jolivet 
2251413bcc21SPierre Jolivet         mumps->id.ICNTL(19) = 1;                                                                            /* MUMPS returns Schur centralized on the host */
2252413bcc21SPierre 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 */
2253462c564dSBarry Smith         PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &gs, 1, MPIU_BOOL, MPI_LAND, mumps->petsc_comm));
2254413bcc21SPierre Jolivet         PetscCheck(gs, PETSC_COMM_SELF, PETSC_ERR_SUP, "MUMPS distributed parallel Schur complements not yet supported from PETSc");
2255413bcc21SPierre Jolivet       } else {
2256413bcc21SPierre Jolivet         if (F->factortype == MAT_FACTOR_LU) {
2257413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
2258413bcc21SPierre Jolivet         } else {
2259413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
2260413bcc21SPierre Jolivet         }
2261413bcc21SPierre Jolivet       }
2262413bcc21SPierre Jolivet       mumps->id.ICNTL(26) = -1;
2263413bcc21SPierre Jolivet     }
2264413bcc21SPierre Jolivet 
2265413bcc21SPierre Jolivet     /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
2266413bcc21SPierre Jolivet        For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
2267413bcc21SPierre Jolivet      */
2268413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.icntl, 40, MPI_INT, 0, mumps->omp_comm));
2269413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15, MPIU_REAL, 0, mumps->omp_comm));
2270413bcc21SPierre Jolivet 
2271413bcc21SPierre Jolivet     mumps->scat_rhs = NULL;
2272413bcc21SPierre Jolivet     mumps->scat_sol = NULL;
2273413bcc21SPierre Jolivet   }
22749566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1", "ICNTL(1): output stream for error messages", "None", mumps->id.ICNTL(1), &icntl, &flg));
22759a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
22769566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2", "ICNTL(2): output stream for diagnostic printing, statistics, and warning", "None", mumps->id.ICNTL(2), &icntl, &flg));
22779a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
22789566063dSJacob 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));
22799a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
2280dcd589f8SShri Abhyankar 
22819566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4", "ICNTL(4): level of printing (0 to 4)", "None", mumps->id.ICNTL(4), &icntl, &flg));
22829a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
22839a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
22849a2535b5SHong Zhang 
22859566063dSJacob 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));
22869a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
22879a2535b5SHong Zhang 
22889566063dSJacob 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));
2289dcd589f8SShri Abhyankar   if (flg) {
2290aed4548fSBarry 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");
2291b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
2292dcd589f8SShri Abhyankar   }
2293e0b74bf9SHong Zhang 
22949566063dSJacob 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));
22959566063dSJacob 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() */
22969566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10", "ICNTL(10): max num of refinements", "None", mumps->id.ICNTL(10), &mumps->id.ICNTL(10), NULL));
22979566063dSJacob 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));
22989566063dSJacob 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));
22999566063dSJacob 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));
23009566063dSJacob 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));
230145e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A, &rbs, &cbs));
23026497c311SBarry Smith   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = (PetscMUMPSInt)-rbs;
230345e3843bSPierre 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));
230445e3843bSPierre Jolivet   if (flg) {
230593d70b8aSPierre Jolivet     if (mumps->id.ICNTL(15) < 0) 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");
230693d70b8aSPierre Jolivet     else if (mumps->id.ICNTL(15) > 0) {
230793d70b8aSPierre Jolivet       const PetscInt *bsizes;
230893d70b8aSPierre Jolivet       PetscInt        nblocks, p, *blkptr = NULL;
230993d70b8aSPierre Jolivet       PetscMPIInt    *recvcounts, *displs, n;
231093d70b8aSPierre Jolivet       PetscMPIInt     rank, size = 0;
231193d70b8aSPierre Jolivet 
231293d70b8aSPierre Jolivet       PetscCall(MatGetVariableBlockSizes(A, &nblocks, &bsizes));
231393d70b8aSPierre Jolivet       flg = PETSC_TRUE;
231493d70b8aSPierre Jolivet       for (p = 0; p < nblocks; ++p) {
231593d70b8aSPierre Jolivet         if (bsizes[p] > 1) break;
231693d70b8aSPierre Jolivet       }
231793d70b8aSPierre Jolivet       if (p == nblocks) flg = PETSC_FALSE;
231893d70b8aSPierre Jolivet       PetscCallMPI(MPIU_Allreduce(MPI_IN_PLACE, &flg, 1, MPIU_BOOL, MPI_LOR, PetscObjectComm((PetscObject)A)));
231993d70b8aSPierre Jolivet       if (flg) { // if at least one process supplies variable block sizes and they are not all set to 1
232093d70b8aSPierre Jolivet         PetscCallMPI(MPI_Comm_rank(PetscObjectComm((PetscObject)A), &rank));
232193d70b8aSPierre Jolivet         if (rank == 0) PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
232293d70b8aSPierre Jolivet         PetscCall(PetscCalloc2(size, &recvcounts, size + 1, &displs));
232393d70b8aSPierre Jolivet         PetscCall(PetscMPIIntCast(nblocks, &n));
232493d70b8aSPierre Jolivet         PetscCallMPI(MPI_Gather(&n, 1, MPI_INT, recvcounts, 1, MPI_INT, 0, PetscObjectComm((PetscObject)A)));
232593d70b8aSPierre Jolivet         for (PetscInt p = 0; p < size; ++p) displs[p + 1] = displs[p] + recvcounts[p];
232693d70b8aSPierre Jolivet         PetscCall(PetscMalloc1(displs[size] + 1, &blkptr));
232793d70b8aSPierre Jolivet         PetscCallMPI(MPI_Bcast(displs + size, 1, MPIU_INT, 0, PetscObjectComm((PetscObject)A)));
232893d70b8aSPierre Jolivet         PetscCallMPI(MPI_Gatherv(bsizes, n, MPIU_INT, blkptr + 1, recvcounts, displs, MPIU_INT, 0, PetscObjectComm((PetscObject)A)));
232993d70b8aSPierre Jolivet         if (rank == 0) {
233093d70b8aSPierre Jolivet           blkptr[0] = 1;
233193d70b8aSPierre Jolivet           for (PetscInt p = 0; p < n; ++p) blkptr[p + 1] += blkptr[p];
233293d70b8aSPierre Jolivet           PetscCall(MatMumpsSetBlk(F, displs[size], NULL, blkptr));
233393d70b8aSPierre Jolivet         }
233493d70b8aSPierre Jolivet         PetscCall(PetscFree2(recvcounts, displs));
233593d70b8aSPierre Jolivet         PetscCall(PetscFree(blkptr));
233693d70b8aSPierre Jolivet       }
233793d70b8aSPierre Jolivet     }
233845e3843bSPierre Jolivet   }
23399566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19", "ICNTL(19): computes the Schur complement", "None", mumps->id.ICNTL(19), &mumps->id.ICNTL(19), NULL));
234059ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
23419566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
23429566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
234359ac8732SStefano Zampini   }
234425aac85cSJunchao Zhang 
234543f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
234643f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
234725aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
234843f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
234943f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
235041caa250SJunchao Zhang      In short, we could not use distributed RHS until with MPICH v4.0b1 or we enabled a workaround in mumps-5.6.2+
235125aac85cSJunchao Zhang    */
2352c183326eSPierre Jolivet   mumps->ICNTL20 = 10; /* Distributed dense RHS, by default */
2353c183326eSPierre Jolivet #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0) || (PetscDefined(HAVE_MPICH) && MPICH_NUMVERSION < 40000101) || PetscDefined(HAVE_MSMPI)
2354c183326eSPierre Jolivet   mumps->ICNTL20 = 0; /* Centralized dense RHS, if need be */
235525aac85cSJunchao Zhang #endif
23569566063dSJacob 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));
2357aed4548fSBarry 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);
235825aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0)
2359aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10, PETSC_COMM_SELF, PETSC_ERR_SUP, "ICNTL(20)=10 is not supported before MUMPS-5.3.0");
236025aac85cSJunchao Zhang #endif
23619566063dSJacob 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 */
23629a2535b5SHong Zhang 
23639566063dSJacob 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));
23649566063dSJacob 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));
23659566063dSJacob 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));
23669371c9d4SSatish Balay   if (mumps->id.ICNTL(24)) { mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */ }
2367d7ebd59bSHong Zhang 
23689566063dSJacob 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));
23699566063dSJacob 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));
23709566063dSJacob 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));
2371fa6fd9d0SPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_28", "ICNTL(28): use 1 for sequential analysis and ICNTL(7) ordering, or 2 for parallel analysis and ICNTL(29) ordering", "None", mumps->id.ICNTL(28), &mumps->id.ICNTL(28), NULL));
23729566063dSJacob 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));
23739566063dSJacob 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 */
23749566063dSJacob 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));
2375145b44c9SPierre 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 */
23769566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33", "ICNTL(33): compute determinant", "None", mumps->id.ICNTL(33), &mumps->id.ICNTL(33), NULL));
23779566063dSJacob 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));
23789566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36", "ICNTL(36): choice of BLR factorization variant", "None", mumps->id.ICNTL(36), &mumps->id.ICNTL(36), NULL));
237950ea2040Saszaboa   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_37", "ICNTL(37): compression of the contribution blocks (CB)", "None", mumps->id.ICNTL(37), &mumps->id.ICNTL(37), NULL));
23809566063dSJacob 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));
2381c92b4f89SPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_48", "ICNTL(48): multithreading with tree parallelism", "None", mumps->id.ICNTL(48), &mumps->id.ICNTL(48), NULL));
238291b026caSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_56", "ICNTL(56): postponing and rank-revealing factorization", "None", mumps->id.ICNTL(56), &mumps->id.ICNTL(56), NULL));
2383146931dbSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_58", "ICNTL(58): defines options for symbolic factorization", "None", mumps->id.ICNTL(58), &mumps->id.ICNTL(58), NULL));
2384dcd589f8SShri Abhyankar 
23859566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1", "CNTL(1): relative pivoting threshold", "None", mumps->id.CNTL(1), &mumps->id.CNTL(1), NULL));
23869566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2", "CNTL(2): stopping criterion of refinement", "None", mumps->id.CNTL(2), &mumps->id.CNTL(2), NULL));
23879566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3", "CNTL(3): absolute pivoting threshold", "None", mumps->id.CNTL(3), &mumps->id.CNTL(3), NULL));
23889566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4", "CNTL(4): value for static pivoting", "None", mumps->id.CNTL(4), &mumps->id.CNTL(4), NULL));
23899566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5", "CNTL(5): fixation for null pivots", "None", mumps->id.CNTL(5), &mumps->id.CNTL(5), NULL));
23909566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7", "CNTL(7): dropping parameter used during BLR", "None", mumps->id.CNTL(7), &mumps->id.CNTL(7), NULL));
2391e5bb22a1SHong Zhang 
23929566063dSJacob 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));
2393b34f08ffSHong Zhang 
23949566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info", "request INFO local to each processor", "", info, &ninfo, NULL));
2395b34f08ffSHong Zhang   if (ninfo) {
239608401ef6SPierre Jolivet     PetscCheck(ninfo <= 80, PETSC_COMM_SELF, PETSC_ERR_USER, "number of INFO %" PetscInt_FMT " must <= 80", ninfo);
23979566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo, &mumps->info));
2398b34f08ffSHong Zhang     mumps->ninfo = ninfo;
2399b34f08ffSHong Zhang     for (i = 0; i < ninfo; i++) {
2400aed4548fSBarry 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);
2401f7d195e4SLawrence Mitchell       mumps->info[i] = info[i];
2402b34f08ffSHong Zhang     }
2403b34f08ffSHong Zhang   }
2404d0609cedSBarry Smith   PetscOptionsEnd();
24053ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2406dcd589f8SShri Abhyankar }
2407dcd589f8SShri Abhyankar 
2408d2a308c1SPierre Jolivet static PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F, Mat A, PETSC_UNUSED const MatFactorInfo *info, Mat_MUMPS *mumps)
2409d71ae5a4SJacob Faibussowitsch {
24105cd7cf9dSHong Zhang   PetscFunctionBegin;
24115cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
24129261f6e4SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in analysis: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
24135cd7cf9dSHong Zhang     if (mumps->id.INFOG(1) == -6) {
24149261f6e4SBarry 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)));
2415603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
24165cd7cf9dSHong Zhang     } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
24179261f6e4SBarry 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)));
2418603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
2419dbf6bb8dSprj-     } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
24209261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: empty matrix\n"));
24215cd7cf9dSHong Zhang     } else {
24229261f6e4SBarry 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)));
2423603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
24245cd7cf9dSHong Zhang     }
24255cd7cf9dSHong Zhang   }
242672b150d8SStefano Zampini   if (!mumps->id.n) F->factorerrortype = MAT_FACTOR_NOERROR;
24273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
24285cd7cf9dSHong Zhang }
24295cd7cf9dSHong Zhang 
2430d2a308c1SPierre Jolivet static PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F, Mat A, IS r, PETSC_UNUSED IS c, const MatFactorInfo *info)
2431d71ae5a4SJacob Faibussowitsch {
2432e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
243367877ebaSShri Abhyankar   Vec            b;
243467877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2435397b6df1SKris Buschelman 
2436397b6df1SKris Buschelman   PetscFunctionBegin;
2437d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2438d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
24393ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2440d47f36abSHong Zhang   }
2441dcd589f8SShri Abhyankar 
24429a2535b5SHong Zhang   /* Set MUMPS options from the options database */
244326cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2444dcd589f8SShri Abhyankar 
24459566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
24469566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2447dcd589f8SShri Abhyankar 
244867877ebaSShri Abhyankar   /* analysis phase */
2449a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
24506497c311SBarry Smith   PetscCall(PetscMUMPSIntCast(M, &mumps->id.n));
2451a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
245267877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2453a5e57a09SHong Zhang     if (!mumps->myid) {
2454a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2455a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2456a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2457a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
245851ad14ebSPierre Jolivet       if (r && mumps->id.ICNTL(7) == 7) {
24594ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
2460a5e57a09SHong Zhang         if (!mumps->myid) {
2461e0b74bf9SHong Zhang           const PetscInt *idx;
2462a6053eceSJunchao Zhang           PetscInt        i;
24632205254eSKarl Rupp 
24649566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M, &mumps->id.perm_in));
24659566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r, &idx));
2466f4f49eeaSPierre Jolivet           for (i = 0; i < M; i++) PetscCall(PetscMUMPSIntCast(idx[i] + 1, &mumps->id.perm_in[i])); /* perm_in[]: start from 1, not 0! */
24679566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r, &idx));
2468e0b74bf9SHong Zhang         }
2469e0b74bf9SHong Zhang       }
247067877ebaSShri Abhyankar     }
247167877ebaSShri Abhyankar     break;
247267877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2473a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2474a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2475a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2476a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
247725aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
24789566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
24799566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
24809566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
248125aac85cSJunchao Zhang     }
248267877ebaSShri Abhyankar     break;
248367877ebaSShri Abhyankar   }
24843ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
24859566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
248667877ebaSShri Abhyankar 
2487719d5645SBarry Smith   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2488dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
248951d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
24904e34a73bSHong Zhang   F->ops->matsolve          = MatMatSolve_MUMPS;
2491eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
2492b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2493d47f36abSHong Zhang 
2494d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
24953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2496b24902e0SBarry Smith }
2497b24902e0SBarry Smith 
2498f0b74427SPierre Jolivet /* Note the PETSc r and c permutations are ignored */
2499d2a308c1SPierre Jolivet static PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F, Mat A, PETSC_UNUSED IS r, PETSC_UNUSED IS c, const MatFactorInfo *info)
2500d71ae5a4SJacob Faibussowitsch {
2501e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
250267877ebaSShri Abhyankar   Vec            b;
250367877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2504450b117fSShri Abhyankar 
2505450b117fSShri Abhyankar   PetscFunctionBegin;
2506d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2507338d3105SPierre Jolivet     /* F is assembled by a previous call of MatLUFactorSymbolic_BAIJMUMPS() */
25083ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2509d47f36abSHong Zhang   }
2510dcd589f8SShri Abhyankar 
25119a2535b5SHong Zhang   /* Set MUMPS options from the options database */
251226cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2513dcd589f8SShri Abhyankar 
25149566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
25159566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
251667877ebaSShri Abhyankar 
251767877ebaSShri Abhyankar   /* analysis phase */
2518a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
25196497c311SBarry Smith   PetscCall(PetscMUMPSIntCast(M, &mumps->id.n));
2520a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
252167877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2522a5e57a09SHong Zhang     if (!mumps->myid) {
2523a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2524a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2525a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2526ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
252767877ebaSShri Abhyankar     }
252867877ebaSShri Abhyankar     break;
252967877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2530a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2531a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2532a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2533ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
253425aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
25359566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
25369566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
25379566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
253825aac85cSJunchao Zhang     }
253967877ebaSShri Abhyankar     break;
254067877ebaSShri Abhyankar   }
25413ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
25429566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
254367877ebaSShri Abhyankar 
2544450b117fSShri Abhyankar   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2545dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
254651d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
2547b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2548d47f36abSHong Zhang 
2549d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
25503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2551450b117fSShri Abhyankar }
2552b24902e0SBarry Smith 
2553f0b74427SPierre Jolivet /* Note the PETSc r permutation and factor info are ignored */
2554d2a308c1SPierre Jolivet static PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F, Mat A, PETSC_UNUSED IS r, const MatFactorInfo *info)
2555d71ae5a4SJacob Faibussowitsch {
2556e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
255767877ebaSShri Abhyankar   Vec            b;
255867877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2559397b6df1SKris Buschelman 
2560397b6df1SKris Buschelman   PetscFunctionBegin;
2561d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2562338d3105SPierre Jolivet     /* F is assembled by a previous call of MatCholeskyFactorSymbolic_MUMPS() */
25633ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2564d47f36abSHong Zhang   }
2565dcd589f8SShri Abhyankar 
25669a2535b5SHong Zhang   /* Set MUMPS options from the options database */
256726cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2568dcd589f8SShri Abhyankar 
25699566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
25709566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2571dcd589f8SShri Abhyankar 
257267877ebaSShri Abhyankar   /* analysis phase */
2573a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
25746497c311SBarry Smith   PetscCall(PetscMUMPSIntCast(M, &mumps->id.n));
2575a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
257667877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2577a5e57a09SHong Zhang     if (!mumps->myid) {
2578a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2579a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2580a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2581ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
258267877ebaSShri Abhyankar     }
258367877ebaSShri Abhyankar     break;
258467877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2585a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2586a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2587a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2588ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
258925aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
25909566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
25919566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
25929566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
259325aac85cSJunchao Zhang     }
259467877ebaSShri Abhyankar     break;
259567877ebaSShri Abhyankar   }
25963ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
25979566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
25985cd7cf9dSHong Zhang 
25992792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2600dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
260151d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
26024e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
260323a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
2604b18964edSHong Zhang   F->ops->matsolvetranspose     = MatMatSolveTranspose_MUMPS;
26054e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
26060298fd71SBarry Smith   F->ops->getinertia = NULL;
26074e34a73bSHong Zhang #else
26084e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2609db4efbfdSBarry Smith #endif
2610d47f36abSHong Zhang 
2611d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
26123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2613b24902e0SBarry Smith }
2614b24902e0SBarry Smith 
261566976f2fSJacob Faibussowitsch static PetscErrorCode MatView_MUMPS(Mat A, PetscViewer viewer)
2616d71ae5a4SJacob Faibussowitsch {
261764e6c443SBarry Smith   PetscBool         iascii;
261864e6c443SBarry Smith   PetscViewerFormat format;
2619e69c285eSBarry Smith   Mat_MUMPS        *mumps = (Mat_MUMPS *)A->data;
2620f6c57405SHong Zhang 
2621f6c57405SHong Zhang   PetscFunctionBegin;
262264e6c443SBarry Smith   /* check if matrix is mumps type */
26233ba16761SJacob Faibussowitsch   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(PETSC_SUCCESS);
262464e6c443SBarry Smith 
26259566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
262664e6c443SBarry Smith   if (iascii) {
26279566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
26281511cd71SPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
26299566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "MUMPS run parameters:\n"));
26301511cd71SPierre Jolivet       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
26319566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  SYM (matrix type):                   %d\n", mumps->id.sym));
26329566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  PAR (host participation):            %d\n", mumps->id.par));
26339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(1) (output for error):         %d\n", mumps->id.ICNTL(1)));
26349566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(2) (output of diagnostic msg): %d\n", mumps->id.ICNTL(2)));
26359566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(3) (output for global info):   %d\n", mumps->id.ICNTL(3)));
26369566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(4) (level of printing):        %d\n", mumps->id.ICNTL(4)));
26379566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(5) (input mat struct):         %d\n", mumps->id.ICNTL(5)));
26389566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(6) (matrix prescaling):        %d\n", mumps->id.ICNTL(6)));
26399566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(7) (sequential matrix ordering):%d\n", mumps->id.ICNTL(7)));
26409566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(8) (scaling strategy):         %d\n", mumps->id.ICNTL(8)));
26419566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(10) (max num of refinements):  %d\n", mumps->id.ICNTL(10)));
26429566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(11) (error analysis):          %d\n", mumps->id.ICNTL(11)));
2643a5e57a09SHong Zhang         if (mumps->id.ICNTL(11) > 0) {
2644d2a308c1SPierre Jolivet           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(4) (inf norm of input mat):        %g\n", (double)mumps->id.RINFOG(4)));
2645d2a308c1SPierre Jolivet           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(5) (inf norm of solution):         %g\n", (double)mumps->id.RINFOG(5)));
2646d2a308c1SPierre Jolivet           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(6) (inf norm of residual):         %g\n", (double)mumps->id.RINFOG(6)));
2647d2a308c1SPierre Jolivet           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n", (double)mumps->id.RINFOG(7), (double)mumps->id.RINFOG(8)));
2648d2a308c1SPierre Jolivet           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(9) (error estimate):               %g\n", (double)mumps->id.RINFOG(9)));
2649d2a308c1SPierre Jolivet           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n", (double)mumps->id.RINFOG(10), (double)mumps->id.RINFOG(11)));
2650f6c57405SHong Zhang         }
26519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(12) (efficiency control):                         %d\n", mumps->id.ICNTL(12)));
26529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(13) (sequential factorization of the root node):  %d\n", mumps->id.ICNTL(13)));
26539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(14) (percentage of estimated workspace increase): %d\n", mumps->id.ICNTL(14)));
265445e3843bSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(15) (compression of the input matrix):            %d\n", mumps->id.ICNTL(15)));
2655f6c57405SHong Zhang         /* ICNTL(15-17) not used */
26569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(18) (input mat struct):                           %d\n", mumps->id.ICNTL(18)));
26579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(19) (Schur complement info):                      %d\n", mumps->id.ICNTL(19)));
26589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(20) (RHS sparse pattern):                         %d\n", mumps->id.ICNTL(20)));
26599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(21) (solution struct):                            %d\n", mumps->id.ICNTL(21)));
26609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(22) (in-core/out-of-core facility):               %d\n", mumps->id.ICNTL(22)));
26619566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(23) (max size of memory can be allocated locally):%d\n", mumps->id.ICNTL(23)));
2662c0165424SHong Zhang 
26639566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(24) (detection of null pivot rows):               %d\n", mumps->id.ICNTL(24)));
26649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(25) (computation of a null space basis):          %d\n", mumps->id.ICNTL(25)));
26659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(26) (Schur options for RHS or solution):          %d\n", mumps->id.ICNTL(26)));
26669566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(27) (blocking size for multiple RHS):             %d\n", mumps->id.ICNTL(27)));
26679566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(28) (use parallel or sequential ordering):        %d\n", mumps->id.ICNTL(28)));
26689566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(29) (parallel ordering):                          %d\n", mumps->id.ICNTL(29)));
266942179a6aSHong Zhang 
26709566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n", mumps->id.ICNTL(30)));
26719566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(31) (factors is discarded in the solve phase):    %d\n", mumps->id.ICNTL(31)));
26729566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(33) (compute determinant):                        %d\n", mumps->id.ICNTL(33)));
26739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(35) (activate BLR based factorization):           %d\n", mumps->id.ICNTL(35)));
26749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(36) (choice of BLR factorization variant):        %d\n", mumps->id.ICNTL(36)));
267550ea2040Saszaboa         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(37) (compression of the contribution blocks):     %d\n", mumps->id.ICNTL(37)));
26769566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(38) (estimated compression rate of LU factors):   %d\n", mumps->id.ICNTL(38)));
2677c92b4f89SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(48) (multithreading with tree parallelism):       %d\n", mumps->id.ICNTL(48)));
267891b026caSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(56) (postponing and rank-revealing factorization):%d\n", mumps->id.ICNTL(56)));
2679146931dbSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(58) (options for symbolic factorization):         %d\n", mumps->id.ICNTL(58)));
2680f6c57405SHong Zhang 
2681d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(1) (relative pivoting threshold):      %g\n", (double)mumps->id.CNTL(1)));
2682d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(2) (stopping criterion of refinement): %g\n", (double)mumps->id.CNTL(2)));
2683d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(3) (absolute pivoting threshold):      %g\n", (double)mumps->id.CNTL(3)));
2684d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(4) (value of static pivoting):         %g\n", (double)mumps->id.CNTL(4)));
2685d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(5) (fixation for null pivots):         %g\n", (double)mumps->id.CNTL(5)));
2686d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(7) (dropping parameter for BLR):       %g\n", (double)mumps->id.CNTL(7)));
2687f6c57405SHong Zhang 
2688a5b23f4aSJose E. Roman         /* information local to each processor */
26899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis):\n"));
26909566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushSynchronized(viewer));
2691d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, (double)mumps->id.RINFO(1)));
26929566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
26939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization):\n"));
2694d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, (double)mumps->id.RINFO(2)));
26959566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
26969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization):\n"));
2697d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, (double)mumps->id.RINFO(3)));
26989566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2699f6c57405SHong Zhang 
27009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization):\n"));
27019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(15)));
27029566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2703f6c57405SHong Zhang 
27049566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization):\n"));
27059566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(16)));
27069566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2707f6c57405SHong Zhang 
27089566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization):\n"));
27099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(23)));
27109566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2711b34f08ffSHong Zhang 
2712a0e18203SThibaut Appel         if (mumps->ninfo && mumps->ninfo <= 80) {
2713b34f08ffSHong Zhang           PetscInt i;
2714b34f08ffSHong Zhang           for (i = 0; i < mumps->ninfo; i++) {
27159566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "):\n", mumps->info[i]));
27169566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(mumps->info[i])));
27179566063dSJacob Faibussowitsch             PetscCall(PetscViewerFlush(viewer));
2718b34f08ffSHong Zhang           }
2719b34f08ffSHong Zhang         }
27209566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopSynchronized(viewer));
27211511cd71SPierre Jolivet       } else PetscCall(PetscViewerASCIIPrintf(viewer, "  Use -%sksp_view ::ascii_info_detail to display information for all processes\n", ((PetscObject)A)->prefix ? ((PetscObject)A)->prefix : ""));
2722f6c57405SHong Zhang 
27231511cd71SPierre Jolivet       if (mumps->myid == 0) { /* information from the host */
2724d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(1) (global estimated flops for the elimination after analysis): %g\n", (double)mumps->id.RINFOG(1)));
2725d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(2) (global estimated flops for the assembly after factorization): %g\n", (double)mumps->id.RINFOG(2)));
2726d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(3) (global estimated flops for the elimination after factorization): %g\n", (double)mumps->id.RINFOG(3)));
2727d2a308c1SPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  (RINFOG(12) RINFOG(13))*2^INFOG(34) (determinant): (%g,%g)*(2^%d)\n", (double)mumps->id.RINFOG(12), (double)mumps->id.RINFOG(13), mumps->id.INFOG(34)));
2728f6c57405SHong Zhang 
27299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(3)));
27309566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(4)));
27319566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(5) (estimated maximum front size in the complete tree): %d\n", mumps->id.INFOG(5)));
27329566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(6) (number of nodes in the complete tree): %d\n", mumps->id.INFOG(6)));
27339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(7) (ordering option effectively used after analysis): %d\n", mumps->id.INFOG(7)));
27349566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n", mumps->id.INFOG(8)));
27359566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n", mumps->id.INFOG(9)));
27369566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(10) (total integer space store the matrix factors after factorization): %d\n", mumps->id.INFOG(10)));
27379566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(11) (order of largest frontal matrix after factorization): %d\n", mumps->id.INFOG(11)));
27389566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(12) (number of off-diagonal pivots): %d\n", mumps->id.INFOG(12)));
27399566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(13) (number of delayed pivots after factorization): %d\n", mumps->id.INFOG(13)));
27409566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(14) (number of memory compress after factorization): %d\n", mumps->id.INFOG(14)));
27419566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(15) (number of steps of iterative refinement after solution): %d\n", mumps->id.INFOG(15)));
27429566063dSJacob 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)));
27439566063dSJacob 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)));
27449566063dSJacob 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)));
27459566063dSJacob 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)));
27469566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(20) (estimated number of entries in the factors): %d\n", mumps->id.INFOG(20)));
27479566063dSJacob 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)));
27489566063dSJacob 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)));
27499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n", mumps->id.INFOG(23)));
27509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n", mumps->id.INFOG(24)));
27519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n", mumps->id.INFOG(25)));
27529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(28) (after factorization: number of null pivots encountered): %d\n", mumps->id.INFOG(28)));
27539566063dSJacob 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)));
27549566063dSJacob 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)));
27559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(32) (after analysis: type of analysis done): %d\n", mumps->id.INFOG(32)));
27569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(33) (value used for ICNTL(8)): %d\n", mumps->id.INFOG(33)));
27579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(34) (exponent of the determinant if determinant is requested): %d\n", mumps->id.INFOG(34)));
27589566063dSJacob 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)));
27599566063dSJacob 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)));
27609566063dSJacob 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)));
27619566063dSJacob 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)));
27629566063dSJacob 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)));
2763f6c57405SHong Zhang       }
2764f6c57405SHong Zhang     }
2765cb828f0fSHong Zhang   }
27663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2767f6c57405SHong Zhang }
2768f6c57405SHong Zhang 
2769d2a308c1SPierre Jolivet static PetscErrorCode MatGetInfo_MUMPS(Mat A, PETSC_UNUSED MatInfoType flag, MatInfo *info)
2770d71ae5a4SJacob Faibussowitsch {
2771e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
277235bd34faSBarry Smith 
277335bd34faSBarry Smith   PetscFunctionBegin;
277435bd34faSBarry Smith   info->block_size        = 1.0;
277564412097SPierre Jolivet   info->nz_allocated      = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
277664412097SPierre Jolivet   info->nz_used           = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
277735bd34faSBarry Smith   info->nz_unneeded       = 0.0;
277835bd34faSBarry Smith   info->assemblies        = 0.0;
277935bd34faSBarry Smith   info->mallocs           = 0.0;
278035bd34faSBarry Smith   info->memory            = 0.0;
278135bd34faSBarry Smith   info->fill_ratio_given  = 0;
278235bd34faSBarry Smith   info->fill_ratio_needed = 0;
278335bd34faSBarry Smith   info->factor_mallocs    = 0;
27843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
278535bd34faSBarry Smith }
278635bd34faSBarry Smith 
278766976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
2788d71ae5a4SJacob Faibussowitsch {
2789e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)F->data;
2790a3d589ffSStefano Zampini   const PetscScalar *arr;
27918e7ba810SStefano Zampini   const PetscInt    *idxs;
27928e7ba810SStefano Zampini   PetscInt           size, i;
27936444a565SStefano Zampini 
27946444a565SStefano Zampini   PetscFunctionBegin;
27959566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &size));
2796b3cb21ddSStefano Zampini   /* Schur complement matrix */
27979566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
27989566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, size, size, NULL, &F->schur));
27999566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur, &arr));
2800a3d589ffSStefano Zampini   mumps->id.schur = (MumpsScalar *)arr;
28016497c311SBarry Smith   PetscCall(PetscMUMPSIntCast(size, &mumps->id.size_schur));
28026497c311SBarry Smith   PetscCall(PetscMUMPSIntCast(size, &mumps->id.schur_lld));
28039566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur, &arr));
280448a46eb9SPierre Jolivet   if (mumps->sym == 1) PetscCall(MatSetOption(F->schur, MAT_SPD, PETSC_TRUE));
2805b3cb21ddSStefano Zampini 
2806b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
28079566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
28089566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &mumps->id.listvar_schur));
28099566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &idxs));
2810f4f49eeaSPierre Jolivet   for (i = 0; i < size; i++) PetscCall(PetscMUMPSIntCast(idxs[i] + 1, &mumps->id.listvar_schur[i]));
28119566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &idxs));
281259ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2813b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
28143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28156444a565SStefano Zampini }
281659ac8732SStefano Zampini 
281766976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F, Mat *S)
2818d71ae5a4SJacob Faibussowitsch {
28196444a565SStefano Zampini   Mat          St;
2820e69c285eSBarry Smith   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
28216444a565SStefano Zampini   PetscScalar *array;
28226444a565SStefano Zampini 
28236444a565SStefano Zampini   PetscFunctionBegin;
28249261f6e4SBarry Smith   PetscCheck(mumps->id.ICNTL(19), PetscObjectComm((PetscObject)F), PETSC_ERR_ORDER, "Schur complement mode not selected! Call MatFactorSetSchurIS() to enable it");
28259566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF, &St));
28269566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St, PETSC_DECIDE, PETSC_DECIDE, mumps->id.size_schur, mumps->id.size_schur));
28279566063dSJacob Faibussowitsch   PetscCall(MatSetType(St, MATDENSE));
28289566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
28299566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St, &array));
283059ac8732SStefano Zampini   if (!mumps->sym) {                /* MUMPS always return a full matrix */
28316444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
28326444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
28336444a565SStefano Zampini       for (i = 0; i < N; i++) {
28346444a565SStefano Zampini         for (j = 0; j < N; j++) {
28356444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
28366444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
28376444a565SStefano Zampini #else
28383e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
28396444a565SStefano Zampini #endif
28406444a565SStefano Zampini           array[j * N + i] = val;
28416444a565SStefano Zampini         }
28426444a565SStefano Zampini       }
28436444a565SStefano Zampini     } else { /* stored by columns */
28449566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
28456444a565SStefano Zampini     }
28466444a565SStefano Zampini   } else {                          /* either full or lower-triangular (not packed) */
28476444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
28486444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
28496444a565SStefano Zampini       for (i = 0; i < N; i++) {
28506444a565SStefano Zampini         for (j = i; j < N; j++) {
28516444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
28526444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
28536444a565SStefano Zampini #else
28543e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
28556444a565SStefano Zampini #endif
28563e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
28576444a565SStefano Zampini         }
28586444a565SStefano Zampini       }
28596444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
28609566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
28616444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular stored by rows */
28626444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
28636444a565SStefano Zampini       for (i = 0; i < N; i++) {
28646444a565SStefano Zampini         for (j = 0; j < i + 1; j++) {
28656444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
28666444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
28676444a565SStefano Zampini #else
28683e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
28696444a565SStefano Zampini #endif
28703e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
28716444a565SStefano Zampini         }
28726444a565SStefano Zampini       }
28736444a565SStefano Zampini     }
28746444a565SStefano Zampini   }
28759566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St, &array));
28766444a565SStefano Zampini   *S = St;
28773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28786444a565SStefano Zampini }
28796444a565SStefano Zampini 
288066976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt ival)
2881d71ae5a4SJacob Faibussowitsch {
2882e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
28835ccb76cbSHong Zhang 
28845ccb76cbSHong Zhang   PetscFunctionBegin;
2885413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {                                            /* need to cache icntl and ival since PetscMUMPS_c() has never been called */
28866497c311SBarry Smith     PetscMUMPSInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0; /* number of already cached ICNTL */
28879371c9d4SSatish Balay     for (i = 0; i < nICNTL_pre; ++i)
28889371c9d4SSatish Balay       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) break; /* is this ICNTL already cached? */
2889413bcc21SPierre Jolivet     if (i == nICNTL_pre) {                             /* not already cached */
2890413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscMUMPSInt) * (2 * nICNTL_pre + 3), &mumps->ICNTL_pre));
2891413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscMUMPSInt) * 3, &mumps->ICNTL_pre));
2892413bcc21SPierre Jolivet       mumps->ICNTL_pre[0]++;
2893413bcc21SPierre Jolivet     }
28946497c311SBarry Smith     mumps->ICNTL_pre[1 + 2 * i] = (PetscMUMPSInt)icntl;
2895413bcc21SPierre Jolivet     PetscCall(PetscMUMPSIntCast(ival, mumps->ICNTL_pre + 2 + 2 * i));
2896413bcc21SPierre Jolivet   } else PetscCall(PetscMUMPSIntCast(ival, &mumps->id.ICNTL(icntl)));
28973ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28985ccb76cbSHong Zhang }
28995ccb76cbSHong Zhang 
290066976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt *ival)
2901d71ae5a4SJacob Faibussowitsch {
2902e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2903bc6112feSHong Zhang 
2904bc6112feSHong Zhang   PetscFunctionBegin;
290536df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
290636df9881Sjeremy theler     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
290736df9881Sjeremy theler     *ival = 0;
290836df9881Sjeremy theler     for (i = 0; i < nICNTL_pre; ++i) {
290936df9881Sjeremy theler       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) *ival = mumps->ICNTL_pre[2 + 2 * i];
291036df9881Sjeremy theler     }
291136df9881Sjeremy theler   } else *ival = mumps->id.ICNTL(icntl);
29123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2913bc6112feSHong Zhang }
2914bc6112feSHong Zhang 
29155ccb76cbSHong Zhang /*@
29161d27aa22SBarry Smith   MatMumpsSetIcntl - Set MUMPS parameter ICNTL() <https://mumps-solver.org/index.php?page=doc>
29175ccb76cbSHong Zhang 
2918c3339decSBarry Smith   Logically Collective
29195ccb76cbSHong Zhang 
29205ccb76cbSHong Zhang   Input Parameters:
29210b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
292279578405SBarry Smith . icntl - index of MUMPS parameter array `ICNTL()`
292379578405SBarry Smith - ival  - value of MUMPS `ICNTL(icntl)`
29245ccb76cbSHong Zhang 
29253c7db156SBarry Smith   Options Database Key:
292679578405SBarry Smith . -mat_mumps_icntl_<icntl> <ival> - change the option numbered `icntl` to `ival`
29275ccb76cbSHong Zhang 
29285ccb76cbSHong Zhang   Level: beginner
29295ccb76cbSHong Zhang 
293079578405SBarry Smith   Note:
293179578405SBarry Smith   Ignored if MUMPS is not installed or `F` is not a MUMPS matrix
293279578405SBarry Smith 
29331cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
29345ccb76cbSHong Zhang @*/
2935d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl(Mat F, PetscInt icntl, PetscInt ival)
2936d71ae5a4SJacob Faibussowitsch {
29375ccb76cbSHong Zhang   PetscFunctionBegin;
29382989dfd4SHong Zhang   PetscValidType(F, 1);
293928b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
29405ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
29415ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, ival, 3);
294291b026caSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 48 || icntl == 56 || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2943cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetIcntl_C", (Mat, PetscInt, PetscInt), (F, icntl, ival));
29443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29455ccb76cbSHong Zhang }
29465ccb76cbSHong Zhang 
2947a21f80fcSHong Zhang /*@
29481d27aa22SBarry Smith   MatMumpsGetIcntl - Get MUMPS parameter ICNTL() <https://mumps-solver.org/index.php?page=doc>
2949a21f80fcSHong Zhang 
2950c3339decSBarry Smith   Logically Collective
2951a21f80fcSHong Zhang 
2952a21f80fcSHong Zhang   Input Parameters:
29530b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
2954a21f80fcSHong Zhang - icntl - index of MUMPS parameter array ICNTL()
2955a21f80fcSHong Zhang 
2956a21f80fcSHong Zhang   Output Parameter:
2957a21f80fcSHong Zhang . ival - value of MUMPS ICNTL(icntl)
2958a21f80fcSHong Zhang 
2959a21f80fcSHong Zhang   Level: beginner
2960a21f80fcSHong Zhang 
29611cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2962a21f80fcSHong Zhang @*/
2963d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl(Mat F, PetscInt icntl, PetscInt *ival)
2964d71ae5a4SJacob Faibussowitsch {
2965bc6112feSHong Zhang   PetscFunctionBegin;
29662989dfd4SHong Zhang   PetscValidType(F, 1);
296728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2968bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
29694f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
2970c92b4f89SPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 48 || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2971cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetIcntl_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
29723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2973bc6112feSHong Zhang }
2974bc6112feSHong Zhang 
297566976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal val)
2976d71ae5a4SJacob Faibussowitsch {
2977e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
29788928b65cSHong Zhang 
29798928b65cSHong Zhang   PetscFunctionBegin;
2980413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {
2981413bcc21SPierre Jolivet     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
29829371c9d4SSatish Balay     for (i = 0; i < nCNTL_pre; ++i)
29839371c9d4SSatish Balay       if (mumps->CNTL_pre[1 + 2 * i] == icntl) break;
2984413bcc21SPierre Jolivet     if (i == nCNTL_pre) {
2985413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscReal) * (2 * nCNTL_pre + 3), &mumps->CNTL_pre));
2986413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscReal) * 3, &mumps->CNTL_pre));
2987413bcc21SPierre Jolivet       mumps->CNTL_pre[0]++;
2988413bcc21SPierre Jolivet     }
2989413bcc21SPierre Jolivet     mumps->CNTL_pre[1 + 2 * i] = icntl;
2990413bcc21SPierre Jolivet     mumps->CNTL_pre[2 + 2 * i] = val;
2991413bcc21SPierre Jolivet   } else mumps->id.CNTL(icntl) = val;
29923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29938928b65cSHong Zhang }
29948928b65cSHong Zhang 
299566976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal *val)
2996d71ae5a4SJacob Faibussowitsch {
2997e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2998bc6112feSHong Zhang 
2999bc6112feSHong Zhang   PetscFunctionBegin;
300036df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
300136df9881Sjeremy theler     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
300236df9881Sjeremy theler     *val = 0.0;
300336df9881Sjeremy theler     for (i = 0; i < nCNTL_pre; ++i) {
300436df9881Sjeremy theler       if (mumps->CNTL_pre[1 + 2 * i] == icntl) *val = mumps->CNTL_pre[2 + 2 * i];
300536df9881Sjeremy theler     }
300636df9881Sjeremy theler   } else *val = mumps->id.CNTL(icntl);
30073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3008bc6112feSHong Zhang }
3009bc6112feSHong Zhang 
30108928b65cSHong Zhang /*@
30111d27aa22SBarry Smith   MatMumpsSetCntl - Set MUMPS parameter CNTL() <https://mumps-solver.org/index.php?page=doc>
30128928b65cSHong Zhang 
3013c3339decSBarry Smith   Logically Collective
30148928b65cSHong Zhang 
30158928b65cSHong Zhang   Input Parameters:
30160b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
301779578405SBarry Smith . icntl - index of MUMPS parameter array `CNTL()`
301879578405SBarry Smith - val   - value of MUMPS `CNTL(icntl)`
30198928b65cSHong Zhang 
30203c7db156SBarry Smith   Options Database Key:
3021147403d9SBarry Smith . -mat_mumps_cntl_<icntl> <val> - change the option numbered icntl to ival
30228928b65cSHong Zhang 
30238928b65cSHong Zhang   Level: beginner
30248928b65cSHong Zhang 
302579578405SBarry Smith   Note:
302679578405SBarry Smith   Ignored if MUMPS is not installed or `F` is not a MUMPS matrix
302779578405SBarry Smith 
30281cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
30298928b65cSHong Zhang @*/
3030d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl(Mat F, PetscInt icntl, PetscReal val)
3031d71ae5a4SJacob Faibussowitsch {
30328928b65cSHong Zhang   PetscFunctionBegin;
30332989dfd4SHong Zhang   PetscValidType(F, 1);
303428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30358928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
3036bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F, val, 3);
3037413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
3038cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetCntl_C", (Mat, PetscInt, PetscReal), (F, icntl, val));
30393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30408928b65cSHong Zhang }
30418928b65cSHong Zhang 
3042a21f80fcSHong Zhang /*@
30431d27aa22SBarry Smith   MatMumpsGetCntl - Get MUMPS parameter CNTL() <https://mumps-solver.org/index.php?page=doc>
3044a21f80fcSHong Zhang 
3045c3339decSBarry Smith   Logically Collective
3046a21f80fcSHong Zhang 
3047a21f80fcSHong Zhang   Input Parameters:
30480b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
3049a21f80fcSHong Zhang - icntl - index of MUMPS parameter array CNTL()
3050a21f80fcSHong Zhang 
3051a21f80fcSHong Zhang   Output Parameter:
3052a21f80fcSHong Zhang . val - value of MUMPS CNTL(icntl)
3053a21f80fcSHong Zhang 
3054a21f80fcSHong Zhang   Level: beginner
3055a21f80fcSHong Zhang 
30561cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3057a21f80fcSHong Zhang @*/
3058d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl(Mat F, PetscInt icntl, PetscReal *val)
3059d71ae5a4SJacob Faibussowitsch {
3060bc6112feSHong Zhang   PetscFunctionBegin;
30612989dfd4SHong Zhang   PetscValidType(F, 1);
306228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
3063bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
30644f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3065413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
3066cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetCntl_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
30673ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3068bc6112feSHong Zhang }
3069bc6112feSHong Zhang 
307066976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F, PetscInt icntl, PetscInt *info)
3071d71ae5a4SJacob Faibussowitsch {
3072e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
3073bc6112feSHong Zhang 
3074bc6112feSHong Zhang   PetscFunctionBegin;
3075bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
30763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3077bc6112feSHong Zhang }
3078bc6112feSHong Zhang 
307966976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F, PetscInt icntl, PetscInt *infog)
3080d71ae5a4SJacob Faibussowitsch {
3081e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
3082bc6112feSHong Zhang 
3083bc6112feSHong Zhang   PetscFunctionBegin;
3084bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
30853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3086bc6112feSHong Zhang }
3087bc6112feSHong Zhang 
308866976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfo)
3089d71ae5a4SJacob Faibussowitsch {
3090e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
3091bc6112feSHong Zhang 
3092bc6112feSHong Zhang   PetscFunctionBegin;
3093bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
30943ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3095bc6112feSHong Zhang }
3096bc6112feSHong Zhang 
309766976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfog)
3098d71ae5a4SJacob Faibussowitsch {
3099e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
3100bc6112feSHong Zhang 
3101bc6112feSHong Zhang   PetscFunctionBegin;
3102bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
31033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3104bc6112feSHong Zhang }
3105bc6112feSHong Zhang 
310666976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetNullPivots_MUMPS(Mat F, PetscInt *size, PetscInt **array)
31075c0bae8cSAshish Patel {
31085c0bae8cSAshish Patel   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
31095c0bae8cSAshish Patel 
31105c0bae8cSAshish Patel   PetscFunctionBegin;
31115c0bae8cSAshish 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");
31125c0bae8cSAshish Patel   *size  = 0;
31135c0bae8cSAshish Patel   *array = NULL;
31145c0bae8cSAshish Patel   if (!mumps->myid) {
31155c0bae8cSAshish Patel     *size = mumps->id.INFOG(28);
31165c0bae8cSAshish Patel     PetscCall(PetscMalloc1(*size, array));
31175c0bae8cSAshish Patel     for (int i = 0; i < *size; i++) (*array)[i] = mumps->id.pivnul_list[i] - 1;
31185c0bae8cSAshish Patel   }
31195c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
31205c0bae8cSAshish Patel }
31215c0bae8cSAshish Patel 
312266976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F, Mat spRHS)
3123d71ae5a4SJacob Faibussowitsch {
31240e6b8875SHong Zhang   Mat          Bt = NULL, Btseq = NULL;
31250e6b8875SHong Zhang   PetscBool    flg;
3126bb599dfdSHong Zhang   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
3127bb599dfdSHong Zhang   PetscScalar *aa;
3128f410b75aSHong Zhang   PetscInt     spnr, *ia, *ja, M, nrhs;
3129bb599dfdSHong Zhang 
3130bb599dfdSHong Zhang   PetscFunctionBegin;
31314f572ea9SToby Isaac   PetscAssertPointer(spRHS, 2);
3132013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS, MATTRANSPOSEVIRTUAL, &flg));
313353587d93SPierre Jolivet   PetscCheck(flg, PetscObjectComm((PetscObject)spRHS), PETSC_ERR_ARG_WRONG, "Matrix spRHS must be type MATTRANSPOSEVIRTUAL matrix");
313453587d93SPierre Jolivet   PetscCall(MatShellGetScalingShifts(spRHS, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (PetscScalar *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Vec *)MAT_SHELL_NOT_ALLOWED, (Mat *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED, (IS *)MAT_SHELL_NOT_ALLOWED));
31359566063dSJacob Faibussowitsch   PetscCall(MatTransposeGetMat(spRHS, &Bt));
3136bb599dfdSHong Zhang 
31379566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F, 30, 1));
3138bb599dfdSHong Zhang 
31392d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
31400e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ *)Bt->data;
31410e6b8875SHong Zhang     Btseq         = b->A;
31420e6b8875SHong Zhang   } else {
31430e6b8875SHong Zhang     Btseq = Bt;
31440e6b8875SHong Zhang   }
31450e6b8875SHong Zhang 
31469566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS, &M, &nrhs));
31476497c311SBarry Smith   mumps->id.nrhs = (PetscMUMPSInt)nrhs;
31486497c311SBarry Smith   PetscCall(PetscMUMPSIntCast(M, &mumps->id.lrhs));
3149f410b75aSHong Zhang   mumps->id.rhs = NULL;
3150f410b75aSHong Zhang 
3151e3f2db6aSHong Zhang   if (!mumps->myid) {
31529566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq, &aa));
31539566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
315428b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
31559566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
3156bb599dfdSHong Zhang     mumps->id.rhs_sparse = (MumpsScalar *)aa;
3157e3f2db6aSHong Zhang   } else {
3158e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
3159e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
3160e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
3161e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
3162e3f2db6aSHong Zhang   }
3163bb599dfdSHong Zhang   mumps->id.ICNTL(20) = 1; /* rhs is sparse */
3164e3f2db6aSHong Zhang   mumps->id.ICNTL(21) = 0; /* solution is in assembled centralized format */
3165bb599dfdSHong Zhang 
3166bb599dfdSHong Zhang   /* solve phase */
3167bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
31683ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
31699261f6e4SBarry 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));
317014267174SHong Zhang 
3171e3f2db6aSHong Zhang   if (!mumps->myid) {
31729566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq, &aa));
31739566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
317428b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
3175e3f2db6aSHong Zhang   }
31763ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3177bb599dfdSHong Zhang }
3178bb599dfdSHong Zhang 
3179bb599dfdSHong Zhang /*@
31801d27aa22SBarry Smith   MatMumpsGetInverse - Get user-specified set of entries in inverse of `A` <https://mumps-solver.org/index.php?page=doc>
3181bb599dfdSHong Zhang 
3182c3339decSBarry Smith   Logically Collective
3183bb599dfdSHong Zhang 
318420f4b53cSBarry Smith   Input Parameter:
31850b4b7b1cSBarry Smith . F - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
3186bb599dfdSHong Zhang 
3187bb599dfdSHong Zhang   Output Parameter:
318820f4b53cSBarry Smith . spRHS - sequential sparse matrix in `MATTRANSPOSEVIRTUAL` format with requested entries of inverse of `A`
3189bb599dfdSHong Zhang 
3190bb599dfdSHong Zhang   Level: beginner
3191bb599dfdSHong Zhang 
31921cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`
3193bb599dfdSHong Zhang @*/
3194d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse(Mat F, Mat spRHS)
3195d71ae5a4SJacob Faibussowitsch {
3196bb599dfdSHong Zhang   PetscFunctionBegin;
3197bb599dfdSHong Zhang   PetscValidType(F, 1);
319828b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
3199cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverse_C", (Mat, Mat), (F, spRHS));
32003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3201bb599dfdSHong Zhang }
3202bb599dfdSHong Zhang 
320366976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F, Mat spRHST)
3204d71ae5a4SJacob Faibussowitsch {
32050e6b8875SHong Zhang   Mat spRHS;
32060e6b8875SHong Zhang 
32070e6b8875SHong Zhang   PetscFunctionBegin;
32089566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST, &spRHS));
32099566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F, spRHS));
32109566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
32113ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32120e6b8875SHong Zhang }
32130e6b8875SHong Zhang 
32140e6b8875SHong Zhang /*@
32151d27aa22SBarry Smith   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix $A^T $ <https://mumps-solver.org/index.php?page=doc>
32160e6b8875SHong Zhang 
3217c3339decSBarry Smith   Logically Collective
32180e6b8875SHong Zhang 
321920f4b53cSBarry Smith   Input Parameter:
32200b4b7b1cSBarry Smith . F - the factored matrix of A obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
32210e6b8875SHong Zhang 
32220e6b8875SHong Zhang   Output Parameter:
322320f4b53cSBarry Smith . spRHST - sequential sparse matrix in `MATAIJ` format containing the requested entries of inverse of `A`^T
32240e6b8875SHong Zhang 
32250e6b8875SHong Zhang   Level: beginner
32260e6b8875SHong Zhang 
32271cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
32280e6b8875SHong Zhang @*/
3229d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose(Mat F, Mat spRHST)
3230d71ae5a4SJacob Faibussowitsch {
32310e6b8875SHong Zhang   PetscBool flg;
32320e6b8875SHong Zhang 
32330e6b8875SHong Zhang   PetscFunctionBegin;
32340e6b8875SHong Zhang   PetscValidType(F, 1);
323528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
32369566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
323728b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)spRHST), PETSC_ERR_ARG_WRONG, "Matrix spRHST must be MATAIJ matrix");
3238cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverseTranspose_C", (Mat, Mat), (F, spRHST));
32393ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
32400e6b8875SHong Zhang }
32410e6b8875SHong Zhang 
324293d70b8aSPierre Jolivet static PetscErrorCode MatMumpsSetBlk_MUMPS(Mat F, PetscInt nblk, const PetscInt blkvar[], const PetscInt blkptr[])
324393d70b8aSPierre Jolivet {
324493d70b8aSPierre Jolivet   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
324593d70b8aSPierre Jolivet 
324693d70b8aSPierre Jolivet   PetscFunctionBegin;
324793d70b8aSPierre Jolivet   if (nblk) {
324893d70b8aSPierre Jolivet     PetscAssertPointer(blkptr, 4);
324993d70b8aSPierre Jolivet     PetscCall(PetscMUMPSIntCast(nblk, &mumps->id.nblk));
325093d70b8aSPierre Jolivet     PetscCall(PetscFree(mumps->id.blkptr));
325193d70b8aSPierre Jolivet     PetscCall(PetscMalloc1(nblk + 1, &mumps->id.blkptr));
325293d70b8aSPierre Jolivet     for (PetscInt i = 0; i < nblk + 1; ++i) PetscCall(PetscMUMPSIntCast(blkptr[i], mumps->id.blkptr + i));
325393d70b8aSPierre Jolivet     mumps->id.ICNTL(15) = 1;
325493d70b8aSPierre Jolivet     if (blkvar) {
325593d70b8aSPierre Jolivet       PetscCall(PetscFree(mumps->id.blkvar));
325693d70b8aSPierre Jolivet       PetscCall(PetscMalloc1(F->rmap->N, &mumps->id.blkvar));
325793d70b8aSPierre Jolivet       for (PetscInt i = 0; i < F->rmap->N; ++i) PetscCall(PetscMUMPSIntCast(blkvar[i], mumps->id.blkvar + i));
325893d70b8aSPierre Jolivet     }
325993d70b8aSPierre Jolivet   } else {
326093d70b8aSPierre Jolivet     PetscCall(PetscFree(mumps->id.blkptr));
326193d70b8aSPierre Jolivet     PetscCall(PetscFree(mumps->id.blkvar));
326293d70b8aSPierre Jolivet     mumps->id.ICNTL(15) = 0;
326393d70b8aSPierre Jolivet   }
326493d70b8aSPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
326593d70b8aSPierre Jolivet }
326693d70b8aSPierre Jolivet 
326793d70b8aSPierre Jolivet /*@
326893d70b8aSPierre Jolivet   MatMumpsSetBlk - Set user-specified variable block sizes to be used with `-mat_mumps_icntl_15 1`
326993d70b8aSPierre Jolivet 
327093d70b8aSPierre Jolivet   Not collective, only relevant on the first process of the MPI communicator
327193d70b8aSPierre Jolivet 
327293d70b8aSPierre Jolivet   Input Parameters:
327393d70b8aSPierre Jolivet + F      - the factored matrix of A obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
327493d70b8aSPierre Jolivet . nblk   - the number of blocks
327593d70b8aSPierre Jolivet . blkvar - see MUMPS documentation, `blkvar(blkptr(iblk):blkptr(iblk+1)-1)`, (`iblk=1, nblk`) holds the variables associated to block `iblk`
327693d70b8aSPierre Jolivet - blkptr - array starting at 1 and of size `nblk + 1` storing the prefix sum of all blocks
327793d70b8aSPierre Jolivet 
327893d70b8aSPierre Jolivet   Level: advanced
327993d70b8aSPierre Jolivet 
328093d70b8aSPierre Jolivet .seealso: [](ch_matrices), `MATSOLVERMUMPS`, `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatSetVariableBlockSizes()`
328193d70b8aSPierre Jolivet @*/
328293d70b8aSPierre Jolivet PetscErrorCode MatMumpsSetBlk(Mat F, PetscInt nblk, const PetscInt blkvar[], const PetscInt blkptr[])
328393d70b8aSPierre Jolivet {
328493d70b8aSPierre Jolivet   PetscFunctionBegin;
328593d70b8aSPierre Jolivet   PetscValidType(F, 1);
328693d70b8aSPierre Jolivet   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
328793d70b8aSPierre Jolivet   PetscUseMethod(F, "MatMumpsSetBlk_C", (Mat, PetscInt, const PetscInt[], const PetscInt[]), (F, nblk, blkvar, blkptr));
328893d70b8aSPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
328993d70b8aSPierre Jolivet }
329093d70b8aSPierre Jolivet 
3291a21f80fcSHong Zhang /*@
32921d27aa22SBarry Smith   MatMumpsGetInfo - Get MUMPS parameter INFO() <https://mumps-solver.org/index.php?page=doc>
3293a21f80fcSHong Zhang 
3294c3339decSBarry Smith   Logically Collective
3295a21f80fcSHong Zhang 
3296a21f80fcSHong Zhang   Input Parameters:
32970b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
3298a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFO()
3299a21f80fcSHong Zhang 
3300a21f80fcSHong Zhang   Output Parameter:
3301a21f80fcSHong Zhang . ival - value of MUMPS INFO(icntl)
3302a21f80fcSHong Zhang 
3303a21f80fcSHong Zhang   Level: beginner
3304a21f80fcSHong Zhang 
33051cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3306a21f80fcSHong Zhang @*/
3307d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo(Mat F, PetscInt icntl, PetscInt *ival)
3308d71ae5a4SJacob Faibussowitsch {
3309bc6112feSHong Zhang   PetscFunctionBegin;
33102989dfd4SHong Zhang   PetscValidType(F, 1);
331128b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
33124f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3313cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfo_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
33143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3315bc6112feSHong Zhang }
3316bc6112feSHong Zhang 
3317a21f80fcSHong Zhang /*@
33181d27aa22SBarry Smith   MatMumpsGetInfog - Get MUMPS parameter INFOG() <https://mumps-solver.org/index.php?page=doc>
3319a21f80fcSHong Zhang 
3320c3339decSBarry Smith   Logically Collective
3321a21f80fcSHong Zhang 
3322a21f80fcSHong Zhang   Input Parameters:
33230b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
3324a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFOG()
3325a21f80fcSHong Zhang 
3326a21f80fcSHong Zhang   Output Parameter:
3327a21f80fcSHong Zhang . ival - value of MUMPS INFOG(icntl)
3328a21f80fcSHong Zhang 
3329a21f80fcSHong Zhang   Level: beginner
3330a21f80fcSHong Zhang 
33311cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3332a21f80fcSHong Zhang @*/
3333d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog(Mat F, PetscInt icntl, PetscInt *ival)
3334d71ae5a4SJacob Faibussowitsch {
3335bc6112feSHong Zhang   PetscFunctionBegin;
33362989dfd4SHong Zhang   PetscValidType(F, 1);
333728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
33384f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3339cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfog_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
33403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3341bc6112feSHong Zhang }
3342bc6112feSHong Zhang 
3343a21f80fcSHong Zhang /*@
33441d27aa22SBarry Smith   MatMumpsGetRinfo - Get MUMPS parameter RINFO() <https://mumps-solver.org/index.php?page=doc>
3345a21f80fcSHong Zhang 
3346c3339decSBarry Smith   Logically Collective
3347a21f80fcSHong Zhang 
3348a21f80fcSHong Zhang   Input Parameters:
33490b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
3350a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFO()
3351a21f80fcSHong Zhang 
3352a21f80fcSHong Zhang   Output Parameter:
3353a21f80fcSHong Zhang . val - value of MUMPS RINFO(icntl)
3354a21f80fcSHong Zhang 
3355a21f80fcSHong Zhang   Level: beginner
3356a21f80fcSHong Zhang 
33571cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
3358a21f80fcSHong Zhang @*/
3359d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo(Mat F, PetscInt icntl, PetscReal *val)
3360d71ae5a4SJacob Faibussowitsch {
3361bc6112feSHong Zhang   PetscFunctionBegin;
33622989dfd4SHong Zhang   PetscValidType(F, 1);
336328b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
33644f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3365cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfo_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
33663ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3367bc6112feSHong Zhang }
3368bc6112feSHong Zhang 
3369a21f80fcSHong Zhang /*@
33701d27aa22SBarry Smith   MatMumpsGetRinfog - Get MUMPS parameter RINFOG() <https://mumps-solver.org/index.php?page=doc>
3371a21f80fcSHong Zhang 
3372c3339decSBarry Smith   Logically Collective
3373a21f80fcSHong Zhang 
3374a21f80fcSHong Zhang   Input Parameters:
33750b4b7b1cSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
3376a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFOG()
3377a21f80fcSHong Zhang 
3378a21f80fcSHong Zhang   Output Parameter:
3379a21f80fcSHong Zhang . val - value of MUMPS RINFOG(icntl)
3380a21f80fcSHong Zhang 
3381a21f80fcSHong Zhang   Level: beginner
3382a21f80fcSHong Zhang 
33831cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
3384a21f80fcSHong Zhang @*/
3385d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog(Mat F, PetscInt icntl, PetscReal *val)
3386d71ae5a4SJacob Faibussowitsch {
3387bc6112feSHong Zhang   PetscFunctionBegin;
33882989dfd4SHong Zhang   PetscValidType(F, 1);
338928b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
33904f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3391cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfog_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
33923ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3393bc6112feSHong Zhang }
3394bc6112feSHong Zhang 
33955c0bae8cSAshish Patel /*@
33961d27aa22SBarry Smith   MatMumpsGetNullPivots - Get MUMPS parameter PIVNUL_LIST() <https://mumps-solver.org/index.php?page=doc>
33975c0bae8cSAshish Patel 
33985c0bae8cSAshish Patel   Logically Collective
33995c0bae8cSAshish Patel 
34005c0bae8cSAshish Patel   Input Parameter:
34010b4b7b1cSBarry Smith . F - the factored matrix obtained by calling `MatGetFactor()` with a `MatSolverType` of `MATSOLVERMUMPS` and a `MatFactorType` of `MAT_FACTOR_LU` or `MAT_FACTOR_CHOLESKY`
34025c0bae8cSAshish Patel 
34035c0bae8cSAshish Patel   Output Parameters:
34040b4b7b1cSBarry Smith + size  - local size of the array. The size of the array is non-zero only on MPI rank 0
34055c0bae8cSAshish 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
34065c0bae8cSAshish Patel           for freeing this array.
34075c0bae8cSAshish Patel 
34085c0bae8cSAshish Patel   Level: beginner
34095c0bae8cSAshish Patel 
34101cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
34115c0bae8cSAshish Patel @*/
34125c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots(Mat F, PetscInt *size, PetscInt **array)
34135c0bae8cSAshish Patel {
34145c0bae8cSAshish Patel   PetscFunctionBegin;
34155c0bae8cSAshish Patel   PetscValidType(F, 1);
34165c0bae8cSAshish Patel   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
34174f572ea9SToby Isaac   PetscAssertPointer(size, 2);
34184f572ea9SToby Isaac   PetscAssertPointer(array, 3);
34195c0bae8cSAshish Patel   PetscUseMethod(F, "MatMumpsGetNullPivots_C", (Mat, PetscInt *, PetscInt **), (F, size, array));
34205c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
34215c0bae8cSAshish Patel }
34225c0bae8cSAshish Patel 
342324b6179bSKris Buschelman /*MC
34242692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
34250b4b7b1cSBarry Smith   MPI distributed and sequential matrices via the external package MUMPS <https://mumps-solver.org/index.php?page=doc>
342624b6179bSKris Buschelman 
342711a5261eSBarry Smith   Works with `MATAIJ` and `MATSBAIJ` matrices
342824b6179bSKris Buschelman 
3429c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
3430c2b89b5dSBarry Smith 
34312ef1f0ffSBarry 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.
34322ef1f0ffSBarry Smith   See details below.
3433217d3b1eSJunchao Zhang 
34342ef1f0ffSBarry Smith   Use `-pc_type cholesky` or `lu` `-pc_factor_mat_solver_type mumps` to use this direct solver
3435c2b89b5dSBarry Smith 
343624b6179bSKris Buschelman   Options Database Keys:
34374422a9fcSPatrick Sanan +  -mat_mumps_icntl_1  - ICNTL(1): output stream for error messages
34384422a9fcSPatrick Sanan .  -mat_mumps_icntl_2  - ICNTL(2): output stream for diagnostic printing, statistics, and warning
34394422a9fcSPatrick Sanan .  -mat_mumps_icntl_3  - ICNTL(3): output stream for global information, collected on the host
34404422a9fcSPatrick Sanan .  -mat_mumps_icntl_4  - ICNTL(4): level of printing (0 to 4)
34414422a9fcSPatrick Sanan .  -mat_mumps_icntl_6  - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
3442b53c1a7fSBarry 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
3443b53c1a7fSBarry Smith                           Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
34444422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
34454422a9fcSPatrick Sanan .  -mat_mumps_icntl_10 - ICNTL(10): max num of refinements
34464422a9fcSPatrick Sanan .  -mat_mumps_icntl_11 - ICNTL(11): statistics related to an error analysis (via -ksp_view)
34474422a9fcSPatrick Sanan .  -mat_mumps_icntl_12 - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
34484422a9fcSPatrick Sanan .  -mat_mumps_icntl_13 - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
34494422a9fcSPatrick Sanan .  -mat_mumps_icntl_14 - ICNTL(14): percentage increase in the estimated working space
345045e3843bSPierre Jolivet .  -mat_mumps_icntl_15 - ICNTL(15): compression of the input matrix resulting from a block format
34514422a9fcSPatrick Sanan .  -mat_mumps_icntl_19 - ICNTL(19): computes the Schur complement
345225aac85cSJunchao Zhang .  -mat_mumps_icntl_20 - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
34534422a9fcSPatrick Sanan .  -mat_mumps_icntl_22 - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
34544422a9fcSPatrick Sanan .  -mat_mumps_icntl_23 - ICNTL(23): max size of the working memory (MB) that can allocate per processor
34554422a9fcSPatrick Sanan .  -mat_mumps_icntl_24 - ICNTL(24): detection of null pivot rows (0 or 1)
34564422a9fcSPatrick Sanan .  -mat_mumps_icntl_25 - ICNTL(25): compute a solution of a deficient matrix and a null space basis
34574422a9fcSPatrick Sanan .  -mat_mumps_icntl_26 - ICNTL(26): drives the solution phase if a Schur complement matrix
3458fa6fd9d0SPierre Jolivet .  -mat_mumps_icntl_28 - ICNTL(28): use 1 for sequential analysis and ICNTL(7) ordering, or 2 for parallel analysis and ICNTL(29) ordering
34594422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
34604422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
34614422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
34624422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
3463a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
3464a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
346550ea2040Saszaboa .  -mat_mumps_icntl_37 - ICNTL(37): compression of the contribution blocks (CB)
3466a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
3467c92b4f89SPierre Jolivet .  -mat_mumps_icntl_48 - ICNTL(48): multithreading with tree parallelism
3468146931dbSPierre Jolivet .  -mat_mumps_icntl_58 - ICNTL(58): options for symbolic factorization
34694422a9fcSPatrick Sanan .  -mat_mumps_cntl_1   - CNTL(1): relative pivoting threshold
34704422a9fcSPatrick Sanan .  -mat_mumps_cntl_2   - CNTL(2): stopping criterion of refinement
34714422a9fcSPatrick Sanan .  -mat_mumps_cntl_3   - CNTL(3): absolute pivoting threshold
34724422a9fcSPatrick Sanan .  -mat_mumps_cntl_4   - CNTL(4): value for static pivoting
3473217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5   - CNTL(5): fixation for null pivots
3474a0e18203SThibaut Appel .  -mat_mumps_cntl_7   - CNTL(7): precision of the dropping parameter used during BLR factorization
3475217d3b1eSJunchao 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.
3476217d3b1eSJunchao Zhang                                     Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
347724b6179bSKris Buschelman 
347824b6179bSKris Buschelman   Level: beginner
347924b6179bSKris Buschelman 
348095452b02SPatrick Sanan   Notes:
34811d27aa22SBarry 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
34822ef1f0ffSBarry Smith   error if the matrix is Hermitian.
348338548759SBarry Smith 
348426cc229bSBarry 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
348526cc229bSBarry Smith   `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
348626cc229bSBarry Smith 
34872ef1f0ffSBarry 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
34882ef1f0ffSBarry Smith   the failure with
34892ef1f0ffSBarry Smith .vb
34902ef1f0ffSBarry Smith           KSPGetPC(ksp,&pc);
34912ef1f0ffSBarry Smith           PCFactorGetMatrix(pc,&mat);
34922ef1f0ffSBarry Smith           MatMumpsGetInfo(mat,....);
34932ef1f0ffSBarry Smith           MatMumpsGetInfog(mat,....); etc.
34942ef1f0ffSBarry Smith .ve
34952ef1f0ffSBarry Smith   Or run with `-ksp_error_if_not_converged` and the program will be stopped and the information printed in the error message.
34969fc87aa7SBarry Smith 
3497a5399872SJunchao Zhang   MUMPS provides 64-bit integer support in two build modes:
3498a5399872SJunchao Zhang   full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
3499a5399872SJunchao 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).
35008fcaa860SBarry Smith 
3501a5399872SJunchao 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,
3502a5399872SJunchao 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
3503a5399872SJunchao 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
3504a5399872SJunchao Zhang   integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
3505a5399872SJunchao Zhang 
3506a5399872SJunchao 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.
3507a5399872SJunchao Zhang 
3508a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
35092ef1f0ffSBarry Smith .vb
35100b4b7b1cSBarry Smith    Set `OMP_NUM_THREADS` and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
35110b4b7b1cSBarry Smith    threads per rank, then you may use "export `OMP_NUM_THREADS` = 16 && mpirun -n 4 ./test".
35122ef1f0ffSBarry Smith .ve
35138fcaa860SBarry Smith 
35142ef1f0ffSBarry Smith .vb
35150b4b7b1cSBarry Smith    `-mat_mumps_use_omp_threads` [m] and run your code with as many MPI ranks as the number of cores. For example,
35162ef1f0ffSBarry 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"
35172ef1f0ffSBarry Smith .ve
35188fcaa860SBarry Smith 
35198fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
35202ef1f0ffSBarry 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`
35212ef1f0ffSBarry 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
35228fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
35230b4b7b1cSBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if `--with-openmp` is provided).
3524217d3b1eSJunchao Zhang 
35258fcaa860SBarry 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
3526217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
3527217d3b1eSJunchao 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
3528217d3b1eSJunchao 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
3529217d3b1eSJunchao 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.
3530217d3b1eSJunchao 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,
3531217d3b1eSJunchao 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
35320b4b7b1cSBarry Smith    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
3533217d3b1eSJunchao 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
35340b4b7b1cSBarry Smith    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.
35350b4b7b1cSBarry 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
3536217d3b1eSJunchao Zhang    examine the mapping result.
3537217d3b1eSJunchao Zhang 
353811a5261eSBarry 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,
353911a5261eSBarry 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
354011a5261eSBarry Smith    calls `omp_set_num_threads`(m) internally before calling MUMPS.
3541217d3b1eSJunchao Zhang 
35421d27aa22SBarry Smith    See {cite}`heroux2011bi` and {cite}`gutierrez2017accommodating`
3543217d3b1eSJunchao Zhang 
354493d70b8aSPierre Jolivet .seealso: [](ch_matrices), `Mat`, `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `MatMumpsSetBlk()`, `KSPGetPC()`, `PCFactorGetMatrix()`
354524b6179bSKris Buschelman M*/
354624b6179bSKris Buschelman 
3547d2a308c1SPierre Jolivet static PetscErrorCode MatFactorGetSolverType_mumps(PETSC_UNUSED Mat A, MatSolverType *type)
3548d71ae5a4SJacob Faibussowitsch {
354935bd34faSBarry Smith   PetscFunctionBegin;
35502692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
35513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
355235bd34faSBarry Smith }
355335bd34faSBarry Smith 
3554bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
3555d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_aij_mumps(Mat A, MatFactorType ftype, Mat *F)
3556d71ae5a4SJacob Faibussowitsch {
35572877fffaSHong Zhang   Mat         B;
35582877fffaSHong Zhang   Mat_MUMPS  *mumps;
35594b9405b2SPierre Jolivet   PetscBool   isSeqAIJ, isDiag, isDense;
35602c7c0729SBarry Smith   PetscMPIInt size;
35612877fffaSHong Zhang 
35622877fffaSHong Zhang   PetscFunctionBegin;
3563eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
356403e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
356503e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
356603e5aca4SStefano Zampini     *F = NULL;
356703e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
356803e5aca4SStefano Zampini   }
3569eb1ec7c1SStefano Zampini #endif
35702877fffaSHong Zhang   /* Create the factorization matrix */
35719566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATSEQAIJ, &isSeqAIJ));
3572c3e1b152SPierre Jolivet   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATDIAGONAL, &isDiag));
35734b9405b2SPierre Jolivet   PetscCall(PetscObjectTypeCompareAny((PetscObject)A, &isDense, MATSEQDENSE, MATMPIDENSE, NULL));
35749566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35759566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
3576d2a308c1SPierre Jolivet   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
35779566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
35782877fffaSHong Zhang 
35794dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
35802205254eSKarl Rupp 
35812877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
358235bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
35832205254eSKarl Rupp 
35849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
35889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
35899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
35909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
35919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
35929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
35939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
35949566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
35955c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
35969566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
35979566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
359893d70b8aSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetBlk_C", MatMumpsSetBlk_MUMPS));
35996444a565SStefano Zampini 
3600450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3601450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3602d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3603bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3604c3e1b152SPierre Jolivet     else if (isDiag) mumps->ConvertToTriples = MatConvertToTriples_diagonal_xaij;
36054b9405b2SPierre Jolivet     else if (isDense) mumps->ConvertToTriples = MatConvertToTriples_dense_xaij;
3606bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
36079566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3608746480a1SHong Zhang     mumps->sym = 0;
3609dcd589f8SShri Abhyankar   } else {
361067877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3611450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3612bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3613c3e1b152SPierre Jolivet     else if (isDiag) mumps->ConvertToTriples = MatConvertToTriples_diagonal_xaij;
36144b9405b2SPierre Jolivet     else if (isDense) mumps->ConvertToTriples = MatConvertToTriples_dense_xaij;
3615bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
36169566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
361759ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
361859ac8732SStefano Zampini     mumps->sym = 2;
361959ac8732SStefano Zampini #else
3620b94d7dedSBarry Smith     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
36216fdc2a6dSBarry Smith     else mumps->sym = 2;
362259ac8732SStefano Zampini #endif
3623450b117fSShri Abhyankar   }
36242877fffaSHong Zhang 
362500c67f3bSHong Zhang   /* set solvertype */
36269566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
36279566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
36289566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
36292c7c0729SBarry Smith   if (size == 1) {
36304ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3631f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
36322c7c0729SBarry Smith   }
36332877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3634e69c285eSBarry Smith   B->data         = (void *)mumps;
36352205254eSKarl Rupp 
36362877fffaSHong Zhang   *F               = B;
3637413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3638413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3639413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3640d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
36413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
36422877fffaSHong Zhang }
36432877fffaSHong Zhang 
3644bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3645d2a308c1SPierre Jolivet static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A, PETSC_UNUSED MatFactorType ftype, Mat *F)
3646d71ae5a4SJacob Faibussowitsch {
36472877fffaSHong Zhang   Mat         B;
36482877fffaSHong Zhang   Mat_MUMPS  *mumps;
3649ace3abfcSBarry Smith   PetscBool   isSeqSBAIJ;
36502c7c0729SBarry Smith   PetscMPIInt size;
36512877fffaSHong Zhang 
36522877fffaSHong Zhang   PetscFunctionBegin;
3653eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
365403e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
365503e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
365603e5aca4SStefano Zampini     *F = NULL;
365703e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
365803e5aca4SStefano Zampini   }
3659eb1ec7c1SStefano Zampini #endif
36609566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
36619566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
3662d2a308c1SPierre Jolivet   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
36639566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3664e69c285eSBarry Smith 
36654dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
36669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSBAIJ, &isSeqSBAIJ));
3667bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
366816ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3669dcd589f8SShri Abhyankar   } else {
3670bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3671bccb9932SShri Abhyankar   }
3672bccb9932SShri Abhyankar 
367367877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3674bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3675722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
36762205254eSKarl Rupp 
36779566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
36789566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
36799566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
36809566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
36819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
36829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
36839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
36849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
36859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
36869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
36879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
36885c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
36899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
36909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
369193d70b8aSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetBlk_C", MatMumpsSetBlk_MUMPS));
36922205254eSKarl Rupp 
3693f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
369459ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
369559ac8732SStefano Zampini   mumps->sym = 2;
369659ac8732SStefano Zampini #else
3697b94d7dedSBarry Smith   if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
36986fdc2a6dSBarry Smith   else mumps->sym = 2;
369959ac8732SStefano Zampini #endif
3700a214ac2aSShri Abhyankar 
370100c67f3bSHong Zhang   /* set solvertype */
37029566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
37039566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
37049566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
37052c7c0729SBarry Smith   if (size == 1) {
37064ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3707f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
37082c7c0729SBarry Smith   }
37099566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3710f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3711e69c285eSBarry Smith   B->data         = (void *)mumps;
37122205254eSKarl Rupp 
37132877fffaSHong Zhang   *F               = B;
3714413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3715413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3716413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3717d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
37183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
37192877fffaSHong Zhang }
372097969023SHong Zhang 
3721d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_baij_mumps(Mat A, MatFactorType ftype, Mat *F)
3722d71ae5a4SJacob Faibussowitsch {
372367877ebaSShri Abhyankar   Mat         B;
372467877ebaSShri Abhyankar   Mat_MUMPS  *mumps;
3725ace3abfcSBarry Smith   PetscBool   isSeqBAIJ;
37262c7c0729SBarry Smith   PetscMPIInt size;
372767877ebaSShri Abhyankar 
372867877ebaSShri Abhyankar   PetscFunctionBegin;
372967877ebaSShri Abhyankar   /* Create the factorization matrix */
37309566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQBAIJ, &isSeqBAIJ));
37319566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
37329566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
3733d2a308c1SPierre Jolivet   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
37349566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3735450b117fSShri Abhyankar 
37364dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
3737450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3738450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3739450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3740bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3741bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3742746480a1SHong Zhang     mumps->sym = 0;
37439566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3744546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3745bccb9932SShri Abhyankar 
3746450b117fSShri Abhyankar   B->ops->view    = MatView_MUMPS;
3747722b6324SPierre Jolivet   B->ops->getinfo = MatGetInfo_MUMPS;
37482205254eSKarl Rupp 
37499566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
37509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
37519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
37529566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
37539566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
37549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
37559566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
37569566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
37579566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
37589566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
37599566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
37605c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
37619566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
37629566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
376393d70b8aSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetBlk_C", MatMumpsSetBlk_MUMPS));
3764450b117fSShri Abhyankar 
376500c67f3bSHong Zhang   /* set solvertype */
37669566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
37679566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
37689566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
37692c7c0729SBarry Smith   if (size == 1) {
37704ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3771f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
37722c7c0729SBarry Smith   }
37737ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
37747ee00b23SStefano Zampini   B->data         = (void *)mumps;
37757ee00b23SStefano Zampini 
37767ee00b23SStefano Zampini   *F               = B;
3777413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3778413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3779413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3780d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
37813ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
37827ee00b23SStefano Zampini }
37837ee00b23SStefano Zampini 
37847ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
3785d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sell_mumps(Mat A, MatFactorType ftype, Mat *F)
3786d71ae5a4SJacob Faibussowitsch {
37877ee00b23SStefano Zampini   Mat         B;
37887ee00b23SStefano Zampini   Mat_MUMPS  *mumps;
37897ee00b23SStefano Zampini   PetscBool   isSeqSELL;
37902c7c0729SBarry Smith   PetscMPIInt size;
37917ee00b23SStefano Zampini 
37927ee00b23SStefano Zampini   PetscFunctionBegin;
37937ee00b23SStefano Zampini   /* Create the factorization matrix */
37949566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSELL, &isSeqSELL));
37959566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
37969566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
3797d2a308c1SPierre Jolivet   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
37989566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
37997ee00b23SStefano Zampini 
38004dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
38017ee00b23SStefano Zampini 
38027ee00b23SStefano Zampini   B->ops->view    = MatView_MUMPS;
38037ee00b23SStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
38047ee00b23SStefano Zampini 
38059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
38069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
38079566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
38089566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
38099566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
38109566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
38119566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
38129566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
38139566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
38149566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
38159566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
38165c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
38177ee00b23SStefano Zampini 
38187ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
38197ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
38207ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
38217ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
38227ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
38237ee00b23SStefano Zampini     mumps->sym = 0;
38249566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
38257ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
38267ee00b23SStefano Zampini 
38277ee00b23SStefano Zampini   /* set solvertype */
38289566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
38299566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
38309566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
38312c7c0729SBarry Smith   if (size == 1) {
38324ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3833f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
38342c7c0729SBarry Smith   }
3835450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3836e69c285eSBarry Smith   B->data         = (void *)mumps;
38372205254eSKarl Rupp 
3838450b117fSShri Abhyankar   *F               = B;
3839413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3840413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3841413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3842d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
38433ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3844450b117fSShri Abhyankar }
384542c9c57cSBarry Smith 
38469d0448ceSStefano Zampini /* MatGetFactor for MATNEST matrices */
38479d0448ceSStefano Zampini static PetscErrorCode MatGetFactor_nest_mumps(Mat A, MatFactorType ftype, Mat *F)
38489d0448ceSStefano Zampini {
38499d0448ceSStefano Zampini   Mat         B, **mats;
38509d0448ceSStefano Zampini   Mat_MUMPS  *mumps;
38519d0448ceSStefano Zampini   PetscInt    nr, nc;
38529d0448ceSStefano Zampini   PetscMPIInt size;
385303e5aca4SStefano Zampini   PetscBool   flg = PETSC_TRUE;
38549d0448ceSStefano Zampini 
38559d0448ceSStefano Zampini   PetscFunctionBegin;
38569d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
385703e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
385803e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
385903e5aca4SStefano Zampini     *F = NULL;
386003e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
386103e5aca4SStefano Zampini   }
38629d0448ceSStefano Zampini #endif
38639d0448ceSStefano Zampini 
386403e5aca4SStefano Zampini   /* Return if some condition is not satisfied */
386503e5aca4SStefano Zampini   *F = NULL;
38669d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
38679d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY) {
38689d0448ceSStefano Zampini     IS       *rows, *cols;
38699d0448ceSStefano Zampini     PetscInt *m, *M;
38709d0448ceSStefano Zampini 
38719d0448ceSStefano 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);
38729d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &rows, nc, &cols));
38739d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
38749d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++) PetscCall(ISEqualUnsorted(rows[r], cols[r], &flg));
387503e5aca4SStefano Zampini     if (!flg) {
387603e5aca4SStefano Zampini       PetscCall(PetscFree2(rows, cols));
387703e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for unequal row and column maps. Use MAT_FACTOR_LU.\n"));
387803e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
387903e5aca4SStefano Zampini     }
38809d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &m, nr, &M));
38819d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetMinMax(rows[r], &m[r], &M[r]));
38829d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++)
38839d0448ceSStefano Zampini       for (PetscInt k = r + 1; flg && k < nr; k++)
38849d0448ceSStefano Zampini         if ((m[k] <= m[r] && m[r] <= M[k]) || (m[k] <= M[r] && M[r] <= M[k])) flg = PETSC_FALSE;
38859d0448ceSStefano Zampini     PetscCall(PetscFree2(m, M));
38869d0448ceSStefano Zampini     PetscCall(PetscFree2(rows, cols));
388703e5aca4SStefano Zampini     if (!flg) {
388803e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for intersecting row maps. Use MAT_FACTOR_LU.\n"));
388903e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
389003e5aca4SStefano Zampini     }
38919d0448ceSStefano Zampini   }
38929d0448ceSStefano Zampini 
38939d0448ceSStefano Zampini   for (PetscInt r = 0; r < nr; r++) {
38949d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) {
38959d0448ceSStefano Zampini       Mat       sub = mats[r][c];
389653587d93SPierre Jolivet       PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isDiag, isDense;
38979d0448ceSStefano Zampini 
38989d0448ceSStefano Zampini       if (!sub || (ftype == MAT_FACTOR_CHOLESKY && c < r)) continue;
389953587d93SPierre Jolivet       PetscCall(MatGetTranspose_TransposeVirtual(&sub, NULL, NULL, NULL, NULL));
39009d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
39019d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
39029d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
39039d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
39049d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
39059d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
3906c3e1b152SPierre Jolivet       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATDIAGONAL, &isDiag));
39074b9405b2SPierre Jolivet       PetscCall(PetscObjectTypeCompareAny((PetscObject)sub, &isDense, MATSEQDENSE, MATMPIDENSE, NULL));
39089d0448ceSStefano Zampini       if (ftype == MAT_FACTOR_CHOLESKY) {
3909dcab004fSPierre Jolivet         if (r == c) {
39104b9405b2SPierre Jolivet           if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isSeqSBAIJ && !isMPISBAIJ && !isDiag && !isDense) {
391140afc089SBarry Smith             PetscCall(PetscInfo(sub, "MAT_FACTOR_CHOLESKY not supported for diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
391203e5aca4SStefano Zampini             flg = PETSC_FALSE;
3913dcab004fSPierre Jolivet           }
39144b9405b2SPierre Jolivet         } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isDiag && !isDense) {
391540afc089SBarry Smith           PetscCall(PetscInfo(sub, "MAT_FACTOR_CHOLESKY not supported for off-diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
391603e5aca4SStefano Zampini           flg = PETSC_FALSE;
391703e5aca4SStefano Zampini         }
39184b9405b2SPierre Jolivet       } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isDiag && !isDense) {
39199afb9c56SPierre Jolivet         PetscCall(PetscInfo(sub, "MAT_FACTOR_LU not supported for block of type %s.\n", ((PetscObject)sub)->type_name));
392003e5aca4SStefano Zampini         flg = PETSC_FALSE;
39219d0448ceSStefano Zampini       }
39229d0448ceSStefano Zampini     }
392303e5aca4SStefano Zampini   }
392403e5aca4SStefano Zampini   if (!flg) PetscFunctionReturn(PETSC_SUCCESS);
39259d0448ceSStefano Zampini 
39269d0448ceSStefano Zampini   /* Create the factorization matrix */
39279d0448ceSStefano Zampini   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
39289d0448ceSStefano Zampini   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
39299d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
39309d0448ceSStefano Zampini   PetscCall(MatSetUp(B));
39319d0448ceSStefano Zampini 
39329d0448ceSStefano Zampini   PetscCall(PetscNew(&mumps));
39339d0448ceSStefano Zampini 
39349d0448ceSStefano Zampini   B->ops->view    = MatView_MUMPS;
39359d0448ceSStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
39369d0448ceSStefano Zampini 
39379d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
39389d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
39399d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
39409d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
39419d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
39429d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
39439d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
39449d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
39459d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
39469d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
39479d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
39489d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
39499d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
39509d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
395193d70b8aSPierre Jolivet   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetBlk_C", MatMumpsSetBlk_MUMPS));
39529d0448ceSStefano Zampini 
39539d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_LU) {
39549d0448ceSStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
39559d0448ceSStefano Zampini     B->factortype            = MAT_FACTOR_LU;
39569d0448ceSStefano Zampini     mumps->sym               = 0;
39579d0448ceSStefano Zampini   } else {
39589d0448ceSStefano Zampini     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
39599d0448ceSStefano Zampini     B->factortype                  = MAT_FACTOR_CHOLESKY;
39609d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
39619d0448ceSStefano Zampini     mumps->sym = 2;
39629d0448ceSStefano Zampini #else
39639d0448ceSStefano Zampini     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
39649d0448ceSStefano Zampini     else mumps->sym = 2;
39659d0448ceSStefano Zampini #endif
39669d0448ceSStefano Zampini   }
39679d0448ceSStefano Zampini   mumps->ConvertToTriples = MatConvertToTriples_nest_xaij;
39689d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[ftype]));
39699d0448ceSStefano Zampini 
39709d0448ceSStefano Zampini   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
39719d0448ceSStefano Zampini   if (size == 1) {
39729d0448ceSStefano Zampini     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
39739d0448ceSStefano Zampini     B->canuseordering = PETSC_TRUE;
39749d0448ceSStefano Zampini   }
39759d0448ceSStefano Zampini 
39769d0448ceSStefano Zampini   /* set solvertype */
39779d0448ceSStefano Zampini   PetscCall(PetscFree(B->solvertype));
39789d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
39799d0448ceSStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
39809d0448ceSStefano Zampini   B->data         = (void *)mumps;
39819d0448ceSStefano Zampini 
39829d0448ceSStefano Zampini   *F               = B;
39839d0448ceSStefano Zampini   mumps->id.job    = JOB_NULL;
39849d0448ceSStefano Zampini   mumps->ICNTL_pre = NULL;
39859d0448ceSStefano Zampini   mumps->CNTL_pre  = NULL;
39869d0448ceSStefano Zampini   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
39879d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
39889d0448ceSStefano Zampini }
39899d0448ceSStefano Zampini 
3990d1f0640dSPierre Jolivet PETSC_INTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
3991d71ae5a4SJacob Faibussowitsch {
399242c9c57cSBarry Smith   PetscFunctionBegin;
39939566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
39949566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
39959566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
39969566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
39979566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPISBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
39989566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
39999566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
40009566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
40019566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
40029566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
40039566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSELL, MAT_FACTOR_LU, MatGetFactor_sell_mumps));
4004c3e1b152SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATDIAGONAL, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
4005c3e1b152SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATDIAGONAL, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
40064b9405b2SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQDENSE, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
40074b9405b2SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQDENSE, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
40084b9405b2SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIDENSE, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
40094b9405b2SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIDENSE, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
40109d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_LU, MatGetFactor_nest_mumps));
40119d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_CHOLESKY, MatGetFactor_nest_mumps));
40123ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
401342c9c57cSBarry Smith }
4014