xref: /petsc/src/mat/interface/dlregismat.c (revision 7b6bb2c608b6fc6714ef38fda02c2dbb91c82665)
1 
2 #include <private/matimpl.h>
3 
4 const char *MatOptions[] = {"ROW_ORIENTED","NEW_NONZERO_LOCATIONS",
5               "SYMMETRIC",
6               "STRUCTURALLY_SYMMETRIC",
7               "NEW_DIAGONALS",
8               "IGNORE_OFF_PROC_ENTRIES",
9               "NEW_NONZERO_LOCATION_ERR",
10               "NEW_NONZERO_ALLOCATION_ERR","USE_HASH_TABLE",
11               "KEEP_ZEROED_ROWS","IGNORE_ZERO_ENTRIES","USE_INODES",
12               "HERMITIAN",
13               "SYMMETRY_ETERNAL",
14               "CHECK_COMPRESSED_ROW",
15               "IGNORE_LOWER_TRIANGULAR","ERROR_LOWER_TRIANGULAR","GETROW_UPPERTRIANGULAR","SPD","NO_OFF_PROC_ENTRIES","NO_OFF_PROC_ZERO_ROWS","MatOption","MAT_",0};
16 const char *MatFactorShiftTypes[] = {"NONE","NONZERO","POSITIVE_DEFINITE","INBLOCKS","MatFactorShiftType","PC_FACTOR_",0};
17 
18 extern PetscErrorCode  MatMFFDInitializePackage(const char[]);
19 static PetscBool  MatPackageInitialized = PETSC_FALSE;
20 #undef __FUNCT__
21 #define __FUNCT__ "MatFinalizePackage"
22 /*@C
23   MatFinalizePackage - This function destroys everything in the Petsc interface to the Mat package. It is
24   called from PetscFinalize().
25 
26   Level: developer
27 
28 .keywords: Petsc, destroy, package, mathematica
29 .seealso: PetscFinalize()
30 @*/
31 PetscErrorCode  MatFinalizePackage(void)
32 {
33   MatBaseName    nnames,names = MatBaseNameList;
34   PetscErrorCode ierr;
35 
36   PetscFunctionBegin;
37   while (names) {
38     nnames = names->next;
39     ierr = PetscFree(names->bname);CHKERRQ(ierr);
40     ierr = PetscFree(names->sname);CHKERRQ(ierr);
41     ierr = PetscFree(names->mname);CHKERRQ(ierr);
42     ierr = PetscFree(names);CHKERRQ(ierr);
43     names = nnames;
44   }
45   MatBaseNameList                  = PETSC_NULL;
46   MatPackageInitialized            = PETSC_FALSE;
47   MatRegisterAllCalled             = PETSC_FALSE;
48   MatList                          = PETSC_NULL;
49   MatOrderingRegisterAllCalled     = PETSC_FALSE;
50   MatOrderingList                  = PETSC_NULL;
51   MatColoringList                  = PETSC_NULL;
52   MatColoringRegisterAllCalled     = PETSC_FALSE;
53   MatPartitioningList              = PETSC_NULL;
54   MatPartitioningRegisterAllCalled = PETSC_FALSE;
55   PetscFunctionReturn(0);
56 }
57 
58 #undef __FUNCT__
59 #define __FUNCT__ "MatInitializePackage"
60 /*@C
61   MatInitializePackage - This function initializes everything in the Mat package. It is called
62   from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to MatCreate()
63   when using static libraries.
64 
65   Input Parameter:
66   path - The dynamic library path, or PETSC_NULL
67 
68   Level: developer
69 
70 .keywords: Mat, initialize, package
71 .seealso: PetscInitialize()
72 @*/
73 PetscErrorCode  MatInitializePackage(const char path[])
74 {
75   char              logList[256];
76   char              *className;
77   PetscBool         opt;
78   PetscErrorCode    ierr;
79 
80   PetscFunctionBegin;
81   if (MatPackageInitialized) PetscFunctionReturn(0);
82   MatPackageInitialized = PETSC_TRUE;
83   /* Inialize subpackage */
84   ierr = MatMFFDInitializePackage(path);CHKERRQ(ierr);
85   /* Register Classes */
86   ierr = PetscClassIdRegister("Matrix",&MAT_CLASSID);CHKERRQ(ierr);
87   ierr = PetscClassIdRegister("Matrix FD Coloring",&MAT_FDCOLORING_CLASSID);CHKERRQ(ierr);
88   ierr = PetscClassIdRegister("Matrix Partitioning",&MAT_PARTITIONING_CLASSID);CHKERRQ(ierr);
89   ierr = PetscClassIdRegister("Matrix Null Space",&MAT_NULLSPACE_CLASSID);CHKERRQ(ierr);
90   /* Register Constructors */
91   ierr = MatRegisterAll(path);CHKERRQ(ierr);
92   ierr = MatOrderingRegisterAll(path);CHKERRQ(ierr);
93   ierr = MatColoringRegisterAll(path);CHKERRQ(ierr);
94   ierr = MatPartitioningRegisterAll(path);CHKERRQ(ierr);
95   /* Register Events */
96   ierr = PetscLogEventRegister("MatMult",          MAT_CLASSID,&MAT_Mult);CHKERRQ(ierr);
97   ierr = PetscLogEventRegister("MatMults",         MAT_CLASSID,&MAT_Mults);CHKERRQ(ierr);
98   ierr = PetscLogEventRegister("MatMultConstr",    MAT_CLASSID,&MAT_MultConstrained);CHKERRQ(ierr);
99   ierr = PetscLogEventRegister("MatMultAdd",       MAT_CLASSID,&MAT_MultAdd);CHKERRQ(ierr);
100   ierr = PetscLogEventRegister("MatMultTranspose", MAT_CLASSID,&MAT_MultTranspose);CHKERRQ(ierr);
101   ierr = PetscLogEventRegister("MatMultTrConstr",  MAT_CLASSID,&MAT_MultTransposeConstrained);CHKERRQ(ierr);
102   ierr = PetscLogEventRegister("MatMultTrAdd",     MAT_CLASSID,&MAT_MultTransposeAdd);CHKERRQ(ierr);
103   ierr = PetscLogEventRegister("MatSolve",         MAT_CLASSID,&MAT_Solve);CHKERRQ(ierr);
104   ierr = PetscLogEventRegister("MatSolves",        MAT_CLASSID,&MAT_Solves);CHKERRQ(ierr);
105   ierr = PetscLogEventRegister("MatSolveAdd",      MAT_CLASSID,&MAT_SolveAdd);CHKERRQ(ierr);
106   ierr = PetscLogEventRegister("MatSolveTranspos", MAT_CLASSID,&MAT_SolveTranspose);CHKERRQ(ierr);
107   ierr = PetscLogEventRegister("MatSolveTrAdd",    MAT_CLASSID,&MAT_SolveTransposeAdd);CHKERRQ(ierr);
108   ierr = PetscLogEventRegister("MatSOR",           MAT_CLASSID,&MAT_SOR);CHKERRQ(ierr);
109   ierr = PetscLogEventRegister("MatForwardSolve",  MAT_CLASSID,&MAT_ForwardSolve);CHKERRQ(ierr);
110   ierr = PetscLogEventRegister("MatBackwardSolve", MAT_CLASSID,&MAT_BackwardSolve);CHKERRQ(ierr);
111   ierr = PetscLogEventRegister("MatLUFactor",      MAT_CLASSID,&MAT_LUFactor);CHKERRQ(ierr);
112   ierr = PetscLogEventRegister("MatLUFactorSym",   MAT_CLASSID,&MAT_LUFactorSymbolic);CHKERRQ(ierr);
113   ierr = PetscLogEventRegister("MatLUFactorNum",   MAT_CLASSID,&MAT_LUFactorNumeric);CHKERRQ(ierr);
114   ierr = PetscLogEventRegister("MatCholeskyFctr",  MAT_CLASSID,&MAT_CholeskyFactor);CHKERRQ(ierr);
115   ierr = PetscLogEventRegister("MatCholFctrSym",   MAT_CLASSID,&MAT_CholeskyFactorSymbolic);CHKERRQ(ierr);
116   ierr = PetscLogEventRegister("MatCholFctrNum",   MAT_CLASSID,&MAT_CholeskyFactorNumeric);CHKERRQ(ierr);
117   ierr = PetscLogEventRegister("MatILUFactor",     MAT_CLASSID,&MAT_ILUFactor);CHKERRQ(ierr);
118   ierr = PetscLogEventRegister("MatILUFactorSym",  MAT_CLASSID,&MAT_ILUFactorSymbolic);CHKERRQ(ierr);
119   ierr = PetscLogEventRegister("MatICCFactorSym",  MAT_CLASSID,&MAT_ICCFactorSymbolic);CHKERRQ(ierr);
120   ierr = PetscLogEventRegister("MatCopy",          MAT_CLASSID,&MAT_Copy);CHKERRQ(ierr);
121   ierr = PetscLogEventRegister("MatConvert",       MAT_CLASSID,&MAT_Convert);CHKERRQ(ierr);
122   ierr = PetscLogEventRegister("MatScale",         MAT_CLASSID,&MAT_Scale);CHKERRQ(ierr);
123   ierr = PetscLogEventRegister("MatAssemblyBegin", MAT_CLASSID,&MAT_AssemblyBegin);CHKERRQ(ierr);
124   ierr = PetscLogEventRegister("MatAssemblyEnd",   MAT_CLASSID,&MAT_AssemblyEnd);CHKERRQ(ierr);
125   ierr = PetscLogEventRegister("MatSetValues",     MAT_CLASSID,&MAT_SetValues);CHKERRQ(ierr);
126   ierr = PetscLogEventRegister("MatGetValues",     MAT_CLASSID,&MAT_GetValues);CHKERRQ(ierr);
127   ierr = PetscLogEventRegister("MatGetRow",        MAT_CLASSID,&MAT_GetRow);CHKERRQ(ierr);
128   ierr = PetscLogEventRegister("MatGetRowIJ",      MAT_CLASSID,&MAT_GetRowIJ);CHKERRQ(ierr);
129   ierr = PetscLogEventRegister("MatGetSubMatrice", MAT_CLASSID,&MAT_GetSubMatrices);CHKERRQ(ierr);
130   ierr = PetscLogEventRegister("MatGetColoring",   MAT_CLASSID,&MAT_GetColoring);CHKERRQ(ierr);
131   ierr = PetscLogEventRegister("MatGetOrdering",   MAT_CLASSID,&MAT_GetOrdering);CHKERRQ(ierr);
132   ierr = PetscLogEventRegister("MatIncreaseOvrlp", MAT_CLASSID,&MAT_IncreaseOverlap);CHKERRQ(ierr);
133   ierr = PetscLogEventRegister("MatPartitioning",  MAT_PARTITIONING_CLASSID,&MAT_Partitioning);CHKERRQ(ierr);
134   ierr = PetscLogEventRegister("MatZeroEntries",   MAT_CLASSID,&MAT_ZeroEntries);CHKERRQ(ierr);
135   ierr = PetscLogEventRegister("MatLoad",          MAT_CLASSID,&MAT_Load);CHKERRQ(ierr);
136   ierr = PetscLogEventRegister("MatView",          MAT_CLASSID,&MAT_View);CHKERRQ(ierr);
137   ierr = PetscLogEventRegister("MatAXPY",          MAT_CLASSID,&MAT_AXPY);CHKERRQ(ierr);
138   ierr = PetscLogEventRegister("MatFDColorCreate", MAT_FDCOLORING_CLASSID,&MAT_FDColoringCreate);CHKERRQ(ierr);
139   ierr = PetscLogEventRegister("MatFDColorApply",  MAT_FDCOLORING_CLASSID,&MAT_FDColoringApply);CHKERRQ(ierr);
140   ierr = PetscLogEventRegister("MatFDColorFunc",   MAT_FDCOLORING_CLASSID,&MAT_FDColoringFunction);CHKERRQ(ierr);
141   ierr = PetscLogEventRegister("MatTranspose",     MAT_CLASSID,&MAT_Transpose);CHKERRQ(ierr);
142   ierr = PetscLogEventRegister("MatMatMult",       MAT_CLASSID,&MAT_MatMult);CHKERRQ(ierr);
143   ierr = PetscLogEventRegister("MatMatSolve",      MAT_CLASSID,&MAT_MatSolve);CHKERRQ(ierr);
144   ierr = PetscLogEventRegister("MatMatMultSym",    MAT_CLASSID,&MAT_MatMultSymbolic);CHKERRQ(ierr);
145   ierr = PetscLogEventRegister("MatMatMultNum",    MAT_CLASSID,&MAT_MatMultNumeric);CHKERRQ(ierr);
146   ierr = PetscLogEventRegister("MatPtAP",          MAT_CLASSID,&MAT_PtAP);CHKERRQ(ierr);
147   ierr = PetscLogEventRegister("MatPtAPSymbolic",  MAT_CLASSID,&MAT_PtAPSymbolic);CHKERRQ(ierr);
148   ierr = PetscLogEventRegister("MatPtAPNumeric",   MAT_CLASSID,&MAT_PtAPNumeric);CHKERRQ(ierr);
149   ierr = PetscLogEventRegister("MatMatMultTrans",  MAT_CLASSID,&MAT_MatMultTranspose);CHKERRQ(ierr);
150   ierr = PetscLogEventRegister("MatMatMultTrnSym" ,MAT_CLASSID,&MAT_MatMultTransposeSymbolic);CHKERRQ(ierr);
151   ierr = PetscLogEventRegister("MatMatMultTrnNum", MAT_CLASSID,&MAT_MatMultTransposeNumeric);CHKERRQ(ierr);
152   ierr = PetscLogEventRegister("MatGetRedundant",  MAT_CLASSID,&MAT_GetRedundantMatrix);CHKERRQ(ierr);
153   ierr = PetscLogEventRegister("MatGetSeqNZStrct", MAT_CLASSID,&MAT_GetSequentialNonzeroStructure);CHKERRQ(ierr);
154   ierr = PetscLogEventRegister("MatGetMultiProcBlock", MAT_CLASSID,&MAT_GetMultiProcBlock);CHKERRQ(ierr);
155 
156   /* these may be specific to MPIAIJ matrices */
157   ierr = PetscLogEventRegister("MatMerge_SeqsToMPINumeric",MAT_CLASSID,&MAT_Seqstompinum);
158   ierr = PetscLogEventRegister("MatMerge_SeqsToMPISymbolic",MAT_CLASSID,&MAT_Seqstompisym);
159   ierr = PetscLogEventRegister("MatMerge_SeqsToMPI",MAT_CLASSID,&MAT_Seqstompi);
160   ierr = PetscLogEventRegister("MatGetLocalMat",MAT_CLASSID,&MAT_Getlocalmat);
161   ierr = PetscLogEventRegister("MatGetLocalMatCondensed",MAT_CLASSID,&MAT_Getlocalmatcondensed);
162   ierr = PetscLogEventRegister("MatGetBrowsOfAcols",MAT_CLASSID,&MAT_GetBrowsOfAcols);
163   ierr = PetscLogEventRegister("MatGetBrAoCol",MAT_CLASSID,&MAT_GetBrowsOfAocols);
164 
165   ierr = PetscLogEventRegister("MatApplyPAPt_Symbolic",MAT_CLASSID,&MAT_Applypapt_symbolic);CHKERRQ(ierr);
166   ierr = PetscLogEventRegister("MatApplyPAPt_Numeric",MAT_CLASSID,&MAT_Applypapt_numeric);CHKERRQ(ierr);
167   ierr = PetscLogEventRegister("MatApplyPAPt",MAT_CLASSID,&MAT_Applypapt);CHKERRQ(ierr);
168 
169   ierr = PetscLogEventRegister("MatGetSymTrans",MAT_CLASSID,&MAT_Getsymtranspose);CHKERRQ(ierr);
170   ierr = PetscLogEventRegister("MatGetSymTransR",MAT_CLASSID,&MAT_Getsymtransreduced);CHKERRQ(ierr);
171   ierr = PetscLogEventRegister("MatTranspose_SeqAIJ_FAST",MAT_CLASSID,&MAT_Transpose_SeqAIJ);CHKERRQ(ierr);
172   ierr = PetscLogEventRegister("MatCUSPCopyTo",MAT_CLASSID,&MAT_CUSPCopyToGPU);CHKERRQ(ierr);
173 
174   /* Turn off high traffic events by default */
175   ierr = PetscLogEventSetActiveAll(MAT_SetValues, PETSC_FALSE);CHKERRQ(ierr);
176   /* Process info exclusions */
177   ierr = PetscOptionsGetString(PETSC_NULL, "-info_exclude", logList, 256, &opt);CHKERRQ(ierr);
178   if (opt) {
179     ierr = PetscStrstr(logList, "mat", &className);CHKERRQ(ierr);
180     if (className) {
181       ierr = PetscInfoDeactivateClass(MAT_CLASSID);CHKERRQ(ierr);
182     }
183   }
184   /* Process summary exclusions */
185   ierr = PetscOptionsGetString(PETSC_NULL, "-log_summary_exclude", logList, 256, &opt);CHKERRQ(ierr);
186   if (opt) {
187     ierr = PetscStrstr(logList, "mat", &className);CHKERRQ(ierr);
188     if (className) {
189       ierr = PetscLogEventDeactivateClass(MAT_CLASSID);CHKERRQ(ierr);
190     }
191   }
192   ierr = PetscRegisterFinalize(MatFinalizePackage);CHKERRQ(ierr);
193   PetscFunctionReturn(0);
194 }
195 
196 #ifdef PETSC_USE_DYNAMIC_LIBRARIES
197 EXTERN_C_BEGIN
198 #undef __FUNCT__
199 #define __FUNCT__ "PetscDLLibraryRegister_petscmat"
200 /*
201   PetscDLLibraryRegister - This function is called when the dynamic library it is in is opened.
202 
203   This one registers all the matrix methods that are in the basic PETSc Matrix library.
204 
205   Input Parameter:
206   path - library path
207  */
208 PetscErrorCode  PetscDLLibraryRegister_petscmat(const char path[])
209 {
210   PetscErrorCode ierr;
211 
212   PetscFunctionBegin;
213   ierr = MatInitializePackage(path);CHKERRQ(ierr);
214   PetscFunctionReturn(0);
215 }
216 EXTERN_C_END
217 
218 
219 #endif /* PETSC_USE_DYNAMIC_LIBRARIES */
220