xref: /petsc/src/mat/interface/matreg.c (revision 3050cee28ff83b093d983d7c5197e87b438ca09b)
1 #define PETSCMAT_DLL
2 
3 /*
4      Mechanism for register PETSc matrix types
5 */
6 #include "include/private/matimpl.h"      /*I "petscmat.h" I*/
7 #include "petscsys.h"
8 
9 PetscTruth MatRegisterAllCalled = PETSC_FALSE;
10 
11 /*
12    Contains the list of registered Mat routines
13 */
14 PetscFList MatList = 0;
15 
16 #undef __FUNCT__
17 #define __FUNCT__ "MatSetType"
18 /*@C
19    MatSetType - Builds matrix object for a particular matrix type
20 
21    Collective on Mat
22 
23    Input Parameters:
24 +  mat      - the matrix object
25 -  matype   - matrix type
26 
27    Options Database Key:
28 .  -mat_type  <method> - Sets the type; use -help for a list
29     of available methods (for instance, seqaij)
30 
31    Notes:
32    See "${PETSC_DIR}/include/petscmat.h" for available methods
33 
34   Level: intermediate
35 
36 .keywords: Mat, MatType, set, method
37 
38 .seealso: PCSetType(), VecSetType(), MatCreate(), MatType, Mat
39 @*/
40 PetscErrorCode PETSCMAT_DLLEXPORT MatSetType(Mat mat, MatType matype)
41 {
42   PetscErrorCode ierr,(*r)(Mat);
43   PetscTruth     sametype;
44 
45   PetscFunctionBegin;
46   PetscValidHeaderSpecific(mat,MAT_COOKIE,1);
47   if (mat->rmap.n < 0 && mat->rmap.N < 0 && mat->cmap.n < 0 && mat->cmap.N < 0) SETERRQ(PETSC_ERR_ARG_WRONGSTATE,"Must call MatSetSizes() first");
48   ierr = PetscTypeCompare((PetscObject)mat,matype,&sametype);CHKERRQ(ierr);
49   if (!sametype) {
50     /* Get the function pointers for the matrix requested */
51     if (!MatRegisterAllCalled) {ierr = MatRegisterAll(PETSC_NULL);CHKERRQ(ierr);}
52     ierr =  PetscFListFind(mat->comm,MatList,matype,(void(**)(void))&r);CHKERRQ(ierr);
53     if (!r) SETERRQ1(PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown Mat type given: %s",matype);
54 
55     /* free the old data structure if it existed */
56     if (mat->ops->destroy) {
57       ierr = MatPreallocated(mat);CHKERRQ(ierr);
58       ierr = (*mat->ops->destroy)(mat);CHKERRQ(ierr);
59       mat->ops->destroy = PETSC_NULL;
60       mat->preallocated = PETSC_FALSE;
61     }
62 
63     /* create the new data structure */
64     ierr = (*r)(mat);CHKERRQ(ierr);
65   }
66   ierr = PetscPublishAll(mat);CHKERRQ(ierr);
67   PetscFunctionReturn(0);
68 }
69 
70 
71 #undef __FUNCT__
72 #define __FUNCT__ "MatRegisterDestroy"
73 /*@C
74    MatRegisterDestroy - Frees the list of matrix types that were
75    registered by MatRegister()/MatRegisterDynamic().
76 
77    Not Collective
78 
79    Level: advanced
80 
81 .keywords: Mat, register, destroy
82 
83 .seealso: MatRegister(), MatRegisterAll(), MatRegisterDynamic()
84 @*/
85 PetscErrorCode PETSCMAT_DLLEXPORT MatRegisterDestroy(void)
86 {
87   PetscErrorCode ierr;
88 
89   PetscFunctionBegin;
90   if (MatList) {
91     ierr = PetscFListDestroy(&MatList);CHKERRQ(ierr);
92     MatList = 0;
93   }
94   MatRegisterAllCalled = PETSC_FALSE;
95   PetscFunctionReturn(0);
96 }
97 
98 #undef __FUNCT__
99 #define __FUNCT__ "MatGetType"
100 /*@C
101    MatGetType - Gets the matrix type as a string from the matrix object.
102 
103    Not Collective
104 
105    Input Parameter:
106 .  mat - the matrix
107 
108    Output Parameter:
109 .  name - name of matrix type
110 
111    Level: intermediate
112 
113 .keywords: Mat, MatType, get, method, name
114 
115 .seealso: MatSetType()
116 @*/
117 PetscErrorCode PETSCMAT_DLLEXPORT MatGetType(Mat mat,MatType *type)
118 {
119   PetscFunctionBegin;
120   *type = mat->type_name;
121   PetscFunctionReturn(0);
122 }
123 
124 
125 #undef __FUNCT__
126 #define __FUNCT__ "MatRegister"
127 /*@C
128   MatRegister - See MatRegisterDynamic()
129 
130   Level: advanced
131 @*/
132 PetscErrorCode PETSCMAT_DLLEXPORT MatRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(Mat))
133 {
134   PetscErrorCode ierr;
135   char           fullname[PETSC_MAX_PATH_LEN];
136 
137   PetscFunctionBegin;
138   ierr = PetscFListConcat(path,name,fullname);CHKERRQ(ierr);
139   ierr = PetscFListAdd(&MatList,sname,fullname,(void (*)(void))function);CHKERRQ(ierr);
140   PetscFunctionReturn(0);
141 }
142 
143 
144 
145 
146 
147 
148 
149 
150 
151 
152