Actual source code: matreg.c

  1: #define PETSCMAT_DLL

  3: /*
  4:      Mechanism for register PETSc matrix types
  5: */
 6:  #include include/private/matimpl.h
 7:  #include petscsys.h

  9: PetscTruth MatRegisterAllCalled = PETSC_FALSE;

 11: /*
 12:    Contains the list of registered Mat routines
 13: */
 14: PetscFList MatList = 0;

 18: /*@C
 19:    MatSetType - Builds matrix object for a particular matrix type

 21:    Collective on Mat

 23:    Input Parameters:
 24: +  mat      - the matrix object
 25: -  matype   - matrix type

 27:    Options Database Key:
 28: .  -mat_type  <method> - Sets the type; use -help for a list 
 29:     of available methods (for instance, seqaij)

 31:    Notes:  
 32:    See "${PETSC_DIR}/include/petscmat.h" for available methods

 34:   Level: intermediate

 36: .keywords: Mat, MatType, set, method

 38: .seealso: PCSetType(), VecSetType(), MatCreate(), MatType, Mat
 39: @*/
 40: PetscErrorCode  MatSetType(Mat mat, MatType matype)
 41: {
 42:   PetscErrorCode ierr,(*r)(Mat);
 43:   PetscTruth     sametype;

 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:   PetscTypeCompare((PetscObject)mat,matype,&sametype);
 49:   if (!sametype) {
 50:     /* Get the function pointers for the matrix requested */
 51:     if (!MatRegisterAllCalled) {MatRegisterAll(PETSC_NULL);}
 52:      PetscFListFind(mat->comm,MatList,matype,(void(**)(void))&r);
 53:     if (!r) SETERRQ1(PETSC_ERR_ARG_UNKNOWN_TYPE,"Unknown Mat type given: %s",matype);

 55:     /* free the old data structure if it existed */
 56:     if (mat->ops->destroy) {
 57:       MatPreallocated(mat);
 58:       (*mat->ops->destroy)(mat);
 59:       mat->ops->destroy = PETSC_NULL;
 60:       mat->preallocated = PETSC_FALSE;
 61:     }

 63:     /* create the new data structure */
 64:     (*r)(mat);
 65:   }
 66:   PetscPublishAll(mat);
 67:   return(0);
 68: }


 73: /*@C
 74:    MatRegisterDestroy - Frees the list of matrix types that were
 75:    registered by MatRegister()/MatRegisterDynamic().

 77:    Not Collective

 79:    Level: advanced

 81: .keywords: Mat, register, destroy

 83: .seealso: MatRegister(), MatRegisterAll(), MatRegisterDynamic()
 84: @*/
 85: PetscErrorCode  MatRegisterDestroy(void)
 86: {

 90:   if (MatList) {
 91:     PetscFListDestroy(&MatList);
 92:     MatList = 0;
 93:   }
 94:   MatRegisterAllCalled = PETSC_FALSE;
 95:   return(0);
 96: }

100: /*@C
101:    MatGetType - Gets the matrix type as a string from the matrix object.

103:    Not Collective

105:    Input Parameter:
106: .  mat - the matrix

108:    Output Parameter:
109: .  name - name of matrix type

111:    Level: intermediate

113: .keywords: Mat, MatType, get, method, name

115: .seealso: MatSetType()
116: @*/
117: PetscErrorCode  MatGetType(Mat mat,MatType *type)
118: {
120:   *type = mat->type_name;
121:   return(0);
122: }


127: /*@C
128:   MatRegister - See MatRegisterDynamic()

130:   Level: advanced
131: @*/
132: PetscErrorCode  MatRegister(const char sname[],const char path[],const char name[],PetscErrorCode (*function)(Mat))
133: {
135:   char           fullname[PETSC_MAX_PATH_LEN];

138:   PetscFListConcat(path,name,fullname);
139:   PetscFListAdd(&MatList,sname,fullname,(void (*)(void))function);
140:   return(0);
141: }