Actual source code: dmshell.c

petsc-master 2017-12-15
Report Typos and Errors
  1:  #include <petscdmshell.h>
  2:  #include <petscmat.h>
  3:  #include <petsc/private/dmimpl.h>

  5: typedef struct  {
  6:   Vec        Xglobal;
  7:   Vec        Xlocal;
  8:   Mat        A;
  9:   VecScatter gtol;
 10:   VecScatter ltog;
 11:   VecScatter ltol;
 12:   void       *ctx;
 13: } DM_Shell;

 15: /*@
 16:    DMGlobalToLocalBeginDefaultShell - Uses the GlobalToLocal VecScatter context set by the user to begin a global to local scatter
 17:    Collective

 19:    Input Arguments:
 20: +  dm - shell DM
 21: .  g - global vector
 22: .  mode - InsertMode
 23: -  l - local vector

 25:    Level: advanced

 27:    Note:  This is not normally called directly by user code, generally user code calls DMGlobalToLocalBegin() and DMGlobalToLocalEnd(). If the user provides their own custom routines to DMShellSetLocalToGlobal() then those routines might have reason to call this function.

 29: .seealso: DMGlobalToLocalEndDefaultShell()
 30: @*/
 31: PetscErrorCode DMGlobalToLocalBeginDefaultShell(DM dm,Vec g,InsertMode mode,Vec l)
 32: {
 34:   DM_Shell       *shell = (DM_Shell*)dm->data;

 37:   if (!shell->gtol) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE, "Cannot be used without first setting the scatter context via DMShellSetGlobalToLocalVecScatter()");
 38:   VecScatterBegin(shell->gtol,g,l,mode,SCATTER_FORWARD);
 39:   return(0);
 40: }

 42: /*@
 43:    DMGlobalToLocalEndDefaultShell - Uses the GlobalToLocal VecScatter context set by the user to end a global to local scatter
 44:    Collective

 46:    Input Arguments:
 47: +  dm - shell DM
 48: .  g - global vector
 49: .  mode - InsertMode
 50: -  l - local vector

 52:    Level: advanced

 54: .seealso: DMGlobalToLocalBeginDefaultShell()
 55: @*/
 56: PetscErrorCode DMGlobalToLocalEndDefaultShell(DM dm,Vec g,InsertMode mode,Vec l)
 57: {
 59:   DM_Shell       *shell = (DM_Shell*)dm->data;

 62:    if (!shell->gtol) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE, "Cannot be used without first setting the scatter context via DMShellSetGlobalToLocalVecScatter()");
 63:   VecScatterEnd(shell->gtol,g,l,mode,SCATTER_FORWARD);
 64:   return(0);
 65: }

 67: /*@
 68:    DMLocalToGlobalBeginDefaultShell - Uses the LocalToGlobal VecScatter context set by the user to begin a local to global scatter
 69:    Collective

 71:    Input Arguments:
 72: +  dm - shell DM
 73: .  l - local vector
 74: .  mode - InsertMode
 75: -  g - global vector

 77:    Level: advanced

 79:    Note:  This is not normally called directly by user code, generally user code calls DMLocalToGlobalBegin() and DMLocalToGlobalEnd(). If the user provides their own custom routines to DMShellSetLocalToGlobal() then those routines might have reason to call this function.

 81: .seealso: DMLocalToGlobalEndDefaultShell()
 82: @*/
 83: PetscErrorCode DMLocalToGlobalBeginDefaultShell(DM dm,Vec l,InsertMode mode,Vec g)
 84: {
 86:   DM_Shell       *shell = (DM_Shell*)dm->data;

 89:   if (!shell->ltog) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE, "Cannot be used without first setting the scatter context via DMShellSetLocalToGlobalVecScatter()");
 90:   VecScatterBegin(shell->ltog,l,g,mode,SCATTER_FORWARD);
 91:   return(0);
 92: }

 94: /*@
 95:    DMLocalToGlobalEndDefaultShell - Uses the LocalToGlobal VecScatter context set by the user to end a local to global scatter
 96:    Collective

 98:    Input Arguments:
 99: +  dm - shell DM
100: .  l - local vector
101: .  mode - InsertMode
102: -  g - global vector

104:    Level: advanced

106: .seealso: DMLocalToGlobalBeginDefaultShell()
107: @*/
108: PetscErrorCode DMLocalToGlobalEndDefaultShell(DM dm,Vec l,InsertMode mode,Vec g)
109: {
111:   DM_Shell       *shell = (DM_Shell*)dm->data;

114:    if (!shell->ltog) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE, "Cannot be used without first setting the scatter context via DMShellSetLocalToGlobalVecScatter()");
115:   VecScatterEnd(shell->ltog,l,g,mode,SCATTER_FORWARD);
116:   return(0);
117: }

119: /*@
120:    DMLocalToLocalBeginDefaultShell - Uses the LocalToLocal VecScatter context set by the user to begin a local to local scatter
121:    Collective

123:    Input Arguments:
124: +  dm - shell DM
125: .  g - the original local vector
126: -  mode - InsertMode

128:    Output Parameter:
129: .  l  - the local vector with correct ghost values

131:    Level: advanced

133:    Note:  This is not normally called directly by user code, generally user code calls DMLocalToLocalBegin() and DMLocalToLocalEnd(). If the user provides their own custom routines to DMShellSetLocalToLocal() then those routines might have reason to call this function.

135: .seealso: DMLocalToLocalEndDefaultShell()
136: @*/
137: PetscErrorCode DMLocalToLocalBeginDefaultShell(DM dm,Vec g,InsertMode mode,Vec l)
138: {
140:   DM_Shell       *shell = (DM_Shell*)dm->data;

143:   if (!shell->ltol) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE, "Cannot be used without first setting the scatter context via DMShellSetLocalToLocalVecScatter()");
144:   VecScatterBegin(shell->ltol,g,l,mode,SCATTER_FORWARD);
145:   return(0);
146: }

148: /*@
149:    DMLocalToLocalEndDefaultShell - Uses the LocalToLocal VecScatter context set by the user to end a local to local scatter
150:    Collective

152:    Input Arguments:
153: +  dm - shell DM
154: .  g - the original local vector
155: -  mode - InsertMode

157:    Output Parameter:
158: .  l  - the local vector with correct ghost values

160:    Level: advanced

162: .seealso: DMLocalToLocalBeginDefaultShell()
163: @*/
164: PetscErrorCode DMLocalToLocalEndDefaultShell(DM dm,Vec g,InsertMode mode,Vec l)
165: {
167:   DM_Shell       *shell = (DM_Shell*)dm->data;

170:    if (!shell->ltol) SETERRQ(((PetscObject)dm)->comm,PETSC_ERR_ARG_WRONGSTATE, "Cannot be used without first setting the scatter context via DMShellSetGlobalToLocalVecScatter()");
171:   VecScatterEnd(shell->ltol,g,l,mode,SCATTER_FORWARD);
172:   return(0);
173: }

175: static PetscErrorCode DMCreateMatrix_Shell(DM dm,Mat *J)
176: {
178:   DM_Shell       *shell = (DM_Shell*)dm->data;
179:   Mat            A;

184:   if (!shell->A) {
185:     if (shell->Xglobal) {
186:       PetscInt m,M;
187:       PetscInfo(dm,"Naively creating matrix using global vector distribution without preallocation\n");
188:       VecGetSize(shell->Xglobal,&M);
189:       VecGetLocalSize(shell->Xglobal,&m);
190:       MatCreate(PetscObjectComm((PetscObject)dm),&shell->A);
191:       MatSetSizes(shell->A,m,m,M,M);
192:       MatSetType(shell->A,dm->mattype);
193:       MatSetUp(shell->A);
194:     } else SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Must call DMShellSetMatrix(), DMShellSetCreateMatrix(), or provide a vector");
195:   }
196:   A = shell->A;
197:   /* the check below is tacky and incomplete */
198:   if (dm->mattype) {
199:     PetscBool flg,aij,seqaij,mpiaij;
200:     PetscObjectTypeCompare((PetscObject)A,dm->mattype,&flg);
201:     PetscObjectTypeCompare((PetscObject)A,MATSEQAIJ,&seqaij);
202:     PetscObjectTypeCompare((PetscObject)A,MATMPIAIJ,&mpiaij);
203:     PetscStrcmp(dm->mattype,MATAIJ,&aij);
204:     if (!flg) {
205:       if (!(aij && (seqaij || mpiaij))) SETERRQ2(PetscObjectComm((PetscObject)dm),PETSC_ERR_ARG_NOTSAMETYPE,"Requested matrix of type %s, but only %s available",dm->mattype,((PetscObject)A)->type_name);
206:     }
207:   }
208:   if (((PetscObject)A)->refct < 2) { /* We have an exclusive reference so we can give it out */
209:     PetscObjectReference((PetscObject)A);
210:     MatZeroEntries(A);
211:     *J   = A;
212:   } else {                      /* Need to create a copy, could use MAT_SHARE_NONZERO_PATTERN in most cases */
213:     MatDuplicate(A,MAT_DO_NOT_COPY_VALUES,J);
214:     MatZeroEntries(*J);
215:   }
216:   return(0);
217: }

219: PetscErrorCode DMCreateGlobalVector_Shell(DM dm,Vec *gvec)
220: {
222:   DM_Shell       *shell = (DM_Shell*)dm->data;
223:   Vec            X;

228:   *gvec = 0;
229:   X     = shell->Xglobal;
230:   if (!X) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Must call DMShellSetGlobalVector() or DMShellSetCreateGlobalVector()");
231:   if (((PetscObject)X)->refct < 2) { /* We have an exclusive reference so we can give it out */
232:     PetscObjectReference((PetscObject)X);
233:     VecZeroEntries(X);
234:     *gvec = X;
235:   } else {                      /* Need to create a copy, could use MAT_SHARE_NONZERO_PATTERN in most cases */
236:     VecDuplicate(X,gvec);
237:     VecZeroEntries(*gvec);
238:   }
239:   VecSetDM(*gvec,dm);
240:   return(0);
241: }

243: PetscErrorCode DMCreateLocalVector_Shell(DM dm,Vec *gvec)
244: {
246:   DM_Shell       *shell = (DM_Shell*)dm->data;
247:   Vec            X;

252:   *gvec = 0;
253:   X     = shell->Xlocal;
254:   if (!X) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Must call DMShellSetLocalVector() or DMShellSetCreateLocalVector()");
255:   if (((PetscObject)X)->refct < 2) { /* We have an exclusive reference so we can give it out */
256:     PetscObjectReference((PetscObject)X);
257:     VecZeroEntries(X);
258:     *gvec = X;
259:   } else {                      /* Need to create a copy, could use MAT_SHARE_NONZERO_PATTERN in most cases */
260:     VecDuplicate(X,gvec);
261:     VecZeroEntries(*gvec);
262:   }
263:   VecSetDM(*gvec,dm);
264:   return(0);
265: }

267: /*@
268:    DMShellSetContext - set some data to be usable by this DM

270:    Collective

272:    Input Arguments:
273: +  dm - shell DM
274: -  ctx - the context

276:    Level: advanced

278: .seealso: DMCreateMatrix(), DMShellGetContext()
279: @*/
280: PetscErrorCode DMShellSetContext(DM dm,void *ctx)
281: {
282:   DM_Shell       *shell = (DM_Shell*)dm->data;
284:   PetscBool      isshell;

288:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
289:   if (!isshell) return(0);
290:   shell->ctx = ctx;
291:   return(0);
292: }

294: /*@
295:    DMShellGetContext - set some data to be usable by this DM

297:    Collective

299:    Input Argument:
300: .  dm - shell DM

302:    Output Argument:
303: .  ctx - the context

305:    Level: advanced

307: .seealso: DMCreateMatrix(), DMShellSetContext()
308: @*/
309: PetscErrorCode DMShellGetContext(DM dm,void **ctx)
310: {
311:   DM_Shell       *shell = (DM_Shell*)dm->data;
313:   PetscBool      isshell;

317:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
318:   if (!isshell) return(0);
319:   *ctx = shell->ctx;
320:   return(0);
321: }

323: /*@
324:    DMShellSetMatrix - sets a template matrix associated with the DMShell

326:    Collective

328:    Input Arguments:
329: +  dm - shell DM
330: -  J - template matrix

332:    Level: advanced

334: .seealso: DMCreateMatrix(), DMShellSetCreateMatrix(), DMShellSetContext(), DMShellGetContext()
335: @*/
336: PetscErrorCode DMShellSetMatrix(DM dm,Mat J)
337: {
338:   DM_Shell       *shell = (DM_Shell*)dm->data;
340:   PetscBool      isshell;

345:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
346:   if (!isshell) return(0);
347:   PetscObjectReference((PetscObject)J);
348:   MatDestroy(&shell->A);
349:   shell->A = J;
350:   return(0);
351: }

353: /*@C
354:    DMShellSetCreateMatrix - sets the routine to create a matrix associated with the shell DM

356:    Logically Collective on DM

358:    Input Arguments:
359: +  dm - the shell DM
360: -  func - the function to create a matrix

362:    Level: advanced

364: .seealso: DMCreateMatrix(), DMShellSetMatrix(), DMShellSetContext(), DMShellGetContext()
365: @*/
366: PetscErrorCode DMShellSetCreateMatrix(DM dm,PetscErrorCode (*func)(DM,Mat*))
367: {

371:   dm->ops->creatematrix = func;
372:   return(0);
373: }

375: /*@
376:    DMShellSetGlobalVector - sets a template global vector associated with the DMShell

378:    Logically Collective on DM

380:    Input Arguments:
381: +  dm - shell DM
382: -  X - template vector

384:    Level: advanced

386: .seealso: DMCreateGlobalVector(), DMShellSetMatrix(), DMShellSetCreateGlobalVector()
387: @*/
388: PetscErrorCode DMShellSetGlobalVector(DM dm,Vec X)
389: {
390:   DM_Shell       *shell = (DM_Shell*)dm->data;
392:   PetscBool      isshell;
393:   DM             vdm;

398:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
399:   if (!isshell) return(0);
400:   VecGetDM(X,&vdm);
401:   /*
402:       if the vector proposed as the new base global vector for the DM is a DM vector associated
403:       with the same DM then the current base global vector for the DM is ok and if we replace it with the new one
404:       we get a circular dependency that prevents the DM from being destroy when it should be.
405:       This occurs when SNESSet/GetNPC() is used with a SNES that does not have a user provided
406:       DM attached to it since the inner SNES (which shares the DM with the outer SNES) tries
407:       to set its input vector (which is associated with the DM) as the base global vector.
408:       Thanks to Juan P. Mendez Granado Re: [petsc-maint] Nonlinear conjugate gradien
409:       for pointing out the problem.
410:    */
411:   if (vdm == dm) return(0);
412:   PetscObjectReference((PetscObject)X);
413:   VecDestroy(&shell->Xglobal);
414:   shell->Xglobal = X;
415:   return(0);
416: }

418: /*@C
419:    DMShellSetCreateGlobalVector - sets the routine to create a global vector associated with the shell DM

421:    Logically Collective

423:    Input Arguments:
424: +  dm - the shell DM
425: -  func - the creation routine

427:    Level: advanced

429: .seealso: DMShellSetGlobalVector(), DMShellSetCreateMatrix(), DMShellSetContext(), DMShellGetContext()
430: @*/
431: PetscErrorCode DMShellSetCreateGlobalVector(DM dm,PetscErrorCode (*func)(DM,Vec*))
432: {

436:   dm->ops->createglobalvector = func;
437:   return(0);
438: }

440: /*@
441:    DMShellSetLocalVector - sets a template local vector associated with the DMShell

443:    Logically Collective on DM

445:    Input Arguments:
446: +  dm - shell DM
447: -  X - template vector

449:    Level: advanced

451: .seealso: DMCreateLocalVector(), DMShellSetMatrix(), DMShellSetCreateLocalVector()
452: @*/
453: PetscErrorCode DMShellSetLocalVector(DM dm,Vec X)
454: {
455:   DM_Shell       *shell = (DM_Shell*)dm->data;
457:   PetscBool      isshell;
458:   DM             vdm;

463:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
464:   if (!isshell) return(0);
465:   VecGetDM(X,&vdm);
466:   /*
467:       if the vector proposed as the new base global vector for the DM is a DM vector associated
468:       with the same DM then the current base global vector for the DM is ok and if we replace it with the new one
469:       we get a circular dependency that prevents the DM from being destroy when it should be.
470:       This occurs when SNESSet/GetNPC() is used with a SNES that does not have a user provided
471:       DM attached to it since the inner SNES (which shares the DM with the outer SNES) tries
472:       to set its input vector (which is associated with the DM) as the base global vector.
473:       Thanks to Juan P. Mendez Granado Re: [petsc-maint] Nonlinear conjugate gradien
474:       for pointing out the problem.
475:    */
476:   if (vdm == dm) return(0);
477:   PetscObjectReference((PetscObject)X);
478:   VecDestroy(&shell->Xlocal);
479:   shell->Xlocal = X;
480:   return(0);
481: }

483: /*@C
484:    DMShellSetCreateLocalVector - sets the routine to create a local vector associated with the shell DM

486:    Logically Collective

488:    Input Arguments:
489: +  dm - the shell DM
490: -  func - the creation routine

492:    Level: advanced

494: .seealso: DMShellSetLocalVector(), DMShellSetCreateMatrix(), DMShellSetContext(), DMShellGetContext()
495: @*/
496: PetscErrorCode DMShellSetCreateLocalVector(DM dm,PetscErrorCode (*func)(DM,Vec*))
497: {

501:   dm->ops->createlocalvector = func;
502:   return(0);
503: }

505: /*@C
506:    DMShellSetGlobalToLocal - Sets the routines used to perform a global to local scatter

508:    Logically Collective on DM

510:    Input Arguments
511: +  dm - the shell DM
512: .  begin - the routine that begins the global to local scatter
513: -  end - the routine that ends the global to local scatter

515:    Notes: If these functions are not provided but DMShellSetGlobalToLocalVecScatter() is called then
516:    DMGlobalToLocalBeginDefaultShell()/DMGlobalToLocalEndDefaultShell() are used to to perform the transfers

518:    Level: advanced

520: .seealso: DMShellSetLocalToGlobal(), DMGlobalToLocalBeginDefaultShell(), DMGlobalToLocalEndDefaultShell()
521: @*/
522: PetscErrorCode DMShellSetGlobalToLocal(DM dm,PetscErrorCode (*begin)(DM,Vec,InsertMode,Vec),PetscErrorCode (*end)(DM,Vec,InsertMode,Vec)) {
524:   dm->ops->globaltolocalbegin = begin;
525:   dm->ops->globaltolocalend = end;
526:   return(0);
527: }

529: /*@C
530:    DMShellSetLocalToGlobal - Sets the routines used to perform a local to global scatter

532:    Logically Collective on DM

534:    Input Arguments
535: +  dm - the shell DM
536: .  begin - the routine that begins the local to global scatter
537: -  end - the routine that ends the local to global scatter

539:    Notes: If these functions are not provided but DMShellSetLocalToGlobalVecScatter() is called then
540:    DMLocalToGlobalBeginDefaultShell()/DMLocalToGlobalEndDefaultShell() are used to to perform the transfers

542:    Level: advanced

544: .seealso: DMShellSetGlobalToLocal()
545: @*/
546: PetscErrorCode DMShellSetLocalToGlobal(DM dm,PetscErrorCode (*begin)(DM,Vec,InsertMode,Vec),PetscErrorCode (*end)(DM,Vec,InsertMode,Vec)) {
548:   dm->ops->localtoglobalbegin = begin;
549:   dm->ops->localtoglobalend = end;
550:   return(0);
551: }

553: /*@C
554:    DMShellSetLocalToLocal - Sets the routines used to perform a local to local scatter

556:    Logically Collective on DM

558:    Input Arguments
559: +  dm - the shell DM
560: .  begin - the routine that begins the local to local scatter
561: -  end - the routine that ends the local to local scatter

563:    Notes: If these functions are not provided but DMShellSetLocalToLocalVecScatter() is called then
564:    DMLocalToLocalBeginDefaultShell()/DMLocalToLocalEndDefaultShell() are used to to perform the transfers

566:    Level: advanced

568: .seealso: DMShellSetGlobalToLocal(), DMLocalToLocalBeginDefaultShell(), DMLocalToLocalEndDefaultShell()
569: @*/
570: PetscErrorCode DMShellSetLocalToLocal(DM dm,PetscErrorCode (*begin)(DM,Vec,InsertMode,Vec),PetscErrorCode (*end)(DM,Vec,InsertMode,Vec)) {
572:   dm->ops->localtolocalbegin = begin;
573:   dm->ops->localtolocalend = end;
574:   return(0);
575: }

577: /*@
578:    DMShellSetGlobalToLocalVecScatter - Sets a VecScatter context for global to local communication

580:    Logically Collective on DM

582:    Input Arguments
583: +  dm - the shell DM
584: -  gtol - the global to local VecScatter context

586:    Level: advanced

588: .seealso: DMShellSetGlobalToLocal(), DMGlobalToLocalBeginDefaultShell(), DMGlobalToLocalEndDefaultShell()
589: @*/
590: PetscErrorCode DMShellSetGlobalToLocalVecScatter(DM dm, VecScatter gtol)
591: {
592:   DM_Shell       *shell = (DM_Shell*)dm->data;

596:   PetscObjectReference((PetscObject)gtol);
597:   /* Call VecScatterDestroy() to avoid a memory leak in case of re-setting. */
598:   VecScatterDestroy(&shell->gtol);
599:   shell->gtol = gtol;
600:   return(0);
601: }

603: /*@
604:    DMShellSetLocalToGlobalVecScatter - Sets a VecScatter context for local to global communication

606:    Logically Collective on DM

608:    Input Arguments
609: +  dm - the shell DM
610: -  ltog - the local to global VecScatter context

612:    Level: advanced

614: .seealso: DMShellSetLocalToGlobal(), DMLocalToGlobalBeginDefaultShell(), DMLocalToGlobalEndDefaultShell()
615: @*/
616: PetscErrorCode DMShellSetLocalToGlobalVecScatter(DM dm, VecScatter ltog)
617: {
618:   DM_Shell       *shell = (DM_Shell*)dm->data;

622:   PetscObjectReference((PetscObject)ltog);
623:   /* Call VecScatterDestroy() to avoid a memory leak in case of re-setting. */
624:   VecScatterDestroy(&shell->ltog);
625:   shell->ltog = ltog;
626:   return(0);
627: }

629: /*@
630:    DMShellSetLocalToLocalVecScatter - Sets a VecScatter context for local to local communication

632:    Logically Collective on DM

634:    Input Arguments
635: +  dm - the shell DM
636: -  ltol - the local to local VecScatter context

638:    Level: advanced

640: .seealso: DMShellSetLocalToLocal(), DMLocalToLocalBeginDefaultShell(), DMLocalToLocalEndDefaultShell()
641: @*/
642: PetscErrorCode DMShellSetLocalToLocalVecScatter(DM dm, VecScatter ltol)
643: {
644:   DM_Shell       *shell = (DM_Shell*)dm->data;

648:   PetscObjectReference((PetscObject)ltol);
649:   /* Call VecScatterDestroy() to avoid a memory leak in case of re-setting. */
650:   VecScatterDestroy(&shell->ltol);
651:   shell->ltol = ltol;
652:   return(0);
653: }

655: /*@C
656:    DMShellSetCoarsen - Set the routine used to coarsen the shell DM

658:    Logically Collective on DM

660:    Input Arguments
661: +  dm - the shell DM
662: -  coarsen - the routine that coarsens the DM

664:    Level: advanced

666: .seealso: DMShellSetRefine(), DMCoarsen(), DMShellSetContext(), DMShellGetContext()
667: @*/
668: PetscErrorCode DMShellSetCoarsen(DM dm, PetscErrorCode (*coarsen)(DM,MPI_Comm,DM*))
669: {
671:   PetscBool      isshell;

675:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
676:   if (!isshell) return(0);
677:   dm->ops->coarsen = coarsen;
678:   return(0);
679: }

681: /*@C
682:    DMShellSetRefine - Set the routine used to refine the shell DM

684:    Logically Collective on DM

686:    Input Arguments
687: +  dm - the shell DM
688: -  refine - the routine that refines the DM

690:    Level: advanced

692: .seealso: DMShellSetCoarsen(), DMRefine(), DMShellSetContext(), DMShellGetContext()
693: @*/
694: PetscErrorCode DMShellSetRefine(DM dm, PetscErrorCode (*refine)(DM,MPI_Comm,DM*))
695: {
697:   PetscBool      isshell;

701:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
702:   if (!isshell) return(0);
703:   dm->ops->refine = refine;
704:   return(0);
705: }

707: /*@C
708:    DMShellSetCreateInterpolation - Set the routine used to create the interpolation operator

710:    Logically Collective on DM

712:    Input Arguments
713: +  dm - the shell DM
714: -  interp - the routine to create the interpolation

716:    Level: advanced

718: .seealso: DMShellSetCreateInjection(), DMCreateInterpolation(), DMShellSetCreateRestriction(), DMShellSetContext(), DMShellGetContext()
719: @*/
720: PetscErrorCode DMShellSetCreateInterpolation(DM dm, PetscErrorCode (*interp)(DM,DM,Mat*,Vec*))
721: {
723:   PetscBool      isshell;

727:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
728:   if (!isshell) return(0);
729:   dm->ops->createinterpolation = interp;
730:   return(0);
731: }

733: /*@C
734:    DMShellSetCreateRestriction - Set the routine used to create the restriction operator

736:    Logically Collective on DM

738:    Input Arguments
739: +  dm - the shell DM
740: -  striction- the routine to create the restriction

742:    Level: advanced

744: .seealso: DMShellSetCreateInjection(), DMCreateInterpolation(), DMShellSetContext(), DMShellGetContext()
745: @*/
746: PetscErrorCode DMShellSetCreateRestriction(DM dm, PetscErrorCode (*restriction)(DM,DM,Mat*))
747: {
749:   PetscBool      isshell;

753:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
754:   if (!isshell) return(0);
755:   dm->ops->createrestriction = restriction;
756:   return(0);
757: }

759: /*@C
760:    DMShellSetCreateInjection - Set the routine used to create the injection operator

762:    Logically Collective on DM

764:    Input Arguments
765: +  dm - the shell DM
766: -  inject - the routine to create the injection

768:    Level: advanced

770: .seealso: DMShellSetCreateInterpolation(), DMCreateInjection(), DMShellSetContext(), DMShellGetContext()
771: @*/
772: PetscErrorCode DMShellSetCreateInjection(DM dm, PetscErrorCode (*inject)(DM,DM,Mat*))
773: {
775:   PetscBool      isshell;

779:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
780:   if (!isshell) return(0);
781:   dm->ops->getinjection = inject;
782:   return(0);
783: }

785: /*@C
786:    DMShellSetCreateFieldDecomposition - Set the routine used to create a decomposition of fields for the shell DM

788:    Logically Collective on DM

790:    Input Arguments
791: +  dm - the shell DM
792: -  decomp - the routine to create the decomposition

794:    Level: advanced

796: .seealso: DMCreateFieldDecomposition(), DMShellSetContext(), DMShellGetContext()
797: @*/
798: PetscErrorCode DMShellSetCreateFieldDecomposition(DM dm, PetscErrorCode (*decomp)(DM,PetscInt*,char***, IS**,DM**))
799: {
801:   PetscBool      isshell;

805:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
806:   if (!isshell) return(0);
807:   dm->ops->createfielddecomposition = decomp;
808:   return(0);
809: }

811: /*@C
812:    DMShellSetCreateDomainDecomposition - Set the routine used to create a domain decomposition for the shell DM

814:    Logically Collective on DM

816:    Input Arguments
817: +  dm - the shell DM
818: -  decomp - the routine to create the decomposition

820:    Level: advanced

822: .seealso: DMCreateDomainDecomposition(), DMShellSetContext(), DMShellGetContext()
823: @*/
824: PetscErrorCode DMShellSetCreateDomainDecomposition(DM dm, PetscErrorCode (*decomp)(DM,PetscInt*,char***, IS**,IS**,DM**))
825: {
827:   PetscBool      isshell;

831:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
832:   if (!isshell) return(0);
833:   dm->ops->createdomaindecomposition = decomp;
834:   return(0);
835: }

837: /*@C
838:    DMShellSetCreateDomainDecompositionScatters - Set the routine used to create the scatter contexts for domain decomposition with a shell DM

840:    Logically Collective on DM

842:    Input Arguments
843: +  dm - the shell DM
844: -  scatter - the routine to create the scatters

846:    Level: advanced

848: .seealso: DMCreateDomainDecompositionScatters(), DMShellSetContext(), DMShellGetContext()
849: @*/
850: PetscErrorCode DMShellSetCreateDomainDecompositionScatters(DM dm, PetscErrorCode (*scatter)(DM,PetscInt,DM*,VecScatter**,VecScatter**,VecScatter**))
851: {
853:   PetscBool      isshell;

857:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
858:   if (!isshell) return(0);
859:   dm->ops->createddscatters = scatter;
860:   return(0);
861: }

863: /*@C
864:    DMShellSetCreateSubDM - Set the routine used to create a sub DM from the shell DM

866:    Logically Collective on DM

868:    Input Arguments
869: +  dm - the shell DM
870: -  subdm - the routine to create the decomposition

872:    Level: advanced

874: .seealso: DMCreateSubDM(), DMShellSetContext(), DMShellGetContext()
875: @*/
876: PetscErrorCode DMShellSetCreateSubDM(DM dm, PetscErrorCode (*subdm)(DM,PetscInt,const PetscInt[],IS*,DM*))
877: {
879:   PetscBool      isshell;

883:   PetscObjectTypeCompare((PetscObject)dm,DMSHELL,&isshell);
884:   if (!isshell) return(0);
885:   dm->ops->createsubdm = subdm;
886:   return(0);
887: }

889: static PetscErrorCode DMDestroy_Shell(DM dm)
890: {
892:   DM_Shell       *shell = (DM_Shell*)dm->data;

895:   MatDestroy(&shell->A);
896:   VecDestroy(&shell->Xglobal);
897:   VecDestroy(&shell->Xlocal);
898:   VecScatterDestroy(&shell->gtol);
899:   VecScatterDestroy(&shell->ltog);
900:   VecScatterDestroy(&shell->ltol);
901:   /* This was originally freed in DMDestroy(), but that prevents reference counting of backend objects */
902:   PetscFree(shell);
903:   return(0);
904: }

906: static PetscErrorCode DMView_Shell(DM dm,PetscViewer v)
907: {
909:   DM_Shell       *shell = (DM_Shell*)dm->data;

912:   VecView(shell->Xglobal,v);
913:   return(0);
914: }

916: static PetscErrorCode DMLoad_Shell(DM dm,PetscViewer v)
917: {
919:   DM_Shell       *shell = (DM_Shell*)dm->data;

922:   VecCreate(PetscObjectComm((PetscObject)dm),&shell->Xglobal);
923:   VecLoad(shell->Xglobal,v);
924:   return(0);
925: }

927: PetscErrorCode DMCreateSubDM_Shell(DM dm, PetscInt numFields, const PetscInt fields[], IS *is, DM *subdm)
928: {

932:   if (subdm) {DMShellCreate(PetscObjectComm((PetscObject) dm), subdm);}
933:   DMCreateSubDM_Section_Private(dm, numFields, fields, is, subdm);
934:   return(0);
935: }

937: PETSC_EXTERN PetscErrorCode DMCreate_Shell(DM dm)
938: {
940:   DM_Shell       *shell;

943:   PetscNewLog(dm,&shell);
944:   dm->data = shell;

946:   PetscObjectChangeTypeName((PetscObject)dm,DMSHELL);

948:   dm->ops->destroy            = DMDestroy_Shell;
949:   dm->ops->createglobalvector = DMCreateGlobalVector_Shell;
950:   dm->ops->createlocalvector  = DMCreateLocalVector_Shell;
951:   dm->ops->creatematrix       = DMCreateMatrix_Shell;
952:   dm->ops->view               = DMView_Shell;
953:   dm->ops->load               = DMLoad_Shell;
954:   dm->ops->globaltolocalbegin = DMGlobalToLocalBeginDefaultShell;
955:   dm->ops->globaltolocalend   = DMGlobalToLocalEndDefaultShell;
956:   dm->ops->localtoglobalbegin = DMLocalToGlobalBeginDefaultShell;
957:   dm->ops->localtoglobalend   = DMLocalToGlobalEndDefaultShell;
958:   dm->ops->localtolocalbegin  = DMLocalToLocalBeginDefaultShell;
959:   dm->ops->localtolocalend    = DMLocalToLocalEndDefaultShell;
960:   dm->ops->createsubdm        = DMCreateSubDM_Shell;
961:   return(0);
962: }

964: /*@
965:     DMShellCreate - Creates a shell DM object, used to manage user-defined problem data

967:     Collective on MPI_Comm

969:     Input Parameter:
970: .   comm - the processors that will share the global vector

972:     Output Parameters:
973: .   shell - the shell DM

975:     Level: advanced

977: .seealso DMDestroy(), DMCreateGlobalVector(), DMCreateLocalVector(), DMShellSetContext(), DMShellGetContext()
978: @*/
979: PetscErrorCode  DMShellCreate(MPI_Comm comm,DM *dm)
980: {

985:   DMCreate(comm,dm);
986:   DMSetType(*dm,DMSHELL);
987:   DMSetUp(*dm);
988:   return(0);
989: }