xref: /petsc/src/mat/interface/dlregismat.c (revision b022a5c136836438e4f06517ed69d7947f7243d0)
11153da11SBarry Smith #define PETSCMAT_DLL
21153da11SBarry Smith 
37c4f633dSBarry Smith #include "private/matimpl.h"
41153da11SBarry Smith 
5ea5af983SLisandro Dalcin const char *MatOptions[] = {"ROW_ORIENTED","NEW_NONZERO_LOCATIONS",
64e0d8c25SBarry Smith               "SYMMETRIC",
74e0d8c25SBarry Smith               "STRUCTURALLY_SYMMETRIC",
8dc5b3d67SBarry Smith               "NEW_DIAGONALS",
94e0d8c25SBarry Smith               "IGNORE_OFF_PROC_ENTRIES",
104e0d8c25SBarry Smith               "NEW_NONZERO_LOCATION_ERR",
11290bbb0aSBarry Smith               "NEW_NONZERO_ALLOCATION_ERR","USE_HASH_TABLE",
12290bbb0aSBarry Smith               "KEEP_ZEROED_ROWS","IGNORE_ZERO_ENTRIES","USE_INODES",
134e0d8c25SBarry Smith               "HERMITIAN",
144e0d8c25SBarry Smith               "SYMMETRY_ETERNAL",
154e0d8c25SBarry Smith               "USE_COMPRESSEDROW",
16290bbb0aSBarry Smith               "IGNORE_LOWER_TRIANGULAR","ERROR_LOWER_TRIANGULAR","GETROW_UPPERTRIANGULAR","MatOption","MAT_",0};
17290bbb0aSBarry Smith 
18e5beb14aSMatthew Knepley EXTERN PetscErrorCode PETSCMAT_DLLEXPORT MatMFFDInitializePackage(const char[]);
19*b022a5c1SBarry Smith static PetscTruth MatPackageInitialized = PETSC_FALSE;
20*b022a5c1SBarry Smith #undef __FUNCT__
21*b022a5c1SBarry Smith #define __FUNCT__ "MatFinalizePackage"
22*b022a5c1SBarry Smith /*@C
23*b022a5c1SBarry Smith   MatFinalizePackage - This function destroys everything in the Petsc interface to the charactoristics package. It is
24*b022a5c1SBarry Smith   called from PetscFinalize().
25*b022a5c1SBarry Smith 
26*b022a5c1SBarry Smith   Level: developer
27*b022a5c1SBarry Smith 
28*b022a5c1SBarry Smith .keywords: Petsc, destroy, package, mathematica
29*b022a5c1SBarry Smith .seealso: PetscFinalize()
30*b022a5c1SBarry Smith @*/
31*b022a5c1SBarry Smith PetscErrorCode PETSC_DLLEXPORT MatFinalizePackage(void)
32*b022a5c1SBarry Smith {
33*b022a5c1SBarry Smith   PetscFunctionBegin;
34*b022a5c1SBarry Smith   MatPackageInitialized            = PETSC_FALSE;
35*b022a5c1SBarry Smith   MatRegisterAllCalled             = PETSC_FALSE;
36*b022a5c1SBarry Smith   MatList                          = PETSC_NULL;
37*b022a5c1SBarry Smith   MatOrderingRegisterAllCalled     = PETSC_FALSE;
38*b022a5c1SBarry Smith   MatOrderingList                  = PETSC_NULL;
39*b022a5c1SBarry Smith   MatColoringList                  = PETSC_NULL;
40*b022a5c1SBarry Smith   MatColoringRegisterAllCalled     = PETSC_FALSE;
41*b022a5c1SBarry Smith   MatPartitioningList              = PETSC_NULL;
42*b022a5c1SBarry Smith   MatPartitioningRegisterAllCalled = PETSC_FALSE;
43*b022a5c1SBarry Smith   PetscFunctionReturn(0);
44*b022a5c1SBarry Smith }
45e5beb14aSMatthew Knepley 
461153da11SBarry Smith #undef __FUNCT__
471153da11SBarry Smith #define __FUNCT__ "MatInitializePackage"
481153da11SBarry Smith /*@C
491153da11SBarry Smith   MatInitializePackage - This function initializes everything in the Mat package. It is called
501153da11SBarry Smith   from PetscDLLibraryRegister() when using dynamic libraries, and on the first call to MatCreate()
511153da11SBarry Smith   when using static libraries.
521153da11SBarry Smith 
531153da11SBarry Smith   Input Parameter:
541153da11SBarry Smith   path - The dynamic library path, or PETSC_NULL
551153da11SBarry Smith 
561153da11SBarry Smith   Level: developer
571153da11SBarry Smith 
581153da11SBarry Smith .keywords: Mat, initialize, package
591153da11SBarry Smith .seealso: PetscInitialize()
601153da11SBarry Smith @*/
61e5bd5246SBarry Smith PetscErrorCode PETSCMAT_DLLEXPORT MatInitializePackage(const char path[])
621153da11SBarry Smith {
631153da11SBarry Smith   char              logList[256];
641153da11SBarry Smith   char              *className;
651153da11SBarry Smith   PetscTruth        opt;
661153da11SBarry Smith   PetscErrorCode    ierr;
671153da11SBarry Smith 
681153da11SBarry Smith   PetscFunctionBegin;
69*b022a5c1SBarry Smith   if (MatPackageInitialized) PetscFunctionReturn(0);
70*b022a5c1SBarry Smith   MatPackageInitialized = PETSC_TRUE;
71cce0b1b2SLisandro Dalcin   /* Inialize subpackage */
72cce0b1b2SLisandro Dalcin   ierr = MatMFFDInitializePackage(path);CHKERRQ(ierr);
731153da11SBarry Smith   /* Register Classes */
749afaeae2SBarry Smith   ierr = PetscCookieRegister("Matrix",&MAT_COOKIE);CHKERRQ(ierr);
759afaeae2SBarry Smith   ierr = PetscCookieRegister("Matrix FD Coloring",&MAT_FDCOLORING_COOKIE);CHKERRQ(ierr);
769afaeae2SBarry Smith   ierr = PetscCookieRegister("Matrix Partitioning",&MAT_PARTITIONING_COOKIE);CHKERRQ(ierr);
779afaeae2SBarry Smith   ierr = PetscCookieRegister("Matrix Null Space",&MAT_NULLSPACE_COOKIE);CHKERRQ(ierr);
781153da11SBarry Smith   /* Register Constructors */
791153da11SBarry Smith   ierr = MatRegisterAll(path);CHKERRQ(ierr);
80cce0b1b2SLisandro Dalcin   ierr = MatOrderingRegisterAll(path);CHKERRQ(ierr);
81cce0b1b2SLisandro Dalcin   ierr = MatColoringRegisterAll(path);CHKERRQ(ierr);
82cce0b1b2SLisandro Dalcin   ierr = MatPartitioningRegisterAll(path);CHKERRQ(ierr);
831153da11SBarry Smith   /* Register Events */
848cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMult",          MAT_COOKIE,&MAT_Mult);CHKERRQ(ierr);
858cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMults",         MAT_COOKIE,&MAT_Mults);CHKERRQ(ierr);
868cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMultConstr",    MAT_COOKIE,&MAT_MultConstrained);CHKERRQ(ierr);
878cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMultAdd",       MAT_COOKIE,&MAT_MultAdd);CHKERRQ(ierr);
888cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMultTranspose", MAT_COOKIE,&MAT_MultTranspose);CHKERRQ(ierr);
898cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMultTrConstr",  MAT_COOKIE,&MAT_MultTransposeConstrained);CHKERRQ(ierr);
908cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMultTrAdd",     MAT_COOKIE,&MAT_MultTransposeAdd);CHKERRQ(ierr);
918cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatSolve",         MAT_COOKIE,&MAT_Solve);CHKERRQ(ierr);
928cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatSolves",        MAT_COOKIE,&MAT_Solves);CHKERRQ(ierr);
938cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatSolveAdd",      MAT_COOKIE,&MAT_SolveAdd);CHKERRQ(ierr);
948cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatSolveTranspos", MAT_COOKIE,&MAT_SolveTranspose);CHKERRQ(ierr);
958cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatSolveTrAdd",    MAT_COOKIE,&MAT_SolveTransposeAdd);CHKERRQ(ierr);
968cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatRelax",         MAT_COOKIE,&MAT_Relax);CHKERRQ(ierr);
978cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatForwardSolve",  MAT_COOKIE,&MAT_ForwardSolve);CHKERRQ(ierr);
988cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatBackwardSolve", MAT_COOKIE,&MAT_BackwardSolve);CHKERRQ(ierr);
998cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatLUFactor",      MAT_COOKIE,&MAT_LUFactor);CHKERRQ(ierr);
1008cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatLUFactorSym",   MAT_COOKIE,&MAT_LUFactorSymbolic);CHKERRQ(ierr);
1018cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatLUFactorNum",   MAT_COOKIE,&MAT_LUFactorNumeric);CHKERRQ(ierr);
1028cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatCholeskyFctr",  MAT_COOKIE,&MAT_CholeskyFactor);CHKERRQ(ierr);
1038cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatCholFctrSym",   MAT_COOKIE,&MAT_CholeskyFactorSymbolic);CHKERRQ(ierr);
1048cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatCholFctrNum",   MAT_COOKIE,&MAT_CholeskyFactorNumeric);CHKERRQ(ierr);
1058cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatILUFactor",     MAT_COOKIE,&MAT_ILUFactor);CHKERRQ(ierr);
1068cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatILUFactorSym",  MAT_COOKIE,&MAT_ILUFactorSymbolic);CHKERRQ(ierr);
1078cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatICCFactorSym",  MAT_COOKIE,&MAT_ICCFactorSymbolic);CHKERRQ(ierr);
1088cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatCopy",          MAT_COOKIE,&MAT_Copy);CHKERRQ(ierr);
1098cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatConvert",       MAT_COOKIE,&MAT_Convert);CHKERRQ(ierr);
1108cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatScale",         MAT_COOKIE,&MAT_Scale);CHKERRQ(ierr);
1118cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatAssemblyBegin", MAT_COOKIE,&MAT_AssemblyBegin);CHKERRQ(ierr);
1128cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatAssemblyEnd",   MAT_COOKIE,&MAT_AssemblyEnd);CHKERRQ(ierr);
1138cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatSetValues",     MAT_COOKIE,&MAT_SetValues);CHKERRQ(ierr);
1148cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetValues",     MAT_COOKIE,&MAT_GetValues);CHKERRQ(ierr);
1158cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetRow",        MAT_COOKIE,&MAT_GetRow);CHKERRQ(ierr);
1168cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetRowIJ",      MAT_COOKIE,&MAT_GetRowIJ);CHKERRQ(ierr);
1178cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetSubMatrice", MAT_COOKIE,&MAT_GetSubMatrices);CHKERRQ(ierr);
1188cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetColoring",   MAT_COOKIE,&MAT_GetColoring);CHKERRQ(ierr);
1198cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetOrdering",   MAT_COOKIE,&MAT_GetOrdering);CHKERRQ(ierr);
1208cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatIncreaseOvrlp", MAT_COOKIE,&MAT_IncreaseOverlap);CHKERRQ(ierr);
1218cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatPartitioning",  MAT_PARTITIONING_COOKIE,&MAT_Partitioning);CHKERRQ(ierr);
1228cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatZeroEntries",   MAT_COOKIE,&MAT_ZeroEntries);CHKERRQ(ierr);
1238cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatLoad",          MAT_COOKIE,&MAT_Load);CHKERRQ(ierr);
1248cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatView",          MAT_COOKIE,&MAT_View);CHKERRQ(ierr);
1258cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatAXPY",          MAT_COOKIE,&MAT_AXPY);CHKERRQ(ierr);
1268cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatFDColorCreate", MAT_FDCOLORING_COOKIE,&MAT_FDColoringCreate);CHKERRQ(ierr);
1278cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatFDColorApply",  MAT_FDCOLORING_COOKIE,&MAT_FDColoringApply);CHKERRQ(ierr);
1288cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatFDColorFunc",   MAT_FDCOLORING_COOKIE,&MAT_FDColoringFunction);CHKERRQ(ierr);
1298cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatTranspose",     MAT_COOKIE,&MAT_Transpose);CHKERRQ(ierr);
1308cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMatMult",       MAT_COOKIE,&MAT_MatMult);CHKERRQ(ierr);
1313639cd1fSBarry Smith   ierr = PetscLogEventRegister("MatMatSolve",      MAT_COOKIE,&MAT_MatSolve);CHKERRQ(ierr);
1328cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMatMultSym",    MAT_COOKIE,&MAT_MatMultSymbolic);CHKERRQ(ierr);
1338cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMatMultNum",    MAT_COOKIE,&MAT_MatMultNumeric);CHKERRQ(ierr);
1348cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatPtAP",          MAT_COOKIE,&MAT_PtAP);CHKERRQ(ierr);
1358cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatPtAPSymbolic",  MAT_COOKIE,&MAT_PtAPSymbolic);CHKERRQ(ierr);
1368cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatPtAPNumeric",   MAT_COOKIE,&MAT_PtAPNumeric);CHKERRQ(ierr);
1378cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMatMultTrans",  MAT_COOKIE,&MAT_MatMultTranspose);CHKERRQ(ierr);
1388cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMatMultTrnSym" ,MAT_COOKIE,&MAT_MatMultTransposeSymbolic);CHKERRQ(ierr);
1398cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMatMultTrnNum", MAT_COOKIE,&MAT_MatMultTransposeNumeric);CHKERRQ(ierr);
1400fc9d207SBarry Smith   ierr = PetscLogEventRegister("MatGetRedundant",  MAT_COOKIE,&MAT_GetRedundantMatrix);CHKERRQ(ierr);
1410fc9d207SBarry Smith   ierr = PetscLogEventRegister("MatGetSeqNZStrct", MAT_COOKIE,&MAT_GetSequentialNonzeroStructure);CHKERRQ(ierr);
1424ebed01fSBarry Smith 
1434ebed01fSBarry Smith   /* these may be specific to MPIAIJ matrices */
1448cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMerge_SeqsToMPINumeric",MAT_COOKIE,&MAT_Seqstompinum);
1458cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMerge_SeqsToMPISymbolic",MAT_COOKIE,&MAT_Seqstompisym);
1468cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatMerge_SeqsToMPI",MAT_COOKIE,&MAT_Seqstompi);
1478cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetLocalMat",MAT_COOKIE,&MAT_Getlocalmat);
1488cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetLocalMatCondensed",MAT_COOKIE,&MAT_Getlocalmatcondensed);
1498cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetBrowsOfAcols",MAT_COOKIE,&MAT_GetBrowsOfAcols);
1508cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatGetBrAoCol",MAT_COOKIE,&MAT_GetBrowsOfAocols);
1514ebed01fSBarry Smith 
1528cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatApplyPAPt_Symbolic",MAT_COOKIE,&MAT_Applypapt_symbolic);CHKERRQ(ierr);
1538cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatApplyPAPt_Numeric",MAT_COOKIE,&MAT_Applypapt_numeric);CHKERRQ(ierr);
1548cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatApplyPAPt",MAT_COOKIE,&MAT_Applypapt);CHKERRQ(ierr);
1554ebed01fSBarry Smith 
1560fc9d207SBarry Smith   ierr = PetscLogEventRegister("MatGetSymTrans",MAT_COOKIE,&MAT_Getsymtranspose);CHKERRQ(ierr);
1570fc9d207SBarry Smith   ierr = PetscLogEventRegister("MatGetSymTransR",MAT_COOKIE,&MAT_Getsymtransreduced);CHKERRQ(ierr);
1588cbcd9ccSBarry Smith   ierr = PetscLogEventRegister("MatTranspose_SeqAIJ_FAST",MAT_COOKIE,&MAT_Transpose_SeqAIJ);CHKERRQ(ierr);
1594ebed01fSBarry Smith 
1601153da11SBarry Smith   /* Turn off high traffic events by default */
1611153da11SBarry Smith   ierr = PetscLogEventSetActiveAll(MAT_SetValues, PETSC_FALSE);CHKERRQ(ierr);
1621153da11SBarry Smith   /* Process info exclusions */
1636cf91177SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL, "-info_exclude", logList, 256, &opt);CHKERRQ(ierr);
1641153da11SBarry Smith   if (opt) {
1651153da11SBarry Smith     ierr = PetscStrstr(logList, "mat", &className);CHKERRQ(ierr);
1661153da11SBarry Smith     if (className) {
1676cf91177SBarry Smith       ierr = PetscInfoDeactivateClass(MAT_COOKIE);CHKERRQ(ierr);
1681153da11SBarry Smith     }
1691153da11SBarry Smith   }
1701153da11SBarry Smith   /* Process summary exclusions */
1711153da11SBarry Smith   ierr = PetscOptionsGetString(PETSC_NULL, "-log_summary_exclude", logList, 256, &opt);CHKERRQ(ierr);
1721153da11SBarry Smith   if (opt) {
1731153da11SBarry Smith     ierr = PetscStrstr(logList, "mat", &className);CHKERRQ(ierr);
1741153da11SBarry Smith     if (className) {
1751153da11SBarry Smith       ierr = PetscLogEventDeactivateClass(MAT_COOKIE);CHKERRQ(ierr);
1761153da11SBarry Smith     }
1771153da11SBarry Smith   }
178*b022a5c1SBarry Smith   ierr = PetscRegisterFinalize(MatFinalizePackage);CHKERRQ(ierr);
1791153da11SBarry Smith   PetscFunctionReturn(0);
1801153da11SBarry Smith }
1811153da11SBarry Smith 
1821153da11SBarry Smith #ifdef PETSC_USE_DYNAMIC_LIBRARIES
1831153da11SBarry Smith EXTERN_C_BEGIN
1841153da11SBarry Smith #undef __FUNCT__
1851153da11SBarry Smith #define __FUNCT__ "PetscDLLibraryRegister_petscmat"
1861153da11SBarry Smith /*
1871153da11SBarry Smith   PetscDLLibraryRegister - This function is called when the dynamic library it is in is opened.
1881153da11SBarry Smith 
1893f92711fSBarry Smith   This one registers all the matrix methods that are in the basic PETSc Matrix library.
1901153da11SBarry Smith 
1911153da11SBarry Smith   Input Parameter:
1921153da11SBarry Smith   path - library path
1931153da11SBarry Smith  */
194e5bd5246SBarry Smith PetscErrorCode PETSCMAT_DLLEXPORT PetscDLLibraryRegister_petscmat(const char path[])
1951153da11SBarry Smith {
1961153da11SBarry Smith   PetscErrorCode ierr;
1971153da11SBarry Smith 
1981153da11SBarry Smith   ierr = PetscInitializeNoArguments(); if (ierr) return 1;
1991153da11SBarry Smith 
2001153da11SBarry Smith   PetscFunctionBegin;
2011153da11SBarry Smith   /*
2021153da11SBarry Smith       If we got here then PETSc was properly loaded
2031153da11SBarry Smith   */
2041153da11SBarry Smith   ierr = MatInitializePackage(path);CHKERRQ(ierr);
2051153da11SBarry Smith   PetscFunctionReturn(0);
2061153da11SBarry Smith }
2071153da11SBarry Smith EXTERN_C_END
2081153da11SBarry Smith 
2091153da11SBarry Smith 
2101153da11SBarry Smith #endif /* PETSC_USE_DYNAMIC_LIBRARIES */
211