Actual source code: gcreate.c

petsc-master 2019-07-16
Report Typos and Errors

  2:  #include <petsc/private/matimpl.h>

  4: PETSC_INTERN PetscErrorCode MatSetBlockSizes_Default(Mat mat,PetscInt rbs, PetscInt cbs)
  5: {
  7:   if (!mat->preallocated) return(0);
  8:   if (mat->rmap->bs > 0 && mat->rmap->bs != rbs) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Cannot change row block size %D to %D\n",mat->rmap->bs,rbs);
  9:   if (mat->cmap->bs > 0 && mat->cmap->bs != cbs) SETERRQ2(PetscObjectComm((PetscObject)mat),PETSC_ERR_SUP,"Cannot change column block size %D to %D\n",mat->cmap->bs,cbs);
 10:   return(0);
 11: }

 13: PETSC_INTERN PetscErrorCode MatShift_Basic(Mat Y,PetscScalar a)
 14: {
 16:   PetscInt       i,start,end;
 17:   PetscScalar    alpha = a;
 18:   PetscBool      prevoption;

 21:   MatGetOption(Y,MAT_NO_OFF_PROC_ENTRIES,&prevoption);
 22:   MatSetOption(Y,MAT_NO_OFF_PROC_ENTRIES,PETSC_TRUE);
 23:   MatGetOwnershipRange(Y,&start,&end);
 24:   for (i=start; i<end; i++) {
 25:     if (i < Y->cmap->N) {
 26:       MatSetValues(Y,1,&i,1,&i,&alpha,ADD_VALUES);
 27:     }
 28:   }
 29:   MatAssemblyBegin(Y,MAT_FINAL_ASSEMBLY);
 30:   MatAssemblyEnd(Y,MAT_FINAL_ASSEMBLY);
 31:   MatSetOption(Y,MAT_NO_OFF_PROC_ENTRIES,prevoption);
 32:   return(0);
 33: }

 35: /*@
 36:    MatCreate - Creates a matrix where the type is determined
 37:    from either a call to MatSetType() or from the options database
 38:    with a call to MatSetFromOptions(). The default matrix type is
 39:    AIJ, using the routines MatCreateSeqAIJ() or MatCreateAIJ()
 40:    if you do not set a type in the options database. If you never
 41:    call MatSetType() or MatSetFromOptions() it will generate an
 42:    error when you try to use the matrix.

 44:    Collective

 46:    Input Parameter:
 47: .  comm - MPI communicator

 49:    Output Parameter:
 50: .  A - the matrix

 52:    Options Database Keys:
 53: +    -mat_type seqaij   - AIJ type, uses MatCreateSeqAIJ()
 54: .    -mat_type mpiaij   - AIJ type, uses MatCreateAIJ()
 55: .    -mat_type seqdense - dense type, uses MatCreateSeqDense()
 56: .    -mat_type mpidense - dense type, uses MatCreateDense()
 57: .    -mat_type seqbaij  - block AIJ type, uses MatCreateSeqBAIJ()
 58: -    -mat_type mpibaij  - block AIJ type, uses MatCreateBAIJ()

 60:    Even More Options Database Keys:
 61:    See the manpages for particular formats (e.g., MatCreateSeqAIJ())
 62:    for additional format-specific options.

 64:    Notes:

 66:    Level: beginner

 68:    User manual sections:
 69: +   Section 3.1 Creating and Assembling Matrices
 70: -   Chapter 3 Matrices

 72: .seealso: MatCreateSeqAIJ(), MatCreateAIJ(),
 73:           MatCreateSeqDense(), MatCreateDense(),
 74:           MatCreateSeqBAIJ(), MatCreateBAIJ(),
 75:           MatCreateSeqSBAIJ(), MatCreateSBAIJ(),
 76:           MatConvert()
 77: @*/
 78: PetscErrorCode  MatCreate(MPI_Comm comm,Mat *A)
 79: {
 80:   Mat            B;


 86:   *A = NULL;
 87:   MatInitializePackage();

 89:   PetscHeaderCreate(B,MAT_CLASSID,"Mat","Matrix","Mat",comm,MatDestroy,MatView);
 90:   PetscLayoutCreate(comm,&B->rmap);
 91:   PetscLayoutCreate(comm,&B->cmap);
 92:   PetscStrallocpy(VECSTANDARD,&B->defaultvectype);

 94:   B->congruentlayouts = PETSC_DECIDE;
 95:   B->preallocated     = PETSC_FALSE;
 96:   *A                  = B;
 97:   return(0);
 98: }

100: /*@
101:    MatSetErrorIfFailure - Causes Mat to generate an error, for example a zero pivot, is detected.

103:    Logically Collective on Mat

105:    Input Parameters:
106: +  mat -  matrix obtained from MatCreate()
107: -  flg - PETSC_TRUE indicates you want the error generated

109:    Level: advanced

111: .seealso: PCSetErrorIfFailure()
112: @*/
113: PetscErrorCode  MatSetErrorIfFailure(Mat mat,PetscBool flg)
114: {
118:   mat->erroriffailure = flg;
119:   return(0);
120: }

122: /*@
123:   MatSetSizes - Sets the local and global sizes, and checks to determine compatibility

125:   Collective on Mat

127:   Input Parameters:
128: +  A - the matrix
129: .  m - number of local rows (or PETSC_DECIDE)
130: .  n - number of local columns (or PETSC_DECIDE)
131: .  M - number of global rows (or PETSC_DETERMINE)
132: -  N - number of global columns (or PETSC_DETERMINE)

134:    Notes:
135:    m (n) and M (N) cannot be both PETSC_DECIDE
136:    If one processor calls this with M (N) of PETSC_DECIDE then all processors must, otherwise the program will hang.

138:    If PETSC_DECIDE is not used for the arguments 'm' and 'n', then the
139:    user must ensure that they are chosen to be compatible with the
140:    vectors. To do this, one first considers the matrix-vector product
141:    'y = A x'. The 'm' that is used in the above routine must match the
142:    local size used in the vector creation routine VecCreateMPI() for 'y'.
143:    Likewise, the 'n' used must match that used as the local size in
144:    VecCreateMPI() for 'x'.

146:    You cannot change the sizes once they have been set.

148:    The sizes must be set before MatSetUp() or MatXXXSetPreallocation() is called.

150:   Level: beginner

152: .seealso: MatGetSize(), PetscSplitOwnership()
153: @*/
154: PetscErrorCode  MatSetSizes(Mat A, PetscInt m, PetscInt n, PetscInt M, PetscInt N)
155: {
160:   if (M > 0 && m > M) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Local column size %D cannot be larger than global column size %D",m,M);
161:   if (N > 0 && n > N) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_INCOMP,"Local row size %D cannot be larger than global row size %D",n,N);
162:   if ((A->rmap->n >= 0 && A->rmap->N >= 0) && (A->rmap->n != m || (M > 0 && A->rmap->N != M))) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot change/reset row sizes to %D local %D global after previously setting them to %D local %D global",m,M,A->rmap->n,A->rmap->N);
163:   if ((A->cmap->n >= 0 && A->cmap->N >= 0) && (A->cmap->n != n || (N > 0 && A->cmap->N != N))) SETERRQ4(PETSC_COMM_SELF,PETSC_ERR_SUP,"Cannot change/reset column sizes to %D local %D global after previously setting them to %D local %D global",n,N,A->cmap->n,A->cmap->N);
164:   A->rmap->n = m;
165:   A->cmap->n = n;
166:   A->rmap->N = M > -1 ? M : A->rmap->N;
167:   A->cmap->N = N > -1 ? N : A->cmap->N;
168:   return(0);
169: }

171: /*@
172:    MatSetFromOptions - Creates a matrix where the type is determined
173:    from the options database. Generates a parallel MPI matrix if the
174:    communicator has more than one processor.  The default matrix type is
175:    AIJ, using the routines MatCreateSeqAIJ() and MatCreateAIJ() if
176:    you do not select a type in the options database.

178:    Collective on Mat

180:    Input Parameter:
181: .  A - the matrix

183:    Options Database Keys:
184: +    -mat_type seqaij   - AIJ type, uses MatCreateSeqAIJ()
185: .    -mat_type mpiaij   - AIJ type, uses MatCreateAIJ()
186: .    -mat_type seqdense - dense type, uses MatCreateSeqDense()
187: .    -mat_type mpidense - dense type, uses MatCreateDense()
188: .    -mat_type seqbaij  - block AIJ type, uses MatCreateSeqBAIJ()
189: -    -mat_type mpibaij  - block AIJ type, uses MatCreateBAIJ()

191:    Even More Options Database Keys:
192:    See the manpages for particular formats (e.g., MatCreateSeqAIJ())
193:    for additional format-specific options.

195:    Level: beginner

197: .seealso: MatCreateSeqAIJ((), MatCreateAIJ(),
198:           MatCreateSeqDense(), MatCreateDense(),
199:           MatCreateSeqBAIJ(), MatCreateBAIJ(),
200:           MatCreateSeqSBAIJ(), MatCreateSBAIJ(),
201:           MatConvert()
202: @*/
203: PetscErrorCode  MatSetFromOptions(Mat B)
204: {
206:   const char     *deft = MATAIJ;
207:   char           type[256];
208:   PetscBool      flg,set;


213:   PetscObjectOptionsBegin((PetscObject)B);

215:   if (B->rmap->bs < 0) {
216:     PetscInt newbs = -1;
217:     PetscOptionsInt("-mat_block_size","Set the blocksize used to store the matrix","MatSetBlockSize",newbs,&newbs,&flg);
218:     if (flg) {
219:       PetscLayoutSetBlockSize(B->rmap,newbs);
220:       PetscLayoutSetBlockSize(B->cmap,newbs);
221:     }
222:   }

224:   PetscOptionsFList("-mat_type","Matrix type","MatSetType",MatList,deft,type,256,&flg);
225:   if (flg) {
226:     MatSetType(B,type);
227:   } else if (!((PetscObject)B)->type_name) {
228:     MatSetType(B,deft);
229:   }

231:   PetscOptionsName("-mat_is_symmetric","Checks if mat is symmetric on MatAssemblyEnd()","MatIsSymmetric",&B->checksymmetryonassembly);
232:   PetscOptionsReal("-mat_is_symmetric","Checks if mat is symmetric on MatAssemblyEnd()","MatIsSymmetric",B->checksymmetrytol,&B->checksymmetrytol,NULL);
233:   PetscOptionsBool("-mat_null_space_test","Checks if provided null space is correct in MatAssemblyEnd()","MatSetNullSpaceTest",B->checknullspaceonassembly,&B->checknullspaceonassembly,NULL);
234:   PetscOptionsBool("-mat_error_if_failure","Generate an error if an error occurs when factoring the matrix","MatSetErrorIfFailure",B->erroriffailure,&B->erroriffailure,NULL);

236:   if (B->ops->setfromoptions) {
237:     (*B->ops->setfromoptions)(PetscOptionsObject,B);
238:   }

240:   flg  = PETSC_FALSE;
241:   PetscOptionsBool("-mat_new_nonzero_location_err","Generate an error if new nonzeros are created in the matrix structure (useful to test preallocation)","MatSetOption",flg,&flg,&set);
242:   if (set) {MatSetOption(B,MAT_NEW_NONZERO_LOCATION_ERR,flg);}
243:   flg  = PETSC_FALSE;
244:   PetscOptionsBool("-mat_new_nonzero_allocation_err","Generate an error if new nonzeros are allocated in the matrix structure (useful to test preallocation)","MatSetOption",flg,&flg,&set);
245:   if (set) {MatSetOption(B,MAT_NEW_NONZERO_ALLOCATION_ERR,flg);}

247:   /* process any options handlers added with PetscObjectAddOptionsHandler() */
248:   PetscObjectProcessOptionsHandlers(PetscOptionsObject,(PetscObject)B);
249:   PetscOptionsEnd();
250:   return(0);
251: }

253: /*@C
254:    MatXAIJSetPreallocation - set preallocation for serial and parallel AIJ, BAIJ, and SBAIJ matrices and their unassembled versions.

256:    Collective on Mat

258:    Input Arguments:
259: +  A - matrix being preallocated
260: .  bs - block size
261: .  dnnz - number of nonzero column blocks per block row of diagonal part of parallel matrix
262: .  onnz - number of nonzero column blocks per block row of off-diagonal part of parallel matrix
263: .  dnnzu - number of nonzero column blocks per block row of upper-triangular part of diagonal part of parallel matrix
264: -  onnzu - number of nonzero column blocks per block row of upper-triangular part of off-diagonal part of parallel matrix

266:    Level: beginner

268: .seealso: MatSeqAIJSetPreallocation(), MatMPIAIJSetPreallocation(), MatSeqBAIJSetPreallocation(), MatMPIBAIJSetPreallocation(), MatSeqSBAIJSetPreallocation(), MatMPISBAIJSetPreallocation(),
269:           PetscSplitOwnership()
270: @*/
271: PetscErrorCode MatXAIJSetPreallocation(Mat A,PetscInt bs,const PetscInt dnnz[],const PetscInt onnz[],const PetscInt dnnzu[],const PetscInt onnzu[])
272: {
274:   PetscInt       cbs;
275:   void           (*aij)(void);
276:   void           (*is)(void);
277:   void           (*hyp)(void) = NULL;

280:   if (bs != PETSC_DECIDE) { /* don't mess with an already set block size */
281:     MatSetBlockSize(A,bs);
282:   }
283:   PetscLayoutSetUp(A->rmap);
284:   PetscLayoutSetUp(A->cmap);
285:   MatGetBlockSizes(A,&bs,&cbs);
286:   /* these routines assumes bs == cbs, this should be checked somehow */
287:   MatSeqBAIJSetPreallocation(A,bs,0,dnnz);
288:   MatMPIBAIJSetPreallocation(A,bs,0,dnnz,0,onnz);
289:   MatSeqSBAIJSetPreallocation(A,bs,0,dnnzu);
290:   MatMPISBAIJSetPreallocation(A,bs,0,dnnzu,0,onnzu);
291:   /*
292:     In general, we have to do extra work to preallocate for scalar (AIJ) or unassembled (IS) matrices so we check whether it will do any
293:     good before going on with it.
294:   */
295:   PetscObjectQueryFunction((PetscObject)A,"MatMPIAIJSetPreallocation_C",&aij);
296:   PetscObjectQueryFunction((PetscObject)A,"MatISSetPreallocation_C",&is);
297: #if defined(PETSC_HAVE_HYPRE)
298:   PetscObjectQueryFunction((PetscObject)A,"MatHYPRESetPreallocation_C",&hyp);
299: #endif
300:   if (!aij && !is && !hyp) {
301:     PetscObjectQueryFunction((PetscObject)A,"MatSeqAIJSetPreallocation_C",&aij);
302:   }
303:   if (aij || is || hyp) {
304:     if (bs == cbs && bs == 1) {
305:       MatSeqAIJSetPreallocation(A,0,dnnz);
306:       MatMPIAIJSetPreallocation(A,0,dnnz,0,onnz);
307:       MatISSetPreallocation(A,0,dnnz,0,onnz);
308: #if defined(PETSC_HAVE_HYPRE)
309:       MatHYPRESetPreallocation(A,0,dnnz,0,onnz);
310: #endif
311:     } else { /* Convert block-row precallocation to scalar-row */
312:       PetscInt i,m,*sdnnz,*sonnz;
313:       MatGetLocalSize(A,&m,NULL);
314:       PetscMalloc2((!!dnnz)*m,&sdnnz,(!!onnz)*m,&sonnz);
315:       for (i=0; i<m; i++) {
316:         if (dnnz) sdnnz[i] = dnnz[i/bs] * cbs;
317:         if (onnz) sonnz[i] = onnz[i/bs] * cbs;
318:       }
319:       MatSeqAIJSetPreallocation(A,0,dnnz ? sdnnz : NULL);
320:       MatMPIAIJSetPreallocation(A,0,dnnz ? sdnnz : NULL,0,onnz ? sonnz : NULL);
321:       MatISSetPreallocation(A,0,dnnz ? sdnnz : NULL,0,onnz ? sonnz : NULL);
322: #if defined(PETSC_HAVE_HYPRE)
323:       MatHYPRESetPreallocation(A,0,dnnz ? sdnnz : NULL,0,onnz ? sonnz : NULL);
324: #endif
325:       PetscFree2(sdnnz,sonnz);
326:     }
327:   }
328:   return(0);
329: }

331: /*
332:         Merges some information from Cs header to A; the C object is then destroyed

334:         This is somewhat different from MatHeaderReplace() it would be nice to merge the code
335: */
336: PetscErrorCode MatHeaderMerge(Mat A,Mat *C)
337: {
339:   PetscInt       refct;
340:   PetscOps       Abops;
341:   struct _MatOps Aops;
342:   char           *mtype,*mname,*mprefix;

345:   /* save the parts of A we need */
346:   Abops = ((PetscObject)A)->bops[0];
347:   Aops  = A->ops[0];
348:   refct = ((PetscObject)A)->refct;
349:   mtype = ((PetscObject)A)->type_name;
350:   mname = ((PetscObject)A)->name;
351:   mprefix = ((PetscObject)A)->prefix;

353:   /* zero these so the destroy below does not free them */
354:   ((PetscObject)A)->type_name = 0;
355:   ((PetscObject)A)->name      = 0;

357:   /* free all the interior data structures from mat */
358:   (*A->ops->destroy)(A);

360:   PetscFree(A->defaultvectype);
361:   PetscLayoutDestroy(&A->rmap);
362:   PetscLayoutDestroy(&A->cmap);
363:   PetscFunctionListDestroy(&((PetscObject)A)->qlist);
364:   PetscObjectListDestroy(&((PetscObject)A)->olist);

366:   /* copy C over to A */
367:   PetscMemcpy(A,*C,sizeof(struct _p_Mat));

369:   /* return the parts of A we saved */
370:   ((PetscObject)A)->bops[0]   = Abops;
371:   A->ops[0]                   = Aops;
372:   ((PetscObject)A)->refct     = refct;
373:   ((PetscObject)A)->type_name = mtype;
374:   ((PetscObject)A)->name      = mname;
375:   ((PetscObject)A)->prefix    = mprefix;

377:   /* since these two are copied into A we do not want them destroyed in C */
378:   ((PetscObject)*C)->qlist = 0;
379:   ((PetscObject)*C)->olist = 0;

381:   PetscHeaderDestroy(C);
382:   return(0);
383: }
384: /*
385:         Replace A's header with that of C; the C object is then destroyed

387:         This is essentially code moved from MatDestroy()

389:         This is somewhat different from MatHeaderMerge() it would be nice to merge the code

391:         Used in DM hence is declared PETSC_EXTERN
392: */
393: PETSC_EXTERN PetscErrorCode MatHeaderReplace(Mat A,Mat *C)
394: {
395:   PetscErrorCode   ierr;
396:   PetscInt         refct;
397:   PetscObjectState state;
398:   struct _p_Mat    buffer;

403:   if (A == *C) return(0);
405:   if (((PetscObject)*C)->refct != 1) SETERRQ1(PetscObjectComm((PetscObject)C),PETSC_ERR_ARG_WRONGSTATE,"Object C has refct %D > 1, would leave hanging reference",((PetscObject)*C)->refct);

407:   /* swap C and A */
408:   refct = ((PetscObject)A)->refct;
409:   state = ((PetscObject)A)->state;
410:   PetscMemcpy(&buffer,A,sizeof(struct _p_Mat));
411:   PetscMemcpy(A,*C,sizeof(struct _p_Mat));
412:   PetscMemcpy(*C,&buffer,sizeof(struct _p_Mat));
413:   ((PetscObject)A)->refct = refct;
414:   ((PetscObject)A)->state = state + 1;

416:   ((PetscObject)*C)->refct = 1;
417:   MatDestroy(C);
418:   return(0);
419: }

421: /*@
422:      MatPinToCPU - marks a matrix to temporarily stay on the CPU and perform computations on the CPU

424:    Input Parameters:
425: +   A - the matrix
426: -   flg - pin to the CPU if value of PETSC_TRUE

428: @*/
429: PetscErrorCode MatPinToCPU(Mat A,PetscBool flg)
430: {
432: #if defined(PETSC_HAVE_VIENNACL) || defined(PETSC_HAVE_CUDA)

435:   if (A->pinnedtocpu == flg) return 0;
436:   A->pinnedtocpu = flg;
437:   if (A->ops->pintocpu) {
438:     (*A->ops->pintocpu)(A,flg);
439:   }
440: #endif
441:   return(0);
442: }