xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision c3e1b1524a97deee746822b368bdd3acb019179f)
11c2a3de1SBarry Smith 
2397b6df1SKris Buschelman /*
3c2b5dc30SHong Zhang     Provides an interface to the MUMPS sparse solver
4397b6df1SKris Buschelman */
567602552SJunchao Zhang #include <petscpkg_version.h>
69d0448ceSStefano Zampini #include <petscsf.h>
7c6db04a5SJed Brown #include <../src/mat/impls/aij/mpi/mpiaij.h> /*I  "petscmat.h"  I*/
8c6db04a5SJed Brown #include <../src/mat/impls/sbaij/mpi/mpisbaij.h>
97ee00b23SStefano Zampini #include <../src/mat/impls/sell/mpi/mpisell.h>
10397b6df1SKris Buschelman 
119261f6e4SBarry Smith #define MUMPS_MANUALS "(see users manual https://mumps-solver.org/index.php?page=doc \"Error and warning diagnostics\")"
129261f6e4SBarry Smith 
13397b6df1SKris Buschelman EXTERN_C_BEGIN
14397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
152907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
162907cef9SHong Zhang     #include <cmumps_c.h>
172907cef9SHong Zhang   #else
18c6db04a5SJed Brown     #include <zmumps_c.h>
192907cef9SHong Zhang   #endif
202907cef9SHong Zhang #else
212907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
222907cef9SHong Zhang     #include <smumps_c.h>
23397b6df1SKris Buschelman   #else
24c6db04a5SJed Brown     #include <dmumps_c.h>
25397b6df1SKris Buschelman   #endif
262907cef9SHong Zhang #endif
27397b6df1SKris Buschelman EXTERN_C_END
28397b6df1SKris Buschelman #define JOB_INIT         -1
29413bcc21SPierre Jolivet #define JOB_NULL         0
303d472b54SHong Zhang #define JOB_FACTSYMBOLIC 1
313d472b54SHong Zhang #define JOB_FACTNUMERIC  2
323d472b54SHong Zhang #define JOB_SOLVE        3
33397b6df1SKris Buschelman #define JOB_END          -2
343d472b54SHong Zhang 
352907cef9SHong Zhang /* calls to MUMPS */
362907cef9SHong Zhang #if defined(PETSC_USE_COMPLEX)
372907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
383ab56b82SJunchao Zhang     #define MUMPS_c cmumps_c
392907cef9SHong Zhang   #else
403ab56b82SJunchao Zhang     #define MUMPS_c zmumps_c
412907cef9SHong Zhang   #endif
422907cef9SHong Zhang #else
432907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
443ab56b82SJunchao Zhang     #define MUMPS_c smumps_c
452907cef9SHong Zhang   #else
463ab56b82SJunchao Zhang     #define MUMPS_c dmumps_c
472907cef9SHong Zhang   #endif
482907cef9SHong Zhang #endif
492907cef9SHong Zhang 
50a6053eceSJunchao Zhang /* MUMPS uses MUMPS_INT for nonzero indices such as irn/jcn, irn_loc/jcn_loc and uses int64_t for
51a6053eceSJunchao Zhang    number of nonzeros such as nnz, nnz_loc. We typedef MUMPS_INT to PetscMUMPSInt to follow the
52a6053eceSJunchao Zhang    naming convention in PetscMPIInt, PetscBLASInt etc.
53a6053eceSJunchao Zhang */
54a6053eceSJunchao Zhang typedef MUMPS_INT PetscMUMPSInt;
55a6053eceSJunchao Zhang 
5667602552SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_GE(5, 3, 0)
5767602552SJunchao Zhang   #if defined(MUMPS_INTSIZE64) /* MUMPS_INTSIZE64 is in MUMPS headers if it is built in full 64-bit mode, therefore the macro is more reliable */
58a6053eceSJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
5967602552SJunchao Zhang   #endif
60a6053eceSJunchao Zhang #else
6167602552SJunchao Zhang   #if defined(INTSIZE64) /* INTSIZE64 is a command line macro one used to build MUMPS in full 64-bit mode */
6267602552SJunchao Zhang     #error "Petsc has not been tested with full 64-bit MUMPS and we choose to error out"
6367602552SJunchao Zhang   #endif
6467602552SJunchao Zhang #endif
6567602552SJunchao Zhang 
66a6053eceSJunchao Zhang #define MPIU_MUMPSINT       MPI_INT
67a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MAX 2147483647
68a6053eceSJunchao Zhang #define PETSC_MUMPS_INT_MIN -2147483648
69a6053eceSJunchao Zhang 
70a6053eceSJunchao Zhang /* Cast PetscInt to PetscMUMPSInt. Usually there is no overflow since <a> is row/col indices or some small integers*/
71d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscMUMPSIntCast(PetscInt a, PetscMUMPSInt *b)
72d71ae5a4SJacob Faibussowitsch {
73a6053eceSJunchao Zhang   PetscFunctionBegin;
74ece88022SPierre Jolivet #if PetscDefined(USE_64BIT_INDICES)
752c71b3e2SJacob Faibussowitsch   PetscAssert(a <= PETSC_MUMPS_INT_MAX && a >= PETSC_MUMPS_INT_MIN, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
76ece88022SPierre Jolivet #endif
77a6053eceSJunchao Zhang   *b = (PetscMUMPSInt)(a);
783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
79a6053eceSJunchao Zhang }
80a6053eceSJunchao Zhang 
81a6053eceSJunchao Zhang /* Put these utility routines here since they are only used in this file */
82d71ae5a4SJacob Faibussowitsch static inline PetscErrorCode PetscOptionsMUMPSInt_Private(PetscOptionItems *PetscOptionsObject, const char opt[], const char text[], const char man[], PetscMUMPSInt currentvalue, PetscMUMPSInt *value, PetscBool *set, PetscMUMPSInt lb, PetscMUMPSInt ub)
83d71ae5a4SJacob Faibussowitsch {
84a6053eceSJunchao Zhang   PetscInt  myval;
85a6053eceSJunchao Zhang   PetscBool myset;
86a6053eceSJunchao Zhang   PetscFunctionBegin;
87a6053eceSJunchao Zhang   /* PetscInt's size should be always >= PetscMUMPSInt's. It is safe to call PetscOptionsInt_Private to read a PetscMUMPSInt */
889566063dSJacob Faibussowitsch   PetscCall(PetscOptionsInt_Private(PetscOptionsObject, opt, text, man, (PetscInt)currentvalue, &myval, &myset, lb, ub));
899566063dSJacob Faibussowitsch   if (myset) PetscCall(PetscMUMPSIntCast(myval, value));
90a6053eceSJunchao Zhang   if (set) *set = myset;
913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
92a6053eceSJunchao Zhang }
93a6053eceSJunchao Zhang #define PetscOptionsMUMPSInt(a, b, c, d, e, f) PetscOptionsMUMPSInt_Private(PetscOptionsObject, a, b, c, d, e, f, PETSC_MUMPS_INT_MIN, PETSC_MUMPS_INT_MAX)
94a6053eceSJunchao Zhang 
95217d3b1eSJunchao Zhang /* if using PETSc OpenMP support, we only call MUMPS on master ranks. Before/after the call, we change/restore CPUs the master ranks can run on */
963ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
973ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
983ab56b82SJunchao Zhang     do { \
993ab56b82SJunchao Zhang       if (mumps->use_petsc_omp_support) { \
1003ab56b82SJunchao Zhang         if (mumps->is_omp_master) { \
1019566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterBegin(mumps->omp_ctrl)); \
10214ffdc6fSStefano Zampini           PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
10314ffdc6fSStefano Zampini           PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
10414ffdc6fSStefano Zampini           PetscCall(PetscFPTrapPop()); \
1059566063dSJacob Faibussowitsch           PetscCall(PetscOmpCtrlOmpRegionOnMasterEnd(mumps->omp_ctrl)); \
1063ab56b82SJunchao Zhang         } \
1079566063dSJacob Faibussowitsch         PetscCall(PetscOmpCtrlBarrier(mumps->omp_ctrl)); \
108c3714a1dSJunchao Zhang         /* Global info is same on all processes so we Bcast it within omp_comm. Local info is specific      \
109c3714a1dSJunchao Zhang          to processes, so we only Bcast info[1], an error code and leave others (since they do not have   \
110c3714a1dSJunchao Zhang          an easy translation between omp_comm and petsc_comm). See MUMPS-5.1.2 manual p82.                   \
111c3714a1dSJunchao Zhang          omp_comm is a small shared memory communicator, hence doing multiple Bcast as shown below is OK. \
112c3714a1dSJunchao Zhang       */ \
113338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.infog, PETSC_STATIC_ARRAY_LENGTH(mumps->id.infog), MPIU_MUMPSINT, 0, mumps->omp_comm)); \
114338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.rinfog, PETSC_STATIC_ARRAY_LENGTH(mumps->id.rinfog), MPIU_REAL, 0, mumps->omp_comm)); \
115338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.info, PETSC_STATIC_ARRAY_LENGTH(mumps->id.info), MPIU_MUMPSINT, 0, mumps->omp_comm)); \
116338d3105SPierre Jolivet         PetscCallMPI(MPI_Bcast(mumps->id.rinfo, PETSC_STATIC_ARRAY_LENGTH(mumps->id.rinfo), MPIU_REAL, 0, mumps->omp_comm)); \
1173ab56b82SJunchao Zhang       } else { \
11814ffdc6fSStefano Zampini         PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
11914ffdc6fSStefano Zampini         PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
12014ffdc6fSStefano Zampini         PetscCall(PetscFPTrapPop()); \
1213ab56b82SJunchao Zhang       } \
1223ab56b82SJunchao Zhang     } while (0)
1233ab56b82SJunchao Zhang #else
1243ab56b82SJunchao Zhang   #define PetscMUMPS_c(mumps) \
125d71ae5a4SJacob Faibussowitsch     do { \
12614ffdc6fSStefano Zampini       PetscCall(PetscFPTrapPush(PETSC_FP_TRAP_OFF)); \
12714ffdc6fSStefano Zampini       PetscStackCallExternalVoid(PetscStringize(MUMPS_c), MUMPS_c(&mumps->id)); \
12814ffdc6fSStefano Zampini       PetscCall(PetscFPTrapPop()); \
129d71ae5a4SJacob Faibussowitsch     } while (0)
1303ab56b82SJunchao Zhang #endif
1313ab56b82SJunchao Zhang 
132940cd9d6SSatish Balay /* declare MumpsScalar */
133940cd9d6SSatish Balay #if defined(PETSC_USE_COMPLEX)
134940cd9d6SSatish Balay   #if defined(PETSC_USE_REAL_SINGLE)
135940cd9d6SSatish Balay     #define MumpsScalar mumps_complex
136940cd9d6SSatish Balay   #else
137940cd9d6SSatish Balay     #define MumpsScalar mumps_double_complex
138940cd9d6SSatish Balay   #endif
139940cd9d6SSatish Balay #else
140940cd9d6SSatish Balay   #define MumpsScalar PetscScalar
141940cd9d6SSatish Balay #endif
1423d472b54SHong Zhang 
143397b6df1SKris Buschelman /* macros s.t. indices match MUMPS documentation */
144397b6df1SKris Buschelman #define ICNTL(I)  icntl[(I)-1]
145397b6df1SKris Buschelman #define CNTL(I)   cntl[(I)-1]
146397b6df1SKris Buschelman #define INFOG(I)  infog[(I)-1]
147a7aca84bSHong Zhang #define INFO(I)   info[(I)-1]
148397b6df1SKris Buschelman #define RINFOG(I) rinfog[(I)-1]
149adc1d99fSHong Zhang #define RINFO(I)  rinfo[(I)-1]
150397b6df1SKris Buschelman 
151a6053eceSJunchao Zhang typedef struct Mat_MUMPS Mat_MUMPS;
152a6053eceSJunchao Zhang struct Mat_MUMPS {
153397b6df1SKris Buschelman #if defined(PETSC_USE_COMPLEX)
1542907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1552907cef9SHong Zhang   CMUMPS_STRUC_C id;
1562907cef9SHong Zhang   #else
157397b6df1SKris Buschelman   ZMUMPS_STRUC_C id;
1582907cef9SHong Zhang   #endif
1592907cef9SHong Zhang #else
1602907cef9SHong Zhang   #if defined(PETSC_USE_REAL_SINGLE)
1612907cef9SHong Zhang   SMUMPS_STRUC_C id;
162397b6df1SKris Buschelman   #else
163397b6df1SKris Buschelman   DMUMPS_STRUC_C id;
164397b6df1SKris Buschelman   #endif
1652907cef9SHong Zhang #endif
1662907cef9SHong Zhang 
167397b6df1SKris Buschelman   MatStructure   matstruc;
1682d4298aeSJunchao Zhang   PetscMPIInt    myid, petsc_size;
169a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;       /* the (i,j,v) triplets passed to mumps. */
170a6053eceSJunchao Zhang   PetscScalar   *val, *val_alloc; /* For some matrices, we can directly access their data array without a buffer. For others, we need a buffer. So comes val_alloc. */
171a6053eceSJunchao Zhang   PetscInt64     nnz;             /* number of nonzeros. The type is called selective 64-bit in mumps */
172a6053eceSJunchao Zhang   PetscMUMPSInt  sym;
1732d4298aeSJunchao Zhang   MPI_Comm       mumps_comm;
174413bcc21SPierre Jolivet   PetscMUMPSInt *ICNTL_pre;
175413bcc21SPierre Jolivet   PetscReal     *CNTL_pre;
176a6053eceSJunchao Zhang   PetscMUMPSInt  ICNTL9_pre;         /* check if ICNTL(9) is changed from previous MatSolve */
177801fbe65SHong Zhang   VecScatter     scat_rhs, scat_sol; /* used by MatSolve() */
17825aac85cSJunchao Zhang   PetscMUMPSInt  ICNTL20;            /* use centralized (0) or distributed (10) dense RHS */
17967602552SJunchao Zhang   PetscMUMPSInt  lrhs_loc, nloc_rhs, *irhs_loc;
18067602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
18167602552SJunchao Zhang   PetscInt    *rhs_nrow, max_nrhs;
18267602552SJunchao Zhang   PetscMPIInt *rhs_recvcounts, *rhs_disps;
18367602552SJunchao Zhang   PetscScalar *rhs_loc, *rhs_recvbuf;
18467602552SJunchao Zhang #endif
185801fbe65SHong Zhang   Vec            b_seq, x_seq;
186a6053eceSJunchao Zhang   PetscInt       ninfo, *info; /* which INFO to display */
187b5fa320bSStefano Zampini   PetscInt       sizeredrhs;
18859ac8732SStefano Zampini   PetscScalar   *schur_sol;
18959ac8732SStefano Zampini   PetscInt       schur_sizesol;
190a6053eceSJunchao Zhang   PetscMUMPSInt *ia_alloc, *ja_alloc; /* work arrays used for the CSR struct for sparse rhs */
191a6053eceSJunchao Zhang   PetscInt64     cur_ilen, cur_jlen;  /* current len of ia_alloc[], ja_alloc[] */
192a6053eceSJunchao Zhang   PetscErrorCode (*ConvertToTriples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1932205254eSKarl Rupp 
1949d0448ceSStefano Zampini   /* Support for MATNEST */
1959d0448ceSStefano Zampini   PetscErrorCode (**nest_convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *);
1969d0448ceSStefano Zampini   PetscInt64  *nest_vals_start;
1979d0448ceSStefano Zampini   PetscScalar *nest_vals;
1989d0448ceSStefano Zampini 
199a6053eceSJunchao Zhang   /* stuff used by petsc/mumps OpenMP support*/
2003ab56b82SJunchao Zhang   PetscBool    use_petsc_omp_support;
201da81f932SPierre Jolivet   PetscOmpCtrl omp_ctrl;             /* an OpenMP controller that blocked processes will release their CPU (MPI_Barrier does not have this guarantee) */
2023ab56b82SJunchao Zhang   MPI_Comm     petsc_comm, omp_comm; /* petsc_comm is petsc matrix's comm */
203a6053eceSJunchao Zhang   PetscInt64  *recvcount;            /* a collection of nnz on omp_master */
204a6053eceSJunchao Zhang   PetscMPIInt  tag, omp_comm_size;
2053ab56b82SJunchao Zhang   PetscBool    is_omp_master; /* is this rank the master of omp_comm */
206a6053eceSJunchao Zhang   MPI_Request *reqs;
207a6053eceSJunchao Zhang };
2083ab56b82SJunchao Zhang 
209a6053eceSJunchao Zhang /* Cast a 1-based CSR represented by (nrow, ia, ja) of type PetscInt to a CSR of type PetscMUMPSInt.
210a6053eceSJunchao Zhang    Here, nrow is number of rows, ia[] is row pointer and ja[] is column indices.
211a6053eceSJunchao Zhang  */
212d71ae5a4SJacob Faibussowitsch static PetscErrorCode PetscMUMPSIntCSRCast(Mat_MUMPS *mumps, PetscInt nrow, PetscInt *ia, PetscInt *ja, PetscMUMPSInt **ia_mumps, PetscMUMPSInt **ja_mumps, PetscMUMPSInt *nnz_mumps)
213d71ae5a4SJacob Faibussowitsch {
214a6053eceSJunchao Zhang   PetscInt nnz = ia[nrow] - 1; /* mumps uses 1-based indices. Uses PetscInt instead of PetscInt64 since mumps only uses PetscMUMPSInt for rhs */
215f0c56d0fSKris Buschelman 
216a6053eceSJunchao Zhang   PetscFunctionBegin;
217a6053eceSJunchao Zhang #if defined(PETSC_USE_64BIT_INDICES)
218a6053eceSJunchao Zhang   {
219a6053eceSJunchao Zhang     PetscInt i;
220a6053eceSJunchao Zhang     if (nrow + 1 > mumps->cur_ilen) { /* realloc ia_alloc/ja_alloc to fit ia/ja */
2219566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ia_alloc));
2229566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nrow + 1, &mumps->ia_alloc));
223a6053eceSJunchao Zhang       mumps->cur_ilen = nrow + 1;
224a6053eceSJunchao Zhang     }
225a6053eceSJunchao Zhang     if (nnz > mumps->cur_jlen) {
2269566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->ja_alloc));
2279566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(nnz, &mumps->ja_alloc));
228a6053eceSJunchao Zhang       mumps->cur_jlen = nnz;
229a6053eceSJunchao Zhang     }
2309566063dSJacob Faibussowitsch     for (i = 0; i < nrow + 1; i++) PetscCall(PetscMUMPSIntCast(ia[i], &(mumps->ia_alloc[i])));
2319566063dSJacob Faibussowitsch     for (i = 0; i < nnz; i++) PetscCall(PetscMUMPSIntCast(ja[i], &(mumps->ja_alloc[i])));
232a6053eceSJunchao Zhang     *ia_mumps = mumps->ia_alloc;
233a6053eceSJunchao Zhang     *ja_mumps = mumps->ja_alloc;
234a6053eceSJunchao Zhang   }
235a6053eceSJunchao Zhang #else
236a6053eceSJunchao Zhang   *ia_mumps = ia;
237a6053eceSJunchao Zhang   *ja_mumps = ja;
238a6053eceSJunchao Zhang #endif
2399566063dSJacob Faibussowitsch   PetscCall(PetscMUMPSIntCast(nnz, nnz_mumps));
2403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
241a6053eceSJunchao Zhang }
242b24902e0SBarry Smith 
243d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsResetSchur_Private(Mat_MUMPS *mumps)
244d71ae5a4SJacob Faibussowitsch {
245b5fa320bSStefano Zampini   PetscFunctionBegin;
2469566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
2479566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.redrhs));
2489566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->schur_sol));
24959ac8732SStefano Zampini   mumps->id.size_schur = 0;
250b3cb21ddSStefano Zampini   mumps->id.schur_lld  = 0;
25159ac8732SStefano Zampini   mumps->id.ICNTL(19)  = 0;
2523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25359ac8732SStefano Zampini }
25459ac8732SStefano Zampini 
255b3cb21ddSStefano Zampini /* solve with rhs in mumps->id.redrhs and return in the same location */
256d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSolveSchur_Private(Mat F)
257d71ae5a4SJacob Faibussowitsch {
258b3cb21ddSStefano Zampini   Mat_MUMPS           *mumps = (Mat_MUMPS *)F->data;
259b3cb21ddSStefano Zampini   Mat                  S, B, X;
260b3cb21ddSStefano Zampini   MatFactorSchurStatus schurstatus;
261b3cb21ddSStefano Zampini   PetscInt             sizesol;
26259ac8732SStefano Zampini 
26359ac8732SStefano Zampini   PetscFunctionBegin;
2649566063dSJacob Faibussowitsch   PetscCall(MatFactorFactorizeSchurComplement(F));
2659566063dSJacob Faibussowitsch   PetscCall(MatFactorGetSchurComplement(F, &S, &schurstatus));
2669566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &B));
2679566063dSJacob Faibussowitsch   PetscCall(MatSetType(B, ((PetscObject)S)->type_name));
268a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2699566063dSJacob Faibussowitsch   PetscCall(MatBindToCPU(B, S->boundtocpu));
270a3d589ffSStefano Zampini #endif
271b3cb21ddSStefano Zampini   switch (schurstatus) {
272d71ae5a4SJacob Faibussowitsch   case MAT_FACTOR_SCHUR_FACTORED:
273d71ae5a4SJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, (PetscScalar *)mumps->id.redrhs, &X));
274d71ae5a4SJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
275a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2769566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
277a3d589ffSStefano Zampini #endif
278b3cb21ddSStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2799566063dSJacob Faibussowitsch       PetscCall(MatMatSolveTranspose(S, B, X));
28059ac8732SStefano Zampini     } else {
2819566063dSJacob Faibussowitsch       PetscCall(MatMatSolve(S, B, X));
28259ac8732SStefano Zampini     }
283b3cb21ddSStefano Zampini     break;
284b3cb21ddSStefano Zampini   case MAT_FACTOR_SCHUR_INVERTED:
285b3cb21ddSStefano Zampini     sizesol = mumps->id.nrhs * mumps->id.size_schur;
28659ac8732SStefano Zampini     if (!mumps->schur_sol || sizesol > mumps->schur_sizesol) {
2879566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->schur_sol));
2889566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(sizesol, &mumps->schur_sol));
28959ac8732SStefano Zampini       mumps->schur_sizesol = sizesol;
290b5fa320bSStefano Zampini     }
2919566063dSJacob Faibussowitsch     PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, mumps->id.size_schur, mumps->id.nrhs, mumps->schur_sol, &X));
2929566063dSJacob Faibussowitsch     PetscCall(MatSetType(X, ((PetscObject)S)->type_name));
293a3d589ffSStefano Zampini #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)
2949566063dSJacob Faibussowitsch     PetscCall(MatBindToCPU(X, S->boundtocpu));
295a3d589ffSStefano Zampini #endif
2969566063dSJacob Faibussowitsch     PetscCall(MatProductCreateWithMat(S, B, NULL, X));
29759ac8732SStefano Zampini     if (!mumps->id.ICNTL(9)) { /* transpose solve */
2989566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AtB));
299b5fa320bSStefano Zampini     } else {
3009566063dSJacob Faibussowitsch       PetscCall(MatProductSetType(X, MATPRODUCT_AB));
301b5fa320bSStefano Zampini     }
3029566063dSJacob Faibussowitsch     PetscCall(MatProductSetFromOptions(X));
3039566063dSJacob Faibussowitsch     PetscCall(MatProductSymbolic(X));
3049566063dSJacob Faibussowitsch     PetscCall(MatProductNumeric(X));
3054417c5e8SHong Zhang 
3069566063dSJacob Faibussowitsch     PetscCall(MatCopy(X, B, SAME_NONZERO_PATTERN));
307b3cb21ddSStefano Zampini     break;
308d71ae5a4SJacob Faibussowitsch   default:
309d71ae5a4SJacob Faibussowitsch     SETERRQ(PetscObjectComm((PetscObject)F), PETSC_ERR_SUP, "Unhandled MatFactorSchurStatus %d", F->schur_status);
31059ac8732SStefano Zampini   }
3119566063dSJacob Faibussowitsch   PetscCall(MatFactorRestoreSchurComplement(F, &S, schurstatus));
3129566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
3139566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&X));
3143ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
315b5fa320bSStefano Zampini }
316b5fa320bSStefano Zampini 
317d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsHandleSchur_Private(Mat F, PetscBool expansion)
318d71ae5a4SJacob Faibussowitsch {
319b3cb21ddSStefano Zampini   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
320b5fa320bSStefano Zampini 
321b5fa320bSStefano Zampini   PetscFunctionBegin;
322b5fa320bSStefano Zampini   if (!mumps->id.ICNTL(19)) { /* do nothing when Schur complement has not been computed */
3233ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
324b5fa320bSStefano Zampini   }
325b8f61ee1SStefano Zampini   if (!expansion) { /* prepare for the condensation step */
326b5fa320bSStefano Zampini     PetscInt sizeredrhs = mumps->id.nrhs * mumps->id.size_schur;
327b5fa320bSStefano Zampini     /* allocate MUMPS internal array to store reduced right-hand sides */
328b5fa320bSStefano Zampini     if (!mumps->id.redrhs || sizeredrhs > mumps->sizeredrhs) {
3299566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
330b5fa320bSStefano Zampini       mumps->id.lredrhs = mumps->id.size_schur;
3319566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.nrhs * mumps->id.lredrhs, &mumps->id.redrhs));
332b5fa320bSStefano Zampini       mumps->sizeredrhs = mumps->id.nrhs * mumps->id.lredrhs;
333b5fa320bSStefano Zampini     }
334b5fa320bSStefano Zampini   } else { /* prepare for the expansion step */
335b8f61ee1SStefano Zampini     /* solve Schur complement (this has to be done by the MUMPS user, so basically us) */
3369566063dSJacob Faibussowitsch     PetscCall(MatMumpsSolveSchur_Private(F));
337b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 2; /* expansion phase */
3383ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
3399261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in solve: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
340b5fa320bSStefano Zampini     /* restore defaults */
341b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = -1;
342d3d598ffSStefano Zampini     /* free MUMPS internal array for redrhs if we have solved for multiple rhs in order to save memory space */
343d3d598ffSStefano Zampini     if (mumps->id.nrhs > 1) {
3449566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
345d3d598ffSStefano Zampini       mumps->id.lredrhs = 0;
346d3d598ffSStefano Zampini       mumps->sizeredrhs = 0;
347d3d598ffSStefano Zampini     }
348b5fa320bSStefano Zampini   }
3493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
350b5fa320bSStefano Zampini }
351b5fa320bSStefano Zampini 
352397b6df1SKris Buschelman /*
353d341cd04SHong Zhang   MatConvertToTriples_A_B - convert Petsc matrix to triples: row[nz], col[nz], val[nz]
354d341cd04SHong Zhang 
355397b6df1SKris Buschelman   input:
35675480915SPierre Jolivet     A       - matrix in aij,baij or sbaij format
357397b6df1SKris Buschelman     shift   - 0: C style output triple; 1: Fortran style output triple.
358bccb9932SShri Abhyankar     reuse   - MAT_INITIAL_MATRIX: spaces are allocated and values are set for the triple
359bccb9932SShri Abhyankar               MAT_REUSE_MATRIX:   only the values in v array are updated
360397b6df1SKris Buschelman   output:
361397b6df1SKris Buschelman     nnz     - dim of r, c, and v (number of local nonzero entries of A)
362397b6df1SKris Buschelman     r, c, v - row and col index, matrix values (matrix triples)
363eb9baa12SBarry Smith 
364eb9baa12SBarry Smith   The returned values r, c, and sometimes v are obtained in a single PetscMalloc(). Then in MatDestroy_MUMPS() it is
3657ee00b23SStefano Zampini   freed with PetscFree(mumps->irn);  This is not ideal code, the fact that v is ONLY sometimes part of mumps->irn means
366eb9baa12SBarry Smith   that the PetscMalloc() cannot easily be replaced with a PetscMalloc3().
367eb9baa12SBarry Smith 
368397b6df1SKris Buschelman  */
36916ebf90aSShri Abhyankar 
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;
374a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j, k;
375a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
37616ebf90aSShri Abhyankar   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
377397b6df1SKris Buschelman 
378397b6df1SKris Buschelman   PetscFunctionBegin;
3799566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
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));
385a6053eceSJunchao Zhang     for (i = k = 0; i < M; i++) {
38616ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
38767877ebaSShri Abhyankar       ajj = aj + ai[i];
38867877ebaSShri Abhyankar       for (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;
39850c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, av, aa->nz));
3999566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
4003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
40116ebf90aSShri Abhyankar }
402397b6df1SKris Buschelman 
40366976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
404d71ae5a4SJacob Faibussowitsch {
405a6053eceSJunchao Zhang   PetscInt64     nz, i, j, k, r;
4067ee00b23SStefano Zampini   Mat_SeqSELL   *a = (Mat_SeqSELL *)A->data;
407a6053eceSJunchao Zhang   PetscMUMPSInt *row, *col;
4087ee00b23SStefano Zampini 
4097ee00b23SStefano Zampini   PetscFunctionBegin;
4107ee00b23SStefano Zampini   nz = a->sliidx[a->totalslices];
41150c845baSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4129566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
413a6053eceSJunchao Zhang     for (i = k = 0; i < a->totalslices; i++) {
41448a46eb9SPierre 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++]));
4157ee00b23SStefano Zampini     }
4169566063dSJacob Faibussowitsch     for (i = 0; i < nz; i++) PetscCall(PetscMUMPSIntCast(a->colidx[i] + shift, &col[i]));
417a6053eceSJunchao Zhang     mumps->irn = row;
418a6053eceSJunchao Zhang     mumps->jcn = col;
419a6053eceSJunchao Zhang     mumps->nnz = nz;
42050c845baSStefano Zampini     mumps->val = a->val;
42150c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, a->val, nz));
4223ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4237ee00b23SStefano Zampini }
4247ee00b23SStefano Zampini 
42566976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
426d71ae5a4SJacob Faibussowitsch {
42767877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa = (Mat_SeqBAIJ *)A->data;
42833d57670SJed Brown   const PetscInt *ai, *aj, *ajj, bs2 = aa->bs2;
42950c845baSStefano Zampini   PetscInt64      M, nz = bs2 * aa->nz, idx = 0, rnz, i, j, k, m;
430a6053eceSJunchao Zhang   PetscInt        bs;
431a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
43267877ebaSShri Abhyankar 
43367877ebaSShri Abhyankar   PetscFunctionBegin;
43450c845baSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4359566063dSJacob Faibussowitsch     PetscCall(MatGetBlockSize(A, &bs));
43633d57670SJed Brown     M  = A->rmap->N / bs;
4379371c9d4SSatish Balay     ai = aa->i;
4389371c9d4SSatish Balay     aj = aa->j;
4399566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
44067877ebaSShri Abhyankar     for (i = 0; i < M; i++) {
44167877ebaSShri Abhyankar       ajj = aj + ai[i];
44267877ebaSShri Abhyankar       rnz = ai[i + 1] - ai[i];
44367877ebaSShri Abhyankar       for (k = 0; k < rnz; k++) {
44467877ebaSShri Abhyankar         for (j = 0; j < bs; j++) {
44567877ebaSShri Abhyankar           for (m = 0; m < bs; m++) {
4469566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[idx]));
4479566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * ajj[k] + j + shift, &col[idx]));
448a6053eceSJunchao Zhang             idx++;
44967877ebaSShri Abhyankar           }
45067877ebaSShri Abhyankar         }
45167877ebaSShri Abhyankar       }
45267877ebaSShri Abhyankar     }
453a6053eceSJunchao Zhang     mumps->irn = row;
454a6053eceSJunchao Zhang     mumps->jcn = col;
455a6053eceSJunchao Zhang     mumps->nnz = nz;
45650c845baSStefano Zampini     mumps->val = aa->a;
45750c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, aa->a, nz));
4583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
45967877ebaSShri Abhyankar }
46067877ebaSShri Abhyankar 
46166976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
462d71ae5a4SJacob Faibussowitsch {
46375480915SPierre Jolivet   const PetscInt *ai, *aj, *ajj;
464a6053eceSJunchao Zhang   PetscInt        bs;
465a6053eceSJunchao Zhang   PetscInt64      nz, rnz, i, j, k, m;
466a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
46775480915SPierre Jolivet   PetscScalar    *val;
46816ebf90aSShri Abhyankar   Mat_SeqSBAIJ   *aa  = (Mat_SeqSBAIJ *)A->data;
46975480915SPierre Jolivet   const PetscInt  bs2 = aa->bs2, mbs = aa->mbs;
47038548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
471b94d7dedSBarry Smith   PetscBool isset, hermitian;
47238548759SBarry Smith #endif
47316ebf90aSShri Abhyankar 
47416ebf90aSShri Abhyankar   PetscFunctionBegin;
47538548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
476b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
477b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
47838548759SBarry Smith #endif
4792205254eSKarl Rupp   ai = aa->i;
4802205254eSKarl Rupp   aj = aa->j;
4819566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
48275480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
483f3fa974cSJacob Faibussowitsch     const PetscInt64 alloc_size = aa->nz * bs2;
484f3fa974cSJacob Faibussowitsch 
485f3fa974cSJacob Faibussowitsch     PetscCall(PetscMalloc2(alloc_size, &row, alloc_size, &col));
486a6053eceSJunchao Zhang     if (bs > 1) {
487f3fa974cSJacob Faibussowitsch       PetscCall(PetscMalloc1(alloc_size, &mumps->val_alloc));
488a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
48975480915SPierre Jolivet     } else {
490a6053eceSJunchao Zhang       mumps->val = aa->a;
49175480915SPierre Jolivet     }
492a6053eceSJunchao Zhang     mumps->irn = row;
493a6053eceSJunchao Zhang     mumps->jcn = col;
494a6053eceSJunchao Zhang   } else {
495a6053eceSJunchao Zhang     row = mumps->irn;
496a6053eceSJunchao Zhang     col = mumps->jcn;
497a6053eceSJunchao Zhang   }
498a6053eceSJunchao Zhang   val = mumps->val;
499185f6596SHong Zhang 
50016ebf90aSShri Abhyankar   nz = 0;
501a81fe166SPierre Jolivet   if (bs > 1) {
50275480915SPierre Jolivet     for (i = 0; i < mbs; i++) {
50316ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
50467877ebaSShri Abhyankar       ajj = aj + ai[i];
50575480915SPierre Jolivet       for (j = 0; j < rnz; j++) {
50675480915SPierre Jolivet         for (k = 0; k < bs; k++) {
50775480915SPierre Jolivet           for (m = 0; m < bs; m++) {
508ec4f40fdSPierre Jolivet             if (ajj[j] > i || k >= m) {
50975480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
5109566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[nz]));
5119566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j] * bs + k + shift, &col[nz]));
51275480915SPierre Jolivet               }
51375480915SPierre Jolivet               val[nz++] = aa->a[(ai[i] + j) * bs2 + m + k * bs];
51475480915SPierre Jolivet             }
51575480915SPierre Jolivet           }
51675480915SPierre Jolivet         }
51775480915SPierre Jolivet       }
51875480915SPierre Jolivet     }
519a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
520a81fe166SPierre Jolivet     for (i = 0; i < mbs; i++) {
521a81fe166SPierre Jolivet       rnz = ai[i + 1] - ai[i];
522a81fe166SPierre Jolivet       ajj = aj + ai[i];
523a81fe166SPierre Jolivet       for (j = 0; j < rnz; j++) {
5249566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5259566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
526a6053eceSJunchao Zhang         nz++;
527a81fe166SPierre Jolivet       }
528a81fe166SPierre Jolivet     }
52908401ef6SPierre Jolivet     PetscCheck(nz == aa->nz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different numbers of nonzeros %" PetscInt64_FMT " != %" PetscInt_FMT, nz, aa->nz);
53050c845baSStefano Zampini   } else PetscCall(PetscArraycpy(mumps->val, aa->a, aa->nz)); /* bs == 1 and MAT_REUSE_MATRIX */
531a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
5323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
53316ebf90aSShri Abhyankar }
53416ebf90aSShri Abhyankar 
53566976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
536d71ae5a4SJacob Faibussowitsch {
53767877ebaSShri Abhyankar   const PetscInt    *ai, *aj, *ajj, *adiag, M = A->rmap->n;
538a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j;
53967877ebaSShri Abhyankar   const PetscScalar *av, *v1;
54016ebf90aSShri Abhyankar   PetscScalar       *val;
541a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
542829b1710SHong Zhang   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
54329b521d4Sstefano_zampini   PetscBool          missing;
54438548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
545b94d7dedSBarry Smith   PetscBool hermitian, isset;
54638548759SBarry Smith #endif
54716ebf90aSShri Abhyankar 
54816ebf90aSShri Abhyankar   PetscFunctionBegin;
54938548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
550b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
551b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
55238548759SBarry Smith #endif
5539566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
5549371c9d4SSatish Balay   ai    = aa->i;
5559371c9d4SSatish Balay   aj    = aa->j;
55616ebf90aSShri Abhyankar   adiag = aa->diag;
5579566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A, &missing, NULL));
558bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5597ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
560829b1710SHong Zhang     nz = 0;
56129b521d4Sstefano_zampini     if (missing) {
56229b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
56329b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
56429b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
56529b521d4Sstefano_zampini             if (aj[j] < i) continue;
56629b521d4Sstefano_zampini             nz++;
56729b521d4Sstefano_zampini           }
56829b521d4Sstefano_zampini         } else {
56929b521d4Sstefano_zampini           nz += ai[i + 1] - adiag[i];
57029b521d4Sstefano_zampini         }
57129b521d4Sstefano_zampini       }
57229b521d4Sstefano_zampini     } else {
573829b1710SHong Zhang       for (i = 0; i < M; i++) nz += ai[i + 1] - adiag[i];
57429b521d4Sstefano_zampini     }
5759566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
5769566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
577a6053eceSJunchao Zhang     mumps->nnz = nz;
578a6053eceSJunchao Zhang     mumps->irn = row;
579a6053eceSJunchao Zhang     mumps->jcn = col;
580a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
581185f6596SHong Zhang 
58216ebf90aSShri Abhyankar     nz = 0;
58329b521d4Sstefano_zampini     if (missing) {
58429b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
58529b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
58629b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
58729b521d4Sstefano_zampini             if (aj[j] < i) continue;
5889566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5899566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j] + shift, &col[nz]));
59029b521d4Sstefano_zampini             val[nz] = av[j];
59129b521d4Sstefano_zampini             nz++;
59229b521d4Sstefano_zampini           }
59329b521d4Sstefano_zampini         } else {
59429b521d4Sstefano_zampini           rnz = ai[i + 1] - adiag[i];
59529b521d4Sstefano_zampini           ajj = aj + adiag[i];
59629b521d4Sstefano_zampini           v1  = av + adiag[i];
59729b521d4Sstefano_zampini           for (j = 0; j < rnz; j++) {
5989566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5999566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
600a6053eceSJunchao Zhang             val[nz++] = v1[j];
60129b521d4Sstefano_zampini           }
60229b521d4Sstefano_zampini         }
60329b521d4Sstefano_zampini       }
60429b521d4Sstefano_zampini     } else {
60516ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
60616ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
60767877ebaSShri Abhyankar         ajj = aj + adiag[i];
608cf3759fdSShri Abhyankar         v1  = av + adiag[i];
60967877ebaSShri Abhyankar         for (j = 0; j < rnz; j++) {
6109566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6119566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
612a6053eceSJunchao Zhang           val[nz++] = v1[j];
61316ebf90aSShri Abhyankar         }
61416ebf90aSShri Abhyankar       }
61529b521d4Sstefano_zampini     }
616397b6df1SKris Buschelman   } else {
617a6053eceSJunchao Zhang     nz  = 0;
618a6053eceSJunchao Zhang     val = mumps->val;
61929b521d4Sstefano_zampini     if (missing) {
62016ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
62129b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
62229b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
62329b521d4Sstefano_zampini             if (aj[j] < i) continue;
62429b521d4Sstefano_zampini             val[nz++] = av[j];
62529b521d4Sstefano_zampini           }
62629b521d4Sstefano_zampini         } else {
62716ebf90aSShri Abhyankar           rnz = ai[i + 1] - adiag[i];
62867877ebaSShri Abhyankar           v1  = av + adiag[i];
629ad540459SPierre Jolivet           for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63016ebf90aSShri Abhyankar         }
63116ebf90aSShri Abhyankar       }
63229b521d4Sstefano_zampini     } else {
63316ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
63416ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
63516ebf90aSShri Abhyankar         v1  = av + adiag[i];
636ad540459SPierre Jolivet         for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63716ebf90aSShri Abhyankar       }
63816ebf90aSShri Abhyankar     }
63929b521d4Sstefano_zampini   }
6409566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
6413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
64216ebf90aSShri Abhyankar }
64316ebf90aSShri Abhyankar 
64466976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
645d71ae5a4SJacob Faibussowitsch {
646a6053eceSJunchao Zhang   const PetscInt    *ai, *aj, *bi, *bj, *garray, *ajj, *bjj;
647a6053eceSJunchao Zhang   PetscInt           bs;
648a6053eceSJunchao Zhang   PetscInt64         rstart, nz, i, j, k, m, jj, irow, countA, countB;
649a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
65016ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
65116ebf90aSShri Abhyankar   PetscScalar       *val;
652397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ *)A->data;
653397b6df1SKris Buschelman   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ *)(mat->A)->data;
654397b6df1SKris Buschelman   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
655ec4f40fdSPierre Jolivet   const PetscInt     bs2 = aa->bs2, mbs = aa->mbs;
65638548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
657b94d7dedSBarry Smith   PetscBool hermitian, isset;
65838548759SBarry Smith #endif
65916ebf90aSShri Abhyankar 
66016ebf90aSShri Abhyankar   PetscFunctionBegin;
66138548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
662b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
663b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
66438548759SBarry Smith #endif
6659566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
66638548759SBarry Smith   rstart = A->rmap->rstart;
66738548759SBarry Smith   ai     = aa->i;
66838548759SBarry Smith   aj     = aa->j;
66938548759SBarry Smith   bi     = bb->i;
67038548759SBarry Smith   bj     = bb->j;
67138548759SBarry Smith   av     = aa->a;
67238548759SBarry Smith   bv     = bb->a;
673397b6df1SKris Buschelman 
6742205254eSKarl Rupp   garray = mat->garray;
6752205254eSKarl Rupp 
676bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
677a6053eceSJunchao Zhang     nz = (aa->nz + bb->nz) * bs2; /* just a conservative estimate */
6789566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
6799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
680a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
681a6053eceSJunchao Zhang     mumps->irn = row;
682a6053eceSJunchao Zhang     mumps->jcn = col;
683a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
684397b6df1SKris Buschelman   } else {
685a6053eceSJunchao Zhang     val = mumps->val;
686397b6df1SKris Buschelman   }
687397b6df1SKris Buschelman 
6889371c9d4SSatish Balay   jj   = 0;
6899371c9d4SSatish Balay   irow = rstart;
690ec4f40fdSPierre Jolivet   for (i = 0; i < mbs; i++) {
691397b6df1SKris Buschelman     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
692397b6df1SKris Buschelman     countA = ai[i + 1] - ai[i];
693397b6df1SKris Buschelman     countB = bi[i + 1] - bi[i];
694397b6df1SKris Buschelman     bjj    = bj + bi[i];
695ec4f40fdSPierre Jolivet     v1     = av + ai[i] * bs2;
696ec4f40fdSPierre Jolivet     v2     = bv + bi[i] * bs2;
697397b6df1SKris Buschelman 
698ec4f40fdSPierre Jolivet     if (bs > 1) {
699ec4f40fdSPierre Jolivet       /* A-part */
700ec4f40fdSPierre Jolivet       for (j = 0; j < countA; j++) {
701ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
702ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
703ec4f40fdSPierre Jolivet             if (rstart + ajj[j] * bs > irow || k >= m) {
704ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
7059566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7069566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j] * bs + k + shift, &col[jj]));
707ec4f40fdSPierre Jolivet               }
708ec4f40fdSPierre Jolivet               val[jj++] = v1[j * bs2 + m + k * bs];
709ec4f40fdSPierre Jolivet             }
710ec4f40fdSPierre Jolivet           }
711ec4f40fdSPierre Jolivet         }
712ec4f40fdSPierre Jolivet       }
713ec4f40fdSPierre Jolivet 
714ec4f40fdSPierre Jolivet       /* B-part */
715ec4f40fdSPierre Jolivet       for (j = 0; j < countB; j++) {
716ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
717ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
718ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7199566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7209566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]] * bs + k + shift, &col[jj]));
721ec4f40fdSPierre Jolivet             }
722ec4f40fdSPierre Jolivet             val[jj++] = v2[j * bs2 + m + k * bs];
723ec4f40fdSPierre Jolivet           }
724ec4f40fdSPierre Jolivet         }
725ec4f40fdSPierre Jolivet       }
726ec4f40fdSPierre Jolivet     } else {
727397b6df1SKris Buschelman       /* A-part */
728397b6df1SKris Buschelman       for (j = 0; j < countA; j++) {
729bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7309566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7319566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
732397b6df1SKris Buschelman         }
73316ebf90aSShri Abhyankar         val[jj++] = v1[j];
734397b6df1SKris Buschelman       }
73516ebf90aSShri Abhyankar 
73616ebf90aSShri Abhyankar       /* B-part */
73716ebf90aSShri Abhyankar       for (j = 0; j < countB; j++) {
738bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7399566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7409566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
741397b6df1SKris Buschelman         }
74216ebf90aSShri Abhyankar         val[jj++] = v2[j];
74316ebf90aSShri Abhyankar       }
74416ebf90aSShri Abhyankar     }
745ec4f40fdSPierre Jolivet     irow += bs;
746ec4f40fdSPierre Jolivet   }
7475d955bbbSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = jj;
7483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
74916ebf90aSShri Abhyankar }
75016ebf90aSShri Abhyankar 
75166976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
752d71ae5a4SJacob Faibussowitsch {
75316ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
7545d955bbbSStefano Zampini   PetscInt64         rstart, cstart, nz, i, j, jj, irow, countA, countB;
755a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
75616ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
75716ebf90aSShri Abhyankar   PetscScalar       *val;
758a3d589ffSStefano Zampini   Mat                Ad, Ao;
759a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
760a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
76116ebf90aSShri Abhyankar 
76216ebf90aSShri Abhyankar   PetscFunctionBegin;
7639566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
7649566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
7659566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
766a3d589ffSStefano Zampini 
767a3d589ffSStefano Zampini   aa = (Mat_SeqAIJ *)(Ad)->data;
768a3d589ffSStefano Zampini   bb = (Mat_SeqAIJ *)(Ao)->data;
76938548759SBarry Smith   ai = aa->i;
77038548759SBarry Smith   aj = aa->j;
77138548759SBarry Smith   bi = bb->i;
77238548759SBarry Smith   bj = bb->j;
77316ebf90aSShri Abhyankar 
774a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7755d955bbbSStefano Zampini   cstart = A->cmap->rstart;
7762205254eSKarl Rupp 
777bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
778a6053eceSJunchao Zhang     nz = (PetscInt64)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
7809566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
781a6053eceSJunchao Zhang     mumps->nnz = nz;
782a6053eceSJunchao Zhang     mumps->irn = row;
783a6053eceSJunchao Zhang     mumps->jcn = col;
784a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
78516ebf90aSShri Abhyankar   } else {
786a6053eceSJunchao Zhang     val = mumps->val;
78716ebf90aSShri Abhyankar   }
78816ebf90aSShri Abhyankar 
7899371c9d4SSatish Balay   jj   = 0;
7909371c9d4SSatish Balay   irow = rstart;
79116ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
79216ebf90aSShri Abhyankar     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
79316ebf90aSShri Abhyankar     countA = ai[i + 1] - ai[i];
79416ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
79516ebf90aSShri Abhyankar     bjj    = bj + bi[i];
79616ebf90aSShri Abhyankar     v1     = av + ai[i];
79716ebf90aSShri Abhyankar     v2     = bv + bi[i];
79816ebf90aSShri Abhyankar 
79916ebf90aSShri Abhyankar     /* A-part */
80016ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
801bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8029566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8035d955bbbSStefano Zampini         PetscCall(PetscMUMPSIntCast(cstart + ajj[j] + shift, &col[jj]));
80416ebf90aSShri Abhyankar       }
80516ebf90aSShri Abhyankar       val[jj++] = v1[j];
80616ebf90aSShri Abhyankar     }
80716ebf90aSShri Abhyankar 
80816ebf90aSShri Abhyankar     /* B-part */
80916ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
810bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8119566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8129566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
81316ebf90aSShri Abhyankar       }
81416ebf90aSShri Abhyankar       val[jj++] = v2[j];
81516ebf90aSShri Abhyankar     }
81616ebf90aSShri Abhyankar     irow++;
81716ebf90aSShri Abhyankar   }
8189566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
8199566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
8203ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82116ebf90aSShri Abhyankar }
82216ebf90aSShri Abhyankar 
82366976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
824d71ae5a4SJacob Faibussowitsch {
82567877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat = (Mat_MPIBAIJ *)A->data;
82667877ebaSShri Abhyankar   Mat_SeqBAIJ       *aa  = (Mat_SeqBAIJ *)(mat->A)->data;
82767877ebaSShri Abhyankar   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
82867877ebaSShri Abhyankar   const PetscInt    *ai = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j, *ajj, *bjj;
8295d955bbbSStefano Zampini   const PetscInt    *garray = mat->garray, mbs = mat->mbs, rstart = A->rmap->rstart, cstart = A->cmap->rstart;
83033d57670SJed Brown   const PetscInt     bs2 = mat->bs2;
831a6053eceSJunchao Zhang   PetscInt           bs;
832a6053eceSJunchao Zhang   PetscInt64         nz, i, j, k, n, jj, irow, countA, countB, idx;
833a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
83467877ebaSShri Abhyankar   const PetscScalar *av = aa->a, *bv = bb->a, *v1, *v2;
83567877ebaSShri Abhyankar   PetscScalar       *val;
83667877ebaSShri Abhyankar 
83767877ebaSShri Abhyankar   PetscFunctionBegin;
8389566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
839bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
84067877ebaSShri Abhyankar     nz = bs2 * (aa->nz + bb->nz);
8419566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
8429566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
843a6053eceSJunchao Zhang     mumps->nnz = nz;
844a6053eceSJunchao Zhang     mumps->irn = row;
845a6053eceSJunchao Zhang     mumps->jcn = col;
846a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
84767877ebaSShri Abhyankar   } else {
848a6053eceSJunchao Zhang     val = mumps->val;
84967877ebaSShri Abhyankar   }
85067877ebaSShri Abhyankar 
8519371c9d4SSatish Balay   jj   = 0;
8529371c9d4SSatish Balay   irow = rstart;
85367877ebaSShri Abhyankar   for (i = 0; i < mbs; i++) {
85467877ebaSShri Abhyankar     countA = ai[i + 1] - ai[i];
85567877ebaSShri Abhyankar     countB = bi[i + 1] - bi[i];
85667877ebaSShri Abhyankar     ajj    = aj + ai[i];
85767877ebaSShri Abhyankar     bjj    = bj + bi[i];
85867877ebaSShri Abhyankar     v1     = av + bs2 * ai[i];
85967877ebaSShri Abhyankar     v2     = bv + bs2 * bi[i];
86067877ebaSShri Abhyankar 
86167877ebaSShri Abhyankar     idx = 0;
86267877ebaSShri Abhyankar     /* A-part */
86367877ebaSShri Abhyankar     for (k = 0; k < countA; k++) {
86467877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
86567877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
866bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8679566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8685d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(cstart + bs * ajj[k] + j + shift, &col[jj]));
86967877ebaSShri Abhyankar           }
87067877ebaSShri Abhyankar           val[jj++] = v1[idx++];
87167877ebaSShri Abhyankar         }
87267877ebaSShri Abhyankar       }
87367877ebaSShri Abhyankar     }
87467877ebaSShri Abhyankar 
87567877ebaSShri Abhyankar     idx = 0;
87667877ebaSShri Abhyankar     /* B-part */
87767877ebaSShri Abhyankar     for (k = 0; k < countB; k++) {
87867877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
87967877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
880bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8819566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8829566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * garray[bjj[k]] + j + shift, &col[jj]));
88367877ebaSShri Abhyankar           }
884d985c460SShri Abhyankar           val[jj++] = v2[idx++];
88567877ebaSShri Abhyankar         }
88667877ebaSShri Abhyankar       }
88767877ebaSShri Abhyankar     }
888d985c460SShri Abhyankar     irow += bs;
88967877ebaSShri Abhyankar   }
8903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
89167877ebaSShri Abhyankar }
89267877ebaSShri Abhyankar 
89366976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
894d71ae5a4SJacob Faibussowitsch {
89516ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *adiag, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
896a6053eceSJunchao Zhang   PetscInt64         rstart, nz, nza, nzb, i, j, jj, irow, countA, countB;
897a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
89816ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
89916ebf90aSShri Abhyankar   PetscScalar       *val;
900a3d589ffSStefano Zampini   Mat                Ad, Ao;
901a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
902a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
90338548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
904b94d7dedSBarry Smith   PetscBool hermitian, isset;
90538548759SBarry Smith #endif
90616ebf90aSShri Abhyankar 
90716ebf90aSShri Abhyankar   PetscFunctionBegin;
90838548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
909b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
910b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
91138548759SBarry Smith #endif
9129566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
9139566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
9149566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
915a3d589ffSStefano Zampini 
916a3d589ffSStefano Zampini   aa    = (Mat_SeqAIJ *)(Ad)->data;
917a3d589ffSStefano Zampini   bb    = (Mat_SeqAIJ *)(Ao)->data;
91838548759SBarry Smith   ai    = aa->i;
91938548759SBarry Smith   aj    = aa->j;
92038548759SBarry Smith   adiag = aa->diag;
92138548759SBarry Smith   bi    = bb->i;
92238548759SBarry Smith   bj    = bb->j;
9232205254eSKarl Rupp 
92416ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
92516ebf90aSShri Abhyankar 
926bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
927e0bace9bSHong Zhang     nza = 0; /* num of upper triangular entries in mat->A, including diagonals */
928e0bace9bSHong Zhang     nzb = 0; /* num of upper triangular entries in mat->B */
92916ebf90aSShri Abhyankar     for (i = 0; i < m; i++) {
930e0bace9bSHong Zhang       nza += (ai[i + 1] - adiag[i]);
93116ebf90aSShri Abhyankar       countB = bi[i + 1] - bi[i];
93216ebf90aSShri Abhyankar       bjj    = bj + bi[i];
933e0bace9bSHong Zhang       for (j = 0; j < countB; j++) {
934e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
935e0bace9bSHong Zhang       }
936e0bace9bSHong Zhang     }
93716ebf90aSShri Abhyankar 
938e0bace9bSHong Zhang     nz = nza + nzb; /* total nz of upper triangular part of mat */
9399566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
9409566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
941a6053eceSJunchao Zhang     mumps->nnz = nz;
942a6053eceSJunchao Zhang     mumps->irn = row;
943a6053eceSJunchao Zhang     mumps->jcn = col;
944a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
94516ebf90aSShri Abhyankar   } else {
946a6053eceSJunchao Zhang     val = mumps->val;
94716ebf90aSShri Abhyankar   }
94816ebf90aSShri Abhyankar 
9499371c9d4SSatish Balay   jj   = 0;
9509371c9d4SSatish Balay   irow = rstart;
95116ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
95216ebf90aSShri Abhyankar     ajj    = aj + adiag[i]; /* ptr to the beginning of the diagonal of this row */
95316ebf90aSShri Abhyankar     v1     = av + adiag[i];
95416ebf90aSShri Abhyankar     countA = ai[i + 1] - adiag[i];
95516ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
95616ebf90aSShri Abhyankar     bjj    = bj + bi[i];
95716ebf90aSShri Abhyankar     v2     = bv + bi[i];
95816ebf90aSShri Abhyankar 
95916ebf90aSShri Abhyankar     /* A-part */
96016ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
961bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9629566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9639566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
96416ebf90aSShri Abhyankar       }
96516ebf90aSShri Abhyankar       val[jj++] = v1[j];
96616ebf90aSShri Abhyankar     }
96716ebf90aSShri Abhyankar 
96816ebf90aSShri Abhyankar     /* B-part */
96916ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
97016ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
971bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9729566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9739566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
97416ebf90aSShri Abhyankar         }
97516ebf90aSShri Abhyankar         val[jj++] = v2[j];
97616ebf90aSShri Abhyankar       }
977397b6df1SKris Buschelman     }
978397b6df1SKris Buschelman     irow++;
979397b6df1SKris Buschelman   }
9809566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
9819566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
9823ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
983397b6df1SKris Buschelman }
984397b6df1SKris Buschelman 
985*c3e1b152SPierre Jolivet static PetscErrorCode MatConvertToTriples_diagonal_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
986*c3e1b152SPierre Jolivet {
987*c3e1b152SPierre Jolivet   const PetscScalar *av;
988*c3e1b152SPierre Jolivet   const PetscInt     M = A->rmap->n;
989*c3e1b152SPierre Jolivet   PetscInt64         i;
990*c3e1b152SPierre Jolivet   PetscMUMPSInt     *row, *col;
991*c3e1b152SPierre Jolivet   Vec                v;
992*c3e1b152SPierre Jolivet 
993*c3e1b152SPierre Jolivet   PetscFunctionBegin;
994*c3e1b152SPierre Jolivet   PetscCall(MatDiagonalGetDiagonal(A, &v));
995*c3e1b152SPierre Jolivet   PetscCall(VecGetArrayRead(v, &av));
996*c3e1b152SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
997*c3e1b152SPierre Jolivet     PetscCall(PetscMalloc2(M, &row, M, &col));
998*c3e1b152SPierre Jolivet     for (i = 0; i < M; i++) {
999*c3e1b152SPierre Jolivet       PetscCall(PetscMUMPSIntCast(i + A->rmap->rstart, &row[i]));
1000*c3e1b152SPierre Jolivet       col[i] = row[i];
1001*c3e1b152SPierre Jolivet     }
1002*c3e1b152SPierre Jolivet     mumps->val = (PetscScalar *)av;
1003*c3e1b152SPierre Jolivet     mumps->irn = row;
1004*c3e1b152SPierre Jolivet     mumps->jcn = col;
1005*c3e1b152SPierre Jolivet     mumps->nnz = M;
1006*c3e1b152SPierre Jolivet   } else PetscCall(PetscArraycpy(mumps->val, av, M));
1007*c3e1b152SPierre Jolivet   PetscCall(VecRestoreArrayRead(v, &av));
1008*c3e1b152SPierre Jolivet   PetscFunctionReturn(PETSC_SUCCESS);
1009*c3e1b152SPierre Jolivet }
1010*c3e1b152SPierre Jolivet 
101166976f2fSJacob Faibussowitsch static PetscErrorCode MatConvertToTriples_nest_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
10129d0448ceSStefano Zampini {
10139d0448ceSStefano Zampini   Mat     **mats;
10149d0448ceSStefano Zampini   PetscInt  nr, nc;
10159d0448ceSStefano Zampini   PetscBool chol = mumps->sym ? PETSC_TRUE : PETSC_FALSE;
10169d0448ceSStefano Zampini 
10179d0448ceSStefano Zampini   PetscFunctionBegin;
10189d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
10199d0448ceSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
10209d0448ceSStefano Zampini     PetscMUMPSInt *irns, *jcns;
10219d0448ceSStefano Zampini     PetscScalar   *vals;
10229d0448ceSStefano Zampini     PetscInt64     totnnz, cumnnz, maxnnz;
10239d0448ceSStefano Zampini     PetscInt      *pjcns_w;
10249d0448ceSStefano Zampini     IS            *rows, *cols;
10259d0448ceSStefano Zampini     PetscInt     **rows_idx, **cols_idx;
10269d0448ceSStefano Zampini 
10279d0448ceSStefano Zampini     cumnnz = 0;
10289d0448ceSStefano Zampini     maxnnz = 0;
10295d955bbbSStefano Zampini     PetscCall(PetscMalloc2(nr * nc + 1, &mumps->nest_vals_start, nr * nc, &mumps->nest_convert_to_triples));
10309d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
10319d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
10329d0448ceSStefano Zampini         Mat sub = mats[r][c];
10339d0448ceSStefano Zampini 
10349d0448ceSStefano Zampini         mumps->nest_convert_to_triples[r * nc + c] = NULL;
10359d0448ceSStefano Zampini         if (chol && c < r) continue; /* skip lower-triangular block for Cholesky */
10369d0448ceSStefano Zampini         if (sub) {
10379d0448ceSStefano Zampini           PetscErrorCode (*convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *) = NULL;
1038*c3e1b152SPierre Jolivet           PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans, isHTrans = PETSC_FALSE, isDiag;
10399d0448ceSStefano Zampini           MatInfo   info;
10409d0448ceSStefano Zampini 
10415d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
10425d955bbbSStefano Zampini           if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
10435d955bbbSStefano Zampini           else {
10445d955bbbSStefano Zampini             PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
10455d955bbbSStefano Zampini             if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
10465d955bbbSStefano Zampini           }
10479d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
10489d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
10499d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
10509d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
10519d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
10529d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
1053*c3e1b152SPierre Jolivet           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATDIAGONAL, &isDiag));
10549d0448ceSStefano Zampini 
10559d0448ceSStefano Zampini           if (chol) {
10569d0448ceSStefano Zampini             if (r == c) {
10579d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqsbaij;
10589d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpisbaij;
10599d0448ceSStefano Zampini               else if (isSeqSBAIJ) convert_to_triples = MatConvertToTriples_seqsbaij_seqsbaij;
10609d0448ceSStefano Zampini               else if (isMPISBAIJ) convert_to_triples = MatConvertToTriples_mpisbaij_mpisbaij;
1061*c3e1b152SPierre Jolivet               else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
10629d0448ceSStefano Zampini             } else {
10639d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10649d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10659d0448ceSStefano Zampini               else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10669d0448ceSStefano Zampini               else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
1067*c3e1b152SPierre Jolivet               else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
10689d0448ceSStefano Zampini             }
10699d0448ceSStefano Zampini           } else {
10709d0448ceSStefano Zampini             if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10719d0448ceSStefano Zampini             else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10729d0448ceSStefano Zampini             else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10739d0448ceSStefano Zampini             else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
1074*c3e1b152SPierre Jolivet             else if (isDiag) convert_to_triples = MatConvertToTriples_diagonal_xaij;
10759d0448ceSStefano Zampini           }
10769d0448ceSStefano Zampini           PetscCheck(convert_to_triples, PetscObjectComm((PetscObject)sub), PETSC_ERR_SUP, "Not for block of type %s", ((PetscObject)sub)->type_name);
10779d0448ceSStefano Zampini           mumps->nest_convert_to_triples[r * nc + c] = convert_to_triples;
10789d0448ceSStefano Zampini           PetscCall(MatGetInfo(sub, MAT_LOCAL, &info));
10799d0448ceSStefano Zampini           cumnnz += (PetscInt64)info.nz_used; /* can be overestimated for Cholesky */
10809d0448ceSStefano Zampini           maxnnz = PetscMax(maxnnz, info.nz_used);
10819d0448ceSStefano Zampini         }
10829d0448ceSStefano Zampini       }
10839d0448ceSStefano Zampini     }
10849d0448ceSStefano Zampini 
10859d0448ceSStefano Zampini     /* Allocate total COO */
10869d0448ceSStefano Zampini     totnnz = cumnnz;
10879d0448ceSStefano Zampini     PetscCall(PetscMalloc2(totnnz, &irns, totnnz, &jcns));
10889d0448ceSStefano Zampini     PetscCall(PetscMalloc1(totnnz, &vals));
10899d0448ceSStefano Zampini 
10909d0448ceSStefano Zampini     /* Handle rows and column maps
10919d0448ceSStefano Zampini        We directly map rows and use an SF for the columns */
10929d0448ceSStefano Zampini     PetscCall(PetscMalloc4(nr, &rows, nc, &cols, nr, &rows_idx, nc, &cols_idx));
10939d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
10949d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetIndices(rows[r], (const PetscInt **)&rows_idx[r]));
10959d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISGetIndices(cols[c], (const PetscInt **)&cols_idx[c]));
10969d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscMalloc1(maxnnz, &pjcns_w));
10975d955bbbSStefano Zampini     else (void)maxnnz;
10989d0448ceSStefano Zampini 
10999d0448ceSStefano Zampini     cumnnz = 0;
11009d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11019d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11029d0448ceSStefano Zampini         Mat             sub  = mats[r][c];
11039d0448ceSStefano Zampini         const PetscInt *ridx = rows_idx[r];
11045d955bbbSStefano Zampini         const PetscInt *cidx = cols_idx[c];
11059d0448ceSStefano Zampini         PetscInt        rst;
11069d0448ceSStefano Zampini         PetscSF         csf;
11075d955bbbSStefano Zampini         PetscBool       isTrans, isHTrans = PETSC_FALSE, swap;
11085d955bbbSStefano Zampini         PetscLayout     cmap;
11099d0448ceSStefano Zampini 
11109d0448ceSStefano Zampini         mumps->nest_vals_start[r * nc + c] = cumnnz;
11119d0448ceSStefano Zampini         if (!mumps->nest_convert_to_triples[r * nc + c]) continue;
11129d0448ceSStefano Zampini 
11135d955bbbSStefano Zampini         /* Extract inner blocks if needed */
11145d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
11155d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
11165d955bbbSStefano Zampini         else {
11175d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
11185d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
11195d955bbbSStefano Zampini         }
11205d955bbbSStefano Zampini         swap = (PetscBool)(isTrans || isHTrans);
11215d955bbbSStefano Zampini 
11225d955bbbSStefano Zampini         /* Get column layout to map off-process columns */
11235d955bbbSStefano Zampini         PetscCall(MatGetLayouts(sub, NULL, &cmap));
11245d955bbbSStefano Zampini 
11255d955bbbSStefano Zampini         /* Get row start to map on-process rows */
11265d955bbbSStefano Zampini         PetscCall(MatGetOwnershipRange(sub, &rst, NULL));
11275d955bbbSStefano Zampini 
11289d0448ceSStefano Zampini         /* Directly use the mumps datastructure and use C ordering for now */
11299d0448ceSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[r * nc + c])(sub, 0, MAT_INITIAL_MATRIX, mumps));
11309d0448ceSStefano Zampini 
11315d955bbbSStefano Zampini         /* Swap the role of rows and columns indices for transposed blocks
11325d955bbbSStefano Zampini            since we need values with global final ordering */
11335d955bbbSStefano Zampini         if (swap) {
11345d955bbbSStefano Zampini           cidx = rows_idx[r];
11355d955bbbSStefano Zampini           ridx = cols_idx[c];
11369d0448ceSStefano Zampini         }
11379d0448ceSStefano Zampini 
11385d955bbbSStefano Zampini         /* Communicate column indices
11395d955bbbSStefano Zampini            This could have been done with a single SF but it would have complicated the code a lot.
11405d955bbbSStefano Zampini            But since we do it only once, we pay the price of setting up an SF for each block */
11415d955bbbSStefano Zampini         if (PetscDefined(USE_64BIT_INDICES)) {
11425d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) pjcns_w[k] = mumps->jcn[k];
11435d955bbbSStefano Zampini         } else pjcns_w = (PetscInt *)(mumps->jcn); /* This cast is needed only to silence warnings for 64bit integers builds */
11449d0448ceSStefano Zampini         PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)A), &csf));
11455d955bbbSStefano Zampini         PetscCall(PetscSFSetGraphLayout(csf, cmap, mumps->nnz, NULL, PETSC_OWN_POINTER, pjcns_w));
11465d955bbbSStefano Zampini         PetscCall(PetscSFBcastBegin(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11475d955bbbSStefano Zampini         PetscCall(PetscSFBcastEnd(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11489d0448ceSStefano Zampini         PetscCall(PetscSFDestroy(&csf));
11499d0448ceSStefano Zampini 
11505d955bbbSStefano Zampini         /* Import indices: use direct map for rows and mapped indices for columns */
11515d955bbbSStefano Zampini         if (swap) {
11525d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11535d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &jcns[cumnnz + k]));
11545d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &irns[cumnnz + k]));
11555d955bbbSStefano Zampini           }
11565d955bbbSStefano Zampini         } else {
11575d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11585d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &irns[cumnnz + k]));
11595d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &jcns[cumnnz + k]));
11605d955bbbSStefano Zampini           }
11615d955bbbSStefano Zampini         }
11625d955bbbSStefano Zampini 
11635d955bbbSStefano Zampini         /* Import values to full COO */
11645d955bbbSStefano Zampini         PetscCall(PetscArraycpy(vals + cumnnz, mumps->val, mumps->nnz));
116550c845baSStefano Zampini         if (isHTrans) { /* conjugate the entries */
116650c845baSStefano Zampini           PetscScalar *v = vals + cumnnz;
116750c845baSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) v[k] = PetscConj(v[k]);
116850c845baSStefano Zampini         }
11699d0448ceSStefano Zampini 
11709d0448ceSStefano Zampini         /* Shift new starting point and sanity check */
11719d0448ceSStefano Zampini         cumnnz += mumps->nnz;
11729d0448ceSStefano Zampini         PetscCheck(cumnnz <= totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Unexpected number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11739d0448ceSStefano Zampini 
11749d0448ceSStefano Zampini         /* Free scratch memory */
11759d0448ceSStefano Zampini         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
11769d0448ceSStefano Zampini         PetscCall(PetscFree(mumps->val_alloc));
11779d0448ceSStefano Zampini         mumps->val = NULL;
11789d0448ceSStefano Zampini         mumps->nnz = 0;
11799d0448ceSStefano Zampini       }
11809d0448ceSStefano Zampini     }
11819d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscFree(pjcns_w));
11829d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISRestoreIndices(rows[r], (const PetscInt **)&rows_idx[r]));
11839d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISRestoreIndices(cols[c], (const PetscInt **)&cols_idx[c]));
11849d0448ceSStefano Zampini     PetscCall(PetscFree4(rows, cols, rows_idx, cols_idx));
11859d0448ceSStefano Zampini     if (!chol) PetscCheck(cumnnz == totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11865d955bbbSStefano Zampini     mumps->nest_vals_start[nr * nc] = cumnnz;
11879d0448ceSStefano Zampini 
11889d0448ceSStefano Zampini     /* Set pointers for final MUMPS data structure */
11899d0448ceSStefano Zampini     mumps->nest_vals = vals;
11909d0448ceSStefano Zampini     mumps->val_alloc = NULL; /* do not use val_alloc since it may be reallocated with the OMP callpath */
11919d0448ceSStefano Zampini     mumps->val       = vals;
11929d0448ceSStefano Zampini     mumps->irn       = irns;
11939d0448ceSStefano Zampini     mumps->jcn       = jcns;
11949d0448ceSStefano Zampini     mumps->nnz       = cumnnz;
11959d0448ceSStefano Zampini   } else {
11969d0448ceSStefano Zampini     PetscScalar *oval = mumps->nest_vals;
11979d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11989d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11995d955bbbSStefano Zampini         PetscBool isTrans, isHTrans = PETSC_FALSE;
12005d955bbbSStefano Zampini         Mat       sub  = mats[r][c];
12015d955bbbSStefano Zampini         PetscInt  midx = r * nc + c;
12025d955bbbSStefano Zampini 
12035d955bbbSStefano Zampini         if (!mumps->nest_convert_to_triples[midx]) continue;
12045d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
12055d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
12065d955bbbSStefano Zampini         else {
12075d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
12085d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
12095d955bbbSStefano Zampini         }
12105d955bbbSStefano Zampini         mumps->val = oval + mumps->nest_vals_start[midx];
12115d955bbbSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[midx])(sub, shift, MAT_REUSE_MATRIX, mumps));
12125d955bbbSStefano Zampini         if (isHTrans) {
12135d955bbbSStefano Zampini           PetscInt nnz = mumps->nest_vals_start[midx + 1] - mumps->nest_vals_start[midx];
12145d955bbbSStefano Zampini           for (PetscInt k = 0; k < nnz; k++) mumps->val[k] = PetscConj(mumps->val[k]);
12155d955bbbSStefano Zampini         }
12169d0448ceSStefano Zampini       }
12179d0448ceSStefano Zampini     }
12189d0448ceSStefano Zampini     mumps->val = oval;
12199d0448ceSStefano Zampini   }
12209d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
12219d0448ceSStefano Zampini }
12229d0448ceSStefano Zampini 
122366976f2fSJacob Faibussowitsch static PetscErrorCode MatDestroy_MUMPS(Mat A)
1224d71ae5a4SJacob Faibussowitsch {
1225a6053eceSJunchao Zhang   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
1226b24902e0SBarry Smith 
1227397b6df1SKris Buschelman   PetscFunctionBegin;
12289566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
12299566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
12309566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
12319566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
12329566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
12339566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
12349566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn, mumps->jcn));
12359566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
12369566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
1237413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->ICNTL_pre));
1238413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->CNTL_pre));
12399566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
1240413bcc21SPierre Jolivet   if (mumps->id.job != JOB_NULL) { /* cannot call PetscMUMPS_c() if JOB_INIT has never been called for this instance */
1241a5e57a09SHong Zhang     mumps->id.job = JOB_END;
12423ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
12439261f6e4SBarry 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));
1244413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
1245413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) PetscCallMPI(MPI_Comm_free(&mumps->mumps_comm));
1246413bcc21SPierre Jolivet       else PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A), &mumps->mumps_comm));
1247413bcc21SPierre Jolivet     }
1248413bcc21SPierre Jolivet   }
12493ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
125067602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
12519566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
12529566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
12539566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow, mumps->rhs_recvcounts, mumps->rhs_disps));
125467602552SJunchao Zhang   }
12553ab56b82SJunchao Zhang #endif
12569566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
12579566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
12589566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
12599566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
12609566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
12619d0448ceSStefano Zampini   PetscCall(PetscFree2(mumps->nest_vals_start, mumps->nest_convert_to_triples));
12629d0448ceSStefano Zampini   PetscCall(PetscFree(mumps->nest_vals));
12639566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
1264bf0cc555SLisandro Dalcin 
126597969023SHong Zhang   /* clear composed functions */
12669566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorGetSolverType_C", NULL));
12679566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorSetSchurIS_C", NULL));
12689566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorCreateSchurComplement_C", NULL));
12699566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetIcntl_C", NULL));
12709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetIcntl_C", NULL));
12719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetCntl_C", NULL));
12729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetCntl_C", NULL));
12739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfo_C", NULL));
12749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfog_C", NULL));
12759566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfo_C", NULL));
12769566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfog_C", NULL));
12775c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetNullPivots_C", NULL));
12789566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverse_C", NULL));
12799566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverseTranspose_C", NULL));
12803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1281397b6df1SKris Buschelman }
1282397b6df1SKris Buschelman 
128367602552SJunchao 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. */
1284d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A, PetscInt nrhs, const PetscScalar *array)
1285d71ae5a4SJacob Faibussowitsch {
128667602552SJunchao Zhang   Mat_MUMPS        *mumps   = (Mat_MUMPS *)A->data;
128767602552SJunchao Zhang   const PetscMPIInt ompsize = mumps->omp_comm_size;
128867602552SJunchao Zhang   PetscInt          i, m, M, rstart;
128967602552SJunchao Zhang 
129067602552SJunchao Zhang   PetscFunctionBegin;
12919566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, NULL));
12929566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, NULL));
129308401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
129467602552SJunchao Zhang   if (ompsize == 1) {
129567602552SJunchao Zhang     if (!mumps->irhs_loc) {
129667602552SJunchao Zhang       mumps->nloc_rhs = m;
12979566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m, &mumps->irhs_loc));
12989566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A, &rstart, NULL));
129967602552SJunchao Zhang       for (i = 0; i < m; i++) mumps->irhs_loc[i] = rstart + i + 1; /* use 1-based indices */
130067602552SJunchao Zhang     }
130167602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar *)array;
130267602552SJunchao Zhang   } else {
130367602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
130467602552SJunchao Zhang     const PetscInt *ranges;
130567602552SJunchao Zhang     PetscMPIInt     j, k, sendcount, *petsc_ranks, *omp_ranks;
130667602552SJunchao Zhang     MPI_Group       petsc_group, omp_group;
130767602552SJunchao Zhang     PetscScalar    *recvbuf = NULL;
130867602552SJunchao Zhang 
130967602552SJunchao Zhang     if (mumps->is_omp_master) {
131067602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
131167602552SJunchao Zhang       if (!mumps->irhs_loc) {
13129566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize, &omp_ranks, ompsize, &petsc_ranks));
13139566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize, &mumps->rhs_nrow, ompsize, &mumps->rhs_recvcounts, ompsize, &mumps->rhs_disps));
13149566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm, &petsc_group));
13159566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm, &omp_group));
131667602552SJunchao Zhang         for (j = 0; j < ompsize; j++) omp_ranks[j] = j;
13179566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group, ompsize, omp_ranks, petsc_group, petsc_ranks));
131867602552SJunchao Zhang 
131967602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
132067602552SJunchao Zhang         mumps->nloc_rhs = 0;
13219566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A, &ranges));
132267602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
132367602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j] + 1] - ranges[petsc_ranks[j]];
132467602552SJunchao Zhang           mumps->nloc_rhs += mumps->rhs_nrow[j];
132567602552SJunchao Zhang         }
13269566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs, &mumps->irhs_loc));
132767602552SJunchao Zhang         for (j = k = 0; j < ompsize; j++) {
132867602552SJunchao 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 */
132967602552SJunchao Zhang         }
133067602552SJunchao Zhang 
13319566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks, petsc_ranks));
13329566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
13339566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
133467602552SJunchao Zhang       }
133567602552SJunchao Zhang 
133667602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
133767602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
13389566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
13399566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs * nrhs, &mumps->rhs_loc, mumps->nloc_rhs * nrhs, &mumps->rhs_recvbuf));
134067602552SJunchao Zhang         mumps->max_nrhs = nrhs;
134167602552SJunchao Zhang       }
134267602552SJunchao Zhang 
134367602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
13449566063dSJacob Faibussowitsch       for (j = 0; j < ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j] * nrhs, &mumps->rhs_recvcounts[j]));
134567602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
134667602552SJunchao Zhang       for (j = 1; j < ompsize; j++) {
134767602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j - 1] + mumps->rhs_recvcounts[j - 1];
134808401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscMPIInt overflow!");
134967602552SJunchao Zhang       }
135067602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
135167602552SJunchao Zhang     }
135267602552SJunchao Zhang 
13539566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m * nrhs, &sendcount));
13549566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array, sendcount, MPIU_SCALAR, recvbuf, mumps->rhs_recvcounts, mumps->rhs_disps, MPIU_SCALAR, 0, mumps->omp_comm));
135567602552SJunchao Zhang 
135667602552SJunchao Zhang     if (mumps->is_omp_master) {
135767602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
135867602552SJunchao Zhang         PetscScalar *dst, *dstbase = mumps->rhs_loc;
135967602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
136067602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
136167602552SJunchao Zhang           dst                    = dstbase;
136267602552SJunchao Zhang           for (i = 0; i < nrhs; i++) {
13639566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst, src, mumps->rhs_nrow[j]));
136467602552SJunchao Zhang             src += mumps->rhs_nrow[j];
136567602552SJunchao Zhang             dst += mumps->nloc_rhs;
136667602552SJunchao Zhang           }
136767602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
136867602552SJunchao Zhang         }
136967602552SJunchao Zhang       }
137067602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar *)mumps->rhs_loc;
137167602552SJunchao Zhang     }
137267602552SJunchao Zhang #endif /* PETSC_HAVE_OPENMP_SUPPORT */
137367602552SJunchao Zhang   }
137467602552SJunchao Zhang   mumps->id.nrhs     = nrhs;
137567602552SJunchao Zhang   mumps->id.nloc_rhs = mumps->nloc_rhs;
137667602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
137767602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
13783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
137967602552SJunchao Zhang }
138067602552SJunchao Zhang 
138166976f2fSJacob Faibussowitsch static PetscErrorCode MatSolve_MUMPS(Mat A, Vec b, Vec x)
1382d71ae5a4SJacob Faibussowitsch {
1383e69c285eSBarry Smith   Mat_MUMPS         *mumps  = (Mat_MUMPS *)A->data;
138425aac85cSJunchao Zhang   const PetscScalar *rarray = NULL;
1385d54de34fSKris Buschelman   PetscScalar       *array;
1386329ec9b3SHong Zhang   IS                 is_iden, is_petsc;
1387329ec9b3SHong Zhang   PetscInt           i;
1388cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1389883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE, cite2 = PETSC_FALSE;
1390397b6df1SKris Buschelman 
1391397b6df1SKris Buschelman   PetscFunctionBegin;
13929371c9d4SSatish 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 "
13939371c9d4SSatish Balay                                    "Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",
13949371c9d4SSatish Balay                                    &cite1));
13959371c9d4SSatish 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 "
13969371c9d4SSatish Balay                                    "Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",
13979371c9d4SSatish Balay                                    &cite2));
13982aca8efcSHong Zhang 
1399603e8f96SBarry Smith   if (A->factorerrortype) {
14009566063dSJacob 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)));
14019566063dSJacob Faibussowitsch     PetscCall(VecSetInf(x));
14023ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
14032aca8efcSHong Zhang   }
14042aca8efcSHong Zhang 
1405a5e57a09SHong Zhang   mumps->id.nrhs = 1;
14062d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
140725aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
140867602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
14099566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b, &rarray));
14109566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, 1, rarray));
141125aac85cSJunchao Zhang     } else {
141241ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
14139566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
14149566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
141567602552SJunchao Zhang       if (!mumps->myid) {
14169566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq, &array));
141767602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar *)array;
141867602552SJunchao Zhang       }
141925aac85cSJunchao Zhang     }
14203ab56b82SJunchao Zhang   } else {                   /* petsc_size == 1 */
142167602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
14229566063dSJacob Faibussowitsch     PetscCall(VecCopy(b, x));
14239566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x, &array));
1424940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar *)array;
1425397b6df1SKris Buschelman   }
1426397b6df1SKris Buschelman 
1427cc86f929SStefano Zampini   /*
1428cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1429cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1430cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1431cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1432cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1433cc86f929SStefano Zampini   */
14343e5b40d0SPierre Jolivet   if (mumps->id.size_schur > 0) {
143508401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
14363e5b40d0SPierre Jolivet     if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1437cc86f929SStefano Zampini       second_solve = PETSC_TRUE;
14389566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
14393e5b40d0SPierre Jolivet       mumps->id.ICNTL(26) = 1; /* condensation phase */
14403e5b40d0SPierre Jolivet     } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1441cc86f929SStefano Zampini   }
1442397b6df1SKris Buschelman   /* solve phase */
1443a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
14443ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
14459261f6e4SBarry 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));
1446397b6df1SKris Buschelman 
1447b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
14481baa6e33SBarry Smith   if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
14493e5b40d0SPierre Jolivet   else if (mumps->id.ICNTL(26) == 1) {
14503e5b40d0SPierre Jolivet     PetscCall(MatMumpsSolveSchur_Private(A));
14513e5b40d0SPierre Jolivet     for (i = 0; i < mumps->id.size_schur; ++i) {
14523e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
14533e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i];
14543e5b40d0SPierre Jolivet #else
14553e5b40d0SPierre Jolivet       PetscScalar val = mumps->id.redrhs[i].r + PETSC_i * mumps->id.redrhs[i].i;
14563e5b40d0SPierre Jolivet #endif
14573e5b40d0SPierre Jolivet       array[mumps->id.listvar_schur[i] - 1] = val;
14583e5b40d0SPierre Jolivet     }
14593e5b40d0SPierre Jolivet   }
1460b5fa320bSStefano Zampini 
14612d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to petsc mpi x */
1462a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1463a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
14649566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1465397b6df1SKris Buschelman     }
1466a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1467a6053eceSJunchao Zhang       PetscInt *isol2_loc = NULL;
14689566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, mumps->id.lsol_loc, 0, 1, &is_iden)); /* from */
14699566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc, &isol2_loc));
1470a6053eceSJunchao 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 */
14719566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, mumps->id.lsol_loc, isol2_loc, PETSC_OWN_POINTER, &is_petsc)); /* to */
14729566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq, is_iden, x, is_petsc, &mumps->scat_sol));
14739566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
14749566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1475a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1476397b6df1SKris Buschelman     }
1477a5e57a09SHong Zhang 
14789566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
14799566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
1480329ec9b3SHong Zhang   }
1481353d7d71SJunchao Zhang 
148267602552SJunchao Zhang   if (mumps->petsc_size > 1) {
148325aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
14849566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b, &rarray));
148525aac85cSJunchao Zhang     } else if (!mumps->myid) {
14869566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq, &array));
148725aac85cSJunchao Zhang     }
14889566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x, &array));
1489353d7d71SJunchao Zhang 
149064412097SPierre Jolivet   PetscCall(PetscLogFlops(2.0 * PetscMax(0, (mumps->id.INFO(28) >= 0 ? mumps->id.INFO(28) : -1000000 * mumps->id.INFO(28)) - A->cmap->n)));
14913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1492397b6df1SKris Buschelman }
1493397b6df1SKris Buschelman 
149466976f2fSJacob Faibussowitsch static PetscErrorCode MatSolveTranspose_MUMPS(Mat A, Vec b, Vec x)
1495d71ae5a4SJacob Faibussowitsch {
1496e69c285eSBarry Smith   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1497338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
149851d5961aSHong Zhang 
149951d5961aSHong Zhang   PetscFunctionBegin;
1500a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
15019566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A, b, x));
1502338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
15033ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
150451d5961aSHong Zhang }
150551d5961aSHong Zhang 
150666976f2fSJacob Faibussowitsch static PetscErrorCode MatMatSolve_MUMPS(Mat A, Mat B, Mat X)
1507d71ae5a4SJacob Faibussowitsch {
1508b8491c3eSStefano Zampini   Mat                Bt = NULL;
1509a6053eceSJunchao Zhang   PetscBool          denseX, denseB, flg, flgT;
1510e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)A->data;
1511334c5f61SHong Zhang   PetscInt           i, nrhs, M;
15121683a169SBarry Smith   PetscScalar       *array;
15131683a169SBarry Smith   const PetscScalar *rbray;
1514a6053eceSJunchao Zhang   PetscInt           lsol_loc, nlsol_loc, *idxx, iidx = 0;
1515a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc, *isol_loc_save;
15161683a169SBarry Smith   PetscScalar       *bray, *sol_loc, *sol_loc_save;
1517be818407SHong Zhang   IS                 is_to, is_from;
1518beae5ec0SHong Zhang   PetscInt           k, proc, j, m, myrstart;
1519be818407SHong Zhang   const PetscInt    *rstart;
152067602552SJunchao Zhang   Vec                v_mpi, msol_loc;
152167602552SJunchao Zhang   VecScatter         scat_sol;
152267602552SJunchao Zhang   Vec                b_seq;
152367602552SJunchao Zhang   VecScatter         scat_rhs;
1524be818407SHong Zhang   PetscScalar       *aa;
1525be818407SHong Zhang   PetscInt           spnr, *ia, *ja;
1526d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1527bda8bf91SBarry Smith 
1528e0b74bf9SHong Zhang   PetscFunctionBegin;
15299566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X, &denseX, MATSEQDENSE, MATMPIDENSE, NULL));
153028b400f6SJacob Faibussowitsch   PetscCheck(denseX, PetscObjectComm((PetscObject)X), PETSC_ERR_ARG_WRONG, "Matrix X must be MATDENSE matrix");
1531be818407SHong Zhang 
15329566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B, &denseB, MATSEQDENSE, MATMPIDENSE, NULL));
1533a6053eceSJunchao Zhang   if (denseB) {
153408401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix B and X must have same row distribution");
1535be818407SHong Zhang     mumps->id.ICNTL(20) = 0; /* dense RHS */
15360e6b8875SHong Zhang   } else {                   /* sparse B */
153708401ef6SPierre Jolivet     PetscCheck(X != B, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_IDN, "X and B must be different matrices");
1538013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)B, MATTRANSPOSEVIRTUAL, &flgT));
1539da81f932SPierre Jolivet     if (flgT) { /* input B is transpose of actual RHS matrix,
15400e6b8875SHong Zhang                  because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
15419566063dSJacob Faibussowitsch       PetscCall(MatTransposeGetMat(B, &Bt));
1542013e2dc7SBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)B), PETSC_ERR_ARG_WRONG, "Matrix B must be MATTRANSPOSEVIRTUAL matrix");
1543be818407SHong Zhang     mumps->id.ICNTL(20) = 1; /* sparse RHS */
1544b8491c3eSStefano Zampini   }
154587b22cf4SHong Zhang 
15469566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, &nrhs));
15479481e6e9SHong Zhang   mumps->id.nrhs = nrhs;
15489481e6e9SHong Zhang   mumps->id.lrhs = M;
15492b691707SHong Zhang   mumps->id.rhs  = NULL;
15509481e6e9SHong Zhang 
15512d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1552b8491c3eSStefano Zampini     PetscScalar *aa;
1553b8491c3eSStefano Zampini     PetscInt     spnr, *ia, *ja;
1554e94cce23SStefano Zampini     PetscBool    second_solve = PETSC_FALSE;
1555b8491c3eSStefano Zampini 
15569566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &array));
1557b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar *)array;
15582b691707SHong Zhang 
1559a6053eceSJunchao Zhang     if (denseB) {
15602b691707SHong Zhang       /* copy B to X */
15619566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
15629566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, rbray, M * nrhs));
15639566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
15642b691707SHong Zhang     } else { /* sparse B */
15659566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt, &aa));
15669566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
156728b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
15689566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
1569b8491c3eSStefano Zampini       mumps->id.rhs_sparse = (MumpsScalar *)aa;
1570b8491c3eSStefano Zampini     }
1571e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
15723e5b40d0SPierre Jolivet     if (mumps->id.size_schur > 0) {
15733e5b40d0SPierre Jolivet       PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
15743e5b40d0SPierre Jolivet       if (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2) {
1575e94cce23SStefano Zampini         second_solve = PETSC_TRUE;
15769566063dSJacob Faibussowitsch         PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
15773e5b40d0SPierre Jolivet         mumps->id.ICNTL(26) = 1; /* condensation phase */
15783e5b40d0SPierre Jolivet       } else if (mumps->id.ICNTL(26) == 1) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1579e94cce23SStefano Zampini     }
15802cd7d884SHong Zhang     /* solve phase */
15812cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
15823ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
15839261f6e4SBarry 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));
1584b5fa320bSStefano Zampini 
1585b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
15861baa6e33SBarry Smith     if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
15873e5b40d0SPierre Jolivet     else if (mumps->id.ICNTL(26) == 1) {
15883e5b40d0SPierre Jolivet       PetscCall(MatMumpsSolveSchur_Private(A));
15893e5b40d0SPierre Jolivet       for (j = 0; j < nrhs; ++j)
15903e5b40d0SPierre Jolivet         for (i = 0; i < mumps->id.size_schur; ++i) {
15913e5b40d0SPierre Jolivet #if !defined(PETSC_USE_COMPLEX)
15923e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs];
15933e5b40d0SPierre Jolivet #else
15943e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.redrhs[i + j * mumps->id.lredrhs].r + PETSC_i * mumps->id.redrhs[i + j * mumps->id.lredrhs].i;
15953e5b40d0SPierre Jolivet #endif
15963e5b40d0SPierre Jolivet           array[mumps->id.listvar_schur[i] - 1 + j * M] = val;
15973e5b40d0SPierre Jolivet         }
15983e5b40d0SPierre Jolivet     }
1599a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
16009566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt, &aa));
16019566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
160228b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
1603b8491c3eSStefano Zampini     }
16049566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &array));
16053ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1606be818407SHong Zhang   }
1607801fbe65SHong Zhang 
16082ef1f0ffSBarry Smith   /* parallel case: MUMPS requires rhs B to be centralized on the host! */
1609aed4548fSBarry Smith   PetscCheck(mumps->petsc_size <= 1 || !mumps->id.ICNTL(19), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1610241dbb5eSStefano Zampini 
1611beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
16121683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
16131683a169SBarry Smith   sol_loc_save  = (PetscScalar *)mumps->id.sol_loc;
1614801fbe65SHong Zhang 
1615a1dfcbd9SJunchao Zhang   lsol_loc  = mumps->id.lsol_loc;
161671aed81dSHong Zhang   nlsol_loc = nrhs * lsol_loc; /* length of sol_loc */
16179566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc, &sol_loc, lsol_loc, &isol_loc));
1618940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
1619801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1620801fbe65SHong Zhang 
16219566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, nlsol_loc, (PetscScalar *)sol_loc, &msol_loc));
16222cd7d884SHong Zhang 
162367602552SJunchao Zhang   if (denseB) {
162425aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
162567602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
16269566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
16279566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, nrhs, rbray));
16289566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
16299566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
16309566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, NULL, &v_mpi));
163125aac85cSJunchao Zhang     } else {
163225aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
163380577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
163480577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
163580577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
163680577c12SJunchao Zhang       */
163780577c12SJunchao Zhang 
163867602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1639be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
16409566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
16419566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B, &bray));
16429566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16439566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B, &bray));
16442b691707SHong Zhang 
1645be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1646801fbe65SHong Zhang       if (!mumps->myid) {
1647beae5ec0SHong Zhang         PetscInt *idx;
1648beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
16499566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nrhs * M, &idx));
16509566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B, &rstart));
1651be818407SHong Zhang         k = 0;
16522d4298aeSJunchao Zhang         for (proc = 0; proc < mumps->petsc_size; proc++) {
1653be818407SHong Zhang           for (j = 0; j < nrhs; j++) {
1654beae5ec0SHong Zhang             for (i = rstart[proc]; i < rstart[proc + 1]; i++) idx[k++] = j * M + i;
1655be818407SHong Zhang           }
1656be818407SHong Zhang         }
1657be818407SHong Zhang 
16589566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, nrhs * M, &b_seq));
16599566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nrhs * M, idx, PETSC_OWN_POINTER, &is_to));
16609566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, nrhs * M, 0, 1, &is_from));
1661801fbe65SHong Zhang       } else {
16629566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, 0, &b_seq));
16639566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_to));
16649566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_from));
1665801fbe65SHong Zhang       }
16669566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi, is_from, b_seq, is_to, &scat_rhs));
16679566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
16689566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
16699566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
16709566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
1671801fbe65SHong Zhang 
1672801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
16739566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq, &bray));
1674940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar *)bray;
16759566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq, &bray));
1676801fbe65SHong Zhang       }
167725aac85cSJunchao Zhang     }
16782b691707SHong Zhang   } else { /* sparse B */
16792b691707SHong Zhang     b = (Mat_MPIAIJ *)Bt->data;
16802b691707SHong Zhang 
1681be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
16829566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X, &m, NULL));
16839566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &bray));
16849566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16859566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &bray));
16862b691707SHong Zhang 
16872b691707SHong Zhang     if (!mumps->myid) {
16889566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A, &aa));
16899566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
169028b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
16919566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
16922b691707SHong Zhang       mumps->id.rhs_sparse = (MumpsScalar *)aa;
16932b691707SHong Zhang     } else {
16942b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
16952b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
16962b691707SHong Zhang       mumps->id.nz_rhs      = 0;
16972b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
16982b691707SHong Zhang     }
16992b691707SHong Zhang   }
17002b691707SHong Zhang 
1701801fbe65SHong Zhang   /* solve phase */
1702801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
17033ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
17049261f6e4SBarry 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));
1705801fbe65SHong Zhang 
1706334c5f61SHong Zhang   /* scatter mumps distributed solution to petsc vector v_mpi, which shares local arrays with solution matrix X */
17079566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X, &array));
17089566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi, array));
1709801fbe65SHong Zhang 
1710334c5f61SHong Zhang   /* create scatter scat_sol */
17119566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X, &rstart));
1712beae5ec0SHong Zhang   /* iidx: index for scatter mumps solution to petsc X */
1713beae5ec0SHong Zhang 
17149566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, nlsol_loc, 0, 1, &is_from));
17159566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc, &idxx));
1716beae5ec0SHong Zhang   for (i = 0; i < lsol_loc; i++) {
1717beae5ec0SHong 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 */
1718beae5ec0SHong Zhang 
17192d4298aeSJunchao Zhang     for (proc = 0; proc < mumps->petsc_size; proc++) {
1720beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc + 1]) {
1721beae5ec0SHong Zhang         myrstart = rstart[proc];
1722beae5ec0SHong Zhang         k        = isol_loc[i] - myrstart;          /* local index on 1st column of petsc vector X */
1723beae5ec0SHong Zhang         iidx     = k + myrstart * nrhs;             /* maps mumps isol_loc[i] to petsc index in X */
1724beae5ec0SHong Zhang         m        = rstart[proc + 1] - rstart[proc]; /* rows of X for this proc */
1725beae5ec0SHong Zhang         break;
1726be818407SHong Zhang       }
1727be818407SHong Zhang     }
1728be818407SHong Zhang 
1729beae5ec0SHong Zhang     for (j = 0; j < nrhs; j++) idxx[i + j * lsol_loc] = iidx + j * m;
1730801fbe65SHong Zhang   }
17319566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nlsol_loc, idxx, PETSC_COPY_VALUES, &is_to));
17329566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc, is_from, v_mpi, is_to, &scat_sol));
17339566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
17349566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
17359566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
17369566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
17379566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X, &array));
173871aed81dSHong Zhang 
173971aed81dSHong Zhang   /* free spaces */
17401683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar *)sol_loc_save;
174171aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
174271aed81dSHong Zhang 
17439566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc, isol_loc));
17449566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
17459566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
17469566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1747a6053eceSJunchao Zhang   if (!denseB) {
17482b691707SHong Zhang     if (!mumps->myid) {
1749d56c302dSHong Zhang       b = (Mat_MPIAIJ *)Bt->data;
17509566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A, &aa));
17519566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
175228b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
17532b691707SHong Zhang     }
17542b691707SHong Zhang   } else {
175525aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
17569566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
17579566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
175825aac85cSJunchao Zhang     }
17592b691707SHong Zhang   }
17609566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
176164412097SPierre 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))));
17623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1763e0b74bf9SHong Zhang }
1764e0b74bf9SHong Zhang 
176566976f2fSJacob Faibussowitsch static PetscErrorCode MatMatSolveTranspose_MUMPS(Mat A, Mat B, Mat X)
1766d71ae5a4SJacob Faibussowitsch {
1767b18964edSHong Zhang   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1768338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
1769b18964edSHong Zhang 
1770b18964edSHong Zhang   PetscFunctionBegin;
1771b18964edSHong Zhang   mumps->id.ICNTL(9) = 0;
1772b18964edSHong Zhang   PetscCall(MatMatSolve_MUMPS(A, B, X));
1773338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
17743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1775b18964edSHong Zhang }
1776b18964edSHong Zhang 
177766976f2fSJacob Faibussowitsch static PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A, Mat Bt, Mat X)
1778d71ae5a4SJacob Faibussowitsch {
1779eb3ef3b2SHong Zhang   PetscBool flg;
1780eb3ef3b2SHong Zhang   Mat       B;
1781eb3ef3b2SHong Zhang 
1782eb3ef3b2SHong Zhang   PetscFunctionBegin;
17839566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
178428b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)Bt), PETSC_ERR_ARG_WRONG, "Matrix Bt must be MATAIJ matrix");
1785eb3ef3b2SHong Zhang 
1786eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
17879566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt, &B));
1788eb3ef3b2SHong Zhang 
17899566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A, B, X));
17909566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
17913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1792eb3ef3b2SHong Zhang }
1793eb3ef3b2SHong Zhang 
1794ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1795a58c3f20SHong Zhang /*
1796a58c3f20SHong Zhang   input:
1797a58c3f20SHong Zhang    F:        numeric factor
1798a58c3f20SHong Zhang   output:
1799a58c3f20SHong Zhang    nneg:     total number of negative pivots
180019d49a3bSHong Zhang    nzero:    total number of zero pivots
180119d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1802a58c3f20SHong Zhang */
180366976f2fSJacob Faibussowitsch static PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F, PetscInt *nneg, PetscInt *nzero, PetscInt *npos)
1804d71ae5a4SJacob Faibussowitsch {
1805e69c285eSBarry Smith   Mat_MUMPS  *mumps = (Mat_MUMPS *)F->data;
1806c1490034SHong Zhang   PetscMPIInt size;
1807a58c3f20SHong Zhang 
1808a58c3f20SHong Zhang   PetscFunctionBegin;
18099566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F), &size));
1810bcb30aebSHong 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 */
1811aed4548fSBarry 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));
1812ed85ac9fSHong Zhang 
1813710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1814ed85ac9fSHong Zhang   if (nzero || npos) {
181508401ef6SPierre 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");
1816710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1817710ac8efSHong Zhang     if (npos) *npos = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1818a58c3f20SHong Zhang   }
18193ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1820a58c3f20SHong Zhang }
182119d49a3bSHong Zhang #endif
1822a58c3f20SHong Zhang 
182366976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse, Mat_MUMPS *mumps)
1824d71ae5a4SJacob Faibussowitsch {
1825a6053eceSJunchao Zhang   PetscInt       i, nreqs;
1826a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;
1827a6053eceSJunchao Zhang   PetscMPIInt    count;
1828a6053eceSJunchao Zhang   PetscInt64     totnnz, remain;
1829a6053eceSJunchao Zhang   const PetscInt osize = mumps->omp_comm_size;
1830a6053eceSJunchao Zhang   PetscScalar   *val;
18313ab56b82SJunchao Zhang 
18323ab56b82SJunchao Zhang   PetscFunctionBegin;
1833a6053eceSJunchao Zhang   if (osize > 1) {
18343ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
18353ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
18369566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize, &mumps->recvcount));
18379566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz, 1, MPIU_INT64, mumps->recvcount, 1, MPIU_INT64, 0 /*master*/, mumps->omp_comm));
18383ab56b82SJunchao Zhang 
1839a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
18403ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1841a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1842a6053eceSJunchao Zhang         nreqs = 0;
1843a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) nreqs += (mumps->recvcount[i] + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
1844a6053eceSJunchao Zhang       } else {
1845a6053eceSJunchao Zhang         nreqs = (mumps->nnz + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
18463ab56b82SJunchao Zhang       }
184735cb6cd3SPierre Jolivet       PetscCall(PetscMalloc1(nreqs * 3, &mumps->reqs)); /* Triple the requests since we send irn, jcn and val separately */
18483ab56b82SJunchao Zhang 
1849a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1850a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1851a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1852a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1853a6053eceSJunchao Zhang        */
1854a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
18553ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1856a6053eceSJunchao Zhang         for (i = 0, totnnz = 0; i < osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
18579566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz, &irn, totnnz, &jcn));
18589566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz, &val));
1859a6053eceSJunchao Zhang 
1860a6053eceSJunchao Zhang         /* Self communication */
18619566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn, mumps->irn, mumps->nnz));
18629566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn, mumps->jcn, mumps->nnz));
18639566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val, mumps->val, mumps->nnz));
1864a6053eceSJunchao Zhang 
1865a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
18669566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
18679566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1868a6053eceSJunchao Zhang         mumps->nnz = totnnz;
18693ab56b82SJunchao Zhang         mumps->irn = irn;
18703ab56b82SJunchao Zhang         mumps->jcn = jcn;
1871a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1872a6053eceSJunchao Zhang 
1873a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
1874a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
1875a6053eceSJunchao Zhang         val += mumps->recvcount[0];
1876a6053eceSJunchao Zhang 
1877a6053eceSJunchao Zhang         /* Remote communication */
1878a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) {
1879a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1880a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1881a6053eceSJunchao Zhang           while (count > 0) {
18829566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(irn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18839566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(jcn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18849566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1885a6053eceSJunchao Zhang             irn += count;
1886a6053eceSJunchao Zhang             jcn += count;
1887a6053eceSJunchao Zhang             val += count;
1888a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1889a6053eceSJunchao Zhang             remain -= count;
1890a6053eceSJunchao Zhang           }
18913ab56b82SJunchao Zhang         }
18923ab56b82SJunchao Zhang       } else {
1893a6053eceSJunchao Zhang         irn    = mumps->irn;
1894a6053eceSJunchao Zhang         jcn    = mumps->jcn;
1895a6053eceSJunchao Zhang         val    = mumps->val;
1896a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1897a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1898a6053eceSJunchao Zhang         while (count > 0) {
18999566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(irn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
19009566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(jcn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
19019566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1902a6053eceSJunchao Zhang           irn += count;
1903a6053eceSJunchao Zhang           jcn += count;
1904a6053eceSJunchao Zhang           val += count;
1905a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1906a6053eceSJunchao Zhang           remain -= count;
19073ab56b82SJunchao Zhang         }
19083ab56b82SJunchao Zhang       }
1909a6053eceSJunchao Zhang     } else {
1910a6053eceSJunchao Zhang       nreqs = 0;
1911a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
1912a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
1913a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) { /* Remote communication only since self data is already in place */
1914a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1915a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1916a6053eceSJunchao Zhang           while (count > 0) {
19179566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1918a6053eceSJunchao Zhang             val += count;
1919a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1920a6053eceSJunchao Zhang             remain -= count;
1921a6053eceSJunchao Zhang           }
1922a6053eceSJunchao Zhang         }
1923a6053eceSJunchao Zhang       } else {
1924a6053eceSJunchao Zhang         val    = mumps->val;
1925a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1926a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1927a6053eceSJunchao Zhang         while (count > 0) {
19289566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1929a6053eceSJunchao Zhang           val += count;
1930a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1931a6053eceSJunchao Zhang           remain -= count;
1932a6053eceSJunchao Zhang         }
1933a6053eceSJunchao Zhang       }
1934a6053eceSJunchao Zhang     }
19359566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs, mumps->reqs, MPI_STATUSES_IGNORE));
1936a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
1937a6053eceSJunchao Zhang   }
19383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
19393ab56b82SJunchao Zhang }
19403ab56b82SJunchao Zhang 
194166976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorNumeric_MUMPS(Mat F, Mat A, const MatFactorInfo *info)
1942d71ae5a4SJacob Faibussowitsch {
1943e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)(F)->data;
1944ace3abfcSBarry Smith   PetscBool  isMPIAIJ;
1945397b6df1SKris Buschelman 
1946397b6df1SKris Buschelman   PetscFunctionBegin;
1947dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
194848a46eb9SPierre 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)));
19499566063dSJacob 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)));
19503ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
19512aca8efcSHong Zhang   }
19526baea169SHong Zhang 
19539566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
19549566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX, mumps));
1955397b6df1SKris Buschelman 
1956397b6df1SKris Buschelman   /* numerical factorization phase */
1957a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
19584e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
1959ad540459SPierre Jolivet     if (!mumps->myid) mumps->id.a = (MumpsScalar *)mumps->val;
1960397b6df1SKris Buschelman   } else {
1961940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar *)mumps->val;
1962397b6df1SKris Buschelman   }
19633ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1964a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
19659261f6e4SBarry 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));
19669261f6e4SBarry Smith     if (mumps->id.INFOG(1) == -10) {
19679261f6e4SBarry 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)));
1968603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
1969c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -13) {
19709261f6e4SBarry 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)));
1971603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1972c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
19739261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorizatione: INFOG(1)=%d, INFO(2)=%d, problem with work array\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1974603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
19752aca8efcSHong Zhang     } else {
19769261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1977603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
1978151787a6SHong Zhang     }
19792aca8efcSHong Zhang   }
19809261f6e4SBarry 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));
1981397b6df1SKris Buschelman 
1982b3cb21ddSStefano Zampini   F->assembled = PETSC_TRUE;
1983d47f36abSHong Zhang 
1984b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
19853cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
1986c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
19873cb7dd0eSStefano Zampini #endif
1988b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
1989b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
19909566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur, MAT_INPLACE_MATRIX, &F->schur));
1991b3cb21ddSStefano Zampini     }
19929566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F, NULL, MAT_FACTOR_SCHUR_UNFACTORED));
1993b3cb21ddSStefano Zampini   }
199467877ebaSShri Abhyankar 
1995066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
1996066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
1997066565c5SStefano Zampini 
19983ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
19992d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
200067877ebaSShri Abhyankar     PetscInt     lsol_loc;
200167877ebaSShri Abhyankar     PetscScalar *sol_loc;
20022205254eSKarl Rupp 
20039566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A, MATMPIAIJ, &isMPIAIJ));
2004c2093ab7SHong Zhang 
2005c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
2006c2093ab7SHong Zhang     if (mumps->x_seq) {
20079566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
20089566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
20099566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
2010c2093ab7SHong Zhang     }
2011a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
20129566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc, &sol_loc, lsol_loc, &mumps->id.isol_loc));
2013a5e57a09SHong Zhang     mumps->id.lsol_loc = lsol_loc;
2014940cd9d6SSatish Balay     mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
20159566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, lsol_loc, sol_loc, &mumps->x_seq));
201667877ebaSShri Abhyankar   }
20179566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(mumps->id.RINFO(2)));
20183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2019397b6df1SKris Buschelman }
2020397b6df1SKris Buschelman 
20219a2535b5SHong Zhang /* Sets MUMPS options from the options database */
202266976f2fSJacob Faibussowitsch static PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
2023d71ae5a4SJacob Faibussowitsch {
2024e69c285eSBarry Smith   Mat_MUMPS    *mumps = (Mat_MUMPS *)F->data;
2025413bcc21SPierre Jolivet   PetscMUMPSInt icntl = 0, size, *listvar_schur;
202645e3843bSPierre Jolivet   PetscInt      info[80], i, ninfo = 80, rbs, cbs;
2027413bcc21SPierre Jolivet   PetscBool     flg = PETSC_FALSE, schur = (PetscBool)(mumps->id.ICNTL(26) == -1);
2028413bcc21SPierre Jolivet   MumpsScalar  *arr;
2029dcd589f8SShri Abhyankar 
2030dcd589f8SShri Abhyankar   PetscFunctionBegin;
203126cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F), ((PetscObject)F)->prefix, "MUMPS Options", "Mat");
2032413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) { /* MatSetFromOptions_MUMPS() has never been called before */
2033413bcc21SPierre Jolivet     PetscInt nthreads   = 0;
2034413bcc21SPierre Jolivet     PetscInt nCNTL_pre  = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
2035413bcc21SPierre Jolivet     PetscInt nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
2036413bcc21SPierre Jolivet 
2037413bcc21SPierre Jolivet     mumps->petsc_comm = PetscObjectComm((PetscObject)A);
2038413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->petsc_comm, &mumps->petsc_size));
2039413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm, &mumps->myid)); /* "if (!myid)" still works even if mumps_comm is different */
2040413bcc21SPierre Jolivet 
2041413bcc21SPierre Jolivet     PetscCall(PetscOptionsName("-mat_mumps_use_omp_threads", "Convert MPI processes into OpenMP threads", "None", &mumps->use_petsc_omp_support));
2042413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
2043413bcc21SPierre Jolivet     /* do not use PetscOptionsInt() so that the option -mat_mumps_use_omp_threads is not displayed twice in the help */
2044413bcc21SPierre Jolivet     PetscCall(PetscOptionsGetInt(NULL, ((PetscObject)F)->prefix, "-mat_mumps_use_omp_threads", &nthreads, NULL));
2045413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) {
20469371c9d4SSatish Balay       PetscCheck(PetscDefined(HAVE_OPENMP_SUPPORT), PETSC_COMM_SELF, PETSC_ERR_SUP_SYS, "The system does not have PETSc OpenMP support but you added the -%smat_mumps_use_omp_threads option. Configure PETSc with --with-openmp --download-hwloc (or --with-hwloc) to enable it, see more in MATSOLVERMUMPS manual",
20479371c9d4SSatish Balay                  ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
2048413bcc21SPierre 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 : "");
2049413bcc21SPierre Jolivet #if defined(PETSC_HAVE_OPENMP_SUPPORT)
2050413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm, nthreads, &mumps->omp_ctrl));
2051413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl, &mumps->omp_comm, &mumps->mumps_comm, &mumps->is_omp_master));
2052413bcc21SPierre Jolivet #endif
2053413bcc21SPierre Jolivet     } else {
2054413bcc21SPierre Jolivet       mumps->omp_comm      = PETSC_COMM_SELF;
2055413bcc21SPierre Jolivet       mumps->mumps_comm    = mumps->petsc_comm;
2056413bcc21SPierre Jolivet       mumps->is_omp_master = PETSC_TRUE;
2057413bcc21SPierre Jolivet     }
2058413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->omp_comm, &mumps->omp_comm_size));
2059413bcc21SPierre Jolivet     mumps->reqs = NULL;
2060413bcc21SPierre Jolivet     mumps->tag  = 0;
2061413bcc21SPierre Jolivet 
2062413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
2063413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) {
2064413bcc21SPierre Jolivet         /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
2065413bcc21SPierre Jolivet         MPI_Comm comm;
2066413bcc21SPierre Jolivet         PetscCallMPI(MPI_Comm_dup(mumps->mumps_comm, &comm));
2067413bcc21SPierre Jolivet         mumps->mumps_comm = comm;
2068413bcc21SPierre Jolivet       } else PetscCall(PetscCommGetComm(mumps->petsc_comm, &mumps->mumps_comm));
2069413bcc21SPierre Jolivet     }
2070413bcc21SPierre Jolivet 
2071413bcc21SPierre Jolivet     mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
2072413bcc21SPierre Jolivet     mumps->id.job          = JOB_INIT;
2073413bcc21SPierre Jolivet     mumps->id.par          = 1; /* host participates factorizaton and solve */
2074413bcc21SPierre Jolivet     mumps->id.sym          = mumps->sym;
2075413bcc21SPierre Jolivet 
2076413bcc21SPierre Jolivet     size          = mumps->id.size_schur;
2077413bcc21SPierre Jolivet     arr           = mumps->id.schur;
2078413bcc21SPierre Jolivet     listvar_schur = mumps->id.listvar_schur;
2079413bcc21SPierre Jolivet     PetscMUMPS_c(mumps);
20809261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
2081413bcc21SPierre Jolivet     /* restore cached ICNTL and CNTL values */
2082413bcc21SPierre Jolivet     for (icntl = 0; icntl < nICNTL_pre; ++icntl) mumps->id.ICNTL(mumps->ICNTL_pre[1 + 2 * icntl]) = mumps->ICNTL_pre[2 + 2 * icntl];
2083413bcc21SPierre Jolivet     for (icntl = 0; icntl < nCNTL_pre; ++icntl) mumps->id.CNTL((PetscInt)mumps->CNTL_pre[1 + 2 * icntl]) = mumps->CNTL_pre[2 + 2 * icntl];
2084413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->ICNTL_pre));
2085413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->CNTL_pre));
2086413bcc21SPierre Jolivet 
2087413bcc21SPierre Jolivet     if (schur) {
2088413bcc21SPierre Jolivet       mumps->id.size_schur    = size;
2089413bcc21SPierre Jolivet       mumps->id.schur_lld     = size;
2090413bcc21SPierre Jolivet       mumps->id.schur         = arr;
2091413bcc21SPierre Jolivet       mumps->id.listvar_schur = listvar_schur;
2092413bcc21SPierre Jolivet       if (mumps->petsc_size > 1) {
2093413bcc21SPierre Jolivet         PetscBool gs; /* gs is false if any rank other than root has non-empty IS */
2094413bcc21SPierre Jolivet 
2095413bcc21SPierre Jolivet         mumps->id.ICNTL(19) = 1;                                                                            /* MUMPS returns Schur centralized on the host */
2096413bcc21SPierre 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 */
2097712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &gs, 1, MPIU_BOOL, MPI_LAND, mumps->petsc_comm));
2098413bcc21SPierre Jolivet         PetscCheck(gs, PETSC_COMM_SELF, PETSC_ERR_SUP, "MUMPS distributed parallel Schur complements not yet supported from PETSc");
2099413bcc21SPierre Jolivet       } else {
2100413bcc21SPierre Jolivet         if (F->factortype == MAT_FACTOR_LU) {
2101413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
2102413bcc21SPierre Jolivet         } else {
2103413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
2104413bcc21SPierre Jolivet         }
2105413bcc21SPierre Jolivet       }
2106413bcc21SPierre Jolivet       mumps->id.ICNTL(26) = -1;
2107413bcc21SPierre Jolivet     }
2108413bcc21SPierre Jolivet 
2109413bcc21SPierre Jolivet     /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
2110413bcc21SPierre Jolivet        For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
2111413bcc21SPierre Jolivet      */
2112413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.icntl, 40, MPI_INT, 0, mumps->omp_comm));
2113413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15, MPIU_REAL, 0, mumps->omp_comm));
2114413bcc21SPierre Jolivet 
2115413bcc21SPierre Jolivet     mumps->scat_rhs = NULL;
2116413bcc21SPierre Jolivet     mumps->scat_sol = NULL;
2117413bcc21SPierre Jolivet 
2118413bcc21SPierre Jolivet     /* set PETSc-MUMPS default options - override MUMPS default */
2119413bcc21SPierre Jolivet     mumps->id.ICNTL(3) = 0;
2120413bcc21SPierre Jolivet     mumps->id.ICNTL(4) = 0;
2121413bcc21SPierre Jolivet     if (mumps->petsc_size == 1) {
2122413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 0; /* centralized assembled matrix input */
2123413bcc21SPierre Jolivet       mumps->id.ICNTL(7)  = 7; /* automatic choice of ordering done by the package */
2124413bcc21SPierre Jolivet     } else {
2125413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 3; /* distributed assembled matrix input */
2126413bcc21SPierre Jolivet       mumps->id.ICNTL(21) = 1; /* distributed solution */
2127413bcc21SPierre Jolivet     }
2128413bcc21SPierre Jolivet   }
21299566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1", "ICNTL(1): output stream for error messages", "None", mumps->id.ICNTL(1), &icntl, &flg));
21309a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
21319566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2", "ICNTL(2): output stream for diagnostic printing, statistics, and warning", "None", mumps->id.ICNTL(2), &icntl, &flg));
21329a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
21339566063dSJacob 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));
21349a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
2135dcd589f8SShri Abhyankar 
21369566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4", "ICNTL(4): level of printing (0 to 4)", "None", mumps->id.ICNTL(4), &icntl, &flg));
21379a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
21389a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
21399a2535b5SHong Zhang 
21409566063dSJacob 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));
21419a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
21429a2535b5SHong Zhang 
21439566063dSJacob 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));
2144dcd589f8SShri Abhyankar   if (flg) {
2145aed4548fSBarry 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");
2146b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
2147dcd589f8SShri Abhyankar   }
2148e0b74bf9SHong Zhang 
21499566063dSJacob 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));
21509566063dSJacob 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() */
21519566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10", "ICNTL(10): max num of refinements", "None", mumps->id.ICNTL(10), &mumps->id.ICNTL(10), NULL));
21529566063dSJacob 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));
21539566063dSJacob 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));
21549566063dSJacob 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));
21559566063dSJacob 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));
215645e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A, &rbs, &cbs));
215745e3843bSPierre Jolivet   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = -rbs;
215845e3843bSPierre 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));
215945e3843bSPierre Jolivet   if (flg) {
216045e3843bSPierre Jolivet     PetscCheck(mumps->id.ICNTL(15) <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Positive -mat_mumps_icntl_15 not handled");
216145e3843bSPierre Jolivet     PetscCheck((-mumps->id.ICNTL(15) % cbs == 0) && (-mumps->id.ICNTL(15) % rbs == 0), PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "The opposite of -mat_mumps_icntl_15 must be a multiple of the column and row blocksizes");
216245e3843bSPierre Jolivet   }
21639566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19", "ICNTL(19): computes the Schur complement", "None", mumps->id.ICNTL(19), &mumps->id.ICNTL(19), NULL));
216459ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
21659566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
21669566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
216759ac8732SStefano Zampini   }
216825aac85cSJunchao Zhang 
216943f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
217043f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
217125aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
217243f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
217343f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
217443f3b051SJunchao Zhang      In short, we could not use distributed RHS with MPICH until v4.0b1.
217525aac85cSJunchao Zhang    */
217643f3b051SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0) || (defined(PETSC_HAVE_MPICH_NUMVERSION) && (PETSC_HAVE_MPICH_NUMVERSION < 40000101))
217725aac85cSJunchao Zhang   mumps->ICNTL20 = 0; /* Centralized dense RHS*/
217843f3b051SJunchao Zhang #else
217943f3b051SJunchao Zhang   mumps->ICNTL20     = 10; /* Distributed dense RHS*/
218025aac85cSJunchao Zhang #endif
21819566063dSJacob 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));
2182aed4548fSBarry 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);
218325aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0)
2184aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10, PETSC_COMM_SELF, PETSC_ERR_SUP, "ICNTL(20)=10 is not supported before MUMPS-5.3.0");
218525aac85cSJunchao Zhang #endif
21869566063dSJacob 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 */
21879a2535b5SHong Zhang 
21889566063dSJacob 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));
21899566063dSJacob 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));
21909566063dSJacob 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));
21919371c9d4SSatish Balay   if (mumps->id.ICNTL(24)) { mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */ }
2192d7ebd59bSHong Zhang 
21939566063dSJacob 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));
21949566063dSJacob 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));
21959566063dSJacob 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));
21969566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_28", "ICNTL(28): use 1 for sequential analysis and ictnl(7) ordering, or 2 for parallel analysis and ictnl(29) ordering", "None", mumps->id.ICNTL(28), &mumps->id.ICNTL(28), NULL));
21979566063dSJacob 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));
21989566063dSJacob 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 */
21999566063dSJacob 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));
2200145b44c9SPierre 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 */
22019566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33", "ICNTL(33): compute determinant", "None", mumps->id.ICNTL(33), &mumps->id.ICNTL(33), NULL));
22029566063dSJacob 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));
22039566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36", "ICNTL(36): choice of BLR factorization variant", "None", mumps->id.ICNTL(36), &mumps->id.ICNTL(36), NULL));
22049566063dSJacob 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));
2205146931dbSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_58", "ICNTL(58): defines options for symbolic factorization", "None", mumps->id.ICNTL(58), &mumps->id.ICNTL(58), NULL));
2206dcd589f8SShri Abhyankar 
22079566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1", "CNTL(1): relative pivoting threshold", "None", mumps->id.CNTL(1), &mumps->id.CNTL(1), NULL));
22089566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2", "CNTL(2): stopping criterion of refinement", "None", mumps->id.CNTL(2), &mumps->id.CNTL(2), NULL));
22099566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3", "CNTL(3): absolute pivoting threshold", "None", mumps->id.CNTL(3), &mumps->id.CNTL(3), NULL));
22109566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4", "CNTL(4): value for static pivoting", "None", mumps->id.CNTL(4), &mumps->id.CNTL(4), NULL));
22119566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5", "CNTL(5): fixation for null pivots", "None", mumps->id.CNTL(5), &mumps->id.CNTL(5), NULL));
22129566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7", "CNTL(7): dropping parameter used during BLR", "None", mumps->id.CNTL(7), &mumps->id.CNTL(7), NULL));
2213e5bb22a1SHong Zhang 
22149566063dSJacob 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));
2215b34f08ffSHong Zhang 
22169566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info", "request INFO local to each processor", "", info, &ninfo, NULL));
2217b34f08ffSHong Zhang   if (ninfo) {
221808401ef6SPierre Jolivet     PetscCheck(ninfo <= 80, PETSC_COMM_SELF, PETSC_ERR_USER, "number of INFO %" PetscInt_FMT " must <= 80", ninfo);
22199566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo, &mumps->info));
2220b34f08ffSHong Zhang     mumps->ninfo = ninfo;
2221b34f08ffSHong Zhang     for (i = 0; i < ninfo; i++) {
2222aed4548fSBarry 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);
2223f7d195e4SLawrence Mitchell       mumps->info[i] = info[i];
2224b34f08ffSHong Zhang     }
2225b34f08ffSHong Zhang   }
2226d0609cedSBarry Smith   PetscOptionsEnd();
22273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2228dcd589f8SShri Abhyankar }
2229dcd589f8SShri Abhyankar 
223066976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F, Mat A, const MatFactorInfo *info, Mat_MUMPS *mumps)
2231d71ae5a4SJacob Faibussowitsch {
22325cd7cf9dSHong Zhang   PetscFunctionBegin;
22335cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
22349261f6e4SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in analysis: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
22355cd7cf9dSHong Zhang     if (mumps->id.INFOG(1) == -6) {
22369261f6e4SBarry 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)));
2237603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
22385cd7cf9dSHong Zhang     } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
22399261f6e4SBarry 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)));
2240603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
2241dbf6bb8dSprj-     } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
22429261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: empty matrix\n"));
22435cd7cf9dSHong Zhang     } else {
22449261f6e4SBarry 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)));
2245603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
22465cd7cf9dSHong Zhang     }
22475cd7cf9dSHong Zhang   }
22483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
22495cd7cf9dSHong Zhang }
22505cd7cf9dSHong Zhang 
225166976f2fSJacob Faibussowitsch static PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2252d71ae5a4SJacob Faibussowitsch {
2253e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
225467877ebaSShri Abhyankar   Vec            b;
225567877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2256397b6df1SKris Buschelman 
2257397b6df1SKris Buschelman   PetscFunctionBegin;
2258d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2259d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
22603ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2261d47f36abSHong Zhang   }
2262dcd589f8SShri Abhyankar 
22639a2535b5SHong Zhang   /* Set MUMPS options from the options database */
226426cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2265dcd589f8SShri Abhyankar 
22669566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
22679566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2268dcd589f8SShri Abhyankar 
226967877ebaSShri Abhyankar   /* analysis phase */
2270a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2271a5e57a09SHong Zhang   mumps->id.n   = M;
2272a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
227367877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2274a5e57a09SHong Zhang     if (!mumps->myid) {
2275a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2276a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2277a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2278a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
22794ac6704cSBarry Smith       if (r) {
22804ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
2281a5e57a09SHong Zhang         if (!mumps->myid) {
2282e0b74bf9SHong Zhang           const PetscInt *idx;
2283a6053eceSJunchao Zhang           PetscInt        i;
22842205254eSKarl Rupp 
22859566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M, &mumps->id.perm_in));
22869566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r, &idx));
22879566063dSJacob Faibussowitsch           for (i = 0; i < M; i++) PetscCall(PetscMUMPSIntCast(idx[i] + 1, &(mumps->id.perm_in[i]))); /* perm_in[]: start from 1, not 0! */
22889566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r, &idx));
2289e0b74bf9SHong Zhang         }
2290e0b74bf9SHong Zhang       }
229167877ebaSShri Abhyankar     }
229267877ebaSShri Abhyankar     break;
229367877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2294a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2295a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2296a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2297a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
229825aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
22999566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23009566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23019566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
230225aac85cSJunchao Zhang     }
230367877ebaSShri Abhyankar     break;
230467877ebaSShri Abhyankar   }
23053ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23069566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
230767877ebaSShri Abhyankar 
2308719d5645SBarry Smith   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2309dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
231051d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
23114e34a73bSHong Zhang   F->ops->matsolve          = MatMatSolve_MUMPS;
2312eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
2313b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2314d47f36abSHong Zhang 
2315d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2317b24902e0SBarry Smith }
2318b24902e0SBarry Smith 
2319450b117fSShri Abhyankar /* Note the Petsc r and c permutations are ignored */
232066976f2fSJacob Faibussowitsch static PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2321d71ae5a4SJacob Faibussowitsch {
2322e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
232367877ebaSShri Abhyankar   Vec            b;
232467877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2325450b117fSShri Abhyankar 
2326450b117fSShri Abhyankar   PetscFunctionBegin;
2327d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2328338d3105SPierre Jolivet     /* F is assembled by a previous call of MatLUFactorSymbolic_BAIJMUMPS() */
23293ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2330d47f36abSHong Zhang   }
2331dcd589f8SShri Abhyankar 
23329a2535b5SHong Zhang   /* Set MUMPS options from the options database */
233326cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2334dcd589f8SShri Abhyankar 
23359566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23369566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
233767877ebaSShri Abhyankar 
233867877ebaSShri Abhyankar   /* analysis phase */
2339a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2340a5e57a09SHong Zhang   mumps->id.n   = M;
2341a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
234267877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2343a5e57a09SHong Zhang     if (!mumps->myid) {
2344a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2345a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2346a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2347ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
234867877ebaSShri Abhyankar     }
234967877ebaSShri Abhyankar     break;
235067877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2351a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2352a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2353a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2354ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
235525aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
23569566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23579566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23589566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
235925aac85cSJunchao Zhang     }
236067877ebaSShri Abhyankar     break;
236167877ebaSShri Abhyankar   }
23623ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23639566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
236467877ebaSShri Abhyankar 
2365450b117fSShri Abhyankar   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2366dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
236751d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
2368b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2369d47f36abSHong Zhang 
2370d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23713ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2372450b117fSShri Abhyankar }
2373b24902e0SBarry Smith 
2374141f4205SHong Zhang /* Note the Petsc r permutation and factor info are ignored */
237566976f2fSJacob Faibussowitsch static PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F, Mat A, IS r, const MatFactorInfo *info)
2376d71ae5a4SJacob Faibussowitsch {
2377e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
237867877ebaSShri Abhyankar   Vec            b;
237967877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2380397b6df1SKris Buschelman 
2381397b6df1SKris Buschelman   PetscFunctionBegin;
2382d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2383338d3105SPierre Jolivet     /* F is assembled by a previous call of MatCholeskyFactorSymbolic_MUMPS() */
23843ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2385d47f36abSHong Zhang   }
2386dcd589f8SShri Abhyankar 
23879a2535b5SHong Zhang   /* Set MUMPS options from the options database */
238826cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2389dcd589f8SShri Abhyankar 
23909566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23919566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2392dcd589f8SShri Abhyankar 
239367877ebaSShri Abhyankar   /* analysis phase */
2394a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2395a5e57a09SHong Zhang   mumps->id.n   = M;
2396a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
239767877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2398a5e57a09SHong Zhang     if (!mumps->myid) {
2399a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2400a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2401a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2402ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
240367877ebaSShri Abhyankar     }
240467877ebaSShri Abhyankar     break;
240567877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2406a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2407a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2408a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2409ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
241025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
24119566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
24129566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
24139566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
241425aac85cSJunchao Zhang     }
241567877ebaSShri Abhyankar     break;
241667877ebaSShri Abhyankar   }
24173ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
24189566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
24195cd7cf9dSHong Zhang 
24202792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2421dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
242251d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
24234e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
242423a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
2425b18964edSHong Zhang   F->ops->matsolvetranspose     = MatMatSolveTranspose_MUMPS;
24264e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
24270298fd71SBarry Smith   F->ops->getinertia = NULL;
24284e34a73bSHong Zhang #else
24294e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2430db4efbfdSBarry Smith #endif
2431d47f36abSHong Zhang 
2432d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
24333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2434b24902e0SBarry Smith }
2435b24902e0SBarry Smith 
243666976f2fSJacob Faibussowitsch static PetscErrorCode MatView_MUMPS(Mat A, PetscViewer viewer)
2437d71ae5a4SJacob Faibussowitsch {
243864e6c443SBarry Smith   PetscBool         iascii;
243964e6c443SBarry Smith   PetscViewerFormat format;
2440e69c285eSBarry Smith   Mat_MUMPS        *mumps = (Mat_MUMPS *)A->data;
2441f6c57405SHong Zhang 
2442f6c57405SHong Zhang   PetscFunctionBegin;
244364e6c443SBarry Smith   /* check if matrix is mumps type */
24443ba16761SJacob Faibussowitsch   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(PETSC_SUCCESS);
244564e6c443SBarry Smith 
24469566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
244764e6c443SBarry Smith   if (iascii) {
24489566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
24491511cd71SPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
24509566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "MUMPS run parameters:\n"));
24511511cd71SPierre Jolivet       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
24529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  SYM (matrix type):                   %d\n", mumps->id.sym));
24539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  PAR (host participation):            %d\n", mumps->id.par));
24549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(1) (output for error):         %d\n", mumps->id.ICNTL(1)));
24559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(2) (output of diagnostic msg): %d\n", mumps->id.ICNTL(2)));
24569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(3) (output for global info):   %d\n", mumps->id.ICNTL(3)));
24579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(4) (level of printing):        %d\n", mumps->id.ICNTL(4)));
24589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(5) (input mat struct):         %d\n", mumps->id.ICNTL(5)));
24599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(6) (matrix prescaling):        %d\n", mumps->id.ICNTL(6)));
24609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(7) (sequential matrix ordering):%d\n", mumps->id.ICNTL(7)));
24619566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(8) (scaling strategy):         %d\n", mumps->id.ICNTL(8)));
24629566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(10) (max num of refinements):  %d\n", mumps->id.ICNTL(10)));
24639566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(11) (error analysis):          %d\n", mumps->id.ICNTL(11)));
2464a5e57a09SHong Zhang         if (mumps->id.ICNTL(11) > 0) {
24659566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(4) (inf norm of input mat):        %g\n", mumps->id.RINFOG(4)));
24669566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(5) (inf norm of solution):         %g\n", mumps->id.RINFOG(5)));
24679566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(6) (inf norm of residual):         %g\n", mumps->id.RINFOG(6)));
24689566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n", mumps->id.RINFOG(7), mumps->id.RINFOG(8)));
24699566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(9) (error estimate):               %g\n", mumps->id.RINFOG(9)));
24709566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n", mumps->id.RINFOG(10), mumps->id.RINFOG(11)));
2471f6c57405SHong Zhang         }
24729566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(12) (efficiency control):                         %d\n", mumps->id.ICNTL(12)));
24739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(13) (sequential factorization of the root node):  %d\n", mumps->id.ICNTL(13)));
24749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(14) (percentage of estimated workspace increase): %d\n", mumps->id.ICNTL(14)));
247545e3843bSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(15) (compression of the input matrix):            %d\n", mumps->id.ICNTL(15)));
2476f6c57405SHong Zhang         /* ICNTL(15-17) not used */
24779566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(18) (input mat struct):                           %d\n", mumps->id.ICNTL(18)));
24789566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(19) (Schur complement info):                      %d\n", mumps->id.ICNTL(19)));
24799566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(20) (RHS sparse pattern):                         %d\n", mumps->id.ICNTL(20)));
24809566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(21) (solution struct):                            %d\n", mumps->id.ICNTL(21)));
24819566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(22) (in-core/out-of-core facility):               %d\n", mumps->id.ICNTL(22)));
24829566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(23) (max size of memory can be allocated locally):%d\n", mumps->id.ICNTL(23)));
2483c0165424SHong Zhang 
24849566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(24) (detection of null pivot rows):               %d\n", mumps->id.ICNTL(24)));
24859566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(25) (computation of a null space basis):          %d\n", mumps->id.ICNTL(25)));
24869566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(26) (Schur options for RHS or solution):          %d\n", mumps->id.ICNTL(26)));
24879566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(27) (blocking size for multiple RHS):             %d\n", mumps->id.ICNTL(27)));
24889566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(28) (use parallel or sequential ordering):        %d\n", mumps->id.ICNTL(28)));
24899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(29) (parallel ordering):                          %d\n", mumps->id.ICNTL(29)));
249042179a6aSHong Zhang 
24919566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n", mumps->id.ICNTL(30)));
24929566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(31) (factors is discarded in the solve phase):    %d\n", mumps->id.ICNTL(31)));
24939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(33) (compute determinant):                        %d\n", mumps->id.ICNTL(33)));
24949566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(35) (activate BLR based factorization):           %d\n", mumps->id.ICNTL(35)));
24959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(36) (choice of BLR factorization variant):        %d\n", mumps->id.ICNTL(36)));
24969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(38) (estimated compression rate of LU factors):   %d\n", mumps->id.ICNTL(38)));
2497146931dbSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(58) (options for symbolic factorization):         %d\n", mumps->id.ICNTL(58)));
2498f6c57405SHong Zhang 
24999566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(1) (relative pivoting threshold):      %g\n", mumps->id.CNTL(1)));
25009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(2) (stopping criterion of refinement): %g\n", mumps->id.CNTL(2)));
25019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(3) (absolute pivoting threshold):      %g\n", mumps->id.CNTL(3)));
25029566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(4) (value of static pivoting):         %g\n", mumps->id.CNTL(4)));
25039566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(5) (fixation for null pivots):         %g\n", mumps->id.CNTL(5)));
25049566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(7) (dropping parameter for BLR):       %g\n", mumps->id.CNTL(7)));
2505f6c57405SHong Zhang 
2506a5b23f4aSJose E. Roman         /* information local to each processor */
25079566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis):\n"));
25089566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushSynchronized(viewer));
25099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(1)));
25109566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
25119566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization):\n"));
25129566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(2)));
25139566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
25149566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization):\n"));
25159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(3)));
25169566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2517f6c57405SHong Zhang 
25189566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization):\n"));
25199566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(15)));
25209566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2521f6c57405SHong Zhang 
25229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization):\n"));
25239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(16)));
25249566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2525f6c57405SHong Zhang 
25269566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization):\n"));
25279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(23)));
25289566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2529b34f08ffSHong Zhang 
2530a0e18203SThibaut Appel         if (mumps->ninfo && mumps->ninfo <= 80) {
2531b34f08ffSHong Zhang           PetscInt i;
2532b34f08ffSHong Zhang           for (i = 0; i < mumps->ninfo; i++) {
25339566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "):\n", mumps->info[i]));
25349566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(mumps->info[i])));
25359566063dSJacob Faibussowitsch             PetscCall(PetscViewerFlush(viewer));
2536b34f08ffSHong Zhang           }
2537b34f08ffSHong Zhang         }
25389566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopSynchronized(viewer));
25391511cd71SPierre Jolivet       } else PetscCall(PetscViewerASCIIPrintf(viewer, "  Use -%sksp_view ::ascii_info_detail to display information for all processes\n", ((PetscObject)A)->prefix ? ((PetscObject)A)->prefix : ""));
2540f6c57405SHong Zhang 
25411511cd71SPierre Jolivet       if (mumps->myid == 0) { /* information from the host */
25429566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(1) (global estimated flops for the elimination after analysis): %g\n", mumps->id.RINFOG(1)));
25439566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(2) (global estimated flops for the assembly after factorization): %g\n", mumps->id.RINFOG(2)));
25449566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(3) (global estimated flops for the elimination after factorization): %g\n", mumps->id.RINFOG(3)));
25459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  (RINFOG(12) RINFOG(13))*2^INFOG(34) (determinant): (%g,%g)*(2^%d)\n", mumps->id.RINFOG(12), mumps->id.RINFOG(13), mumps->id.INFOG(34)));
2546f6c57405SHong Zhang 
25479566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(3)));
25489566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(4)));
25499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(5) (estimated maximum front size in the complete tree): %d\n", mumps->id.INFOG(5)));
25509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(6) (number of nodes in the complete tree): %d\n", mumps->id.INFOG(6)));
25519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(7) (ordering option effectively used after analysis): %d\n", mumps->id.INFOG(7)));
25529566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n", mumps->id.INFOG(8)));
25539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n", mumps->id.INFOG(9)));
25549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(10) (total integer space store the matrix factors after factorization): %d\n", mumps->id.INFOG(10)));
25559566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(11) (order of largest frontal matrix after factorization): %d\n", mumps->id.INFOG(11)));
25569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(12) (number of off-diagonal pivots): %d\n", mumps->id.INFOG(12)));
25579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(13) (number of delayed pivots after factorization): %d\n", mumps->id.INFOG(13)));
25589566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(14) (number of memory compress after factorization): %d\n", mumps->id.INFOG(14)));
25599566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(15) (number of steps of iterative refinement after solution): %d\n", mumps->id.INFOG(15)));
25609566063dSJacob 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)));
25619566063dSJacob 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)));
25629566063dSJacob 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)));
25639566063dSJacob 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)));
25649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(20) (estimated number of entries in the factors): %d\n", mumps->id.INFOG(20)));
25659566063dSJacob 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)));
25669566063dSJacob 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)));
25679566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n", mumps->id.INFOG(23)));
25689566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n", mumps->id.INFOG(24)));
25699566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n", mumps->id.INFOG(25)));
25709566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(28) (after factorization: number of null pivots encountered): %d\n", mumps->id.INFOG(28)));
25719566063dSJacob 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)));
25729566063dSJacob 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)));
25739566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(32) (after analysis: type of analysis done): %d\n", mumps->id.INFOG(32)));
25749566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(33) (value used for ICNTL(8)): %d\n", mumps->id.INFOG(33)));
25759566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(34) (exponent of the determinant if determinant is requested): %d\n", mumps->id.INFOG(34)));
25769566063dSJacob 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)));
25779566063dSJacob 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)));
25789566063dSJacob 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)));
25799566063dSJacob 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)));
25809566063dSJacob 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)));
2581f6c57405SHong Zhang       }
2582f6c57405SHong Zhang     }
2583cb828f0fSHong Zhang   }
25843ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2585f6c57405SHong Zhang }
2586f6c57405SHong Zhang 
258766976f2fSJacob Faibussowitsch static PetscErrorCode MatGetInfo_MUMPS(Mat A, MatInfoType flag, MatInfo *info)
2588d71ae5a4SJacob Faibussowitsch {
2589e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
259035bd34faSBarry Smith 
259135bd34faSBarry Smith   PetscFunctionBegin;
259235bd34faSBarry Smith   info->block_size        = 1.0;
259364412097SPierre Jolivet   info->nz_allocated      = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
259464412097SPierre Jolivet   info->nz_used           = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
259535bd34faSBarry Smith   info->nz_unneeded       = 0.0;
259635bd34faSBarry Smith   info->assemblies        = 0.0;
259735bd34faSBarry Smith   info->mallocs           = 0.0;
259835bd34faSBarry Smith   info->memory            = 0.0;
259935bd34faSBarry Smith   info->fill_ratio_given  = 0;
260035bd34faSBarry Smith   info->fill_ratio_needed = 0;
260135bd34faSBarry Smith   info->factor_mallocs    = 0;
26023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
260335bd34faSBarry Smith }
260435bd34faSBarry Smith 
260566976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
2606d71ae5a4SJacob Faibussowitsch {
2607e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)F->data;
2608a3d589ffSStefano Zampini   const PetscScalar *arr;
26098e7ba810SStefano Zampini   const PetscInt    *idxs;
26108e7ba810SStefano Zampini   PetscInt           size, i;
26116444a565SStefano Zampini 
26126444a565SStefano Zampini   PetscFunctionBegin;
26139566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &size));
2614b3cb21ddSStefano Zampini   /* Schur complement matrix */
26159566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
26169566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, size, size, NULL, &F->schur));
26179566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur, &arr));
2618a3d589ffSStefano Zampini   mumps->id.schur      = (MumpsScalar *)arr;
2619a3d589ffSStefano Zampini   mumps->id.size_schur = size;
2620a3d589ffSStefano Zampini   mumps->id.schur_lld  = size;
26219566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur, &arr));
262248a46eb9SPierre Jolivet   if (mumps->sym == 1) PetscCall(MatSetOption(F->schur, MAT_SPD, PETSC_TRUE));
2623b3cb21ddSStefano Zampini 
2624b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
26259566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
26269566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &mumps->id.listvar_schur));
26279566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &idxs));
26289566063dSJacob Faibussowitsch   for (i = 0; i < size; i++) PetscCall(PetscMUMPSIntCast(idxs[i] + 1, &(mumps->id.listvar_schur[i])));
26299566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &idxs));
263059ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2631b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
26323ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26336444a565SStefano Zampini }
263459ac8732SStefano Zampini 
263566976f2fSJacob Faibussowitsch static PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F, Mat *S)
2636d71ae5a4SJacob Faibussowitsch {
26376444a565SStefano Zampini   Mat          St;
2638e69c285eSBarry Smith   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
26396444a565SStefano Zampini   PetscScalar *array;
26406444a565SStefano Zampini 
26416444a565SStefano Zampini   PetscFunctionBegin;
26429261f6e4SBarry Smith   PetscCheck(mumps->id.ICNTL(19), PetscObjectComm((PetscObject)F), PETSC_ERR_ORDER, "Schur complement mode not selected! Call MatFactorSetSchurIS() to enable it");
26439566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF, &St));
26449566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St, PETSC_DECIDE, PETSC_DECIDE, mumps->id.size_schur, mumps->id.size_schur));
26459566063dSJacob Faibussowitsch   PetscCall(MatSetType(St, MATDENSE));
26469566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
26479566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St, &array));
264859ac8732SStefano Zampini   if (!mumps->sym) {                /* MUMPS always return a full matrix */
26496444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
26506444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26516444a565SStefano Zampini       for (i = 0; i < N; i++) {
26526444a565SStefano Zampini         for (j = 0; j < N; j++) {
26536444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26546444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26556444a565SStefano Zampini #else
26563e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26576444a565SStefano Zampini #endif
26586444a565SStefano Zampini           array[j * N + i] = val;
26596444a565SStefano Zampini         }
26606444a565SStefano Zampini       }
26616444a565SStefano Zampini     } else { /* stored by columns */
26629566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26636444a565SStefano Zampini     }
26646444a565SStefano Zampini   } else {                          /* either full or lower-triangular (not packed) */
26656444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
26666444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26676444a565SStefano Zampini       for (i = 0; i < N; i++) {
26686444a565SStefano Zampini         for (j = i; j < N; j++) {
26696444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26706444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26716444a565SStefano Zampini #else
26723e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26736444a565SStefano Zampini #endif
26743e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
26756444a565SStefano Zampini         }
26766444a565SStefano Zampini       }
26776444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
26789566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26796444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular stored by rows */
26806444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26816444a565SStefano Zampini       for (i = 0; i < N; i++) {
26826444a565SStefano Zampini         for (j = 0; j < i + 1; j++) {
26836444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26846444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26856444a565SStefano Zampini #else
26863e5b40d0SPierre Jolivet           PetscScalar val = mumps->id.schur[i * N + j].r + PETSC_i * mumps->id.schur[i * N + j].i;
26876444a565SStefano Zampini #endif
26883e5b40d0SPierre Jolivet           array[i * N + j] = array[j * N + i] = val;
26896444a565SStefano Zampini         }
26906444a565SStefano Zampini       }
26916444a565SStefano Zampini     }
26926444a565SStefano Zampini   }
26939566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St, &array));
26946444a565SStefano Zampini   *S = St;
26953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26966444a565SStefano Zampini }
26976444a565SStefano Zampini 
269866976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt ival)
2699d71ae5a4SJacob Faibussowitsch {
2700e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
27015ccb76cbSHong Zhang 
27025ccb76cbSHong Zhang   PetscFunctionBegin;
2703413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {                                       /* need to cache icntl and ival since PetscMUMPS_c() has never been called */
2704413bcc21SPierre Jolivet     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0; /* number of already cached ICNTL */
27059371c9d4SSatish Balay     for (i = 0; i < nICNTL_pre; ++i)
27069371c9d4SSatish Balay       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) break; /* is this ICNTL already cached? */
2707413bcc21SPierre Jolivet     if (i == nICNTL_pre) {                             /* not already cached */
2708413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscMUMPSInt) * (2 * nICNTL_pre + 3), &mumps->ICNTL_pre));
2709413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscMUMPSInt) * 3, &mumps->ICNTL_pre));
2710413bcc21SPierre Jolivet       mumps->ICNTL_pre[0]++;
2711413bcc21SPierre Jolivet     }
2712413bcc21SPierre Jolivet     mumps->ICNTL_pre[1 + 2 * i] = icntl;
2713413bcc21SPierre Jolivet     PetscCall(PetscMUMPSIntCast(ival, mumps->ICNTL_pre + 2 + 2 * i));
2714413bcc21SPierre Jolivet   } else PetscCall(PetscMUMPSIntCast(ival, &mumps->id.ICNTL(icntl)));
27153ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27165ccb76cbSHong Zhang }
27175ccb76cbSHong Zhang 
271866976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt *ival)
2719d71ae5a4SJacob Faibussowitsch {
2720e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2721bc6112feSHong Zhang 
2722bc6112feSHong Zhang   PetscFunctionBegin;
272336df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
272436df9881Sjeremy theler     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
272536df9881Sjeremy theler     *ival = 0;
272636df9881Sjeremy theler     for (i = 0; i < nICNTL_pre; ++i) {
272736df9881Sjeremy theler       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) *ival = mumps->ICNTL_pre[2 + 2 * i];
272836df9881Sjeremy theler     }
272936df9881Sjeremy theler   } else *ival = mumps->id.ICNTL(icntl);
27303ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2731bc6112feSHong Zhang }
2732bc6112feSHong Zhang 
27335ccb76cbSHong Zhang /*@
27345ccb76cbSHong Zhang   MatMumpsSetIcntl - Set MUMPS parameter ICNTL()
27355ccb76cbSHong Zhang 
2736c3339decSBarry Smith   Logically Collective
27375ccb76cbSHong Zhang 
27385ccb76cbSHong Zhang   Input Parameters:
273911a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
27405ccb76cbSHong Zhang . icntl - index of MUMPS parameter array ICNTL()
27415ccb76cbSHong Zhang - ival  - value of MUMPS ICNTL(icntl)
27425ccb76cbSHong Zhang 
27433c7db156SBarry Smith   Options Database Key:
2744147403d9SBarry Smith . -mat_mumps_icntl_<icntl> <ival> - change the option numbered icntl to ival
27455ccb76cbSHong Zhang 
27465ccb76cbSHong Zhang   Level: beginner
27475ccb76cbSHong Zhang 
274896a0c994SBarry Smith   References:
2749606c0280SSatish Balay .  * - MUMPS Users' Guide
27505ccb76cbSHong Zhang 
27511cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
27525ccb76cbSHong Zhang @*/
2753d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl(Mat F, PetscInt icntl, PetscInt ival)
2754d71ae5a4SJacob Faibussowitsch {
27555ccb76cbSHong Zhang   PetscFunctionBegin;
27562989dfd4SHong Zhang   PetscValidType(F, 1);
275728b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
27585ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27595ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, ival, 3);
2760146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2761cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetIcntl_C", (Mat, PetscInt, PetscInt), (F, icntl, ival));
27623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27635ccb76cbSHong Zhang }
27645ccb76cbSHong Zhang 
2765a21f80fcSHong Zhang /*@
2766a21f80fcSHong Zhang   MatMumpsGetIcntl - Get MUMPS parameter ICNTL()
2767a21f80fcSHong Zhang 
2768c3339decSBarry Smith   Logically Collective
2769a21f80fcSHong Zhang 
2770a21f80fcSHong Zhang   Input Parameters:
277111a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2772a21f80fcSHong Zhang - icntl - index of MUMPS parameter array ICNTL()
2773a21f80fcSHong Zhang 
2774a21f80fcSHong Zhang   Output Parameter:
2775a21f80fcSHong Zhang . ival - value of MUMPS ICNTL(icntl)
2776a21f80fcSHong Zhang 
2777a21f80fcSHong Zhang   Level: beginner
2778a21f80fcSHong Zhang 
277996a0c994SBarry Smith   References:
2780606c0280SSatish Balay .  * - MUMPS Users' Guide
2781a21f80fcSHong Zhang 
27821cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2783a21f80fcSHong Zhang @*/
2784d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl(Mat F, PetscInt icntl, PetscInt *ival)
2785d71ae5a4SJacob Faibussowitsch {
2786bc6112feSHong Zhang   PetscFunctionBegin;
27872989dfd4SHong Zhang   PetscValidType(F, 1);
278828b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2789bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27904f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
2791146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2792cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetIcntl_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
27933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2794bc6112feSHong Zhang }
2795bc6112feSHong Zhang 
279666976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal val)
2797d71ae5a4SJacob Faibussowitsch {
2798e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
27998928b65cSHong Zhang 
28008928b65cSHong Zhang   PetscFunctionBegin;
2801413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {
2802413bcc21SPierre Jolivet     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
28039371c9d4SSatish Balay     for (i = 0; i < nCNTL_pre; ++i)
28049371c9d4SSatish Balay       if (mumps->CNTL_pre[1 + 2 * i] == icntl) break;
2805413bcc21SPierre Jolivet     if (i == nCNTL_pre) {
2806413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscReal) * (2 * nCNTL_pre + 3), &mumps->CNTL_pre));
2807413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscReal) * 3, &mumps->CNTL_pre));
2808413bcc21SPierre Jolivet       mumps->CNTL_pre[0]++;
2809413bcc21SPierre Jolivet     }
2810413bcc21SPierre Jolivet     mumps->CNTL_pre[1 + 2 * i] = icntl;
2811413bcc21SPierre Jolivet     mumps->CNTL_pre[2 + 2 * i] = val;
2812413bcc21SPierre Jolivet   } else mumps->id.CNTL(icntl) = val;
28133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28148928b65cSHong Zhang }
28158928b65cSHong Zhang 
281666976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal *val)
2817d71ae5a4SJacob Faibussowitsch {
2818e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2819bc6112feSHong Zhang 
2820bc6112feSHong Zhang   PetscFunctionBegin;
282136df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
282236df9881Sjeremy theler     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
282336df9881Sjeremy theler     *val = 0.0;
282436df9881Sjeremy theler     for (i = 0; i < nCNTL_pre; ++i) {
282536df9881Sjeremy theler       if (mumps->CNTL_pre[1 + 2 * i] == icntl) *val = mumps->CNTL_pre[2 + 2 * i];
282636df9881Sjeremy theler     }
282736df9881Sjeremy theler   } else *val = mumps->id.CNTL(icntl);
28283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2829bc6112feSHong Zhang }
2830bc6112feSHong Zhang 
28318928b65cSHong Zhang /*@
28328928b65cSHong Zhang   MatMumpsSetCntl - Set MUMPS parameter CNTL()
28338928b65cSHong Zhang 
2834c3339decSBarry Smith   Logically Collective
28358928b65cSHong Zhang 
28368928b65cSHong Zhang   Input Parameters:
283711a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
28388928b65cSHong Zhang . icntl - index of MUMPS parameter array CNTL()
28398928b65cSHong Zhang - val   - value of MUMPS CNTL(icntl)
28408928b65cSHong Zhang 
28413c7db156SBarry Smith   Options Database Key:
2842147403d9SBarry Smith . -mat_mumps_cntl_<icntl> <val> - change the option numbered icntl to ival
28438928b65cSHong Zhang 
28448928b65cSHong Zhang   Level: beginner
28458928b65cSHong Zhang 
284696a0c994SBarry Smith   References:
2847606c0280SSatish Balay .  * - MUMPS Users' Guide
28488928b65cSHong Zhang 
28491cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
28508928b65cSHong Zhang @*/
2851d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl(Mat F, PetscInt icntl, PetscReal val)
2852d71ae5a4SJacob Faibussowitsch {
28538928b65cSHong Zhang   PetscFunctionBegin;
28542989dfd4SHong Zhang   PetscValidType(F, 1);
285528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
28568928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2857bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F, val, 3);
2858413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2859cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetCntl_C", (Mat, PetscInt, PetscReal), (F, icntl, val));
28603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28618928b65cSHong Zhang }
28628928b65cSHong Zhang 
2863a21f80fcSHong Zhang /*@
2864a21f80fcSHong Zhang   MatMumpsGetCntl - Get MUMPS parameter CNTL()
2865a21f80fcSHong Zhang 
2866c3339decSBarry Smith   Logically Collective
2867a21f80fcSHong Zhang 
2868a21f80fcSHong Zhang   Input Parameters:
286911a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2870a21f80fcSHong Zhang - icntl - index of MUMPS parameter array CNTL()
2871a21f80fcSHong Zhang 
2872a21f80fcSHong Zhang   Output Parameter:
2873a21f80fcSHong Zhang . val - value of MUMPS CNTL(icntl)
2874a21f80fcSHong Zhang 
2875a21f80fcSHong Zhang   Level: beginner
2876a21f80fcSHong Zhang 
287796a0c994SBarry Smith   References:
2878606c0280SSatish Balay .  * - MUMPS Users' Guide
2879a21f80fcSHong Zhang 
28801cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2881a21f80fcSHong Zhang @*/
2882d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl(Mat F, PetscInt icntl, PetscReal *val)
2883d71ae5a4SJacob Faibussowitsch {
2884bc6112feSHong Zhang   PetscFunctionBegin;
28852989dfd4SHong Zhang   PetscValidType(F, 1);
288628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2887bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
28884f572ea9SToby Isaac   PetscAssertPointer(val, 3);
2889413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2890cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetCntl_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
28913ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2892bc6112feSHong Zhang }
2893bc6112feSHong Zhang 
289466976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F, PetscInt icntl, PetscInt *info)
2895d71ae5a4SJacob Faibussowitsch {
2896e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2897bc6112feSHong Zhang 
2898bc6112feSHong Zhang   PetscFunctionBegin;
2899bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
29003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2901bc6112feSHong Zhang }
2902bc6112feSHong Zhang 
290366976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F, PetscInt icntl, PetscInt *infog)
2904d71ae5a4SJacob Faibussowitsch {
2905e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2906bc6112feSHong Zhang 
2907bc6112feSHong Zhang   PetscFunctionBegin;
2908bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
29093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2910bc6112feSHong Zhang }
2911bc6112feSHong Zhang 
291266976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfo)
2913d71ae5a4SJacob Faibussowitsch {
2914e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2915bc6112feSHong Zhang 
2916bc6112feSHong Zhang   PetscFunctionBegin;
2917bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
29183ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2919bc6112feSHong Zhang }
2920bc6112feSHong Zhang 
292166976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfog)
2922d71ae5a4SJacob Faibussowitsch {
2923e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2924bc6112feSHong Zhang 
2925bc6112feSHong Zhang   PetscFunctionBegin;
2926bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
29273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2928bc6112feSHong Zhang }
2929bc6112feSHong Zhang 
293066976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetNullPivots_MUMPS(Mat F, PetscInt *size, PetscInt **array)
29315c0bae8cSAshish Patel {
29325c0bae8cSAshish Patel   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
29335c0bae8cSAshish Patel 
29345c0bae8cSAshish Patel   PetscFunctionBegin;
29355c0bae8cSAshish 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");
29365c0bae8cSAshish Patel   *size  = 0;
29375c0bae8cSAshish Patel   *array = NULL;
29385c0bae8cSAshish Patel   if (!mumps->myid) {
29395c0bae8cSAshish Patel     *size = mumps->id.INFOG(28);
29405c0bae8cSAshish Patel     PetscCall(PetscMalloc1(*size, array));
29415c0bae8cSAshish Patel     for (int i = 0; i < *size; i++) (*array)[i] = mumps->id.pivnul_list[i] - 1;
29425c0bae8cSAshish Patel   }
29435c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
29445c0bae8cSAshish Patel }
29455c0bae8cSAshish Patel 
294666976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F, Mat spRHS)
2947d71ae5a4SJacob Faibussowitsch {
29480e6b8875SHong Zhang   Mat          Bt = NULL, Btseq = NULL;
29490e6b8875SHong Zhang   PetscBool    flg;
2950bb599dfdSHong Zhang   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
2951bb599dfdSHong Zhang   PetscScalar *aa;
2952f410b75aSHong Zhang   PetscInt     spnr, *ia, *ja, M, nrhs;
2953bb599dfdSHong Zhang 
2954bb599dfdSHong Zhang   PetscFunctionBegin;
29554f572ea9SToby Isaac   PetscAssertPointer(spRHS, 2);
2956013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS, MATTRANSPOSEVIRTUAL, &flg));
29570e6b8875SHong Zhang   if (flg) {
29589566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(spRHS, &Bt));
2959013e2dc7SBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)spRHS), PETSC_ERR_ARG_WRONG, "Matrix spRHS must be type MATTRANSPOSEVIRTUAL matrix");
2960bb599dfdSHong Zhang 
29619566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F, 30, 1));
2962bb599dfdSHong Zhang 
29632d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
29640e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ *)Bt->data;
29650e6b8875SHong Zhang     Btseq         = b->A;
29660e6b8875SHong Zhang   } else {
29670e6b8875SHong Zhang     Btseq = Bt;
29680e6b8875SHong Zhang   }
29690e6b8875SHong Zhang 
29709566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS, &M, &nrhs));
2971f410b75aSHong Zhang   mumps->id.nrhs = nrhs;
2972f410b75aSHong Zhang   mumps->id.lrhs = M;
2973f410b75aSHong Zhang   mumps->id.rhs  = NULL;
2974f410b75aSHong Zhang 
2975e3f2db6aSHong Zhang   if (!mumps->myid) {
29769566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq, &aa));
29779566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
297828b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
29799566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
2980bb599dfdSHong Zhang     mumps->id.rhs_sparse = (MumpsScalar *)aa;
2981e3f2db6aSHong Zhang   } else {
2982e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
2983e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
2984e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
2985e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
2986e3f2db6aSHong Zhang   }
2987bb599dfdSHong Zhang   mumps->id.ICNTL(20) = 1; /* rhs is sparse */
2988e3f2db6aSHong Zhang   mumps->id.ICNTL(21) = 0; /* solution is in assembled centralized format */
2989bb599dfdSHong Zhang 
2990bb599dfdSHong Zhang   /* solve phase */
2991bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
29923ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
29939261f6e4SBarry 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));
299414267174SHong Zhang 
2995e3f2db6aSHong Zhang   if (!mumps->myid) {
29969566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq, &aa));
29979566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
299828b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
2999e3f2db6aSHong Zhang   }
30003ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3001bb599dfdSHong Zhang }
3002bb599dfdSHong Zhang 
3003bb599dfdSHong Zhang /*@
30042ef1f0ffSBarry Smith   MatMumpsGetInverse - Get user-specified set of entries in inverse of `A`
3005bb599dfdSHong Zhang 
3006c3339decSBarry Smith   Logically Collective
3007bb599dfdSHong Zhang 
300820f4b53cSBarry Smith   Input Parameter:
300920f4b53cSBarry Smith . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3010bb599dfdSHong Zhang 
3011bb599dfdSHong Zhang   Output Parameter:
301220f4b53cSBarry Smith . spRHS - sequential sparse matrix in `MATTRANSPOSEVIRTUAL` format with requested entries of inverse of `A`
3013bb599dfdSHong Zhang 
3014bb599dfdSHong Zhang   Level: beginner
3015bb599dfdSHong Zhang 
3016bb599dfdSHong Zhang   References:
3017606c0280SSatish Balay .  * - MUMPS Users' Guide
3018bb599dfdSHong Zhang 
30191cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`
3020bb599dfdSHong Zhang @*/
3021d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse(Mat F, Mat spRHS)
3022d71ae5a4SJacob Faibussowitsch {
3023bb599dfdSHong Zhang   PetscFunctionBegin;
3024bb599dfdSHong Zhang   PetscValidType(F, 1);
302528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
3026cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverse_C", (Mat, Mat), (F, spRHS));
30273ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3028bb599dfdSHong Zhang }
3029bb599dfdSHong Zhang 
303066976f2fSJacob Faibussowitsch static PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F, Mat spRHST)
3031d71ae5a4SJacob Faibussowitsch {
30320e6b8875SHong Zhang   Mat spRHS;
30330e6b8875SHong Zhang 
30340e6b8875SHong Zhang   PetscFunctionBegin;
30359566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST, &spRHS));
30369566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F, spRHS));
30379566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
30383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30390e6b8875SHong Zhang }
30400e6b8875SHong Zhang 
30410e6b8875SHong Zhang /*@
30422ef1f0ffSBarry Smith   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix `A`^T
30430e6b8875SHong Zhang 
3044c3339decSBarry Smith   Logically Collective
30450e6b8875SHong Zhang 
304620f4b53cSBarry Smith   Input Parameter:
304720f4b53cSBarry Smith . F - the factored matrix of A obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
30480e6b8875SHong Zhang 
30490e6b8875SHong Zhang   Output Parameter:
305020f4b53cSBarry Smith . spRHST - sequential sparse matrix in `MATAIJ` format containing the requested entries of inverse of `A`^T
30510e6b8875SHong Zhang 
30520e6b8875SHong Zhang   Level: beginner
30530e6b8875SHong Zhang 
30540e6b8875SHong Zhang   References:
3055606c0280SSatish Balay .  * - MUMPS Users' Guide
30560e6b8875SHong Zhang 
30571cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
30580e6b8875SHong Zhang @*/
3059d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose(Mat F, Mat spRHST)
3060d71ae5a4SJacob Faibussowitsch {
30610e6b8875SHong Zhang   PetscBool flg;
30620e6b8875SHong Zhang 
30630e6b8875SHong Zhang   PetscFunctionBegin;
30640e6b8875SHong Zhang   PetscValidType(F, 1);
306528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
306728b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)spRHST), PETSC_ERR_ARG_WRONG, "Matrix spRHST must be MATAIJ matrix");
30680e6b8875SHong Zhang 
3069cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverseTranspose_C", (Mat, Mat), (F, spRHST));
30703ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30710e6b8875SHong Zhang }
30720e6b8875SHong Zhang 
3073a21f80fcSHong Zhang /*@
3074a21f80fcSHong Zhang   MatMumpsGetInfo - Get MUMPS parameter INFO()
3075a21f80fcSHong Zhang 
3076c3339decSBarry Smith   Logically Collective
3077a21f80fcSHong Zhang 
3078a21f80fcSHong Zhang   Input Parameters:
307911a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3080a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFO()
3081a21f80fcSHong Zhang 
3082a21f80fcSHong Zhang   Output Parameter:
3083a21f80fcSHong Zhang . ival - value of MUMPS INFO(icntl)
3084a21f80fcSHong Zhang 
3085a21f80fcSHong Zhang   Level: beginner
3086a21f80fcSHong Zhang 
308796a0c994SBarry Smith   References:
3088606c0280SSatish Balay .  * - MUMPS Users' Guide
3089a21f80fcSHong Zhang 
30901cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3091a21f80fcSHong Zhang @*/
3092d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo(Mat F, PetscInt icntl, PetscInt *ival)
3093d71ae5a4SJacob Faibussowitsch {
3094bc6112feSHong Zhang   PetscFunctionBegin;
30952989dfd4SHong Zhang   PetscValidType(F, 1);
309628b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30974f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3098cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfo_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
30993ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3100bc6112feSHong Zhang }
3101bc6112feSHong Zhang 
3102a21f80fcSHong Zhang /*@
3103a21f80fcSHong Zhang   MatMumpsGetInfog - Get MUMPS parameter INFOG()
3104a21f80fcSHong Zhang 
3105c3339decSBarry Smith   Logically Collective
3106a21f80fcSHong Zhang 
3107a21f80fcSHong Zhang   Input Parameters:
310811a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3109a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFOG()
3110a21f80fcSHong Zhang 
3111a21f80fcSHong Zhang   Output Parameter:
3112a21f80fcSHong Zhang . ival - value of MUMPS INFOG(icntl)
3113a21f80fcSHong Zhang 
3114a21f80fcSHong Zhang   Level: beginner
3115a21f80fcSHong Zhang 
311696a0c994SBarry Smith   References:
3117606c0280SSatish Balay .  * - MUMPS Users' Guide
3118a21f80fcSHong Zhang 
31191cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3120a21f80fcSHong Zhang @*/
3121d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog(Mat F, PetscInt icntl, PetscInt *ival)
3122d71ae5a4SJacob Faibussowitsch {
3123bc6112feSHong Zhang   PetscFunctionBegin;
31242989dfd4SHong Zhang   PetscValidType(F, 1);
312528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31264f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3127cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfog_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
31283ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3129bc6112feSHong Zhang }
3130bc6112feSHong Zhang 
3131a21f80fcSHong Zhang /*@
3132a21f80fcSHong Zhang   MatMumpsGetRinfo - Get MUMPS parameter RINFO()
3133a21f80fcSHong Zhang 
3134c3339decSBarry Smith   Logically Collective
3135a21f80fcSHong Zhang 
3136a21f80fcSHong Zhang   Input Parameters:
313711a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3138a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFO()
3139a21f80fcSHong Zhang 
3140a21f80fcSHong Zhang   Output Parameter:
3141a21f80fcSHong Zhang . val - value of MUMPS RINFO(icntl)
3142a21f80fcSHong Zhang 
3143a21f80fcSHong Zhang   Level: beginner
3144a21f80fcSHong Zhang 
314596a0c994SBarry Smith   References:
3146606c0280SSatish Balay .  * - MUMPS Users' Guide
3147a21f80fcSHong Zhang 
31481cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
3149a21f80fcSHong Zhang @*/
3150d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo(Mat F, PetscInt icntl, PetscReal *val)
3151d71ae5a4SJacob Faibussowitsch {
3152bc6112feSHong Zhang   PetscFunctionBegin;
31532989dfd4SHong Zhang   PetscValidType(F, 1);
315428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31554f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3156cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfo_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31573ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3158bc6112feSHong Zhang }
3159bc6112feSHong Zhang 
3160a21f80fcSHong Zhang /*@
3161a21f80fcSHong Zhang   MatMumpsGetRinfog - Get MUMPS parameter RINFOG()
3162a21f80fcSHong Zhang 
3163c3339decSBarry Smith   Logically Collective
3164a21f80fcSHong Zhang 
3165a21f80fcSHong Zhang   Input Parameters:
316611a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3167a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFOG()
3168a21f80fcSHong Zhang 
3169a21f80fcSHong Zhang   Output Parameter:
3170a21f80fcSHong Zhang . val - value of MUMPS RINFOG(icntl)
3171a21f80fcSHong Zhang 
3172a21f80fcSHong Zhang   Level: beginner
3173a21f80fcSHong Zhang 
317496a0c994SBarry Smith   References:
3175606c0280SSatish Balay .  * - MUMPS Users' Guide
3176a21f80fcSHong Zhang 
31771cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
3178a21f80fcSHong Zhang @*/
3179d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog(Mat F, PetscInt icntl, PetscReal *val)
3180d71ae5a4SJacob Faibussowitsch {
3181bc6112feSHong Zhang   PetscFunctionBegin;
31822989dfd4SHong Zhang   PetscValidType(F, 1);
318328b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31844f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3185cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfog_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31863ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3187bc6112feSHong Zhang }
3188bc6112feSHong Zhang 
31895c0bae8cSAshish Patel /*@
31905c0bae8cSAshish Patel   MatMumpsGetNullPivots - Get MUMPS parameter PIVNUL_LIST()
31915c0bae8cSAshish Patel 
31925c0bae8cSAshish Patel   Logically Collective
31935c0bae8cSAshish Patel 
31945c0bae8cSAshish Patel   Input Parameter:
31955c0bae8cSAshish Patel . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
31965c0bae8cSAshish Patel 
31975c0bae8cSAshish Patel   Output Parameters:
31985c0bae8cSAshish Patel + size  - local size of the array. The size of the array is non-zero only on the host.
31995c0bae8cSAshish 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
32005c0bae8cSAshish Patel            for freeing this array.
32015c0bae8cSAshish Patel 
32025c0bae8cSAshish Patel   Level: beginner
32035c0bae8cSAshish Patel 
32045c0bae8cSAshish Patel   References:
32055c0bae8cSAshish Patel .  * - MUMPS Users' Guide
32065c0bae8cSAshish Patel 
32071cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
32085c0bae8cSAshish Patel @*/
32095c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots(Mat F, PetscInt *size, PetscInt **array)
32105c0bae8cSAshish Patel {
32115c0bae8cSAshish Patel   PetscFunctionBegin;
32125c0bae8cSAshish Patel   PetscValidType(F, 1);
32135c0bae8cSAshish Patel   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
32144f572ea9SToby Isaac   PetscAssertPointer(size, 2);
32154f572ea9SToby Isaac   PetscAssertPointer(array, 3);
32165c0bae8cSAshish Patel   PetscUseMethod(F, "MatMumpsGetNullPivots_C", (Mat, PetscInt *, PetscInt **), (F, size, array));
32175c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
32185c0bae8cSAshish Patel }
32195c0bae8cSAshish Patel 
322024b6179bSKris Buschelman /*MC
32212692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
322224b6179bSKris Buschelman   distributed and sequential matrices via the external package MUMPS.
322324b6179bSKris Buschelman 
322411a5261eSBarry Smith   Works with `MATAIJ` and `MATSBAIJ` matrices
322524b6179bSKris Buschelman 
3226c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
3227c2b89b5dSBarry Smith 
32282ef1f0ffSBarry 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.
32292ef1f0ffSBarry Smith   See details below.
3230217d3b1eSJunchao Zhang 
32312ef1f0ffSBarry Smith   Use `-pc_type cholesky` or `lu` `-pc_factor_mat_solver_type mumps` to use this direct solver
3232c2b89b5dSBarry Smith 
323324b6179bSKris Buschelman   Options Database Keys:
32344422a9fcSPatrick Sanan +  -mat_mumps_icntl_1 - ICNTL(1): output stream for error messages
32354422a9fcSPatrick Sanan .  -mat_mumps_icntl_2 - ICNTL(2): output stream for diagnostic printing, statistics, and warning
32364422a9fcSPatrick Sanan .  -mat_mumps_icntl_3 -  ICNTL(3): output stream for global information, collected on the host
32374422a9fcSPatrick Sanan .  -mat_mumps_icntl_4 -  ICNTL(4): level of printing (0 to 4)
32384422a9fcSPatrick Sanan .  -mat_mumps_icntl_6 - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
3239b53c1a7fSBarry 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
3240b53c1a7fSBarry Smith                         Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
32414422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
32424422a9fcSPatrick Sanan .  -mat_mumps_icntl_10  - ICNTL(10): max num of refinements
32434422a9fcSPatrick Sanan .  -mat_mumps_icntl_11  - ICNTL(11): statistics related to an error analysis (via -ksp_view)
32444422a9fcSPatrick Sanan .  -mat_mumps_icntl_12  - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
32454422a9fcSPatrick Sanan .  -mat_mumps_icntl_13  - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
32464422a9fcSPatrick Sanan .  -mat_mumps_icntl_14  - ICNTL(14): percentage increase in the estimated working space
324745e3843bSPierre Jolivet .  -mat_mumps_icntl_15  - ICNTL(15): compression of the input matrix resulting from a block format
32484422a9fcSPatrick Sanan .  -mat_mumps_icntl_19  - ICNTL(19): computes the Schur complement
324925aac85cSJunchao Zhang .  -mat_mumps_icntl_20  - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
32504422a9fcSPatrick Sanan .  -mat_mumps_icntl_22  - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
32514422a9fcSPatrick Sanan .  -mat_mumps_icntl_23  - ICNTL(23): max size of the working memory (MB) that can allocate per processor
32524422a9fcSPatrick Sanan .  -mat_mumps_icntl_24  - ICNTL(24): detection of null pivot rows (0 or 1)
32534422a9fcSPatrick Sanan .  -mat_mumps_icntl_25  - ICNTL(25): compute a solution of a deficient matrix and a null space basis
32544422a9fcSPatrick Sanan .  -mat_mumps_icntl_26  - ICNTL(26): drives the solution phase if a Schur complement matrix
32554422a9fcSPatrick Sanan .  -mat_mumps_icntl_28  - ICNTL(28): use 1 for sequential analysis and ictnl(7) ordering, or 2 for parallel analysis and ictnl(29) ordering
32564422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
32574422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
32584422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
32594422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
3260a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
3261a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
3262a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
3263146931dbSPierre Jolivet .  -mat_mumps_icntl_58 - ICNTL(58): options for symbolic factorization
32644422a9fcSPatrick Sanan .  -mat_mumps_cntl_1  - CNTL(1): relative pivoting threshold
32654422a9fcSPatrick Sanan .  -mat_mumps_cntl_2  -  CNTL(2): stopping criterion of refinement
32664422a9fcSPatrick Sanan .  -mat_mumps_cntl_3 - CNTL(3): absolute pivoting threshold
32674422a9fcSPatrick Sanan .  -mat_mumps_cntl_4 - CNTL(4): value for static pivoting
3268217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5 - CNTL(5): fixation for null pivots
3269a0e18203SThibaut Appel .  -mat_mumps_cntl_7 - CNTL(7): precision of the dropping parameter used during BLR factorization
3270217d3b1eSJunchao 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.
3271217d3b1eSJunchao Zhang                                    Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
327224b6179bSKris Buschelman 
327324b6179bSKris Buschelman   Level: beginner
327424b6179bSKris Buschelman 
327595452b02SPatrick Sanan     Notes:
32762ef1f0ffSBarry 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
32772ef1f0ffSBarry Smith     error if the matrix is Hermitian.
327838548759SBarry Smith 
327926cc229bSBarry 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
328026cc229bSBarry Smith     `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
328126cc229bSBarry Smith 
32822ef1f0ffSBarry 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
32832ef1f0ffSBarry Smith     the failure with
32842ef1f0ffSBarry Smith .vb
32852ef1f0ffSBarry Smith           KSPGetPC(ksp,&pc);
32862ef1f0ffSBarry Smith           PCFactorGetMatrix(pc,&mat);
32872ef1f0ffSBarry Smith           MatMumpsGetInfo(mat,....);
32882ef1f0ffSBarry Smith           MatMumpsGetInfog(mat,....); etc.
32892ef1f0ffSBarry Smith .ve
32902ef1f0ffSBarry Smith     Or run with `-ksp_error_if_not_converged` and the program will be stopped and the information printed in the error message.
32919fc87aa7SBarry Smith 
3292a5399872SJunchao Zhang     MUMPS provides 64-bit integer support in two build modes:
3293a5399872SJunchao Zhang       full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
3294a5399872SJunchao 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).
32958fcaa860SBarry Smith 
3296a5399872SJunchao 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,
3297a5399872SJunchao 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
3298a5399872SJunchao 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
3299a5399872SJunchao Zhang       integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
3300a5399872SJunchao Zhang 
3301a5399872SJunchao 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.
3302a5399872SJunchao Zhang 
3303a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
33042ef1f0ffSBarry Smith .vb
33052ef1f0ffSBarry Smith      Set OMP_NUM_THREADS and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
33062ef1f0ffSBarry Smith      threads per rank, then you may use "export OMP_NUM_THREADS=16 && mpirun -n 4 ./test".
33072ef1f0ffSBarry Smith .ve
33088fcaa860SBarry Smith 
33092ef1f0ffSBarry Smith .vb
33102ef1f0ffSBarry Smith      -mat_mumps_use_omp_threads [m] and run your code with as many MPI ranks as the number of cores. For example,
33112ef1f0ffSBarry 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"
33122ef1f0ffSBarry Smith .ve
33138fcaa860SBarry Smith 
33148fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
33152ef1f0ffSBarry 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`
33162ef1f0ffSBarry 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
33178fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
33188fcaa860SBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if --with-openmp is provided).
3319217d3b1eSJunchao Zhang 
33208fcaa860SBarry 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
3321217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
3322217d3b1eSJunchao 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
3323217d3b1eSJunchao 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
3324217d3b1eSJunchao 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.
3325217d3b1eSJunchao 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,
3326217d3b1eSJunchao 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
3327217d3b1eSJunchao Zhang    MPI ranks to cores, then with -mat_mumps_use_omp_threads 16, a master rank (and threads it spawns) will use half cores in socket 0, and half
3328217d3b1eSJunchao 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
3329217d3b1eSJunchao Zhang    problem will not happen. Therefore, when you use -mat_mumps_use_omp_threads, you need to keep an eye on your MPI rank mapping and CPU binding.
33308fcaa860SBarry 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
3331217d3b1eSJunchao Zhang    examine the mapping result.
3332217d3b1eSJunchao Zhang 
333311a5261eSBarry 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,
333411a5261eSBarry 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
333511a5261eSBarry Smith    calls `omp_set_num_threads`(m) internally before calling MUMPS.
3336217d3b1eSJunchao Zhang 
3337217d3b1eSJunchao Zhang    References:
3338606c0280SSatish Balay +  * - Heroux, Michael A., R. Brightwell, and Michael M. Wolf. "Bi-modal MPI and MPI+ threads computing on scalable multicore systems." IJHPCA (Submitted) (2011).
3339606c0280SSatish Balay -  * - Gutierrez, Samuel K., et al. "Accommodating Thread-Level Heterogeneity in Coupled Parallel Applications." Parallel and Distributed Processing Symposium (IPDPS), 2017 IEEE International. IEEE, 2017.
3340217d3b1eSJunchao Zhang 
33411cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `KSPGetPC()`, `PCFactorGetMatrix()`
334224b6179bSKris Buschelman M*/
334324b6179bSKris Buschelman 
3344d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatFactorGetSolverType_mumps(Mat A, MatSolverType *type)
3345d71ae5a4SJacob Faibussowitsch {
334635bd34faSBarry Smith   PetscFunctionBegin;
33472692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
33483ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
334935bd34faSBarry Smith }
335035bd34faSBarry Smith 
3351bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
3352d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_aij_mumps(Mat A, MatFactorType ftype, Mat *F)
3353d71ae5a4SJacob Faibussowitsch {
33542877fffaSHong Zhang   Mat         B;
33552877fffaSHong Zhang   Mat_MUMPS  *mumps;
3356*c3e1b152SPierre Jolivet   PetscBool   isSeqAIJ, isDiag;
33572c7c0729SBarry Smith   PetscMPIInt size;
33582877fffaSHong Zhang 
33592877fffaSHong Zhang   PetscFunctionBegin;
3360eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
336103e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
336203e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
336303e5aca4SStefano Zampini     *F = NULL;
336403e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
336503e5aca4SStefano Zampini   }
3366eb1ec7c1SStefano Zampini #endif
33672877fffaSHong Zhang   /* Create the factorization matrix */
33689566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATSEQAIJ, &isSeqAIJ));
3369*c3e1b152SPierre Jolivet   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATDIAGONAL, &isDiag));
33709566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
33719566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
33729566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
33739566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
33742877fffaSHong Zhang 
33754dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
33762205254eSKarl Rupp 
33772877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
337835bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
33792205254eSKarl Rupp 
33809566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
33819566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
33829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
33839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
33849566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
33859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
33869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
33879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
33889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
33899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
33909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
33915c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
33929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
33939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
33946444a565SStefano Zampini 
3395450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3396450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3397d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3398bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3399*c3e1b152SPierre Jolivet     else if (isDiag) mumps->ConvertToTriples = MatConvertToTriples_diagonal_xaij;
3400bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
34019566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3402746480a1SHong Zhang     mumps->sym = 0;
3403dcd589f8SShri Abhyankar   } else {
340467877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3405450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3406bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3407*c3e1b152SPierre Jolivet     else if (isDiag) mumps->ConvertToTriples = MatConvertToTriples_diagonal_xaij;
3408bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
34099566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
341059ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
341159ac8732SStefano Zampini     mumps->sym = 2;
341259ac8732SStefano Zampini #else
3413b94d7dedSBarry Smith     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
34146fdc2a6dSBarry Smith     else mumps->sym = 2;
341559ac8732SStefano Zampini #endif
3416450b117fSShri Abhyankar   }
34172877fffaSHong Zhang 
341800c67f3bSHong Zhang   /* set solvertype */
34199566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
34209566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
34219566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
34222c7c0729SBarry Smith   if (size == 1) {
34234ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3424f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
34252c7c0729SBarry Smith   }
34262877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3427e69c285eSBarry Smith   B->data         = (void *)mumps;
34282205254eSKarl Rupp 
34292877fffaSHong Zhang   *F               = B;
3430413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3431413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3432413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3433d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
34343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34352877fffaSHong Zhang }
34362877fffaSHong Zhang 
3437bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3438d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A, MatFactorType ftype, Mat *F)
3439d71ae5a4SJacob Faibussowitsch {
34402877fffaSHong Zhang   Mat         B;
34412877fffaSHong Zhang   Mat_MUMPS  *mumps;
3442ace3abfcSBarry Smith   PetscBool   isSeqSBAIJ;
34432c7c0729SBarry Smith   PetscMPIInt size;
34442877fffaSHong Zhang 
34452877fffaSHong Zhang   PetscFunctionBegin;
3446eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
344703e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
344803e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
344903e5aca4SStefano Zampini     *F = NULL;
345003e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
345103e5aca4SStefano Zampini   }
3452eb1ec7c1SStefano Zampini #endif
34539566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
34549566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
34559566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
34569566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3457e69c285eSBarry Smith 
34584dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
34599566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSBAIJ, &isSeqSBAIJ));
3460bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
346116ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3462dcd589f8SShri Abhyankar   } else {
3463bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3464bccb9932SShri Abhyankar   }
3465bccb9932SShri Abhyankar 
346667877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3467bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3468722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
34692205254eSKarl Rupp 
34709566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
34719566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
34729566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
34739566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
34749566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
34759566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
34769566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
34779566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
34789566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
34799566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
34809566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
34815c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
34829566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
34839566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
34842205254eSKarl Rupp 
3485f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
348659ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
348759ac8732SStefano Zampini   mumps->sym = 2;
348859ac8732SStefano Zampini #else
3489b94d7dedSBarry Smith   if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
34906fdc2a6dSBarry Smith   else mumps->sym = 2;
349159ac8732SStefano Zampini #endif
3492a214ac2aSShri Abhyankar 
349300c67f3bSHong Zhang   /* set solvertype */
34949566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
34959566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
34969566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
34972c7c0729SBarry Smith   if (size == 1) {
34984ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3499f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35002c7c0729SBarry Smith   }
35019566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3502f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3503e69c285eSBarry Smith   B->data         = (void *)mumps;
35042205254eSKarl Rupp 
35052877fffaSHong Zhang   *F               = B;
3506413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3507413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3508413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3509d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35103ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
35112877fffaSHong Zhang }
351297969023SHong Zhang 
3513d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_baij_mumps(Mat A, MatFactorType ftype, Mat *F)
3514d71ae5a4SJacob Faibussowitsch {
351567877ebaSShri Abhyankar   Mat         B;
351667877ebaSShri Abhyankar   Mat_MUMPS  *mumps;
3517ace3abfcSBarry Smith   PetscBool   isSeqBAIJ;
35182c7c0729SBarry Smith   PetscMPIInt size;
351967877ebaSShri Abhyankar 
352067877ebaSShri Abhyankar   PetscFunctionBegin;
352167877ebaSShri Abhyankar   /* Create the factorization matrix */
35229566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQBAIJ, &isSeqBAIJ));
35239566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35249566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
35259566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
35269566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3527450b117fSShri Abhyankar 
35284dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
3529450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3530450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3531450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3532bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3533bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3534746480a1SHong Zhang     mumps->sym = 0;
35359566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3536546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3537bccb9932SShri Abhyankar 
3538450b117fSShri Abhyankar   B->ops->view    = MatView_MUMPS;
3539722b6324SPierre Jolivet   B->ops->getinfo = MatGetInfo_MUMPS;
35402205254eSKarl Rupp 
35419566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35429566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35439566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35449566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
35459566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
35469566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
35479566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
35489566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
35499566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
35509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
35519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
35525c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
35539566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
35549566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
3555450b117fSShri Abhyankar 
355600c67f3bSHong Zhang   /* set solvertype */
35579566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
35589566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
35599566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
35602c7c0729SBarry Smith   if (size == 1) {
35614ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3562f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35632c7c0729SBarry Smith   }
35647ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
35657ee00b23SStefano Zampini   B->data         = (void *)mumps;
35667ee00b23SStefano Zampini 
35677ee00b23SStefano Zampini   *F               = B;
3568413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3569413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3570413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3571d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35723ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
35737ee00b23SStefano Zampini }
35747ee00b23SStefano Zampini 
35757ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
3576d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sell_mumps(Mat A, MatFactorType ftype, Mat *F)
3577d71ae5a4SJacob Faibussowitsch {
35787ee00b23SStefano Zampini   Mat         B;
35797ee00b23SStefano Zampini   Mat_MUMPS  *mumps;
35807ee00b23SStefano Zampini   PetscBool   isSeqSELL;
35812c7c0729SBarry Smith   PetscMPIInt size;
35827ee00b23SStefano Zampini 
35837ee00b23SStefano Zampini   PetscFunctionBegin;
35847ee00b23SStefano Zampini   /* Create the factorization matrix */
35859566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSELL, &isSeqSELL));
35869566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35879566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
35889566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
35899566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
35907ee00b23SStefano Zampini 
35914dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
35927ee00b23SStefano Zampini 
35937ee00b23SStefano Zampini   B->ops->view    = MatView_MUMPS;
35947ee00b23SStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
35957ee00b23SStefano Zampini 
35969566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35979566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35989566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35999566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
36009566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
36019566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
36029566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
36039566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
36049566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
36059566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
36069566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
36075c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
36087ee00b23SStefano Zampini 
36097ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
36107ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
36117ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
36127ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
36137ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
36147ee00b23SStefano Zampini     mumps->sym = 0;
36159566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
36167ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
36177ee00b23SStefano Zampini 
36187ee00b23SStefano Zampini   /* set solvertype */
36199566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
36209566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
36219566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
36222c7c0729SBarry Smith   if (size == 1) {
36234ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3624f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
36252c7c0729SBarry Smith   }
3626450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3627e69c285eSBarry Smith   B->data         = (void *)mumps;
36282205254eSKarl Rupp 
3629450b117fSShri Abhyankar   *F               = B;
3630413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3631413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3632413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3633d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
36343ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3635450b117fSShri Abhyankar }
363642c9c57cSBarry Smith 
36379d0448ceSStefano Zampini /* MatGetFactor for MATNEST matrices */
36389d0448ceSStefano Zampini static PetscErrorCode MatGetFactor_nest_mumps(Mat A, MatFactorType ftype, Mat *F)
36399d0448ceSStefano Zampini {
36409d0448ceSStefano Zampini   Mat         B, **mats;
36419d0448ceSStefano Zampini   Mat_MUMPS  *mumps;
36429d0448ceSStefano Zampini   PetscInt    nr, nc;
36439d0448ceSStefano Zampini   PetscMPIInt size;
364403e5aca4SStefano Zampini   PetscBool   flg = PETSC_TRUE;
36459d0448ceSStefano Zampini 
36469d0448ceSStefano Zampini   PetscFunctionBegin;
36479d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
364803e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
364903e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
365003e5aca4SStefano Zampini     *F = NULL;
365103e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
365203e5aca4SStefano Zampini   }
36539d0448ceSStefano Zampini #endif
36549d0448ceSStefano Zampini 
365503e5aca4SStefano Zampini   /* Return if some condition is not satisfied */
365603e5aca4SStefano Zampini   *F = NULL;
36579d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
36589d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY) {
36599d0448ceSStefano Zampini     IS       *rows, *cols;
36609d0448ceSStefano Zampini     PetscInt *m, *M;
36619d0448ceSStefano Zampini 
36629d0448ceSStefano 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);
36639d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &rows, nc, &cols));
36649d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
36659d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++) PetscCall(ISEqualUnsorted(rows[r], cols[r], &flg));
366603e5aca4SStefano Zampini     if (!flg) {
366703e5aca4SStefano Zampini       PetscCall(PetscFree2(rows, cols));
366803e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for unequal row and column maps. Use MAT_FACTOR_LU.\n"));
366903e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
367003e5aca4SStefano Zampini     }
36719d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &m, nr, &M));
36729d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetMinMax(rows[r], &m[r], &M[r]));
36739d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++)
36749d0448ceSStefano Zampini       for (PetscInt k = r + 1; flg && k < nr; k++)
36759d0448ceSStefano Zampini         if ((m[k] <= m[r] && m[r] <= M[k]) || (m[k] <= M[r] && M[r] <= M[k])) flg = PETSC_FALSE;
36769d0448ceSStefano Zampini     PetscCall(PetscFree2(m, M));
36779d0448ceSStefano Zampini     PetscCall(PetscFree2(rows, cols));
367803e5aca4SStefano Zampini     if (!flg) {
367903e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for intersecting row maps. Use MAT_FACTOR_LU.\n"));
368003e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
368103e5aca4SStefano Zampini     }
36829d0448ceSStefano Zampini   }
36839d0448ceSStefano Zampini 
36849d0448ceSStefano Zampini   for (PetscInt r = 0; r < nr; r++) {
36859d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) {
36869d0448ceSStefano Zampini       Mat       sub = mats[r][c];
3687*c3e1b152SPierre Jolivet       PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans, isDiag;
36889d0448ceSStefano Zampini 
36899d0448ceSStefano Zampini       if (!sub || (ftype == MAT_FACTOR_CHOLESKY && c < r)) continue;
36905d955bbbSStefano Zampini       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
36915d955bbbSStefano Zampini       if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
36925d955bbbSStefano Zampini       else {
36935d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isTrans));
36945d955bbbSStefano Zampini         if (isTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
36955d955bbbSStefano Zampini       }
36969d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
36979d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
36989d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
36999d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
37009d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
37019d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
3702*c3e1b152SPierre Jolivet       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATDIAGONAL, &isDiag));
37039d0448ceSStefano Zampini       if (ftype == MAT_FACTOR_CHOLESKY) {
3704dcab004fSPierre Jolivet         if (r == c) {
3705*c3e1b152SPierre Jolivet           if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isSeqSBAIJ && !isMPISBAIJ && !isDiag) {
370603e5aca4SStefano Zampini             PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
370703e5aca4SStefano Zampini             flg = PETSC_FALSE;
3708dcab004fSPierre Jolivet           }
3709*c3e1b152SPierre Jolivet         } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isDiag) {
371003e5aca4SStefano Zampini           PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for off-diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
371103e5aca4SStefano Zampini           flg = PETSC_FALSE;
371203e5aca4SStefano Zampini         }
3713*c3e1b152SPierre Jolivet       } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ && !isDiag) {
371403e5aca4SStefano Zampini         PetscCall(PetscInfo(sub, "MAT_LU_FACTOR not supported for block of type %s.\n", ((PetscObject)sub)->type_name));
371503e5aca4SStefano Zampini         flg = PETSC_FALSE;
37169d0448ceSStefano Zampini       }
37179d0448ceSStefano Zampini     }
371803e5aca4SStefano Zampini   }
371903e5aca4SStefano Zampini   if (!flg) PetscFunctionReturn(PETSC_SUCCESS);
37209d0448ceSStefano Zampini 
37219d0448ceSStefano Zampini   /* Create the factorization matrix */
37229d0448ceSStefano Zampini   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
37239d0448ceSStefano Zampini   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
37249d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
37259d0448ceSStefano Zampini   PetscCall(MatSetUp(B));
37269d0448ceSStefano Zampini 
37279d0448ceSStefano Zampini   PetscCall(PetscNew(&mumps));
37289d0448ceSStefano Zampini 
37299d0448ceSStefano Zampini   B->ops->view    = MatView_MUMPS;
37309d0448ceSStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
37319d0448ceSStefano Zampini 
37329d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
37339d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
37349d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
37359d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
37369d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
37379d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
37389d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
37399d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
37409d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
37419d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
37429d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
37439d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
37449d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
37459d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
37469d0448ceSStefano Zampini 
37479d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_LU) {
37489d0448ceSStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
37499d0448ceSStefano Zampini     B->factortype            = MAT_FACTOR_LU;
37509d0448ceSStefano Zampini     mumps->sym               = 0;
37519d0448ceSStefano Zampini   } else {
37529d0448ceSStefano Zampini     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
37539d0448ceSStefano Zampini     B->factortype                  = MAT_FACTOR_CHOLESKY;
37549d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
37559d0448ceSStefano Zampini     mumps->sym = 2;
37569d0448ceSStefano Zampini #else
37579d0448ceSStefano Zampini     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
37589d0448ceSStefano Zampini     else mumps->sym = 2;
37599d0448ceSStefano Zampini #endif
37609d0448ceSStefano Zampini   }
37619d0448ceSStefano Zampini   mumps->ConvertToTriples = MatConvertToTriples_nest_xaij;
37629d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[ftype]));
37639d0448ceSStefano Zampini 
37649d0448ceSStefano Zampini   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
37659d0448ceSStefano Zampini   if (size == 1) {
37669d0448ceSStefano Zampini     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
37679d0448ceSStefano Zampini     B->canuseordering = PETSC_TRUE;
37689d0448ceSStefano Zampini   }
37699d0448ceSStefano Zampini 
37709d0448ceSStefano Zampini   /* set solvertype */
37719d0448ceSStefano Zampini   PetscCall(PetscFree(B->solvertype));
37729d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
37739d0448ceSStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
37749d0448ceSStefano Zampini   B->data         = (void *)mumps;
37759d0448ceSStefano Zampini 
37769d0448ceSStefano Zampini   *F               = B;
37779d0448ceSStefano Zampini   mumps->id.job    = JOB_NULL;
37789d0448ceSStefano Zampini   mumps->ICNTL_pre = NULL;
37799d0448ceSStefano Zampini   mumps->CNTL_pre  = NULL;
37809d0448ceSStefano Zampini   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
37819d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37829d0448ceSStefano Zampini }
37839d0448ceSStefano Zampini 
3784d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
3785d71ae5a4SJacob Faibussowitsch {
378642c9c57cSBarry Smith   PetscFunctionBegin;
37879566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37889566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37899566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37909566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37919566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPISBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37929566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37939566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37949566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37959566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37969566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37979566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSELL, MAT_FACTOR_LU, MatGetFactor_sell_mumps));
3798*c3e1b152SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATDIAGONAL, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
3799*c3e1b152SPierre Jolivet   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATDIAGONAL, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
38009d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_LU, MatGetFactor_nest_mumps));
38019d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_CHOLESKY, MatGetFactor_nest_mumps));
38023ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
380342c9c57cSBarry Smith }
3804