xref: /petsc/src/ksp/pc/impls/gasm/gasm.c (revision 390e1bf27627d887df99a9f4d0d0ad68037f55ec)
1b1a0a8a3SJed Brown /*
2f746d493SDmitry Karpeev   This file defines an "generalized" additive Schwarz preconditioner for any Mat implementation.
36a4f0f73SDmitry Karpeev   In this version each processor may intersect multiple subdomains and any subdomain may
46a4f0f73SDmitry Karpeev   intersect multiple processors.  Intersections of subdomains with processors are called *local
56a4f0f73SDmitry Karpeev   subdomains*.
6b1a0a8a3SJed Brown 
78f3b4b4dSDmitry Karpeev        N    - total number of distinct global subdomains          (set explicitly in PCGASMSetTotalSubdomains() or implicitly PCGASMSetSubdomains() and then calculated in PCSetUp_GASM())
86a4f0f73SDmitry Karpeev        n    - actual number of local subdomains on this processor (set in PCGASMSetSubdomains() or calculated in PCGASMSetTotalSubdomains())
98f3b4b4dSDmitry Karpeev        nmax - maximum number of local subdomains per processor    (calculated in PCSetUp_GASM())
10b1a0a8a3SJed Brown */
11af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
121e25c274SJed Brown #include <petscdm.h>
13b1a0a8a3SJed Brown 
14b1a0a8a3SJed Brown typedef struct {
15f746d493SDmitry Karpeev   PetscInt    N,n,nmax;
16b1a0a8a3SJed Brown   PetscInt    overlap;                  /* overlap requested by user */
178f3b4b4dSDmitry Karpeev   PCGASMType  type;                     /* use reduced interpolation, restriction or both */
188f3b4b4dSDmitry Karpeev   PetscBool   type_set;                 /* if user set this value (so won't change it for symmetric problems) */
198f3b4b4dSDmitry Karpeev   PetscBool   same_subdomain_solvers;   /* flag indicating whether all local solvers are same */
208f3b4b4dSDmitry Karpeev   PetscBool   sort_indices;             /* flag to sort subdomain indices */
218f3b4b4dSDmitry Karpeev   PetscBool   user_subdomains;          /* whether the user set explicit subdomain index sets -- keep them on PCReset() */
228f3b4b4dSDmitry Karpeev   PetscBool   dm_subdomains;            /* whether DM is allowed to define subdomains */
23ea91fabdSFande Kong   PetscBool   hierarchicalpartitioning;
248f3b4b4dSDmitry Karpeev   IS          *ois;                     /* index sets that define the outer (conceptually, overlapping) subdomains */
258f3b4b4dSDmitry Karpeev   IS          *iis;                     /* index sets that define the inner (conceptually, nonoverlapping) subdomains */
268f3b4b4dSDmitry Karpeev   KSP         *ksp;                     /* linear solvers for each subdomain */
278f3b4b4dSDmitry Karpeev   Mat         *pmat;                    /* subdomain block matrices */
28f746d493SDmitry Karpeev   Vec         gx,gy;                    /* Merged work vectors */
29f746d493SDmitry Karpeev   Vec         *x,*y;                    /* Split work vectors; storage aliases pieces of storage of the above merged vectors. */
306a4f0f73SDmitry Karpeev   VecScatter  gorestriction;            /* merged restriction to disjoint union of outer subdomains */
316a4f0f73SDmitry Karpeev   VecScatter  girestriction;            /* merged restriction to disjoint union of inner subdomains */
32ea91fabdSFande Kong   VecScatter  pctoouter;
33ea91fabdSFande Kong   IS          permutationIS;
34ea91fabdSFande Kong   Mat         permutationP;
35ea91fabdSFande Kong   Mat         pcmat;
36ea91fabdSFande Kong   Vec         pcx,pcy;
37f746d493SDmitry Karpeev } PC_GASM;
38b1a0a8a3SJed Brown 
398f3b4b4dSDmitry Karpeev static PetscErrorCode  PCGASMComputeGlobalSubdomainNumbering_Private(PC pc,PetscInt **numbering,PetscInt **permutation)
408f3b4b4dSDmitry Karpeev {
418f3b4b4dSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
428f3b4b4dSDmitry Karpeev   PetscInt       i;
438f3b4b4dSDmitry Karpeev   PetscErrorCode ierr;
448f3b4b4dSDmitry Karpeev 
458f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
468f3b4b4dSDmitry Karpeev   /* Determine the number of globally-distinct subdomains and compute a global numbering for them. */
478f3b4b4dSDmitry Karpeev   ierr = PetscMalloc2(osm->n,numbering,osm->n,permutation);CHKERRQ(ierr);
488f3b4b4dSDmitry Karpeev   ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->iis,NULL,*numbering);CHKERRQ(ierr);
498f3b4b4dSDmitry Karpeev   for (i = 0; i < osm->n; ++i) (*permutation)[i] = i;
508f3b4b4dSDmitry Karpeev   ierr = PetscSortIntWithPermutation(osm->n,*numbering,*permutation);CHKERRQ(ierr);
518f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
528f3b4b4dSDmitry Karpeev }
538f3b4b4dSDmitry Karpeev 
5406b43e7eSDmitry Karpeev static PetscErrorCode  PCGASMSubdomainView_Private(PC pc, PetscInt i, PetscViewer viewer)
55af538404SDmitry Karpeev {
56af538404SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
5706b43e7eSDmitry Karpeev   PetscInt       j,nidx;
58af538404SDmitry Karpeev   const PetscInt *idx;
5906b43e7eSDmitry Karpeev   PetscViewer    sviewer;
60af538404SDmitry Karpeev   char           *cidx;
61af538404SDmitry Karpeev   PetscErrorCode ierr;
62af538404SDmitry Karpeev 
63af538404SDmitry Karpeev   PetscFunctionBegin;
64ce94432eSBarry Smith   if (i < 0 || i > osm->n) SETERRQ2(PetscObjectComm((PetscObject)viewer), PETSC_ERR_ARG_WRONG, "Invalid subdomain %D: must nonnegative and less than %D", i, osm->n);
654bde246dSDmitry Karpeev   /* Inner subdomains. */
664bde246dSDmitry Karpeev   ierr = ISGetLocalSize(osm->iis[i], &nidx);CHKERRQ(ierr);
674bde246dSDmitry Karpeev   /*
684bde246dSDmitry Karpeev    No more than 15 characters per index plus a space.
694bde246dSDmitry Karpeev    PetscViewerStringSPrintf requires a string of size at least 2, so use (nidx+1) instead of nidx,
704bde246dSDmitry Karpeev    in case nidx == 0. That will take care of the space for the trailing '\0' as well.
714bde246dSDmitry Karpeev    For nidx == 0, the whole string 16 '\0'.
724bde246dSDmitry Karpeev    */
7389d949e2SBarry Smith   ierr = PetscMalloc1(16*(nidx+1)+1, &cidx);CHKERRQ(ierr);
744bde246dSDmitry Karpeev   ierr = PetscViewerStringOpen(PETSC_COMM_SELF, cidx, 16*(nidx+1)+1, &sviewer);CHKERRQ(ierr);
754bde246dSDmitry Karpeev   ierr = ISGetIndices(osm->iis[i], &idx);CHKERRQ(ierr);
764bde246dSDmitry Karpeev   for (j = 0; j < nidx; ++j) {
774bde246dSDmitry Karpeev     ierr = PetscViewerStringSPrintf(sviewer, "%D ", idx[j]);CHKERRQ(ierr);
784bde246dSDmitry Karpeev   }
794bde246dSDmitry Karpeev   ierr = ISRestoreIndices(osm->iis[i],&idx);CHKERRQ(ierr);
804bde246dSDmitry Karpeev   ierr = PetscViewerDestroy(&sviewer);CHKERRQ(ierr);
814bde246dSDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "Inner subdomain:\n");CHKERRQ(ierr);
824bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
831575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
844bde246dSDmitry Karpeev   ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%s", cidx);CHKERRQ(ierr);
854bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
861575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
874bde246dSDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
884bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
894bde246dSDmitry Karpeev   ierr = PetscFree(cidx);CHKERRQ(ierr);
904bde246dSDmitry Karpeev   /* Outer subdomains. */
916a4f0f73SDmitry Karpeev   ierr = ISGetLocalSize(osm->ois[i], &nidx);CHKERRQ(ierr);
92eec7e3faSDmitry Karpeev   /*
93eec7e3faSDmitry Karpeev    No more than 15 characters per index plus a space.
94eec7e3faSDmitry Karpeev    PetscViewerStringSPrintf requires a string of size at least 2, so use (nidx+1) instead of nidx,
95eec7e3faSDmitry Karpeev    in case nidx == 0. That will take care of the space for the trailing '\0' as well.
96eec7e3faSDmitry Karpeev    For nidx == 0, the whole string 16 '\0'.
97eec7e3faSDmitry Karpeev    */
9889d949e2SBarry Smith   ierr = PetscMalloc1(16*(nidx+1)+1, &cidx);CHKERRQ(ierr);
9906b43e7eSDmitry Karpeev   ierr = PetscViewerStringOpen(PETSC_COMM_SELF, cidx, 16*(nidx+1)+1, &sviewer);CHKERRQ(ierr);
1006a4f0f73SDmitry Karpeev   ierr = ISGetIndices(osm->ois[i], &idx);CHKERRQ(ierr);
101af538404SDmitry Karpeev   for (j = 0; j < nidx; ++j) {
102af538404SDmitry Karpeev     ierr = PetscViewerStringSPrintf(sviewer,"%D ", idx[j]);CHKERRQ(ierr);
103af538404SDmitry Karpeev   }
1046bf464f9SBarry Smith   ierr = PetscViewerDestroy(&sviewer);CHKERRQ(ierr);
1056a4f0f73SDmitry Karpeev   ierr = ISRestoreIndices(osm->ois[i],&idx);CHKERRQ(ierr);
1066a4f0f73SDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "Outer subdomain:\n");CHKERRQ(ierr);
10706b43e7eSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
1081575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
109af538404SDmitry Karpeev   ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%s", cidx);CHKERRQ(ierr);
110af538404SDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
1111575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
112af538404SDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
11306b43e7eSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
114af538404SDmitry Karpeev   ierr = PetscFree(cidx);CHKERRQ(ierr);
11506b43e7eSDmitry Karpeev   PetscFunctionReturn(0);
11606b43e7eSDmitry Karpeev }
11706b43e7eSDmitry Karpeev 
11806b43e7eSDmitry Karpeev static PetscErrorCode  PCGASMPrintSubdomains(PC pc)
11906b43e7eSDmitry Karpeev {
12006b43e7eSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
12106b43e7eSDmitry Karpeev   const char     *prefix;
12206b43e7eSDmitry Karpeev   char           fname[PETSC_MAX_PATH_LEN+1];
1238f3b4b4dSDmitry Karpeev   PetscInt       l, d, count;
1248f3b4b4dSDmitry Karpeev   PetscBool      doprint,found;
1250298fd71SBarry Smith   PetscViewer    viewer, sviewer = NULL;
1268f3b4b4dSDmitry Karpeev   PetscInt       *numbering,*permutation;/* global numbering of locally-supported subdomains and the permutation from the local ordering */
12706b43e7eSDmitry Karpeev   PetscErrorCode ierr;
12806b43e7eSDmitry Karpeev 
12906b43e7eSDmitry Karpeev   PetscFunctionBegin;
13006b43e7eSDmitry Karpeev   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
1318f3b4b4dSDmitry Karpeev   doprint  = PETSC_FALSE;
132c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,prefix,"-pc_gasm_print_subdomains",&doprint,NULL);CHKERRQ(ierr);
1338f3b4b4dSDmitry Karpeev   if (!doprint) PetscFunctionReturn(0);
134c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,prefix,"-pc_gasm_print_subdomains",fname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr);
13506b43e7eSDmitry Karpeev   if (!found) { ierr = PetscStrcpy(fname,"stdout");CHKERRQ(ierr); };
136ce94432eSBarry Smith   ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)pc),fname,&viewer);CHKERRQ(ierr);
1374bde246dSDmitry Karpeev   /*
1384bde246dSDmitry Karpeev    Make sure the viewer has a name. Otherwise this may cause a deadlock or other weird errors when creating a subcomm viewer:
1394bde246dSDmitry Karpeev    the subcomm viewer will attempt to inherit the viewer's name, which, if not set, will be constructed collectively on the comm.
1404bde246dSDmitry Karpeev   */
1414bde246dSDmitry Karpeev   ierr = PetscObjectName((PetscObject)viewer);CHKERRQ(ierr);
1424bde246dSDmitry Karpeev   l    = 0;
1438f3b4b4dSDmitry Karpeev   ierr = PCGASMComputeGlobalSubdomainNumbering_Private(pc,&numbering,&permutation);CHKERRQ(ierr);
1448f3b4b4dSDmitry Karpeev   for (count = 0; count < osm->N; ++count) {
1454bde246dSDmitry Karpeev     /* Now let subdomains go one at a time in the global numbering order and print their subdomain/solver info. */
1464bde246dSDmitry Karpeev     if (l<osm->n) {
1474bde246dSDmitry Karpeev       d = permutation[l]; /* d is the local number of the l-th smallest (in the global ordering) among the locally supported subdomains */
1484bde246dSDmitry Karpeev       if (numbering[d] == count) {
1493f08860eSBarry Smith         ierr = PetscViewerGetSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
1504bde246dSDmitry Karpeev         ierr = PCGASMSubdomainView_Private(pc,d,sviewer);CHKERRQ(ierr);
1513f08860eSBarry Smith         ierr = PetscViewerRestoreSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
1524bde246dSDmitry Karpeev         ++l;
153af538404SDmitry Karpeev       }
1544bde246dSDmitry Karpeev     }
155ce94432eSBarry Smith     ierr = MPI_Barrier(PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1564bde246dSDmitry Karpeev   }
1578f3b4b4dSDmitry Karpeev   ierr = PetscFree2(numbering,permutation);CHKERRQ(ierr);
1584bde246dSDmitry Karpeev   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
159af538404SDmitry Karpeev   PetscFunctionReturn(0);
160af538404SDmitry Karpeev }
161af538404SDmitry Karpeev 
162af538404SDmitry Karpeev 
163f746d493SDmitry Karpeev static PetscErrorCode PCView_GASM(PC pc,PetscViewer viewer)
164b1a0a8a3SJed Brown {
165f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
166af538404SDmitry Karpeev   const char     *prefix;
167b1a0a8a3SJed Brown   PetscErrorCode ierr;
168af538404SDmitry Karpeev   PetscMPIInt    rank, size;
1698f3b4b4dSDmitry Karpeev   PetscInt       bsz;
17006b43e7eSDmitry Karpeev   PetscBool      iascii,view_subdomains=PETSC_FALSE;
171b1a0a8a3SJed Brown   PetscViewer    sviewer;
1728f3b4b4dSDmitry Karpeev   PetscInt       count, l;
1736a4f0f73SDmitry Karpeev   char           overlap[256]     = "user-defined overlap";
1746a4f0f73SDmitry Karpeev   char           gsubdomains[256] = "unknown total number of subdomains";
17506b43e7eSDmitry Karpeev   char           msubdomains[256] = "unknown max number of local subdomains";
1768f3b4b4dSDmitry Karpeev   PetscInt       *numbering,*permutation;/* global numbering of locally-supported subdomains and the permutation from the local ordering */
17711aeaf0aSBarry Smith 
178b1a0a8a3SJed Brown   PetscFunctionBegin;
179ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size);CHKERRQ(ierr);
180ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank);CHKERRQ(ierr);
18106b43e7eSDmitry Karpeev 
18206b43e7eSDmitry Karpeev   if (osm->overlap >= 0) {
18306b43e7eSDmitry Karpeev     ierr = PetscSNPrintf(overlap,sizeof(overlap),"requested amount of overlap = %D",osm->overlap);CHKERRQ(ierr);
18406b43e7eSDmitry Karpeev   }
1858f3b4b4dSDmitry Karpeev   if (osm->N != PETSC_DETERMINE) {
1868f3b4b4dSDmitry Karpeev     ierr = PetscSNPrintf(gsubdomains, sizeof(gsubdomains), "total number of subdomains = %D",osm->N);CHKERRQ(ierr);
18706b43e7eSDmitry Karpeev   }
1888f3b4b4dSDmitry Karpeev   if (osm->nmax != PETSC_DETERMINE) {
18906b43e7eSDmitry Karpeev     ierr = PetscSNPrintf(msubdomains,sizeof(msubdomains),"max number of local subdomains = %D",osm->nmax);CHKERRQ(ierr);
19006b43e7eSDmitry Karpeev   }
19106b43e7eSDmitry Karpeev 
192af538404SDmitry Karpeev   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
193c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,prefix,"-pc_gasm_view_subdomains",&view_subdomains,NULL);CHKERRQ(ierr);
19406b43e7eSDmitry Karpeev 
19506b43e7eSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
196b1a0a8a3SJed Brown   if (iascii) {
19706b43e7eSDmitry Karpeev     /*
19806b43e7eSDmitry Karpeev      Make sure the viewer has a name. Otherwise this may cause a deadlock when creating a subcomm viewer:
19906b43e7eSDmitry Karpeev      the subcomm viewer will attempt to inherit the viewer's name, which, if not set, will be constructed
20006b43e7eSDmitry Karpeev      collectively on the comm.
20106b43e7eSDmitry Karpeev      */
20206b43e7eSDmitry Karpeev     ierr = PetscObjectName((PetscObject)viewer);CHKERRQ(ierr);
20306b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"Generalized additive Schwarz:\n");CHKERRQ(ierr);
20406b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"Restriction/interpolation type: %s\n",PCGASMTypes[osm->type]);CHKERRQ(ierr);
20506b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"%s\n",overlap);CHKERRQ(ierr);
20606b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"%s\n",gsubdomains);CHKERRQ(ierr);
20706b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"%s\n",msubdomains);CHKERRQ(ierr);
2081575c14dSBarry Smith     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
2098f3b4b4dSDmitry Karpeev     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d|%d] number of locally-supported subdomains = %D\n",rank,size,osm->n);CHKERRQ(ierr);
210af538404SDmitry Karpeev     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2111575c14dSBarry Smith     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
2126a4f0f73SDmitry Karpeev     /* Cannot take advantage of osm->same_subdomain_solvers without a global numbering of subdomains. */
21306b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"Subdomain solver info is as follows:\n");CHKERRQ(ierr);
214b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
215b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"- - - - - - - - - - - - - - - - - -\n");CHKERRQ(ierr);
21606b43e7eSDmitry Karpeev     /* Make sure that everybody waits for the banner to be printed. */
217ce94432eSBarry Smith     ierr = MPI_Barrier(PetscObjectComm((PetscObject)viewer));CHKERRQ(ierr);
2184bde246dSDmitry Karpeev     /* Now let subdomains go one at a time in the global numbering order and print their subdomain/solver info. */
2198f3b4b4dSDmitry Karpeev     ierr = PCGASMComputeGlobalSubdomainNumbering_Private(pc,&numbering,&permutation);CHKERRQ(ierr);
22006b43e7eSDmitry Karpeev     l = 0;
2218f3b4b4dSDmitry Karpeev     for (count = 0; count < osm->N; ++count) {
22206b43e7eSDmitry Karpeev       PetscMPIInt srank, ssize;
22306b43e7eSDmitry Karpeev       if (l<osm->n) {
22406b43e7eSDmitry Karpeev         PetscInt d = permutation[l]; /* d is the local number of the l-th smallest (in the global ordering) among the locally supported subdomains */
22506b43e7eSDmitry Karpeev         if (numbering[d] == count) {
2266a4f0f73SDmitry Karpeev           ierr = MPI_Comm_size(((PetscObject)osm->ois[d])->comm, &ssize);CHKERRQ(ierr);
2276a4f0f73SDmitry Karpeev           ierr = MPI_Comm_rank(((PetscObject)osm->ois[d])->comm, &srank);CHKERRQ(ierr);
2283f08860eSBarry Smith           ierr = PetscViewerGetSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
2296a4f0f73SDmitry Karpeev           ierr = ISGetLocalSize(osm->ois[d],&bsz);CHKERRQ(ierr);
2308f3b4b4dSDmitry Karpeev           ierr = PetscViewerASCIISynchronizedPrintf(sviewer,"[%d|%d] (subcomm [%d|%d]) local subdomain number %D, local size = %D\n",rank,size,srank,ssize,d,bsz);CHKERRQ(ierr);
2316a4f0f73SDmitry Karpeev           ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
23206b43e7eSDmitry Karpeev           if (view_subdomains) {
23306b43e7eSDmitry Karpeev             ierr = PCGASMSubdomainView_Private(pc,d,sviewer);CHKERRQ(ierr);
23406b43e7eSDmitry Karpeev           }
2356a4f0f73SDmitry Karpeev           if (!pc->setupcalled) {
2361575c14dSBarry Smith             ierr = PetscViewerASCIIPrintf(sviewer, "Solver not set up yet: PCSetUp() not yet called\n");CHKERRQ(ierr);
2372fa5cd67SKarl Rupp           } else {
23806b43e7eSDmitry Karpeev             ierr = KSPView(osm->ksp[d],sviewer);CHKERRQ(ierr);
2396a4f0f73SDmitry Karpeev           }
24006b43e7eSDmitry Karpeev           ierr = PetscViewerASCIIPrintf(sviewer,"- - - - - - - - - - - - - - - - - -\n");CHKERRQ(ierr);
2417b23a99aSBarry Smith           ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
2423f08860eSBarry Smith           ierr = PetscViewerRestoreSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
24306b43e7eSDmitry Karpeev           ++l;
244b1a0a8a3SJed Brown         }
24506b43e7eSDmitry Karpeev       }
246ce94432eSBarry Smith       ierr = MPI_Barrier(PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
247b1a0a8a3SJed Brown     }
2488f3b4b4dSDmitry Karpeev     ierr = PetscFree2(numbering,permutation);CHKERRQ(ierr);
249b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
250b1a0a8a3SJed Brown   }
251c5e4d11fSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2521575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
253b1a0a8a3SJed Brown   PetscFunctionReturn(0);
254b1a0a8a3SJed Brown }
255b1a0a8a3SJed Brown 
2568f3b4b4dSDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[]);
257af538404SDmitry Karpeev 
258ea91fabdSFande Kong 
259ea91fabdSFande Kong 
260ea91fabdSFande Kong PetscErrorCode PCGASMSetHierarchicalPartitioning(PC pc)
261ea91fabdSFande Kong {
262ea91fabdSFande Kong    PC_GASM              *osm = (PC_GASM*)pc->data;
263ea91fabdSFande Kong    MatPartitioning       part;
264ea91fabdSFande Kong    MPI_Comm              comm;
265ea91fabdSFande Kong    PetscMPIInt           size;
266ea91fabdSFande Kong    PetscInt              nlocalsubdomains,fromrows_localsize;
267ea91fabdSFande Kong    IS                    partitioning,fromrows,isn;
268ea91fabdSFande Kong    Vec                   outervec;
269ea91fabdSFande Kong    PetscErrorCode        ierr;
270ea91fabdSFande Kong 
271ea91fabdSFande Kong    PetscFunctionBegin;
272ea91fabdSFande Kong    ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
273ea91fabdSFande Kong    ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
274ea91fabdSFande Kong    /* we do not need a hierarchical partitioning when
275ea91fabdSFande Kong     * the total number of subdomains is consistent with
276ea91fabdSFande Kong     * the number of MPI tasks.
277ea91fabdSFande Kong     * For the following cases, we do not need to use HP
278ea91fabdSFande Kong     * */
279670417b2SFande Kong    if(osm->N==PETSC_DETERMINE || osm->N>=size || osm->N==1) PetscFunctionReturn(0);
280670417b2SFande Kong    if(size%osm->N != 0) SETERRQ2(PETSC_COMM_WORLD,PETSC_ERR_ARG_INCOMP,"have to specify the total number of subdomains %D to be a factor of the number of processors %d \n",osm->N,size);
281ea91fabdSFande Kong    nlocalsubdomains = size/osm->N;
282ea91fabdSFande Kong    osm->n           = 1;
283ea91fabdSFande Kong    ierr = MatPartitioningCreate(comm,&part);CHKERRQ(ierr);
284ea91fabdSFande Kong    ierr = MatPartitioningSetAdjacency(part,pc->pmat);CHKERRQ(ierr);
285ea91fabdSFande Kong    ierr = MatPartitioningSetType(part,MATPARTITIONINGHIERARCH);CHKERRQ(ierr);
286ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNcoarseparts(part,osm->N);CHKERRQ(ierr);
287ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNfineparts(part,nlocalsubdomains);CHKERRQ(ierr);
288ea91fabdSFande Kong    ierr = MatPartitioningSetFromOptions(part);CHKERRQ(ierr);
289ea91fabdSFande Kong    /* get new processor owner number of each vertex */
290ea91fabdSFande Kong    ierr = MatPartitioningApply(part,&partitioning);CHKERRQ(ierr);
291ea91fabdSFande Kong    ierr = ISBuildTwoSided(partitioning,NULL,&fromrows);CHKERRQ(ierr);
292ea91fabdSFande Kong    ierr = ISPartitioningToNumbering(partitioning,&isn);CHKERRQ(ierr);
293ea91fabdSFande Kong    ierr = ISDestroy(&isn);CHKERRQ(ierr);
294ea91fabdSFande Kong    ierr = ISGetLocalSize(fromrows,&fromrows_localsize);CHKERRQ(ierr);
295ea91fabdSFande Kong    ierr = MatPartitioningDestroy(&part);CHKERRQ(ierr);
296ea91fabdSFande Kong    ierr = MatCreateVecs(pc->pmat,&outervec,NULL);CHKERRQ(ierr);
297ea91fabdSFande Kong    ierr = VecCreateMPI(comm,fromrows_localsize,PETSC_DETERMINE,&(osm->pcx));CHKERRQ(ierr);
298ea91fabdSFande Kong    ierr = VecDuplicate(osm->pcx,&(osm->pcy));CHKERRQ(ierr);
299ea91fabdSFande Kong    ierr = VecScatterCreate(osm->pcx,NULL,outervec,fromrows,&(osm->pctoouter));CHKERRQ(ierr);
300ea91fabdSFande Kong    ierr = MatGetSubMatrix(pc->pmat,fromrows,fromrows,MAT_INITIAL_MATRIX,&(osm->permutationP));CHKERRQ(ierr);
301ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)fromrows);CHKERRQ(ierr);
302ea91fabdSFande Kong    osm->permutationIS = fromrows;
303ea91fabdSFande Kong    osm->pcmat =  pc->pmat;
304ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
305ea91fabdSFande Kong    pc->pmat = osm->permutationP;
306ea91fabdSFande Kong    ierr = VecDestroy(&outervec);CHKERRQ(ierr);
307ea91fabdSFande Kong    ierr = ISDestroy(&fromrows);CHKERRQ(ierr);
308ea91fabdSFande Kong    ierr = ISDestroy(&partitioning);CHKERRQ(ierr);
309ea91fabdSFande Kong    osm->n           = PETSC_DETERMINE;
310ea91fabdSFande Kong    PetscFunctionReturn(0);
311ea91fabdSFande Kong }
312ea91fabdSFande Kong 
313ea91fabdSFande Kong 
314ea91fabdSFande Kong 
315f746d493SDmitry Karpeev static PetscErrorCode PCSetUp_GASM(PC pc)
316b1a0a8a3SJed Brown {
317f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
318b1a0a8a3SJed Brown   PetscErrorCode ierr;
319b1a0a8a3SJed Brown   PetscBool      symset,flg;
320ea91fabdSFande Kong   PetscInt       i,nInnerIndices,nTotalInnerIndices;
321c10bc1a1SDmitry Karpeev   PetscMPIInt    rank, size;
322b1a0a8a3SJed Brown   MatReuse       scall = MAT_REUSE_MATRIX;
323b1a0a8a3SJed Brown   KSP            ksp;
324b1a0a8a3SJed Brown   PC             subpc;
325b1a0a8a3SJed Brown   const char     *prefix,*pprefix;
326f746d493SDmitry Karpeev   Vec            x,y;
3276a4f0f73SDmitry Karpeev   PetscInt       oni;       /* Number of indices in the i-th local outer subdomain.               */
3286a4f0f73SDmitry Karpeev   const PetscInt *oidxi;    /* Indices from the i-th subdomain local outer subdomain.             */
3296a4f0f73SDmitry Karpeev   PetscInt       on;        /* Number of indices in the disjoint union of local outer subdomains. */
3306a4f0f73SDmitry Karpeev   PetscInt       *oidx;     /* Indices in the disjoint union of local outer subdomains. */
3316a4f0f73SDmitry Karpeev   IS             gois;      /* Disjoint union the global indices of outer subdomains.             */
3326a4f0f73SDmitry Karpeev   IS             goid;      /* Identity IS of the size of the disjoint union of outer subdomains. */
333f746d493SDmitry Karpeev   PetscScalar    *gxarray, *gyarray;
334930d09c1SFande Kong   PetscInt       gostart;   /* Start of locally-owned indices in the vectors -- osm->gx,osm->gy -- over the disjoint union of outer subdomains. */
3358f3b4b4dSDmitry Karpeev   PetscInt       num_subdomains    = 0;
3360298fd71SBarry Smith   DM             *subdomain_dm     = NULL;
3378f3b4b4dSDmitry Karpeev   char           **subdomain_names = NULL;
338f771a274SFande Kong   PetscInt       *numbering;
3398f3b4b4dSDmitry Karpeev 
340b1a0a8a3SJed Brown 
341b1a0a8a3SJed Brown   PetscFunctionBegin;
342ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
343ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
344b1a0a8a3SJed Brown   if (!pc->setupcalled) {
345ea91fabdSFande Kong 	/* use a hierarchical partitioning */
346ea91fabdSFande Kong     if(osm->hierarchicalpartitioning){
347ea91fabdSFande Kong       ierr = PCGASMSetHierarchicalPartitioning(pc);CHKERRQ(ierr);
348ea91fabdSFande Kong     }
349b1a0a8a3SJed Brown     if (!osm->type_set) {
350b1a0a8a3SJed Brown       ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
3512fa5cd67SKarl Rupp       if (symset && flg) osm->type = PC_GASM_BASIC;
352b1a0a8a3SJed Brown     }
353b1a0a8a3SJed Brown 
3548f3b4b4dSDmitry Karpeev     if (osm->n == PETSC_DETERMINE) {
3558f3b4b4dSDmitry Karpeev       if (osm->N != PETSC_DETERMINE) {
3568f3b4b4dSDmitry Karpeev 	   /* No local subdomains given, but the desired number of total subdomains is known, so construct them accordingly. */
3578f3b4b4dSDmitry Karpeev 	   ierr = PCGASMCreateSubdomains(pc->pmat,osm->N,&osm->n,&osm->iis);CHKERRQ(ierr);
3588f3b4b4dSDmitry Karpeev       } else if (osm->dm_subdomains && pc->dm) {
3598f3b4b4dSDmitry Karpeev 	/* try pc->dm next, if allowed */
3608f3b4b4dSDmitry Karpeev 	PetscInt  d;
361a35b7b57SDmitry Karpeev 	IS       *inner_subdomain_is, *outer_subdomain_is;
362a35b7b57SDmitry Karpeev 	ierr = DMCreateDomainDecomposition(pc->dm, &num_subdomains, &subdomain_names, &inner_subdomain_is, &outer_subdomain_is, &subdomain_dm);CHKERRQ(ierr);
363a35b7b57SDmitry Karpeev 	if (num_subdomains) {
364a35b7b57SDmitry Karpeev 	  ierr = PCGASMSetSubdomains(pc, num_subdomains, inner_subdomain_is, outer_subdomain_is);CHKERRQ(ierr);
36569ca1f37SDmitry Karpeev 	}
366a35b7b57SDmitry Karpeev 	for (d = 0; d < num_subdomains; ++d) {
367a35b7b57SDmitry Karpeev 	  if (inner_subdomain_is) {ierr = ISDestroy(&inner_subdomain_is[d]);CHKERRQ(ierr);}
368a35b7b57SDmitry Karpeev 	  if (outer_subdomain_is) {ierr = ISDestroy(&outer_subdomain_is[d]);CHKERRQ(ierr);}
369fdc48646SDmitry Karpeev 	}
370a35b7b57SDmitry Karpeev 	ierr = PetscFree(inner_subdomain_is);CHKERRQ(ierr);
371a35b7b57SDmitry Karpeev 	ierr = PetscFree(outer_subdomain_is);CHKERRQ(ierr);
3728f3b4b4dSDmitry Karpeev       } else {
3738f3b4b4dSDmitry Karpeev 	/* still no subdomains; use one per processor */
37444fe18e5SDmitry Karpeev 	osm->nmax = osm->n = 1;
375ce94432eSBarry Smith 	ierr      = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
376f746d493SDmitry Karpeev 	osm->N    = size;
3778f3b4b4dSDmitry Karpeev 	ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
378fdc48646SDmitry Karpeev       }
37906b43e7eSDmitry Karpeev     }
380a35b7b57SDmitry Karpeev     if (!osm->iis) {
381a35b7b57SDmitry Karpeev       /*
3828f3b4b4dSDmitry Karpeev        osm->n was set in PCGASMSetSubdomains(), but the actual subdomains have not been supplied.
3838f3b4b4dSDmitry Karpeev        We create the requisite number of local inner subdomains and then expand them into
3848f3b4b4dSDmitry Karpeev        out subdomains, if necessary.
385a35b7b57SDmitry Karpeev        */
3868f3b4b4dSDmitry Karpeev       ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
387a35b7b57SDmitry Karpeev     }
3888f3b4b4dSDmitry Karpeev     if (!osm->ois) {
3898f3b4b4dSDmitry Karpeev       /*
3908f3b4b4dSDmitry Karpeev 	    Initially make outer subdomains the same as inner subdomains. If nonzero additional overlap
3918f3b4b4dSDmitry Karpeev 	    has been requested, copy the inner subdomains over so they can be modified.
3928f3b4b4dSDmitry Karpeev       */
3938f3b4b4dSDmitry Karpeev       ierr = PetscMalloc1(osm->n,&osm->ois);CHKERRQ(ierr);
3948f3b4b4dSDmitry Karpeev       for (i=0; i<osm->n; ++i) {
395ea91fabdSFande Kong 	if (osm->overlap > 0 && osm->N>1) { /* With positive overlap, osm->iis[i] will be modified */
3968f3b4b4dSDmitry Karpeev 	  ierr = ISDuplicate(osm->iis[i],(osm->ois)+i);CHKERRQ(ierr);
3978f3b4b4dSDmitry Karpeev 	  ierr = ISCopy(osm->iis[i],osm->ois[i]);CHKERRQ(ierr);
3988f3b4b4dSDmitry Karpeev 	} else {
3998f3b4b4dSDmitry Karpeev 	  ierr      = PetscObjectReference((PetscObject)((osm->iis)[i]));CHKERRQ(ierr);
4008f3b4b4dSDmitry Karpeev 	  osm->ois[i] = osm->iis[i];
4018f3b4b4dSDmitry Karpeev 	}
4028f3b4b4dSDmitry Karpeev       }
403ea91fabdSFande Kong       if (osm->overlap>0 && osm->N>1) {
4048f3b4b4dSDmitry Karpeev 	   /* Extend the "overlapping" regions by a number of steps */
405d21f2a47SFande Kong 	   ierr = MatIncreaseOverlapSplit(pc->pmat,osm->n,osm->ois,osm->overlap);CHKERRQ(ierr);
4068f3b4b4dSDmitry Karpeev       }
407b1a0a8a3SJed Brown     }
4086a4f0f73SDmitry Karpeev 
4098f3b4b4dSDmitry Karpeev     /* Now the subdomains are defined.  Determine their global and max local numbers, if necessary. */
4108f3b4b4dSDmitry Karpeev     if (osm->nmax == PETSC_DETERMINE) {
4118f3b4b4dSDmitry Karpeev       PetscMPIInt inwork,outwork;
4128f3b4b4dSDmitry Karpeev       /* determine global number of subdomains and the max number of local subdomains */
4138f3b4b4dSDmitry Karpeev       inwork = osm->n;
414b2566f29SBarry Smith       ierr       = MPIU_Allreduce(&inwork,&outwork,1,MPI_INT,MPI_MAX,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
4158f3b4b4dSDmitry Karpeev       osm->nmax  = outwork;
4168f3b4b4dSDmitry Karpeev     }
4178f3b4b4dSDmitry Karpeev     if (osm->N == PETSC_DETERMINE) {
4188f3b4b4dSDmitry Karpeev       /* Determine the number of globally-distinct subdomains and compute a global numbering for them. */
4198f3b4b4dSDmitry Karpeev       ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,&osm->N,NULL);CHKERRQ(ierr);
4208f3b4b4dSDmitry Karpeev     }
4218f3b4b4dSDmitry Karpeev 
422b1a0a8a3SJed Brown 
423b1a0a8a3SJed Brown     if (osm->sort_indices) {
424f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4256a4f0f73SDmitry Karpeev         ierr = ISSort(osm->ois[i]);CHKERRQ(ierr);
4266a4f0f73SDmitry Karpeev         ierr = ISSort(osm->iis[i]);CHKERRQ(ierr);
427b1a0a8a3SJed Brown       }
428b1a0a8a3SJed Brown     }
4298f3b4b4dSDmitry Karpeev     ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
4308f3b4b4dSDmitry Karpeev     ierr = PCGASMPrintSubdomains(pc);CHKERRQ(ierr);
4318f3b4b4dSDmitry Karpeev 
4326a4f0f73SDmitry Karpeev     /*
4336a4f0f73SDmitry Karpeev        Merge the ISs, create merged vectors and restrictions.
4346a4f0f73SDmitry Karpeev      */
4356a4f0f73SDmitry Karpeev     /* Merge outer subdomain ISs and construct a restriction onto the disjoint union of local outer subdomains. */
4366a4f0f73SDmitry Karpeev     on = 0;
437f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4386a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4396a4f0f73SDmitry Karpeev       on  += oni;
440f746d493SDmitry Karpeev     }
441785e854fSJed Brown     ierr = PetscMalloc1(on, &oidx);CHKERRQ(ierr);
4426a4f0f73SDmitry Karpeev     on   = 0;
443930d09c1SFande Kong     /* Merge local indices together */
444f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4456a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4466a4f0f73SDmitry Karpeev       ierr = ISGetIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4476a4f0f73SDmitry Karpeev       ierr = PetscMemcpy(oidx+on,oidxi,sizeof(PetscInt)*oni);CHKERRQ(ierr);
4486a4f0f73SDmitry Karpeev       ierr = ISRestoreIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4496a4f0f73SDmitry Karpeev       on  += oni;
450f746d493SDmitry Karpeev     }
4516a4f0f73SDmitry Karpeev     ierr = ISCreateGeneral(((PetscObject)(pc))->comm,on,oidx,PETSC_OWN_POINTER,&gois);CHKERRQ(ierr);
452ea91fabdSFande Kong     nTotalInnerIndices = 0;
453ea91fabdSFande Kong     for(i=0; i<osm->n; i++){
454ea91fabdSFande Kong       ierr = ISGetLocalSize(osm->iis[i],&nInnerIndices);CHKERRQ(ierr);
455ea91fabdSFande Kong       nTotalInnerIndices += nInnerIndices;
456ea91fabdSFande Kong     }
457ea91fabdSFande Kong     ierr = VecCreateMPI(((PetscObject)(pc))->comm,nTotalInnerIndices,PETSC_DETERMINE,&x);CHKERRQ(ierr);
458ea91fabdSFande Kong     ierr = VecDuplicate(x,&y);CHKERRQ(ierr);
459ea91fabdSFande Kong 
460ce94432eSBarry Smith     ierr = VecCreateMPI(PetscObjectComm((PetscObject)pc),on,PETSC_DECIDE,&osm->gx);CHKERRQ(ierr);
461f746d493SDmitry Karpeev     ierr = VecDuplicate(osm->gx,&osm->gy);CHKERRQ(ierr);
462930d09c1SFande Kong     ierr = VecGetOwnershipRange(osm->gx, &gostart, NULL);CHKERRQ(ierr);
463930d09c1SFande Kong     ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),on,gostart,1, &goid);CHKERRQ(ierr);
464930d09c1SFande Kong     /* gois might indices not on local */
4656a4f0f73SDmitry Karpeev     ierr = VecScatterCreate(x,gois,osm->gx,goid, &(osm->gorestriction));CHKERRQ(ierr);
466f771a274SFande Kong     ierr = PetscMalloc1(osm->n,&numbering);CHKERRQ(ierr);
467f771a274SFande Kong     ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,NULL,numbering);CHKERRQ(ierr);
4686a4f0f73SDmitry Karpeev     ierr = VecDestroy(&x);CHKERRQ(ierr);
4697105d80bSDmitry Karpeev     ierr = ISDestroy(&gois);CHKERRQ(ierr);
4702fa5cd67SKarl Rupp 
4716a4f0f73SDmitry Karpeev     /* Merge inner subdomain ISs and construct a restriction onto the disjoint union of local inner subdomains. */
4722fa5cd67SKarl Rupp     {
4732fa5cd67SKarl Rupp       PetscInt        ini;           /* Number of indices the i-th a local inner subdomain. */
4746a4f0f73SDmitry Karpeev       PetscInt        in;            /* Number of indices in the disjoint uniont of local inner subdomains. */
4756a4f0f73SDmitry Karpeev       PetscInt       *iidx;          /* Global indices in the merged local inner subdomain. */
4766a4f0f73SDmitry Karpeev       PetscInt       *ioidx;         /* Global indices of the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
4776a4f0f73SDmitry Karpeev       IS              giis;          /* IS for the disjoint union of inner subdomains. */
4786a4f0f73SDmitry Karpeev       IS              giois;         /* IS for the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
479f771a274SFande Kong       PetscScalar    *array;
480f771a274SFande Kong       const PetscInt *indices;
481f771a274SFande Kong       PetscInt        k;
4826a4f0f73SDmitry Karpeev       on = 0;
483f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4846a4f0f73SDmitry Karpeev         ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4856a4f0f73SDmitry Karpeev         on  += oni;
486f746d493SDmitry Karpeev       }
487f771a274SFande Kong       ierr = PetscMalloc1(on, &iidx);CHKERRQ(ierr);
488f771a274SFande Kong       ierr = PetscMalloc1(on, &ioidx);CHKERRQ(ierr);
489f771a274SFande Kong       ierr = VecGetArray(y,&array);CHKERRQ(ierr);
490e12b4729SFande Kong       /* set communicator id to determine where overlap is */
491f771a274SFande Kong       in   = 0;
492f771a274SFande Kong       for (i=0; i<osm->n; i++) {
493f771a274SFande Kong         ierr   = ISGetLocalSize(osm->iis[i],&ini);CHKERRQ(ierr);
494f771a274SFande Kong         for (k = 0; k < ini; ++k){
495f771a274SFande Kong           array[in+k] = numbering[i];
496f771a274SFande Kong         }
497f771a274SFande Kong         in += ini;
498f771a274SFande Kong       }
499f771a274SFande Kong       ierr = VecRestoreArray(y,&array);CHKERRQ(ierr);
500f771a274SFande Kong       ierr = VecScatterBegin(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
501f771a274SFande Kong       ierr = VecScatterEnd(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
502f771a274SFande Kong       ierr = VecGetOwnershipRange(osm->gy,&gostart, NULL);CHKERRQ(ierr);
503f771a274SFande Kong       ierr = VecGetArray(osm->gy,&array);CHKERRQ(ierr);
504f771a274SFande Kong       on  = 0;
505f771a274SFande Kong       in  = 0;
506f771a274SFande Kong       for (i=0; i<osm->n; i++) {
507f771a274SFande Kong     	ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
508f771a274SFande Kong     	ierr = ISGetIndices(osm->ois[i],&indices);CHKERRQ(ierr);
509f771a274SFande Kong     	for (k=0; k<oni; k++) {
510e12b4729SFande Kong           /*  skip overlapping indices to get inner domain */
51143081b6cSDmitry Karpeev           if(PetscRealPart(array[on+k]) != numbering[i]) continue;
512f771a274SFande Kong           iidx[in]    = indices[k];
513f771a274SFande Kong           ioidx[in++] = gostart+on+k;
514f771a274SFande Kong     	}
515f771a274SFande Kong     	ierr   = ISRestoreIndices(osm->ois[i], &indices);CHKERRQ(ierr);
516f771a274SFande Kong     	on += oni;
517f771a274SFande Kong       }
518f771a274SFande Kong       ierr = VecRestoreArray(osm->gy,&array);CHKERRQ(ierr);
519ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,iidx,PETSC_OWN_POINTER,&giis);CHKERRQ(ierr);
520ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,ioidx,PETSC_OWN_POINTER,&giois);CHKERRQ(ierr);
5216a4f0f73SDmitry Karpeev       ierr = VecScatterCreate(y,giis,osm->gy,giois,&osm->girestriction);CHKERRQ(ierr);
5226a4f0f73SDmitry Karpeev       ierr = VecDestroy(&y);CHKERRQ(ierr);
5236a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giis);CHKERRQ(ierr);
5246a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giois);CHKERRQ(ierr);
525b1a0a8a3SJed Brown     }
5266a4f0f73SDmitry Karpeev     ierr = ISDestroy(&goid);CHKERRQ(ierr);
527f771a274SFande Kong     ierr = PetscFree(numbering);CHKERRQ(ierr);
5282fa5cd67SKarl Rupp 
529f746d493SDmitry Karpeev     /* Create the subdomain work vectors. */
530785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->x);CHKERRQ(ierr);
531785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->y);CHKERRQ(ierr);
532f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gx, &gxarray);CHKERRQ(ierr);
533f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gy, &gyarray);CHKERRQ(ierr);
5346a4f0f73SDmitry Karpeev     for (i=0, on=0; i<osm->n; ++i, on += oni) {
5356a4f0f73SDmitry Karpeev       PetscInt oNi;
5366a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
537930d09c1SFande Kong       /* on a sub communicator */
5386a4f0f73SDmitry Karpeev       ierr = ISGetSize(osm->ois[i],&oNi);CHKERRQ(ierr);
5396a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gxarray+on,&osm->x[i]);CHKERRQ(ierr);
5406a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gyarray+on,&osm->y[i]);CHKERRQ(ierr);
541b1a0a8a3SJed Brown     }
542f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gx, &gxarray);CHKERRQ(ierr);
543f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gy, &gyarray);CHKERRQ(ierr);
5448f3b4b4dSDmitry Karpeev     /* Create the subdomain solvers */
545785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->ksp);CHKERRQ(ierr);
5468f3b4b4dSDmitry Karpeev     for (i=0; i<osm->n; i++) {
5478f3b4b4dSDmitry Karpeev       char subprefix[PETSC_MAX_PATH_LEN+1];
5486a4f0f73SDmitry Karpeev       ierr        = KSPCreate(((PetscObject)(osm->ois[i]))->comm,&ksp);CHKERRQ(ierr);
5493bb1ff40SBarry Smith       ierr        = PetscLogObjectParent((PetscObject)pc,(PetscObject)ksp);CHKERRQ(ierr);
550b1a0a8a3SJed Brown       ierr        = PetscObjectIncrementTabLevel((PetscObject)ksp,(PetscObject)pc,1);CHKERRQ(ierr);
551b1a0a8a3SJed Brown       ierr        = KSPSetType(ksp,KSPPREONLY);CHKERRQ(ierr);
5528f3b4b4dSDmitry Karpeev       ierr        = KSPGetPC(ksp,&subpc);CHKERRQ(ierr); /* Why do we need this here? */
5538f3b4b4dSDmitry Karpeev       if (subdomain_dm) {
5548f3b4b4dSDmitry Karpeev 	    ierr = KSPSetDM(ksp,subdomain_dm[i]);CHKERRQ(ierr);
5558f3b4b4dSDmitry Karpeev 	    ierr = DMDestroy(subdomain_dm+i);CHKERRQ(ierr);
5568f3b4b4dSDmitry Karpeev       }
557b1a0a8a3SJed Brown       ierr        = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
558b1a0a8a3SJed Brown       ierr        = KSPSetOptionsPrefix(ksp,prefix);CHKERRQ(ierr);
5598f3b4b4dSDmitry Karpeev       if (subdomain_names && subdomain_names[i]) {
5608f3b4b4dSDmitry Karpeev 	     ierr = PetscSNPrintf(subprefix,PETSC_MAX_PATH_LEN,"sub_%s_",subdomain_names[i]);CHKERRQ(ierr);
5618f3b4b4dSDmitry Karpeev 	     ierr = KSPAppendOptionsPrefix(ksp,subprefix);CHKERRQ(ierr);
5628f3b4b4dSDmitry Karpeev 	     ierr = PetscFree(subdomain_names[i]);CHKERRQ(ierr);
5638f3b4b4dSDmitry Karpeev       }
564b1a0a8a3SJed Brown       ierr        = KSPAppendOptionsPrefix(ksp,"sub_");CHKERRQ(ierr);
565b1a0a8a3SJed Brown       osm->ksp[i] = ksp;
566b1a0a8a3SJed Brown     }
5678f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_dm);CHKERRQ(ierr);
5688f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_names);CHKERRQ(ierr);
569b1a0a8a3SJed Brown     scall = MAT_INITIAL_MATRIX;
570b1a0a8a3SJed Brown 
5718f3b4b4dSDmitry Karpeev   } else { /* if (pc->setupcalled) */
572b1a0a8a3SJed Brown     /*
5738f3b4b4dSDmitry Karpeev        Destroy the submatrices from the previous iteration
574b1a0a8a3SJed Brown     */
575b1a0a8a3SJed Brown     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
576f746d493SDmitry Karpeev       ierr  = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
577b1a0a8a3SJed Brown       scall = MAT_INITIAL_MATRIX;
578b1a0a8a3SJed Brown     }
579ea91fabdSFande Kong     if(osm->permutationIS){
580ea91fabdSFande Kong       ierr = MatGetSubMatrix(pc->pmat,osm->permutationIS,osm->permutationIS,scall,&osm->permutationP);CHKERRQ(ierr);
581ea91fabdSFande Kong       ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
582ea91fabdSFande Kong       osm->pcmat = pc->pmat;
583ea91fabdSFande Kong       pc->pmat   = osm->permutationP;
584b1a0a8a3SJed Brown     }
585b1a0a8a3SJed Brown 
586ea91fabdSFande Kong   }
587ea91fabdSFande Kong 
588ea91fabdSFande Kong 
589b1a0a8a3SJed Brown   /*
590f746d493SDmitry Karpeev      Extract out the submatrices.
591b1a0a8a3SJed Brown   */
59281a5c4aaSDmitry Karpeev   if (size > 1) {
5938f3b4b4dSDmitry Karpeev     ierr = MatGetSubMatricesMPI(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
5942fa5cd67SKarl Rupp   } else {
5956a4f0f73SDmitry Karpeev     ierr = MatGetSubMatrices(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
59681a5c4aaSDmitry Karpeev   }
597b1a0a8a3SJed Brown   if (scall == MAT_INITIAL_MATRIX) {
598b1a0a8a3SJed Brown     ierr = PetscObjectGetOptionsPrefix((PetscObject)pc->pmat,&pprefix);CHKERRQ(ierr);
599f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
6003bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)osm->pmat[i]);CHKERRQ(ierr);
601b1a0a8a3SJed Brown       ierr = PetscObjectSetOptionsPrefix((PetscObject)osm->pmat[i],pprefix);CHKERRQ(ierr);
602b1a0a8a3SJed Brown     }
603b1a0a8a3SJed Brown   }
604b1a0a8a3SJed Brown 
605b1a0a8a3SJed Brown   /* Return control to the user so that the submatrices can be modified (e.g., to apply
606b1a0a8a3SJed Brown      different boundary conditions for the submatrices than for the global problem) */
6076a4f0f73SDmitry Karpeev   ierr = PCModifySubMatrices(pc,osm->n,osm->ois,osm->ois,osm->pmat,pc->modifysubmatricesP);CHKERRQ(ierr);
608b1a0a8a3SJed Brown 
609b1a0a8a3SJed Brown   /*
6106a4f0f73SDmitry Karpeev      Loop over submatrices putting them into local ksps
611b1a0a8a3SJed Brown   */
612f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
61323ee1639SBarry Smith     ierr = KSPSetOperators(osm->ksp[i],osm->pmat[i],osm->pmat[i]);CHKERRQ(ierr);
614b1a0a8a3SJed Brown     if (!pc->setupcalled) {
615b1a0a8a3SJed Brown       ierr = KSPSetFromOptions(osm->ksp[i]);CHKERRQ(ierr);
616b1a0a8a3SJed Brown     }
617b1a0a8a3SJed Brown   }
618ea91fabdSFande Kong   if(osm->pcmat){
619ea91fabdSFande Kong     ierr = MatDestroy(&pc->pmat);CHKERRQ(ierr);
620ea91fabdSFande Kong     pc->pmat   = osm->pcmat;
621ea91fabdSFande Kong     osm->pcmat = 0;
622ea91fabdSFande Kong   }
623b1a0a8a3SJed Brown   PetscFunctionReturn(0);
624b1a0a8a3SJed Brown }
625b1a0a8a3SJed Brown 
626f746d493SDmitry Karpeev static PetscErrorCode PCSetUpOnBlocks_GASM(PC pc)
627b1a0a8a3SJed Brown {
628f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
629b1a0a8a3SJed Brown   PetscErrorCode ierr;
630b1a0a8a3SJed Brown   PetscInt       i;
631b1a0a8a3SJed Brown 
632b1a0a8a3SJed Brown   PetscFunctionBegin;
633f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
634b1a0a8a3SJed Brown     ierr = KSPSetUp(osm->ksp[i]);CHKERRQ(ierr);
635b1a0a8a3SJed Brown   }
636b1a0a8a3SJed Brown   PetscFunctionReturn(0);
637b1a0a8a3SJed Brown }
638b1a0a8a3SJed Brown 
639ea91fabdSFande Kong static PetscErrorCode PCApply_GASM(PC pc,Vec xin,Vec yout)
640b1a0a8a3SJed Brown {
641f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
642b1a0a8a3SJed Brown   PetscErrorCode ierr;
643f746d493SDmitry Karpeev   PetscInt       i;
644ea91fabdSFande Kong   Vec            x,y;
645b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
646b1a0a8a3SJed Brown 
647b1a0a8a3SJed Brown   PetscFunctionBegin;
648ea91fabdSFande Kong   if(osm->pctoouter){
649ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
650ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
651ea91fabdSFande Kong     x = osm->pcx;
652ea91fabdSFande Kong     y = osm->pcy;
653ea91fabdSFande Kong   }else{
654ea91fabdSFande Kong 	x = xin;
655ea91fabdSFande Kong 	y = yout;
656ea91fabdSFande Kong   }
657b1a0a8a3SJed Brown   /*
6586a4f0f73SDmitry Karpeev      Support for limiting the restriction or interpolation only to the inner
659b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
660b1a0a8a3SJed Brown   */
661f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
662b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
663f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
6646a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6652fa5cd67SKarl Rupp   } else {
6666a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
667b1a0a8a3SJed Brown   }
6686a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
6696a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
6706a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6712fa5cd67SKarl Rupp   } else {
6726a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6736a4f0f73SDmitry Karpeev   }
67486b96d36SDmitry Karpeev   /* do the subdomain solves */
67586b96d36SDmitry Karpeev   for (i=0; i<osm->n; ++i) {
676b1a0a8a3SJed Brown     ierr = KSPSolve(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
677b1a0a8a3SJed Brown   }
678930d09c1SFande Kong   /* Do we need to zero y ?? */
6796a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
6806a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
6816a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
682ea91fabdSFande Kong     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
6832fa5cd67SKarl Rupp   } else {
6846a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
685ea91fabdSFande Kong     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
6866a4f0f73SDmitry Karpeev   }
687ea91fabdSFande Kong   if(osm->pctoouter){
688ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
689ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
690ea91fabdSFande Kong   }
691ea91fabdSFande Kong   PetscFunctionReturn(0);
692b1a0a8a3SJed Brown }
693b1a0a8a3SJed Brown 
694ea91fabdSFande Kong static PetscErrorCode PCApplyTranspose_GASM(PC pc,Vec xin,Vec yout)
695b1a0a8a3SJed Brown {
696f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
697b1a0a8a3SJed Brown   PetscErrorCode ierr;
698f746d493SDmitry Karpeev   PetscInt       i;
699ea91fabdSFande Kong   Vec            x,y;
700b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
701b1a0a8a3SJed Brown 
702b1a0a8a3SJed Brown   PetscFunctionBegin;
703ea91fabdSFande Kong   if(osm->pctoouter){
704ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
705ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
706ea91fabdSFande Kong    x = osm->pcx;
707ea91fabdSFande Kong    y = osm->pcy;
708ea91fabdSFande Kong   }else{
709ea91fabdSFande Kong 	x = xin;
710ea91fabdSFande Kong 	y = yout;
711ea91fabdSFande Kong   }
712b1a0a8a3SJed Brown   /*
713b1a0a8a3SJed Brown      Support for limiting the restriction or interpolation to only local
714b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
715b1a0a8a3SJed Brown 
716f746d493SDmitry Karpeev      Note: these are reversed from the PCApply_GASM() because we are applying the
717b1a0a8a3SJed Brown      transpose of the three terms
718b1a0a8a3SJed Brown   */
719f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
720b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
721f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
7226a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7232fa5cd67SKarl Rupp   } else {
7246a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
725b1a0a8a3SJed Brown   }
7266a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
7276a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
7286a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7292fa5cd67SKarl Rupp   } else {
7306a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7316a4f0f73SDmitry Karpeev   }
732b1a0a8a3SJed Brown   /* do the local solves */
733ab3e923fSDmitry Karpeev   for (i=0; i<osm->n; ++i) { /* Note that the solves are local, so we can go to osm->n, rather than osm->nmax. */
734b1a0a8a3SJed Brown     ierr = KSPSolveTranspose(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
735b1a0a8a3SJed Brown   }
7366a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
7376a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
7386a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7396a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7402fa5cd67SKarl Rupp   } else {
7416a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7426a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7436a4f0f73SDmitry Karpeev   }
744ea91fabdSFande Kong   if(osm->pctoouter){
745ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
746ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
747ea91fabdSFande Kong   }
748b1a0a8a3SJed Brown   PetscFunctionReturn(0);
749b1a0a8a3SJed Brown }
750b1a0a8a3SJed Brown 
751a06653b4SBarry Smith static PetscErrorCode PCReset_GASM(PC pc)
752b1a0a8a3SJed Brown {
753f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
754b1a0a8a3SJed Brown   PetscErrorCode ierr;
755b1a0a8a3SJed Brown   PetscInt       i;
756b1a0a8a3SJed Brown 
757b1a0a8a3SJed Brown   PetscFunctionBegin;
758b1a0a8a3SJed Brown   if (osm->ksp) {
759f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
760a06653b4SBarry Smith       ierr = KSPReset(osm->ksp[i]);CHKERRQ(ierr);
761b1a0a8a3SJed Brown     }
762b1a0a8a3SJed Brown   }
763b1a0a8a3SJed Brown   if (osm->pmat) {
764f746d493SDmitry Karpeev     if (osm->n > 0) {
765ab3e923fSDmitry Karpeev       ierr = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
766b1a0a8a3SJed Brown     }
767b1a0a8a3SJed Brown   }
768d34fcf5fSBarry Smith   if (osm->x) {
769f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
770fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->x[i]);CHKERRQ(ierr);
771fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->y[i]);CHKERRQ(ierr);
772b1a0a8a3SJed Brown     }
773d34fcf5fSBarry Smith   }
7746bf464f9SBarry Smith   ierr = VecDestroy(&osm->gx);CHKERRQ(ierr);
7756bf464f9SBarry Smith   ierr = VecDestroy(&osm->gy);CHKERRQ(ierr);
776ab3e923fSDmitry Karpeev 
7776a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->gorestriction);CHKERRQ(ierr);
7786a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->girestriction);CHKERRQ(ierr);
7798f3b4b4dSDmitry Karpeev   if (!osm->user_subdomains) {
7802c112581SDmitry Karpeev     ierr      = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
7818f3b4b4dSDmitry Karpeev     osm->N    = PETSC_DETERMINE;
7828f3b4b4dSDmitry Karpeev     osm->nmax = PETSC_DETERMINE;
7838f3b4b4dSDmitry Karpeev   }
784ea91fabdSFande Kong   if(osm->pctoouter){
785ea91fabdSFande Kong 	ierr = VecScatterDestroy(&(osm->pctoouter));CHKERRQ(ierr);
786ea91fabdSFande Kong   }
787ea91fabdSFande Kong   if(osm->permutationIS){
788ea91fabdSFande Kong 	ierr = ISDestroy(&(osm->permutationIS));CHKERRQ(ierr);
789ea91fabdSFande Kong   }
790ea91fabdSFande Kong   if(osm->pcx){
791ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcx));CHKERRQ(ierr);
792ea91fabdSFande Kong   }
793ea91fabdSFande Kong   if(osm->pcy){
794ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcy));CHKERRQ(ierr);
795ea91fabdSFande Kong   }
796ea91fabdSFande Kong   if(osm->permutationP){
797ea91fabdSFande Kong     ierr = MatDestroy(&(osm->permutationP));CHKERRQ(ierr);
798ea91fabdSFande Kong   }
799ea91fabdSFande Kong   if(osm->pcmat){
800ea91fabdSFande Kong 	ierr = MatDestroy(&osm->pcmat);CHKERRQ(ierr);
801ea91fabdSFande Kong   }
802a06653b4SBarry Smith   PetscFunctionReturn(0);
803a06653b4SBarry Smith }
804a06653b4SBarry Smith 
805a06653b4SBarry Smith static PetscErrorCode PCDestroy_GASM(PC pc)
806a06653b4SBarry Smith {
807a06653b4SBarry Smith   PC_GASM        *osm = (PC_GASM*)pc->data;
808a06653b4SBarry Smith   PetscErrorCode ierr;
809a06653b4SBarry Smith   PetscInt       i;
810a06653b4SBarry Smith 
811a06653b4SBarry Smith   PetscFunctionBegin;
812a06653b4SBarry Smith   ierr = PCReset_GASM(pc);CHKERRQ(ierr);
813135757f6SDmitry Karpeev   /* PCReset will not destroy subdomains, if user_subdomains is true. */
814135757f6SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
815a06653b4SBarry Smith   if (osm->ksp) {
816a06653b4SBarry Smith     for (i=0; i<osm->n; i++) {
8176bf464f9SBarry Smith       ierr = KSPDestroy(&osm->ksp[i]);CHKERRQ(ierr);
818a06653b4SBarry Smith     }
819a06653b4SBarry Smith     ierr = PetscFree(osm->ksp);CHKERRQ(ierr);
820a06653b4SBarry Smith   }
821a06653b4SBarry Smith   ierr = PetscFree(osm->x);CHKERRQ(ierr);
822a06653b4SBarry Smith   ierr = PetscFree(osm->y);CHKERRQ(ierr);
823c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
824b1a0a8a3SJed Brown   PetscFunctionReturn(0);
825b1a0a8a3SJed Brown }
826b1a0a8a3SJed Brown 
8274416b707SBarry Smith static PetscErrorCode PCSetFromOptions_GASM(PetscOptionItems *PetscOptionsObject,PC pc)
828a6dfd86eSKarl Rupp {
829f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
830b1a0a8a3SJed Brown   PetscErrorCode ierr;
831b1a0a8a3SJed Brown   PetscInt       blocks,ovl;
832b1a0a8a3SJed Brown   PetscBool      symset,flg;
833f746d493SDmitry Karpeev   PCGASMType     gasmtype;
834b1a0a8a3SJed Brown 
835b1a0a8a3SJed Brown   PetscFunctionBegin;
836b1a0a8a3SJed Brown   /* set the type to symmetric if matrix is symmetric */
837b1a0a8a3SJed Brown   if (!osm->type_set && pc->pmat) {
838b1a0a8a3SJed Brown     ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
8392fa5cd67SKarl Rupp     if (symset && flg) osm->type = PC_GASM_BASIC;
840b1a0a8a3SJed Brown   }
841e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"Generalized additive Schwarz options");CHKERRQ(ierr);
8428f3b4b4dSDmitry Karpeev   ierr = PetscOptionsBool("-pc_gasm_use_dm_subdomains","If subdomains aren't set, use DMCreateDomainDecomposition() to define subdomains.","PCGASMSetUseDMSubdomains",osm->dm_subdomains,&osm->dm_subdomains,&flg);CHKERRQ(ierr);
8438f3b4b4dSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_total_subdomains","Total number of subdomains across communicator","PCGASMSetTotalSubdomains",osm->N,&blocks,&flg);CHKERRQ(ierr);
84465db9045SDmitry Karpeev   if (flg) {
8458f3b4b4dSDmitry Karpeev     ierr = PCGASMSetTotalSubdomains(pc,blocks);CHKERRQ(ierr);
84665db9045SDmitry Karpeev   }
84706b43e7eSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_overlap","Number of overlapping degrees of freedom","PCGASMSetOverlap",osm->overlap,&ovl,&flg);CHKERRQ(ierr);
84865db9045SDmitry Karpeev   if (flg) {
84965db9045SDmitry Karpeev     ierr = PCGASMSetOverlap(pc,ovl);CHKERRQ(ierr);
850d709ea83SDmitry Karpeev     osm->dm_subdomains = PETSC_FALSE;
85165db9045SDmitry Karpeev   }
852b1a0a8a3SJed Brown   flg  = PETSC_FALSE;
853f746d493SDmitry Karpeev   ierr = PetscOptionsEnum("-pc_gasm_type","Type of restriction/extension","PCGASMSetType",PCGASMTypes,(PetscEnum)osm->type,(PetscEnum*)&gasmtype,&flg);CHKERRQ(ierr);
854f746d493SDmitry Karpeev   if (flg) {ierr = PCGASMSetType(pc,gasmtype);CHKERRQ(ierr);}
855ea91fabdSFande Kong   ierr = PetscOptionsBool("-pc_gasm_use_hierachical_partitioning","use hierarchical partitioning",NULL,osm->hierarchicalpartitioning,&osm->hierarchicalpartitioning,&flg);CHKERRQ(ierr);
856b1a0a8a3SJed Brown   ierr = PetscOptionsTail();CHKERRQ(ierr);
857b1a0a8a3SJed Brown   PetscFunctionReturn(0);
858b1a0a8a3SJed Brown }
859b1a0a8a3SJed Brown 
860b1a0a8a3SJed Brown /*------------------------------------------------------------------------------------*/
861b1a0a8a3SJed Brown 
8628f3b4b4dSDmitry Karpeev /*@
8638f3b4b4dSDmitry Karpeev     PCGASMSetTotalSubdomains - sets the total number of subdomains to use across the
8648f3b4b4dSDmitry Karpeev                                communicator.
8658f3b4b4dSDmitry Karpeev     Logically collective on pc
8668f3b4b4dSDmitry Karpeev 
8678f3b4b4dSDmitry Karpeev     Input Parameters:
8688f3b4b4dSDmitry Karpeev +   pc  - the preconditioner
8698f3b4b4dSDmitry Karpeev -   N   - total number of subdomains
8708f3b4b4dSDmitry Karpeev 
8718f3b4b4dSDmitry Karpeev 
8728f3b4b4dSDmitry Karpeev     Level: beginner
8738f3b4b4dSDmitry Karpeev 
8748f3b4b4dSDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
8758f3b4b4dSDmitry Karpeev 
8768f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap()
8778f3b4b4dSDmitry Karpeev           PCGASMCreateSubdomains2D()
8788f3b4b4dSDmitry Karpeev @*/
8798f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetTotalSubdomains(PC pc,PetscInt N)
8808f3b4b4dSDmitry Karpeev {
8818f3b4b4dSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
8828f3b4b4dSDmitry Karpeev   PetscMPIInt    size,rank;
8838f3b4b4dSDmitry Karpeev   PetscErrorCode ierr;
8848f3b4b4dSDmitry Karpeev 
8858f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
8868f3b4b4dSDmitry Karpeev   if (N < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Total number of subdomains must be 1 or more, got N = %D",N);
8878f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetTotalSubdomains() should be called before calling PCSetUp().");
8888f3b4b4dSDmitry Karpeev 
8892c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
8908f3b4b4dSDmitry Karpeev   osm->ois = osm->iis = NULL;
8918f3b4b4dSDmitry Karpeev 
8928f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
8938f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
8948f3b4b4dSDmitry Karpeev   osm->N    = N;
8958f3b4b4dSDmitry Karpeev   osm->n    = PETSC_DETERMINE;
8968f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
8978f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
8988f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
8998f3b4b4dSDmitry Karpeev }
9008f3b4b4dSDmitry Karpeev 
901670417b2SFande Kong 
902b541e6a4SDmitry Karpeev static PetscErrorCode  PCGASMSetSubdomains_GASM(PC pc,PetscInt n,IS iis[],IS ois[])
903b1a0a8a3SJed Brown {
904f746d493SDmitry Karpeev   PC_GASM         *osm = (PC_GASM*)pc->data;
905b1a0a8a3SJed Brown   PetscErrorCode  ierr;
906b1a0a8a3SJed Brown   PetscInt        i;
907b1a0a8a3SJed Brown 
908b1a0a8a3SJed Brown   PetscFunctionBegin;
9098f3b4b4dSDmitry Karpeev   if (n < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Each process must have 1 or more subdomains, got n = %D",n);
9108f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetSubdomains() should be called before calling PCSetUp().");
911b1a0a8a3SJed Brown 
9122c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9138f3b4b4dSDmitry Karpeev   osm->iis  = osm->ois = NULL;
9148f3b4b4dSDmitry Karpeev   osm->n    = n;
9158f3b4b4dSDmitry Karpeev   osm->N    = PETSC_DETERMINE;
9168f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
917a35b7b57SDmitry Karpeev   if (ois) {
918785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->ois);CHKERRQ(ierr);
9198f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9208f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)ois[i]);CHKERRQ(ierr);
9218f3b4b4dSDmitry Karpeev       osm->ois[i] = ois[i];
9228f3b4b4dSDmitry Karpeev     }
9238f3b4b4dSDmitry Karpeev     /*
9248f3b4b4dSDmitry Karpeev        Since the user set the outer subdomains, even if nontrivial overlap was requested via PCGASMSetOverlap(),
9258f3b4b4dSDmitry Karpeev        it will be ignored.  To avoid confusion later on (e.g., when viewing the PC), the overlap size is set to -1.
9268f3b4b4dSDmitry Karpeev     */
927b1a0a8a3SJed Brown     osm->overlap = -1;
928670417b2SFande Kong     /* inner subdomains must be provided  */
929670417b2SFande Kong     if (!iis) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"inner indices have to be provided \n");
930670417b2SFande Kong   }/* end if */
931a35b7b57SDmitry Karpeev   if (iis) {
932785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->iis);CHKERRQ(ierr);
9338f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9348f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)iis[i]);CHKERRQ(ierr);
9358f3b4b4dSDmitry Karpeev       osm->iis[i] = iis[i];
9368f3b4b4dSDmitry Karpeev     }
937a35b7b57SDmitry Karpeev     if (!ois) {
938*390e1bf2SBarry Smith       osm->ois = NULL;
939670417b2SFande Kong       /* if user does not provide outer indices, we will create the corresponding outer indices using  osm->overlap =1 in PCSetUp_GASM */
940670417b2SFande Kong     }
941670417b2SFande Kong   }
942670417b2SFande Kong #if defined(PETSC_USE_DEBUG)
943670417b2SFande Kong   {
944670417b2SFande Kong     PetscInt        j,rstart,rend,*covered,lsize;
945670417b2SFande Kong     const PetscInt  *indices;
946670417b2SFande Kong     /* check if the inner indices cover and only cover the local portion of the preconditioning matrix */
947670417b2SFande Kong     ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
948670417b2SFande Kong     ierr = PetscCalloc1(rend-rstart,&covered);CHKERRQ(ierr);
949670417b2SFande Kong     /* check if the current processor owns indices from others */
950a35b7b57SDmitry Karpeev     for (i=0; i<n; i++) {
951670417b2SFande Kong       ierr = ISGetIndices(osm->iis[i],&indices);CHKERRQ(ierr);
952670417b2SFande Kong       ierr = ISGetLocalSize(osm->iis[i],&lsize);CHKERRQ(ierr);
953670417b2SFande Kong       for (j=0; j<lsize; j++) {
954670417b2SFande Kong         if (indices[j]<rstart || indices[j]>=rend) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"inner subdomains can not own an index %d from other processors", indices[j]);
955670417b2SFande Kong         else if (covered[indices[j]-rstart]==1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"inner subdomains can not have an overlapping index %d ",indices[j]);
956670417b2SFande Kong         else covered[indices[j]-rstart] = 1;
957a35b7b57SDmitry Karpeev       }
958670417b2SFande Kong     ierr = ISRestoreIndices(osm->iis[i],&indices);CHKERRQ(ierr);
9598f3b4b4dSDmitry Karpeev     }
960670417b2SFande Kong     /* check if we miss any indices */
961670417b2SFande Kong     for (i=rstart; i<rend; i++) {
962670417b2SFande Kong       if (!covered[i-rstart]) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"local entity %d was not covered by inner subdomains",i);
963a35b7b57SDmitry Karpeev     }
964670417b2SFande Kong     ierr = PetscFree(covered);CHKERRQ(ierr);
965a35b7b57SDmitry Karpeev   }
966670417b2SFande Kong #endif
9678f3b4b4dSDmitry Karpeev   if (iis)  osm->user_subdomains = PETSC_TRUE;
968b1a0a8a3SJed Brown   PetscFunctionReturn(0);
969b1a0a8a3SJed Brown }
970b1a0a8a3SJed Brown 
971b1a0a8a3SJed Brown 
972f7a08781SBarry Smith static PetscErrorCode  PCGASMSetOverlap_GASM(PC pc,PetscInt ovl)
973b1a0a8a3SJed Brown {
974f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
975b1a0a8a3SJed Brown 
976b1a0a8a3SJed Brown   PetscFunctionBegin;
977ce94432eSBarry Smith   if (ovl < 0) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Negative overlap value requested");
978ce94432eSBarry Smith   if (pc->setupcalled && ovl != osm->overlap) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetOverlap() should be called before PCSetUp().");
9792fa5cd67SKarl Rupp   if (!pc->setupcalled) osm->overlap = ovl;
980b1a0a8a3SJed Brown   PetscFunctionReturn(0);
981b1a0a8a3SJed Brown }
982b1a0a8a3SJed Brown 
983f7a08781SBarry Smith static PetscErrorCode  PCGASMSetType_GASM(PC pc,PCGASMType type)
984b1a0a8a3SJed Brown {
985f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
986b1a0a8a3SJed Brown 
987b1a0a8a3SJed Brown   PetscFunctionBegin;
988b1a0a8a3SJed Brown   osm->type     = type;
989b1a0a8a3SJed Brown   osm->type_set = PETSC_TRUE;
990b1a0a8a3SJed Brown   PetscFunctionReturn(0);
991b1a0a8a3SJed Brown }
992b1a0a8a3SJed Brown 
993f7a08781SBarry Smith static PetscErrorCode  PCGASMSetSortIndices_GASM(PC pc,PetscBool doSort)
994b1a0a8a3SJed Brown {
995f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
996b1a0a8a3SJed Brown 
997b1a0a8a3SJed Brown   PetscFunctionBegin;
998b1a0a8a3SJed Brown   osm->sort_indices = doSort;
999b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1000b1a0a8a3SJed Brown }
1001b1a0a8a3SJed Brown 
100244fe18e5SDmitry Karpeev /*
10038f3b4b4dSDmitry Karpeev    FIXME: This routine might need to be modified now that multiple ranks per subdomain are allowed.
100444fe18e5SDmitry Karpeev         In particular, it would upset the global subdomain number calculation.
100544fe18e5SDmitry Karpeev */
1006f7a08781SBarry Smith static PetscErrorCode  PCGASMGetSubKSP_GASM(PC pc,PetscInt *n,PetscInt *first,KSP **ksp)
1007b1a0a8a3SJed Brown {
1008f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1009b1a0a8a3SJed Brown   PetscErrorCode ierr;
1010b1a0a8a3SJed Brown 
1011b1a0a8a3SJed Brown   PetscFunctionBegin;
1012ce94432eSBarry Smith   if (osm->n < 1) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ORDER,"Need to call PCSetUP() on PC (or KSPSetUp() on the outer KSP object) before calling here");
1013b1a0a8a3SJed Brown 
10142fa5cd67SKarl Rupp   if (n) *n = osm->n;
1015ab3e923fSDmitry Karpeev   if (first) {
1016ce94432eSBarry Smith     ierr    = MPI_Scan(&osm->n,first,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1017ab3e923fSDmitry Karpeev     *first -= osm->n;
1018b1a0a8a3SJed Brown   }
1019b1a0a8a3SJed Brown   if (ksp) {
1020b1a0a8a3SJed Brown     /* Assume that local solves are now different; not necessarily
102106b43e7eSDmitry Karpeev        true, though!  This flag is used only for PCView_GASM() */
1022b1a0a8a3SJed Brown     *ksp                        = osm->ksp;
10236a4f0f73SDmitry Karpeev     osm->same_subdomain_solvers = PETSC_FALSE;
1024b1a0a8a3SJed Brown   }
1025b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1026ab3e923fSDmitry Karpeev } /* PCGASMGetSubKSP_GASM() */
1027b1a0a8a3SJed Brown 
1028b1a0a8a3SJed Brown /*@C
102906b43e7eSDmitry Karpeev     PCGASMSetSubdomains - Sets the subdomains for this processor
103006b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1031b1a0a8a3SJed Brown 
10328f3b4b4dSDmitry Karpeev     Collective on pc
1033b1a0a8a3SJed Brown 
1034b1a0a8a3SJed Brown     Input Parameters:
10358f3b4b4dSDmitry Karpeev +   pc  - the preconditioner object
103606b43e7eSDmitry Karpeev .   n   - the number of subdomains for this processor
10378f3b4b4dSDmitry Karpeev .   iis - the index sets that define the inner subdomains (or NULL for PETSc to determine subdomains)
10388f3b4b4dSDmitry Karpeev -   ois - the index sets that define the outer subdomains (or NULL to use the same as iis, or to construct by expanding iis by the requested overlap)
1039b1a0a8a3SJed Brown 
1040b1a0a8a3SJed Brown     Notes:
104106b43e7eSDmitry Karpeev     The IS indices use the parallel, global numbering of the vector entries.
10426a4f0f73SDmitry Karpeev     Inner subdomains are those where the correction is applied.
10436a4f0f73SDmitry Karpeev     Outer subdomains are those where the residual necessary to obtain the
10446a4f0f73SDmitry Karpeev     corrections is obtained (see PCGASMType for the use of inner/outer subdomains).
10456a4f0f73SDmitry Karpeev     Both inner and outer subdomains can extend over several processors.
10466a4f0f73SDmitry Karpeev     This processor's portion of a subdomain is known as a local subdomain.
10476a4f0f73SDmitry Karpeev 
1048670417b2SFande Kong     Inner subdomains can not overlap with each other, do not have any entities from remote processors,
1049670417b2SFande Kong     and  have to cover the entire local subdomain owned by the current processor. The index sets on each
1050670417b2SFande Kong     process should be ordered such that the ith local subdomain is connected to the ith remote subdomain
1051670417b2SFande Kong     on another MPI process.
1052670417b2SFande Kong 
10536a4f0f73SDmitry Karpeev     By default the GASM preconditioner uses 1 (local) subdomain per processor.
10546a4f0f73SDmitry Karpeev 
1055b1a0a8a3SJed Brown 
1056b1a0a8a3SJed Brown     Level: advanced
1057b1a0a8a3SJed Brown 
105806b43e7eSDmitry Karpeev .keywords: PC, GASM, set, subdomains, additive Schwarz
1059b1a0a8a3SJed Brown 
10608f3b4b4dSDmitry Karpeev .seealso: PCGASMSetNumSubdomains(), PCGASMSetOverlap(), PCGASMGetSubKSP(),
106106b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1062b1a0a8a3SJed Brown @*/
10636a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMSetSubdomains(PC pc,PetscInt n,IS iis[],IS ois[])
1064b1a0a8a3SJed Brown {
10658f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1066b1a0a8a3SJed Brown   PetscErrorCode ierr;
1067b1a0a8a3SJed Brown 
1068b1a0a8a3SJed Brown   PetscFunctionBegin;
1069b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
10706a4f0f73SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSubdomains_C",(PC,PetscInt,IS[],IS[]),(pc,n,iis,ois));CHKERRQ(ierr);
10718f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1072b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1073b1a0a8a3SJed Brown }
1074b1a0a8a3SJed Brown 
1075b1a0a8a3SJed Brown 
1076b1a0a8a3SJed Brown /*@
1077f746d493SDmitry Karpeev     PCGASMSetOverlap - Sets the overlap between a pair of subdomains for the
1078b1a0a8a3SJed Brown     additive Schwarz preconditioner.  Either all or no processors in the
10798f3b4b4dSDmitry Karpeev     pc communicator must call this routine.
1080b1a0a8a3SJed Brown 
10818f3b4b4dSDmitry Karpeev     Logically Collective on pc
1082b1a0a8a3SJed Brown 
1083b1a0a8a3SJed Brown     Input Parameters:
1084b1a0a8a3SJed Brown +   pc  - the preconditioner context
10858f3b4b4dSDmitry Karpeev -   ovl - the amount of overlap between subdomains (ovl >= 0, default value = 0)
1086b1a0a8a3SJed Brown 
1087b1a0a8a3SJed Brown     Options Database Key:
108806b43e7eSDmitry Karpeev .   -pc_gasm_overlap <overlap> - Sets overlap
1089b1a0a8a3SJed Brown 
1090b1a0a8a3SJed Brown     Notes:
109106b43e7eSDmitry Karpeev     By default the GASM preconditioner uses 1 subdomain per processor.  To use
10928f3b4b4dSDmitry Karpeev     multiple subdomain per perocessor or "straddling" subdomains that intersect
10938f3b4b4dSDmitry Karpeev     multiple processors use PCGASMSetSubdomains() (or option -pc_gasm_total_subdomains <n>).
1094b1a0a8a3SJed Brown 
10958f3b4b4dSDmitry Karpeev     The overlap defaults to 0, so if one desires that no additional
1096b1a0a8a3SJed Brown     overlap be computed beyond what may have been set with a call to
10978f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), then ovl must be set to be 0.  In particular, if one does
10988f3b4b4dSDmitry Karpeev     not explicitly set the subdomains in application code, then all overlap would be computed
1099f746d493SDmitry Karpeev     internally by PETSc, and using an overlap of 0 would result in an GASM
1100b1a0a8a3SJed Brown     variant that is equivalent to the block Jacobi preconditioner.
1101b1a0a8a3SJed Brown 
1102b1a0a8a3SJed Brown     Note that one can define initial index sets with any overlap via
110306b43e7eSDmitry Karpeev     PCGASMSetSubdomains(); the routine PCGASMSetOverlap() merely allows
110406b43e7eSDmitry Karpeev     PETSc to extend that overlap further, if desired.
1105b1a0a8a3SJed Brown 
1106b1a0a8a3SJed Brown     Level: intermediate
1107b1a0a8a3SJed Brown 
1108f746d493SDmitry Karpeev .keywords: PC, GASM, set, overlap
1109b1a0a8a3SJed Brown 
11108f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
111106b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1112b1a0a8a3SJed Brown @*/
11137087cfbeSBarry Smith PetscErrorCode  PCGASMSetOverlap(PC pc,PetscInt ovl)
1114b1a0a8a3SJed Brown {
1115b1a0a8a3SJed Brown   PetscErrorCode ierr;
11168f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1117b1a0a8a3SJed Brown 
1118b1a0a8a3SJed Brown   PetscFunctionBegin;
1119b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1120b1a0a8a3SJed Brown   PetscValidLogicalCollectiveInt(pc,ovl,2);
1121f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetOverlap_C",(PC,PetscInt),(pc,ovl));CHKERRQ(ierr);
11228f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1123b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1124b1a0a8a3SJed Brown }
1125b1a0a8a3SJed Brown 
1126b1a0a8a3SJed Brown /*@
1127f746d493SDmitry Karpeev     PCGASMSetType - Sets the type of restriction and interpolation used
1128b1a0a8a3SJed Brown     for local problems in the additive Schwarz method.
1129b1a0a8a3SJed Brown 
1130b1a0a8a3SJed Brown     Logically Collective on PC
1131b1a0a8a3SJed Brown 
1132b1a0a8a3SJed Brown     Input Parameters:
1133b1a0a8a3SJed Brown +   pc  - the preconditioner context
1134f746d493SDmitry Karpeev -   type - variant of GASM, one of
1135b1a0a8a3SJed Brown .vb
1136f746d493SDmitry Karpeev       PC_GASM_BASIC       - full interpolation and restriction
1137f746d493SDmitry Karpeev       PC_GASM_RESTRICT    - full restriction, local processor interpolation
1138f746d493SDmitry Karpeev       PC_GASM_INTERPOLATE - full interpolation, local processor restriction
1139f746d493SDmitry Karpeev       PC_GASM_NONE        - local processor restriction and interpolation
1140b1a0a8a3SJed Brown .ve
1141b1a0a8a3SJed Brown 
1142b1a0a8a3SJed Brown     Options Database Key:
1143f746d493SDmitry Karpeev .   -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1144b1a0a8a3SJed Brown 
1145b1a0a8a3SJed Brown     Level: intermediate
1146b1a0a8a3SJed Brown 
1147f746d493SDmitry Karpeev .keywords: PC, GASM, set, type
1148b1a0a8a3SJed Brown 
11498f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1150f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1151b1a0a8a3SJed Brown @*/
11527087cfbeSBarry Smith PetscErrorCode  PCGASMSetType(PC pc,PCGASMType type)
1153b1a0a8a3SJed Brown {
1154b1a0a8a3SJed Brown   PetscErrorCode ierr;
1155b1a0a8a3SJed Brown 
1156b1a0a8a3SJed Brown   PetscFunctionBegin;
1157b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1158b1a0a8a3SJed Brown   PetscValidLogicalCollectiveEnum(pc,type,2);
1159f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetType_C",(PC,PCGASMType),(pc,type));CHKERRQ(ierr);
1160b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1161b1a0a8a3SJed Brown }
1162b1a0a8a3SJed Brown 
1163b1a0a8a3SJed Brown /*@
1164f746d493SDmitry Karpeev     PCGASMSetSortIndices - Determines whether subdomain indices are sorted.
1165b1a0a8a3SJed Brown 
1166b1a0a8a3SJed Brown     Logically Collective on PC
1167b1a0a8a3SJed Brown 
1168b1a0a8a3SJed Brown     Input Parameters:
1169b1a0a8a3SJed Brown +   pc  - the preconditioner context
1170b1a0a8a3SJed Brown -   doSort - sort the subdomain indices
1171b1a0a8a3SJed Brown 
1172b1a0a8a3SJed Brown     Level: intermediate
1173b1a0a8a3SJed Brown 
1174f746d493SDmitry Karpeev .keywords: PC, GASM, set, type
1175b1a0a8a3SJed Brown 
11768f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1177f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1178b1a0a8a3SJed Brown @*/
11797087cfbeSBarry Smith PetscErrorCode  PCGASMSetSortIndices(PC pc,PetscBool doSort)
1180b1a0a8a3SJed Brown {
1181b1a0a8a3SJed Brown   PetscErrorCode ierr;
1182b1a0a8a3SJed Brown 
1183b1a0a8a3SJed Brown   PetscFunctionBegin;
1184b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1185b1a0a8a3SJed Brown   PetscValidLogicalCollectiveBool(pc,doSort,2);
1186f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSortIndices_C",(PC,PetscBool),(pc,doSort));CHKERRQ(ierr);
1187b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1188b1a0a8a3SJed Brown }
1189b1a0a8a3SJed Brown 
1190b1a0a8a3SJed Brown /*@C
1191f746d493SDmitry Karpeev    PCGASMGetSubKSP - Gets the local KSP contexts for all blocks on
1192b1a0a8a3SJed Brown    this processor.
1193b1a0a8a3SJed Brown 
1194b1a0a8a3SJed Brown    Collective on PC iff first_local is requested
1195b1a0a8a3SJed Brown 
1196b1a0a8a3SJed Brown    Input Parameter:
1197b1a0a8a3SJed Brown .  pc - the preconditioner context
1198b1a0a8a3SJed Brown 
1199b1a0a8a3SJed Brown    Output Parameters:
12000298fd71SBarry Smith +  n_local - the number of blocks on this processor or NULL
12010298fd71SBarry Smith .  first_local - the global number of the first block on this processor or NULL,
12020298fd71SBarry Smith                  all processors must request or all must pass NULL
1203b1a0a8a3SJed Brown -  ksp - the array of KSP contexts
1204b1a0a8a3SJed Brown 
1205b1a0a8a3SJed Brown    Note:
1206f746d493SDmitry Karpeev    After PCGASMGetSubKSP() the array of KSPes is not to be freed
1207b1a0a8a3SJed Brown 
1208b1a0a8a3SJed Brown    Currently for some matrix implementations only 1 block per processor
1209b1a0a8a3SJed Brown    is supported.
1210b1a0a8a3SJed Brown 
1211f746d493SDmitry Karpeev    You must call KSPSetUp() before calling PCGASMGetSubKSP().
1212b1a0a8a3SJed Brown 
1213b1a0a8a3SJed Brown    Level: advanced
1214b1a0a8a3SJed Brown 
1215f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, get, sub, KSP, context
1216b1a0a8a3SJed Brown 
12178f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap(),
1218f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D(),
1219b1a0a8a3SJed Brown @*/
12207087cfbeSBarry Smith PetscErrorCode  PCGASMGetSubKSP(PC pc,PetscInt *n_local,PetscInt *first_local,KSP *ksp[])
1221b1a0a8a3SJed Brown {
1222b1a0a8a3SJed Brown   PetscErrorCode ierr;
1223b1a0a8a3SJed Brown 
1224b1a0a8a3SJed Brown   PetscFunctionBegin;
1225b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1226f746d493SDmitry Karpeev   ierr = PetscUseMethod(pc,"PCGASMGetSubKSP_C",(PC,PetscInt*,PetscInt*,KSP **),(pc,n_local,first_local,ksp));CHKERRQ(ierr);
1227b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1228b1a0a8a3SJed Brown }
1229b1a0a8a3SJed Brown 
1230b1a0a8a3SJed Brown /* -------------------------------------------------------------------------------------*/
1231b1a0a8a3SJed Brown /*MC
1232f746d493SDmitry Karpeev    PCGASM - Use the (restricted) additive Schwarz method, each block is (approximately) solved with
1233b1a0a8a3SJed Brown            its own KSP object.
1234b1a0a8a3SJed Brown 
1235b1a0a8a3SJed Brown    Options Database Keys:
12368f3b4b4dSDmitry Karpeev +  -pc_gasm_total_subdomains <n>  - Sets total number of local subdomains to be distributed among processors
123706b43e7eSDmitry Karpeev .  -pc_gasm_view_subdomains       - activates the printing of subdomain indices in PCView(), -ksp_view or -snes_view
123806b43e7eSDmitry Karpeev .  -pc_gasm_print_subdomains      - activates the printing of subdomain indices in PCSetUp()
123906b43e7eSDmitry Karpeev .  -pc_gasm_overlap <ovl>         - Sets overlap by which to (automatically) extend local subdomains
1240f746d493SDmitry Karpeev -  -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1241b1a0a8a3SJed Brown 
1242b1a0a8a3SJed Brown      IMPORTANT: If you run with, for example, 3 blocks on 1 processor or 3 blocks on 3 processors you
1243f746d493SDmitry Karpeev       will get a different convergence rate due to the default option of -pc_gasm_type restrict. Use
1244f746d493SDmitry Karpeev       -pc_gasm_type basic to use the standard GASM.
1245b1a0a8a3SJed Brown 
1246b1a0a8a3SJed Brown    Notes: Each processor can have one or more blocks, but a block cannot be shared by more
1247b1a0a8a3SJed Brown      than one processor. Defaults to one block per processor.
1248b1a0a8a3SJed Brown 
1249b1a0a8a3SJed Brown      To set options on the solvers for each block append -sub_ to all the KSP, and PC
1250b1a0a8a3SJed Brown         options database keys. For example, -sub_pc_type ilu -sub_pc_factor_levels 1 -sub_ksp_type preonly
1251b1a0a8a3SJed Brown 
1252f746d493SDmitry Karpeev      To set the options on the solvers separate for each block call PCGASMGetSubKSP()
1253b1a0a8a3SJed Brown          and set the options directly on the resulting KSP object (you can access its PC
1254b1a0a8a3SJed Brown          with KSPGetPC())
1255b1a0a8a3SJed Brown 
1256b1a0a8a3SJed Brown 
1257b1a0a8a3SJed Brown    Level: beginner
1258b1a0a8a3SJed Brown 
1259b1a0a8a3SJed Brown    Concepts: additive Schwarz method
1260b1a0a8a3SJed Brown 
1261b1a0a8a3SJed Brown     References:
126296a0c994SBarry Smith +   1. - M Dryja, OB Widlund, An additive variant of the Schwarz alternating method for the case of many subregions
126396a0c994SBarry Smith      Courant Institute, New York University Technical report
126496a0c994SBarry Smith -   2. - Barry Smith, Petter Bjorstad, and William Gropp, Domain Decompositions: Parallel Multilevel Methods for Elliptic Partial Differential Equations,
126596a0c994SBarry Smith     Cambridge University Press.
1266b1a0a8a3SJed Brown 
1267b1a0a8a3SJed Brown .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
126849517cdeSBarry Smith            PCBJACOBI,  PCGASMGetSubKSP(), PCGASMSetSubdomains(),
12698f3b4b4dSDmitry Karpeev            PCSetModifySubmatrices(), PCGASMSetOverlap(), PCGASMSetType()
1270b1a0a8a3SJed Brown 
1271b1a0a8a3SJed Brown M*/
1272b1a0a8a3SJed Brown 
12738cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GASM(PC pc)
1274b1a0a8a3SJed Brown {
1275b1a0a8a3SJed Brown   PetscErrorCode ierr;
1276f746d493SDmitry Karpeev   PC_GASM        *osm;
1277b1a0a8a3SJed Brown 
1278b1a0a8a3SJed Brown   PetscFunctionBegin;
1279b00a9115SJed Brown   ierr = PetscNewLog(pc,&osm);CHKERRQ(ierr);
12802fa5cd67SKarl Rupp 
12818f3b4b4dSDmitry Karpeev   osm->N                        = PETSC_DETERMINE;
128206b43e7eSDmitry Karpeev   osm->n                        = PETSC_DECIDE;
12838f3b4b4dSDmitry Karpeev   osm->nmax                     = PETSC_DETERMINE;
12848f3b4b4dSDmitry Karpeev   osm->overlap                  = 0;
1285b1a0a8a3SJed Brown   osm->ksp                      = 0;
12866a4f0f73SDmitry Karpeev   osm->gorestriction            = 0;
12876a4f0f73SDmitry Karpeev   osm->girestriction            = 0;
1288ea91fabdSFande Kong   osm->pctoouter                = 0;
1289ab3e923fSDmitry Karpeev   osm->gx                       = 0;
1290ab3e923fSDmitry Karpeev   osm->gy                       = 0;
1291b1a0a8a3SJed Brown   osm->x                        = 0;
1292b1a0a8a3SJed Brown   osm->y                        = 0;
1293ea91fabdSFande Kong   osm->pcx                      = 0;
1294ea91fabdSFande Kong   osm->pcy                      = 0;
1295ea91fabdSFande Kong   osm->permutationIS            = 0;
1296ea91fabdSFande Kong   osm->permutationP             = 0;
1297ea91fabdSFande Kong   osm->pcmat                    = 0;
12986a4f0f73SDmitry Karpeev   osm->ois                      = 0;
12996a4f0f73SDmitry Karpeev   osm->iis                      = 0;
1300b1a0a8a3SJed Brown   osm->pmat                     = 0;
1301f746d493SDmitry Karpeev   osm->type                     = PC_GASM_RESTRICT;
13026a4f0f73SDmitry Karpeev   osm->same_subdomain_solvers   = PETSC_TRUE;
1303b1a0a8a3SJed Brown   osm->sort_indices             = PETSC_TRUE;
1304d709ea83SDmitry Karpeev   osm->dm_subdomains            = PETSC_FALSE;
1305ea91fabdSFande Kong   osm->hierarchicalpartitioning = PETSC_FALSE;
1306b1a0a8a3SJed Brown 
1307b1a0a8a3SJed Brown   pc->data                 = (void*)osm;
1308f746d493SDmitry Karpeev   pc->ops->apply           = PCApply_GASM;
1309f746d493SDmitry Karpeev   pc->ops->applytranspose  = PCApplyTranspose_GASM;
1310f746d493SDmitry Karpeev   pc->ops->setup           = PCSetUp_GASM;
1311a06653b4SBarry Smith   pc->ops->reset           = PCReset_GASM;
1312f746d493SDmitry Karpeev   pc->ops->destroy         = PCDestroy_GASM;
1313f746d493SDmitry Karpeev   pc->ops->setfromoptions  = PCSetFromOptions_GASM;
1314f746d493SDmitry Karpeev   pc->ops->setuponblocks   = PCSetUpOnBlocks_GASM;
1315f746d493SDmitry Karpeev   pc->ops->view            = PCView_GASM;
1316b1a0a8a3SJed Brown   pc->ops->applyrichardson = 0;
1317b1a0a8a3SJed Brown 
1318bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSubdomains_C",PCGASMSetSubdomains_GASM);CHKERRQ(ierr);
1319bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetOverlap_C",PCGASMSetOverlap_GASM);CHKERRQ(ierr);
1320bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetType_C",PCGASMSetType_GASM);CHKERRQ(ierr);
1321bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSortIndices_C",PCGASMSetSortIndices_GASM);CHKERRQ(ierr);
1322bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMGetSubKSP_C",PCGASMGetSubKSP_GASM);CHKERRQ(ierr);
1323b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1324b1a0a8a3SJed Brown }
1325b1a0a8a3SJed Brown 
1326b1a0a8a3SJed Brown 
13278f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[])
1328b1a0a8a3SJed Brown {
1329b1a0a8a3SJed Brown   MatPartitioning mpart;
1330b1a0a8a3SJed Brown   const char      *prefix;
1331c56a70eeSBarry Smith   void            (*f)(void);
1332b1a0a8a3SJed Brown   PetscInt        i,j,rstart,rend,bs;
133311bd1e4dSLisandro Dalcin   PetscBool       isbaij = PETSC_FALSE,foundpart = PETSC_FALSE;
13340298fd71SBarry Smith   Mat             Ad     = NULL, adj;
1335b1a0a8a3SJed Brown   IS              ispart,isnumb,*is;
1336b1a0a8a3SJed Brown   PetscErrorCode  ierr;
1337b1a0a8a3SJed Brown 
1338b1a0a8a3SJed Brown   PetscFunctionBegin;
13398f3b4b4dSDmitry Karpeev   if (nloc < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"number of local subdomains must > 0, got nloc = %D",nloc);
1340b1a0a8a3SJed Brown 
1341b1a0a8a3SJed Brown   /* Get prefix, row distribution, and block size */
1342b1a0a8a3SJed Brown   ierr = MatGetOptionsPrefix(A,&prefix);CHKERRQ(ierr);
1343b1a0a8a3SJed Brown   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
1344b1a0a8a3SJed Brown   ierr = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
1345b1a0a8a3SJed Brown   if (rstart/bs*bs != rstart || rend/bs*bs != rend) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"bad row distribution [%D,%D) for matrix block size %D",rstart,rend,bs);
1346b1a0a8a3SJed Brown 
1347b1a0a8a3SJed Brown   /* Get diagonal block from matrix if possible */
1348c56a70eeSBarry Smith   ierr = MatShellGetOperation(A,MATOP_GET_DIAGONAL_BLOCK,&f);CHKERRQ(ierr);
1349b1a0a8a3SJed Brown   if (f) {
135011bd1e4dSLisandro Dalcin     ierr = MatGetDiagonalBlock(A,&Ad);CHKERRQ(ierr);
1351b1a0a8a3SJed Brown   }
1352b1a0a8a3SJed Brown   if (Ad) {
1353251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)Ad,MATSEQBAIJ,&isbaij);CHKERRQ(ierr);
1354251f4c67SDmitry Karpeev     if (!isbaij) {ierr = PetscObjectTypeCompare((PetscObject)Ad,MATSEQSBAIJ,&isbaij);CHKERRQ(ierr);}
1355b1a0a8a3SJed Brown   }
13568f3b4b4dSDmitry Karpeev   if (Ad && nloc > 1) {
1357b1a0a8a3SJed Brown     PetscBool  match,done;
1358b1a0a8a3SJed Brown     /* Try to setup a good matrix partitioning if available */
1359b1a0a8a3SJed Brown     ierr = MatPartitioningCreate(PETSC_COMM_SELF,&mpart);CHKERRQ(ierr);
1360b1a0a8a3SJed Brown     ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
1361b1a0a8a3SJed Brown     ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
1362251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGCURRENT,&match);CHKERRQ(ierr);
1363b1a0a8a3SJed Brown     if (!match) {
1364251f4c67SDmitry Karpeev       ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGSQUARE,&match);CHKERRQ(ierr);
1365b1a0a8a3SJed Brown     }
1366b1a0a8a3SJed Brown     if (!match) { /* assume a "good" partitioner is available */
13671a83f524SJed Brown       PetscInt       na;
13681a83f524SJed Brown       const PetscInt *ia,*ja;
1369b1a0a8a3SJed Brown       ierr = MatGetRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1370b1a0a8a3SJed Brown       if (done) {
1371b1a0a8a3SJed Brown         /* Build adjacency matrix by hand. Unfortunately a call to
1372b1a0a8a3SJed Brown            MatConvert(Ad,MATMPIADJ,MAT_INITIAL_MATRIX,&adj) will
1373b1a0a8a3SJed Brown            remove the block-aij structure and we cannot expect
1374b1a0a8a3SJed Brown            MatPartitioning to split vertices as we need */
13751a83f524SJed Brown         PetscInt       i,j,len,nnz,cnt,*iia=0,*jja=0;
13761a83f524SJed Brown         const PetscInt *row;
1377b1a0a8a3SJed Brown         nnz = 0;
1378b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* count number of nonzeros */
1379b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1380b1a0a8a3SJed Brown           row = ja + ia[i];
1381b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
1382b1a0a8a3SJed Brown             if (row[j] == i) { /* don't count diagonal */
1383b1a0a8a3SJed Brown               len--; break;
1384b1a0a8a3SJed Brown             }
1385b1a0a8a3SJed Brown           }
1386b1a0a8a3SJed Brown           nnz += len;
1387b1a0a8a3SJed Brown         }
1388854ce69bSBarry Smith         ierr   = PetscMalloc1(na+1,&iia);CHKERRQ(ierr);
1389854ce69bSBarry Smith         ierr   = PetscMalloc1(nnz,&jja);CHKERRQ(ierr);
1390b1a0a8a3SJed Brown         nnz    = 0;
1391b1a0a8a3SJed Brown         iia[0] = 0;
1392b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* fill adjacency */
1393b1a0a8a3SJed Brown           cnt = 0;
1394b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1395b1a0a8a3SJed Brown           row = ja + ia[i];
1396b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
13972fa5cd67SKarl Rupp             if (row[j] != i) jja[nnz+cnt++] = row[j]; /* if not diagonal */
1398b1a0a8a3SJed Brown           }
1399b1a0a8a3SJed Brown           nnz += cnt;
1400b1a0a8a3SJed Brown           iia[i+1] = nnz;
1401b1a0a8a3SJed Brown         }
1402b1a0a8a3SJed Brown         /* Partitioning of the adjacency matrix */
14030298fd71SBarry Smith         ierr      = MatCreateMPIAdj(PETSC_COMM_SELF,na,na,iia,jja,NULL,&adj);CHKERRQ(ierr);
1404b1a0a8a3SJed Brown         ierr      = MatPartitioningSetAdjacency(mpart,adj);CHKERRQ(ierr);
14058f3b4b4dSDmitry Karpeev         ierr      = MatPartitioningSetNParts(mpart,nloc);CHKERRQ(ierr);
1406b1a0a8a3SJed Brown         ierr      = MatPartitioningApply(mpart,&ispart);CHKERRQ(ierr);
1407b1a0a8a3SJed Brown         ierr      = ISPartitioningToNumbering(ispart,&isnumb);CHKERRQ(ierr);
14086bf464f9SBarry Smith         ierr      = MatDestroy(&adj);CHKERRQ(ierr);
1409b1a0a8a3SJed Brown         foundpart = PETSC_TRUE;
1410b1a0a8a3SJed Brown       }
1411b1a0a8a3SJed Brown       ierr = MatRestoreRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1412b1a0a8a3SJed Brown     }
14136bf464f9SBarry Smith     ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
1414b1a0a8a3SJed Brown   }
14158f3b4b4dSDmitry Karpeev   ierr = PetscMalloc1(nloc,&is);CHKERRQ(ierr);
1416b1a0a8a3SJed Brown   if (!foundpart) {
1417b1a0a8a3SJed Brown 
1418b1a0a8a3SJed Brown     /* Partitioning by contiguous chunks of rows */
1419b1a0a8a3SJed Brown 
1420b1a0a8a3SJed Brown     PetscInt mbs   = (rend-rstart)/bs;
1421b1a0a8a3SJed Brown     PetscInt start = rstart;
14228f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
14238f3b4b4dSDmitry Karpeev       PetscInt count = (mbs/nloc + ((mbs % nloc) > i)) * bs;
1424b1a0a8a3SJed Brown       ierr   = ISCreateStride(PETSC_COMM_SELF,count,start,1,&is[i]);CHKERRQ(ierr);
1425b1a0a8a3SJed Brown       start += count;
1426b1a0a8a3SJed Brown     }
1427b1a0a8a3SJed Brown 
1428b1a0a8a3SJed Brown   } else {
1429b1a0a8a3SJed Brown 
1430b1a0a8a3SJed Brown     /* Partitioning by adjacency of diagonal block  */
1431b1a0a8a3SJed Brown 
1432b1a0a8a3SJed Brown     const PetscInt *numbering;
1433b1a0a8a3SJed Brown     PetscInt       *count,nidx,*indices,*newidx,start=0;
1434b1a0a8a3SJed Brown     /* Get node count in each partition */
14358f3b4b4dSDmitry Karpeev     ierr = PetscMalloc1(nloc,&count);CHKERRQ(ierr);
14368f3b4b4dSDmitry Karpeev     ierr = ISPartitioningCount(ispart,nloc,count);CHKERRQ(ierr);
1437b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
14388f3b4b4dSDmitry Karpeev       for (i=0; i<nloc; i++) count[i] *= bs;
1439b1a0a8a3SJed Brown     }
1440b1a0a8a3SJed Brown     /* Build indices from node numbering */
1441b1a0a8a3SJed Brown     ierr = ISGetLocalSize(isnumb,&nidx);CHKERRQ(ierr);
1442785e854fSJed Brown     ierr = PetscMalloc1(nidx,&indices);CHKERRQ(ierr);
1443b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] = i; /* needs to be initialized */
1444b1a0a8a3SJed Brown     ierr = ISGetIndices(isnumb,&numbering);CHKERRQ(ierr);
1445b1a0a8a3SJed Brown     ierr = PetscSortIntWithPermutation(nidx,numbering,indices);CHKERRQ(ierr);
1446b1a0a8a3SJed Brown     ierr = ISRestoreIndices(isnumb,&numbering);CHKERRQ(ierr);
1447b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
1448785e854fSJed Brown       ierr = PetscMalloc1(nidx*bs,&newidx);CHKERRQ(ierr);
14492fa5cd67SKarl Rupp       for (i=0; i<nidx; i++) {
14502fa5cd67SKarl Rupp         for (j=0; j<bs; j++) newidx[i*bs+j] = indices[i]*bs + j;
14512fa5cd67SKarl Rupp       }
1452b1a0a8a3SJed Brown       ierr    = PetscFree(indices);CHKERRQ(ierr);
1453b1a0a8a3SJed Brown       nidx   *= bs;
1454b1a0a8a3SJed Brown       indices = newidx;
1455b1a0a8a3SJed Brown     }
1456b1a0a8a3SJed Brown     /* Shift to get global indices */
1457b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] += rstart;
1458b1a0a8a3SJed Brown 
1459b1a0a8a3SJed Brown     /* Build the index sets for each block */
14608f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
1461b1a0a8a3SJed Brown       ierr   = ISCreateGeneral(PETSC_COMM_SELF,count[i],&indices[start],PETSC_COPY_VALUES,&is[i]);CHKERRQ(ierr);
1462b1a0a8a3SJed Brown       ierr   = ISSort(is[i]);CHKERRQ(ierr);
1463b1a0a8a3SJed Brown       start += count[i];
1464b1a0a8a3SJed Brown     }
1465b1a0a8a3SJed Brown 
1466302440fdSBarry Smith     ierr = PetscFree(count);CHKERRQ(ierr);
1467302440fdSBarry Smith     ierr = PetscFree(indices);CHKERRQ(ierr);
1468fcfd50ebSBarry Smith     ierr = ISDestroy(&isnumb);CHKERRQ(ierr);
1469fcfd50ebSBarry Smith     ierr = ISDestroy(&ispart);CHKERRQ(ierr);
1470b1a0a8a3SJed Brown   }
14716a4f0f73SDmitry Karpeev   *iis = is;
14728f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
14738f3b4b4dSDmitry Karpeev }
14748f3b4b4dSDmitry Karpeev 
1475b541e6a4SDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateStraddlingSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
14768f3b4b4dSDmitry Karpeev {
14778f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
14788f3b4b4dSDmitry Karpeev 
14798f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
14808f3b4b4dSDmitry Karpeev   ierr = MatSubdomainsCreateCoalesce(A,N,n,iis);CHKERRQ(ierr);
14818f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
14828f3b4b4dSDmitry Karpeev }
14838f3b4b4dSDmitry Karpeev 
14848f3b4b4dSDmitry Karpeev 
14858f3b4b4dSDmitry Karpeev 
14868f3b4b4dSDmitry Karpeev /*@C
14878f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains - Creates n index sets defining n nonoverlapping subdomains for the additive
14888f3b4b4dSDmitry Karpeev    Schwarz preconditioner for a any problem based on its matrix.
14898f3b4b4dSDmitry Karpeev 
14908f3b4b4dSDmitry Karpeev    Collective
14918f3b4b4dSDmitry Karpeev 
14928f3b4b4dSDmitry Karpeev    Input Parameters:
14938f3b4b4dSDmitry Karpeev +  A       - The global matrix operator
14948f3b4b4dSDmitry Karpeev -  N       - the number of global subdomains requested
14958f3b4b4dSDmitry Karpeev 
14968f3b4b4dSDmitry Karpeev    Output Parameters:
14978f3b4b4dSDmitry Karpeev +  n   - the number of subdomains created on this processor
14988f3b4b4dSDmitry Karpeev -  iis - the array of index sets defining the local inner subdomains (on which the correction is applied)
14998f3b4b4dSDmitry Karpeev 
15008f3b4b4dSDmitry Karpeev    Level: advanced
15018f3b4b4dSDmitry Karpeev 
15028f3b4b4dSDmitry Karpeev    Note: When N >= A's communicator size, each subdomain is local -- contained within a single processor.
15038f3b4b4dSDmitry Karpeev          When N < size, the subdomains are 'straddling' (processor boundaries) and are no longer local.
15048f3b4b4dSDmitry Karpeev          The resulting subdomains can be use in PCGASMSetSubdomains(pc,n,iss,NULL).  The overlapping
15058f3b4b4dSDmitry Karpeev 	 outer subdomains will be automatically generated from these according to the requested amount of
15068f3b4b4dSDmitry Karpeev 	 overlap; this is currently supported only with local subdomains.
15078f3b4b4dSDmitry Karpeev 
15088f3b4b4dSDmitry Karpeev 
15098f3b4b4dSDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, unstructured grid
15108f3b4b4dSDmitry Karpeev 
15118f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMDestroySubdomains()
15128f3b4b4dSDmitry Karpeev @*/
1513b541e6a4SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
15148f3b4b4dSDmitry Karpeev {
15158f3b4b4dSDmitry Karpeev   PetscMPIInt     size;
15168f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
15178f3b4b4dSDmitry Karpeev 
15188f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
15198f3b4b4dSDmitry Karpeev   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
15208f3b4b4dSDmitry Karpeev   PetscValidPointer(iis,4);
15218f3b4b4dSDmitry Karpeev 
15228f3b4b4dSDmitry Karpeev   if (N < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Number of subdomains must be > 0, N = %D",N);
15238f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
15248f3b4b4dSDmitry Karpeev   if (N >= size) {
15258f3b4b4dSDmitry Karpeev     *n = N/size + (N%size);
15268f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateLocalSubdomains(A,*n,iis);CHKERRQ(ierr);
15276a4f0f73SDmitry Karpeev   } else {
15288f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateStraddlingSubdomains(A,N,n,iis);CHKERRQ(ierr);
15296a4f0f73SDmitry Karpeev   }
1530b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1531b1a0a8a3SJed Brown }
1532b1a0a8a3SJed Brown 
1533b1a0a8a3SJed Brown /*@C
1534f746d493SDmitry Karpeev    PCGASMDestroySubdomains - Destroys the index sets created with
15358f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains() or PCGASMCreateSubdomains2D. Should be
153606b43e7eSDmitry Karpeev    called after setting subdomains with PCGASMSetSubdomains().
1537b1a0a8a3SJed Brown 
1538b1a0a8a3SJed Brown    Collective
1539b1a0a8a3SJed Brown 
1540b1a0a8a3SJed Brown    Input Parameters:
1541b1a0a8a3SJed Brown +  n   - the number of index sets
15426a4f0f73SDmitry Karpeev .  iis - the array of inner subdomains,
15430298fd71SBarry Smith -  ois - the array of outer subdomains, can be NULL
1544b1a0a8a3SJed Brown 
15456a4f0f73SDmitry Karpeev    Level: intermediate
15466a4f0f73SDmitry Karpeev 
15476a4f0f73SDmitry Karpeev    Notes: this is merely a convenience subroutine that walks each list,
15482c112581SDmitry Karpeev    destroys each IS on the list, and then frees the list. At the end the
15492c112581SDmitry Karpeev    list pointers are set to NULL.
1550b1a0a8a3SJed Brown 
1551f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, unstructured grid
1552b1a0a8a3SJed Brown 
15538f3b4b4dSDmitry Karpeev .seealso: PCGASMCreateSubdomains(), PCGASMSetSubdomains()
1554b1a0a8a3SJed Brown @*/
15552c112581SDmitry Karpeev PetscErrorCode  PCGASMDestroySubdomains(PetscInt n,IS **iis,IS **ois)
1556b1a0a8a3SJed Brown {
1557b1a0a8a3SJed Brown   PetscInt       i;
1558b1a0a8a3SJed Brown   PetscErrorCode ierr;
15595fd66863SKarl Rupp 
1560b1a0a8a3SJed Brown   PetscFunctionBegin;
1561a35b7b57SDmitry Karpeev   if (n <= 0) PetscFunctionReturn(0);
15626a4f0f73SDmitry Karpeev   if (ois) {
15632c112581SDmitry Karpeev     PetscValidPointer(ois,3);
15642c112581SDmitry Karpeev     if (*ois) {
15652c112581SDmitry Karpeev       PetscValidPointer(*ois,3);
1566a35b7b57SDmitry Karpeev       for (i=0; i<n; i++) {
15672c112581SDmitry Karpeev         ierr = ISDestroy(&(*ois)[i]);CHKERRQ(ierr);
1568a35b7b57SDmitry Karpeev       }
1569135757f6SDmitry Karpeev       ierr = PetscFree((*ois));CHKERRQ(ierr);
15702c112581SDmitry Karpeev     }
1571b1a0a8a3SJed Brown   }
1572b9d0fdaaSFande Kong   if (iis) {
1573b9d0fdaaSFande Kong     PetscValidPointer(iis,2);
1574b9d0fdaaSFande Kong     if (*iis) {
1575b9d0fdaaSFande Kong       PetscValidPointer(*iis,2);
1576b9d0fdaaSFande Kong       for (i=0; i<n; i++) {
1577b9d0fdaaSFande Kong         ierr = ISDestroy(&(*iis)[i]);CHKERRQ(ierr);
1578b9d0fdaaSFande Kong       }
1579b9d0fdaaSFande Kong       ierr = PetscFree((*iis));CHKERRQ(ierr);
1580b9d0fdaaSFande Kong     }
1581b9d0fdaaSFande Kong   }
1582b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1583b1a0a8a3SJed Brown }
1584b1a0a8a3SJed Brown 
1585af538404SDmitry Karpeev 
1586af538404SDmitry Karpeev #define PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,xleft_loc,ylow_loc,xright_loc,yhigh_loc,n) \
1587af538404SDmitry Karpeev   {                                                                                                       \
1588af538404SDmitry Karpeev     PetscInt first_row = first/M, last_row = last/M+1;                                                     \
1589af538404SDmitry Karpeev     /*                                                                                                    \
1590af538404SDmitry Karpeev      Compute ylow_loc and yhigh_loc so that (ylow_loc,xleft) and (yhigh_loc,xright) are the corners       \
1591af538404SDmitry Karpeev      of the bounding box of the intersection of the subdomain with the local ownership range (local       \
1592af538404SDmitry Karpeev      subdomain).                                                                                          \
1593af538404SDmitry Karpeev      Also compute xleft_loc and xright_loc as the lower and upper bounds on the first and last rows       \
1594af538404SDmitry Karpeev      of the intersection.                                                                                 \
1595af538404SDmitry Karpeev     */                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             \
1596af538404SDmitry Karpeev     /* ylow_loc is the grid row containing the first element of the local sumbdomain */                   \
1597eec7e3faSDmitry Karpeev     *ylow_loc = PetscMax(first_row,ylow);                                                                    \
1598af538404SDmitry Karpeev     /* xleft_loc is the offset of first element of the local subdomain within its grid row (might actually be outside the local subdomain) */ \
1599eec7e3faSDmitry Karpeev     *xleft_loc = *ylow_loc==first_row ? PetscMax(first%M,xleft) : xleft;                                                                            \
1600af538404SDmitry Karpeev     /* yhigh_loc is the grid row above the last local subdomain element */                                                                    \
1601eec7e3faSDmitry Karpeev     *yhigh_loc = PetscMin(last_row,yhigh);                                                                                                     \
1602af538404SDmitry Karpeev     /* xright is the offset of the end of the  local subdomain within its grid row (might actually be outside the local subdomain) */         \
1603eec7e3faSDmitry Karpeev     *xright_loc = *yhigh_loc==last_row ? PetscMin(xright,last%M) : xright;                                                                          \
1604af538404SDmitry Karpeev     /* Now compute the size of the local subdomain n. */ \
1605c3518bceSDmitry Karpeev     *n = 0;                                               \
1606eec7e3faSDmitry Karpeev     if (*ylow_loc < *yhigh_loc) {                           \
1607af538404SDmitry Karpeev       PetscInt width = xright-xleft;                     \
1608eec7e3faSDmitry Karpeev       *n += width*(*yhigh_loc-*ylow_loc-1);                 \
1609eec7e3faSDmitry Karpeev       *n += PetscMin(PetscMax(*xright_loc-xleft,0),width); \
1610eec7e3faSDmitry Karpeev       *n -= PetscMin(PetscMax(*xleft_loc-xleft,0), width); \
1611af538404SDmitry Karpeev     } \
1612af538404SDmitry Karpeev   }
1613af538404SDmitry Karpeev 
1614c3518bceSDmitry Karpeev 
1615eec7e3faSDmitry Karpeev 
1616b1a0a8a3SJed Brown /*@
1617f746d493SDmitry Karpeev    PCGASMCreateSubdomains2D - Creates the index sets for the overlapping Schwarz
1618b1a0a8a3SJed Brown    preconditioner for a two-dimensional problem on a regular grid.
1619b1a0a8a3SJed Brown 
1620af538404SDmitry Karpeev    Collective
1621b1a0a8a3SJed Brown 
1622b1a0a8a3SJed Brown    Input Parameters:
162306b43e7eSDmitry Karpeev +  M, N               - the global number of grid points in the x and y directions
1624af538404SDmitry Karpeev .  Mdomains, Ndomains - the global number of subdomains in the x and y directions
1625b1a0a8a3SJed Brown .  dof                - degrees of freedom per node
1626b1a0a8a3SJed Brown -  overlap            - overlap in mesh lines
1627b1a0a8a3SJed Brown 
1628b1a0a8a3SJed Brown    Output Parameters:
1629af538404SDmitry Karpeev +  Nsub - the number of local subdomains created
16306a4f0f73SDmitry Karpeev .  iis  - array of index sets defining inner (nonoverlapping) subdomains
16316a4f0f73SDmitry Karpeev -  ois  - array of index sets defining outer (overlapping, if overlap > 0) subdomains
1632b1a0a8a3SJed Brown 
1633b1a0a8a3SJed Brown 
1634b1a0a8a3SJed Brown    Level: advanced
1635b1a0a8a3SJed Brown 
1636f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, 2D, regular grid
1637b1a0a8a3SJed Brown 
16388f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(), PCGASMSetOverlap()
1639b1a0a8a3SJed Brown @*/
16406a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains2D(PC pc,PetscInt M,PetscInt N,PetscInt Mdomains,PetscInt Ndomains,PetscInt dof,PetscInt overlap,PetscInt *nsub,IS **iis,IS **ois)
1641b1a0a8a3SJed Brown {
1642b1a0a8a3SJed Brown   PetscErrorCode ierr;
16432bbb417fSDmitry Karpeev   PetscMPIInt    size, rank;
16442bbb417fSDmitry Karpeev   PetscInt       i, j;
16452bbb417fSDmitry Karpeev   PetscInt       maxheight, maxwidth;
16462bbb417fSDmitry Karpeev   PetscInt       xstart, xleft, xright, xleft_loc, xright_loc;
16472bbb417fSDmitry Karpeev   PetscInt       ystart, ylow,  yhigh,  ylow_loc,  yhigh_loc;
1648eec7e3faSDmitry Karpeev   PetscInt       x[2][2], y[2][2], n[2];
16492bbb417fSDmitry Karpeev   PetscInt       first, last;
16502bbb417fSDmitry Karpeev   PetscInt       nidx, *idx;
16512bbb417fSDmitry Karpeev   PetscInt       ii,jj,s,q,d;
1652af538404SDmitry Karpeev   PetscInt       k,kk;
16532bbb417fSDmitry Karpeev   PetscMPIInt    color;
16542bbb417fSDmitry Karpeev   MPI_Comm       comm, subcomm;
16556a4f0f73SDmitry Karpeev   IS             **xis = 0, **is = ois, **is_local = iis;
1656d34fcf5fSBarry Smith 
1657b1a0a8a3SJed Brown   PetscFunctionBegin;
16582bbb417fSDmitry Karpeev   ierr = PetscObjectGetComm((PetscObject)pc, &comm);CHKERRQ(ierr);
16592bbb417fSDmitry Karpeev   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
16602bbb417fSDmitry Karpeev   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
16612bbb417fSDmitry Karpeev   ierr = MatGetOwnershipRange(pc->pmat, &first, &last);CHKERRQ(ierr);
1662d34fcf5fSBarry Smith   if (first%dof || last%dof) SETERRQ3(PETSC_COMM_SELF, PETSC_ERR_ARG_OUTOFRANGE, "Matrix row partitioning unsuitable for domain decomposition: local row range (%D,%D) "
16632bbb417fSDmitry Karpeev                                       "does not respect the number of degrees of freedom per grid point %D", first, last, dof);
1664d34fcf5fSBarry Smith 
1665af538404SDmitry Karpeev   /* Determine the number of domains with nonzero intersections with the local ownership range. */
16662bbb417fSDmitry Karpeev   s      = 0;
1667af538404SDmitry Karpeev   ystart = 0;
1668af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1669af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1670af538404SDmitry Karpeev     if (maxheight < 2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many %D subdomains in the vertical directon for mesh height %D", Ndomains, N);
1671eec7e3faSDmitry Karpeev     /* Vertical domain limits with an overlap. */
1672eec7e3faSDmitry Karpeev     ylow   = PetscMax(ystart - overlap,0);
1673eec7e3faSDmitry Karpeev     yhigh  = PetscMin(ystart + maxheight + overlap,N);
1674b1a0a8a3SJed Brown     xstart = 0;
1675af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1676af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1677af538404SDmitry Karpeev       if (maxwidth < 2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many %D subdomains in the horizontal direction for mesh width %D", Mdomains, M);
1678eec7e3faSDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1679eec7e3faSDmitry Karpeev       xleft  = PetscMax(xstart - overlap,0);
1680eec7e3faSDmitry Karpeev       xright = PetscMin(xstart + maxwidth + overlap,M);
1681af538404SDmitry Karpeev       /*
1682af538404SDmitry Karpeev          Determine whether this subdomain intersects this processor's ownership range of pc->pmat.
1683af538404SDmitry Karpeev       */
1684c3518bceSDmitry Karpeev       PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
16852fa5cd67SKarl Rupp       if (nidx) ++s;
1686af538404SDmitry Karpeev       xstart += maxwidth;
1687af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
1688af538404SDmitry Karpeev     ystart += maxheight;
1689af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
16902fa5cd67SKarl Rupp 
1691af538404SDmitry Karpeev   /* Now we can allocate the necessary number of ISs. */
1692af538404SDmitry Karpeev   *nsub  = s;
1693854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is);CHKERRQ(ierr);
1694854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is_local);CHKERRQ(ierr);
1695af538404SDmitry Karpeev   s      = 0;
1696af538404SDmitry Karpeev   ystart = 0;
1697af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1698af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1699af538404SDmitry Karpeev     if (maxheight < 2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many %D subdomains in the vertical directon for mesh height %D", Ndomains, N);
1700af538404SDmitry Karpeev     /* Vertical domain limits with an overlap. */
1701eec7e3faSDmitry Karpeev     y[0][0] = PetscMax(ystart - overlap,0);
1702eec7e3faSDmitry Karpeev     y[0][1] = PetscMin(ystart + maxheight + overlap,N);
1703eec7e3faSDmitry Karpeev     /* Vertical domain limits without an overlap. */
1704eec7e3faSDmitry Karpeev     y[1][0] = ystart;
1705eec7e3faSDmitry Karpeev     y[1][1] = PetscMin(ystart + maxheight,N);
1706eec7e3faSDmitry Karpeev     xstart  = 0;
1707af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1708af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1709af538404SDmitry Karpeev       if (maxwidth < 2) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Too many %D subdomains in the horizontal direction for mesh width %D", Mdomains, M);
1710af538404SDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1711eec7e3faSDmitry Karpeev       x[0][0] = PetscMax(xstart - overlap,0);
1712eec7e3faSDmitry Karpeev       x[0][1] = PetscMin(xstart + maxwidth + overlap,M);
1713eec7e3faSDmitry Karpeev       /* Horizontal domain limits without an overlap. */
1714eec7e3faSDmitry Karpeev       x[1][0] = xstart;
1715eec7e3faSDmitry Karpeev       x[1][1] = PetscMin(xstart+maxwidth,M);
17162bbb417fSDmitry Karpeev       /*
17172bbb417fSDmitry Karpeev          Determine whether this domain intersects this processor's ownership range of pc->pmat.
17182bbb417fSDmitry Karpeev          Do this twice: first for the domains with overlaps, and once without.
17192bbb417fSDmitry Karpeev          During the first pass create the subcommunicators, and use them on the second pass as well.
17202bbb417fSDmitry Karpeev       */
17212bbb417fSDmitry Karpeev       for (q = 0; q < 2; ++q) {
1722cc96b2e5SBarry Smith         PetscBool split = PETSC_FALSE;
17232bbb417fSDmitry Karpeev         /*
17242bbb417fSDmitry Karpeev           domain limits, (xleft, xright) and (ylow, yheigh) are adjusted
17252bbb417fSDmitry Karpeev           according to whether the domain with an overlap or without is considered.
17262bbb417fSDmitry Karpeev         */
17272bbb417fSDmitry Karpeev         xleft = x[q][0]; xright = x[q][1];
17282bbb417fSDmitry Karpeev         ylow  = y[q][0]; yhigh  = y[q][1];
1729c3518bceSDmitry Karpeev         PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
1730af538404SDmitry Karpeev         nidx *= dof;
1731eec7e3faSDmitry Karpeev         n[q]  = nidx;
17322bbb417fSDmitry Karpeev         /*
1733eec7e3faSDmitry Karpeev          Based on the counted number of indices in the local domain *with an overlap*,
1734af538404SDmitry Karpeev          construct a subcommunicator of all the processors supporting this domain.
1735eec7e3faSDmitry Karpeev          Observe that a domain with an overlap might have nontrivial local support,
1736eec7e3faSDmitry Karpeev          while the domain without an overlap might not.  Hence, the decision to participate
1737eec7e3faSDmitry Karpeev          in the subcommunicator must be based on the domain with an overlap.
17382bbb417fSDmitry Karpeev          */
17392bbb417fSDmitry Karpeev         if (q == 0) {
17402fa5cd67SKarl Rupp           if (nidx) color = 1;
17412fa5cd67SKarl Rupp           else color = MPI_UNDEFINED;
17422bbb417fSDmitry Karpeev           ierr = MPI_Comm_split(comm, color, rank, &subcomm);CHKERRQ(ierr);
1743cc96b2e5SBarry Smith           split = PETSC_TRUE;
17442bbb417fSDmitry Karpeev         }
1745af538404SDmitry Karpeev         /*
1746eec7e3faSDmitry Karpeev          Proceed only if the number of local indices *with an overlap* is nonzero.
1747af538404SDmitry Karpeev          */
1748eec7e3faSDmitry Karpeev         if (n[0]) {
17492fa5cd67SKarl Rupp           if (q == 0) xis = is;
1750af538404SDmitry Karpeev           if (q == 1) {
1751af538404SDmitry Karpeev             /*
1752eec7e3faSDmitry Karpeev              The IS for the no-overlap subdomain shares a communicator with the overlapping domain.
1753af538404SDmitry Karpeev              Moreover, if the overlap is zero, the two ISs are identical.
1754af538404SDmitry Karpeev              */
1755b1a0a8a3SJed Brown             if (overlap == 0) {
1756eec7e3faSDmitry Karpeev               (*is_local)[s] = (*is)[s];
17572bbb417fSDmitry Karpeev               ierr           = PetscObjectReference((PetscObject)(*is)[s]);CHKERRQ(ierr);
17582bbb417fSDmitry Karpeev               continue;
1759d34fcf5fSBarry Smith             } else {
17606a4f0f73SDmitry Karpeev               xis     = is_local;
1761eec7e3faSDmitry Karpeev               subcomm = ((PetscObject)(*is)[s])->comm;
17622bbb417fSDmitry Karpeev             }
1763af538404SDmitry Karpeev           } /* if (q == 1) */
17640298fd71SBarry Smith           idx  = NULL;
1765785e854fSJed Brown           ierr = PetscMalloc1(nidx,&idx);CHKERRQ(ierr);
1766eec7e3faSDmitry Karpeev           if (nidx) {
17672bbb417fSDmitry Karpeev             k = 0;
17682bbb417fSDmitry Karpeev             for (jj=ylow_loc; jj<yhigh_loc; ++jj) {
1769af538404SDmitry Karpeev               PetscInt x0 = (jj==ylow_loc) ? xleft_loc : xleft;
1770af538404SDmitry Karpeev               PetscInt x1 = (jj==yhigh_loc-1) ? xright_loc : xright;
1771af538404SDmitry Karpeev               kk = dof*(M*jj + x0);
17722bbb417fSDmitry Karpeev               for (ii=x0; ii<x1; ++ii) {
17732bbb417fSDmitry Karpeev                 for (d = 0; d < dof; ++d) {
17742bbb417fSDmitry Karpeev                   idx[k++] = kk++;
1775b1a0a8a3SJed Brown                 }
1776b1a0a8a3SJed Brown               }
1777b1a0a8a3SJed Brown             }
1778eec7e3faSDmitry Karpeev           }
17796a4f0f73SDmitry Karpeev           ierr = ISCreateGeneral(subcomm,nidx,idx,PETSC_OWN_POINTER,(*xis)+s);CHKERRQ(ierr);
1780cc96b2e5SBarry Smith           if (split) {
1781cc96b2e5SBarry Smith             ierr = MPI_Comm_free(&subcomm);CHKERRQ(ierr);
1782cc96b2e5SBarry Smith           }
1783eec7e3faSDmitry Karpeev         }/* if (n[0]) */
17842bbb417fSDmitry Karpeev       }/* for (q = 0; q < 2; ++q) */
17852fa5cd67SKarl Rupp       if (n[0]) ++s;
1786af538404SDmitry Karpeev       xstart += maxwidth;
1787af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
17882bbb417fSDmitry Karpeev     ystart += maxheight;
1789af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
1790b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1791b1a0a8a3SJed Brown }
1792b1a0a8a3SJed Brown 
1793b1a0a8a3SJed Brown /*@C
179406b43e7eSDmitry Karpeev     PCGASMGetSubdomains - Gets the subdomains supported on this processor
179506b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1796b1a0a8a3SJed Brown 
1797b1a0a8a3SJed Brown     Not Collective
1798b1a0a8a3SJed Brown 
1799b1a0a8a3SJed Brown     Input Parameter:
1800b1a0a8a3SJed Brown .   pc - the preconditioner context
1801b1a0a8a3SJed Brown 
1802b1a0a8a3SJed Brown     Output Parameters:
1803b1a0a8a3SJed Brown +   n   - the number of subdomains for this processor (default value = 1)
18040298fd71SBarry Smith .   iis - the index sets that define the inner subdomains (without overlap) supported on this processor (can be NULL)
18050298fd71SBarry Smith -   ois - the index sets that define the outer subdomains (with overlap) supported on this processor (can be NULL)
1806b1a0a8a3SJed Brown 
1807b1a0a8a3SJed Brown 
1808b1a0a8a3SJed Brown     Notes:
18096a4f0f73SDmitry Karpeev     The user is responsible for destroying the ISs and freeing the returned arrays.
1810b1a0a8a3SJed Brown     The IS numbering is in the parallel, global numbering of the vector.
1811b1a0a8a3SJed Brown 
1812b1a0a8a3SJed Brown     Level: advanced
1813b1a0a8a3SJed Brown 
181406b43e7eSDmitry Karpeev .keywords: PC, GASM, get, subdomains, additive Schwarz
1815b1a0a8a3SJed Brown 
18168f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(), PCGASMCreateSubdomains2D(),
18178f3b4b4dSDmitry Karpeev           PCGASMSetSubdomains(), PCGASMGetSubmatrices()
1818b1a0a8a3SJed Brown @*/
18196a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMGetSubdomains(PC pc,PetscInt *n,IS *iis[],IS *ois[])
1820b1a0a8a3SJed Brown {
1821f746d493SDmitry Karpeev   PC_GASM        *osm;
1822b1a0a8a3SJed Brown   PetscErrorCode ierr;
1823b1a0a8a3SJed Brown   PetscBool      match;
18246a4f0f73SDmitry Karpeev   PetscInt       i;
18255fd66863SKarl Rupp 
1826b1a0a8a3SJed Brown   PetscFunctionBegin;
1827b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1828251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1829ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Incorrect object type: expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1830f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1831ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
18326a4f0f73SDmitry Karpeev   if (iis) {
1833785e854fSJed Brown     ierr = PetscMalloc1(osm->n, iis);CHKERRQ(ierr);
18346a4f0f73SDmitry Karpeev   }
18356a4f0f73SDmitry Karpeev   if (ois) {
1836785e854fSJed Brown     ierr = PetscMalloc1(osm->n, ois);CHKERRQ(ierr);
18376a4f0f73SDmitry Karpeev   }
18386a4f0f73SDmitry Karpeev   if (iis || ois) {
18396a4f0f73SDmitry Karpeev     for (i = 0; i < osm->n; ++i) {
18406a4f0f73SDmitry Karpeev       if (iis) (*iis)[i] = osm->iis[i];
18416a4f0f73SDmitry Karpeev       if (ois) (*ois)[i] = osm->ois[i];
18426a4f0f73SDmitry Karpeev     }
1843b1a0a8a3SJed Brown   }
1844b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1845b1a0a8a3SJed Brown }
1846b1a0a8a3SJed Brown 
1847b1a0a8a3SJed Brown /*@C
184806b43e7eSDmitry Karpeev     PCGASMGetSubmatrices - Gets the local submatrices (for this processor
1849b1a0a8a3SJed Brown     only) for the additive Schwarz preconditioner.
1850b1a0a8a3SJed Brown 
1851b1a0a8a3SJed Brown     Not Collective
1852b1a0a8a3SJed Brown 
1853b1a0a8a3SJed Brown     Input Parameter:
1854b1a0a8a3SJed Brown .   pc - the preconditioner context
1855b1a0a8a3SJed Brown 
1856b1a0a8a3SJed Brown     Output Parameters:
1857b1a0a8a3SJed Brown +   n   - the number of matrices for this processor (default value = 1)
1858b1a0a8a3SJed Brown -   mat - the matrices
1859b1a0a8a3SJed Brown 
186006b43e7eSDmitry Karpeev     Notes: matrices returned by this routine have the same communicators as the index sets (IS)
18618f3b4b4dSDmitry Karpeev            used to define subdomains in PCGASMSetSubdomains()
1862b1a0a8a3SJed Brown     Level: advanced
1863b1a0a8a3SJed Brown 
1864f746d493SDmitry Karpeev .keywords: PC, GASM, set, local, subdomains, additive Schwarz, block Jacobi
1865b1a0a8a3SJed Brown 
18668f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(),
186706b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMSetSubdomains(), PCGASMGetSubdomains()
1868b1a0a8a3SJed Brown @*/
186906b43e7eSDmitry Karpeev PetscErrorCode  PCGASMGetSubmatrices(PC pc,PetscInt *n,Mat *mat[])
1870b1a0a8a3SJed Brown {
1871f746d493SDmitry Karpeev   PC_GASM        *osm;
1872b1a0a8a3SJed Brown   PetscErrorCode ierr;
1873b1a0a8a3SJed Brown   PetscBool      match;
1874b1a0a8a3SJed Brown 
1875b1a0a8a3SJed Brown   PetscFunctionBegin;
1876b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1877b1a0a8a3SJed Brown   PetscValidIntPointer(n,2);
1878b1a0a8a3SJed Brown   if (mat) PetscValidPointer(mat,3);
1879ce94432eSBarry Smith   if (!pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call after KSPSetUP() or PCSetUp().");
1880251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1881ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1882f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1883ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
1884b1a0a8a3SJed Brown   if (mat) *mat = osm->pmat;
1885b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1886b1a0a8a3SJed Brown }
1887d709ea83SDmitry Karpeev 
1888d709ea83SDmitry Karpeev /*@
18898f3b4b4dSDmitry Karpeev     PCGASMSetUseDMSubdomains - Indicates whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1890d709ea83SDmitry Karpeev     Logically Collective
1891d709ea83SDmitry Karpeev 
1892d709ea83SDmitry Karpeev     Input Parameter:
1893d709ea83SDmitry Karpeev +   pc  - the preconditioner
1894d709ea83SDmitry Karpeev -   flg - boolean indicating whether to use subdomains defined by the DM
1895d709ea83SDmitry Karpeev 
1896d709ea83SDmitry Karpeev     Options Database Key:
18978f3b4b4dSDmitry Karpeev .   -pc_gasm_dm_subdomains -pc_gasm_overlap -pc_gasm_total_subdomains
1898d709ea83SDmitry Karpeev 
1899d709ea83SDmitry Karpeev     Level: intermediate
1900d709ea83SDmitry Karpeev 
1901d709ea83SDmitry Karpeev     Notes:
19028f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), PCGASMSetTotalSubdomains() or PCGASMSetOverlap() take precedence over PCGASMSetUseDMSubdomains(),
19038f3b4b4dSDmitry Karpeev     so setting PCGASMSetSubdomains() with nontrivial subdomain ISs or any of PCGASMSetTotalSubdomains() and PCGASMSetOverlap()
19048f3b4b4dSDmitry Karpeev     automatically turns the latter off.
1905d709ea83SDmitry Karpeev 
1906d709ea83SDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
1907d709ea83SDmitry Karpeev 
19088f3b4b4dSDmitry Karpeev .seealso: PCGASMGetUseDMSubdomains(), PCGASMSetSubdomains(), PCGASMSetOverlap()
1909d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
1910d709ea83SDmitry Karpeev @*/
19118f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetUseDMSubdomains(PC pc,PetscBool flg)
1912d709ea83SDmitry Karpeev {
1913d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1914d709ea83SDmitry Karpeev   PetscErrorCode ierr;
1915d709ea83SDmitry Karpeev   PetscBool      match;
1916d709ea83SDmitry Karpeev 
1917d709ea83SDmitry Karpeev   PetscFunctionBegin;
1918d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1919d709ea83SDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
1920d709ea83SDmitry Karpeev   if (pc->setupcalled) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Not for a setup PC.");
1921d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1922d709ea83SDmitry Karpeev   if (match) {
19238f3b4b4dSDmitry Karpeev     if (!osm->user_subdomains && osm->N == PETSC_DETERMINE && osm->overlap < 0) {
1924d709ea83SDmitry Karpeev       osm->dm_subdomains = flg;
1925d709ea83SDmitry Karpeev     }
19268f3b4b4dSDmitry Karpeev   }
1927d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
1928d709ea83SDmitry Karpeev }
1929d709ea83SDmitry Karpeev 
1930d709ea83SDmitry Karpeev /*@
19318f3b4b4dSDmitry Karpeev     PCGASMGetUseDMSubdomains - Returns flag indicating whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1932d709ea83SDmitry Karpeev     Not Collective
1933d709ea83SDmitry Karpeev 
1934d709ea83SDmitry Karpeev     Input Parameter:
1935d709ea83SDmitry Karpeev .   pc  - the preconditioner
1936d709ea83SDmitry Karpeev 
1937d709ea83SDmitry Karpeev     Output Parameter:
1938d709ea83SDmitry Karpeev .   flg - boolean indicating whether to use subdomains defined by the DM
1939d709ea83SDmitry Karpeev 
1940d709ea83SDmitry Karpeev     Level: intermediate
1941d709ea83SDmitry Karpeev 
1942d709ea83SDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
1943d709ea83SDmitry Karpeev 
19448f3b4b4dSDmitry Karpeev .seealso: PCGASMSetUseDMSubdomains(), PCGASMSetOverlap()
1945d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
1946d709ea83SDmitry Karpeev @*/
19478f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMGetUseDMSubdomains(PC pc,PetscBool* flg)
1948d709ea83SDmitry Karpeev {
1949d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1950d709ea83SDmitry Karpeev   PetscErrorCode ierr;
1951d709ea83SDmitry Karpeev   PetscBool      match;
1952d709ea83SDmitry Karpeev 
1953d709ea83SDmitry Karpeev   PetscFunctionBegin;
1954d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1955d709ea83SDmitry Karpeev   PetscValidPointer(flg,2);
1956d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1957d709ea83SDmitry Karpeev   if (match) {
1958d709ea83SDmitry Karpeev     if (flg) *flg = osm->dm_subdomains;
1959d709ea83SDmitry Karpeev   }
1960d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
1961d709ea83SDmitry Karpeev }
1962