xref: /petsc/src/mat/interface/dlregismat.c (revision aca0776feee4da889fbf4f9f3c60ccde70044ebc)
1 /* Portions of this code are under:
2    Copyright (c) 2022 Advanced Micro Devices, Inc. All rights reserved.
3 */
4 #include <petsc/private/matimpl.h>
5 
6 const char *MatOptions_Shifted[] = {"UNUSED_NONZERO_LOCATION_ERR", "ROW_ORIENTED", "NOT_A_VALID_OPTION", "SYMMETRIC", "STRUCTURALLY_SYMMETRIC", "FORCE_DIAGONAL_ENTRIES", "IGNORE_OFF_PROC_ENTRIES", "USE_HASH_TABLE", "KEEP_NONZERO_PATTERN", "IGNORE_ZERO_ENTRIES", "USE_INODES", "HERMITIAN", "SYMMETRY_ETERNAL", "NEW_NONZERO_LOCATION_ERR", "IGNORE_LOWER_TRIANGULAR", "ERROR_LOWER_TRIANGULAR", "GETROW_UPPERTRIANGULAR", "SPD", "NO_OFF_PROC_ZERO_ROWS", "NO_OFF_PROC_ENTRIES", "NEW_NONZERO_LOCATIONS", "NEW_NONZERO_ALLOCATION_ERR", "SUBSET_OFF_PROC_ENTRIES", "SUBMAT_SINGLEIS", "STRUCTURE_ONLY", "SORTED_FULL", "FORM_EXPLICIT_TRANSPOSE", "STRUCTURAL_SYMMETRY_ETERNAL", "SPD_ETERNAL", "MatOption", "MAT_", NULL};
7 const char *const *MatOptions                  = MatOptions_Shifted + 2;
8 const char *const  MatFactorShiftTypes[]       = {"NONE", "NONZERO", "POSITIVE_DEFINITE", "INBLOCKS", "MatFactorShiftType", "PC_FACTOR_", NULL};
9 const char *const  MatStructures[]             = {"DIFFERENT", "SUBSET", "SAME", "UNKNOWN", "MatStructure", "MAT_STRUCTURE_", NULL};
10 const char *const  MatFactorShiftTypesDetail[] = {NULL, "diagonal shift to prevent zero pivot", "Manteuffel shift", "diagonal shift on blocks to prevent zero pivot"};
11 const char *const  MPPTScotchStrategyTypes[]   = {"DEFAULT", "QUALITY", "SPEED", "BALANCE", "SAFETY", "SCALABILITY", "MPPTScotchStrategyType", "MP_PTSCOTCH_", NULL};
12 const char *const  MPChacoGlobalTypes[]        = {"", "MULTILEVEL", "SPECTRAL", "", "LINEAR", "RANDOM", "SCATTERED", "MPChacoGlobalType", "MP_CHACO_", NULL};
13 const char *const  MPChacoLocalTypes[]         = {"", "KERNIGHAN", "NONE", "MPChacoLocalType", "MP_CHACO_", NULL};
14 const char *const  MPChacoEigenTypes[]         = {"LANCZOS", "RQI", "MPChacoEigenType", "MP_CHACO_", NULL};
15 
16 extern PetscErrorCode MatMFFDInitializePackage(void);
17 extern PetscErrorCode MatSolverTypeDestroy(void);
18 static PetscBool      MatPackageInitialized = PETSC_FALSE;
19 
20 /*@C
21   MatFinalizePackage - This function destroys everything in the Petsc interface to the `Mat`
22   package. It is called from `PetscFinalize()`.
23 
24   Level: developer
25 
26 .seealso: `Mat`, `PetscFinalize()`, `MatInitializePackage()`
27 @*/
28 PetscErrorCode MatFinalizePackage(void)
29 {
30   MatRootName nnames, names = MatRootNameList;
31 
32   PetscFunctionBegin;
33   PetscCall(MatSolverTypeDestroy());
34   while (names) {
35     nnames = names->next;
36     PetscCall(PetscFree(names->rname));
37     PetscCall(PetscFree(names->sname));
38     PetscCall(PetscFree(names->mname));
39     PetscCall(PetscFree(names));
40     names = nnames;
41   }
42   PetscCall(PetscFunctionListDestroy(&MatList));
43   PetscCall(PetscFunctionListDestroy(&MatOrderingList));
44   PetscCall(PetscFunctionListDestroy(&MatColoringList));
45   PetscCall(PetscFunctionListDestroy(&MatPartitioningList));
46   PetscCall(PetscFunctionListDestroy(&MatCoarsenList));
47   MatRootNameList                  = NULL;
48   MatPackageInitialized            = PETSC_FALSE;
49   MatRegisterAllCalled             = PETSC_FALSE;
50   MatOrderingRegisterAllCalled     = PETSC_FALSE;
51   MatColoringRegisterAllCalled     = PETSC_FALSE;
52   MatPartitioningRegisterAllCalled = PETSC_FALSE;
53   MatCoarsenRegisterAllCalled      = PETSC_FALSE;
54   /* this is not ideal because it exposes SeqAIJ implementation details directly into the base Mat code */
55   PetscCall(PetscFunctionListDestroy(&MatSeqAIJList));
56   MatSeqAIJRegisterAllCalled = PETSC_FALSE;
57   PetscFunctionReturn(PETSC_SUCCESS);
58 }
59 
60 #if defined(PETSC_HAVE_CUDA)
61 PETSC_INTERN PetscErrorCode MatSolverTypeRegister_DENSECUDA(void);
62 #endif
63 
64 #if defined(PETSC_HAVE_HIP)
65 PETSC_INTERN PetscErrorCode MatSolverTypeRegister_DENSEHIP(void);
66 #endif
67 
68 #if defined(PETSC_HAVE_MUMPS)
69 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MUMPS(void);
70 #endif
71 #if defined(PETSC_HAVE_CUDA)
72 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_CUSPARSE(void);
73 #endif
74 #if defined(PETSC_HAVE_HIP)
75 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_HIPSPARSE(void);
76 #endif
77 #if defined(PETSC_HAVE_KOKKOS_KERNELS)
78 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_KOKKOS(void);
79 #endif
80 #if defined(PETSC_HAVE_VIENNACL)
81 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_ViennaCL(void);
82 #endif
83 #if defined(PETSC_HAVE_ELEMENTAL)
84 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_Elemental(void);
85 #endif
86 #if defined(PETSC_HAVE_SCALAPACK)
87 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_ScaLAPACK(void);
88 #endif
89 #if defined(PETSC_HAVE_MATLAB)
90 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_Matlab(void);
91 #endif
92 #if defined(PETSC_HAVE_ESSL)
93 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_Essl(void);
94 #endif
95 #if defined(PETSC_HAVE_SUPERLU)
96 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_SuperLU(void);
97 #endif
98 #if defined(PETSC_HAVE_STRUMPACK)
99 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_STRUMPACK(void);
100 #endif
101 #if defined(PETSC_HAVE_PASTIX)
102 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_Pastix(void);
103 #endif
104 #if defined(PETSC_HAVE_SUPERLU_DIST)
105 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_SuperLU_DIST(void);
106 #endif
107 #if defined(PETSC_HAVE_MKL_PARDISO)
108 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MKL_Pardiso(void);
109 #endif
110 #if defined(PETSC_HAVE_MKL_CPARDISO)
111 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_MKL_CPardiso(void);
112 #endif
113 #if defined(PETSC_HAVE_SUITESPARSE)
114 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_SuiteSparse(void);
115 #endif
116 #if defined(PETSC_HAVE_LUSOL)
117 PETSC_EXTERN PetscErrorCode MatSolverTypeRegister_Lusol(void);
118 #endif
119 
120 PETSC_INTERN PetscErrorCode MatGetFactor_seqaij_petsc(Mat, MatFactorType, Mat *);
121 PETSC_INTERN PetscErrorCode MatGetFactor_seqbaij_petsc(Mat, MatFactorType, Mat *);
122 PETSC_INTERN PetscErrorCode MatGetFactor_seqsbaij_petsc(Mat, MatFactorType, Mat *);
123 PETSC_INTERN PetscErrorCode MatGetFactor_seqdense_petsc(Mat, MatFactorType, Mat *);
124 #if defined(PETSC_HAVE_CUDA)
125 PETSC_INTERN PetscErrorCode MatGetFactor_seqdense_cuda(Mat, MatFactorType, Mat *);
126 #endif
127 #if defined(PETSC_HAVE_HIP)
128 PETSC_INTERN PetscErrorCode MatGetFactor_seqdense_hip(Mat, MatFactorType, Mat *);
129 #endif
130 PETSC_INTERN PetscErrorCode MatGetFactor_constantdiagonal_petsc(Mat, MatFactorType, Mat *);
131 PETSC_INTERN PetscErrorCode MatGetFactor_seqaij_bas(Mat, MatFactorType, Mat *);
132 
133 /*@C
134   MatInitializePackage - This function initializes everything in the `Mat` package. It is called
135   from `PetscDLLibraryRegister_petscmat()` when using dynamic libraries, and on the first call to `MatCreate()`
136   when using shared or static libraries.
137 
138   Level: developer
139 
140 .seealso: [](ch_matrices), `Mat`, `PetscInitialize()`, `MatFinalizePackage()`
141 @*/
142 PetscErrorCode MatInitializePackage(void)
143 {
144   char      logList[256];
145   PetscBool opt, pkg;
146 
147   PetscFunctionBegin;
148   if (MatPackageInitialized) PetscFunctionReturn(PETSC_SUCCESS);
149   MatPackageInitialized = PETSC_TRUE;
150   /* Initialize subpackage */
151   PetscCall(MatMFFDInitializePackage());
152   /* Register Classes */
153   PetscCall(PetscClassIdRegister("Matrix", &MAT_CLASSID));
154   PetscCall(PetscClassIdRegister("Matrix FD Coloring", &MAT_FDCOLORING_CLASSID));
155   PetscCall(PetscClassIdRegister("Matrix Coloring", &MAT_COLORING_CLASSID));
156   PetscCall(PetscClassIdRegister("Matrix MatTranspose Coloring", &MAT_TRANSPOSECOLORING_CLASSID));
157   PetscCall(PetscClassIdRegister("Matrix Partitioning", &MAT_PARTITIONING_CLASSID));
158   PetscCall(PetscClassIdRegister("Matrix Coarsen", &MAT_COARSEN_CLASSID));
159   PetscCall(PetscClassIdRegister("Matrix Null Space", &MAT_NULLSPACE_CLASSID));
160   /* Register Constructors */
161   PetscCall(MatRegisterAll());
162   PetscCall(MatOrderingRegisterAll());
163   PetscCall(MatColoringRegisterAll());
164   PetscCall(MatPartitioningRegisterAll());
165   PetscCall(MatCoarsenRegisterAll());
166   PetscCall(MatSeqAIJRegisterAll());
167   /* Register Events */
168   PetscCall(PetscLogEventRegister("MatMult", MAT_CLASSID, &MAT_Mult));
169   PetscCall(PetscLogEventRegister("MatMultAdd", MAT_CLASSID, &MAT_MultAdd));
170   PetscCall(PetscLogEventRegister("MatMultTranspose", MAT_CLASSID, &MAT_MultTranspose));
171   PetscCall(PetscLogEventRegister("MatMultHermitian", MAT_CLASSID, &MAT_MultHermitianTranspose));
172   PetscCall(PetscLogEventRegister("MatMultTrAdd", MAT_CLASSID, &MAT_MultTransposeAdd));
173   PetscCall(PetscLogEventRegister("MatMultHTAdd", MAT_CLASSID, &MAT_MultHermitianTransposeAdd));
174   PetscCall(PetscLogEventRegister("MatSolve", MAT_CLASSID, &MAT_Solve));
175   PetscCall(PetscLogEventRegister("MatSolves", MAT_CLASSID, &MAT_Solves));
176   PetscCall(PetscLogEventRegister("MatSolveAdd", MAT_CLASSID, &MAT_SolveAdd));
177   PetscCall(PetscLogEventRegister("MatSolveTranspos", MAT_CLASSID, &MAT_SolveTranspose));
178   PetscCall(PetscLogEventRegister("MatSolveTrAdd", MAT_CLASSID, &MAT_SolveTransposeAdd));
179   PetscCall(PetscLogEventRegister("MatSOR", MAT_CLASSID, &MAT_SOR));
180   PetscCall(PetscLogEventRegister("MatForwardSolve", MAT_CLASSID, &MAT_ForwardSolve));
181   PetscCall(PetscLogEventRegister("MatBackwardSolve", MAT_CLASSID, &MAT_BackwardSolve));
182   PetscCall(PetscLogEventRegister("MatLUFactor", MAT_CLASSID, &MAT_LUFactor));
183   PetscCall(PetscLogEventRegister("MatLUFactorSym", MAT_CLASSID, &MAT_LUFactorSymbolic));
184   PetscCall(PetscLogEventRegister("MatLUFactorNum", MAT_CLASSID, &MAT_LUFactorNumeric));
185   PetscCall(PetscLogEventRegister("MatQRFactor", MAT_CLASSID, &MAT_QRFactor));
186   PetscCall(PetscLogEventRegister("MatQRFactorSym", MAT_CLASSID, &MAT_QRFactorSymbolic));
187   PetscCall(PetscLogEventRegister("MatQRFactorNum", MAT_CLASSID, &MAT_QRFactorNumeric));
188   PetscCall(PetscLogEventRegister("MatCholeskyFctr", MAT_CLASSID, &MAT_CholeskyFactor));
189   PetscCall(PetscLogEventRegister("MatCholFctrSym", MAT_CLASSID, &MAT_CholeskyFactorSymbolic));
190   PetscCall(PetscLogEventRegister("MatCholFctrNum", MAT_CLASSID, &MAT_CholeskyFactorNumeric));
191   PetscCall(PetscLogEventRegister("MatFctrFactSchur", MAT_CLASSID, &MAT_FactorFactS));
192   PetscCall(PetscLogEventRegister("MatFctrInvSchur", MAT_CLASSID, &MAT_FactorInvS));
193   PetscCall(PetscLogEventRegister("MatILUFactor", MAT_CLASSID, &MAT_ILUFactor));
194   PetscCall(PetscLogEventRegister("MatILUFactorSym", MAT_CLASSID, &MAT_ILUFactorSymbolic));
195   PetscCall(PetscLogEventRegister("MatICCFactorSym", MAT_CLASSID, &MAT_ICCFactorSymbolic));
196   PetscCall(PetscLogEventRegister("MatCopy", MAT_CLASSID, &MAT_Copy));
197   PetscCall(PetscLogEventRegister("MatConvert", MAT_CLASSID, &MAT_Convert));
198   PetscCall(PetscLogEventRegister("MatScale", MAT_CLASSID, &MAT_Scale));
199   PetscCall(PetscLogEventRegister("MatResidual", MAT_CLASSID, &MAT_Residual));
200   PetscCall(PetscLogEventRegister("MatAssemblyBegin", MAT_CLASSID, &MAT_AssemblyBegin));
201   PetscCall(PetscLogEventRegister("MatAssemblyEnd", MAT_CLASSID, &MAT_AssemblyEnd));
202   PetscCall(PetscLogEventRegister("MatSetValues", MAT_CLASSID, &MAT_SetValues));
203   PetscCall(PetscLogEventRegister("MatGetValues", MAT_CLASSID, &MAT_GetValues));
204   PetscCall(PetscLogEventRegister("MatGetRow", MAT_CLASSID, &MAT_GetRow));
205   PetscCall(PetscLogEventRegister("MatGetRowIJ", MAT_CLASSID, &MAT_GetRowIJ));
206   PetscCall(PetscLogEventRegister("MatCreateSubMats", MAT_CLASSID, &MAT_CreateSubMats));
207   PetscCall(PetscLogEventRegister("MatCreateSubMat", MAT_CLASSID, &MAT_CreateSubMat));
208   PetscCall(PetscLogEventRegister("MatGetOrdering", MAT_CLASSID, &MAT_GetOrdering));
209   PetscCall(PetscLogEventRegister("MatIncreaseOvrlp", MAT_CLASSID, &MAT_IncreaseOverlap));
210   PetscCall(PetscLogEventRegister("MatPartitioning", MAT_PARTITIONING_CLASSID, &MAT_Partitioning));
211   PetscCall(PetscLogEventRegister("MatPartitioningND", MAT_PARTITIONING_CLASSID, &MAT_PartitioningND));
212   PetscCall(PetscLogEventRegister("MatCoarsen", MAT_COARSEN_CLASSID, &MAT_Coarsen));
213   PetscCall(PetscLogEventRegister("MatZeroEntries", MAT_CLASSID, &MAT_ZeroEntries));
214   PetscCall(PetscLogEventRegister("MatLoad", MAT_CLASSID, &MAT_Load));
215   PetscCall(PetscLogEventRegister("MatView", MAT_CLASSID, &MAT_View));
216   PetscCall(PetscLogEventRegister("MatAXPY", MAT_CLASSID, &MAT_AXPY));
217   PetscCall(PetscLogEventRegister("MatFDColorCreate", MAT_FDCOLORING_CLASSID, &MAT_FDColoringCreate));
218   PetscCall(PetscLogEventRegister("MatFDColorSetUp", MAT_FDCOLORING_CLASSID, &MAT_FDColoringSetUp));
219   PetscCall(PetscLogEventRegister("MatFDColorApply", MAT_FDCOLORING_CLASSID, &MAT_FDColoringApply));
220   PetscCall(PetscLogEventRegister("MatFDColorFunc", MAT_FDCOLORING_CLASSID, &MAT_FDColoringFunction));
221   PetscCall(PetscLogEventRegister("MatTranspose", MAT_CLASSID, &MAT_Transpose));
222   PetscCall(PetscLogEventRegister("MatMatSolve", MAT_CLASSID, &MAT_MatSolve));
223   PetscCall(PetscLogEventRegister("MatMatTrSolve", MAT_CLASSID, &MAT_MatTrSolve));
224   PetscCall(PetscLogEventRegister("MatMatMultSym", MAT_CLASSID, &MAT_MatMultSymbolic));
225   PetscCall(PetscLogEventRegister("MatMatMultNum", MAT_CLASSID, &MAT_MatMultNumeric));
226   PetscCall(PetscLogEventRegister("MatMatMatMultSym", MAT_CLASSID, &MAT_MatMatMultSymbolic));
227   PetscCall(PetscLogEventRegister("MatMatMatMultNum", MAT_CLASSID, &MAT_MatMatMultNumeric));
228   PetscCall(PetscLogEventRegister("MatPtAPSymbolic", MAT_CLASSID, &MAT_PtAPSymbolic));
229   PetscCall(PetscLogEventRegister("MatPtAPNumeric", MAT_CLASSID, &MAT_PtAPNumeric));
230   PetscCall(PetscLogEventRegister("MatRARtSym", MAT_CLASSID, &MAT_RARtSymbolic));
231   PetscCall(PetscLogEventRegister("MatRARtNum", MAT_CLASSID, &MAT_RARtNumeric));
232   PetscCall(PetscLogEventRegister("MatMatTrnMultSym", MAT_CLASSID, &MAT_MatTransposeMultSymbolic));
233   PetscCall(PetscLogEventRegister("MatMatTrnMultNum", MAT_CLASSID, &MAT_MatTransposeMultNumeric));
234   PetscCall(PetscLogEventRegister("MatTrnMatMultSym", MAT_CLASSID, &MAT_TransposeMatMultSymbolic));
235   PetscCall(PetscLogEventRegister("MatTrnMatMultNum", MAT_CLASSID, &MAT_TransposeMatMultNumeric));
236   PetscCall(PetscLogEventRegister("MatTrnColorCreate", MAT_CLASSID, &MAT_TransposeColoringCreate));
237   PetscCall(PetscLogEventRegister("MatRedundantMat", MAT_CLASSID, &MAT_RedundantMat));
238   PetscCall(PetscLogEventRegister("MatGetSeqNZStrct", MAT_CLASSID, &MAT_GetSeqNonzeroStructure));
239   PetscCall(PetscLogEventRegister("MatGetMultiProcB", MAT_CLASSID, &MAT_GetMultiProcBlock));
240   PetscCall(PetscLogEventRegister("MatSetRandom", MAT_CLASSID, &MAT_SetRandom));
241 
242   /* these may be specific to MPIAIJ matrices */
243   PetscCall(PetscLogEventRegister("MatMPISumSeqNumeric", MAT_CLASSID, &MAT_Seqstompinum));
244   PetscCall(PetscLogEventRegister("MatMPISumSeqSymbolic", MAT_CLASSID, &MAT_Seqstompisym));
245   PetscCall(PetscLogEventRegister("MatMPISumSeq", MAT_CLASSID, &MAT_Seqstompi));
246   PetscCall(PetscLogEventRegister("MatMPIConcateSeq", MAT_CLASSID, &MAT_Merge));
247   PetscCall(PetscLogEventRegister("MatGetLocalMat", MAT_CLASSID, &MAT_Getlocalmat));
248   PetscCall(PetscLogEventRegister("MatGetLocalMatCondensed", MAT_CLASSID, &MAT_Getlocalmatcondensed));
249   PetscCall(PetscLogEventRegister("MatGetBrowsOfAcols", MAT_CLASSID, &MAT_GetBrowsOfAcols));
250   PetscCall(PetscLogEventRegister("MatGetBrAoCol", MAT_CLASSID, &MAT_GetBrowsOfAocols));
251 
252   PetscCall(PetscLogEventRegister("MatGetSymTransR", MAT_CLASSID, &MAT_Getsymtransreduced));
253   PetscCall(PetscLogEventRegister("MatCUSPARSCopyTo", MAT_CLASSID, &MAT_CUSPARSECopyToGPU));
254   PetscCall(PetscLogEventRegister("MatCUSPARSCopyFr", MAT_CLASSID, &MAT_CUSPARSECopyFromGPU));
255   PetscCall(PetscLogEventRegister("MatCUSPARSSolAnl", MAT_CLASSID, &MAT_CUSPARSESolveAnalysis));
256   PetscCall(PetscLogEventRegister("MatCUSPARSGenT", MAT_CLASSID, &MAT_CUSPARSEGenerateTranspose));
257   PetscCall(PetscLogEventRegister("MatHIPSPARSCopyTo", MAT_CLASSID, &MAT_HIPSPARSECopyToGPU));
258   PetscCall(PetscLogEventRegister("MatHIPSPARSCopyFr", MAT_CLASSID, &MAT_HIPSPARSECopyFromGPU));
259   PetscCall(PetscLogEventRegister("MatHIPSPARSSolAnl", MAT_CLASSID, &MAT_HIPSPARSESolveAnalysis));
260   PetscCall(PetscLogEventRegister("MatHIPSPARSGenT", MAT_CLASSID, &MAT_HIPSPARSEGenerateTranspose));
261   PetscCall(PetscLogEventRegister("MatVCLCopyTo", MAT_CLASSID, &MAT_ViennaCLCopyToGPU));
262   PetscCall(PetscLogEventRegister("MatDenseCopyTo", MAT_CLASSID, &MAT_DenseCopyToGPU));
263   PetscCall(PetscLogEventRegister("MatDenseCopyFrom", MAT_CLASSID, &MAT_DenseCopyFromGPU));
264   PetscCall(PetscLogEventRegister("MatSetValBatch", MAT_CLASSID, &MAT_SetValuesBatch));
265 
266   PetscCall(PetscLogEventRegister("MatColoringApply", MAT_COLORING_CLASSID, &MATCOLORING_Apply));
267   PetscCall(PetscLogEventRegister("MatColoringComm", MAT_COLORING_CLASSID, &MATCOLORING_Comm));
268   PetscCall(PetscLogEventRegister("MatColoringLocal", MAT_COLORING_CLASSID, &MATCOLORING_Local));
269   PetscCall(PetscLogEventRegister("MatColoringIS", MAT_COLORING_CLASSID, &MATCOLORING_ISCreate));
270   PetscCall(PetscLogEventRegister("MatColoringSetUp", MAT_COLORING_CLASSID, &MATCOLORING_SetUp));
271   PetscCall(PetscLogEventRegister("MatColoringWeights", MAT_COLORING_CLASSID, &MATCOLORING_Weights));
272 
273   PetscCall(PetscLogEventRegister("MatSetPreallCOO", MAT_CLASSID, &MAT_PreallCOO));
274   PetscCall(PetscLogEventRegister("MatSetValuesCOO", MAT_CLASSID, &MAT_SetVCOO));
275 
276   PetscCall(PetscLogEventRegister("MatH2OpusBuild", MAT_CLASSID, &MAT_H2Opus_Build));
277   PetscCall(PetscLogEventRegister("MatH2OpusComp", MAT_CLASSID, &MAT_H2Opus_Compress));
278   PetscCall(PetscLogEventRegister("MatH2OpusOrth", MAT_CLASSID, &MAT_H2Opus_Orthog));
279   PetscCall(PetscLogEventRegister("MatH2OpusLR", MAT_CLASSID, &MAT_H2Opus_LR));
280 
281   /* Mark non-collective events */
282   PetscCall(PetscLogEventSetCollective(MAT_SetValues, PETSC_FALSE));
283   PetscCall(PetscLogEventSetCollective(MAT_SetValuesBatch, PETSC_FALSE));
284   PetscCall(PetscLogEventSetCollective(MAT_GetRow, PETSC_FALSE));
285   /* Turn off high traffic events by default */
286   PetscCall(PetscLogEventSetActiveAll(MAT_SetValues, PETSC_FALSE));
287   PetscCall(PetscLogEventSetActiveAll(MAT_GetValues, PETSC_FALSE));
288   PetscCall(PetscLogEventSetActiveAll(MAT_GetRow, PETSC_FALSE));
289   /* Process Info */
290   {
291     PetscClassId classids[7];
292 
293     classids[0] = MAT_CLASSID;
294     classids[1] = MAT_FDCOLORING_CLASSID;
295     classids[2] = MAT_COLORING_CLASSID;
296     classids[3] = MAT_TRANSPOSECOLORING_CLASSID;
297     classids[4] = MAT_PARTITIONING_CLASSID;
298     classids[5] = MAT_COARSEN_CLASSID;
299     classids[6] = MAT_NULLSPACE_CLASSID;
300     PetscCall(PetscInfoProcessClass("mat", 7, classids));
301   }
302 
303   /* Process summary exclusions */
304   PetscCall(PetscOptionsGetString(NULL, NULL, "-log_exclude", logList, sizeof(logList), &opt));
305   if (opt) {
306     PetscCall(PetscStrInList("mat", logList, ',', &pkg));
307     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_CLASSID));
308     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_FDCOLORING_CLASSID));
309     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_COLORING_CLASSID));
310     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_TRANSPOSECOLORING_CLASSID));
311     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_PARTITIONING_CLASSID));
312     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_COARSEN_CLASSID));
313     if (pkg) PetscCall(PetscLogEventExcludeClass(MAT_NULLSPACE_CLASSID));
314   }
315 
316   /* Register the PETSc built in factorization based solvers */
317   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJ, MAT_FACTOR_LU, MatGetFactor_seqaij_petsc));
318   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_seqaij_petsc));
319   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJ, MAT_FACTOR_ILU, MatGetFactor_seqaij_petsc));
320   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJ, MAT_FACTOR_ICC, MatGetFactor_seqaij_petsc));
321 
322   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJPERM, MAT_FACTOR_LU, MatGetFactor_seqaij_petsc));
323   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJPERM, MAT_FACTOR_CHOLESKY, MatGetFactor_seqaij_petsc));
324   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJPERM, MAT_FACTOR_ILU, MatGetFactor_seqaij_petsc));
325   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJPERM, MAT_FACTOR_ICC, MatGetFactor_seqaij_petsc));
326 
327   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATCONSTANTDIAGONAL, MAT_FACTOR_LU, MatGetFactor_constantdiagonal_petsc));
328   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATCONSTANTDIAGONAL, MAT_FACTOR_CHOLESKY, MatGetFactor_constantdiagonal_petsc));
329   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATCONSTANTDIAGONAL, MAT_FACTOR_ILU, MatGetFactor_constantdiagonal_petsc));
330   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATCONSTANTDIAGONAL, MAT_FACTOR_ICC, MatGetFactor_constantdiagonal_petsc));
331 
332 #if defined(PETSC_HAVE_MKL_SPARSE)
333   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJMKL, MAT_FACTOR_LU, MatGetFactor_seqaij_petsc));
334   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJMKL, MAT_FACTOR_CHOLESKY, MatGetFactor_seqaij_petsc));
335   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJMKL, MAT_FACTOR_ILU, MatGetFactor_seqaij_petsc));
336   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJMKL, MAT_FACTOR_ICC, MatGetFactor_seqaij_petsc));
337 
338   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJMKL, MAT_FACTOR_LU, MatGetFactor_seqbaij_petsc));
339   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJMKL, MAT_FACTOR_CHOLESKY, MatGetFactor_seqbaij_petsc));
340   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJMKL, MAT_FACTOR_ILU, MatGetFactor_seqbaij_petsc));
341   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJMKL, MAT_FACTOR_ICC, MatGetFactor_seqbaij_petsc));
342 #endif
343   /* Above, we register the PETSc built-in factorization solvers for MATSEQAIJMKL.  In the future, we may want to use
344      * some of the MKL-provided ones instead. */
345 
346   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJCRL, MAT_FACTOR_LU, MatGetFactor_seqaij_petsc));
347   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJCRL, MAT_FACTOR_CHOLESKY, MatGetFactor_seqaij_petsc));
348   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJCRL, MAT_FACTOR_ILU, MatGetFactor_seqaij_petsc));
349   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQAIJCRL, MAT_FACTOR_ICC, MatGetFactor_seqaij_petsc));
350 
351   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJ, MAT_FACTOR_LU, MatGetFactor_seqbaij_petsc));
352   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_seqbaij_petsc));
353   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJ, MAT_FACTOR_ILU, MatGetFactor_seqbaij_petsc));
354   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQBAIJ, MAT_FACTOR_ICC, MatGetFactor_seqbaij_petsc));
355 
356   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQSBAIJ, MAT_FACTOR_CHOLESKY, MatGetFactor_seqsbaij_petsc));
357   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQSBAIJ, MAT_FACTOR_ICC, MatGetFactor_seqsbaij_petsc));
358 
359   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQDENSE, MAT_FACTOR_LU, MatGetFactor_seqdense_petsc));
360   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQDENSE, MAT_FACTOR_ILU, MatGetFactor_seqdense_petsc));
361   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQDENSE, MAT_FACTOR_CHOLESKY, MatGetFactor_seqdense_petsc));
362   PetscCall(MatSolverTypeRegister(MATSOLVERPETSC, MATSEQDENSE, MAT_FACTOR_QR, MatGetFactor_seqdense_petsc));
363 #if defined(PETSC_HAVE_CUDA)
364   PetscCall(MatSolverTypeRegister_DENSECUDA());
365 #endif
366 #if defined(PETSC_HAVE_HIP)
367   PetscCall(MatSolverTypeRegister_DENSEHIP());
368 #endif
369 
370   PetscCall(MatSolverTypeRegister(MATSOLVERBAS, MATSEQAIJ, MAT_FACTOR_ICC, MatGetFactor_seqaij_bas));
371 
372   /*
373      Register the external package factorization based solvers
374         Eventually we don't want to have these hardwired here at compile time of PETSc
375   */
376 #if defined(PETSC_HAVE_MUMPS)
377   PetscCall(MatSolverTypeRegister_MUMPS());
378 #endif
379 #if defined(PETSC_HAVE_CUDA)
380   PetscCall(MatSolverTypeRegister_CUSPARSE());
381 #endif
382 #if defined(PETSC_HAVE_HIP)
383   PetscCall(MatSolverTypeRegister_HIPSPARSE());
384 #endif
385 #if defined(PETSC_HAVE_KOKKOS_KERNELS)
386   PetscCall(MatSolverTypeRegister_KOKKOS());
387 #endif
388 #if defined(PETSC_HAVE_VIENNACL)
389   PetscCall(MatSolverTypeRegister_ViennaCL());
390 #endif
391 #if defined(PETSC_HAVE_ELEMENTAL)
392   PetscCall(MatSolverTypeRegister_Elemental());
393 #endif
394 #if defined(PETSC_HAVE_SCALAPACK)
395   PetscCall(MatSolverTypeRegister_ScaLAPACK());
396 #endif
397 #if defined(PETSC_HAVE_MATLAB)
398   PetscCall(MatSolverTypeRegister_Matlab());
399 #endif
400 #if defined(PETSC_HAVE_ESSL)
401   PetscCall(MatSolverTypeRegister_Essl());
402 #endif
403 #if defined(PETSC_HAVE_SUPERLU)
404   PetscCall(MatSolverTypeRegister_SuperLU());
405 #endif
406 #if defined(PETSC_HAVE_STRUMPACK)
407   PetscCall(MatSolverTypeRegister_STRUMPACK());
408 #endif
409 #if defined(PETSC_HAVE_PASTIX)
410   PetscCall(MatSolverTypeRegister_Pastix());
411 #endif
412 #if defined(PETSC_HAVE_SUPERLU_DIST)
413   PetscCall(MatSolverTypeRegister_SuperLU_DIST());
414 #endif
415 #if defined(PETSC_HAVE_MKL_PARDISO)
416   PetscCall(MatSolverTypeRegister_MKL_Pardiso());
417 #endif
418 #if defined(PETSC_HAVE_MKL_CPARDISO)
419   PetscCall(MatSolverTypeRegister_MKL_CPardiso());
420 #endif
421 #if defined(PETSC_HAVE_SUITESPARSE)
422   PetscCall(MatSolverTypeRegister_SuiteSparse());
423 #endif
424 #if defined(PETSC_HAVE_LUSOL)
425   PetscCall(MatSolverTypeRegister_Lusol());
426 #endif
427   /* Register package finalizer */
428   PetscCall(PetscRegisterFinalize(MatFinalizePackage));
429   PetscFunctionReturn(PETSC_SUCCESS);
430 }
431 
432 #if defined(PETSC_HAVE_DYNAMIC_LIBRARIES)
433 /*
434   PetscDLLibraryRegister - This function is called when the dynamic library it is in is opened.
435 
436   This one registers all the matrix methods that are in the basic PETSc Matrix library.
437 
438  */
439 PETSC_EXTERN PetscErrorCode PetscDLLibraryRegister_petscmat(void)
440 {
441   PetscFunctionBegin;
442   PetscCall(MatInitializePackage());
443   PetscFunctionReturn(PETSC_SUCCESS);
444 }
445 
446 #endif /* PETSC_HAVE_DYNAMIC_LIBRARIES */
447