xref: /petsc/src/mat/impls/aij/mpi/mumps/mumps.c (revision 145b44c9dda6e724c25668e48c0440cb162ee093)
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     mumps->id.ICNTL(26) = 1; /* condensation phase */
335b5fa320bSStefano Zampini   } else {                   /* prepare for the expansion step */
336b8f61ee1SStefano Zampini     /* solve Schur complement (this has to be done by the MUMPS user, so basically us) */
3379566063dSJacob Faibussowitsch     PetscCall(MatMumpsSolveSchur_Private(F));
338b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = 2; /* expansion phase */
3393ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
3409261f6e4SBarry 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));
341b5fa320bSStefano Zampini     /* restore defaults */
342b5fa320bSStefano Zampini     mumps->id.ICNTL(26) = -1;
343d3d598ffSStefano Zampini     /* free MUMPS internal array for redrhs if we have solved for multiple rhs in order to save memory space */
344d3d598ffSStefano Zampini     if (mumps->id.nrhs > 1) {
3459566063dSJacob Faibussowitsch       PetscCall(PetscFree(mumps->id.redrhs));
346d3d598ffSStefano Zampini       mumps->id.lredrhs = 0;
347d3d598ffSStefano Zampini       mumps->sizeredrhs = 0;
348d3d598ffSStefano Zampini     }
349b5fa320bSStefano Zampini   }
3503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
351b5fa320bSStefano Zampini }
352b5fa320bSStefano Zampini 
353397b6df1SKris Buschelman /*
354d341cd04SHong Zhang   MatConvertToTriples_A_B - convert Petsc matrix to triples: row[nz], col[nz], val[nz]
355d341cd04SHong Zhang 
356397b6df1SKris Buschelman   input:
35775480915SPierre Jolivet     A       - matrix in aij,baij or sbaij format
358397b6df1SKris Buschelman     shift   - 0: C style output triple; 1: Fortran style output triple.
359bccb9932SShri Abhyankar     reuse   - MAT_INITIAL_MATRIX: spaces are allocated and values are set for the triple
360bccb9932SShri Abhyankar               MAT_REUSE_MATRIX:   only the values in v array are updated
361397b6df1SKris Buschelman   output:
362397b6df1SKris Buschelman     nnz     - dim of r, c, and v (number of local nonzero entries of A)
363397b6df1SKris Buschelman     r, c, v - row and col index, matrix values (matrix triples)
364eb9baa12SBarry Smith 
365eb9baa12SBarry Smith   The returned values r, c, and sometimes v are obtained in a single PetscMalloc(). Then in MatDestroy_MUMPS() it is
3667ee00b23SStefano Zampini   freed with PetscFree(mumps->irn);  This is not ideal code, the fact that v is ONLY sometimes part of mumps->irn means
367eb9baa12SBarry Smith   that the PetscMalloc() cannot easily be replaced with a PetscMalloc3().
368eb9baa12SBarry Smith 
369397b6df1SKris Buschelman  */
37016ebf90aSShri Abhyankar 
371d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
372d71ae5a4SJacob Faibussowitsch {
373a3d589ffSStefano Zampini   const PetscScalar *av;
374185f6596SHong Zhang   const PetscInt    *ai, *aj, *ajj, M = A->rmap->n;
375a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j, k;
376a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
37716ebf90aSShri Abhyankar   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
378397b6df1SKris Buschelman 
379397b6df1SKris Buschelman   PetscFunctionBegin;
3809566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
381a6053eceSJunchao Zhang   mumps->val = (PetscScalar *)av;
382bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
3832205254eSKarl Rupp     nz = aa->nz;
3842205254eSKarl Rupp     ai = aa->i;
3852205254eSKarl Rupp     aj = aa->j;
3869566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
387a6053eceSJunchao Zhang     for (i = k = 0; i < M; i++) {
38816ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
38967877ebaSShri Abhyankar       ajj = aj + ai[i];
39067877ebaSShri Abhyankar       for (j = 0; j < rnz; j++) {
3919566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[k]));
3929566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[k]));
393a6053eceSJunchao Zhang         k++;
39416ebf90aSShri Abhyankar       }
39516ebf90aSShri Abhyankar     }
396a6053eceSJunchao Zhang     mumps->irn = row;
397a6053eceSJunchao Zhang     mumps->jcn = col;
398a6053eceSJunchao Zhang     mumps->nnz = nz;
39916ebf90aSShri Abhyankar   }
4009566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
4013ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
40216ebf90aSShri Abhyankar }
403397b6df1SKris Buschelman 
404d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqsell_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
405d71ae5a4SJacob Faibussowitsch {
406a6053eceSJunchao Zhang   PetscInt64     nz, i, j, k, r;
4077ee00b23SStefano Zampini   Mat_SeqSELL   *a = (Mat_SeqSELL *)A->data;
408a6053eceSJunchao Zhang   PetscMUMPSInt *row, *col;
4097ee00b23SStefano Zampini 
4107ee00b23SStefano Zampini   PetscFunctionBegin;
411a6053eceSJunchao Zhang   mumps->val = a->val;
4127ee00b23SStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
4137ee00b23SStefano Zampini     nz = a->sliidx[a->totalslices];
4149566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
415a6053eceSJunchao Zhang     for (i = k = 0; i < a->totalslices; i++) {
41648a46eb9SPierre 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++]));
4177ee00b23SStefano Zampini     }
4189566063dSJacob Faibussowitsch     for (i = 0; i < nz; i++) PetscCall(PetscMUMPSIntCast(a->colidx[i] + shift, &col[i]));
419a6053eceSJunchao Zhang     mumps->irn = row;
420a6053eceSJunchao Zhang     mumps->jcn = col;
421a6053eceSJunchao Zhang     mumps->nnz = nz;
4227ee00b23SStefano Zampini   }
4233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
4247ee00b23SStefano Zampini }
4257ee00b23SStefano Zampini 
426d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqbaij_seqaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
427d71ae5a4SJacob Faibussowitsch {
42867877ebaSShri Abhyankar   Mat_SeqBAIJ    *aa = (Mat_SeqBAIJ *)A->data;
42933d57670SJed Brown   const PetscInt *ai, *aj, *ajj, bs2 = aa->bs2;
430a6053eceSJunchao Zhang   PetscInt64      M, nz, idx = 0, rnz, i, j, k, m;
431a6053eceSJunchao Zhang   PetscInt        bs;
432a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
43367877ebaSShri Abhyankar 
43467877ebaSShri Abhyankar   PetscFunctionBegin;
4359566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
43633d57670SJed Brown   M          = A->rmap->N / bs;
437a6053eceSJunchao Zhang   mumps->val = aa->a;
438bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
4399371c9d4SSatish Balay     ai = aa->i;
4409371c9d4SSatish Balay     aj = aa->j;
44167877ebaSShri Abhyankar     nz = bs2 * aa->nz;
4429566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
44367877ebaSShri Abhyankar     for (i = 0; i < M; i++) {
44467877ebaSShri Abhyankar       ajj = aj + ai[i];
44567877ebaSShri Abhyankar       rnz = ai[i + 1] - ai[i];
44667877ebaSShri Abhyankar       for (k = 0; k < rnz; k++) {
44767877ebaSShri Abhyankar         for (j = 0; j < bs; j++) {
44867877ebaSShri Abhyankar           for (m = 0; m < bs; m++) {
4499566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[idx]));
4509566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * ajj[k] + j + shift, &col[idx]));
451a6053eceSJunchao Zhang             idx++;
45267877ebaSShri Abhyankar           }
45367877ebaSShri Abhyankar         }
45467877ebaSShri Abhyankar       }
45567877ebaSShri Abhyankar     }
456a6053eceSJunchao Zhang     mumps->irn = row;
457a6053eceSJunchao Zhang     mumps->jcn = col;
458a6053eceSJunchao Zhang     mumps->nnz = nz;
45967877ebaSShri Abhyankar   }
4603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
46167877ebaSShri Abhyankar }
46267877ebaSShri Abhyankar 
463d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqsbaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
464d71ae5a4SJacob Faibussowitsch {
46575480915SPierre Jolivet   const PetscInt *ai, *aj, *ajj;
466a6053eceSJunchao Zhang   PetscInt        bs;
467a6053eceSJunchao Zhang   PetscInt64      nz, rnz, i, j, k, m;
468a6053eceSJunchao Zhang   PetscMUMPSInt  *row, *col;
46975480915SPierre Jolivet   PetscScalar    *val;
47016ebf90aSShri Abhyankar   Mat_SeqSBAIJ   *aa  = (Mat_SeqSBAIJ *)A->data;
47175480915SPierre Jolivet   const PetscInt  bs2 = aa->bs2, mbs = aa->mbs;
47238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
473b94d7dedSBarry Smith   PetscBool isset, hermitian;
47438548759SBarry Smith #endif
47516ebf90aSShri Abhyankar 
47616ebf90aSShri Abhyankar   PetscFunctionBegin;
47738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
478b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
479b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
48038548759SBarry Smith #endif
4812205254eSKarl Rupp   ai = aa->i;
4822205254eSKarl Rupp   aj = aa->j;
4839566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
48475480915SPierre Jolivet   if (reuse == MAT_INITIAL_MATRIX) {
485f3fa974cSJacob Faibussowitsch     const PetscInt64 alloc_size = aa->nz * bs2;
486f3fa974cSJacob Faibussowitsch 
487f3fa974cSJacob Faibussowitsch     PetscCall(PetscMalloc2(alloc_size, &row, alloc_size, &col));
488a6053eceSJunchao Zhang     if (bs > 1) {
489f3fa974cSJacob Faibussowitsch       PetscCall(PetscMalloc1(alloc_size, &mumps->val_alloc));
490a6053eceSJunchao Zhang       mumps->val = mumps->val_alloc;
49175480915SPierre Jolivet     } else {
492a6053eceSJunchao Zhang       mumps->val = aa->a;
49375480915SPierre Jolivet     }
494a6053eceSJunchao Zhang     mumps->irn = row;
495a6053eceSJunchao Zhang     mumps->jcn = col;
496a6053eceSJunchao Zhang   } else {
497a6053eceSJunchao Zhang     if (bs == 1) mumps->val = aa->a;
498a6053eceSJunchao Zhang     row = mumps->irn;
499a6053eceSJunchao Zhang     col = mumps->jcn;
500a6053eceSJunchao Zhang   }
501a6053eceSJunchao Zhang   val = mumps->val;
502185f6596SHong Zhang 
50316ebf90aSShri Abhyankar   nz = 0;
504a81fe166SPierre Jolivet   if (bs > 1) {
50575480915SPierre Jolivet     for (i = 0; i < mbs; i++) {
50616ebf90aSShri Abhyankar       rnz = ai[i + 1] - ai[i];
50767877ebaSShri Abhyankar       ajj = aj + ai[i];
50875480915SPierre Jolivet       for (j = 0; j < rnz; j++) {
50975480915SPierre Jolivet         for (k = 0; k < bs; k++) {
51075480915SPierre Jolivet           for (m = 0; m < bs; m++) {
511ec4f40fdSPierre Jolivet             if (ajj[j] > i || k >= m) {
51275480915SPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
5139566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(i * bs + m + shift, &row[nz]));
5149566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(ajj[j] * bs + k + shift, &col[nz]));
51575480915SPierre Jolivet               }
51675480915SPierre Jolivet               val[nz++] = aa->a[(ai[i] + j) * bs2 + m + k * bs];
51775480915SPierre Jolivet             }
51875480915SPierre Jolivet           }
51975480915SPierre Jolivet         }
52075480915SPierre Jolivet       }
52175480915SPierre Jolivet     }
522a81fe166SPierre Jolivet   } else if (reuse == MAT_INITIAL_MATRIX) {
523a81fe166SPierre Jolivet     for (i = 0; i < mbs; i++) {
524a81fe166SPierre Jolivet       rnz = ai[i + 1] - ai[i];
525a81fe166SPierre Jolivet       ajj = aj + ai[i];
526a81fe166SPierre Jolivet       for (j = 0; j < rnz; j++) {
5279566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5289566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
529a6053eceSJunchao Zhang         nz++;
530a81fe166SPierre Jolivet       }
531a81fe166SPierre Jolivet     }
53208401ef6SPierre Jolivet     PetscCheck(nz == aa->nz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different numbers of nonzeros %" PetscInt64_FMT " != %" PetscInt_FMT, nz, aa->nz);
53375480915SPierre Jolivet   }
534a6053eceSJunchao Zhang   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = nz;
5353ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
53616ebf90aSShri Abhyankar }
53716ebf90aSShri Abhyankar 
538d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_seqaij_seqsbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
539d71ae5a4SJacob Faibussowitsch {
54067877ebaSShri Abhyankar   const PetscInt    *ai, *aj, *ajj, *adiag, M = A->rmap->n;
541a6053eceSJunchao Zhang   PetscInt64         nz, rnz, i, j;
54267877ebaSShri Abhyankar   const PetscScalar *av, *v1;
54316ebf90aSShri Abhyankar   PetscScalar       *val;
544a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
545829b1710SHong Zhang   Mat_SeqAIJ        *aa = (Mat_SeqAIJ *)A->data;
54629b521d4Sstefano_zampini   PetscBool          missing;
54738548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
548b94d7dedSBarry Smith   PetscBool hermitian, isset;
54938548759SBarry Smith #endif
55016ebf90aSShri Abhyankar 
55116ebf90aSShri Abhyankar   PetscFunctionBegin;
55238548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
553b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
554b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
55538548759SBarry Smith #endif
5569566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(A, &av));
5579371c9d4SSatish Balay   ai    = aa->i;
5589371c9d4SSatish Balay   aj    = aa->j;
55916ebf90aSShri Abhyankar   adiag = aa->diag;
5609566063dSJacob Faibussowitsch   PetscCall(MatMissingDiagonal_SeqAIJ(A, &missing, NULL));
561bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
5627ee00b23SStefano Zampini     /* count nz in the upper triangular part of A */
563829b1710SHong Zhang     nz = 0;
56429b521d4Sstefano_zampini     if (missing) {
56529b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
56629b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
56729b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
56829b521d4Sstefano_zampini             if (aj[j] < i) continue;
56929b521d4Sstefano_zampini             nz++;
57029b521d4Sstefano_zampini           }
57129b521d4Sstefano_zampini         } else {
57229b521d4Sstefano_zampini           nz += ai[i + 1] - adiag[i];
57329b521d4Sstefano_zampini         }
57429b521d4Sstefano_zampini       }
57529b521d4Sstefano_zampini     } else {
576829b1710SHong Zhang       for (i = 0; i < M; i++) nz += ai[i + 1] - adiag[i];
57729b521d4Sstefano_zampini     }
5789566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
5799566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
580a6053eceSJunchao Zhang     mumps->nnz = nz;
581a6053eceSJunchao Zhang     mumps->irn = row;
582a6053eceSJunchao Zhang     mumps->jcn = col;
583a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
584185f6596SHong Zhang 
58516ebf90aSShri Abhyankar     nz = 0;
58629b521d4Sstefano_zampini     if (missing) {
58729b521d4Sstefano_zampini       for (i = 0; i < M; i++) {
58829b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
58929b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
59029b521d4Sstefano_zampini             if (aj[j] < i) continue;
5919566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
5929566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(aj[j] + shift, &col[nz]));
59329b521d4Sstefano_zampini             val[nz] = av[j];
59429b521d4Sstefano_zampini             nz++;
59529b521d4Sstefano_zampini           }
59629b521d4Sstefano_zampini         } else {
59729b521d4Sstefano_zampini           rnz = ai[i + 1] - adiag[i];
59829b521d4Sstefano_zampini           ajj = aj + adiag[i];
59929b521d4Sstefano_zampini           v1  = av + adiag[i];
60029b521d4Sstefano_zampini           for (j = 0; j < rnz; j++) {
6019566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6029566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
603a6053eceSJunchao Zhang             val[nz++] = v1[j];
60429b521d4Sstefano_zampini           }
60529b521d4Sstefano_zampini         }
60629b521d4Sstefano_zampini       }
60729b521d4Sstefano_zampini     } else {
60816ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
60916ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
61067877ebaSShri Abhyankar         ajj = aj + adiag[i];
611cf3759fdSShri Abhyankar         v1  = av + adiag[i];
61267877ebaSShri Abhyankar         for (j = 0; j < rnz; j++) {
6139566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(i + shift, &row[nz]));
6149566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(ajj[j] + shift, &col[nz]));
615a6053eceSJunchao Zhang           val[nz++] = v1[j];
61616ebf90aSShri Abhyankar         }
61716ebf90aSShri Abhyankar       }
61829b521d4Sstefano_zampini     }
619397b6df1SKris Buschelman   } else {
620a6053eceSJunchao Zhang     nz  = 0;
621a6053eceSJunchao Zhang     val = mumps->val;
62229b521d4Sstefano_zampini     if (missing) {
62316ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
62429b521d4Sstefano_zampini         if (PetscUnlikely(adiag[i] >= ai[i + 1])) {
62529b521d4Sstefano_zampini           for (j = ai[i]; j < ai[i + 1]; j++) {
62629b521d4Sstefano_zampini             if (aj[j] < i) continue;
62729b521d4Sstefano_zampini             val[nz++] = av[j];
62829b521d4Sstefano_zampini           }
62929b521d4Sstefano_zampini         } else {
63016ebf90aSShri Abhyankar           rnz = ai[i + 1] - adiag[i];
63167877ebaSShri Abhyankar           v1  = av + adiag[i];
632ad540459SPierre Jolivet           for (j = 0; j < rnz; j++) val[nz++] = v1[j];
63316ebf90aSShri Abhyankar         }
63416ebf90aSShri Abhyankar       }
63529b521d4Sstefano_zampini     } else {
63616ebf90aSShri Abhyankar       for (i = 0; i < M; i++) {
63716ebf90aSShri Abhyankar         rnz = ai[i + 1] - adiag[i];
63816ebf90aSShri Abhyankar         v1  = av + adiag[i];
639ad540459SPierre Jolivet         for (j = 0; j < rnz; j++) val[nz++] = v1[j];
64016ebf90aSShri Abhyankar       }
64116ebf90aSShri Abhyankar     }
64229b521d4Sstefano_zampini   }
6439566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(A, &av));
6443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
64516ebf90aSShri Abhyankar }
64616ebf90aSShri Abhyankar 
647d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpisbaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
648d71ae5a4SJacob Faibussowitsch {
649a6053eceSJunchao Zhang   const PetscInt    *ai, *aj, *bi, *bj, *garray, *ajj, *bjj;
650a6053eceSJunchao Zhang   PetscInt           bs;
651a6053eceSJunchao Zhang   PetscInt64         rstart, nz, i, j, k, m, jj, irow, countA, countB;
652a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
65316ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
65416ebf90aSShri Abhyankar   PetscScalar       *val;
655397b6df1SKris Buschelman   Mat_MPISBAIJ      *mat = (Mat_MPISBAIJ *)A->data;
656397b6df1SKris Buschelman   Mat_SeqSBAIJ      *aa  = (Mat_SeqSBAIJ *)(mat->A)->data;
657397b6df1SKris Buschelman   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
658ec4f40fdSPierre Jolivet   const PetscInt     bs2 = aa->bs2, mbs = aa->mbs;
65938548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
660b94d7dedSBarry Smith   PetscBool hermitian, isset;
66138548759SBarry Smith #endif
66216ebf90aSShri Abhyankar 
66316ebf90aSShri Abhyankar   PetscFunctionBegin;
66438548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
665b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
666b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
66738548759SBarry Smith #endif
6689566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
66938548759SBarry Smith   rstart = A->rmap->rstart;
67038548759SBarry Smith   ai     = aa->i;
67138548759SBarry Smith   aj     = aa->j;
67238548759SBarry Smith   bi     = bb->i;
67338548759SBarry Smith   bj     = bb->j;
67438548759SBarry Smith   av     = aa->a;
67538548759SBarry Smith   bv     = bb->a;
676397b6df1SKris Buschelman 
6772205254eSKarl Rupp   garray = mat->garray;
6782205254eSKarl Rupp 
679bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
680a6053eceSJunchao Zhang     nz = (aa->nz + bb->nz) * bs2; /* just a conservative estimate */
6819566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
6829566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
683a6053eceSJunchao Zhang     /* can not decide the exact mumps->nnz now because of the SBAIJ */
684a6053eceSJunchao Zhang     mumps->irn = row;
685a6053eceSJunchao Zhang     mumps->jcn = col;
686a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
687397b6df1SKris Buschelman   } else {
688a6053eceSJunchao Zhang     val = mumps->val;
689397b6df1SKris Buschelman   }
690397b6df1SKris Buschelman 
6919371c9d4SSatish Balay   jj   = 0;
6929371c9d4SSatish Balay   irow = rstart;
693ec4f40fdSPierre Jolivet   for (i = 0; i < mbs; i++) {
694397b6df1SKris Buschelman     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
695397b6df1SKris Buschelman     countA = ai[i + 1] - ai[i];
696397b6df1SKris Buschelman     countB = bi[i + 1] - bi[i];
697397b6df1SKris Buschelman     bjj    = bj + bi[i];
698ec4f40fdSPierre Jolivet     v1     = av + ai[i] * bs2;
699ec4f40fdSPierre Jolivet     v2     = bv + bi[i] * bs2;
700397b6df1SKris Buschelman 
701ec4f40fdSPierre Jolivet     if (bs > 1) {
702ec4f40fdSPierre Jolivet       /* A-part */
703ec4f40fdSPierre Jolivet       for (j = 0; j < countA; j++) {
704ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
705ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
706ec4f40fdSPierre Jolivet             if (rstart + ajj[j] * bs > irow || k >= m) {
707ec4f40fdSPierre Jolivet               if (reuse == MAT_INITIAL_MATRIX) {
7089566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7099566063dSJacob Faibussowitsch                 PetscCall(PetscMUMPSIntCast(rstart + ajj[j] * bs + k + shift, &col[jj]));
710ec4f40fdSPierre Jolivet               }
711ec4f40fdSPierre Jolivet               val[jj++] = v1[j * bs2 + m + k * bs];
712ec4f40fdSPierre Jolivet             }
713ec4f40fdSPierre Jolivet           }
714ec4f40fdSPierre Jolivet         }
715ec4f40fdSPierre Jolivet       }
716ec4f40fdSPierre Jolivet 
717ec4f40fdSPierre Jolivet       /* B-part */
718ec4f40fdSPierre Jolivet       for (j = 0; j < countB; j++) {
719ec4f40fdSPierre Jolivet         for (k = 0; k < bs; k++) {
720ec4f40fdSPierre Jolivet           for (m = 0; m < bs; m++) {
721ec4f40fdSPierre Jolivet             if (reuse == MAT_INITIAL_MATRIX) {
7229566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(irow + m + shift, &row[jj]));
7239566063dSJacob Faibussowitsch               PetscCall(PetscMUMPSIntCast(garray[bjj[j]] * bs + k + shift, &col[jj]));
724ec4f40fdSPierre Jolivet             }
725ec4f40fdSPierre Jolivet             val[jj++] = v2[j * bs2 + m + k * bs];
726ec4f40fdSPierre Jolivet           }
727ec4f40fdSPierre Jolivet         }
728ec4f40fdSPierre Jolivet       }
729ec4f40fdSPierre Jolivet     } else {
730397b6df1SKris Buschelman       /* A-part */
731397b6df1SKris Buschelman       for (j = 0; j < countA; j++) {
732bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7339566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7349566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
735397b6df1SKris Buschelman         }
73616ebf90aSShri Abhyankar         val[jj++] = v1[j];
737397b6df1SKris Buschelman       }
73816ebf90aSShri Abhyankar 
73916ebf90aSShri Abhyankar       /* B-part */
74016ebf90aSShri Abhyankar       for (j = 0; j < countB; j++) {
741bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
7429566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
7439566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
744397b6df1SKris Buschelman         }
74516ebf90aSShri Abhyankar         val[jj++] = v2[j];
74616ebf90aSShri Abhyankar       }
74716ebf90aSShri Abhyankar     }
748ec4f40fdSPierre Jolivet     irow += bs;
749ec4f40fdSPierre Jolivet   }
7505d955bbbSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) mumps->nnz = jj;
7513ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
75216ebf90aSShri Abhyankar }
75316ebf90aSShri Abhyankar 
754d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpiaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
755d71ae5a4SJacob Faibussowitsch {
75616ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
7575d955bbbSStefano Zampini   PetscInt64         rstart, cstart, nz, i, j, jj, irow, countA, countB;
758a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
75916ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
76016ebf90aSShri Abhyankar   PetscScalar       *val;
761a3d589ffSStefano Zampini   Mat                Ad, Ao;
762a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
763a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
76416ebf90aSShri Abhyankar 
76516ebf90aSShri Abhyankar   PetscFunctionBegin;
7669566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
7679566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
7689566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
769a3d589ffSStefano Zampini 
770a3d589ffSStefano Zampini   aa = (Mat_SeqAIJ *)(Ad)->data;
771a3d589ffSStefano Zampini   bb = (Mat_SeqAIJ *)(Ao)->data;
77238548759SBarry Smith   ai = aa->i;
77338548759SBarry Smith   aj = aa->j;
77438548759SBarry Smith   bi = bb->i;
77538548759SBarry Smith   bj = bb->j;
77616ebf90aSShri Abhyankar 
777a3d589ffSStefano Zampini   rstart = A->rmap->rstart;
7785d955bbbSStefano Zampini   cstart = A->cmap->rstart;
7792205254eSKarl Rupp 
780bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
781a6053eceSJunchao Zhang     nz = (PetscInt64)aa->nz + bb->nz; /* make sure the sum won't overflow PetscInt */
7829566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
7839566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
784a6053eceSJunchao Zhang     mumps->nnz = nz;
785a6053eceSJunchao Zhang     mumps->irn = row;
786a6053eceSJunchao Zhang     mumps->jcn = col;
787a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
78816ebf90aSShri Abhyankar   } else {
789a6053eceSJunchao Zhang     val = mumps->val;
79016ebf90aSShri Abhyankar   }
79116ebf90aSShri Abhyankar 
7929371c9d4SSatish Balay   jj   = 0;
7939371c9d4SSatish Balay   irow = rstart;
79416ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
79516ebf90aSShri Abhyankar     ajj    = aj + ai[i]; /* ptr to the beginning of this row */
79616ebf90aSShri Abhyankar     countA = ai[i + 1] - ai[i];
79716ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
79816ebf90aSShri Abhyankar     bjj    = bj + bi[i];
79916ebf90aSShri Abhyankar     v1     = av + ai[i];
80016ebf90aSShri Abhyankar     v2     = bv + bi[i];
80116ebf90aSShri Abhyankar 
80216ebf90aSShri Abhyankar     /* A-part */
80316ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
804bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8059566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8065d955bbbSStefano Zampini         PetscCall(PetscMUMPSIntCast(cstart + ajj[j] + shift, &col[jj]));
80716ebf90aSShri Abhyankar       }
80816ebf90aSShri Abhyankar       val[jj++] = v1[j];
80916ebf90aSShri Abhyankar     }
81016ebf90aSShri Abhyankar 
81116ebf90aSShri Abhyankar     /* B-part */
81216ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
813bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
8149566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
8159566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
81616ebf90aSShri Abhyankar       }
81716ebf90aSShri Abhyankar       val[jj++] = v2[j];
81816ebf90aSShri Abhyankar     }
81916ebf90aSShri Abhyankar     irow++;
82016ebf90aSShri Abhyankar   }
8219566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
8229566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
8233ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
82416ebf90aSShri Abhyankar }
82516ebf90aSShri Abhyankar 
826d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpibaij_mpiaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
827d71ae5a4SJacob Faibussowitsch {
82867877ebaSShri Abhyankar   Mat_MPIBAIJ       *mat = (Mat_MPIBAIJ *)A->data;
82967877ebaSShri Abhyankar   Mat_SeqBAIJ       *aa  = (Mat_SeqBAIJ *)(mat->A)->data;
83067877ebaSShri Abhyankar   Mat_SeqBAIJ       *bb  = (Mat_SeqBAIJ *)(mat->B)->data;
83167877ebaSShri Abhyankar   const PetscInt    *ai = aa->i, *bi = bb->i, *aj = aa->j, *bj = bb->j, *ajj, *bjj;
8325d955bbbSStefano Zampini   const PetscInt    *garray = mat->garray, mbs = mat->mbs, rstart = A->rmap->rstart, cstart = A->cmap->rstart;
83333d57670SJed Brown   const PetscInt     bs2 = mat->bs2;
834a6053eceSJunchao Zhang   PetscInt           bs;
835a6053eceSJunchao Zhang   PetscInt64         nz, i, j, k, n, jj, irow, countA, countB, idx;
836a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
83767877ebaSShri Abhyankar   const PetscScalar *av = aa->a, *bv = bb->a, *v1, *v2;
83867877ebaSShri Abhyankar   PetscScalar       *val;
83967877ebaSShri Abhyankar 
84067877ebaSShri Abhyankar   PetscFunctionBegin;
8419566063dSJacob Faibussowitsch   PetscCall(MatGetBlockSize(A, &bs));
842bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
84367877ebaSShri Abhyankar     nz = bs2 * (aa->nz + bb->nz);
8449566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
8459566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
846a6053eceSJunchao Zhang     mumps->nnz = nz;
847a6053eceSJunchao Zhang     mumps->irn = row;
848a6053eceSJunchao Zhang     mumps->jcn = col;
849a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
85067877ebaSShri Abhyankar   } else {
851a6053eceSJunchao Zhang     val = mumps->val;
85267877ebaSShri Abhyankar   }
85367877ebaSShri Abhyankar 
8549371c9d4SSatish Balay   jj   = 0;
8559371c9d4SSatish Balay   irow = rstart;
85667877ebaSShri Abhyankar   for (i = 0; i < mbs; i++) {
85767877ebaSShri Abhyankar     countA = ai[i + 1] - ai[i];
85867877ebaSShri Abhyankar     countB = bi[i + 1] - bi[i];
85967877ebaSShri Abhyankar     ajj    = aj + ai[i];
86067877ebaSShri Abhyankar     bjj    = bj + bi[i];
86167877ebaSShri Abhyankar     v1     = av + bs2 * ai[i];
86267877ebaSShri Abhyankar     v2     = bv + bs2 * bi[i];
86367877ebaSShri Abhyankar 
86467877ebaSShri Abhyankar     idx = 0;
86567877ebaSShri Abhyankar     /* A-part */
86667877ebaSShri Abhyankar     for (k = 0; k < countA; k++) {
86767877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
86867877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
869bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8709566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8715d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(cstart + bs * ajj[k] + j + shift, &col[jj]));
87267877ebaSShri Abhyankar           }
87367877ebaSShri Abhyankar           val[jj++] = v1[idx++];
87467877ebaSShri Abhyankar         }
87567877ebaSShri Abhyankar       }
87667877ebaSShri Abhyankar     }
87767877ebaSShri Abhyankar 
87867877ebaSShri Abhyankar     idx = 0;
87967877ebaSShri Abhyankar     /* B-part */
88067877ebaSShri Abhyankar     for (k = 0; k < countB; k++) {
88167877ebaSShri Abhyankar       for (j = 0; j < bs; j++) {
88267877ebaSShri Abhyankar         for (n = 0; n < bs; n++) {
883bccb9932SShri Abhyankar           if (reuse == MAT_INITIAL_MATRIX) {
8849566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(irow + n + shift, &row[jj]));
8859566063dSJacob Faibussowitsch             PetscCall(PetscMUMPSIntCast(bs * garray[bjj[k]] + j + shift, &col[jj]));
88667877ebaSShri Abhyankar           }
887d985c460SShri Abhyankar           val[jj++] = v2[idx++];
88867877ebaSShri Abhyankar         }
88967877ebaSShri Abhyankar       }
89067877ebaSShri Abhyankar     }
891d985c460SShri Abhyankar     irow += bs;
89267877ebaSShri Abhyankar   }
8933ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
89467877ebaSShri Abhyankar }
89567877ebaSShri Abhyankar 
896d71ae5a4SJacob Faibussowitsch PetscErrorCode MatConvertToTriples_mpiaij_mpisbaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
897d71ae5a4SJacob Faibussowitsch {
89816ebf90aSShri Abhyankar   const PetscInt    *ai, *aj, *adiag, *bi, *bj, *garray, m = A->rmap->n, *ajj, *bjj;
899a6053eceSJunchao Zhang   PetscInt64         rstart, nz, nza, nzb, i, j, jj, irow, countA, countB;
900a6053eceSJunchao Zhang   PetscMUMPSInt     *row, *col;
90116ebf90aSShri Abhyankar   const PetscScalar *av, *bv, *v1, *v2;
90216ebf90aSShri Abhyankar   PetscScalar       *val;
903a3d589ffSStefano Zampini   Mat                Ad, Ao;
904a3d589ffSStefano Zampini   Mat_SeqAIJ        *aa;
905a3d589ffSStefano Zampini   Mat_SeqAIJ        *bb;
90638548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
907b94d7dedSBarry Smith   PetscBool hermitian, isset;
90838548759SBarry Smith #endif
90916ebf90aSShri Abhyankar 
91016ebf90aSShri Abhyankar   PetscFunctionBegin;
91138548759SBarry Smith #if defined(PETSC_USE_COMPLEX)
912b94d7dedSBarry Smith   PetscCall(MatIsHermitianKnown(A, &isset, &hermitian));
913b94d7dedSBarry Smith   PetscCheck(!isset || !hermitian, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "MUMPS does not support Hermitian symmetric matrices for Choleksy");
91438548759SBarry Smith #endif
9159566063dSJacob Faibussowitsch   PetscCall(MatMPIAIJGetSeqAIJ(A, &Ad, &Ao, &garray));
9169566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ad, &av));
9179566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJGetArrayRead(Ao, &bv));
918a3d589ffSStefano Zampini 
919a3d589ffSStefano Zampini   aa    = (Mat_SeqAIJ *)(Ad)->data;
920a3d589ffSStefano Zampini   bb    = (Mat_SeqAIJ *)(Ao)->data;
92138548759SBarry Smith   ai    = aa->i;
92238548759SBarry Smith   aj    = aa->j;
92338548759SBarry Smith   adiag = aa->diag;
92438548759SBarry Smith   bi    = bb->i;
92538548759SBarry Smith   bj    = bb->j;
9262205254eSKarl Rupp 
92716ebf90aSShri Abhyankar   rstart = A->rmap->rstart;
92816ebf90aSShri Abhyankar 
929bccb9932SShri Abhyankar   if (reuse == MAT_INITIAL_MATRIX) {
930e0bace9bSHong Zhang     nza = 0; /* num of upper triangular entries in mat->A, including diagonals */
931e0bace9bSHong Zhang     nzb = 0; /* num of upper triangular entries in mat->B */
93216ebf90aSShri Abhyankar     for (i = 0; i < m; i++) {
933e0bace9bSHong Zhang       nza += (ai[i + 1] - adiag[i]);
93416ebf90aSShri Abhyankar       countB = bi[i + 1] - bi[i];
93516ebf90aSShri Abhyankar       bjj    = bj + bi[i];
936e0bace9bSHong Zhang       for (j = 0; j < countB; j++) {
937e0bace9bSHong Zhang         if (garray[bjj[j]] > rstart) nzb++;
938e0bace9bSHong Zhang       }
939e0bace9bSHong Zhang     }
94016ebf90aSShri Abhyankar 
941e0bace9bSHong Zhang     nz = nza + nzb; /* total nz of upper triangular part of mat */
9429566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(nz, &row, nz, &col));
9439566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(nz, &val));
944a6053eceSJunchao Zhang     mumps->nnz = nz;
945a6053eceSJunchao Zhang     mumps->irn = row;
946a6053eceSJunchao Zhang     mumps->jcn = col;
947a6053eceSJunchao Zhang     mumps->val = mumps->val_alloc = val;
94816ebf90aSShri Abhyankar   } else {
949a6053eceSJunchao Zhang     val = mumps->val;
95016ebf90aSShri Abhyankar   }
95116ebf90aSShri Abhyankar 
9529371c9d4SSatish Balay   jj   = 0;
9539371c9d4SSatish Balay   irow = rstart;
95416ebf90aSShri Abhyankar   for (i = 0; i < m; i++) {
95516ebf90aSShri Abhyankar     ajj    = aj + adiag[i]; /* ptr to the beginning of the diagonal of this row */
95616ebf90aSShri Abhyankar     v1     = av + adiag[i];
95716ebf90aSShri Abhyankar     countA = ai[i + 1] - adiag[i];
95816ebf90aSShri Abhyankar     countB = bi[i + 1] - bi[i];
95916ebf90aSShri Abhyankar     bjj    = bj + bi[i];
96016ebf90aSShri Abhyankar     v2     = bv + bi[i];
96116ebf90aSShri Abhyankar 
96216ebf90aSShri Abhyankar     /* A-part */
96316ebf90aSShri Abhyankar     for (j = 0; j < countA; j++) {
964bccb9932SShri Abhyankar       if (reuse == MAT_INITIAL_MATRIX) {
9659566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9669566063dSJacob Faibussowitsch         PetscCall(PetscMUMPSIntCast(rstart + ajj[j] + shift, &col[jj]));
96716ebf90aSShri Abhyankar       }
96816ebf90aSShri Abhyankar       val[jj++] = v1[j];
96916ebf90aSShri Abhyankar     }
97016ebf90aSShri Abhyankar 
97116ebf90aSShri Abhyankar     /* B-part */
97216ebf90aSShri Abhyankar     for (j = 0; j < countB; j++) {
97316ebf90aSShri Abhyankar       if (garray[bjj[j]] > rstart) {
974bccb9932SShri Abhyankar         if (reuse == MAT_INITIAL_MATRIX) {
9759566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(irow + shift, &row[jj]));
9769566063dSJacob Faibussowitsch           PetscCall(PetscMUMPSIntCast(garray[bjj[j]] + shift, &col[jj]));
97716ebf90aSShri Abhyankar         }
97816ebf90aSShri Abhyankar         val[jj++] = v2[j];
97916ebf90aSShri Abhyankar       }
980397b6df1SKris Buschelman     }
981397b6df1SKris Buschelman     irow++;
982397b6df1SKris Buschelman   }
9839566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ad, &av));
9849566063dSJacob Faibussowitsch   PetscCall(MatSeqAIJRestoreArrayRead(Ao, &bv));
9853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
986397b6df1SKris Buschelman }
987397b6df1SKris Buschelman 
9889d0448ceSStefano Zampini PetscErrorCode MatConvertToTriples_nest_xaij(Mat A, PetscInt shift, MatReuse reuse, Mat_MUMPS *mumps)
9899d0448ceSStefano Zampini {
9909d0448ceSStefano Zampini   Mat     **mats;
9919d0448ceSStefano Zampini   PetscInt  nr, nc;
9929d0448ceSStefano Zampini   PetscBool chol = mumps->sym ? PETSC_TRUE : PETSC_FALSE;
9939d0448ceSStefano Zampini 
9949d0448ceSStefano Zampini   PetscFunctionBegin;
9959d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
9969d0448ceSStefano Zampini   if (reuse == MAT_INITIAL_MATRIX) {
9979d0448ceSStefano Zampini     PetscMUMPSInt *irns, *jcns;
9989d0448ceSStefano Zampini     PetscScalar   *vals;
9999d0448ceSStefano Zampini     PetscInt64     totnnz, cumnnz, maxnnz;
10009d0448ceSStefano Zampini     PetscInt      *pjcns_w;
10019d0448ceSStefano Zampini     IS            *rows, *cols;
10029d0448ceSStefano Zampini     PetscInt     **rows_idx, **cols_idx;
10039d0448ceSStefano Zampini 
10049d0448ceSStefano Zampini     cumnnz = 0;
10059d0448ceSStefano Zampini     maxnnz = 0;
10065d955bbbSStefano Zampini     PetscCall(PetscMalloc2(nr * nc + 1, &mumps->nest_vals_start, nr * nc, &mumps->nest_convert_to_triples));
10079d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
10089d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
10099d0448ceSStefano Zampini         Mat sub = mats[r][c];
10109d0448ceSStefano Zampini 
10119d0448ceSStefano Zampini         mumps->nest_convert_to_triples[r * nc + c] = NULL;
10129d0448ceSStefano Zampini         if (chol && c < r) continue; /* skip lower-triangular block for Cholesky */
10139d0448ceSStefano Zampini         if (sub) {
10149d0448ceSStefano Zampini           PetscErrorCode (*convert_to_triples)(Mat, PetscInt, MatReuse, Mat_MUMPS *) = NULL;
10155d955bbbSStefano Zampini           PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans, isHTrans = PETSC_FALSE;
10169d0448ceSStefano Zampini           MatInfo   info;
10179d0448ceSStefano Zampini 
10185d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
10195d955bbbSStefano Zampini           if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
10205d955bbbSStefano Zampini           else {
10215d955bbbSStefano Zampini             PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
10225d955bbbSStefano Zampini             if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
10235d955bbbSStefano Zampini           }
10249d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
10259d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
10269d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
10279d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
10289d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
10299d0448ceSStefano Zampini           PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
10309d0448ceSStefano Zampini 
10319d0448ceSStefano Zampini           if (chol) {
10329d0448ceSStefano Zampini             if (r == c) {
10339d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqsbaij;
10349d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpisbaij;
10359d0448ceSStefano Zampini               else if (isSeqSBAIJ) convert_to_triples = MatConvertToTriples_seqsbaij_seqsbaij;
10369d0448ceSStefano Zampini               else if (isMPISBAIJ) convert_to_triples = MatConvertToTriples_mpisbaij_mpisbaij;
10379d0448ceSStefano Zampini             } else {
10389d0448ceSStefano Zampini               if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10399d0448ceSStefano Zampini               else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10409d0448ceSStefano Zampini               else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10419d0448ceSStefano Zampini               else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
10429d0448ceSStefano Zampini             }
10439d0448ceSStefano Zampini           } else {
10449d0448ceSStefano Zampini             if (isSeqAIJ) convert_to_triples = MatConvertToTriples_seqaij_seqaij;
10459d0448ceSStefano Zampini             else if (isMPIAIJ) convert_to_triples = MatConvertToTriples_mpiaij_mpiaij;
10469d0448ceSStefano Zampini             else if (isSeqBAIJ) convert_to_triples = MatConvertToTriples_seqbaij_seqaij;
10479d0448ceSStefano Zampini             else if (isMPIBAIJ) convert_to_triples = MatConvertToTriples_mpibaij_mpiaij;
10489d0448ceSStefano Zampini           }
10499d0448ceSStefano Zampini           PetscCheck(convert_to_triples, PetscObjectComm((PetscObject)sub), PETSC_ERR_SUP, "Not for block of type %s", ((PetscObject)sub)->type_name);
10509d0448ceSStefano Zampini           mumps->nest_convert_to_triples[r * nc + c] = convert_to_triples;
10519d0448ceSStefano Zampini           PetscCall(MatGetInfo(sub, MAT_LOCAL, &info));
10529d0448ceSStefano Zampini           cumnnz += (PetscInt64)info.nz_used; /* can be overestimated for Cholesky */
10539d0448ceSStefano Zampini           maxnnz = PetscMax(maxnnz, info.nz_used);
10549d0448ceSStefano Zampini         }
10559d0448ceSStefano Zampini       }
10569d0448ceSStefano Zampini     }
10579d0448ceSStefano Zampini 
10589d0448ceSStefano Zampini     /* Allocate total COO */
10599d0448ceSStefano Zampini     totnnz = cumnnz;
10609d0448ceSStefano Zampini     PetscCall(PetscMalloc2(totnnz, &irns, totnnz, &jcns));
10619d0448ceSStefano Zampini     PetscCall(PetscMalloc1(totnnz, &vals));
10629d0448ceSStefano Zampini 
10639d0448ceSStefano Zampini     /* Handle rows and column maps
10649d0448ceSStefano Zampini        We directly map rows and use an SF for the columns */
10659d0448ceSStefano Zampini     PetscCall(PetscMalloc4(nr, &rows, nc, &cols, nr, &rows_idx, nc, &cols_idx));
10669d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
10679d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetIndices(rows[r], (const PetscInt **)&rows_idx[r]));
10689d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISGetIndices(cols[c], (const PetscInt **)&cols_idx[c]));
10699d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscMalloc1(maxnnz, &pjcns_w));
10705d955bbbSStefano Zampini     else (void)maxnnz;
10719d0448ceSStefano Zampini 
10729d0448ceSStefano Zampini     cumnnz = 0;
10739d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
10749d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
10759d0448ceSStefano Zampini         Mat             sub  = mats[r][c];
10769d0448ceSStefano Zampini         const PetscInt *ridx = rows_idx[r];
10775d955bbbSStefano Zampini         const PetscInt *cidx = cols_idx[c];
10789d0448ceSStefano Zampini         PetscInt        rst;
10799d0448ceSStefano Zampini         PetscSF         csf;
10805d955bbbSStefano Zampini         PetscBool       isTrans, isHTrans = PETSC_FALSE, swap;
10815d955bbbSStefano Zampini         PetscLayout     cmap;
10829d0448ceSStefano Zampini 
10839d0448ceSStefano Zampini         mumps->nest_vals_start[r * nc + c] = cumnnz;
10849d0448ceSStefano Zampini         if (!mumps->nest_convert_to_triples[r * nc + c]) continue;
10859d0448ceSStefano Zampini 
10865d955bbbSStefano Zampini         /* Extract inner blocks if needed */
10875d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
10885d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
10895d955bbbSStefano Zampini         else {
10905d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
10915d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
10925d955bbbSStefano Zampini         }
10935d955bbbSStefano Zampini         swap = (PetscBool)(isTrans || isHTrans);
10945d955bbbSStefano Zampini 
10955d955bbbSStefano Zampini         /* Get column layout to map off-process columns */
10965d955bbbSStefano Zampini         PetscCall(MatGetLayouts(sub, NULL, &cmap));
10975d955bbbSStefano Zampini 
10985d955bbbSStefano Zampini         /* Get row start to map on-process rows */
10995d955bbbSStefano Zampini         PetscCall(MatGetOwnershipRange(sub, &rst, NULL));
11005d955bbbSStefano Zampini 
11019d0448ceSStefano Zampini         /* Directly use the mumps datastructure and use C ordering for now */
11029d0448ceSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[r * nc + c])(sub, 0, MAT_INITIAL_MATRIX, mumps));
11039d0448ceSStefano Zampini 
11045d955bbbSStefano Zampini         /* Swap the role of rows and columns indices for transposed blocks
11055d955bbbSStefano Zampini            since we need values with global final ordering */
11065d955bbbSStefano Zampini         if (swap) {
11075d955bbbSStefano Zampini           cidx = rows_idx[r];
11085d955bbbSStefano Zampini           ridx = cols_idx[c];
11099d0448ceSStefano Zampini         }
11109d0448ceSStefano Zampini 
11115d955bbbSStefano Zampini         /* Communicate column indices
11125d955bbbSStefano Zampini            This could have been done with a single SF but it would have complicated the code a lot.
11135d955bbbSStefano Zampini            But since we do it only once, we pay the price of setting up an SF for each block */
11145d955bbbSStefano Zampini         if (PetscDefined(USE_64BIT_INDICES)) {
11155d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) pjcns_w[k] = mumps->jcn[k];
11165d955bbbSStefano Zampini         } else pjcns_w = (PetscInt *)(mumps->jcn); /* This cast is needed only to silence warnings for 64bit integers builds */
11179d0448ceSStefano Zampini         PetscCall(PetscSFCreate(PetscObjectComm((PetscObject)A), &csf));
11185d955bbbSStefano Zampini         PetscCall(PetscSFSetGraphLayout(csf, cmap, mumps->nnz, NULL, PETSC_OWN_POINTER, pjcns_w));
11195d955bbbSStefano Zampini         PetscCall(PetscSFBcastBegin(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11205d955bbbSStefano Zampini         PetscCall(PetscSFBcastEnd(csf, MPIU_INT, cidx, pjcns_w, MPI_REPLACE));
11219d0448ceSStefano Zampini         PetscCall(PetscSFDestroy(&csf));
11229d0448ceSStefano Zampini 
11235d955bbbSStefano Zampini         /* Import indices: use direct map for rows and mapped indices for columns */
11245d955bbbSStefano Zampini         if (swap) {
11255d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11265d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &jcns[cumnnz + k]));
11275d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &irns[cumnnz + k]));
11285d955bbbSStefano Zampini           }
11295d955bbbSStefano Zampini         } else {
11305d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) {
11315d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(ridx[mumps->irn[k] - rst] + shift, &irns[cumnnz + k]));
11325d955bbbSStefano Zampini             PetscCall(PetscMUMPSIntCast(pjcns_w[k] + shift, &jcns[cumnnz + k]));
11335d955bbbSStefano Zampini           }
11345d955bbbSStefano Zampini         }
11355d955bbbSStefano Zampini 
11365d955bbbSStefano Zampini         /* Import values to full COO */
11375d955bbbSStefano Zampini         if (isHTrans) { /* conjugate the entries */
11385d955bbbSStefano Zampini           for (PetscInt k = 0; k < mumps->nnz; k++) mumps->val[k] = PetscConj(mumps->val[k]);
11395d955bbbSStefano Zampini         }
11405d955bbbSStefano Zampini         PetscCall(PetscArraycpy(vals + cumnnz, mumps->val, mumps->nnz));
11419d0448ceSStefano Zampini 
11429d0448ceSStefano Zampini         /* Shift new starting point and sanity check */
11439d0448ceSStefano Zampini         cumnnz += mumps->nnz;
11449d0448ceSStefano Zampini         PetscCheck(cumnnz <= totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Unexpected number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11459d0448ceSStefano Zampini 
11469d0448ceSStefano Zampini         /* Free scratch memory */
11479d0448ceSStefano Zampini         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
11489d0448ceSStefano Zampini         PetscCall(PetscFree(mumps->val_alloc));
11499d0448ceSStefano Zampini         mumps->val = NULL;
11509d0448ceSStefano Zampini         mumps->nnz = 0;
11519d0448ceSStefano Zampini       }
11529d0448ceSStefano Zampini     }
11539d0448ceSStefano Zampini     if (PetscDefined(USE_64BIT_INDICES)) PetscCall(PetscFree(pjcns_w));
11549d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISRestoreIndices(rows[r], (const PetscInt **)&rows_idx[r]));
11559d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) PetscCall(ISRestoreIndices(cols[c], (const PetscInt **)&cols_idx[c]));
11569d0448ceSStefano Zampini     PetscCall(PetscFree4(rows, cols, rows_idx, cols_idx));
11579d0448ceSStefano Zampini     if (!chol) PetscCheck(cumnnz == totnnz, PETSC_COMM_SELF, PETSC_ERR_PLIB, "Different number of nonzeros %" PetscInt64_FMT " != %" PetscInt64_FMT, cumnnz, totnnz);
11585d955bbbSStefano Zampini     mumps->nest_vals_start[nr * nc] = cumnnz;
11599d0448ceSStefano Zampini 
11609d0448ceSStefano Zampini     /* Set pointers for final MUMPS data structure */
11619d0448ceSStefano Zampini     mumps->nest_vals = vals;
11629d0448ceSStefano Zampini     mumps->val_alloc = NULL; /* do not use val_alloc since it may be reallocated with the OMP callpath */
11639d0448ceSStefano Zampini     mumps->val       = vals;
11649d0448ceSStefano Zampini     mumps->irn       = irns;
11659d0448ceSStefano Zampini     mumps->jcn       = jcns;
11669d0448ceSStefano Zampini     mumps->nnz       = cumnnz;
11679d0448ceSStefano Zampini   } else {
11689d0448ceSStefano Zampini     PetscScalar *oval = mumps->nest_vals;
11699d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) {
11709d0448ceSStefano Zampini       for (PetscInt c = 0; c < nc; c++) {
11715d955bbbSStefano Zampini         PetscBool isTrans, isHTrans = PETSC_FALSE;
11725d955bbbSStefano Zampini         Mat       sub  = mats[r][c];
11735d955bbbSStefano Zampini         PetscInt  midx = r * nc + c;
11745d955bbbSStefano Zampini 
11755d955bbbSStefano Zampini         if (!mumps->nest_convert_to_triples[midx]) continue;
11765d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
11775d955bbbSStefano Zampini         if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
11785d955bbbSStefano Zampini         else {
11795d955bbbSStefano Zampini           PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isHTrans));
11805d955bbbSStefano Zampini           if (isHTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
11815d955bbbSStefano Zampini         }
11825d955bbbSStefano Zampini         mumps->val = oval + mumps->nest_vals_start[midx];
11835d955bbbSStefano Zampini         PetscCall((*mumps->nest_convert_to_triples[midx])(sub, shift, MAT_REUSE_MATRIX, mumps));
11845d955bbbSStefano Zampini         if (isHTrans) {
11855d955bbbSStefano Zampini           PetscInt nnz = mumps->nest_vals_start[midx + 1] - mumps->nest_vals_start[midx];
11865d955bbbSStefano Zampini           for (PetscInt k = 0; k < nnz; k++) mumps->val[k] = PetscConj(mumps->val[k]);
11875d955bbbSStefano Zampini         }
11889d0448ceSStefano Zampini       }
11899d0448ceSStefano Zampini     }
11909d0448ceSStefano Zampini     mumps->val = oval;
11919d0448ceSStefano Zampini   }
11929d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
11939d0448ceSStefano Zampini }
11949d0448ceSStefano Zampini 
1195d71ae5a4SJacob Faibussowitsch PetscErrorCode MatDestroy_MUMPS(Mat A)
1196d71ae5a4SJacob Faibussowitsch {
1197a6053eceSJunchao Zhang   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
1198b24902e0SBarry Smith 
1199397b6df1SKris Buschelman   PetscFunctionBegin;
12009566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
12019566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_rhs));
12029566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&mumps->scat_sol));
12039566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->b_seq));
12049566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&mumps->x_seq));
12059566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.perm_in));
12069566063dSJacob Faibussowitsch   PetscCall(PetscFree2(mumps->irn, mumps->jcn));
12079566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->val_alloc));
12089566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->info));
1209413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->ICNTL_pre));
1210413bcc21SPierre Jolivet   PetscCall(PetscFree(mumps->CNTL_pre));
12119566063dSJacob Faibussowitsch   PetscCall(MatMumpsResetSchur_Private(mumps));
1212413bcc21SPierre Jolivet   if (mumps->id.job != JOB_NULL) { /* cannot call PetscMUMPS_c() if JOB_INIT has never been called for this instance */
1213a5e57a09SHong Zhang     mumps->id.job = JOB_END;
12143ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
12159261f6e4SBarry 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));
1216413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
1217413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) PetscCallMPI(MPI_Comm_free(&mumps->mumps_comm));
1218413bcc21SPierre Jolivet       else PetscCall(PetscCommRestoreComm(PetscObjectComm((PetscObject)A), &mumps->mumps_comm));
1219413bcc21SPierre Jolivet     }
1220413bcc21SPierre Jolivet   }
12213ab56b82SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
122267602552SJunchao Zhang   if (mumps->use_petsc_omp_support) {
12239566063dSJacob Faibussowitsch     PetscCall(PetscOmpCtrlDestroy(&mumps->omp_ctrl));
12249566063dSJacob Faibussowitsch     PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
12259566063dSJacob Faibussowitsch     PetscCall(PetscFree3(mumps->rhs_nrow, mumps->rhs_recvcounts, mumps->rhs_disps));
122667602552SJunchao Zhang   }
12273ab56b82SJunchao Zhang #endif
12289566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ia_alloc));
12299566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->ja_alloc));
12309566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->recvcount));
12319566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->reqs));
12329566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->irhs_loc));
12339d0448ceSStefano Zampini   PetscCall(PetscFree2(mumps->nest_vals_start, mumps->nest_convert_to_triples));
12349d0448ceSStefano Zampini   PetscCall(PetscFree(mumps->nest_vals));
12359566063dSJacob Faibussowitsch   PetscCall(PetscFree(A->data));
1236bf0cc555SLisandro Dalcin 
123797969023SHong Zhang   /* clear composed functions */
12389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorGetSolverType_C", NULL));
12399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorSetSchurIS_C", NULL));
12409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatFactorCreateSchurComplement_C", NULL));
12419566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetIcntl_C", NULL));
12429566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetIcntl_C", NULL));
12439566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsSetCntl_C", NULL));
12449566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetCntl_C", NULL));
12459566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfo_C", NULL));
12469566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInfog_C", NULL));
12479566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfo_C", NULL));
12489566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetRinfog_C", NULL));
12495c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetNullPivots_C", NULL));
12509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverse_C", NULL));
12519566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)A, "MatMumpsGetInverseTranspose_C", NULL));
12523ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1253397b6df1SKris Buschelman }
1254397b6df1SKris Buschelman 
125567602552SJunchao 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. */
1256d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatMumpsSetUpDistRHSInfo(Mat A, PetscInt nrhs, const PetscScalar *array)
1257d71ae5a4SJacob Faibussowitsch {
125867602552SJunchao Zhang   Mat_MUMPS        *mumps   = (Mat_MUMPS *)A->data;
125967602552SJunchao Zhang   const PetscMPIInt ompsize = mumps->omp_comm_size;
126067602552SJunchao Zhang   PetscInt          i, m, M, rstart;
126167602552SJunchao Zhang 
126267602552SJunchao Zhang   PetscFunctionBegin;
12639566063dSJacob Faibussowitsch   PetscCall(MatGetSize(A, &M, NULL));
12649566063dSJacob Faibussowitsch   PetscCall(MatGetLocalSize(A, &m, NULL));
126508401ef6SPierre Jolivet   PetscCheck(M <= PETSC_MUMPS_INT_MAX, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscInt too long for PetscMUMPSInt");
126667602552SJunchao Zhang   if (ompsize == 1) {
126767602552SJunchao Zhang     if (!mumps->irhs_loc) {
126867602552SJunchao Zhang       mumps->nloc_rhs = m;
12699566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(m, &mumps->irhs_loc));
12709566063dSJacob Faibussowitsch       PetscCall(MatGetOwnershipRange(A, &rstart, NULL));
127167602552SJunchao Zhang       for (i = 0; i < m; i++) mumps->irhs_loc[i] = rstart + i + 1; /* use 1-based indices */
127267602552SJunchao Zhang     }
127367602552SJunchao Zhang     mumps->id.rhs_loc = (MumpsScalar *)array;
127467602552SJunchao Zhang   } else {
127567602552SJunchao Zhang #if defined(PETSC_HAVE_OPENMP_SUPPORT)
127667602552SJunchao Zhang     const PetscInt *ranges;
127767602552SJunchao Zhang     PetscMPIInt     j, k, sendcount, *petsc_ranks, *omp_ranks;
127867602552SJunchao Zhang     MPI_Group       petsc_group, omp_group;
127967602552SJunchao Zhang     PetscScalar    *recvbuf = NULL;
128067602552SJunchao Zhang 
128167602552SJunchao Zhang     if (mumps->is_omp_master) {
128267602552SJunchao Zhang       /* Lazily initialize the omp stuff for distributed rhs */
128367602552SJunchao Zhang       if (!mumps->irhs_loc) {
12849566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(ompsize, &omp_ranks, ompsize, &petsc_ranks));
12859566063dSJacob Faibussowitsch         PetscCall(PetscMalloc3(ompsize, &mumps->rhs_nrow, ompsize, &mumps->rhs_recvcounts, ompsize, &mumps->rhs_disps));
12869566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->petsc_comm, &petsc_group));
12879566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Comm_group(mumps->omp_comm, &omp_group));
128867602552SJunchao Zhang         for (j = 0; j < ompsize; j++) omp_ranks[j] = j;
12899566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_translate_ranks(omp_group, ompsize, omp_ranks, petsc_group, petsc_ranks));
129067602552SJunchao Zhang 
129167602552SJunchao Zhang         /* Populate mumps->irhs_loc[], rhs_nrow[] */
129267602552SJunchao Zhang         mumps->nloc_rhs = 0;
12939566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(A, &ranges));
129467602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
129567602552SJunchao Zhang           mumps->rhs_nrow[j] = ranges[petsc_ranks[j] + 1] - ranges[petsc_ranks[j]];
129667602552SJunchao Zhang           mumps->nloc_rhs += mumps->rhs_nrow[j];
129767602552SJunchao Zhang         }
12989566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(mumps->nloc_rhs, &mumps->irhs_loc));
129967602552SJunchao Zhang         for (j = k = 0; j < ompsize; j++) {
130067602552SJunchao 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 */
130167602552SJunchao Zhang         }
130267602552SJunchao Zhang 
13039566063dSJacob Faibussowitsch         PetscCall(PetscFree2(omp_ranks, petsc_ranks));
13049566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&petsc_group));
13059566063dSJacob Faibussowitsch         PetscCallMPI(MPI_Group_free(&omp_group));
130667602552SJunchao Zhang       }
130767602552SJunchao Zhang 
130867602552SJunchao Zhang       /* Realloc buffers when current nrhs is bigger than what we have met */
130967602552SJunchao Zhang       if (nrhs > mumps->max_nrhs) {
13109566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->rhs_loc, mumps->rhs_recvbuf));
13119566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(mumps->nloc_rhs * nrhs, &mumps->rhs_loc, mumps->nloc_rhs * nrhs, &mumps->rhs_recvbuf));
131267602552SJunchao Zhang         mumps->max_nrhs = nrhs;
131367602552SJunchao Zhang       }
131467602552SJunchao Zhang 
131567602552SJunchao Zhang       /* Setup recvcounts[], disps[], recvbuf on omp rank 0 for the upcoming MPI_Gatherv */
13169566063dSJacob Faibussowitsch       for (j = 0; j < ompsize; j++) PetscCall(PetscMPIIntCast(mumps->rhs_nrow[j] * nrhs, &mumps->rhs_recvcounts[j]));
131767602552SJunchao Zhang       mumps->rhs_disps[0] = 0;
131867602552SJunchao Zhang       for (j = 1; j < ompsize; j++) {
131967602552SJunchao Zhang         mumps->rhs_disps[j] = mumps->rhs_disps[j - 1] + mumps->rhs_recvcounts[j - 1];
132008401ef6SPierre Jolivet         PetscCheck(mumps->rhs_disps[j] >= 0, PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "PetscMPIInt overflow!");
132167602552SJunchao Zhang       }
132267602552SJunchao Zhang       recvbuf = (nrhs == 1) ? mumps->rhs_loc : mumps->rhs_recvbuf; /* Directly use rhs_loc[] as recvbuf. Single rhs is common in Ax=b */
132367602552SJunchao Zhang     }
132467602552SJunchao Zhang 
13259566063dSJacob Faibussowitsch     PetscCall(PetscMPIIntCast(m * nrhs, &sendcount));
13269566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Gatherv(array, sendcount, MPIU_SCALAR, recvbuf, mumps->rhs_recvcounts, mumps->rhs_disps, MPIU_SCALAR, 0, mumps->omp_comm));
132767602552SJunchao Zhang 
132867602552SJunchao Zhang     if (mumps->is_omp_master) {
132967602552SJunchao Zhang       if (nrhs > 1) { /* Copy & re-arrange data from rhs_recvbuf[] to mumps->rhs_loc[] only when there are multiple rhs */
133067602552SJunchao Zhang         PetscScalar *dst, *dstbase = mumps->rhs_loc;
133167602552SJunchao Zhang         for (j = 0; j < ompsize; j++) {
133267602552SJunchao Zhang           const PetscScalar *src = mumps->rhs_recvbuf + mumps->rhs_disps[j];
133367602552SJunchao Zhang           dst                    = dstbase;
133467602552SJunchao Zhang           for (i = 0; i < nrhs; i++) {
13359566063dSJacob Faibussowitsch             PetscCall(PetscArraycpy(dst, src, mumps->rhs_nrow[j]));
133667602552SJunchao Zhang             src += mumps->rhs_nrow[j];
133767602552SJunchao Zhang             dst += mumps->nloc_rhs;
133867602552SJunchao Zhang           }
133967602552SJunchao Zhang           dstbase += mumps->rhs_nrow[j];
134067602552SJunchao Zhang         }
134167602552SJunchao Zhang       }
134267602552SJunchao Zhang       mumps->id.rhs_loc = (MumpsScalar *)mumps->rhs_loc;
134367602552SJunchao Zhang     }
134467602552SJunchao Zhang #endif /* PETSC_HAVE_OPENMP_SUPPORT */
134567602552SJunchao Zhang   }
134667602552SJunchao Zhang   mumps->id.nrhs     = nrhs;
134767602552SJunchao Zhang   mumps->id.nloc_rhs = mumps->nloc_rhs;
134867602552SJunchao Zhang   mumps->id.lrhs_loc = mumps->nloc_rhs;
134967602552SJunchao Zhang   mumps->id.irhs_loc = mumps->irhs_loc;
13503ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
135167602552SJunchao Zhang }
135267602552SJunchao Zhang 
1353d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSolve_MUMPS(Mat A, Vec b, Vec x)
1354d71ae5a4SJacob Faibussowitsch {
1355e69c285eSBarry Smith   Mat_MUMPS         *mumps  = (Mat_MUMPS *)A->data;
135625aac85cSJunchao Zhang   const PetscScalar *rarray = NULL;
1357d54de34fSKris Buschelman   PetscScalar       *array;
1358329ec9b3SHong Zhang   IS                 is_iden, is_petsc;
1359329ec9b3SHong Zhang   PetscInt           i;
1360cc86f929SStefano Zampini   PetscBool          second_solve = PETSC_FALSE;
1361883f2eb9SBarry Smith   static PetscBool   cite1 = PETSC_FALSE, cite2 = PETSC_FALSE;
1362397b6df1SKris Buschelman 
1363397b6df1SKris Buschelman   PetscFunctionBegin;
13649371c9d4SSatish 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 "
13659371c9d4SSatish Balay                                    "Journal on Matrix Analysis and Applications},\n  volume = {23},\n  number = {1},\n  pages = {15--41},\n  year = {2001}\n}\n",
13669371c9d4SSatish Balay                                    &cite1));
13679371c9d4SSatish 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 "
13689371c9d4SSatish Balay                                    "Computing},\n  volume = {32},\n  number = {2},\n  pages = {136--156},\n  year = {2006}\n}\n",
13699371c9d4SSatish Balay                                    &cite2));
13702aca8efcSHong Zhang 
1371603e8f96SBarry Smith   if (A->factorerrortype) {
13729566063dSJacob 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)));
13739566063dSJacob Faibussowitsch     PetscCall(VecSetInf(x));
13743ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
13752aca8efcSHong Zhang   }
13762aca8efcSHong Zhang 
1377a5e57a09SHong Zhang   mumps->id.nrhs = 1;
13782d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
137925aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
138067602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
13819566063dSJacob Faibussowitsch       PetscCall(VecGetArrayRead(b, &rarray));
13829566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, 1, rarray));
138325aac85cSJunchao Zhang     } else {
138441ffd417SStefano Zampini       mumps->id.ICNTL(20) = 0; /* dense centralized RHS; Scatter b into a sequential rhs vector*/
13859566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
13869566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(mumps->scat_rhs, b, mumps->b_seq, INSERT_VALUES, SCATTER_FORWARD));
138767602552SJunchao Zhang       if (!mumps->myid) {
13889566063dSJacob Faibussowitsch         PetscCall(VecGetArray(mumps->b_seq, &array));
138967602552SJunchao Zhang         mumps->id.rhs = (MumpsScalar *)array;
139067602552SJunchao Zhang       }
139125aac85cSJunchao Zhang     }
13923ab56b82SJunchao Zhang   } else {                   /* petsc_size == 1 */
139367602552SJunchao Zhang     mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
13949566063dSJacob Faibussowitsch     PetscCall(VecCopy(b, x));
13959566063dSJacob Faibussowitsch     PetscCall(VecGetArray(x, &array));
1396940cd9d6SSatish Balay     mumps->id.rhs = (MumpsScalar *)array;
1397397b6df1SKris Buschelman   }
1398397b6df1SKris Buschelman 
1399cc86f929SStefano Zampini   /*
1400cc86f929SStefano Zampini      handle condensation step of Schur complement (if any)
1401cc86f929SStefano Zampini      We set by default ICNTL(26) == -1 when Schur indices have been provided by the user.
1402cc86f929SStefano Zampini      According to MUMPS (5.0.0) manual, any value should be harmful during the factorization phase
1403cc86f929SStefano Zampini      Unless the user provides a valid value for ICNTL(26), MatSolve and MatMatSolve routines solve the full system.
1404cc86f929SStefano Zampini      This requires an extra call to PetscMUMPS_c and the computation of the factors for S
1405cc86f929SStefano Zampini   */
1406583f777eSStefano Zampini   if (mumps->id.size_schur > 0 && (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2)) {
140708401ef6SPierre Jolivet     PetscCheck(mumps->petsc_size <= 1, PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1408cc86f929SStefano Zampini     second_solve = PETSC_TRUE;
14099566063dSJacob Faibussowitsch     PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1410cc86f929SStefano Zampini   }
1411397b6df1SKris Buschelman   /* solve phase */
1412a5e57a09SHong Zhang   mumps->id.job = JOB_SOLVE;
14133ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
14149261f6e4SBarry 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));
1415397b6df1SKris Buschelman 
1416b5fa320bSStefano Zampini   /* handle expansion step of Schur complement (if any) */
14171baa6e33SBarry Smith   if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
1418b5fa320bSStefano Zampini 
14192d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) { /* convert mumps distributed solution to petsc mpi x */
1420a5e57a09SHong Zhang     if (mumps->scat_sol && mumps->ICNTL9_pre != mumps->id.ICNTL(9)) {
1421a5e57a09SHong Zhang       /* when id.ICNTL(9) changes, the contents of lsol_loc may change (not its size, lsol_loc), recreates scat_sol */
14229566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
1423397b6df1SKris Buschelman     }
1424a5e57a09SHong Zhang     if (!mumps->scat_sol) { /* create scatter scat_sol */
1425a6053eceSJunchao Zhang       PetscInt *isol2_loc = NULL;
14269566063dSJacob Faibussowitsch       PetscCall(ISCreateStride(PETSC_COMM_SELF, mumps->id.lsol_loc, 0, 1, &is_iden)); /* from */
14279566063dSJacob Faibussowitsch       PetscCall(PetscMalloc1(mumps->id.lsol_loc, &isol2_loc));
1428a6053eceSJunchao 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 */
14299566063dSJacob Faibussowitsch       PetscCall(ISCreateGeneral(PETSC_COMM_SELF, mumps->id.lsol_loc, isol2_loc, PETSC_OWN_POINTER, &is_petsc)); /* to */
14309566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(mumps->x_seq, is_iden, x, is_petsc, &mumps->scat_sol));
14319566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_iden));
14329566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_petsc));
1433a5e57a09SHong Zhang       mumps->ICNTL9_pre = mumps->id.ICNTL(9); /* save current value of id.ICNTL(9) */
1434397b6df1SKris Buschelman     }
1435a5e57a09SHong Zhang 
14369566063dSJacob Faibussowitsch     PetscCall(VecScatterBegin(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
14379566063dSJacob Faibussowitsch     PetscCall(VecScatterEnd(mumps->scat_sol, mumps->x_seq, x, INSERT_VALUES, SCATTER_FORWARD));
1438329ec9b3SHong Zhang   }
1439353d7d71SJunchao Zhang 
144067602552SJunchao Zhang   if (mumps->petsc_size > 1) {
144125aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
14429566063dSJacob Faibussowitsch       PetscCall(VecRestoreArrayRead(b, &rarray));
144325aac85cSJunchao Zhang     } else if (!mumps->myid) {
14449566063dSJacob Faibussowitsch       PetscCall(VecRestoreArray(mumps->b_seq, &array));
144525aac85cSJunchao Zhang     }
14469566063dSJacob Faibussowitsch   } else PetscCall(VecRestoreArray(x, &array));
1447353d7d71SJunchao Zhang 
144864412097SPierre Jolivet   PetscCall(PetscLogFlops(2.0 * PetscMax(0, (mumps->id.INFO(28) >= 0 ? mumps->id.INFO(28) : -1000000 * mumps->id.INFO(28)) - A->cmap->n)));
14493ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1450397b6df1SKris Buschelman }
1451397b6df1SKris Buschelman 
1452d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSolveTranspose_MUMPS(Mat A, Vec b, Vec x)
1453d71ae5a4SJacob Faibussowitsch {
1454e69c285eSBarry Smith   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1455338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
145651d5961aSHong Zhang 
145751d5961aSHong Zhang   PetscFunctionBegin;
1458a5e57a09SHong Zhang   mumps->id.ICNTL(9) = 0;
14599566063dSJacob Faibussowitsch   PetscCall(MatSolve_MUMPS(A, b, x));
1460338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
14613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
146251d5961aSHong Zhang }
146351d5961aSHong Zhang 
1464d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatSolve_MUMPS(Mat A, Mat B, Mat X)
1465d71ae5a4SJacob Faibussowitsch {
1466b8491c3eSStefano Zampini   Mat                Bt = NULL;
1467a6053eceSJunchao Zhang   PetscBool          denseX, denseB, flg, flgT;
1468e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)A->data;
1469334c5f61SHong Zhang   PetscInt           i, nrhs, M;
14701683a169SBarry Smith   PetscScalar       *array;
14711683a169SBarry Smith   const PetscScalar *rbray;
1472a6053eceSJunchao Zhang   PetscInt           lsol_loc, nlsol_loc, *idxx, iidx = 0;
1473a6053eceSJunchao Zhang   PetscMUMPSInt     *isol_loc, *isol_loc_save;
14741683a169SBarry Smith   PetscScalar       *bray, *sol_loc, *sol_loc_save;
1475be818407SHong Zhang   IS                 is_to, is_from;
1476beae5ec0SHong Zhang   PetscInt           k, proc, j, m, myrstart;
1477be818407SHong Zhang   const PetscInt    *rstart;
147867602552SJunchao Zhang   Vec                v_mpi, msol_loc;
147967602552SJunchao Zhang   VecScatter         scat_sol;
148067602552SJunchao Zhang   Vec                b_seq;
148167602552SJunchao Zhang   VecScatter         scat_rhs;
1482be818407SHong Zhang   PetscScalar       *aa;
1483be818407SHong Zhang   PetscInt           spnr, *ia, *ja;
1484d56c302dSHong Zhang   Mat_MPIAIJ        *b = NULL;
1485bda8bf91SBarry Smith 
1486e0b74bf9SHong Zhang   PetscFunctionBegin;
14879566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)X, &denseX, MATSEQDENSE, MATMPIDENSE, NULL));
148828b400f6SJacob Faibussowitsch   PetscCheck(denseX, PetscObjectComm((PetscObject)X), PETSC_ERR_ARG_WRONG, "Matrix X must be MATDENSE matrix");
1489be818407SHong Zhang 
14909566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)B, &denseB, MATSEQDENSE, MATMPIDENSE, NULL));
1491a6053eceSJunchao Zhang   if (denseB) {
149208401ef6SPierre Jolivet     PetscCheck(B->rmap->n == X->rmap->n, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Matrix B and X must have same row distribution");
1493be818407SHong Zhang     mumps->id.ICNTL(20) = 0; /* dense RHS */
14940e6b8875SHong Zhang   } else {                   /* sparse B */
149508401ef6SPierre Jolivet     PetscCheck(X != B, PetscObjectComm((PetscObject)A), PETSC_ERR_ARG_IDN, "X and B must be different matrices");
1496013e2dc7SBarry Smith     PetscCall(PetscObjectTypeCompare((PetscObject)B, MATTRANSPOSEVIRTUAL, &flgT));
1497da81f932SPierre Jolivet     if (flgT) { /* input B is transpose of actual RHS matrix,
14980e6b8875SHong Zhang                  because mumps requires sparse compressed COLUMN storage! See MatMatTransposeSolve_MUMPS() */
14999566063dSJacob Faibussowitsch       PetscCall(MatTransposeGetMat(B, &Bt));
1500013e2dc7SBarry Smith     } else SETERRQ(PetscObjectComm((PetscObject)B), PETSC_ERR_ARG_WRONG, "Matrix B must be MATTRANSPOSEVIRTUAL matrix");
1501be818407SHong Zhang     mumps->id.ICNTL(20) = 1; /* sparse RHS */
1502b8491c3eSStefano Zampini   }
150387b22cf4SHong Zhang 
15049566063dSJacob Faibussowitsch   PetscCall(MatGetSize(B, &M, &nrhs));
15059481e6e9SHong Zhang   mumps->id.nrhs = nrhs;
15069481e6e9SHong Zhang   mumps->id.lrhs = M;
15072b691707SHong Zhang   mumps->id.rhs  = NULL;
15089481e6e9SHong Zhang 
15092d4298aeSJunchao Zhang   if (mumps->petsc_size == 1) {
1510b8491c3eSStefano Zampini     PetscScalar *aa;
1511b8491c3eSStefano Zampini     PetscInt     spnr, *ia, *ja;
1512e94cce23SStefano Zampini     PetscBool    second_solve = PETSC_FALSE;
1513b8491c3eSStefano Zampini 
15149566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &array));
1515b8491c3eSStefano Zampini     mumps->id.rhs = (MumpsScalar *)array;
15162b691707SHong Zhang 
1517a6053eceSJunchao Zhang     if (denseB) {
15182b691707SHong Zhang       /* copy B to X */
15199566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
15209566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, rbray, M * nrhs));
15219566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
15222b691707SHong Zhang     } else { /* sparse B */
15239566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(Bt, &aa));
15249566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
152528b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
15269566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
1527b8491c3eSStefano Zampini       mumps->id.rhs_sparse = (MumpsScalar *)aa;
1528b8491c3eSStefano Zampini     }
1529e94cce23SStefano Zampini     /* handle condensation step of Schur complement (if any) */
1530583f777eSStefano Zampini     if (mumps->id.size_schur > 0 && (mumps->id.ICNTL(26) < 0 || mumps->id.ICNTL(26) > 2)) {
1531e94cce23SStefano Zampini       second_solve = PETSC_TRUE;
15329566063dSJacob Faibussowitsch       PetscCall(MatMumpsHandleSchur_Private(A, PETSC_FALSE));
1533e94cce23SStefano Zampini     }
15342cd7d884SHong Zhang     /* solve phase */
15352cd7d884SHong Zhang     mumps->id.job = JOB_SOLVE;
15363ab56b82SJunchao Zhang     PetscMUMPS_c(mumps);
15379261f6e4SBarry 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));
1538b5fa320bSStefano Zampini 
1539b5fa320bSStefano Zampini     /* handle expansion step of Schur complement (if any) */
15401baa6e33SBarry Smith     if (second_solve) PetscCall(MatMumpsHandleSchur_Private(A, PETSC_TRUE));
1541a6053eceSJunchao Zhang     if (!denseB) { /* sparse B */
15429566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(Bt, &aa));
15439566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(Bt, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
154428b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
1545b8491c3eSStefano Zampini     }
15469566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &array));
15473ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
1548be818407SHong Zhang   }
1549801fbe65SHong Zhang 
15502ef1f0ffSBarry Smith   /* parallel case: MUMPS requires rhs B to be centralized on the host! */
1551aed4548fSBarry Smith   PetscCheck(mumps->petsc_size <= 1 || !mumps->id.ICNTL(19), PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "Parallel Schur complements not yet supported from PETSc");
1552241dbb5eSStefano Zampini 
1553beae5ec0SHong Zhang   /* create msol_loc to hold mumps local solution */
15541683a169SBarry Smith   isol_loc_save = mumps->id.isol_loc; /* save it for MatSolve() */
15551683a169SBarry Smith   sol_loc_save  = (PetscScalar *)mumps->id.sol_loc;
1556801fbe65SHong Zhang 
1557a1dfcbd9SJunchao Zhang   lsol_loc  = mumps->id.lsol_loc;
155871aed81dSHong Zhang   nlsol_loc = nrhs * lsol_loc; /* length of sol_loc */
15599566063dSJacob Faibussowitsch   PetscCall(PetscMalloc2(nlsol_loc, &sol_loc, lsol_loc, &isol_loc));
1560940cd9d6SSatish Balay   mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
1561801fbe65SHong Zhang   mumps->id.isol_loc = isol_loc;
1562801fbe65SHong Zhang 
15639566063dSJacob Faibussowitsch   PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, nlsol_loc, (PetscScalar *)sol_loc, &msol_loc));
15642cd7d884SHong Zhang 
156567602552SJunchao Zhang   if (denseB) {
156625aac85cSJunchao Zhang     if (mumps->ICNTL20 == 10) {
156767602552SJunchao Zhang       mumps->id.ICNTL(20) = 10; /* dense distributed RHS */
15689566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArrayRead(B, &rbray));
15699566063dSJacob Faibussowitsch       PetscCall(MatMumpsSetUpDistRHSInfo(A, nrhs, rbray));
15709566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArrayRead(B, &rbray));
15719566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
15729566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, NULL, &v_mpi));
157325aac85cSJunchao Zhang     } else {
157425aac85cSJunchao Zhang       mumps->id.ICNTL(20) = 0; /* dense centralized RHS */
157580577c12SJunchao Zhang       /* TODO: Because of non-contiguous indices, the created vecscatter scat_rhs is not done in MPI_Gather, resulting in
157680577c12SJunchao Zhang         very inefficient communication. An optimization is to use VecScatterCreateToZero to gather B to rank 0. Then on rank
157780577c12SJunchao Zhang         0, re-arrange B into desired order, which is a local operation.
157880577c12SJunchao Zhang       */
157980577c12SJunchao Zhang 
158067602552SJunchao Zhang       /* scatter v_mpi to b_seq because MUMPS before 5.3.0 only supports centralized rhs */
1581be818407SHong Zhang       /* wrap dense rhs matrix B into a vector v_mpi */
15829566063dSJacob Faibussowitsch       PetscCall(MatGetLocalSize(B, &m, NULL));
15839566063dSJacob Faibussowitsch       PetscCall(MatDenseGetArray(B, &bray));
15849566063dSJacob Faibussowitsch       PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)B), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
15859566063dSJacob Faibussowitsch       PetscCall(MatDenseRestoreArray(B, &bray));
15862b691707SHong Zhang 
1587be818407SHong Zhang       /* scatter v_mpi to b_seq in proc[0]. MUMPS requires rhs to be centralized on the host! */
1588801fbe65SHong Zhang       if (!mumps->myid) {
1589beae5ec0SHong Zhang         PetscInt *idx;
1590beae5ec0SHong Zhang         /* idx: maps from k-th index of v_mpi to (i,j)-th global entry of B */
15919566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(nrhs * M, &idx));
15929566063dSJacob Faibussowitsch         PetscCall(MatGetOwnershipRanges(B, &rstart));
1593be818407SHong Zhang         k = 0;
15942d4298aeSJunchao Zhang         for (proc = 0; proc < mumps->petsc_size; proc++) {
1595be818407SHong Zhang           for (j = 0; j < nrhs; j++) {
1596beae5ec0SHong Zhang             for (i = rstart[proc]; i < rstart[proc + 1]; i++) idx[k++] = j * M + i;
1597be818407SHong Zhang           }
1598be818407SHong Zhang         }
1599be818407SHong Zhang 
16009566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, nrhs * M, &b_seq));
16019566063dSJacob Faibussowitsch         PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nrhs * M, idx, PETSC_OWN_POINTER, &is_to));
16029566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, nrhs * M, 0, 1, &is_from));
1603801fbe65SHong Zhang       } else {
16049566063dSJacob Faibussowitsch         PetscCall(VecCreateSeq(PETSC_COMM_SELF, 0, &b_seq));
16059566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_to));
16069566063dSJacob Faibussowitsch         PetscCall(ISCreateStride(PETSC_COMM_SELF, 0, 0, 1, &is_from));
1607801fbe65SHong Zhang       }
16089566063dSJacob Faibussowitsch       PetscCall(VecScatterCreate(v_mpi, is_from, b_seq, is_to, &scat_rhs));
16099566063dSJacob Faibussowitsch       PetscCall(VecScatterBegin(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
16109566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_to));
16119566063dSJacob Faibussowitsch       PetscCall(ISDestroy(&is_from));
16129566063dSJacob Faibussowitsch       PetscCall(VecScatterEnd(scat_rhs, v_mpi, b_seq, INSERT_VALUES, SCATTER_FORWARD));
1613801fbe65SHong Zhang 
1614801fbe65SHong Zhang       if (!mumps->myid) { /* define rhs on the host */
16159566063dSJacob Faibussowitsch         PetscCall(VecGetArray(b_seq, &bray));
1616940cd9d6SSatish Balay         mumps->id.rhs = (MumpsScalar *)bray;
16179566063dSJacob Faibussowitsch         PetscCall(VecRestoreArray(b_seq, &bray));
1618801fbe65SHong Zhang       }
161925aac85cSJunchao Zhang     }
16202b691707SHong Zhang   } else { /* sparse B */
16212b691707SHong Zhang     b = (Mat_MPIAIJ *)Bt->data;
16222b691707SHong Zhang 
1623be818407SHong Zhang     /* wrap dense X into a vector v_mpi */
16249566063dSJacob Faibussowitsch     PetscCall(MatGetLocalSize(X, &m, NULL));
16259566063dSJacob Faibussowitsch     PetscCall(MatDenseGetArray(X, &bray));
16269566063dSJacob Faibussowitsch     PetscCall(VecCreateMPIWithArray(PetscObjectComm((PetscObject)X), 1, nrhs * m, nrhs * M, (const PetscScalar *)bray, &v_mpi));
16279566063dSJacob Faibussowitsch     PetscCall(MatDenseRestoreArray(X, &bray));
16282b691707SHong Zhang 
16292b691707SHong Zhang     if (!mumps->myid) {
16309566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJGetArray(b->A, &aa));
16319566063dSJacob Faibussowitsch       PetscCall(MatGetRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
163228b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
16339566063dSJacob Faibussowitsch       PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
16342b691707SHong Zhang       mumps->id.rhs_sparse = (MumpsScalar *)aa;
16352b691707SHong Zhang     } else {
16362b691707SHong Zhang       mumps->id.irhs_ptr    = NULL;
16372b691707SHong Zhang       mumps->id.irhs_sparse = NULL;
16382b691707SHong Zhang       mumps->id.nz_rhs      = 0;
16392b691707SHong Zhang       mumps->id.rhs_sparse  = NULL;
16402b691707SHong Zhang     }
16412b691707SHong Zhang   }
16422b691707SHong Zhang 
1643801fbe65SHong Zhang   /* solve phase */
1644801fbe65SHong Zhang   mumps->id.job = JOB_SOLVE;
16453ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
16469261f6e4SBarry 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));
1647801fbe65SHong Zhang 
1648334c5f61SHong Zhang   /* scatter mumps distributed solution to petsc vector v_mpi, which shares local arrays with solution matrix X */
16499566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(X, &array));
16509566063dSJacob Faibussowitsch   PetscCall(VecPlaceArray(v_mpi, array));
1651801fbe65SHong Zhang 
1652334c5f61SHong Zhang   /* create scatter scat_sol */
16539566063dSJacob Faibussowitsch   PetscCall(MatGetOwnershipRanges(X, &rstart));
1654beae5ec0SHong Zhang   /* iidx: index for scatter mumps solution to petsc X */
1655beae5ec0SHong Zhang 
16569566063dSJacob Faibussowitsch   PetscCall(ISCreateStride(PETSC_COMM_SELF, nlsol_loc, 0, 1, &is_from));
16579566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(nlsol_loc, &idxx));
1658beae5ec0SHong Zhang   for (i = 0; i < lsol_loc; i++) {
1659beae5ec0SHong 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 */
1660beae5ec0SHong Zhang 
16612d4298aeSJunchao Zhang     for (proc = 0; proc < mumps->petsc_size; proc++) {
1662beae5ec0SHong Zhang       if (isol_loc[i] >= rstart[proc] && isol_loc[i] < rstart[proc + 1]) {
1663beae5ec0SHong Zhang         myrstart = rstart[proc];
1664beae5ec0SHong Zhang         k        = isol_loc[i] - myrstart;          /* local index on 1st column of petsc vector X */
1665beae5ec0SHong Zhang         iidx     = k + myrstart * nrhs;             /* maps mumps isol_loc[i] to petsc index in X */
1666beae5ec0SHong Zhang         m        = rstart[proc + 1] - rstart[proc]; /* rows of X for this proc */
1667beae5ec0SHong Zhang         break;
1668be818407SHong Zhang       }
1669be818407SHong Zhang     }
1670be818407SHong Zhang 
1671beae5ec0SHong Zhang     for (j = 0; j < nrhs; j++) idxx[i + j * lsol_loc] = iidx + j * m;
1672801fbe65SHong Zhang   }
16739566063dSJacob Faibussowitsch   PetscCall(ISCreateGeneral(PETSC_COMM_SELF, nlsol_loc, idxx, PETSC_COPY_VALUES, &is_to));
16749566063dSJacob Faibussowitsch   PetscCall(VecScatterCreate(msol_loc, is_from, v_mpi, is_to, &scat_sol));
16759566063dSJacob Faibussowitsch   PetscCall(VecScatterBegin(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
16769566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_from));
16779566063dSJacob Faibussowitsch   PetscCall(ISDestroy(&is_to));
16789566063dSJacob Faibussowitsch   PetscCall(VecScatterEnd(scat_sol, msol_loc, v_mpi, INSERT_VALUES, SCATTER_FORWARD));
16799566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(X, &array));
168071aed81dSHong Zhang 
168171aed81dSHong Zhang   /* free spaces */
16821683a169SBarry Smith   mumps->id.sol_loc  = (MumpsScalar *)sol_loc_save;
168371aed81dSHong Zhang   mumps->id.isol_loc = isol_loc_save;
168471aed81dSHong Zhang 
16859566063dSJacob Faibussowitsch   PetscCall(PetscFree2(sol_loc, isol_loc));
16869566063dSJacob Faibussowitsch   PetscCall(PetscFree(idxx));
16879566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&msol_loc));
16889566063dSJacob Faibussowitsch   PetscCall(VecDestroy(&v_mpi));
1689a6053eceSJunchao Zhang   if (!denseB) {
16902b691707SHong Zhang     if (!mumps->myid) {
1691d56c302dSHong Zhang       b = (Mat_MPIAIJ *)Bt->data;
16929566063dSJacob Faibussowitsch       PetscCall(MatSeqAIJRestoreArray(b->A, &aa));
16939566063dSJacob Faibussowitsch       PetscCall(MatRestoreRowIJ(b->A, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
169428b400f6SJacob Faibussowitsch       PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot restore IJ structure");
16952b691707SHong Zhang     }
16962b691707SHong Zhang   } else {
169725aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) {
16989566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b_seq));
16999566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&scat_rhs));
170025aac85cSJunchao Zhang     }
17012b691707SHong Zhang   }
17029566063dSJacob Faibussowitsch   PetscCall(VecScatterDestroy(&scat_sol));
170364412097SPierre 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))));
17043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1705e0b74bf9SHong Zhang }
1706e0b74bf9SHong Zhang 
1707d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatSolveTranspose_MUMPS(Mat A, Mat B, Mat X)
1708d71ae5a4SJacob Faibussowitsch {
1709b18964edSHong Zhang   Mat_MUMPS          *mumps = (Mat_MUMPS *)A->data;
1710338d3105SPierre Jolivet   const PetscMUMPSInt value = mumps->id.ICNTL(9);
1711b18964edSHong Zhang 
1712b18964edSHong Zhang   PetscFunctionBegin;
1713b18964edSHong Zhang   mumps->id.ICNTL(9) = 0;
1714b18964edSHong Zhang   PetscCall(MatMatSolve_MUMPS(A, B, X));
1715338d3105SPierre Jolivet   mumps->id.ICNTL(9) = value;
17163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1717b18964edSHong Zhang }
1718b18964edSHong Zhang 
1719d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMatTransposeSolve_MUMPS(Mat A, Mat Bt, Mat X)
1720d71ae5a4SJacob Faibussowitsch {
1721eb3ef3b2SHong Zhang   PetscBool flg;
1722eb3ef3b2SHong Zhang   Mat       B;
1723eb3ef3b2SHong Zhang 
1724eb3ef3b2SHong Zhang   PetscFunctionBegin;
17259566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)Bt, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
172628b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)Bt), PETSC_ERR_ARG_WRONG, "Matrix Bt must be MATAIJ matrix");
1727eb3ef3b2SHong Zhang 
1728eb3ef3b2SHong Zhang   /* Create B=Bt^T that uses Bt's data structure */
17299566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(Bt, &B));
1730eb3ef3b2SHong Zhang 
17319566063dSJacob Faibussowitsch   PetscCall(MatMatSolve_MUMPS(A, B, X));
17329566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&B));
17333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1734eb3ef3b2SHong Zhang }
1735eb3ef3b2SHong Zhang 
1736ace3df97SHong Zhang #if !defined(PETSC_USE_COMPLEX)
1737a58c3f20SHong Zhang /*
1738a58c3f20SHong Zhang   input:
1739a58c3f20SHong Zhang    F:        numeric factor
1740a58c3f20SHong Zhang   output:
1741a58c3f20SHong Zhang    nneg:     total number of negative pivots
174219d49a3bSHong Zhang    nzero:    total number of zero pivots
174319d49a3bSHong Zhang    npos:     (global dimension of F) - nneg - nzero
1744a58c3f20SHong Zhang */
1745d71ae5a4SJacob Faibussowitsch PetscErrorCode MatGetInertia_SBAIJMUMPS(Mat F, PetscInt *nneg, PetscInt *nzero, PetscInt *npos)
1746d71ae5a4SJacob Faibussowitsch {
1747e69c285eSBarry Smith   Mat_MUMPS  *mumps = (Mat_MUMPS *)F->data;
1748c1490034SHong Zhang   PetscMPIInt size;
1749a58c3f20SHong Zhang 
1750a58c3f20SHong Zhang   PetscFunctionBegin;
17519566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)F), &size));
1752bcb30aebSHong 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 */
1753aed4548fSBarry 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));
1754ed85ac9fSHong Zhang 
1755710ac8efSHong Zhang   if (nneg) *nneg = mumps->id.INFOG(12);
1756ed85ac9fSHong Zhang   if (nzero || npos) {
175708401ef6SPierre 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");
1758710ac8efSHong Zhang     if (nzero) *nzero = mumps->id.INFOG(28);
1759710ac8efSHong Zhang     if (npos) *npos = F->rmap->N - (mumps->id.INFOG(12) + mumps->id.INFOG(28));
1760a58c3f20SHong Zhang   }
17613ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1762a58c3f20SHong Zhang }
176319d49a3bSHong Zhang #endif
1764a58c3f20SHong Zhang 
1765d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGatherNonzerosOnMaster(MatReuse reuse, Mat_MUMPS *mumps)
1766d71ae5a4SJacob Faibussowitsch {
1767a6053eceSJunchao Zhang   PetscInt       i, nreqs;
1768a6053eceSJunchao Zhang   PetscMUMPSInt *irn, *jcn;
1769a6053eceSJunchao Zhang   PetscMPIInt    count;
1770a6053eceSJunchao Zhang   PetscInt64     totnnz, remain;
1771a6053eceSJunchao Zhang   const PetscInt osize = mumps->omp_comm_size;
1772a6053eceSJunchao Zhang   PetscScalar   *val;
17733ab56b82SJunchao Zhang 
17743ab56b82SJunchao Zhang   PetscFunctionBegin;
1775a6053eceSJunchao Zhang   if (osize > 1) {
17763ab56b82SJunchao Zhang     if (reuse == MAT_INITIAL_MATRIX) {
17773ab56b82SJunchao Zhang       /* master first gathers counts of nonzeros to receive */
17789566063dSJacob Faibussowitsch       if (mumps->is_omp_master) PetscCall(PetscMalloc1(osize, &mumps->recvcount));
17799566063dSJacob Faibussowitsch       PetscCallMPI(MPI_Gather(&mumps->nnz, 1, MPIU_INT64, mumps->recvcount, 1, MPIU_INT64, 0 /*master*/, mumps->omp_comm));
17803ab56b82SJunchao Zhang 
1781a6053eceSJunchao Zhang       /* Then each computes number of send/recvs */
17823ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1783a6053eceSJunchao Zhang         /* Start from 1 since self communication is not done in MPI */
1784a6053eceSJunchao Zhang         nreqs = 0;
1785a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) nreqs += (mumps->recvcount[i] + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
1786a6053eceSJunchao Zhang       } else {
1787a6053eceSJunchao Zhang         nreqs = (mumps->nnz + PETSC_MPI_INT_MAX - 1) / PETSC_MPI_INT_MAX;
17883ab56b82SJunchao Zhang       }
178935cb6cd3SPierre Jolivet       PetscCall(PetscMalloc1(nreqs * 3, &mumps->reqs)); /* Triple the requests since we send irn, jcn and val separately */
17903ab56b82SJunchao Zhang 
1791a6053eceSJunchao Zhang       /* The following code is doing a very simple thing: omp_master rank gathers irn/jcn/val from others.
1792a6053eceSJunchao Zhang          MPI_Gatherv would be enough if it supports big counts > 2^31-1. Since it does not, and mumps->nnz
1793a6053eceSJunchao Zhang          might be a prime number > 2^31-1, we have to slice the message. Note omp_comm_size
1794a6053eceSJunchao Zhang          is very small, the current approach should have no extra overhead compared to MPI_Gatherv.
1795a6053eceSJunchao Zhang        */
1796a6053eceSJunchao Zhang       nreqs = 0; /* counter for actual send/recvs */
17973ab56b82SJunchao Zhang       if (mumps->is_omp_master) {
1798a6053eceSJunchao Zhang         for (i = 0, totnnz = 0; i < osize; i++) totnnz += mumps->recvcount[i]; /* totnnz = sum of nnz over omp_comm */
17999566063dSJacob Faibussowitsch         PetscCall(PetscMalloc2(totnnz, &irn, totnnz, &jcn));
18009566063dSJacob Faibussowitsch         PetscCall(PetscMalloc1(totnnz, &val));
1801a6053eceSJunchao Zhang 
1802a6053eceSJunchao Zhang         /* Self communication */
18039566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(irn, mumps->irn, mumps->nnz));
18049566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(jcn, mumps->jcn, mumps->nnz));
18059566063dSJacob Faibussowitsch         PetscCall(PetscArraycpy(val, mumps->val, mumps->nnz));
1806a6053eceSJunchao Zhang 
1807a6053eceSJunchao Zhang         /* Replace mumps->irn/jcn etc on master with the newly allocated bigger arrays */
18089566063dSJacob Faibussowitsch         PetscCall(PetscFree2(mumps->irn, mumps->jcn));
18099566063dSJacob Faibussowitsch         PetscCall(PetscFree(mumps->val_alloc));
1810a6053eceSJunchao Zhang         mumps->nnz = totnnz;
18113ab56b82SJunchao Zhang         mumps->irn = irn;
18123ab56b82SJunchao Zhang         mumps->jcn = jcn;
1813a6053eceSJunchao Zhang         mumps->val = mumps->val_alloc = val;
1814a6053eceSJunchao Zhang 
1815a6053eceSJunchao Zhang         irn += mumps->recvcount[0]; /* recvcount[0] is old mumps->nnz on omp rank 0 */
1816a6053eceSJunchao Zhang         jcn += mumps->recvcount[0];
1817a6053eceSJunchao Zhang         val += mumps->recvcount[0];
1818a6053eceSJunchao Zhang 
1819a6053eceSJunchao Zhang         /* Remote communication */
1820a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) {
1821a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1822a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1823a6053eceSJunchao Zhang           while (count > 0) {
18249566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(irn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18259566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(jcn, count, MPIU_MUMPSINT, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18269566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1827a6053eceSJunchao Zhang             irn += count;
1828a6053eceSJunchao Zhang             jcn += count;
1829a6053eceSJunchao Zhang             val += count;
1830a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1831a6053eceSJunchao Zhang             remain -= count;
1832a6053eceSJunchao Zhang           }
18333ab56b82SJunchao Zhang         }
18343ab56b82SJunchao Zhang       } else {
1835a6053eceSJunchao Zhang         irn    = mumps->irn;
1836a6053eceSJunchao Zhang         jcn    = mumps->jcn;
1837a6053eceSJunchao Zhang         val    = mumps->val;
1838a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1839a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1840a6053eceSJunchao Zhang         while (count > 0) {
18419566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(irn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18429566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(jcn, count, MPIU_MUMPSINT, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
18439566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1844a6053eceSJunchao Zhang           irn += count;
1845a6053eceSJunchao Zhang           jcn += count;
1846a6053eceSJunchao Zhang           val += count;
1847a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1848a6053eceSJunchao Zhang           remain -= count;
18493ab56b82SJunchao Zhang         }
18503ab56b82SJunchao Zhang       }
1851a6053eceSJunchao Zhang     } else {
1852a6053eceSJunchao Zhang       nreqs = 0;
1853a6053eceSJunchao Zhang       if (mumps->is_omp_master) {
1854a6053eceSJunchao Zhang         val = mumps->val + mumps->recvcount[0];
1855a6053eceSJunchao Zhang         for (i = 1; i < osize; i++) { /* Remote communication only since self data is already in place */
1856a6053eceSJunchao Zhang           count  = PetscMin(mumps->recvcount[i], PETSC_MPI_INT_MAX);
1857a6053eceSJunchao Zhang           remain = mumps->recvcount[i] - count;
1858a6053eceSJunchao Zhang           while (count > 0) {
18599566063dSJacob Faibussowitsch             PetscCallMPI(MPI_Irecv(val, count, MPIU_SCALAR, i, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1860a6053eceSJunchao Zhang             val += count;
1861a6053eceSJunchao Zhang             count = PetscMin(remain, PETSC_MPI_INT_MAX);
1862a6053eceSJunchao Zhang             remain -= count;
1863a6053eceSJunchao Zhang           }
1864a6053eceSJunchao Zhang         }
1865a6053eceSJunchao Zhang       } else {
1866a6053eceSJunchao Zhang         val    = mumps->val;
1867a6053eceSJunchao Zhang         count  = PetscMin(mumps->nnz, PETSC_MPI_INT_MAX);
1868a6053eceSJunchao Zhang         remain = mumps->nnz - count;
1869a6053eceSJunchao Zhang         while (count > 0) {
18709566063dSJacob Faibussowitsch           PetscCallMPI(MPI_Isend(val, count, MPIU_SCALAR, 0, mumps->tag, mumps->omp_comm, &mumps->reqs[nreqs++]));
1871a6053eceSJunchao Zhang           val += count;
1872a6053eceSJunchao Zhang           count = PetscMin(remain, PETSC_MPI_INT_MAX);
1873a6053eceSJunchao Zhang           remain -= count;
1874a6053eceSJunchao Zhang         }
1875a6053eceSJunchao Zhang       }
1876a6053eceSJunchao Zhang     }
18779566063dSJacob Faibussowitsch     PetscCallMPI(MPI_Waitall(nreqs, mumps->reqs, MPI_STATUSES_IGNORE));
1878a6053eceSJunchao Zhang     mumps->tag++; /* It is totally fine for above send/recvs to share one mpi tag */
1879a6053eceSJunchao Zhang   }
18803ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
18813ab56b82SJunchao Zhang }
18823ab56b82SJunchao Zhang 
1883d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorNumeric_MUMPS(Mat F, Mat A, const MatFactorInfo *info)
1884d71ae5a4SJacob Faibussowitsch {
1885e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)(F)->data;
1886ace3abfcSBarry Smith   PetscBool  isMPIAIJ;
1887397b6df1SKris Buschelman 
1888397b6df1SKris Buschelman   PetscFunctionBegin;
1889dbf6bb8dSprj-   if (mumps->id.INFOG(1) < 0 && !(mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0)) {
189048a46eb9SPierre 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)));
18919566063dSJacob 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)));
18923ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
18932aca8efcSHong Zhang   }
18946baea169SHong Zhang 
18959566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_REUSE_MATRIX, mumps));
18969566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_REUSE_MATRIX, mumps));
1897397b6df1SKris Buschelman 
1898397b6df1SKris Buschelman   /* numerical factorization phase */
1899a5e57a09SHong Zhang   mumps->id.job = JOB_FACTNUMERIC;
19004e34a73bSHong Zhang   if (!mumps->id.ICNTL(18)) { /* A is centralized */
1901ad540459SPierre Jolivet     if (!mumps->myid) mumps->id.a = (MumpsScalar *)mumps->val;
1902397b6df1SKris Buschelman   } else {
1903940cd9d6SSatish Balay     mumps->id.a_loc = (MumpsScalar *)mumps->val;
1904397b6df1SKris Buschelman   }
19053ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
1906a5e57a09SHong Zhang   if (mumps->id.INFOG(1) < 0) {
19079261f6e4SBarry 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));
19089261f6e4SBarry Smith     if (mumps->id.INFOG(1) == -10) {
19099261f6e4SBarry 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)));
1910603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_NUMERIC_ZEROPIVOT;
1911c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -13) {
19129261f6e4SBarry 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)));
1913603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
1914c0d63f2fSHong Zhang     } else if (mumps->id.INFOG(1) == -8 || mumps->id.INFOG(1) == -9 || (-16 < mumps->id.INFOG(1) && mumps->id.INFOG(1) < -10)) {
19159261f6e4SBarry 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)));
1916603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
19172aca8efcSHong Zhang     } else {
19189261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in numerical factorization: INFOG(1)=%d, INFO(2)=%d\n", mumps->id.INFOG(1), mumps->id.INFO(2)));
1919603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
1920151787a6SHong Zhang     }
19212aca8efcSHong Zhang   }
19229261f6e4SBarry 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));
1923397b6df1SKris Buschelman 
1924b3cb21ddSStefano Zampini   F->assembled = PETSC_TRUE;
1925d47f36abSHong Zhang 
1926b3cb21ddSStefano Zampini   if (F->schur) { /* reset Schur status to unfactored */
19273cb7dd0eSStefano Zampini #if defined(PETSC_HAVE_CUDA)
1928c70f7ee4SJunchao Zhang     F->schur->offloadmask = PETSC_OFFLOAD_CPU;
19293cb7dd0eSStefano Zampini #endif
1930b3cb21ddSStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
1931b3cb21ddSStefano Zampini       mumps->id.ICNTL(19) = 2;
19329566063dSJacob Faibussowitsch       PetscCall(MatTranspose(F->schur, MAT_INPLACE_MATRIX, &F->schur));
1933b3cb21ddSStefano Zampini     }
19349566063dSJacob Faibussowitsch     PetscCall(MatFactorRestoreSchurComplement(F, NULL, MAT_FACTOR_SCHUR_UNFACTORED));
1935b3cb21ddSStefano Zampini   }
193667877ebaSShri Abhyankar 
1937066565c5SStefano Zampini   /* just to be sure that ICNTL(19) value returned by a call from MatMumpsGetIcntl is always consistent */
1938066565c5SStefano Zampini   if (!mumps->sym && mumps->id.ICNTL(19) && mumps->id.ICNTL(19) != 1) mumps->id.ICNTL(19) = 3;
1939066565c5SStefano Zampini 
19403ab56b82SJunchao Zhang   if (!mumps->is_omp_master) mumps->id.INFO(23) = 0;
19412d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
194267877ebaSShri Abhyankar     PetscInt     lsol_loc;
194367877ebaSShri Abhyankar     PetscScalar *sol_loc;
19442205254eSKarl Rupp 
19459566063dSJacob Faibussowitsch     PetscCall(PetscObjectTypeCompare((PetscObject)A, MATMPIAIJ, &isMPIAIJ));
1946c2093ab7SHong Zhang 
1947c2093ab7SHong Zhang     /* distributed solution; Create x_seq=sol_loc for repeated use */
1948c2093ab7SHong Zhang     if (mumps->x_seq) {
19499566063dSJacob Faibussowitsch       PetscCall(VecScatterDestroy(&mumps->scat_sol));
19509566063dSJacob Faibussowitsch       PetscCall(PetscFree2(mumps->id.sol_loc, mumps->id.isol_loc));
19519566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&mumps->x_seq));
1952c2093ab7SHong Zhang     }
1953a5e57a09SHong Zhang     lsol_loc = mumps->id.INFO(23); /* length of sol_loc */
19549566063dSJacob Faibussowitsch     PetscCall(PetscMalloc2(lsol_loc, &sol_loc, lsol_loc, &mumps->id.isol_loc));
1955a5e57a09SHong Zhang     mumps->id.lsol_loc = lsol_loc;
1956940cd9d6SSatish Balay     mumps->id.sol_loc  = (MumpsScalar *)sol_loc;
19579566063dSJacob Faibussowitsch     PetscCall(VecCreateSeqWithArray(PETSC_COMM_SELF, 1, lsol_loc, sol_loc, &mumps->x_seq));
195867877ebaSShri Abhyankar   }
19599566063dSJacob Faibussowitsch   PetscCall(PetscLogFlops(mumps->id.RINFO(2)));
19603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
1961397b6df1SKris Buschelman }
1962397b6df1SKris Buschelman 
19639a2535b5SHong Zhang /* Sets MUMPS options from the options database */
1964d71ae5a4SJacob Faibussowitsch PetscErrorCode MatSetFromOptions_MUMPS(Mat F, Mat A)
1965d71ae5a4SJacob Faibussowitsch {
1966e69c285eSBarry Smith   Mat_MUMPS    *mumps = (Mat_MUMPS *)F->data;
1967413bcc21SPierre Jolivet   PetscMUMPSInt icntl = 0, size, *listvar_schur;
196845e3843bSPierre Jolivet   PetscInt      info[80], i, ninfo = 80, rbs, cbs;
1969413bcc21SPierre Jolivet   PetscBool     flg = PETSC_FALSE, schur = (PetscBool)(mumps->id.ICNTL(26) == -1);
1970413bcc21SPierre Jolivet   MumpsScalar  *arr;
1971dcd589f8SShri Abhyankar 
1972dcd589f8SShri Abhyankar   PetscFunctionBegin;
197326cc229bSBarry Smith   PetscOptionsBegin(PetscObjectComm((PetscObject)F), ((PetscObject)F)->prefix, "MUMPS Options", "Mat");
1974413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) { /* MatSetFromOptions_MUMPS() has never been called before */
1975413bcc21SPierre Jolivet     PetscInt nthreads   = 0;
1976413bcc21SPierre Jolivet     PetscInt nCNTL_pre  = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
1977413bcc21SPierre Jolivet     PetscInt nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
1978413bcc21SPierre Jolivet 
1979413bcc21SPierre Jolivet     mumps->petsc_comm = PetscObjectComm((PetscObject)A);
1980413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->petsc_comm, &mumps->petsc_size));
1981413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_rank(mumps->petsc_comm, &mumps->myid)); /* "if (!myid)" still works even if mumps_comm is different */
1982413bcc21SPierre Jolivet 
1983413bcc21SPierre Jolivet     PetscCall(PetscOptionsName("-mat_mumps_use_omp_threads", "Convert MPI processes into OpenMP threads", "None", &mumps->use_petsc_omp_support));
1984413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) nthreads = -1; /* -1 will let PetscOmpCtrlCreate() guess a proper value when user did not supply one */
1985413bcc21SPierre Jolivet     /* do not use PetscOptionsInt() so that the option -mat_mumps_use_omp_threads is not displayed twice in the help */
1986413bcc21SPierre Jolivet     PetscCall(PetscOptionsGetInt(NULL, ((PetscObject)F)->prefix, "-mat_mumps_use_omp_threads", &nthreads, NULL));
1987413bcc21SPierre Jolivet     if (mumps->use_petsc_omp_support) {
19889371c9d4SSatish 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",
19899371c9d4SSatish Balay                  ((PetscObject)F)->prefix ? ((PetscObject)F)->prefix : "");
1990413bcc21SPierre 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 : "");
1991413bcc21SPierre Jolivet #if defined(PETSC_HAVE_OPENMP_SUPPORT)
1992413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlCreate(mumps->petsc_comm, nthreads, &mumps->omp_ctrl));
1993413bcc21SPierre Jolivet       PetscCall(PetscOmpCtrlGetOmpComms(mumps->omp_ctrl, &mumps->omp_comm, &mumps->mumps_comm, &mumps->is_omp_master));
1994413bcc21SPierre Jolivet #endif
1995413bcc21SPierre Jolivet     } else {
1996413bcc21SPierre Jolivet       mumps->omp_comm      = PETSC_COMM_SELF;
1997413bcc21SPierre Jolivet       mumps->mumps_comm    = mumps->petsc_comm;
1998413bcc21SPierre Jolivet       mumps->is_omp_master = PETSC_TRUE;
1999413bcc21SPierre Jolivet     }
2000413bcc21SPierre Jolivet     PetscCallMPI(MPI_Comm_size(mumps->omp_comm, &mumps->omp_comm_size));
2001413bcc21SPierre Jolivet     mumps->reqs = NULL;
2002413bcc21SPierre Jolivet     mumps->tag  = 0;
2003413bcc21SPierre Jolivet 
2004413bcc21SPierre Jolivet     if (mumps->mumps_comm != MPI_COMM_NULL) {
2005413bcc21SPierre Jolivet       if (PetscDefined(HAVE_OPENMP_SUPPORT) && mumps->use_petsc_omp_support) {
2006413bcc21SPierre Jolivet         /* It looks like MUMPS does not dup the input comm. Dup a new comm for MUMPS to avoid any tag mismatches. */
2007413bcc21SPierre Jolivet         MPI_Comm comm;
2008413bcc21SPierre Jolivet         PetscCallMPI(MPI_Comm_dup(mumps->mumps_comm, &comm));
2009413bcc21SPierre Jolivet         mumps->mumps_comm = comm;
2010413bcc21SPierre Jolivet       } else PetscCall(PetscCommGetComm(mumps->petsc_comm, &mumps->mumps_comm));
2011413bcc21SPierre Jolivet     }
2012413bcc21SPierre Jolivet 
2013413bcc21SPierre Jolivet     mumps->id.comm_fortran = MPI_Comm_c2f(mumps->mumps_comm);
2014413bcc21SPierre Jolivet     mumps->id.job          = JOB_INIT;
2015413bcc21SPierre Jolivet     mumps->id.par          = 1; /* host participates factorizaton and solve */
2016413bcc21SPierre Jolivet     mumps->id.sym          = mumps->sym;
2017413bcc21SPierre Jolivet 
2018413bcc21SPierre Jolivet     size          = mumps->id.size_schur;
2019413bcc21SPierre Jolivet     arr           = mumps->id.schur;
2020413bcc21SPierre Jolivet     listvar_schur = mumps->id.listvar_schur;
2021413bcc21SPierre Jolivet     PetscMUMPS_c(mumps);
20229261f6e4SBarry Smith     PetscCheck(mumps->id.INFOG(1) >= 0, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
2023413bcc21SPierre Jolivet     /* restore cached ICNTL and CNTL values */
2024413bcc21SPierre Jolivet     for (icntl = 0; icntl < nICNTL_pre; ++icntl) mumps->id.ICNTL(mumps->ICNTL_pre[1 + 2 * icntl]) = mumps->ICNTL_pre[2 + 2 * icntl];
2025413bcc21SPierre Jolivet     for (icntl = 0; icntl < nCNTL_pre; ++icntl) mumps->id.CNTL((PetscInt)mumps->CNTL_pre[1 + 2 * icntl]) = mumps->CNTL_pre[2 + 2 * icntl];
2026413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->ICNTL_pre));
2027413bcc21SPierre Jolivet     PetscCall(PetscFree(mumps->CNTL_pre));
2028413bcc21SPierre Jolivet 
2029413bcc21SPierre Jolivet     if (schur) {
2030413bcc21SPierre Jolivet       mumps->id.size_schur    = size;
2031413bcc21SPierre Jolivet       mumps->id.schur_lld     = size;
2032413bcc21SPierre Jolivet       mumps->id.schur         = arr;
2033413bcc21SPierre Jolivet       mumps->id.listvar_schur = listvar_schur;
2034413bcc21SPierre Jolivet       if (mumps->petsc_size > 1) {
2035413bcc21SPierre Jolivet         PetscBool gs; /* gs is false if any rank other than root has non-empty IS */
2036413bcc21SPierre Jolivet 
2037413bcc21SPierre Jolivet         mumps->id.ICNTL(19) = 1;                                                                            /* MUMPS returns Schur centralized on the host */
2038413bcc21SPierre 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 */
2039712fec58SPierre Jolivet         PetscCall(MPIU_Allreduce(MPI_IN_PLACE, &gs, 1, MPIU_BOOL, MPI_LAND, mumps->petsc_comm));
2040413bcc21SPierre Jolivet         PetscCheck(gs, PETSC_COMM_SELF, PETSC_ERR_SUP, "MUMPS distributed parallel Schur complements not yet supported from PETSc");
2041413bcc21SPierre Jolivet       } else {
2042413bcc21SPierre Jolivet         if (F->factortype == MAT_FACTOR_LU) {
2043413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 3; /* MUMPS returns full matrix */
2044413bcc21SPierre Jolivet         } else {
2045413bcc21SPierre Jolivet           mumps->id.ICNTL(19) = 2; /* MUMPS returns lower triangular part */
2046413bcc21SPierre Jolivet         }
2047413bcc21SPierre Jolivet       }
2048413bcc21SPierre Jolivet       mumps->id.ICNTL(26) = -1;
2049413bcc21SPierre Jolivet     }
2050413bcc21SPierre Jolivet 
2051413bcc21SPierre Jolivet     /* copy MUMPS default control values from master to slaves. Although slaves do not call MUMPS, they may access these values in code.
2052413bcc21SPierre Jolivet        For example, ICNTL(9) is initialized to 1 by MUMPS and slaves check ICNTL(9) in MatSolve_MUMPS.
2053413bcc21SPierre Jolivet      */
2054413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.icntl, 40, MPI_INT, 0, mumps->omp_comm));
2055413bcc21SPierre Jolivet     PetscCallMPI(MPI_Bcast(mumps->id.cntl, 15, MPIU_REAL, 0, mumps->omp_comm));
2056413bcc21SPierre Jolivet 
2057413bcc21SPierre Jolivet     mumps->scat_rhs = NULL;
2058413bcc21SPierre Jolivet     mumps->scat_sol = NULL;
2059413bcc21SPierre Jolivet 
2060413bcc21SPierre Jolivet     /* set PETSc-MUMPS default options - override MUMPS default */
2061413bcc21SPierre Jolivet     mumps->id.ICNTL(3) = 0;
2062413bcc21SPierre Jolivet     mumps->id.ICNTL(4) = 0;
2063413bcc21SPierre Jolivet     if (mumps->petsc_size == 1) {
2064413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 0; /* centralized assembled matrix input */
2065413bcc21SPierre Jolivet       mumps->id.ICNTL(7)  = 7; /* automatic choice of ordering done by the package */
2066413bcc21SPierre Jolivet     } else {
2067413bcc21SPierre Jolivet       mumps->id.ICNTL(18) = 3; /* distributed assembled matrix input */
2068413bcc21SPierre Jolivet       mumps->id.ICNTL(21) = 1; /* distributed solution */
2069413bcc21SPierre Jolivet     }
2070413bcc21SPierre Jolivet   }
20719566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_1", "ICNTL(1): output stream for error messages", "None", mumps->id.ICNTL(1), &icntl, &flg));
20729a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(1) = icntl;
20739566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_2", "ICNTL(2): output stream for diagnostic printing, statistics, and warning", "None", mumps->id.ICNTL(2), &icntl, &flg));
20749a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(2) = icntl;
20759566063dSJacob 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));
20769a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(3) = icntl;
2077dcd589f8SShri Abhyankar 
20789566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_4", "ICNTL(4): level of printing (0 to 4)", "None", mumps->id.ICNTL(4), &icntl, &flg));
20799a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(4) = icntl;
20809a2535b5SHong Zhang   if (mumps->id.ICNTL(4) || PetscLogPrintInfo) mumps->id.ICNTL(3) = 6; /* resume MUMPS default id.ICNTL(3) = 6 */
20819a2535b5SHong Zhang 
20829566063dSJacob 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));
20839a2535b5SHong Zhang   if (flg) mumps->id.ICNTL(6) = icntl;
20849a2535b5SHong Zhang 
20859566063dSJacob 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));
2086dcd589f8SShri Abhyankar   if (flg) {
2087aed4548fSBarry 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");
2088b53c1a7fSBarry Smith     mumps->id.ICNTL(7) = icntl;
2089dcd589f8SShri Abhyankar   }
2090e0b74bf9SHong Zhang 
20919566063dSJacob 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));
20929566063dSJacob 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() */
20939566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_10", "ICNTL(10): max num of refinements", "None", mumps->id.ICNTL(10), &mumps->id.ICNTL(10), NULL));
20949566063dSJacob 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));
20959566063dSJacob 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));
20969566063dSJacob 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));
20979566063dSJacob 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));
209845e3843bSPierre Jolivet   PetscCall(MatGetBlockSizes(A, &rbs, &cbs));
209945e3843bSPierre Jolivet   if (rbs == cbs && rbs > 1) mumps->id.ICNTL(15) = -rbs;
210045e3843bSPierre 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));
210145e3843bSPierre Jolivet   if (flg) {
210245e3843bSPierre Jolivet     PetscCheck(mumps->id.ICNTL(15) <= 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "Positive -mat_mumps_icntl_15 not handled");
210345e3843bSPierre 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");
210445e3843bSPierre Jolivet   }
21059566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_19", "ICNTL(19): computes the Schur complement", "None", mumps->id.ICNTL(19), &mumps->id.ICNTL(19), NULL));
210659ac8732SStefano Zampini   if (mumps->id.ICNTL(19) <= 0 || mumps->id.ICNTL(19) > 3) { /* reset any schur data (if any) */
21079566063dSJacob Faibussowitsch     PetscCall(MatDestroy(&F->schur));
21089566063dSJacob Faibussowitsch     PetscCall(MatMumpsResetSchur_Private(mumps));
210959ac8732SStefano Zampini   }
211025aac85cSJunchao Zhang 
211143f3b051SJunchao Zhang   /* Two MPICH Fortran MPI_IN_PLACE binding bugs prevented the use of 'mpich + mumps'. One happened with "mpi4py + mpich + mumps",
211243f3b051SJunchao Zhang      and was reported by Firedrake. See https://bitbucket.org/mpi4py/mpi4py/issues/162/mpi4py-initialization-breaks-fortran
211325aac85cSJunchao Zhang      and a petsc-maint mailing list thread with subject 'MUMPS segfaults in parallel because of ...'
211443f3b051SJunchao Zhang      This bug was fixed by https://github.com/pmodels/mpich/pull/4149. But the fix brought a new bug,
211543f3b051SJunchao Zhang      see https://github.com/pmodels/mpich/issues/5589. This bug was fixed by https://github.com/pmodels/mpich/pull/5590.
211643f3b051SJunchao Zhang      In short, we could not use distributed RHS with MPICH until v4.0b1.
211725aac85cSJunchao Zhang    */
211843f3b051SJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0) || (defined(PETSC_HAVE_MPICH_NUMVERSION) && (PETSC_HAVE_MPICH_NUMVERSION < 40000101))
211925aac85cSJunchao Zhang   mumps->ICNTL20 = 0; /* Centralized dense RHS*/
212043f3b051SJunchao Zhang #else
212143f3b051SJunchao Zhang   mumps->ICNTL20     = 10; /* Distributed dense RHS*/
212225aac85cSJunchao Zhang #endif
21239566063dSJacob 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));
2124aed4548fSBarry 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);
212525aac85cSJunchao Zhang #if PETSC_PKG_MUMPS_VERSION_LT(5, 3, 0)
2126aed4548fSBarry Smith   PetscCheck(!flg || mumps->ICNTL20 != 10, PETSC_COMM_SELF, PETSC_ERR_SUP, "ICNTL(20)=10 is not supported before MUMPS-5.3.0");
212725aac85cSJunchao Zhang #endif
21289566063dSJacob 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 */
21299a2535b5SHong Zhang 
21309566063dSJacob 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));
21319566063dSJacob 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));
21329566063dSJacob 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));
21339371c9d4SSatish Balay   if (mumps->id.ICNTL(24)) { mumps->id.ICNTL(13) = 1; /* turn-off ScaLAPACK to help with the correct detection of null pivots */ }
2134d7ebd59bSHong Zhang 
21359566063dSJacob 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));
21369566063dSJacob 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));
21379566063dSJacob 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));
21389566063dSJacob 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));
21399566063dSJacob 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));
21409566063dSJacob 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 */
21419566063dSJacob 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));
2142*145b44c9SPierre 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 */
21439566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_33", "ICNTL(33): compute determinant", "None", mumps->id.ICNTL(33), &mumps->id.ICNTL(33), NULL));
21449566063dSJacob 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));
21459566063dSJacob Faibussowitsch   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_36", "ICNTL(36): choice of BLR factorization variant", "None", mumps->id.ICNTL(36), &mumps->id.ICNTL(36), NULL));
21469566063dSJacob 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));
2147146931dbSPierre Jolivet   PetscCall(PetscOptionsMUMPSInt("-mat_mumps_icntl_58", "ICNTL(58): defines options for symbolic factorization", "None", mumps->id.ICNTL(58), &mumps->id.ICNTL(58), NULL));
2148dcd589f8SShri Abhyankar 
21499566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_1", "CNTL(1): relative pivoting threshold", "None", mumps->id.CNTL(1), &mumps->id.CNTL(1), NULL));
21509566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_2", "CNTL(2): stopping criterion of refinement", "None", mumps->id.CNTL(2), &mumps->id.CNTL(2), NULL));
21519566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_3", "CNTL(3): absolute pivoting threshold", "None", mumps->id.CNTL(3), &mumps->id.CNTL(3), NULL));
21529566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_4", "CNTL(4): value for static pivoting", "None", mumps->id.CNTL(4), &mumps->id.CNTL(4), NULL));
21539566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_5", "CNTL(5): fixation for null pivots", "None", mumps->id.CNTL(5), &mumps->id.CNTL(5), NULL));
21549566063dSJacob Faibussowitsch   PetscCall(PetscOptionsReal("-mat_mumps_cntl_7", "CNTL(7): dropping parameter used during BLR", "None", mumps->id.CNTL(7), &mumps->id.CNTL(7), NULL));
2155e5bb22a1SHong Zhang 
21569566063dSJacob 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));
2157b34f08ffSHong Zhang 
21589566063dSJacob Faibussowitsch   PetscCall(PetscOptionsIntArray("-mat_mumps_view_info", "request INFO local to each processor", "", info, &ninfo, NULL));
2159b34f08ffSHong Zhang   if (ninfo) {
216008401ef6SPierre Jolivet     PetscCheck(ninfo <= 80, PETSC_COMM_SELF, PETSC_ERR_USER, "number of INFO %" PetscInt_FMT " must <= 80", ninfo);
21619566063dSJacob Faibussowitsch     PetscCall(PetscMalloc1(ninfo, &mumps->info));
2162b34f08ffSHong Zhang     mumps->ninfo = ninfo;
2163b34f08ffSHong Zhang     for (i = 0; i < ninfo; i++) {
2164aed4548fSBarry 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);
2165f7d195e4SLawrence Mitchell       mumps->info[i] = info[i];
2166b34f08ffSHong Zhang     }
2167b34f08ffSHong Zhang   }
2168d0609cedSBarry Smith   PetscOptionsEnd();
21693ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2170dcd589f8SShri Abhyankar }
2171dcd589f8SShri Abhyankar 
2172d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorSymbolic_MUMPS_ReportIfError(Mat F, Mat A, const MatFactorInfo *info, Mat_MUMPS *mumps)
2173d71ae5a4SJacob Faibussowitsch {
21745cd7cf9dSHong Zhang   PetscFunctionBegin;
21755cd7cf9dSHong Zhang   if (mumps->id.INFOG(1) < 0) {
21769261f6e4SBarry Smith     PetscCheck(!A->erroriffailure, PETSC_COMM_SELF, PETSC_ERR_LIB, "MUMPS error in analysis: INFOG(1)=%d " MUMPS_MANUALS, mumps->id.INFOG(1));
21775cd7cf9dSHong Zhang     if (mumps->id.INFOG(1) == -6) {
21789261f6e4SBarry 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)));
2179603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_STRUCT_ZEROPIVOT;
21805cd7cf9dSHong Zhang     } else if (mumps->id.INFOG(1) == -5 || mumps->id.INFOG(1) == -7) {
21819261f6e4SBarry 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)));
2182603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OUTMEMORY;
2183dbf6bb8dSprj-     } else if (mumps->id.INFOG(1) == -16 && mumps->id.INFOG(1) == 0) {
21849261f6e4SBarry Smith       PetscCall(PetscInfo(F, "MUMPS error in analysis: empty matrix\n"));
21855cd7cf9dSHong Zhang     } else {
21869261f6e4SBarry 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)));
2187603e8f96SBarry Smith       F->factorerrortype = MAT_FACTOR_OTHER;
21885cd7cf9dSHong Zhang     }
21895cd7cf9dSHong Zhang   }
21903ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
21915cd7cf9dSHong Zhang }
21925cd7cf9dSHong Zhang 
2193d71ae5a4SJacob Faibussowitsch PetscErrorCode MatLUFactorSymbolic_AIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2194d71ae5a4SJacob Faibussowitsch {
2195e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
219667877ebaSShri Abhyankar   Vec            b;
219767877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2198397b6df1SKris Buschelman 
2199397b6df1SKris Buschelman   PetscFunctionBegin;
2200d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2201d47f36abSHong Zhang     /* F is assembled by a previous call of MatLUFactorSymbolic_AIJMUMPS() */
22023ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2203d47f36abSHong Zhang   }
2204dcd589f8SShri Abhyankar 
22059a2535b5SHong Zhang   /* Set MUMPS options from the options database */
220626cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2207dcd589f8SShri Abhyankar 
22089566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
22099566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2210dcd589f8SShri Abhyankar 
221167877ebaSShri Abhyankar   /* analysis phase */
2212a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2213a5e57a09SHong Zhang   mumps->id.n   = M;
2214a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
221567877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2216a5e57a09SHong Zhang     if (!mumps->myid) {
2217a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2218a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2219a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2220a6053eceSJunchao Zhang       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
22214ac6704cSBarry Smith       if (r) {
22224ac6704cSBarry Smith         mumps->id.ICNTL(7) = 1;
2223a5e57a09SHong Zhang         if (!mumps->myid) {
2224e0b74bf9SHong Zhang           const PetscInt *idx;
2225a6053eceSJunchao Zhang           PetscInt        i;
22262205254eSKarl Rupp 
22279566063dSJacob Faibussowitsch           PetscCall(PetscMalloc1(M, &mumps->id.perm_in));
22289566063dSJacob Faibussowitsch           PetscCall(ISGetIndices(r, &idx));
22299566063dSJacob Faibussowitsch           for (i = 0; i < M; i++) PetscCall(PetscMUMPSIntCast(idx[i] + 1, &(mumps->id.perm_in[i]))); /* perm_in[]: start from 1, not 0! */
22309566063dSJacob Faibussowitsch           PetscCall(ISRestoreIndices(r, &idx));
2231e0b74bf9SHong Zhang         }
2232e0b74bf9SHong Zhang       }
223367877ebaSShri Abhyankar     }
223467877ebaSShri Abhyankar     break;
223567877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2236a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2237a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2238a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2239a6053eceSJunchao Zhang     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
224025aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
22419566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
22429566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
22439566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
224425aac85cSJunchao Zhang     }
224567877ebaSShri Abhyankar     break;
224667877ebaSShri Abhyankar   }
22473ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
22489566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
224967877ebaSShri Abhyankar 
2250719d5645SBarry Smith   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2251dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
225251d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
22534e34a73bSHong Zhang   F->ops->matsolve          = MatMatSolve_MUMPS;
2254eb3ef3b2SHong Zhang   F->ops->mattransposesolve = MatMatTransposeSolve_MUMPS;
2255b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2256d47f36abSHong Zhang 
2257d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
22583ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2259b24902e0SBarry Smith }
2260b24902e0SBarry Smith 
2261450b117fSShri Abhyankar /* Note the Petsc r and c permutations are ignored */
2262d71ae5a4SJacob Faibussowitsch PetscErrorCode MatLUFactorSymbolic_BAIJMUMPS(Mat F, Mat A, IS r, IS c, const MatFactorInfo *info)
2263d71ae5a4SJacob Faibussowitsch {
2264e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
226567877ebaSShri Abhyankar   Vec            b;
226667877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2267450b117fSShri Abhyankar 
2268450b117fSShri Abhyankar   PetscFunctionBegin;
2269d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2270338d3105SPierre Jolivet     /* F is assembled by a previous call of MatLUFactorSymbolic_BAIJMUMPS() */
22713ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2272d47f36abSHong Zhang   }
2273dcd589f8SShri Abhyankar 
22749a2535b5SHong Zhang   /* Set MUMPS options from the options database */
227526cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2276dcd589f8SShri Abhyankar 
22779566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
22789566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
227967877ebaSShri Abhyankar 
228067877ebaSShri Abhyankar   /* analysis phase */
2281a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2282a5e57a09SHong Zhang   mumps->id.n   = M;
2283a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
228467877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2285a5e57a09SHong Zhang     if (!mumps->myid) {
2286a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2287a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2288a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2289ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
229067877ebaSShri Abhyankar     }
229167877ebaSShri Abhyankar     break;
229267877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2293a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2294a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2295a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2296ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
229725aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
22989566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
22999566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23009566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
230125aac85cSJunchao Zhang     }
230267877ebaSShri Abhyankar     break;
230367877ebaSShri Abhyankar   }
23043ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23059566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
230667877ebaSShri Abhyankar 
2307450b117fSShri Abhyankar   F->ops->lufactornumeric   = MatFactorNumeric_MUMPS;
2308dcd589f8SShri Abhyankar   F->ops->solve             = MatSolve_MUMPS;
230951d5961aSHong Zhang   F->ops->solvetranspose    = MatSolveTranspose_MUMPS;
2310b18964edSHong Zhang   F->ops->matsolvetranspose = MatMatSolveTranspose_MUMPS;
2311d47f36abSHong Zhang 
2312d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23133ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2314450b117fSShri Abhyankar }
2315b24902e0SBarry Smith 
2316141f4205SHong Zhang /* Note the Petsc r permutation and factor info are ignored */
2317d71ae5a4SJacob Faibussowitsch PetscErrorCode MatCholeskyFactorSymbolic_MUMPS(Mat F, Mat A, IS r, const MatFactorInfo *info)
2318d71ae5a4SJacob Faibussowitsch {
2319e69c285eSBarry Smith   Mat_MUMPS     *mumps = (Mat_MUMPS *)F->data;
232067877ebaSShri Abhyankar   Vec            b;
232167877ebaSShri Abhyankar   const PetscInt M = A->rmap->N;
2322397b6df1SKris Buschelman 
2323397b6df1SKris Buschelman   PetscFunctionBegin;
2324d47f36abSHong Zhang   if (mumps->matstruc == SAME_NONZERO_PATTERN) {
2325338d3105SPierre Jolivet     /* F is assembled by a previous call of MatCholeskyFactorSymbolic_MUMPS() */
23263ba16761SJacob Faibussowitsch     PetscFunctionReturn(PETSC_SUCCESS);
2327d47f36abSHong Zhang   }
2328dcd589f8SShri Abhyankar 
23299a2535b5SHong Zhang   /* Set MUMPS options from the options database */
233026cc229bSBarry Smith   PetscCall(MatSetFromOptions_MUMPS(F, A));
2331dcd589f8SShri Abhyankar 
23329566063dSJacob Faibussowitsch   PetscCall((*mumps->ConvertToTriples)(A, 1, MAT_INITIAL_MATRIX, mumps));
23339566063dSJacob Faibussowitsch   PetscCall(MatMumpsGatherNonzerosOnMaster(MAT_INITIAL_MATRIX, mumps));
2334dcd589f8SShri Abhyankar 
233567877ebaSShri Abhyankar   /* analysis phase */
2336a5e57a09SHong Zhang   mumps->id.job = JOB_FACTSYMBOLIC;
2337a5e57a09SHong Zhang   mumps->id.n   = M;
2338a5e57a09SHong Zhang   switch (mumps->id.ICNTL(18)) {
233967877ebaSShri Abhyankar   case 0: /* centralized assembled matrix input */
2340a5e57a09SHong Zhang     if (!mumps->myid) {
2341a6053eceSJunchao Zhang       mumps->id.nnz = mumps->nnz;
2342a6053eceSJunchao Zhang       mumps->id.irn = mumps->irn;
2343a6053eceSJunchao Zhang       mumps->id.jcn = mumps->jcn;
2344ad540459SPierre Jolivet       if (mumps->id.ICNTL(6) > 1) mumps->id.a = (MumpsScalar *)mumps->val;
234567877ebaSShri Abhyankar     }
234667877ebaSShri Abhyankar     break;
234767877ebaSShri Abhyankar   case 3: /* distributed assembled matrix input (size>1) */
2348a6053eceSJunchao Zhang     mumps->id.nnz_loc = mumps->nnz;
2349a6053eceSJunchao Zhang     mumps->id.irn_loc = mumps->irn;
2350a6053eceSJunchao Zhang     mumps->id.jcn_loc = mumps->jcn;
2351ad540459SPierre Jolivet     if (mumps->id.ICNTL(6) > 1) mumps->id.a_loc = (MumpsScalar *)mumps->val;
235225aac85cSJunchao Zhang     if (mumps->ICNTL20 == 0) { /* Centralized rhs. Create scatter scat_rhs for repeated use in MatSolve() */
23539566063dSJacob Faibussowitsch       PetscCall(MatCreateVecs(A, NULL, &b));
23549566063dSJacob Faibussowitsch       PetscCall(VecScatterCreateToZero(b, &mumps->scat_rhs, &mumps->b_seq));
23559566063dSJacob Faibussowitsch       PetscCall(VecDestroy(&b));
235625aac85cSJunchao Zhang     }
235767877ebaSShri Abhyankar     break;
235867877ebaSShri Abhyankar   }
23593ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
23609566063dSJacob Faibussowitsch   PetscCall(MatFactorSymbolic_MUMPS_ReportIfError(F, A, info, mumps));
23615cd7cf9dSHong Zhang 
23622792810eSHong Zhang   F->ops->choleskyfactornumeric = MatFactorNumeric_MUMPS;
2363dcd589f8SShri Abhyankar   F->ops->solve                 = MatSolve_MUMPS;
236451d5961aSHong Zhang   F->ops->solvetranspose        = MatSolve_MUMPS;
23654e34a73bSHong Zhang   F->ops->matsolve              = MatMatSolve_MUMPS;
236623a5080aSHong Zhang   F->ops->mattransposesolve     = MatMatTransposeSolve_MUMPS;
2367b18964edSHong Zhang   F->ops->matsolvetranspose     = MatMatSolveTranspose_MUMPS;
23684e34a73bSHong Zhang #if defined(PETSC_USE_COMPLEX)
23690298fd71SBarry Smith   F->ops->getinertia = NULL;
23704e34a73bSHong Zhang #else
23714e34a73bSHong Zhang   F->ops->getinertia = MatGetInertia_SBAIJMUMPS;
2372db4efbfdSBarry Smith #endif
2373d47f36abSHong Zhang 
2374d47f36abSHong Zhang   mumps->matstruc = SAME_NONZERO_PATTERN;
23753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2376b24902e0SBarry Smith }
2377b24902e0SBarry Smith 
2378d71ae5a4SJacob Faibussowitsch PetscErrorCode MatView_MUMPS(Mat A, PetscViewer viewer)
2379d71ae5a4SJacob Faibussowitsch {
238064e6c443SBarry Smith   PetscBool         iascii;
238164e6c443SBarry Smith   PetscViewerFormat format;
2382e69c285eSBarry Smith   Mat_MUMPS        *mumps = (Mat_MUMPS *)A->data;
2383f6c57405SHong Zhang 
2384f6c57405SHong Zhang   PetscFunctionBegin;
238564e6c443SBarry Smith   /* check if matrix is mumps type */
23863ba16761SJacob Faibussowitsch   if (A->ops->solve != MatSolve_MUMPS) PetscFunctionReturn(PETSC_SUCCESS);
238764e6c443SBarry Smith 
23889566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii));
238964e6c443SBarry Smith   if (iascii) {
23909566063dSJacob Faibussowitsch     PetscCall(PetscViewerGetFormat(viewer, &format));
23911511cd71SPierre Jolivet     if (format == PETSC_VIEWER_ASCII_INFO || format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
23929566063dSJacob Faibussowitsch       PetscCall(PetscViewerASCIIPrintf(viewer, "MUMPS run parameters:\n"));
23931511cd71SPierre Jolivet       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
23949566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  SYM (matrix type):                   %d\n", mumps->id.sym));
23959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  PAR (host participation):            %d\n", mumps->id.par));
23969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(1) (output for error):         %d\n", mumps->id.ICNTL(1)));
23979566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(2) (output of diagnostic msg): %d\n", mumps->id.ICNTL(2)));
23989566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(3) (output for global info):   %d\n", mumps->id.ICNTL(3)));
23999566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(4) (level of printing):        %d\n", mumps->id.ICNTL(4)));
24009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(5) (input mat struct):         %d\n", mumps->id.ICNTL(5)));
24019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(6) (matrix prescaling):        %d\n", mumps->id.ICNTL(6)));
24029566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(7) (sequential matrix ordering):%d\n", mumps->id.ICNTL(7)));
24039566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(8) (scaling strategy):         %d\n", mumps->id.ICNTL(8)));
24049566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(10) (max num of refinements):  %d\n", mumps->id.ICNTL(10)));
24059566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(11) (error analysis):          %d\n", mumps->id.ICNTL(11)));
2406a5e57a09SHong Zhang         if (mumps->id.ICNTL(11) > 0) {
24079566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(4) (inf norm of input mat):        %g\n", mumps->id.RINFOG(4)));
24089566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(5) (inf norm of solution):         %g\n", mumps->id.RINFOG(5)));
24099566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(6) (inf norm of residual):         %g\n", mumps->id.RINFOG(6)));
24109566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(7),RINFOG(8) (backward error est): %g, %g\n", mumps->id.RINFOG(7), mumps->id.RINFOG(8)));
24119566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(9) (error estimate):               %g\n", mumps->id.RINFOG(9)));
24129566063dSJacob Faibussowitsch           PetscCall(PetscViewerASCIIPrintf(viewer, "    RINFOG(10),RINFOG(11)(condition numbers): %g, %g\n", mumps->id.RINFOG(10), mumps->id.RINFOG(11)));
2413f6c57405SHong Zhang         }
24149566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(12) (efficiency control):                         %d\n", mumps->id.ICNTL(12)));
24159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(13) (sequential factorization of the root node):  %d\n", mumps->id.ICNTL(13)));
24169566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(14) (percentage of estimated workspace increase): %d\n", mumps->id.ICNTL(14)));
241745e3843bSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(15) (compression of the input matrix):            %d\n", mumps->id.ICNTL(15)));
2418f6c57405SHong Zhang         /* ICNTL(15-17) not used */
24199566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(18) (input mat struct):                           %d\n", mumps->id.ICNTL(18)));
24209566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(19) (Schur complement info):                      %d\n", mumps->id.ICNTL(19)));
24219566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(20) (RHS sparse pattern):                         %d\n", mumps->id.ICNTL(20)));
24229566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(21) (solution struct):                            %d\n", mumps->id.ICNTL(21)));
24239566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(22) (in-core/out-of-core facility):               %d\n", mumps->id.ICNTL(22)));
24249566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(23) (max size of memory can be allocated locally):%d\n", mumps->id.ICNTL(23)));
2425c0165424SHong Zhang 
24269566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(24) (detection of null pivot rows):               %d\n", mumps->id.ICNTL(24)));
24279566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(25) (computation of a null space basis):          %d\n", mumps->id.ICNTL(25)));
24289566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(26) (Schur options for RHS or solution):          %d\n", mumps->id.ICNTL(26)));
24299566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(27) (blocking size for multiple RHS):             %d\n", mumps->id.ICNTL(27)));
24309566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(28) (use parallel or sequential ordering):        %d\n", mumps->id.ICNTL(28)));
24319566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(29) (parallel ordering):                          %d\n", mumps->id.ICNTL(29)));
243242179a6aSHong Zhang 
24339566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(30) (user-specified set of entries in inv(A)):    %d\n", mumps->id.ICNTL(30)));
24349566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(31) (factors is discarded in the solve phase):    %d\n", mumps->id.ICNTL(31)));
24359566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(33) (compute determinant):                        %d\n", mumps->id.ICNTL(33)));
24369566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(35) (activate BLR based factorization):           %d\n", mumps->id.ICNTL(35)));
24379566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(36) (choice of BLR factorization variant):        %d\n", mumps->id.ICNTL(36)));
24389566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(38) (estimated compression rate of LU factors):   %d\n", mumps->id.ICNTL(38)));
2439146931dbSPierre Jolivet         PetscCall(PetscViewerASCIIPrintf(viewer, "  ICNTL(58) (options for symbolic factorization):         %d\n", mumps->id.ICNTL(58)));
2440f6c57405SHong Zhang 
24419566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(1) (relative pivoting threshold):      %g\n", mumps->id.CNTL(1)));
24429566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(2) (stopping criterion of refinement): %g\n", mumps->id.CNTL(2)));
24439566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(3) (absolute pivoting threshold):      %g\n", mumps->id.CNTL(3)));
24449566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(4) (value of static pivoting):         %g\n", mumps->id.CNTL(4)));
24459566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(5) (fixation for null pivots):         %g\n", mumps->id.CNTL(5)));
24469566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  CNTL(7) (dropping parameter for BLR):       %g\n", mumps->id.CNTL(7)));
2447f6c57405SHong Zhang 
2448a5b23f4aSJose E. Roman         /* information local to each processor */
24499566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(1) (local estimated flops for the elimination after analysis):\n"));
24509566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPushSynchronized(viewer));
24519566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(1)));
24529566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
24539566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(2) (local estimated flops for the assembly after factorization):\n"));
24549566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(2)));
24559566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
24569566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFO(3) (local estimated flops for the elimination after factorization):\n"));
24579566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %g\n", mumps->myid, mumps->id.RINFO(3)));
24589566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2459f6c57405SHong Zhang 
24609566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(15) (estimated size of (in MB) MUMPS internal data for running numerical factorization):\n"));
24619566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(15)));
24629566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2463f6c57405SHong Zhang 
24649566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(16) (size of (in MB) MUMPS internal data used during numerical factorization):\n"));
24659566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(16)));
24669566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2467f6c57405SHong Zhang 
24689566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(23) (num of pivots eliminated on this processor after factorization):\n"));
24699566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(23)));
24709566063dSJacob Faibussowitsch         PetscCall(PetscViewerFlush(viewer));
2471b34f08ffSHong Zhang 
2472a0e18203SThibaut Appel         if (mumps->ninfo && mumps->ninfo <= 80) {
2473b34f08ffSHong Zhang           PetscInt i;
2474b34f08ffSHong Zhang           for (i = 0; i < mumps->ninfo; i++) {
24759566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIIPrintf(viewer, "  INFO(%" PetscInt_FMT "):\n", mumps->info[i]));
24769566063dSJacob Faibussowitsch             PetscCall(PetscViewerASCIISynchronizedPrintf(viewer, "    [%d] %d\n", mumps->myid, mumps->id.INFO(mumps->info[i])));
24779566063dSJacob Faibussowitsch             PetscCall(PetscViewerFlush(viewer));
2478b34f08ffSHong Zhang           }
2479b34f08ffSHong Zhang         }
24809566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPopSynchronized(viewer));
24811511cd71SPierre Jolivet       } else PetscCall(PetscViewerASCIIPrintf(viewer, "  Use -%sksp_view ::ascii_info_detail to display information for all processes\n", ((PetscObject)A)->prefix ? ((PetscObject)A)->prefix : ""));
2482f6c57405SHong Zhang 
24831511cd71SPierre Jolivet       if (mumps->myid == 0) { /* information from the host */
24849566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(1) (global estimated flops for the elimination after analysis): %g\n", mumps->id.RINFOG(1)));
24859566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(2) (global estimated flops for the assembly after factorization): %g\n", mumps->id.RINFOG(2)));
24869566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  RINFOG(3) (global estimated flops for the elimination after factorization): %g\n", mumps->id.RINFOG(3)));
24879566063dSJacob 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)));
2488f6c57405SHong Zhang 
24899566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(3) (estimated real workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(3)));
24909566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(4) (estimated integer workspace for factors on all processors after analysis): %d\n", mumps->id.INFOG(4)));
24919566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(5) (estimated maximum front size in the complete tree): %d\n", mumps->id.INFOG(5)));
24929566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(6) (number of nodes in the complete tree): %d\n", mumps->id.INFOG(6)));
24939566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(7) (ordering option effectively used after analysis): %d\n", mumps->id.INFOG(7)));
24949566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(8) (structural symmetry in percent of the permuted matrix after analysis): %d\n", mumps->id.INFOG(8)));
24959566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(9) (total real/complex workspace to store the matrix factors after factorization): %d\n", mumps->id.INFOG(9)));
24969566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(10) (total integer space store the matrix factors after factorization): %d\n", mumps->id.INFOG(10)));
24979566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(11) (order of largest frontal matrix after factorization): %d\n", mumps->id.INFOG(11)));
24989566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(12) (number of off-diagonal pivots): %d\n", mumps->id.INFOG(12)));
24999566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(13) (number of delayed pivots after factorization): %d\n", mumps->id.INFOG(13)));
25009566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(14) (number of memory compress after factorization): %d\n", mumps->id.INFOG(14)));
25019566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(15) (number of steps of iterative refinement after solution): %d\n", mumps->id.INFOG(15)));
25029566063dSJacob 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)));
25039566063dSJacob 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)));
25049566063dSJacob 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)));
25059566063dSJacob 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)));
25069566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(20) (estimated number of entries in the factors): %d\n", mumps->id.INFOG(20)));
25079566063dSJacob 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)));
25089566063dSJacob 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)));
25099566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(23) (after analysis: value of ICNTL(6) effectively used): %d\n", mumps->id.INFOG(23)));
25109566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(24) (after analysis: value of ICNTL(12) effectively used): %d\n", mumps->id.INFOG(24)));
25119566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(25) (after factorization: number of pivots modified by static pivoting): %d\n", mumps->id.INFOG(25)));
25129566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(28) (after factorization: number of null pivots encountered): %d\n", mumps->id.INFOG(28)));
25139566063dSJacob 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)));
25149566063dSJacob 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)));
25159566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(32) (after analysis: type of analysis done): %d\n", mumps->id.INFOG(32)));
25169566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(33) (value used for ICNTL(8)): %d\n", mumps->id.INFOG(33)));
25179566063dSJacob Faibussowitsch         PetscCall(PetscViewerASCIIPrintf(viewer, "  INFOG(34) (exponent of the determinant if determinant is requested): %d\n", mumps->id.INFOG(34)));
25189566063dSJacob 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)));
25199566063dSJacob 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)));
25209566063dSJacob 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)));
25219566063dSJacob 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)));
25229566063dSJacob 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)));
2523f6c57405SHong Zhang       }
2524f6c57405SHong Zhang     }
2525cb828f0fSHong Zhang   }
25263ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2527f6c57405SHong Zhang }
2528f6c57405SHong Zhang 
2529d71ae5a4SJacob Faibussowitsch PetscErrorCode MatGetInfo_MUMPS(Mat A, MatInfoType flag, MatInfo *info)
2530d71ae5a4SJacob Faibussowitsch {
2531e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)A->data;
253235bd34faSBarry Smith 
253335bd34faSBarry Smith   PetscFunctionBegin;
253435bd34faSBarry Smith   info->block_size        = 1.0;
253564412097SPierre Jolivet   info->nz_allocated      = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
253664412097SPierre Jolivet   info->nz_used           = mumps->id.INFOG(20) >= 0 ? mumps->id.INFOG(20) : -1000000 * mumps->id.INFOG(20);
253735bd34faSBarry Smith   info->nz_unneeded       = 0.0;
253835bd34faSBarry Smith   info->assemblies        = 0.0;
253935bd34faSBarry Smith   info->mallocs           = 0.0;
254035bd34faSBarry Smith   info->memory            = 0.0;
254135bd34faSBarry Smith   info->fill_ratio_given  = 0;
254235bd34faSBarry Smith   info->fill_ratio_needed = 0;
254335bd34faSBarry Smith   info->factor_mallocs    = 0;
25443ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
254535bd34faSBarry Smith }
254635bd34faSBarry Smith 
2547d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorSetSchurIS_MUMPS(Mat F, IS is)
2548d71ae5a4SJacob Faibussowitsch {
2549e69c285eSBarry Smith   Mat_MUMPS         *mumps = (Mat_MUMPS *)F->data;
2550a3d589ffSStefano Zampini   const PetscScalar *arr;
25518e7ba810SStefano Zampini   const PetscInt    *idxs;
25528e7ba810SStefano Zampini   PetscInt           size, i;
25536444a565SStefano Zampini 
25546444a565SStefano Zampini   PetscFunctionBegin;
25559566063dSJacob Faibussowitsch   PetscCall(ISGetLocalSize(is, &size));
2556b3cb21ddSStefano Zampini   /* Schur complement matrix */
25579566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&F->schur));
25589566063dSJacob Faibussowitsch   PetscCall(MatCreateSeqDense(PETSC_COMM_SELF, size, size, NULL, &F->schur));
25599566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArrayRead(F->schur, &arr));
2560a3d589ffSStefano Zampini   mumps->id.schur      = (MumpsScalar *)arr;
2561a3d589ffSStefano Zampini   mumps->id.size_schur = size;
2562a3d589ffSStefano Zampini   mumps->id.schur_lld  = size;
25639566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArrayRead(F->schur, &arr));
256448a46eb9SPierre Jolivet   if (mumps->sym == 1) PetscCall(MatSetOption(F->schur, MAT_SPD, PETSC_TRUE));
2565b3cb21ddSStefano Zampini 
2566b3cb21ddSStefano Zampini   /* MUMPS expects Fortran style indices */
25679566063dSJacob Faibussowitsch   PetscCall(PetscFree(mumps->id.listvar_schur));
25689566063dSJacob Faibussowitsch   PetscCall(PetscMalloc1(size, &mumps->id.listvar_schur));
25699566063dSJacob Faibussowitsch   PetscCall(ISGetIndices(is, &idxs));
25709566063dSJacob Faibussowitsch   for (i = 0; i < size; i++) PetscCall(PetscMUMPSIntCast(idxs[i] + 1, &(mumps->id.listvar_schur[i])));
25719566063dSJacob Faibussowitsch   PetscCall(ISRestoreIndices(is, &idxs));
257259ac8732SStefano Zampini   /* set a special value of ICNTL (not handled my MUMPS) to be used in the solve phase by PETSc */
2573b5fa320bSStefano Zampini   mumps->id.ICNTL(26) = -1;
25743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
25756444a565SStefano Zampini }
257659ac8732SStefano Zampini 
2577d71ae5a4SJacob Faibussowitsch PetscErrorCode MatFactorCreateSchurComplement_MUMPS(Mat F, Mat *S)
2578d71ae5a4SJacob Faibussowitsch {
25796444a565SStefano Zampini   Mat          St;
2580e69c285eSBarry Smith   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
25816444a565SStefano Zampini   PetscScalar *array;
25826444a565SStefano Zampini #if defined(PETSC_USE_COMPLEX)
25838ac429a0SStefano Zampini   PetscScalar im = PetscSqrtScalar((PetscScalar)-1.0);
25846444a565SStefano Zampini #endif
25856444a565SStefano Zampini 
25866444a565SStefano Zampini   PetscFunctionBegin;
25879261f6e4SBarry Smith   PetscCheck(mumps->id.ICNTL(19), PetscObjectComm((PetscObject)F), PETSC_ERR_ORDER, "Schur complement mode not selected! Call MatFactorSetSchurIS() to enable it");
25889566063dSJacob Faibussowitsch   PetscCall(MatCreate(PETSC_COMM_SELF, &St));
25899566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(St, PETSC_DECIDE, PETSC_DECIDE, mumps->id.size_schur, mumps->id.size_schur));
25909566063dSJacob Faibussowitsch   PetscCall(MatSetType(St, MATDENSE));
25919566063dSJacob Faibussowitsch   PetscCall(MatSetUp(St));
25929566063dSJacob Faibussowitsch   PetscCall(MatDenseGetArray(St, &array));
259359ac8732SStefano Zampini   if (!mumps->sym) {                /* MUMPS always return a full matrix */
25946444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 1) { /* stored by rows */
25956444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
25966444a565SStefano Zampini       for (i = 0; i < N; i++) {
25976444a565SStefano Zampini         for (j = 0; j < N; j++) {
25986444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
25996444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26006444a565SStefano Zampini #else
26016444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j].r + im * mumps->id.schur[i * N + j].i;
26026444a565SStefano Zampini #endif
26036444a565SStefano Zampini           array[j * N + i] = val;
26046444a565SStefano Zampini         }
26056444a565SStefano Zampini       }
26066444a565SStefano Zampini     } else { /* stored by columns */
26079566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26086444a565SStefano Zampini     }
26096444a565SStefano Zampini   } else {                          /* either full or lower-triangular (not packed) */
26106444a565SStefano Zampini     if (mumps->id.ICNTL(19) == 2) { /* lower triangular stored by columns */
26116444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26126444a565SStefano Zampini       for (i = 0; i < N; i++) {
26136444a565SStefano Zampini         for (j = i; j < N; j++) {
26146444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26156444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26166444a565SStefano Zampini #else
26176444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j].r + im * mumps->id.schur[i * N + j].i;
26186444a565SStefano Zampini #endif
26196444a565SStefano Zampini           array[i * N + j] = val;
26206444a565SStefano Zampini           array[j * N + i] = val;
26216444a565SStefano Zampini         }
26226444a565SStefano Zampini       }
26236444a565SStefano Zampini     } else if (mumps->id.ICNTL(19) == 3) { /* full matrix */
26249566063dSJacob Faibussowitsch       PetscCall(PetscArraycpy(array, mumps->id.schur, mumps->id.size_schur * mumps->id.size_schur));
26256444a565SStefano Zampini     } else { /* ICNTL(19) == 1 lower triangular stored by rows */
26266444a565SStefano Zampini       PetscInt i, j, N = mumps->id.size_schur;
26276444a565SStefano Zampini       for (i = 0; i < N; i++) {
26286444a565SStefano Zampini         for (j = 0; j < i + 1; j++) {
26296444a565SStefano Zampini #if !defined(PETSC_USE_COMPLEX)
26306444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j];
26316444a565SStefano Zampini #else
26326444a565SStefano Zampini           PetscScalar val = mumps->id.schur[i * N + j].r + im * mumps->id.schur[i * N + j].i;
26336444a565SStefano Zampini #endif
26346444a565SStefano Zampini           array[i * N + j] = val;
26356444a565SStefano Zampini           array[j * N + i] = val;
26366444a565SStefano Zampini         }
26376444a565SStefano Zampini       }
26386444a565SStefano Zampini     }
26396444a565SStefano Zampini   }
26409566063dSJacob Faibussowitsch   PetscCall(MatDenseRestoreArray(St, &array));
26416444a565SStefano Zampini   *S = St;
26423ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26436444a565SStefano Zampini }
26446444a565SStefano Zampini 
2645d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt ival)
2646d71ae5a4SJacob Faibussowitsch {
2647e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
26485ccb76cbSHong Zhang 
26495ccb76cbSHong Zhang   PetscFunctionBegin;
2650413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {                                       /* need to cache icntl and ival since PetscMUMPS_c() has never been called */
2651413bcc21SPierre Jolivet     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0; /* number of already cached ICNTL */
26529371c9d4SSatish Balay     for (i = 0; i < nICNTL_pre; ++i)
26539371c9d4SSatish Balay       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) break; /* is this ICNTL already cached? */
2654413bcc21SPierre Jolivet     if (i == nICNTL_pre) {                             /* not already cached */
2655413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscMUMPSInt) * (2 * nICNTL_pre + 3), &mumps->ICNTL_pre));
2656413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscMUMPSInt) * 3, &mumps->ICNTL_pre));
2657413bcc21SPierre Jolivet       mumps->ICNTL_pre[0]++;
2658413bcc21SPierre Jolivet     }
2659413bcc21SPierre Jolivet     mumps->ICNTL_pre[1 + 2 * i] = icntl;
2660413bcc21SPierre Jolivet     PetscCall(PetscMUMPSIntCast(ival, mumps->ICNTL_pre + 2 + 2 * i));
2661413bcc21SPierre Jolivet   } else PetscCall(PetscMUMPSIntCast(ival, &mumps->id.ICNTL(icntl)));
26623ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
26635ccb76cbSHong Zhang }
26645ccb76cbSHong Zhang 
2665d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl_MUMPS(Mat F, PetscInt icntl, PetscInt *ival)
2666d71ae5a4SJacob Faibussowitsch {
2667e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2668bc6112feSHong Zhang 
2669bc6112feSHong Zhang   PetscFunctionBegin;
267036df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
267136df9881Sjeremy theler     PetscInt i, nICNTL_pre = mumps->ICNTL_pre ? mumps->ICNTL_pre[0] : 0;
267236df9881Sjeremy theler     *ival = 0;
267336df9881Sjeremy theler     for (i = 0; i < nICNTL_pre; ++i) {
267436df9881Sjeremy theler       if (mumps->ICNTL_pre[1 + 2 * i] == icntl) *ival = mumps->ICNTL_pre[2 + 2 * i];
267536df9881Sjeremy theler     }
267636df9881Sjeremy theler   } else *ival = mumps->id.ICNTL(icntl);
26773ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2678bc6112feSHong Zhang }
2679bc6112feSHong Zhang 
26805ccb76cbSHong Zhang /*@
26815ccb76cbSHong Zhang   MatMumpsSetIcntl - Set MUMPS parameter ICNTL()
26825ccb76cbSHong Zhang 
2683c3339decSBarry Smith   Logically Collective
26845ccb76cbSHong Zhang 
26855ccb76cbSHong Zhang   Input Parameters:
268611a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
26875ccb76cbSHong Zhang . icntl - index of MUMPS parameter array ICNTL()
26885ccb76cbSHong Zhang - ival  - value of MUMPS ICNTL(icntl)
26895ccb76cbSHong Zhang 
26903c7db156SBarry Smith   Options Database Key:
2691147403d9SBarry Smith . -mat_mumps_icntl_<icntl> <ival> - change the option numbered icntl to ival
26925ccb76cbSHong Zhang 
26935ccb76cbSHong Zhang   Level: beginner
26945ccb76cbSHong Zhang 
269596a0c994SBarry Smith   References:
2696606c0280SSatish Balay .  * - MUMPS Users' Guide
26975ccb76cbSHong Zhang 
26981cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
26995ccb76cbSHong Zhang @*/
2700d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetIcntl(Mat F, PetscInt icntl, PetscInt ival)
2701d71ae5a4SJacob Faibussowitsch {
27025ccb76cbSHong Zhang   PetscFunctionBegin;
27032989dfd4SHong Zhang   PetscValidType(F, 1);
270428b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
27055ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27065ccb76cbSHong Zhang   PetscValidLogicalCollectiveInt(F, ival, 3);
2707146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2708cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetIcntl_C", (Mat, PetscInt, PetscInt), (F, icntl, ival));
27093ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27105ccb76cbSHong Zhang }
27115ccb76cbSHong Zhang 
2712a21f80fcSHong Zhang /*@
2713a21f80fcSHong Zhang   MatMumpsGetIcntl - Get MUMPS parameter ICNTL()
2714a21f80fcSHong Zhang 
2715c3339decSBarry Smith   Logically Collective
2716a21f80fcSHong Zhang 
2717a21f80fcSHong Zhang   Input Parameters:
271811a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2719a21f80fcSHong Zhang - icntl - index of MUMPS parameter array ICNTL()
2720a21f80fcSHong Zhang 
2721a21f80fcSHong Zhang   Output Parameter:
2722a21f80fcSHong Zhang . ival - value of MUMPS ICNTL(icntl)
2723a21f80fcSHong Zhang 
2724a21f80fcSHong Zhang   Level: beginner
2725a21f80fcSHong Zhang 
272696a0c994SBarry Smith   References:
2727606c0280SSatish Balay .  * - MUMPS Users' Guide
2728a21f80fcSHong Zhang 
27291cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2730a21f80fcSHong Zhang @*/
2731d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetIcntl(Mat F, PetscInt icntl, PetscInt *ival)
2732d71ae5a4SJacob Faibussowitsch {
2733bc6112feSHong Zhang   PetscFunctionBegin;
27342989dfd4SHong Zhang   PetscValidType(F, 1);
273528b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2736bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
27374f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
2738146931dbSPierre Jolivet   PetscCheck((icntl >= 1 && icntl <= 38) || icntl == 58, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported ICNTL value %" PetscInt_FMT, icntl);
2739cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetIcntl_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
27403ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2741bc6112feSHong Zhang }
2742bc6112feSHong Zhang 
2743d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal val)
2744d71ae5a4SJacob Faibussowitsch {
2745e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
27468928b65cSHong Zhang 
27478928b65cSHong Zhang   PetscFunctionBegin;
2748413bcc21SPierre Jolivet   if (mumps->id.job == JOB_NULL) {
2749413bcc21SPierre Jolivet     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
27509371c9d4SSatish Balay     for (i = 0; i < nCNTL_pre; ++i)
27519371c9d4SSatish Balay       if (mumps->CNTL_pre[1 + 2 * i] == icntl) break;
2752413bcc21SPierre Jolivet     if (i == nCNTL_pre) {
2753413bcc21SPierre Jolivet       if (i > 0) PetscCall(PetscRealloc(sizeof(PetscReal) * (2 * nCNTL_pre + 3), &mumps->CNTL_pre));
2754413bcc21SPierre Jolivet       else PetscCall(PetscCalloc(sizeof(PetscReal) * 3, &mumps->CNTL_pre));
2755413bcc21SPierre Jolivet       mumps->CNTL_pre[0]++;
2756413bcc21SPierre Jolivet     }
2757413bcc21SPierre Jolivet     mumps->CNTL_pre[1 + 2 * i] = icntl;
2758413bcc21SPierre Jolivet     mumps->CNTL_pre[2 + 2 * i] = val;
2759413bcc21SPierre Jolivet   } else mumps->id.CNTL(icntl) = val;
27603ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
27618928b65cSHong Zhang }
27628928b65cSHong Zhang 
2763d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl_MUMPS(Mat F, PetscInt icntl, PetscReal *val)
2764d71ae5a4SJacob Faibussowitsch {
2765e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2766bc6112feSHong Zhang 
2767bc6112feSHong Zhang   PetscFunctionBegin;
276836df9881Sjeremy theler   if (mumps->id.job == JOB_NULL) {
276936df9881Sjeremy theler     PetscInt i, nCNTL_pre = mumps->CNTL_pre ? mumps->CNTL_pre[0] : 0;
277036df9881Sjeremy theler     *val = 0.0;
277136df9881Sjeremy theler     for (i = 0; i < nCNTL_pre; ++i) {
277236df9881Sjeremy theler       if (mumps->CNTL_pre[1 + 2 * i] == icntl) *val = mumps->CNTL_pre[2 + 2 * i];
277336df9881Sjeremy theler     }
277436df9881Sjeremy theler   } else *val = mumps->id.CNTL(icntl);
27753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2776bc6112feSHong Zhang }
2777bc6112feSHong Zhang 
27788928b65cSHong Zhang /*@
27798928b65cSHong Zhang   MatMumpsSetCntl - Set MUMPS parameter CNTL()
27808928b65cSHong Zhang 
2781c3339decSBarry Smith   Logically Collective
27828928b65cSHong Zhang 
27838928b65cSHong Zhang   Input Parameters:
278411a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
27858928b65cSHong Zhang . icntl - index of MUMPS parameter array CNTL()
27868928b65cSHong Zhang - val   - value of MUMPS CNTL(icntl)
27878928b65cSHong Zhang 
27883c7db156SBarry Smith   Options Database Key:
2789147403d9SBarry Smith . -mat_mumps_cntl_<icntl> <val> - change the option numbered icntl to ival
27908928b65cSHong Zhang 
27918928b65cSHong Zhang   Level: beginner
27928928b65cSHong Zhang 
279396a0c994SBarry Smith   References:
2794606c0280SSatish Balay .  * - MUMPS Users' Guide
27958928b65cSHong Zhang 
27961cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
27978928b65cSHong Zhang @*/
2798d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsSetCntl(Mat F, PetscInt icntl, PetscReal val)
2799d71ae5a4SJacob Faibussowitsch {
28008928b65cSHong Zhang   PetscFunctionBegin;
28012989dfd4SHong Zhang   PetscValidType(F, 1);
280228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
28038928b65cSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
2804bc6112feSHong Zhang   PetscValidLogicalCollectiveReal(F, val, 3);
2805413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2806cac4c232SBarry Smith   PetscTryMethod(F, "MatMumpsSetCntl_C", (Mat, PetscInt, PetscReal), (F, icntl, val));
28073ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
28088928b65cSHong Zhang }
28098928b65cSHong Zhang 
2810a21f80fcSHong Zhang /*@
2811a21f80fcSHong Zhang   MatMumpsGetCntl - Get MUMPS parameter CNTL()
2812a21f80fcSHong Zhang 
2813c3339decSBarry Smith   Logically Collective
2814a21f80fcSHong Zhang 
2815a21f80fcSHong Zhang   Input Parameters:
281611a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2817a21f80fcSHong Zhang - icntl - index of MUMPS parameter array CNTL()
2818a21f80fcSHong Zhang 
2819a21f80fcSHong Zhang   Output Parameter:
2820a21f80fcSHong Zhang . val - value of MUMPS CNTL(icntl)
2821a21f80fcSHong Zhang 
2822a21f80fcSHong Zhang   Level: beginner
2823a21f80fcSHong Zhang 
282496a0c994SBarry Smith   References:
2825606c0280SSatish Balay .  * - MUMPS Users' Guide
2826a21f80fcSHong Zhang 
28271cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
2828a21f80fcSHong Zhang @*/
2829d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetCntl(Mat F, PetscInt icntl, PetscReal *val)
2830d71ae5a4SJacob Faibussowitsch {
2831bc6112feSHong Zhang   PetscFunctionBegin;
28322989dfd4SHong Zhang   PetscValidType(F, 1);
283328b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2834bc6112feSHong Zhang   PetscValidLogicalCollectiveInt(F, icntl, 2);
28354f572ea9SToby Isaac   PetscAssertPointer(val, 3);
2836413bcc21SPierre Jolivet   PetscCheck(icntl >= 1 && icntl <= 7, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONG, "Unsupported CNTL value %" PetscInt_FMT, icntl);
2837cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetCntl_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
28383ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2839bc6112feSHong Zhang }
2840bc6112feSHong Zhang 
2841d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo_MUMPS(Mat F, PetscInt icntl, PetscInt *info)
2842d71ae5a4SJacob Faibussowitsch {
2843e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2844bc6112feSHong Zhang 
2845bc6112feSHong Zhang   PetscFunctionBegin;
2846bc6112feSHong Zhang   *info = mumps->id.INFO(icntl);
28473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2848bc6112feSHong Zhang }
2849bc6112feSHong Zhang 
2850d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog_MUMPS(Mat F, PetscInt icntl, PetscInt *infog)
2851d71ae5a4SJacob Faibussowitsch {
2852e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2853bc6112feSHong Zhang 
2854bc6112feSHong Zhang   PetscFunctionBegin;
2855bc6112feSHong Zhang   *infog = mumps->id.INFOG(icntl);
28563ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2857bc6112feSHong Zhang }
2858bc6112feSHong Zhang 
2859d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfo)
2860d71ae5a4SJacob Faibussowitsch {
2861e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2862bc6112feSHong Zhang 
2863bc6112feSHong Zhang   PetscFunctionBegin;
2864bc6112feSHong Zhang   *rinfo = mumps->id.RINFO(icntl);
28653ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2866bc6112feSHong Zhang }
2867bc6112feSHong Zhang 
2868d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog_MUMPS(Mat F, PetscInt icntl, PetscReal *rinfog)
2869d71ae5a4SJacob Faibussowitsch {
2870e69c285eSBarry Smith   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
2871bc6112feSHong Zhang 
2872bc6112feSHong Zhang   PetscFunctionBegin;
2873bc6112feSHong Zhang   *rinfog = mumps->id.RINFOG(icntl);
28743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2875bc6112feSHong Zhang }
2876bc6112feSHong Zhang 
28775c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots_MUMPS(Mat F, PetscInt *size, PetscInt **array)
28785c0bae8cSAshish Patel {
28795c0bae8cSAshish Patel   Mat_MUMPS *mumps = (Mat_MUMPS *)F->data;
28805c0bae8cSAshish Patel 
28815c0bae8cSAshish Patel   PetscFunctionBegin;
28825c0bae8cSAshish 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");
28835c0bae8cSAshish Patel   *size  = 0;
28845c0bae8cSAshish Patel   *array = NULL;
28855c0bae8cSAshish Patel   if (!mumps->myid) {
28865c0bae8cSAshish Patel     *size = mumps->id.INFOG(28);
28875c0bae8cSAshish Patel     PetscCall(PetscMalloc1(*size, array));
28885c0bae8cSAshish Patel     for (int i = 0; i < *size; i++) (*array)[i] = mumps->id.pivnul_list[i] - 1;
28895c0bae8cSAshish Patel   }
28905c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
28915c0bae8cSAshish Patel }
28925c0bae8cSAshish Patel 
2893d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse_MUMPS(Mat F, Mat spRHS)
2894d71ae5a4SJacob Faibussowitsch {
28950e6b8875SHong Zhang   Mat          Bt = NULL, Btseq = NULL;
28960e6b8875SHong Zhang   PetscBool    flg;
2897bb599dfdSHong Zhang   Mat_MUMPS   *mumps = (Mat_MUMPS *)F->data;
2898bb599dfdSHong Zhang   PetscScalar *aa;
2899f410b75aSHong Zhang   PetscInt     spnr, *ia, *ja, M, nrhs;
2900bb599dfdSHong Zhang 
2901bb599dfdSHong Zhang   PetscFunctionBegin;
29024f572ea9SToby Isaac   PetscAssertPointer(spRHS, 2);
2903013e2dc7SBarry Smith   PetscCall(PetscObjectTypeCompare((PetscObject)spRHS, MATTRANSPOSEVIRTUAL, &flg));
29040e6b8875SHong Zhang   if (flg) {
29059566063dSJacob Faibussowitsch     PetscCall(MatTransposeGetMat(spRHS, &Bt));
2906013e2dc7SBarry Smith   } else SETERRQ(PetscObjectComm((PetscObject)spRHS), PETSC_ERR_ARG_WRONG, "Matrix spRHS must be type MATTRANSPOSEVIRTUAL matrix");
2907bb599dfdSHong Zhang 
29089566063dSJacob Faibussowitsch   PetscCall(MatMumpsSetIcntl(F, 30, 1));
2909bb599dfdSHong Zhang 
29102d4298aeSJunchao Zhang   if (mumps->petsc_size > 1) {
29110e6b8875SHong Zhang     Mat_MPIAIJ *b = (Mat_MPIAIJ *)Bt->data;
29120e6b8875SHong Zhang     Btseq         = b->A;
29130e6b8875SHong Zhang   } else {
29140e6b8875SHong Zhang     Btseq = Bt;
29150e6b8875SHong Zhang   }
29160e6b8875SHong Zhang 
29179566063dSJacob Faibussowitsch   PetscCall(MatGetSize(spRHS, &M, &nrhs));
2918f410b75aSHong Zhang   mumps->id.nrhs = nrhs;
2919f410b75aSHong Zhang   mumps->id.lrhs = M;
2920f410b75aSHong Zhang   mumps->id.rhs  = NULL;
2921f410b75aSHong Zhang 
2922e3f2db6aSHong Zhang   if (!mumps->myid) {
29239566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJGetArray(Btseq, &aa));
29249566063dSJacob Faibussowitsch     PetscCall(MatGetRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
292528b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
29269566063dSJacob Faibussowitsch     PetscCall(PetscMUMPSIntCSRCast(mumps, spnr, ia, ja, &mumps->id.irhs_ptr, &mumps->id.irhs_sparse, &mumps->id.nz_rhs));
2927bb599dfdSHong Zhang     mumps->id.rhs_sparse = (MumpsScalar *)aa;
2928e3f2db6aSHong Zhang   } else {
2929e3f2db6aSHong Zhang     mumps->id.irhs_ptr    = NULL;
2930e3f2db6aSHong Zhang     mumps->id.irhs_sparse = NULL;
2931e3f2db6aSHong Zhang     mumps->id.nz_rhs      = 0;
2932e3f2db6aSHong Zhang     mumps->id.rhs_sparse  = NULL;
2933e3f2db6aSHong Zhang   }
2934bb599dfdSHong Zhang   mumps->id.ICNTL(20) = 1; /* rhs is sparse */
2935e3f2db6aSHong Zhang   mumps->id.ICNTL(21) = 0; /* solution is in assembled centralized format */
2936bb599dfdSHong Zhang 
2937bb599dfdSHong Zhang   /* solve phase */
2938bb599dfdSHong Zhang   mumps->id.job = JOB_SOLVE;
29393ab56b82SJunchao Zhang   PetscMUMPS_c(mumps);
29409261f6e4SBarry 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));
294114267174SHong Zhang 
2942e3f2db6aSHong Zhang   if (!mumps->myid) {
29439566063dSJacob Faibussowitsch     PetscCall(MatSeqAIJRestoreArray(Btseq, &aa));
29449566063dSJacob Faibussowitsch     PetscCall(MatRestoreRowIJ(Btseq, 1, PETSC_FALSE, PETSC_FALSE, &spnr, (const PetscInt **)&ia, (const PetscInt **)&ja, &flg));
294528b400f6SJacob Faibussowitsch     PetscCheck(flg, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONG, "Cannot get IJ structure");
2946e3f2db6aSHong Zhang   }
29473ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2948bb599dfdSHong Zhang }
2949bb599dfdSHong Zhang 
2950bb599dfdSHong Zhang /*@
29512ef1f0ffSBarry Smith   MatMumpsGetInverse - Get user-specified set of entries in inverse of `A`
2952bb599dfdSHong Zhang 
2953c3339decSBarry Smith   Logically Collective
2954bb599dfdSHong Zhang 
295520f4b53cSBarry Smith   Input Parameter:
295620f4b53cSBarry Smith . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
2957bb599dfdSHong Zhang 
2958bb599dfdSHong Zhang   Output Parameter:
295920f4b53cSBarry Smith . spRHS - sequential sparse matrix in `MATTRANSPOSEVIRTUAL` format with requested entries of inverse of `A`
2960bb599dfdSHong Zhang 
2961bb599dfdSHong Zhang   Level: beginner
2962bb599dfdSHong Zhang 
2963bb599dfdSHong Zhang   References:
2964606c0280SSatish Balay .  * - MUMPS Users' Guide
2965bb599dfdSHong Zhang 
29661cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`
2967bb599dfdSHong Zhang @*/
2968d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverse(Mat F, Mat spRHS)
2969d71ae5a4SJacob Faibussowitsch {
2970bb599dfdSHong Zhang   PetscFunctionBegin;
2971bb599dfdSHong Zhang   PetscValidType(F, 1);
297228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
2973cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverse_C", (Mat, Mat), (F, spRHS));
29743ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
2975bb599dfdSHong Zhang }
2976bb599dfdSHong Zhang 
2977d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose_MUMPS(Mat F, Mat spRHST)
2978d71ae5a4SJacob Faibussowitsch {
29790e6b8875SHong Zhang   Mat spRHS;
29800e6b8875SHong Zhang 
29810e6b8875SHong Zhang   PetscFunctionBegin;
29829566063dSJacob Faibussowitsch   PetscCall(MatCreateTranspose(spRHST, &spRHS));
29839566063dSJacob Faibussowitsch   PetscCall(MatMumpsGetInverse_MUMPS(F, spRHS));
29849566063dSJacob Faibussowitsch   PetscCall(MatDestroy(&spRHS));
29853ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
29860e6b8875SHong Zhang }
29870e6b8875SHong Zhang 
29880e6b8875SHong Zhang /*@
29892ef1f0ffSBarry Smith   MatMumpsGetInverseTranspose - Get user-specified set of entries in inverse of matrix `A`^T
29900e6b8875SHong Zhang 
2991c3339decSBarry Smith   Logically Collective
29920e6b8875SHong Zhang 
299320f4b53cSBarry Smith   Input Parameter:
299420f4b53cSBarry Smith . F - the factored matrix of A obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
29950e6b8875SHong Zhang 
29960e6b8875SHong Zhang   Output Parameter:
299720f4b53cSBarry Smith . spRHST - sequential sparse matrix in `MATAIJ` format containing the requested entries of inverse of `A`^T
29980e6b8875SHong Zhang 
29990e6b8875SHong Zhang   Level: beginner
30000e6b8875SHong Zhang 
30010e6b8875SHong Zhang   References:
3002606c0280SSatish Balay .  * - MUMPS Users' Guide
30030e6b8875SHong Zhang 
30041cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatCreateTranspose()`, `MatMumpsGetInverse()`
30050e6b8875SHong Zhang @*/
3006d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInverseTranspose(Mat F, Mat spRHST)
3007d71ae5a4SJacob Faibussowitsch {
30080e6b8875SHong Zhang   PetscBool flg;
30090e6b8875SHong Zhang 
30100e6b8875SHong Zhang   PetscFunctionBegin;
30110e6b8875SHong Zhang   PetscValidType(F, 1);
301228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30139566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompareAny((PetscObject)spRHST, &flg, MATSEQAIJ, MATMPIAIJ, NULL));
301428b400f6SJacob Faibussowitsch   PetscCheck(flg, PetscObjectComm((PetscObject)spRHST), PETSC_ERR_ARG_WRONG, "Matrix spRHST must be MATAIJ matrix");
30150e6b8875SHong Zhang 
3016cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInverseTranspose_C", (Mat, Mat), (F, spRHST));
30173ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
30180e6b8875SHong Zhang }
30190e6b8875SHong Zhang 
3020a21f80fcSHong Zhang /*@
3021a21f80fcSHong Zhang   MatMumpsGetInfo - Get MUMPS parameter INFO()
3022a21f80fcSHong Zhang 
3023c3339decSBarry Smith   Logically Collective
3024a21f80fcSHong Zhang 
3025a21f80fcSHong Zhang   Input Parameters:
302611a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3027a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFO()
3028a21f80fcSHong Zhang 
3029a21f80fcSHong Zhang   Output Parameter:
3030a21f80fcSHong Zhang . ival - value of MUMPS INFO(icntl)
3031a21f80fcSHong Zhang 
3032a21f80fcSHong Zhang   Level: beginner
3033a21f80fcSHong Zhang 
303496a0c994SBarry Smith   References:
3035606c0280SSatish Balay .  * - MUMPS Users' Guide
3036a21f80fcSHong Zhang 
30371cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3038a21f80fcSHong Zhang @*/
3039d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfo(Mat F, PetscInt icntl, PetscInt *ival)
3040d71ae5a4SJacob Faibussowitsch {
3041bc6112feSHong Zhang   PetscFunctionBegin;
30422989dfd4SHong Zhang   PetscValidType(F, 1);
304328b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30444f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3045cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfo_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
30463ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3047bc6112feSHong Zhang }
3048bc6112feSHong Zhang 
3049a21f80fcSHong Zhang /*@
3050a21f80fcSHong Zhang   MatMumpsGetInfog - Get MUMPS parameter INFOG()
3051a21f80fcSHong Zhang 
3052c3339decSBarry Smith   Logically Collective
3053a21f80fcSHong Zhang 
3054a21f80fcSHong Zhang   Input Parameters:
305511a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3056a21f80fcSHong Zhang - icntl - index of MUMPS parameter array INFOG()
3057a21f80fcSHong Zhang 
3058a21f80fcSHong Zhang   Output Parameter:
3059a21f80fcSHong Zhang . ival - value of MUMPS INFOG(icntl)
3060a21f80fcSHong Zhang 
3061a21f80fcSHong Zhang   Level: beginner
3062a21f80fcSHong Zhang 
306396a0c994SBarry Smith   References:
3064606c0280SSatish Balay .  * - MUMPS Users' Guide
3065a21f80fcSHong Zhang 
30661cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`
3067a21f80fcSHong Zhang @*/
3068d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetInfog(Mat F, PetscInt icntl, PetscInt *ival)
3069d71ae5a4SJacob Faibussowitsch {
3070bc6112feSHong Zhang   PetscFunctionBegin;
30712989dfd4SHong Zhang   PetscValidType(F, 1);
307228b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
30734f572ea9SToby Isaac   PetscAssertPointer(ival, 3);
3074cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetInfog_C", (Mat, PetscInt, PetscInt *), (F, icntl, ival));
30753ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3076bc6112feSHong Zhang }
3077bc6112feSHong Zhang 
3078a21f80fcSHong Zhang /*@
3079a21f80fcSHong Zhang   MatMumpsGetRinfo - Get MUMPS parameter RINFO()
3080a21f80fcSHong Zhang 
3081c3339decSBarry Smith   Logically Collective
3082a21f80fcSHong Zhang 
3083a21f80fcSHong Zhang   Input Parameters:
308411a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3085a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFO()
3086a21f80fcSHong Zhang 
3087a21f80fcSHong Zhang   Output Parameter:
3088a21f80fcSHong Zhang . val - value of MUMPS RINFO(icntl)
3089a21f80fcSHong Zhang 
3090a21f80fcSHong Zhang   Level: beginner
3091a21f80fcSHong Zhang 
309296a0c994SBarry Smith   References:
3093606c0280SSatish Balay .  * - MUMPS Users' Guide
3094a21f80fcSHong Zhang 
30951cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfog()`
3096a21f80fcSHong Zhang @*/
3097d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfo(Mat F, PetscInt icntl, PetscReal *val)
3098d71ae5a4SJacob Faibussowitsch {
3099bc6112feSHong Zhang   PetscFunctionBegin;
31002989dfd4SHong Zhang   PetscValidType(F, 1);
310128b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31024f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3103cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfo_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31043ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3105bc6112feSHong Zhang }
3106bc6112feSHong Zhang 
3107a21f80fcSHong Zhang /*@
3108a21f80fcSHong Zhang   MatMumpsGetRinfog - Get MUMPS parameter RINFOG()
3109a21f80fcSHong Zhang 
3110c3339decSBarry Smith   Logically Collective
3111a21f80fcSHong Zhang 
3112a21f80fcSHong Zhang   Input Parameters:
311311a5261eSBarry Smith + F     - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
3114a21f80fcSHong Zhang - icntl - index of MUMPS parameter array RINFOG()
3115a21f80fcSHong Zhang 
3116a21f80fcSHong Zhang   Output Parameter:
3117a21f80fcSHong Zhang . val - value of MUMPS RINFOG(icntl)
3118a21f80fcSHong Zhang 
3119a21f80fcSHong Zhang   Level: beginner
3120a21f80fcSHong Zhang 
312196a0c994SBarry Smith   References:
3122606c0280SSatish Balay .  * - MUMPS Users' Guide
3123a21f80fcSHong Zhang 
31241cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
3125a21f80fcSHong Zhang @*/
3126d71ae5a4SJacob Faibussowitsch PetscErrorCode MatMumpsGetRinfog(Mat F, PetscInt icntl, PetscReal *val)
3127d71ae5a4SJacob Faibussowitsch {
3128bc6112feSHong Zhang   PetscFunctionBegin;
31292989dfd4SHong Zhang   PetscValidType(F, 1);
313028b400f6SJacob Faibussowitsch   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31314f572ea9SToby Isaac   PetscAssertPointer(val, 3);
3132cac4c232SBarry Smith   PetscUseMethod(F, "MatMumpsGetRinfog_C", (Mat, PetscInt, PetscReal *), (F, icntl, val));
31333ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3134bc6112feSHong Zhang }
3135bc6112feSHong Zhang 
31365c0bae8cSAshish Patel /*@
31375c0bae8cSAshish Patel   MatMumpsGetNullPivots - Get MUMPS parameter PIVNUL_LIST()
31385c0bae8cSAshish Patel 
31395c0bae8cSAshish Patel   Logically Collective
31405c0bae8cSAshish Patel 
31415c0bae8cSAshish Patel   Input Parameter:
31425c0bae8cSAshish Patel . F - the factored matrix obtained by calling `MatGetFactor()` from PETSc-MUMPS interface
31435c0bae8cSAshish Patel 
31445c0bae8cSAshish Patel   Output Parameters:
31455c0bae8cSAshish Patel + size  - local size of the array. The size of the array is non-zero only on the host.
31465c0bae8cSAshish 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
31475c0bae8cSAshish Patel            for freeing this array.
31485c0bae8cSAshish Patel 
31495c0bae8cSAshish Patel   Level: beginner
31505c0bae8cSAshish Patel 
31515c0bae8cSAshish Patel   References:
31525c0bae8cSAshish Patel .  * - MUMPS Users' Guide
31535c0bae8cSAshish Patel 
31541cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `MatGetFactor()`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`
31555c0bae8cSAshish Patel @*/
31565c0bae8cSAshish Patel PetscErrorCode MatMumpsGetNullPivots(Mat F, PetscInt *size, PetscInt **array)
31575c0bae8cSAshish Patel {
31585c0bae8cSAshish Patel   PetscFunctionBegin;
31595c0bae8cSAshish Patel   PetscValidType(F, 1);
31605c0bae8cSAshish Patel   PetscCheck(F->factortype, PetscObjectComm((PetscObject)F), PETSC_ERR_ARG_WRONGSTATE, "Only for factored matrix");
31614f572ea9SToby Isaac   PetscAssertPointer(size, 2);
31624f572ea9SToby Isaac   PetscAssertPointer(array, 3);
31635c0bae8cSAshish Patel   PetscUseMethod(F, "MatMumpsGetNullPivots_C", (Mat, PetscInt *, PetscInt **), (F, size, array));
31645c0bae8cSAshish Patel   PetscFunctionReturn(PETSC_SUCCESS);
31655c0bae8cSAshish Patel }
31665c0bae8cSAshish Patel 
316724b6179bSKris Buschelman /*MC
31682692d6eeSBarry Smith   MATSOLVERMUMPS -  A matrix type providing direct solvers (LU and Cholesky) for
316924b6179bSKris Buschelman   distributed and sequential matrices via the external package MUMPS.
317024b6179bSKris Buschelman 
317111a5261eSBarry Smith   Works with `MATAIJ` and `MATSBAIJ` matrices
317224b6179bSKris Buschelman 
3173c2b89b5dSBarry Smith   Use ./configure --download-mumps --download-scalapack --download-parmetis --download-metis --download-ptscotch to have PETSc installed with MUMPS
3174c2b89b5dSBarry Smith 
31752ef1f0ffSBarry 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.
31762ef1f0ffSBarry Smith   See details below.
3177217d3b1eSJunchao Zhang 
31782ef1f0ffSBarry Smith   Use `-pc_type cholesky` or `lu` `-pc_factor_mat_solver_type mumps` to use this direct solver
3179c2b89b5dSBarry Smith 
318024b6179bSKris Buschelman   Options Database Keys:
31814422a9fcSPatrick Sanan +  -mat_mumps_icntl_1 - ICNTL(1): output stream for error messages
31824422a9fcSPatrick Sanan .  -mat_mumps_icntl_2 - ICNTL(2): output stream for diagnostic printing, statistics, and warning
31834422a9fcSPatrick Sanan .  -mat_mumps_icntl_3 -  ICNTL(3): output stream for global information, collected on the host
31844422a9fcSPatrick Sanan .  -mat_mumps_icntl_4 -  ICNTL(4): level of printing (0 to 4)
31854422a9fcSPatrick Sanan .  -mat_mumps_icntl_6 - ICNTL(6): permutes to a zero-free diagonal and/or scale the matrix (0 to 7)
3186b53c1a7fSBarry 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
3187b53c1a7fSBarry Smith                         Use -pc_factor_mat_ordering_type <type> to have PETSc perform the ordering (sequential only)
31884422a9fcSPatrick Sanan .  -mat_mumps_icntl_8  - ICNTL(8): scaling strategy (-2 to 8 or 77)
31894422a9fcSPatrick Sanan .  -mat_mumps_icntl_10  - ICNTL(10): max num of refinements
31904422a9fcSPatrick Sanan .  -mat_mumps_icntl_11  - ICNTL(11): statistics related to an error analysis (via -ksp_view)
31914422a9fcSPatrick Sanan .  -mat_mumps_icntl_12  - ICNTL(12): an ordering strategy for symmetric matrices (0 to 3)
31924422a9fcSPatrick Sanan .  -mat_mumps_icntl_13  - ICNTL(13): parallelism of the root node (enable ScaLAPACK) and its splitting
31934422a9fcSPatrick Sanan .  -mat_mumps_icntl_14  - ICNTL(14): percentage increase in the estimated working space
319445e3843bSPierre Jolivet .  -mat_mumps_icntl_15  - ICNTL(15): compression of the input matrix resulting from a block format
31954422a9fcSPatrick Sanan .  -mat_mumps_icntl_19  - ICNTL(19): computes the Schur complement
319625aac85cSJunchao Zhang .  -mat_mumps_icntl_20  - ICNTL(20): give MUMPS centralized (0) or distributed (10) dense RHS
31974422a9fcSPatrick Sanan .  -mat_mumps_icntl_22  - ICNTL(22): in-core/out-of-core factorization and solve (0 or 1)
31984422a9fcSPatrick Sanan .  -mat_mumps_icntl_23  - ICNTL(23): max size of the working memory (MB) that can allocate per processor
31994422a9fcSPatrick Sanan .  -mat_mumps_icntl_24  - ICNTL(24): detection of null pivot rows (0 or 1)
32004422a9fcSPatrick Sanan .  -mat_mumps_icntl_25  - ICNTL(25): compute a solution of a deficient matrix and a null space basis
32014422a9fcSPatrick Sanan .  -mat_mumps_icntl_26  - ICNTL(26): drives the solution phase if a Schur complement matrix
32024422a9fcSPatrick 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
32034422a9fcSPatrick Sanan .  -mat_mumps_icntl_29 - ICNTL(29): parallel ordering 1 = ptscotch, 2 = parmetis
32044422a9fcSPatrick Sanan .  -mat_mumps_icntl_30 - ICNTL(30): compute user-specified set of entries in inv(A)
32054422a9fcSPatrick Sanan .  -mat_mumps_icntl_31 - ICNTL(31): indicates which factors may be discarded during factorization
32064422a9fcSPatrick Sanan .  -mat_mumps_icntl_33 - ICNTL(33): compute determinant
3207a0e18203SThibaut Appel .  -mat_mumps_icntl_35 - ICNTL(35): level of activation of BLR (Block Low-Rank) feature
3208a0e18203SThibaut Appel .  -mat_mumps_icntl_36 - ICNTL(36): controls the choice of BLR factorization variant
3209a0e18203SThibaut Appel .  -mat_mumps_icntl_38 - ICNTL(38): sets the estimated compression rate of LU factors with BLR
3210146931dbSPierre Jolivet .  -mat_mumps_icntl_58 - ICNTL(58): options for symbolic factorization
32114422a9fcSPatrick Sanan .  -mat_mumps_cntl_1  - CNTL(1): relative pivoting threshold
32124422a9fcSPatrick Sanan .  -mat_mumps_cntl_2  -  CNTL(2): stopping criterion of refinement
32134422a9fcSPatrick Sanan .  -mat_mumps_cntl_3 - CNTL(3): absolute pivoting threshold
32144422a9fcSPatrick Sanan .  -mat_mumps_cntl_4 - CNTL(4): value for static pivoting
3215217d3b1eSJunchao Zhang .  -mat_mumps_cntl_5 - CNTL(5): fixation for null pivots
3216a0e18203SThibaut Appel .  -mat_mumps_cntl_7 - CNTL(7): precision of the dropping parameter used during BLR factorization
3217217d3b1eSJunchao 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.
3218217d3b1eSJunchao Zhang                                    Default might be the number of cores per CPU package (socket) as reported by hwloc and suggested by the MUMPS manual.
321924b6179bSKris Buschelman 
322024b6179bSKris Buschelman   Level: beginner
322124b6179bSKris Buschelman 
322295452b02SPatrick Sanan     Notes:
32232ef1f0ffSBarry 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
32242ef1f0ffSBarry Smith     error if the matrix is Hermitian.
322538548759SBarry Smith 
322626cc229bSBarry 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
322726cc229bSBarry Smith     `MatSetOptionsPrefixFactor()` on the matrix from which the factor was obtained or `MatSetOptionsPrefix()` on the factor matrix.
322826cc229bSBarry Smith 
32292ef1f0ffSBarry 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
32302ef1f0ffSBarry Smith     the failure with
32312ef1f0ffSBarry Smith .vb
32322ef1f0ffSBarry Smith           KSPGetPC(ksp,&pc);
32332ef1f0ffSBarry Smith           PCFactorGetMatrix(pc,&mat);
32342ef1f0ffSBarry Smith           MatMumpsGetInfo(mat,....);
32352ef1f0ffSBarry Smith           MatMumpsGetInfog(mat,....); etc.
32362ef1f0ffSBarry Smith .ve
32372ef1f0ffSBarry Smith     Or run with `-ksp_error_if_not_converged` and the program will be stopped and the information printed in the error message.
32389fc87aa7SBarry Smith 
3239a5399872SJunchao Zhang     MUMPS provides 64-bit integer support in two build modes:
3240a5399872SJunchao Zhang       full 64-bit: here MUMPS is built with C preprocessing flag -DINTSIZE64 and Fortran compiler option -i8, -fdefault-integer-8 or equivalent, and
3241a5399872SJunchao 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).
32428fcaa860SBarry Smith 
3243a5399872SJunchao 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,
3244a5399872SJunchao 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
3245a5399872SJunchao 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
3246a5399872SJunchao Zhang       integer) build of all dependent libraries MPI, ScaLAPACK, LAPACK and BLAS.
3247a5399872SJunchao Zhang 
3248a5399872SJunchao 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.
3249a5399872SJunchao Zhang 
3250a5399872SJunchao Zhang   Two modes to run MUMPS/PETSc with OpenMP
32512ef1f0ffSBarry Smith .vb
32522ef1f0ffSBarry Smith      Set OMP_NUM_THREADS and run with fewer MPI ranks than cores. For example, if you want to have 16 OpenMP
32532ef1f0ffSBarry Smith      threads per rank, then you may use "export OMP_NUM_THREADS=16 && mpirun -n 4 ./test".
32542ef1f0ffSBarry Smith .ve
32558fcaa860SBarry Smith 
32562ef1f0ffSBarry Smith .vb
32572ef1f0ffSBarry Smith      -mat_mumps_use_omp_threads [m] and run your code with as many MPI ranks as the number of cores. For example,
32582ef1f0ffSBarry 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"
32592ef1f0ffSBarry Smith .ve
32608fcaa860SBarry Smith 
32618fcaa860SBarry Smith    To run MUMPS in MPI+OpenMP hybrid mode (i.e., enable multithreading in MUMPS), but still run the non-MUMPS part
32622ef1f0ffSBarry 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`
32632ef1f0ffSBarry 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
32648fcaa860SBarry Smith    libraries, to really get performance, you should have multithreaded BLAS libraries such as Intel MKL, AMD ACML, Cray libSci or OpenBLAS
32658fcaa860SBarry Smith    (PETSc will automatically try to utilized a threaded BLAS if --with-openmp is provided).
3266217d3b1eSJunchao Zhang 
32678fcaa860SBarry 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
3268217d3b1eSJunchao Zhang    processes on each compute node. Listing the processes in rank ascending order, we split processes on a node into consecutive groups of
3269217d3b1eSJunchao 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
3270217d3b1eSJunchao 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
3271217d3b1eSJunchao 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.
3272217d3b1eSJunchao 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,
3273217d3b1eSJunchao 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
3274217d3b1eSJunchao 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
3275217d3b1eSJunchao 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
3276217d3b1eSJunchao 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.
32778fcaa860SBarry 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
3278217d3b1eSJunchao Zhang    examine the mapping result.
3279217d3b1eSJunchao Zhang 
328011a5261eSBarry 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,
328111a5261eSBarry 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
328211a5261eSBarry Smith    calls `omp_set_num_threads`(m) internally before calling MUMPS.
3283217d3b1eSJunchao Zhang 
3284217d3b1eSJunchao Zhang    References:
3285606c0280SSatish Balay +  * - Heroux, Michael A., R. Brightwell, and Michael M. Wolf. "Bi-modal MPI and MPI+ threads computing on scalable multicore systems." IJHPCA (Submitted) (2011).
3286606c0280SSatish 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.
3287217d3b1eSJunchao Zhang 
32881cc06b55SBarry Smith .seealso: [](ch_matrices), `Mat`, `PCFactorSetMatSolverType()`, `MatSolverType`, `MatMumpsSetIcntl()`, `MatMumpsGetIcntl()`, `MatMumpsSetCntl()`, `MatMumpsGetCntl()`, `MatMumpsGetInfo()`, `MatMumpsGetInfog()`, `MatMumpsGetRinfo()`, `MatMumpsGetRinfog()`, `KSPGetPC()`, `PCFactorGetMatrix()`
328924b6179bSKris Buschelman M*/
329024b6179bSKris Buschelman 
3291d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatFactorGetSolverType_mumps(Mat A, MatSolverType *type)
3292d71ae5a4SJacob Faibussowitsch {
329335bd34faSBarry Smith   PetscFunctionBegin;
32942692d6eeSBarry Smith   *type = MATSOLVERMUMPS;
32953ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
329635bd34faSBarry Smith }
329735bd34faSBarry Smith 
3298bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI AIJ matrices */
3299d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_aij_mumps(Mat A, MatFactorType ftype, Mat *F)
3300d71ae5a4SJacob Faibussowitsch {
33012877fffaSHong Zhang   Mat         B;
33022877fffaSHong Zhang   Mat_MUMPS  *mumps;
3303ace3abfcSBarry Smith   PetscBool   isSeqAIJ;
33042c7c0729SBarry Smith   PetscMPIInt size;
33052877fffaSHong Zhang 
33062877fffaSHong Zhang   PetscFunctionBegin;
3307eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
330803e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
330903e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
331003e5aca4SStefano Zampini     *F = NULL;
331103e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
331203e5aca4SStefano Zampini   }
3313eb1ec7c1SStefano Zampini #endif
33142877fffaSHong Zhang   /* Create the factorization matrix */
33159566063dSJacob Faibussowitsch   PetscCall(PetscObjectBaseTypeCompare((PetscObject)A, MATSEQAIJ, &isSeqAIJ));
33169566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
33179566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
33189566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
33199566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
33202877fffaSHong Zhang 
33214dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
33222205254eSKarl Rupp 
33232877fffaSHong Zhang   B->ops->view    = MatView_MUMPS;
332435bd34faSBarry Smith   B->ops->getinfo = MatGetInfo_MUMPS;
33252205254eSKarl Rupp 
33269566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
33279566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
33289566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
33299566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
33309566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
33319566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
33329566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
33339566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
33349566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
33359566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
33369566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
33375c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
33389566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
33399566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
33406444a565SStefano Zampini 
3341450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3342450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
3343d5f3da31SBarry Smith     B->factortype            = MAT_FACTOR_LU;
3344bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqaij;
3345bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpiaij;
33469566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3347746480a1SHong Zhang     mumps->sym = 0;
3348dcd589f8SShri Abhyankar   } else {
334967877ebaSShri Abhyankar     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3350450b117fSShri Abhyankar     B->factortype                  = MAT_FACTOR_CHOLESKY;
3351bccb9932SShri Abhyankar     if (isSeqAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqaij_seqsbaij;
3352bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpiaij_mpisbaij;
33539566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
335459ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
335559ac8732SStefano Zampini     mumps->sym = 2;
335659ac8732SStefano Zampini #else
3357b94d7dedSBarry Smith     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
33586fdc2a6dSBarry Smith     else mumps->sym = 2;
335959ac8732SStefano Zampini #endif
3360450b117fSShri Abhyankar   }
33612877fffaSHong Zhang 
336200c67f3bSHong Zhang   /* set solvertype */
33639566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
33649566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
33659566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
33662c7c0729SBarry Smith   if (size == 1) {
33674ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3368f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
33692c7c0729SBarry Smith   }
33702877fffaSHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3371e69c285eSBarry Smith   B->data         = (void *)mumps;
33722205254eSKarl Rupp 
33732877fffaSHong Zhang   *F               = B;
3374413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3375413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3376413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3377d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
33783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
33792877fffaSHong Zhang }
33802877fffaSHong Zhang 
3381bccb9932SShri Abhyankar /* MatGetFactor for Seq and MPI SBAIJ matrices */
3382d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sbaij_mumps(Mat A, MatFactorType ftype, Mat *F)
3383d71ae5a4SJacob Faibussowitsch {
33842877fffaSHong Zhang   Mat         B;
33852877fffaSHong Zhang   Mat_MUMPS  *mumps;
3386ace3abfcSBarry Smith   PetscBool   isSeqSBAIJ;
33872c7c0729SBarry Smith   PetscMPIInt size;
33882877fffaSHong Zhang 
33892877fffaSHong Zhang   PetscFunctionBegin;
3390eb1ec7c1SStefano Zampini #if defined(PETSC_USE_COMPLEX)
339103e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
339203e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
339303e5aca4SStefano Zampini     *F = NULL;
339403e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
339503e5aca4SStefano Zampini   }
3396eb1ec7c1SStefano Zampini #endif
33979566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
33989566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
33999566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
34009566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3401e69c285eSBarry Smith 
34024dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
34039566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSBAIJ, &isSeqSBAIJ));
3404bccb9932SShri Abhyankar   if (isSeqSBAIJ) {
340516ebf90aSShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_seqsbaij_seqsbaij;
3406dcd589f8SShri Abhyankar   } else {
3407bccb9932SShri Abhyankar     mumps->ConvertToTriples = MatConvertToTriples_mpisbaij_mpisbaij;
3408bccb9932SShri Abhyankar   }
3409bccb9932SShri Abhyankar 
341067877ebaSShri Abhyankar   B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
3411bccb9932SShri Abhyankar   B->ops->view                   = MatView_MUMPS;
3412722b6324SPierre Jolivet   B->ops->getinfo                = MatGetInfo_MUMPS;
34132205254eSKarl Rupp 
34149566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
34159566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
34169566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
34179566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
34189566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
34199566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
34209566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
34219566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
34229566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
34239566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
34249566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
34255c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
34269566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
34279566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
34282205254eSKarl Rupp 
3429f4762488SHong Zhang   B->factortype = MAT_FACTOR_CHOLESKY;
343059ac8732SStefano Zampini #if defined(PETSC_USE_COMPLEX)
343159ac8732SStefano Zampini   mumps->sym = 2;
343259ac8732SStefano Zampini #else
3433b94d7dedSBarry Smith   if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
34346fdc2a6dSBarry Smith   else mumps->sym = 2;
343559ac8732SStefano Zampini #endif
3436a214ac2aSShri Abhyankar 
343700c67f3bSHong Zhang   /* set solvertype */
34389566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
34399566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
34409566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
34412c7c0729SBarry Smith   if (size == 1) {
34424ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3443f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
34442c7c0729SBarry Smith   }
34459566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_CHOLESKY]));
3446f3c0ef26SHong Zhang   B->ops->destroy = MatDestroy_MUMPS;
3447e69c285eSBarry Smith   B->data         = (void *)mumps;
34482205254eSKarl Rupp 
34492877fffaSHong Zhang   *F               = B;
3450413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3451413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3452413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3453d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
34543ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
34552877fffaSHong Zhang }
345697969023SHong Zhang 
3457d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_baij_mumps(Mat A, MatFactorType ftype, Mat *F)
3458d71ae5a4SJacob Faibussowitsch {
345967877ebaSShri Abhyankar   Mat         B;
346067877ebaSShri Abhyankar   Mat_MUMPS  *mumps;
3461ace3abfcSBarry Smith   PetscBool   isSeqBAIJ;
34622c7c0729SBarry Smith   PetscMPIInt size;
346367877ebaSShri Abhyankar 
346467877ebaSShri Abhyankar   PetscFunctionBegin;
346567877ebaSShri Abhyankar   /* Create the factorization matrix */
34669566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQBAIJ, &isSeqBAIJ));
34679566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
34689566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
34699566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
34709566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
3471450b117fSShri Abhyankar 
34724dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
3473450b117fSShri Abhyankar   if (ftype == MAT_FACTOR_LU) {
3474450b117fSShri Abhyankar     B->ops->lufactorsymbolic = MatLUFactorSymbolic_BAIJMUMPS;
3475450b117fSShri Abhyankar     B->factortype            = MAT_FACTOR_LU;
3476bccb9932SShri Abhyankar     if (isSeqBAIJ) mumps->ConvertToTriples = MatConvertToTriples_seqbaij_seqaij;
3477bccb9932SShri Abhyankar     else mumps->ConvertToTriples = MatConvertToTriples_mpibaij_mpiaij;
3478746480a1SHong Zhang     mumps->sym = 0;
34799566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
3480546078acSJacob Faibussowitsch   } else SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP, "Cannot use PETSc BAIJ matrices with MUMPS Cholesky, use SBAIJ or AIJ matrix instead");
3481bccb9932SShri Abhyankar 
3482450b117fSShri Abhyankar   B->ops->view    = MatView_MUMPS;
3483722b6324SPierre Jolivet   B->ops->getinfo = MatGetInfo_MUMPS;
34842205254eSKarl Rupp 
34859566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
34869566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
34879566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
34889566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
34899566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
34909566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
34919566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
34929566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
34939566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
34949566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
34959566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
34965c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
34979566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
34989566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
3499450b117fSShri Abhyankar 
350000c67f3bSHong Zhang   /* set solvertype */
35019566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
35029566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
35039566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
35042c7c0729SBarry Smith   if (size == 1) {
35054ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
3506f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35072c7c0729SBarry Smith   }
35087ee00b23SStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
35097ee00b23SStefano Zampini   B->data         = (void *)mumps;
35107ee00b23SStefano Zampini 
35117ee00b23SStefano Zampini   *F               = B;
3512413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3513413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3514413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3515d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35163ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
35177ee00b23SStefano Zampini }
35187ee00b23SStefano Zampini 
35197ee00b23SStefano Zampini /* MatGetFactor for Seq and MPI SELL matrices */
3520d71ae5a4SJacob Faibussowitsch static PetscErrorCode MatGetFactor_sell_mumps(Mat A, MatFactorType ftype, Mat *F)
3521d71ae5a4SJacob Faibussowitsch {
35227ee00b23SStefano Zampini   Mat         B;
35237ee00b23SStefano Zampini   Mat_MUMPS  *mumps;
35247ee00b23SStefano Zampini   PetscBool   isSeqSELL;
35252c7c0729SBarry Smith   PetscMPIInt size;
35267ee00b23SStefano Zampini 
35277ee00b23SStefano Zampini   PetscFunctionBegin;
35287ee00b23SStefano Zampini   /* Create the factorization matrix */
35299566063dSJacob Faibussowitsch   PetscCall(PetscObjectTypeCompare((PetscObject)A, MATSEQSELL, &isSeqSELL));
35309566063dSJacob Faibussowitsch   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
35319566063dSJacob Faibussowitsch   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
35329566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy("mumps", &((PetscObject)B)->type_name));
35339566063dSJacob Faibussowitsch   PetscCall(MatSetUp(B));
35347ee00b23SStefano Zampini 
35354dfa11a4SJacob Faibussowitsch   PetscCall(PetscNew(&mumps));
35367ee00b23SStefano Zampini 
35377ee00b23SStefano Zampini   B->ops->view    = MatView_MUMPS;
35387ee00b23SStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
35397ee00b23SStefano Zampini 
35409566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
35419566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
35429566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
35439566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
35449566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
35459566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
35469566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
35479566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
35489566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
35499566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
35509566063dSJacob Faibussowitsch   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
35515c0bae8cSAshish Patel   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
35527ee00b23SStefano Zampini 
35537ee00b23SStefano Zampini   if (ftype == MAT_FACTOR_LU) {
35547ee00b23SStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
35557ee00b23SStefano Zampini     B->factortype            = MAT_FACTOR_LU;
35567ee00b23SStefano Zampini     if (isSeqSELL) mumps->ConvertToTriples = MatConvertToTriples_seqsell_seqaij;
35577ee00b23SStefano Zampini     else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
35587ee00b23SStefano Zampini     mumps->sym = 0;
35599566063dSJacob Faibussowitsch     PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[MAT_FACTOR_LU]));
35607ee00b23SStefano Zampini   } else SETERRQ(PetscObjectComm((PetscObject)A), PETSC_ERR_SUP, "To be implemented");
35617ee00b23SStefano Zampini 
35627ee00b23SStefano Zampini   /* set solvertype */
35639566063dSJacob Faibussowitsch   PetscCall(PetscFree(B->solvertype));
35649566063dSJacob Faibussowitsch   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
35659566063dSJacob Faibussowitsch   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
35662c7c0729SBarry Smith   if (size == 1) {
35674ac6704cSBarry Smith     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization  */
3568f73b0415SBarry Smith     B->canuseordering = PETSC_TRUE;
35692c7c0729SBarry Smith   }
3570450b117fSShri Abhyankar   B->ops->destroy = MatDestroy_MUMPS;
3571e69c285eSBarry Smith   B->data         = (void *)mumps;
35722205254eSKarl Rupp 
3573450b117fSShri Abhyankar   *F               = B;
3574413bcc21SPierre Jolivet   mumps->id.job    = JOB_NULL;
3575413bcc21SPierre Jolivet   mumps->ICNTL_pre = NULL;
3576413bcc21SPierre Jolivet   mumps->CNTL_pre  = NULL;
3577d47f36abSHong Zhang   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
35783ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
3579450b117fSShri Abhyankar }
358042c9c57cSBarry Smith 
35819d0448ceSStefano Zampini /* MatGetFactor for MATNEST matrices */
35829d0448ceSStefano Zampini static PetscErrorCode MatGetFactor_nest_mumps(Mat A, MatFactorType ftype, Mat *F)
35839d0448ceSStefano Zampini {
35849d0448ceSStefano Zampini   Mat         B, **mats;
35859d0448ceSStefano Zampini   Mat_MUMPS  *mumps;
35869d0448ceSStefano Zampini   PetscInt    nr, nc;
35879d0448ceSStefano Zampini   PetscMPIInt size;
358803e5aca4SStefano Zampini   PetscBool   flg = PETSC_TRUE;
35899d0448ceSStefano Zampini 
35909d0448ceSStefano Zampini   PetscFunctionBegin;
35919d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
359203e5aca4SStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY && A->hermitian == PETSC_BOOL3_TRUE && A->symmetric != PETSC_BOOL3_TRUE) {
359303e5aca4SStefano Zampini     PetscCall(PetscInfo(A, "Hermitian MAT_FACTOR_CHOLESKY is not supported. Use MAT_FACTOR_LU instead.\n"));
359403e5aca4SStefano Zampini     *F = NULL;
359503e5aca4SStefano Zampini     PetscFunctionReturn(PETSC_SUCCESS);
359603e5aca4SStefano Zampini   }
35979d0448ceSStefano Zampini #endif
35989d0448ceSStefano Zampini 
359903e5aca4SStefano Zampini   /* Return if some condition is not satisfied */
360003e5aca4SStefano Zampini   *F = NULL;
36019d0448ceSStefano Zampini   PetscCall(MatNestGetSubMats(A, &nr, &nc, &mats));
36029d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_CHOLESKY) {
36039d0448ceSStefano Zampini     IS       *rows, *cols;
36049d0448ceSStefano Zampini     PetscInt *m, *M;
36059d0448ceSStefano Zampini 
36069d0448ceSStefano 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);
36079d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &rows, nc, &cols));
36089d0448ceSStefano Zampini     PetscCall(MatNestGetISs(A, rows, cols));
36099d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++) PetscCall(ISEqualUnsorted(rows[r], cols[r], &flg));
361003e5aca4SStefano Zampini     if (!flg) {
361103e5aca4SStefano Zampini       PetscCall(PetscFree2(rows, cols));
361203e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for unequal row and column maps. Use MAT_FACTOR_LU.\n"));
361303e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
361403e5aca4SStefano Zampini     }
36159d0448ceSStefano Zampini     PetscCall(PetscMalloc2(nr, &m, nr, &M));
36169d0448ceSStefano Zampini     for (PetscInt r = 0; r < nr; r++) PetscCall(ISGetMinMax(rows[r], &m[r], &M[r]));
36179d0448ceSStefano Zampini     for (PetscInt r = 0; flg && r < nr; r++)
36189d0448ceSStefano Zampini       for (PetscInt k = r + 1; flg && k < nr; k++)
36199d0448ceSStefano Zampini         if ((m[k] <= m[r] && m[r] <= M[k]) || (m[k] <= M[r] && M[r] <= M[k])) flg = PETSC_FALSE;
36209d0448ceSStefano Zampini     PetscCall(PetscFree2(m, M));
36219d0448ceSStefano Zampini     PetscCall(PetscFree2(rows, cols));
362203e5aca4SStefano Zampini     if (!flg) {
362303e5aca4SStefano Zampini       PetscCall(PetscInfo(A, "MAT_FACTOR_CHOLESKY not supported for intersecting row maps. Use MAT_FACTOR_LU.\n"));
362403e5aca4SStefano Zampini       PetscFunctionReturn(PETSC_SUCCESS);
362503e5aca4SStefano Zampini     }
36269d0448ceSStefano Zampini   }
36279d0448ceSStefano Zampini 
36289d0448ceSStefano Zampini   for (PetscInt r = 0; r < nr; r++) {
36299d0448ceSStefano Zampini     for (PetscInt c = 0; c < nc; c++) {
36309d0448ceSStefano Zampini       Mat       sub = mats[r][c];
36315d955bbbSStefano Zampini       PetscBool isSeqAIJ, isMPIAIJ, isSeqBAIJ, isMPIBAIJ, isSeqSBAIJ, isMPISBAIJ, isTrans;
36329d0448ceSStefano Zampini 
36339d0448ceSStefano Zampini       if (!sub || (ftype == MAT_FACTOR_CHOLESKY && c < r)) continue;
36345d955bbbSStefano Zampini       PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATTRANSPOSEVIRTUAL, &isTrans));
36355d955bbbSStefano Zampini       if (isTrans) PetscCall(MatTransposeGetMat(sub, &sub));
36365d955bbbSStefano Zampini       else {
36375d955bbbSStefano Zampini         PetscCall(PetscObjectTypeCompare((PetscObject)sub, MATHERMITIANTRANSPOSEVIRTUAL, &isTrans));
36385d955bbbSStefano Zampini         if (isTrans) PetscCall(MatHermitianTransposeGetMat(sub, &sub));
36395d955bbbSStefano Zampini       }
36409d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQAIJ, &isSeqAIJ));
36419d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIAIJ, &isMPIAIJ));
36429d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQBAIJ, &isSeqBAIJ));
36439d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPIBAIJ, &isMPIBAIJ));
36449d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATSEQSBAIJ, &isSeqSBAIJ));
36459d0448ceSStefano Zampini       PetscCall(PetscObjectBaseTypeCompare((PetscObject)sub, MATMPISBAIJ, &isMPISBAIJ));
36469d0448ceSStefano Zampini       if (ftype == MAT_FACTOR_CHOLESKY) {
364703e5aca4SStefano Zampini         if (r == c && !isSeqAIJ && !isMPIAIJ && !isSeqSBAIJ && !isMPISBAIJ) {
364803e5aca4SStefano Zampini           PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
364903e5aca4SStefano Zampini           flg = PETSC_FALSE;
365003e5aca4SStefano Zampini         } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ) {
365103e5aca4SStefano Zampini           PetscCall(PetscInfo(sub, "MAT_CHOLESKY_FACTOR not supported for off-diagonal block of type %s.\n", ((PetscObject)sub)->type_name));
365203e5aca4SStefano Zampini           flg = PETSC_FALSE;
365303e5aca4SStefano Zampini         }
365403e5aca4SStefano Zampini       } else if (!isSeqAIJ && !isMPIAIJ && !isSeqBAIJ && !isMPIBAIJ) {
365503e5aca4SStefano Zampini         PetscCall(PetscInfo(sub, "MAT_LU_FACTOR not supported for block of type %s.\n", ((PetscObject)sub)->type_name));
365603e5aca4SStefano Zampini         flg = PETSC_FALSE;
36579d0448ceSStefano Zampini       }
36589d0448ceSStefano Zampini     }
365903e5aca4SStefano Zampini   }
366003e5aca4SStefano Zampini   if (!flg) PetscFunctionReturn(PETSC_SUCCESS);
36619d0448ceSStefano Zampini 
36629d0448ceSStefano Zampini   /* Create the factorization matrix */
36639d0448ceSStefano Zampini   PetscCall(MatCreate(PetscObjectComm((PetscObject)A), &B));
36649d0448ceSStefano Zampini   PetscCall(MatSetSizes(B, A->rmap->n, A->cmap->n, A->rmap->N, A->cmap->N));
36659d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &((PetscObject)B)->type_name));
36669d0448ceSStefano Zampini   PetscCall(MatSetUp(B));
36679d0448ceSStefano Zampini 
36689d0448ceSStefano Zampini   PetscCall(PetscNew(&mumps));
36699d0448ceSStefano Zampini 
36709d0448ceSStefano Zampini   B->ops->view    = MatView_MUMPS;
36719d0448ceSStefano Zampini   B->ops->getinfo = MatGetInfo_MUMPS;
36729d0448ceSStefano Zampini 
36739d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorGetSolverType_C", MatFactorGetSolverType_mumps));
36749d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorSetSchurIS_C", MatFactorSetSchurIS_MUMPS));
36759d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatFactorCreateSchurComplement_C", MatFactorCreateSchurComplement_MUMPS));
36769d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetIcntl_C", MatMumpsSetIcntl_MUMPS));
36779d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetIcntl_C", MatMumpsGetIcntl_MUMPS));
36789d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsSetCntl_C", MatMumpsSetCntl_MUMPS));
36799d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetCntl_C", MatMumpsGetCntl_MUMPS));
36809d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfo_C", MatMumpsGetInfo_MUMPS));
36819d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInfog_C", MatMumpsGetInfog_MUMPS));
36829d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfo_C", MatMumpsGetRinfo_MUMPS));
36839d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetRinfog_C", MatMumpsGetRinfog_MUMPS));
36849d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetNullPivots_C", MatMumpsGetNullPivots_MUMPS));
36859d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverse_C", MatMumpsGetInverse_MUMPS));
36869d0448ceSStefano Zampini   PetscCall(PetscObjectComposeFunction((PetscObject)B, "MatMumpsGetInverseTranspose_C", MatMumpsGetInverseTranspose_MUMPS));
36879d0448ceSStefano Zampini 
36889d0448ceSStefano Zampini   if (ftype == MAT_FACTOR_LU) {
36899d0448ceSStefano Zampini     B->ops->lufactorsymbolic = MatLUFactorSymbolic_AIJMUMPS;
36909d0448ceSStefano Zampini     B->factortype            = MAT_FACTOR_LU;
36919d0448ceSStefano Zampini     mumps->sym               = 0;
36929d0448ceSStefano Zampini   } else {
36939d0448ceSStefano Zampini     B->ops->choleskyfactorsymbolic = MatCholeskyFactorSymbolic_MUMPS;
36949d0448ceSStefano Zampini     B->factortype                  = MAT_FACTOR_CHOLESKY;
36959d0448ceSStefano Zampini #if defined(PETSC_USE_COMPLEX)
36969d0448ceSStefano Zampini     mumps->sym = 2;
36979d0448ceSStefano Zampini #else
36989d0448ceSStefano Zampini     if (A->spd == PETSC_BOOL3_TRUE) mumps->sym = 1;
36999d0448ceSStefano Zampini     else mumps->sym = 2;
37009d0448ceSStefano Zampini #endif
37019d0448ceSStefano Zampini   }
37029d0448ceSStefano Zampini   mumps->ConvertToTriples = MatConvertToTriples_nest_xaij;
37039d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATORDERINGEXTERNAL, (char **)&B->preferredordering[ftype]));
37049d0448ceSStefano Zampini 
37059d0448ceSStefano Zampini   PetscCallMPI(MPI_Comm_size(PetscObjectComm((PetscObject)A), &size));
37069d0448ceSStefano Zampini   if (size == 1) {
37079d0448ceSStefano Zampini     /* MUMPS option -mat_mumps_icntl_7 1 is automatically set if PETSc ordering is passed into symbolic factorization */
37089d0448ceSStefano Zampini     B->canuseordering = PETSC_TRUE;
37099d0448ceSStefano Zampini   }
37109d0448ceSStefano Zampini 
37119d0448ceSStefano Zampini   /* set solvertype */
37129d0448ceSStefano Zampini   PetscCall(PetscFree(B->solvertype));
37139d0448ceSStefano Zampini   PetscCall(PetscStrallocpy(MATSOLVERMUMPS, &B->solvertype));
37149d0448ceSStefano Zampini   B->ops->destroy = MatDestroy_MUMPS;
37159d0448ceSStefano Zampini   B->data         = (void *)mumps;
37169d0448ceSStefano Zampini 
37179d0448ceSStefano Zampini   *F               = B;
37189d0448ceSStefano Zampini   mumps->id.job    = JOB_NULL;
37199d0448ceSStefano Zampini   mumps->ICNTL_pre = NULL;
37209d0448ceSStefano Zampini   mumps->CNTL_pre  = NULL;
37219d0448ceSStefano Zampini   mumps->matstruc  = DIFFERENT_NONZERO_PATTERN;
37229d0448ceSStefano Zampini   PetscFunctionReturn(PETSC_SUCCESS);
37239d0448ceSStefano Zampini }
37249d0448ceSStefano Zampini 
3725d71ae5a4SJacob Faibussowitsch PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void)
3726d71ae5a4SJacob Faibussowitsch {
372742c9c57cSBarry Smith   PetscFunctionBegin;
37289566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37299566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37309566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37319566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPIBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37329566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATMPISBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37339566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_aij_mumps));
37349566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_aij_mumps));
37359566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_baij_mumps));
37369566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_baij_mumps));
37379566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_sbaij_mumps));
37389566063dSJacob Faibussowitsch   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATSEQSELL, MAT_FACTOR_LU, MatGetFactor_sell_mumps));
37399d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_LU, MatGetFactor_nest_mumps));
37409d0448ceSStefano Zampini   PetscCall(MatSolverTypeRegister(MATSOLVERMUMPS, MATNEST, MAT_FACTOR_CHOLESKY, MatGetFactor_nest_mumps));
37413ba16761SJacob Faibussowitsch   PetscFunctionReturn(PETSC_SUCCESS);
374242c9c57cSBarry Smith }
3743