xref: /petsc/src/ksp/pc/impls/gasm/gasm.c (revision 534a8f05a7a8aff70dd8cfd53d9cd834400a8dbf)
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    */
7336a9e3b9SBarry Smith #define len  16*(nidx+1)+1
7436a9e3b9SBarry Smith   ierr = PetscMalloc1(len, &cidx);CHKERRQ(ierr);
7536a9e3b9SBarry Smith   ierr = PetscViewerStringOpen(PETSC_COMM_SELF, cidx, len, &sviewer);CHKERRQ(ierr);
7636a9e3b9SBarry Smith #undef len
774bde246dSDmitry Karpeev   ierr = ISGetIndices(osm->iis[i], &idx);CHKERRQ(ierr);
784bde246dSDmitry Karpeev   for (j = 0; j < nidx; ++j) {
794bde246dSDmitry Karpeev     ierr = PetscViewerStringSPrintf(sviewer, "%D ", idx[j]);CHKERRQ(ierr);
804bde246dSDmitry Karpeev   }
814bde246dSDmitry Karpeev   ierr = ISRestoreIndices(osm->iis[i],&idx);CHKERRQ(ierr);
824bde246dSDmitry Karpeev   ierr = PetscViewerDestroy(&sviewer);CHKERRQ(ierr);
834bde246dSDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "Inner subdomain:\n");CHKERRQ(ierr);
844bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
851575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
864bde246dSDmitry Karpeev   ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%s", cidx);CHKERRQ(ierr);
874bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
881575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
894bde246dSDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
904bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
914bde246dSDmitry Karpeev   ierr = PetscFree(cidx);CHKERRQ(ierr);
924bde246dSDmitry Karpeev   /* Outer subdomains. */
936a4f0f73SDmitry Karpeev   ierr = ISGetLocalSize(osm->ois[i], &nidx);CHKERRQ(ierr);
94eec7e3faSDmitry Karpeev   /*
95eec7e3faSDmitry Karpeev    No more than 15 characters per index plus a space.
96eec7e3faSDmitry Karpeev    PetscViewerStringSPrintf requires a string of size at least 2, so use (nidx+1) instead of nidx,
97eec7e3faSDmitry Karpeev    in case nidx == 0. That will take care of the space for the trailing '\0' as well.
98eec7e3faSDmitry Karpeev    For nidx == 0, the whole string 16 '\0'.
99eec7e3faSDmitry Karpeev    */
10036a9e3b9SBarry Smith #define len  16*(nidx+1)+1
10136a9e3b9SBarry Smith   ierr = PetscMalloc1(len, &cidx);CHKERRQ(ierr);
10236a9e3b9SBarry Smith   ierr = PetscViewerStringOpen(PETSC_COMM_SELF, cidx, len, &sviewer);CHKERRQ(ierr);
10336a9e3b9SBarry Smith #undef len
1046a4f0f73SDmitry Karpeev   ierr = ISGetIndices(osm->ois[i], &idx);CHKERRQ(ierr);
105af538404SDmitry Karpeev   for (j = 0; j < nidx; ++j) {
106af538404SDmitry Karpeev     ierr = PetscViewerStringSPrintf(sviewer,"%D ", idx[j]);CHKERRQ(ierr);
107af538404SDmitry Karpeev   }
1086bf464f9SBarry Smith   ierr = PetscViewerDestroy(&sviewer);CHKERRQ(ierr);
1096a4f0f73SDmitry Karpeev   ierr = ISRestoreIndices(osm->ois[i],&idx);CHKERRQ(ierr);
1106a4f0f73SDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "Outer subdomain:\n");CHKERRQ(ierr);
11106b43e7eSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
1121575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
113af538404SDmitry Karpeev   ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%s", cidx);CHKERRQ(ierr);
114af538404SDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
1151575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
116af538404SDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
11706b43e7eSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
118af538404SDmitry Karpeev   ierr = PetscFree(cidx);CHKERRQ(ierr);
11906b43e7eSDmitry Karpeev   PetscFunctionReturn(0);
12006b43e7eSDmitry Karpeev }
12106b43e7eSDmitry Karpeev 
12206b43e7eSDmitry Karpeev static PetscErrorCode  PCGASMPrintSubdomains(PC pc)
12306b43e7eSDmitry Karpeev {
12406b43e7eSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
12506b43e7eSDmitry Karpeev   const char     *prefix;
12606b43e7eSDmitry Karpeev   char           fname[PETSC_MAX_PATH_LEN+1];
1278f3b4b4dSDmitry Karpeev   PetscInt       l, d, count;
1288f3b4b4dSDmitry Karpeev   PetscBool      doprint,found;
1290298fd71SBarry Smith   PetscViewer    viewer, sviewer = NULL;
1308f3b4b4dSDmitry Karpeev   PetscInt       *numbering,*permutation;/* global numbering of locally-supported subdomains and the permutation from the local ordering */
13106b43e7eSDmitry Karpeev   PetscErrorCode ierr;
13206b43e7eSDmitry Karpeev 
13306b43e7eSDmitry Karpeev   PetscFunctionBegin;
13406b43e7eSDmitry Karpeev   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
1358f3b4b4dSDmitry Karpeev   doprint  = PETSC_FALSE;
136c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,prefix,"-pc_gasm_print_subdomains",&doprint,NULL);CHKERRQ(ierr);
1378f3b4b4dSDmitry Karpeev   if (!doprint) PetscFunctionReturn(0);
138c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,prefix,"-pc_gasm_print_subdomains",fname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr);
13906b43e7eSDmitry Karpeev   if (!found) { ierr = PetscStrcpy(fname,"stdout");CHKERRQ(ierr); };
140ce94432eSBarry Smith   ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)pc),fname,&viewer);CHKERRQ(ierr);
1414bde246dSDmitry Karpeev   /*
1424bde246dSDmitry Karpeev    Make sure the viewer has a name. Otherwise this may cause a deadlock or other weird errors when creating a subcomm viewer:
1434bde246dSDmitry Karpeev    the subcomm viewer will attempt to inherit the viewer's name, which, if not set, will be constructed collectively on the comm.
1444bde246dSDmitry Karpeev   */
1454bde246dSDmitry Karpeev   ierr = PetscObjectName((PetscObject)viewer);CHKERRQ(ierr);
1464bde246dSDmitry Karpeev   l    = 0;
1478f3b4b4dSDmitry Karpeev   ierr = PCGASMComputeGlobalSubdomainNumbering_Private(pc,&numbering,&permutation);CHKERRQ(ierr);
1488f3b4b4dSDmitry Karpeev   for (count = 0; count < osm->N; ++count) {
1494bde246dSDmitry Karpeev     /* Now let subdomains go one at a time in the global numbering order and print their subdomain/solver info. */
1504bde246dSDmitry Karpeev     if (l<osm->n) {
1514bde246dSDmitry Karpeev       d = permutation[l]; /* d is the local number of the l-th smallest (in the global ordering) among the locally supported subdomains */
1524bde246dSDmitry Karpeev       if (numbering[d] == count) {
1533f08860eSBarry Smith         ierr = PetscViewerGetSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
1544bde246dSDmitry Karpeev         ierr = PCGASMSubdomainView_Private(pc,d,sviewer);CHKERRQ(ierr);
1553f08860eSBarry Smith         ierr = PetscViewerRestoreSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
1564bde246dSDmitry Karpeev         ++l;
157af538404SDmitry Karpeev       }
1584bde246dSDmitry Karpeev     }
159ce94432eSBarry Smith     ierr = MPI_Barrier(PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1604bde246dSDmitry Karpeev   }
1618f3b4b4dSDmitry Karpeev   ierr = PetscFree2(numbering,permutation);CHKERRQ(ierr);
1624bde246dSDmitry Karpeev   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
163af538404SDmitry Karpeev   PetscFunctionReturn(0);
164af538404SDmitry Karpeev }
165af538404SDmitry Karpeev 
166af538404SDmitry Karpeev 
167f746d493SDmitry Karpeev static PetscErrorCode PCView_GASM(PC pc,PetscViewer viewer)
168b1a0a8a3SJed Brown {
169f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
170af538404SDmitry Karpeev   const char     *prefix;
171b1a0a8a3SJed Brown   PetscErrorCode ierr;
172af538404SDmitry Karpeev   PetscMPIInt    rank, size;
1738f3b4b4dSDmitry Karpeev   PetscInt       bsz;
17406b43e7eSDmitry Karpeev   PetscBool      iascii,view_subdomains=PETSC_FALSE;
175b1a0a8a3SJed Brown   PetscViewer    sviewer;
1768f3b4b4dSDmitry Karpeev   PetscInt       count, l;
1776a4f0f73SDmitry Karpeev   char           overlap[256]     = "user-defined overlap";
1786a4f0f73SDmitry Karpeev   char           gsubdomains[256] = "unknown total number of subdomains";
17906b43e7eSDmitry Karpeev   char           msubdomains[256] = "unknown max number of local subdomains";
1808f3b4b4dSDmitry Karpeev   PetscInt       *numbering,*permutation;/* global numbering of locally-supported subdomains and the permutation from the local ordering */
18111aeaf0aSBarry Smith 
182b1a0a8a3SJed Brown   PetscFunctionBegin;
183ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size);CHKERRQ(ierr);
184ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank);CHKERRQ(ierr);
18506b43e7eSDmitry Karpeev 
18606b43e7eSDmitry Karpeev   if (osm->overlap >= 0) {
18706b43e7eSDmitry Karpeev     ierr = PetscSNPrintf(overlap,sizeof(overlap),"requested amount of overlap = %D",osm->overlap);CHKERRQ(ierr);
18806b43e7eSDmitry Karpeev   }
1898f3b4b4dSDmitry Karpeev   if (osm->N != PETSC_DETERMINE) {
1908f3b4b4dSDmitry Karpeev     ierr = PetscSNPrintf(gsubdomains, sizeof(gsubdomains), "total number of subdomains = %D",osm->N);CHKERRQ(ierr);
19106b43e7eSDmitry Karpeev   }
1928f3b4b4dSDmitry Karpeev   if (osm->nmax != PETSC_DETERMINE) {
19306b43e7eSDmitry Karpeev     ierr = PetscSNPrintf(msubdomains,sizeof(msubdomains),"max number of local subdomains = %D",osm->nmax);CHKERRQ(ierr);
19406b43e7eSDmitry Karpeev   }
19506b43e7eSDmitry Karpeev 
196af538404SDmitry Karpeev   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
197c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,prefix,"-pc_gasm_view_subdomains",&view_subdomains,NULL);CHKERRQ(ierr);
19806b43e7eSDmitry Karpeev 
19906b43e7eSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
200b1a0a8a3SJed Brown   if (iascii) {
20106b43e7eSDmitry Karpeev     /*
20206b43e7eSDmitry Karpeev      Make sure the viewer has a name. Otherwise this may cause a deadlock when creating a subcomm viewer:
20306b43e7eSDmitry Karpeev      the subcomm viewer will attempt to inherit the viewer's name, which, if not set, will be constructed
20406b43e7eSDmitry Karpeev      collectively on the comm.
20506b43e7eSDmitry Karpeev      */
20606b43e7eSDmitry Karpeev     ierr = PetscObjectName((PetscObject)viewer);CHKERRQ(ierr);
20706b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"  Restriction/interpolation type: %s\n",PCGASMTypes[osm->type]);CHKERRQ(ierr);
20806b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"  %s\n",overlap);CHKERRQ(ierr);
20906b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"  %s\n",gsubdomains);CHKERRQ(ierr);
21006b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"  %s\n",msubdomains);CHKERRQ(ierr);
2111575c14dSBarry Smith     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
2128f3b4b4dSDmitry Karpeev     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"  [%d|%d] number of locally-supported subdomains = %D\n",rank,size,osm->n);CHKERRQ(ierr);
213af538404SDmitry Karpeev     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2141575c14dSBarry Smith     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
2156a4f0f73SDmitry Karpeev     /* Cannot take advantage of osm->same_subdomain_solvers without a global numbering of subdomains. */
21606b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"  Subdomain solver info is as follows:\n");CHKERRQ(ierr);
217b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
218b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"  - - - - - - - - - - - - - - - - - -\n");CHKERRQ(ierr);
21906b43e7eSDmitry Karpeev     /* Make sure that everybody waits for the banner to be printed. */
220ce94432eSBarry Smith     ierr = MPI_Barrier(PetscObjectComm((PetscObject)viewer));CHKERRQ(ierr);
2214bde246dSDmitry Karpeev     /* Now let subdomains go one at a time in the global numbering order and print their subdomain/solver info. */
2228f3b4b4dSDmitry Karpeev     ierr = PCGASMComputeGlobalSubdomainNumbering_Private(pc,&numbering,&permutation);CHKERRQ(ierr);
22306b43e7eSDmitry Karpeev     l = 0;
2248f3b4b4dSDmitry Karpeev     for (count = 0; count < osm->N; ++count) {
22506b43e7eSDmitry Karpeev       PetscMPIInt srank, ssize;
22606b43e7eSDmitry Karpeev       if (l<osm->n) {
22706b43e7eSDmitry Karpeev         PetscInt d = permutation[l]; /* d is the local number of the l-th smallest (in the global ordering) among the locally supported subdomains */
22806b43e7eSDmitry Karpeev         if (numbering[d] == count) {
2296a4f0f73SDmitry Karpeev           ierr = MPI_Comm_size(((PetscObject)osm->ois[d])->comm, &ssize);CHKERRQ(ierr);
2306a4f0f73SDmitry Karpeev           ierr = MPI_Comm_rank(((PetscObject)osm->ois[d])->comm, &srank);CHKERRQ(ierr);
2313f08860eSBarry Smith           ierr = PetscViewerGetSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
2326a4f0f73SDmitry Karpeev           ierr = ISGetLocalSize(osm->ois[d],&bsz);CHKERRQ(ierr);
2338f3b4b4dSDmitry 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);
2346a4f0f73SDmitry Karpeev           ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
23506b43e7eSDmitry Karpeev           if (view_subdomains) {
23606b43e7eSDmitry Karpeev             ierr = PCGASMSubdomainView_Private(pc,d,sviewer);CHKERRQ(ierr);
23706b43e7eSDmitry Karpeev           }
2386a4f0f73SDmitry Karpeev           if (!pc->setupcalled) {
2391575c14dSBarry Smith             ierr = PetscViewerASCIIPrintf(sviewer, "  Solver not set up yet: PCSetUp() not yet called\n");CHKERRQ(ierr);
2402fa5cd67SKarl Rupp           } else {
24106b43e7eSDmitry Karpeev             ierr = KSPView(osm->ksp[d],sviewer);CHKERRQ(ierr);
2426a4f0f73SDmitry Karpeev           }
24306b43e7eSDmitry Karpeev           ierr = PetscViewerASCIIPrintf(sviewer,"  - - - - - - - - - - - - - - - - - -\n");CHKERRQ(ierr);
2447b23a99aSBarry Smith           ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
2453f08860eSBarry Smith           ierr = PetscViewerRestoreSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
24606b43e7eSDmitry Karpeev           ++l;
247b1a0a8a3SJed Brown         }
24806b43e7eSDmitry Karpeev       }
249ce94432eSBarry Smith       ierr = MPI_Barrier(PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
250b1a0a8a3SJed Brown     }
2518f3b4b4dSDmitry Karpeev     ierr = PetscFree2(numbering,permutation);CHKERRQ(ierr);
252b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
253b1a0a8a3SJed Brown   }
254c5e4d11fSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2551575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
256b1a0a8a3SJed Brown   PetscFunctionReturn(0);
257b1a0a8a3SJed Brown }
258b1a0a8a3SJed Brown 
2598f3b4b4dSDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[]);
260af538404SDmitry Karpeev 
261ea91fabdSFande Kong 
262ea91fabdSFande Kong 
263ea91fabdSFande Kong PetscErrorCode PCGASMSetHierarchicalPartitioning(PC pc)
264ea91fabdSFande Kong {
265ea91fabdSFande Kong    PC_GASM              *osm = (PC_GASM*)pc->data;
266ea91fabdSFande Kong    MatPartitioning       part;
267ea91fabdSFande Kong    MPI_Comm              comm;
268ea91fabdSFande Kong    PetscMPIInt           size;
269ea91fabdSFande Kong    PetscInt              nlocalsubdomains,fromrows_localsize;
270ea91fabdSFande Kong    IS                    partitioning,fromrows,isn;
271ea91fabdSFande Kong    Vec                   outervec;
272ea91fabdSFande Kong    PetscErrorCode        ierr;
273ea91fabdSFande Kong 
274ea91fabdSFande Kong    PetscFunctionBegin;
275ea91fabdSFande Kong    ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
276ea91fabdSFande Kong    ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
277ea91fabdSFande Kong    /* we do not need a hierarchical partitioning when
278ea91fabdSFande Kong     * the total number of subdomains is consistent with
279ea91fabdSFande Kong     * the number of MPI tasks.
280ea91fabdSFande Kong     * For the following cases, we do not need to use HP
281ea91fabdSFande Kong     * */
282670417b2SFande Kong    if(osm->N==PETSC_DETERMINE || osm->N>=size || osm->N==1) PetscFunctionReturn(0);
283670417b2SFande 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);
284ea91fabdSFande Kong    nlocalsubdomains = size/osm->N;
285ea91fabdSFande Kong    osm->n           = 1;
286ea91fabdSFande Kong    ierr = MatPartitioningCreate(comm,&part);CHKERRQ(ierr);
287ea91fabdSFande Kong    ierr = MatPartitioningSetAdjacency(part,pc->pmat);CHKERRQ(ierr);
288ea91fabdSFande Kong    ierr = MatPartitioningSetType(part,MATPARTITIONINGHIERARCH);CHKERRQ(ierr);
289ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNcoarseparts(part,osm->N);CHKERRQ(ierr);
290ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNfineparts(part,nlocalsubdomains);CHKERRQ(ierr);
291ea91fabdSFande Kong    ierr = MatPartitioningSetFromOptions(part);CHKERRQ(ierr);
292ea91fabdSFande Kong    /* get new processor owner number of each vertex */
293ea91fabdSFande Kong    ierr = MatPartitioningApply(part,&partitioning);CHKERRQ(ierr);
294ea91fabdSFande Kong    ierr = ISBuildTwoSided(partitioning,NULL,&fromrows);CHKERRQ(ierr);
295ea91fabdSFande Kong    ierr = ISPartitioningToNumbering(partitioning,&isn);CHKERRQ(ierr);
296ea91fabdSFande Kong    ierr = ISDestroy(&isn);CHKERRQ(ierr);
297ea91fabdSFande Kong    ierr = ISGetLocalSize(fromrows,&fromrows_localsize);CHKERRQ(ierr);
298ea91fabdSFande Kong    ierr = MatPartitioningDestroy(&part);CHKERRQ(ierr);
299ea91fabdSFande Kong    ierr = MatCreateVecs(pc->pmat,&outervec,NULL);CHKERRQ(ierr);
300ea91fabdSFande Kong    ierr = VecCreateMPI(comm,fromrows_localsize,PETSC_DETERMINE,&(osm->pcx));CHKERRQ(ierr);
301ea91fabdSFande Kong    ierr = VecDuplicate(osm->pcx,&(osm->pcy));CHKERRQ(ierr);
3029448b7f1SJunchao Zhang    ierr = VecScatterCreate(osm->pcx,NULL,outervec,fromrows,&(osm->pctoouter));CHKERRQ(ierr);
3037dae84e0SHong Zhang    ierr = MatCreateSubMatrix(pc->pmat,fromrows,fromrows,MAT_INITIAL_MATRIX,&(osm->permutationP));CHKERRQ(ierr);
304ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)fromrows);CHKERRQ(ierr);
305ea91fabdSFande Kong    osm->permutationIS = fromrows;
306ea91fabdSFande Kong    osm->pcmat =  pc->pmat;
307ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
308ea91fabdSFande Kong    pc->pmat = osm->permutationP;
309ea91fabdSFande Kong    ierr = VecDestroy(&outervec);CHKERRQ(ierr);
310ea91fabdSFande Kong    ierr = ISDestroy(&fromrows);CHKERRQ(ierr);
311ea91fabdSFande Kong    ierr = ISDestroy(&partitioning);CHKERRQ(ierr);
312ea91fabdSFande Kong    osm->n           = PETSC_DETERMINE;
313ea91fabdSFande Kong    PetscFunctionReturn(0);
314ea91fabdSFande Kong }
315ea91fabdSFande Kong 
316ea91fabdSFande Kong 
317ea91fabdSFande Kong 
318f746d493SDmitry Karpeev static PetscErrorCode PCSetUp_GASM(PC pc)
319b1a0a8a3SJed Brown {
320f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
321b1a0a8a3SJed Brown   PetscErrorCode ierr;
322b1a0a8a3SJed Brown   PetscBool      symset,flg;
323ea91fabdSFande Kong   PetscInt       i,nInnerIndices,nTotalInnerIndices;
324c10bc1a1SDmitry Karpeev   PetscMPIInt    rank, size;
325b1a0a8a3SJed Brown   MatReuse       scall = MAT_REUSE_MATRIX;
326b1a0a8a3SJed Brown   KSP            ksp;
327b1a0a8a3SJed Brown   PC             subpc;
328b1a0a8a3SJed Brown   const char     *prefix,*pprefix;
329f746d493SDmitry Karpeev   Vec            x,y;
3306a4f0f73SDmitry Karpeev   PetscInt       oni;       /* Number of indices in the i-th local outer subdomain.               */
3316a4f0f73SDmitry Karpeev   const PetscInt *oidxi;    /* Indices from the i-th subdomain local outer subdomain.             */
3326a4f0f73SDmitry Karpeev   PetscInt       on;        /* Number of indices in the disjoint union of local outer subdomains. */
3336a4f0f73SDmitry Karpeev   PetscInt       *oidx;     /* Indices in the disjoint union of local outer subdomains. */
3346a4f0f73SDmitry Karpeev   IS             gois;      /* Disjoint union the global indices of outer subdomains.             */
3356a4f0f73SDmitry Karpeev   IS             goid;      /* Identity IS of the size of the disjoint union of outer subdomains. */
336f746d493SDmitry Karpeev   PetscScalar    *gxarray, *gyarray;
337930d09c1SFande Kong   PetscInt       gostart;   /* Start of locally-owned indices in the vectors -- osm->gx,osm->gy -- over the disjoint union of outer subdomains. */
3388f3b4b4dSDmitry Karpeev   PetscInt       num_subdomains    = 0;
3390298fd71SBarry Smith   DM             *subdomain_dm     = NULL;
3408f3b4b4dSDmitry Karpeev   char           **subdomain_names = NULL;
341f771a274SFande Kong   PetscInt       *numbering;
3428f3b4b4dSDmitry Karpeev 
343b1a0a8a3SJed Brown 
344b1a0a8a3SJed Brown   PetscFunctionBegin;
345ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
346ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
347b1a0a8a3SJed Brown   if (!pc->setupcalled) {
348ea91fabdSFande Kong 	/* use a hierarchical partitioning */
349ea91fabdSFande Kong     if(osm->hierarchicalpartitioning){
350ea91fabdSFande Kong       ierr = PCGASMSetHierarchicalPartitioning(pc);CHKERRQ(ierr);
351ea91fabdSFande Kong     }
352b1a0a8a3SJed Brown     if (!osm->type_set) {
353b1a0a8a3SJed Brown       ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
3542fa5cd67SKarl Rupp       if (symset && flg) osm->type = PC_GASM_BASIC;
355b1a0a8a3SJed Brown     }
356b1a0a8a3SJed Brown 
3578f3b4b4dSDmitry Karpeev     if (osm->n == PETSC_DETERMINE) {
3588f3b4b4dSDmitry Karpeev       if (osm->N != PETSC_DETERMINE) {
3598f3b4b4dSDmitry Karpeev 	   /* No local subdomains given, but the desired number of total subdomains is known, so construct them accordingly. */
3608f3b4b4dSDmitry Karpeev 	   ierr = PCGASMCreateSubdomains(pc->pmat,osm->N,&osm->n,&osm->iis);CHKERRQ(ierr);
3618f3b4b4dSDmitry Karpeev       } else if (osm->dm_subdomains && pc->dm) {
3628f3b4b4dSDmitry Karpeev 	/* try pc->dm next, if allowed */
3638f3b4b4dSDmitry Karpeev 	PetscInt  d;
364a35b7b57SDmitry Karpeev 	IS       *inner_subdomain_is, *outer_subdomain_is;
365a35b7b57SDmitry Karpeev 	ierr = DMCreateDomainDecomposition(pc->dm, &num_subdomains, &subdomain_names, &inner_subdomain_is, &outer_subdomain_is, &subdomain_dm);CHKERRQ(ierr);
366a35b7b57SDmitry Karpeev 	if (num_subdomains) {
367a35b7b57SDmitry Karpeev 	  ierr = PCGASMSetSubdomains(pc, num_subdomains, inner_subdomain_is, outer_subdomain_is);CHKERRQ(ierr);
36869ca1f37SDmitry Karpeev 	}
369a35b7b57SDmitry Karpeev 	for (d = 0; d < num_subdomains; ++d) {
370a35b7b57SDmitry Karpeev 	  if (inner_subdomain_is) {ierr = ISDestroy(&inner_subdomain_is[d]);CHKERRQ(ierr);}
371a35b7b57SDmitry Karpeev 	  if (outer_subdomain_is) {ierr = ISDestroy(&outer_subdomain_is[d]);CHKERRQ(ierr);}
372fdc48646SDmitry Karpeev 	}
373a35b7b57SDmitry Karpeev 	ierr = PetscFree(inner_subdomain_is);CHKERRQ(ierr);
374a35b7b57SDmitry Karpeev 	ierr = PetscFree(outer_subdomain_is);CHKERRQ(ierr);
3758f3b4b4dSDmitry Karpeev       } else {
3768f3b4b4dSDmitry Karpeev 	/* still no subdomains; use one per processor */
37744fe18e5SDmitry Karpeev 	osm->nmax = osm->n = 1;
378ce94432eSBarry Smith 	ierr      = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
379f746d493SDmitry Karpeev 	osm->N    = size;
3808f3b4b4dSDmitry Karpeev 	ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
381fdc48646SDmitry Karpeev       }
38206b43e7eSDmitry Karpeev     }
383a35b7b57SDmitry Karpeev     if (!osm->iis) {
384a35b7b57SDmitry Karpeev       /*
3858f3b4b4dSDmitry Karpeev        osm->n was set in PCGASMSetSubdomains(), but the actual subdomains have not been supplied.
3868f3b4b4dSDmitry Karpeev        We create the requisite number of local inner subdomains and then expand them into
3878f3b4b4dSDmitry Karpeev        out subdomains, if necessary.
388a35b7b57SDmitry Karpeev        */
3898f3b4b4dSDmitry Karpeev       ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
390a35b7b57SDmitry Karpeev     }
3918f3b4b4dSDmitry Karpeev     if (!osm->ois) {
3928f3b4b4dSDmitry Karpeev       /*
3938f3b4b4dSDmitry Karpeev 	    Initially make outer subdomains the same as inner subdomains. If nonzero additional overlap
3948f3b4b4dSDmitry Karpeev 	    has been requested, copy the inner subdomains over so they can be modified.
3958f3b4b4dSDmitry Karpeev       */
3968f3b4b4dSDmitry Karpeev       ierr = PetscMalloc1(osm->n,&osm->ois);CHKERRQ(ierr);
3978f3b4b4dSDmitry Karpeev       for (i=0; i<osm->n; ++i) {
398ea91fabdSFande Kong 	if (osm->overlap > 0 && osm->N>1) { /* With positive overlap, osm->iis[i] will be modified */
3998f3b4b4dSDmitry Karpeev 	  ierr = ISDuplicate(osm->iis[i],(osm->ois)+i);CHKERRQ(ierr);
4008f3b4b4dSDmitry Karpeev 	  ierr = ISCopy(osm->iis[i],osm->ois[i]);CHKERRQ(ierr);
4018f3b4b4dSDmitry Karpeev 	} else {
4028f3b4b4dSDmitry Karpeev 	  ierr      = PetscObjectReference((PetscObject)((osm->iis)[i]));CHKERRQ(ierr);
4038f3b4b4dSDmitry Karpeev 	  osm->ois[i] = osm->iis[i];
4048f3b4b4dSDmitry Karpeev 	}
4058f3b4b4dSDmitry Karpeev       }
406ea91fabdSFande Kong       if (osm->overlap>0 && osm->N>1) {
4078f3b4b4dSDmitry Karpeev 	   /* Extend the "overlapping" regions by a number of steps */
408d21f2a47SFande Kong 	   ierr = MatIncreaseOverlapSplit(pc->pmat,osm->n,osm->ois,osm->overlap);CHKERRQ(ierr);
4098f3b4b4dSDmitry Karpeev       }
410b1a0a8a3SJed Brown     }
4116a4f0f73SDmitry Karpeev 
4128f3b4b4dSDmitry Karpeev     /* Now the subdomains are defined.  Determine their global and max local numbers, if necessary. */
4138f3b4b4dSDmitry Karpeev     if (osm->nmax == PETSC_DETERMINE) {
4148f3b4b4dSDmitry Karpeev       PetscMPIInt inwork,outwork;
4158f3b4b4dSDmitry Karpeev       /* determine global number of subdomains and the max number of local subdomains */
4168f3b4b4dSDmitry Karpeev       inwork = osm->n;
417b2566f29SBarry Smith       ierr       = MPIU_Allreduce(&inwork,&outwork,1,MPI_INT,MPI_MAX,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
4188f3b4b4dSDmitry Karpeev       osm->nmax  = outwork;
4198f3b4b4dSDmitry Karpeev     }
4208f3b4b4dSDmitry Karpeev     if (osm->N == PETSC_DETERMINE) {
4218f3b4b4dSDmitry Karpeev       /* Determine the number of globally-distinct subdomains and compute a global numbering for them. */
4228f3b4b4dSDmitry Karpeev       ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,&osm->N,NULL);CHKERRQ(ierr);
4238f3b4b4dSDmitry Karpeev     }
4248f3b4b4dSDmitry Karpeev 
425b1a0a8a3SJed Brown 
426b1a0a8a3SJed Brown     if (osm->sort_indices) {
427f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4286a4f0f73SDmitry Karpeev         ierr = ISSort(osm->ois[i]);CHKERRQ(ierr);
4296a4f0f73SDmitry Karpeev         ierr = ISSort(osm->iis[i]);CHKERRQ(ierr);
430b1a0a8a3SJed Brown       }
431b1a0a8a3SJed Brown     }
4328f3b4b4dSDmitry Karpeev     ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
4338f3b4b4dSDmitry Karpeev     ierr = PCGASMPrintSubdomains(pc);CHKERRQ(ierr);
4348f3b4b4dSDmitry Karpeev 
4356a4f0f73SDmitry Karpeev     /*
4366a4f0f73SDmitry Karpeev        Merge the ISs, create merged vectors and restrictions.
4376a4f0f73SDmitry Karpeev      */
4386a4f0f73SDmitry Karpeev     /* Merge outer subdomain ISs and construct a restriction onto the disjoint union of local outer subdomains. */
4396a4f0f73SDmitry Karpeev     on = 0;
440f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4416a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4426a4f0f73SDmitry Karpeev       on  += oni;
443f746d493SDmitry Karpeev     }
444785e854fSJed Brown     ierr = PetscMalloc1(on, &oidx);CHKERRQ(ierr);
4456a4f0f73SDmitry Karpeev     on   = 0;
446930d09c1SFande Kong     /* Merge local indices together */
447f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4486a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4496a4f0f73SDmitry Karpeev       ierr = ISGetIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
450580bdb30SBarry Smith       ierr = PetscArraycpy(oidx+on,oidxi,oni);CHKERRQ(ierr);
4516a4f0f73SDmitry Karpeev       ierr = ISRestoreIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4526a4f0f73SDmitry Karpeev       on  += oni;
453f746d493SDmitry Karpeev     }
4546a4f0f73SDmitry Karpeev     ierr = ISCreateGeneral(((PetscObject)(pc))->comm,on,oidx,PETSC_OWN_POINTER,&gois);CHKERRQ(ierr);
455ea91fabdSFande Kong     nTotalInnerIndices = 0;
456ea91fabdSFande Kong     for(i=0; i<osm->n; i++){
457ea91fabdSFande Kong       ierr = ISGetLocalSize(osm->iis[i],&nInnerIndices);CHKERRQ(ierr);
458ea91fabdSFande Kong       nTotalInnerIndices += nInnerIndices;
459ea91fabdSFande Kong     }
460ea91fabdSFande Kong     ierr = VecCreateMPI(((PetscObject)(pc))->comm,nTotalInnerIndices,PETSC_DETERMINE,&x);CHKERRQ(ierr);
461ea91fabdSFande Kong     ierr = VecDuplicate(x,&y);CHKERRQ(ierr);
462ea91fabdSFande Kong 
463ce94432eSBarry Smith     ierr = VecCreateMPI(PetscObjectComm((PetscObject)pc),on,PETSC_DECIDE,&osm->gx);CHKERRQ(ierr);
464f746d493SDmitry Karpeev     ierr = VecDuplicate(osm->gx,&osm->gy);CHKERRQ(ierr);
465930d09c1SFande Kong     ierr = VecGetOwnershipRange(osm->gx, &gostart, NULL);CHKERRQ(ierr);
466930d09c1SFande Kong     ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),on,gostart,1, &goid);CHKERRQ(ierr);
467930d09c1SFande Kong     /* gois might indices not on local */
4689448b7f1SJunchao Zhang     ierr = VecScatterCreate(x,gois,osm->gx,goid, &(osm->gorestriction));CHKERRQ(ierr);
469f771a274SFande Kong     ierr = PetscMalloc1(osm->n,&numbering);CHKERRQ(ierr);
470f771a274SFande Kong     ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,NULL,numbering);CHKERRQ(ierr);
4716a4f0f73SDmitry Karpeev     ierr = VecDestroy(&x);CHKERRQ(ierr);
4727105d80bSDmitry Karpeev     ierr = ISDestroy(&gois);CHKERRQ(ierr);
4732fa5cd67SKarl Rupp 
4746a4f0f73SDmitry Karpeev     /* Merge inner subdomain ISs and construct a restriction onto the disjoint union of local inner subdomains. */
4752fa5cd67SKarl Rupp     {
4762fa5cd67SKarl Rupp       PetscInt        ini;           /* Number of indices the i-th a local inner subdomain. */
4776a4f0f73SDmitry Karpeev       PetscInt        in;            /* Number of indices in the disjoint uniont of local inner subdomains. */
4786a4f0f73SDmitry Karpeev       PetscInt       *iidx;          /* Global indices in the merged local inner subdomain. */
4796a4f0f73SDmitry Karpeev       PetscInt       *ioidx;         /* Global indices of the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
4806a4f0f73SDmitry Karpeev       IS              giis;          /* IS for the disjoint union of inner subdomains. */
4816a4f0f73SDmitry Karpeev       IS              giois;         /* IS for the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
482f771a274SFande Kong       PetscScalar    *array;
483f771a274SFande Kong       const PetscInt *indices;
484f771a274SFande Kong       PetscInt        k;
4856a4f0f73SDmitry Karpeev       on = 0;
486f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4876a4f0f73SDmitry Karpeev         ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4886a4f0f73SDmitry Karpeev         on  += oni;
489f746d493SDmitry Karpeev       }
490f771a274SFande Kong       ierr = PetscMalloc1(on, &iidx);CHKERRQ(ierr);
491f771a274SFande Kong       ierr = PetscMalloc1(on, &ioidx);CHKERRQ(ierr);
492f771a274SFande Kong       ierr = VecGetArray(y,&array);CHKERRQ(ierr);
493e12b4729SFande Kong       /* set communicator id to determine where overlap is */
494f771a274SFande Kong       in   = 0;
495f771a274SFande Kong       for (i=0; i<osm->n; i++) {
496f771a274SFande Kong         ierr   = ISGetLocalSize(osm->iis[i],&ini);CHKERRQ(ierr);
497f771a274SFande Kong         for (k = 0; k < ini; ++k){
498f771a274SFande Kong           array[in+k] = numbering[i];
499f771a274SFande Kong         }
500f771a274SFande Kong         in += ini;
501f771a274SFande Kong       }
502f771a274SFande Kong       ierr = VecRestoreArray(y,&array);CHKERRQ(ierr);
503f771a274SFande Kong       ierr = VecScatterBegin(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
504f771a274SFande Kong       ierr = VecScatterEnd(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
505f771a274SFande Kong       ierr = VecGetOwnershipRange(osm->gy,&gostart, NULL);CHKERRQ(ierr);
506f771a274SFande Kong       ierr = VecGetArray(osm->gy,&array);CHKERRQ(ierr);
507f771a274SFande Kong       on  = 0;
508f771a274SFande Kong       in  = 0;
509f771a274SFande Kong       for (i=0; i<osm->n; i++) {
510f771a274SFande Kong     	ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
511f771a274SFande Kong     	ierr = ISGetIndices(osm->ois[i],&indices);CHKERRQ(ierr);
512f771a274SFande Kong     	for (k=0; k<oni; k++) {
513e12b4729SFande Kong           /*  skip overlapping indices to get inner domain */
51443081b6cSDmitry Karpeev           if(PetscRealPart(array[on+k]) != numbering[i]) continue;
515f771a274SFande Kong           iidx[in]    = indices[k];
516f771a274SFande Kong           ioidx[in++] = gostart+on+k;
517f771a274SFande Kong     	}
518f771a274SFande Kong     	ierr   = ISRestoreIndices(osm->ois[i], &indices);CHKERRQ(ierr);
519f771a274SFande Kong     	on += oni;
520f771a274SFande Kong       }
521f771a274SFande Kong       ierr = VecRestoreArray(osm->gy,&array);CHKERRQ(ierr);
522ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,iidx,PETSC_OWN_POINTER,&giis);CHKERRQ(ierr);
523ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,ioidx,PETSC_OWN_POINTER,&giois);CHKERRQ(ierr);
5249448b7f1SJunchao Zhang       ierr = VecScatterCreate(y,giis,osm->gy,giois,&osm->girestriction);CHKERRQ(ierr);
5256a4f0f73SDmitry Karpeev       ierr = VecDestroy(&y);CHKERRQ(ierr);
5266a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giis);CHKERRQ(ierr);
5276a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giois);CHKERRQ(ierr);
528b1a0a8a3SJed Brown     }
5296a4f0f73SDmitry Karpeev     ierr = ISDestroy(&goid);CHKERRQ(ierr);
530f771a274SFande Kong     ierr = PetscFree(numbering);CHKERRQ(ierr);
5312fa5cd67SKarl Rupp 
532f746d493SDmitry Karpeev     /* Create the subdomain work vectors. */
533785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->x);CHKERRQ(ierr);
534785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->y);CHKERRQ(ierr);
535f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gx, &gxarray);CHKERRQ(ierr);
536f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gy, &gyarray);CHKERRQ(ierr);
5376a4f0f73SDmitry Karpeev     for (i=0, on=0; i<osm->n; ++i, on += oni) {
5386a4f0f73SDmitry Karpeev       PetscInt oNi;
5396a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
540930d09c1SFande Kong       /* on a sub communicator */
5416a4f0f73SDmitry Karpeev       ierr = ISGetSize(osm->ois[i],&oNi);CHKERRQ(ierr);
5426a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gxarray+on,&osm->x[i]);CHKERRQ(ierr);
5436a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gyarray+on,&osm->y[i]);CHKERRQ(ierr);
544b1a0a8a3SJed Brown     }
545f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gx, &gxarray);CHKERRQ(ierr);
546f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gy, &gyarray);CHKERRQ(ierr);
5478f3b4b4dSDmitry Karpeev     /* Create the subdomain solvers */
548785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->ksp);CHKERRQ(ierr);
5498f3b4b4dSDmitry Karpeev     for (i=0; i<osm->n; i++) {
5508f3b4b4dSDmitry Karpeev       char subprefix[PETSC_MAX_PATH_LEN+1];
5516a4f0f73SDmitry Karpeev       ierr        = KSPCreate(((PetscObject)(osm->ois[i]))->comm,&ksp);CHKERRQ(ierr);
55266b14c46SBarry Smith       ierr        = KSPSetErrorIfNotConverged(ksp,pc->erroriffailure);CHKERRQ(ierr);
5533bb1ff40SBarry Smith       ierr        = PetscLogObjectParent((PetscObject)pc,(PetscObject)ksp);CHKERRQ(ierr);
554b1a0a8a3SJed Brown       ierr        = PetscObjectIncrementTabLevel((PetscObject)ksp,(PetscObject)pc,1);CHKERRQ(ierr);
555b1a0a8a3SJed Brown       ierr        = KSPSetType(ksp,KSPPREONLY);CHKERRQ(ierr);
5568f3b4b4dSDmitry Karpeev       ierr        = KSPGetPC(ksp,&subpc);CHKERRQ(ierr); /* Why do we need this here? */
5578f3b4b4dSDmitry Karpeev       if (subdomain_dm) {
5588f3b4b4dSDmitry Karpeev 	    ierr = KSPSetDM(ksp,subdomain_dm[i]);CHKERRQ(ierr);
5598f3b4b4dSDmitry Karpeev 	    ierr = DMDestroy(subdomain_dm+i);CHKERRQ(ierr);
5608f3b4b4dSDmitry Karpeev       }
561b1a0a8a3SJed Brown       ierr        = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
562b1a0a8a3SJed Brown       ierr        = KSPSetOptionsPrefix(ksp,prefix);CHKERRQ(ierr);
5638f3b4b4dSDmitry Karpeev       if (subdomain_names && subdomain_names[i]) {
5648f3b4b4dSDmitry Karpeev 	     ierr = PetscSNPrintf(subprefix,PETSC_MAX_PATH_LEN,"sub_%s_",subdomain_names[i]);CHKERRQ(ierr);
5658f3b4b4dSDmitry Karpeev 	     ierr = KSPAppendOptionsPrefix(ksp,subprefix);CHKERRQ(ierr);
5668f3b4b4dSDmitry Karpeev 	     ierr = PetscFree(subdomain_names[i]);CHKERRQ(ierr);
5678f3b4b4dSDmitry Karpeev       }
568b1a0a8a3SJed Brown       ierr        = KSPAppendOptionsPrefix(ksp,"sub_");CHKERRQ(ierr);
569b1a0a8a3SJed Brown       osm->ksp[i] = ksp;
570b1a0a8a3SJed Brown     }
5718f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_dm);CHKERRQ(ierr);
5728f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_names);CHKERRQ(ierr);
573b1a0a8a3SJed Brown     scall = MAT_INITIAL_MATRIX;
574b1a0a8a3SJed Brown 
5758f3b4b4dSDmitry Karpeev   } else { /* if (pc->setupcalled) */
576b1a0a8a3SJed Brown     /*
5778f3b4b4dSDmitry Karpeev        Destroy the submatrices from the previous iteration
578b1a0a8a3SJed Brown     */
579b1a0a8a3SJed Brown     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
580f746d493SDmitry Karpeev       ierr  = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
581b1a0a8a3SJed Brown       scall = MAT_INITIAL_MATRIX;
582b1a0a8a3SJed Brown     }
583ea91fabdSFande Kong     if(osm->permutationIS){
5847dae84e0SHong Zhang       ierr = MatCreateSubMatrix(pc->pmat,osm->permutationIS,osm->permutationIS,scall,&osm->permutationP);CHKERRQ(ierr);
585ea91fabdSFande Kong       ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
586ea91fabdSFande Kong       osm->pcmat = pc->pmat;
587ea91fabdSFande Kong       pc->pmat   = osm->permutationP;
588b1a0a8a3SJed Brown     }
589b1a0a8a3SJed Brown 
590ea91fabdSFande Kong   }
591ea91fabdSFande Kong 
592ea91fabdSFande Kong 
593b1a0a8a3SJed Brown   /*
594f746d493SDmitry Karpeev      Extract out the submatrices.
595b1a0a8a3SJed Brown   */
59681a5c4aaSDmitry Karpeev   if (size > 1) {
5977dae84e0SHong Zhang     ierr = MatCreateSubMatricesMPI(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
5982fa5cd67SKarl Rupp   } else {
5997dae84e0SHong Zhang     ierr = MatCreateSubMatrices(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
60081a5c4aaSDmitry Karpeev   }
601b1a0a8a3SJed Brown   if (scall == MAT_INITIAL_MATRIX) {
602b1a0a8a3SJed Brown     ierr = PetscObjectGetOptionsPrefix((PetscObject)pc->pmat,&pprefix);CHKERRQ(ierr);
603f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
6043bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)osm->pmat[i]);CHKERRQ(ierr);
605b1a0a8a3SJed Brown       ierr = PetscObjectSetOptionsPrefix((PetscObject)osm->pmat[i],pprefix);CHKERRQ(ierr);
606b1a0a8a3SJed Brown     }
607b1a0a8a3SJed Brown   }
608b1a0a8a3SJed Brown 
609b1a0a8a3SJed Brown   /* Return control to the user so that the submatrices can be modified (e.g., to apply
610b1a0a8a3SJed Brown      different boundary conditions for the submatrices than for the global problem) */
6116a4f0f73SDmitry Karpeev   ierr = PCModifySubMatrices(pc,osm->n,osm->ois,osm->ois,osm->pmat,pc->modifysubmatricesP);CHKERRQ(ierr);
612b1a0a8a3SJed Brown 
613b1a0a8a3SJed Brown   /*
6146a4f0f73SDmitry Karpeev      Loop over submatrices putting them into local ksps
615b1a0a8a3SJed Brown   */
616f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
61723ee1639SBarry Smith     ierr = KSPSetOperators(osm->ksp[i],osm->pmat[i],osm->pmat[i]);CHKERRQ(ierr);
618b1a0a8a3SJed Brown     if (!pc->setupcalled) {
619b1a0a8a3SJed Brown       ierr = KSPSetFromOptions(osm->ksp[i]);CHKERRQ(ierr);
620b1a0a8a3SJed Brown     }
621b1a0a8a3SJed Brown   }
622ea91fabdSFande Kong   if(osm->pcmat){
623ea91fabdSFande Kong     ierr = MatDestroy(&pc->pmat);CHKERRQ(ierr);
624ea91fabdSFande Kong     pc->pmat   = osm->pcmat;
625ea91fabdSFande Kong     osm->pcmat = 0;
626ea91fabdSFande Kong   }
627b1a0a8a3SJed Brown   PetscFunctionReturn(0);
628b1a0a8a3SJed Brown }
629b1a0a8a3SJed Brown 
630f746d493SDmitry Karpeev static PetscErrorCode PCSetUpOnBlocks_GASM(PC pc)
631b1a0a8a3SJed Brown {
632f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
633b1a0a8a3SJed Brown   PetscErrorCode ierr;
634b1a0a8a3SJed Brown   PetscInt       i;
635b1a0a8a3SJed Brown 
636b1a0a8a3SJed Brown   PetscFunctionBegin;
637f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
638b1a0a8a3SJed Brown     ierr = KSPSetUp(osm->ksp[i]);CHKERRQ(ierr);
639b1a0a8a3SJed Brown   }
640b1a0a8a3SJed Brown   PetscFunctionReturn(0);
641b1a0a8a3SJed Brown }
642b1a0a8a3SJed Brown 
643ea91fabdSFande Kong static PetscErrorCode PCApply_GASM(PC pc,Vec xin,Vec yout)
644b1a0a8a3SJed Brown {
645f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
646b1a0a8a3SJed Brown   PetscErrorCode ierr;
647f746d493SDmitry Karpeev   PetscInt       i;
648ea91fabdSFande Kong   Vec            x,y;
649b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
650b1a0a8a3SJed Brown 
651b1a0a8a3SJed Brown   PetscFunctionBegin;
652ea91fabdSFande Kong   if(osm->pctoouter){
653ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
654ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
655ea91fabdSFande Kong     x = osm->pcx;
656ea91fabdSFande Kong     y = osm->pcy;
657ea91fabdSFande Kong   }else{
658ea91fabdSFande Kong 	x = xin;
659ea91fabdSFande Kong 	y = yout;
660ea91fabdSFande Kong   }
661b1a0a8a3SJed Brown   /*
6626a4f0f73SDmitry Karpeev      Support for limiting the restriction or interpolation only to the inner
663b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
664b1a0a8a3SJed Brown   */
665f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
666b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
667f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
6686a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6692fa5cd67SKarl Rupp   } else {
6706a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
671b1a0a8a3SJed Brown   }
6726a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
6736a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
6746a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6752fa5cd67SKarl Rupp   } else {
6766a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6776a4f0f73SDmitry Karpeev   }
67886b96d36SDmitry Karpeev   /* do the subdomain solves */
67986b96d36SDmitry Karpeev   for (i=0; i<osm->n; ++i) {
680b1a0a8a3SJed Brown     ierr = KSPSolve(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
681c0decd05SBarry Smith     ierr = KSPCheckSolve(osm->ksp[i],pc,osm->y[i]);CHKERRQ(ierr);
682b1a0a8a3SJed Brown   }
683930d09c1SFande Kong   /* Do we need to zero y ?? */
6846a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
6856a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
6866a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
687ea91fabdSFande Kong     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
6882fa5cd67SKarl Rupp   } else {
6896a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
690ea91fabdSFande Kong     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
6916a4f0f73SDmitry Karpeev   }
692ea91fabdSFande Kong   if(osm->pctoouter){
693ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
694ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
695ea91fabdSFande Kong   }
696ea91fabdSFande Kong   PetscFunctionReturn(0);
697b1a0a8a3SJed Brown }
698b1a0a8a3SJed Brown 
699ea91fabdSFande Kong static PetscErrorCode PCApplyTranspose_GASM(PC pc,Vec xin,Vec yout)
700b1a0a8a3SJed Brown {
701f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
702b1a0a8a3SJed Brown   PetscErrorCode ierr;
703f746d493SDmitry Karpeev   PetscInt       i;
704ea91fabdSFande Kong   Vec            x,y;
705b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
706b1a0a8a3SJed Brown 
707b1a0a8a3SJed Brown   PetscFunctionBegin;
708ea91fabdSFande Kong   if(osm->pctoouter){
709ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
710ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
711ea91fabdSFande Kong    x = osm->pcx;
712ea91fabdSFande Kong    y = osm->pcy;
713ea91fabdSFande Kong   }else{
714ea91fabdSFande Kong 	x = xin;
715ea91fabdSFande Kong 	y = yout;
716ea91fabdSFande Kong   }
717b1a0a8a3SJed Brown   /*
718b1a0a8a3SJed Brown      Support for limiting the restriction or interpolation to only local
719b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
720b1a0a8a3SJed Brown 
721f746d493SDmitry Karpeev      Note: these are reversed from the PCApply_GASM() because we are applying the
722b1a0a8a3SJed Brown      transpose of the three terms
723b1a0a8a3SJed Brown   */
724f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
725b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
726f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
7276a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7282fa5cd67SKarl Rupp   } else {
7296a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
730b1a0a8a3SJed Brown   }
7316a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
7326a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
7336a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7342fa5cd67SKarl Rupp   } else {
7356a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7366a4f0f73SDmitry Karpeev   }
737b1a0a8a3SJed Brown   /* do the local solves */
738ab3e923fSDmitry 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. */
739b1a0a8a3SJed Brown     ierr = KSPSolveTranspose(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
740c0decd05SBarry Smith     ierr = KSPCheckSolve(osm->ksp[i],pc,osm->y[i]);CHKERRQ(ierr);
741b1a0a8a3SJed Brown   }
7426a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
7436a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
7446a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7456a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7462fa5cd67SKarl Rupp   } else {
7476a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7486a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7496a4f0f73SDmitry Karpeev   }
750ea91fabdSFande Kong   if(osm->pctoouter){
751ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
752ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
753ea91fabdSFande Kong   }
754b1a0a8a3SJed Brown   PetscFunctionReturn(0);
755b1a0a8a3SJed Brown }
756b1a0a8a3SJed Brown 
757a06653b4SBarry Smith static PetscErrorCode PCReset_GASM(PC pc)
758b1a0a8a3SJed Brown {
759f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
760b1a0a8a3SJed Brown   PetscErrorCode ierr;
761b1a0a8a3SJed Brown   PetscInt       i;
762b1a0a8a3SJed Brown 
763b1a0a8a3SJed Brown   PetscFunctionBegin;
764b1a0a8a3SJed Brown   if (osm->ksp) {
765f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
766a06653b4SBarry Smith       ierr = KSPReset(osm->ksp[i]);CHKERRQ(ierr);
767b1a0a8a3SJed Brown     }
768b1a0a8a3SJed Brown   }
769b1a0a8a3SJed Brown   if (osm->pmat) {
770f746d493SDmitry Karpeev     if (osm->n > 0) {
771df750dc8SHong Zhang       PetscMPIInt size;
772df750dc8SHong Zhang       ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
773df750dc8SHong Zhang       if (size > 1) {
7747dae84e0SHong Zhang         /* osm->pmat is created by MatCreateSubMatricesMPI(), cannot use MatDestroySubMatrices() */
775ab3e923fSDmitry Karpeev         ierr = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
776df750dc8SHong Zhang       } else {
777df750dc8SHong Zhang         ierr = MatDestroySubMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
778df750dc8SHong Zhang       }
779b1a0a8a3SJed Brown     }
780b1a0a8a3SJed Brown   }
781d34fcf5fSBarry Smith   if (osm->x) {
782f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
783fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->x[i]);CHKERRQ(ierr);
784fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->y[i]);CHKERRQ(ierr);
785b1a0a8a3SJed Brown     }
786d34fcf5fSBarry Smith   }
7876bf464f9SBarry Smith   ierr = VecDestroy(&osm->gx);CHKERRQ(ierr);
7886bf464f9SBarry Smith   ierr = VecDestroy(&osm->gy);CHKERRQ(ierr);
789ab3e923fSDmitry Karpeev 
7906a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->gorestriction);CHKERRQ(ierr);
7916a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->girestriction);CHKERRQ(ierr);
7928f3b4b4dSDmitry Karpeev   if (!osm->user_subdomains) {
7932c112581SDmitry Karpeev     ierr      = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
7948f3b4b4dSDmitry Karpeev     osm->N    = PETSC_DETERMINE;
7958f3b4b4dSDmitry Karpeev     osm->nmax = PETSC_DETERMINE;
7968f3b4b4dSDmitry Karpeev   }
797ea91fabdSFande Kong   if(osm->pctoouter){
798ea91fabdSFande Kong 	ierr = VecScatterDestroy(&(osm->pctoouter));CHKERRQ(ierr);
799ea91fabdSFande Kong   }
800ea91fabdSFande Kong   if(osm->permutationIS){
801ea91fabdSFande Kong 	ierr = ISDestroy(&(osm->permutationIS));CHKERRQ(ierr);
802ea91fabdSFande Kong   }
803ea91fabdSFande Kong   if(osm->pcx){
804ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcx));CHKERRQ(ierr);
805ea91fabdSFande Kong   }
806ea91fabdSFande Kong   if(osm->pcy){
807ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcy));CHKERRQ(ierr);
808ea91fabdSFande Kong   }
809ea91fabdSFande Kong   if(osm->permutationP){
810ea91fabdSFande Kong     ierr = MatDestroy(&(osm->permutationP));CHKERRQ(ierr);
811ea91fabdSFande Kong   }
812ea91fabdSFande Kong   if(osm->pcmat){
813ea91fabdSFande Kong 	ierr = MatDestroy(&osm->pcmat);CHKERRQ(ierr);
814ea91fabdSFande Kong   }
815a06653b4SBarry Smith   PetscFunctionReturn(0);
816a06653b4SBarry Smith }
817a06653b4SBarry Smith 
818a06653b4SBarry Smith static PetscErrorCode PCDestroy_GASM(PC pc)
819a06653b4SBarry Smith {
820a06653b4SBarry Smith   PC_GASM        *osm = (PC_GASM*)pc->data;
821a06653b4SBarry Smith   PetscErrorCode ierr;
822a06653b4SBarry Smith   PetscInt       i;
823a06653b4SBarry Smith 
824a06653b4SBarry Smith   PetscFunctionBegin;
825a06653b4SBarry Smith   ierr = PCReset_GASM(pc);CHKERRQ(ierr);
826135757f6SDmitry Karpeev   /* PCReset will not destroy subdomains, if user_subdomains is true. */
827135757f6SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
828a06653b4SBarry Smith   if (osm->ksp) {
829a06653b4SBarry Smith     for (i=0; i<osm->n; i++) {
8306bf464f9SBarry Smith       ierr = KSPDestroy(&osm->ksp[i]);CHKERRQ(ierr);
831a06653b4SBarry Smith     }
832a06653b4SBarry Smith     ierr = PetscFree(osm->ksp);CHKERRQ(ierr);
833a06653b4SBarry Smith   }
834a06653b4SBarry Smith   ierr = PetscFree(osm->x);CHKERRQ(ierr);
835a06653b4SBarry Smith   ierr = PetscFree(osm->y);CHKERRQ(ierr);
836c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
837b1a0a8a3SJed Brown   PetscFunctionReturn(0);
838b1a0a8a3SJed Brown }
839b1a0a8a3SJed Brown 
8404416b707SBarry Smith static PetscErrorCode PCSetFromOptions_GASM(PetscOptionItems *PetscOptionsObject,PC pc)
841a6dfd86eSKarl Rupp {
842f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
843b1a0a8a3SJed Brown   PetscErrorCode ierr;
844b1a0a8a3SJed Brown   PetscInt       blocks,ovl;
845b1a0a8a3SJed Brown   PetscBool      symset,flg;
846f746d493SDmitry Karpeev   PCGASMType     gasmtype;
847b1a0a8a3SJed Brown 
848b1a0a8a3SJed Brown   PetscFunctionBegin;
849b1a0a8a3SJed Brown   /* set the type to symmetric if matrix is symmetric */
850b1a0a8a3SJed Brown   if (!osm->type_set && pc->pmat) {
851b1a0a8a3SJed Brown     ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
8522fa5cd67SKarl Rupp     if (symset && flg) osm->type = PC_GASM_BASIC;
853b1a0a8a3SJed Brown   }
854e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"Generalized additive Schwarz options");CHKERRQ(ierr);
8558f3b4b4dSDmitry 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);
8568f3b4b4dSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_total_subdomains","Total number of subdomains across communicator","PCGASMSetTotalSubdomains",osm->N,&blocks,&flg);CHKERRQ(ierr);
85765db9045SDmitry Karpeev   if (flg) {
8588f3b4b4dSDmitry Karpeev     ierr = PCGASMSetTotalSubdomains(pc,blocks);CHKERRQ(ierr);
85965db9045SDmitry Karpeev   }
86006b43e7eSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_overlap","Number of overlapping degrees of freedom","PCGASMSetOverlap",osm->overlap,&ovl,&flg);CHKERRQ(ierr);
86165db9045SDmitry Karpeev   if (flg) {
86265db9045SDmitry Karpeev     ierr = PCGASMSetOverlap(pc,ovl);CHKERRQ(ierr);
863d709ea83SDmitry Karpeev     osm->dm_subdomains = PETSC_FALSE;
86465db9045SDmitry Karpeev   }
865b1a0a8a3SJed Brown   flg  = PETSC_FALSE;
866f746d493SDmitry Karpeev   ierr = PetscOptionsEnum("-pc_gasm_type","Type of restriction/extension","PCGASMSetType",PCGASMTypes,(PetscEnum)osm->type,(PetscEnum*)&gasmtype,&flg);CHKERRQ(ierr);
867f746d493SDmitry Karpeev   if (flg) {ierr = PCGASMSetType(pc,gasmtype);CHKERRQ(ierr);}
868ea91fabdSFande Kong   ierr = PetscOptionsBool("-pc_gasm_use_hierachical_partitioning","use hierarchical partitioning",NULL,osm->hierarchicalpartitioning,&osm->hierarchicalpartitioning,&flg);CHKERRQ(ierr);
869b1a0a8a3SJed Brown   ierr = PetscOptionsTail();CHKERRQ(ierr);
870b1a0a8a3SJed Brown   PetscFunctionReturn(0);
871b1a0a8a3SJed Brown }
872b1a0a8a3SJed Brown 
873b1a0a8a3SJed Brown /*------------------------------------------------------------------------------------*/
874b1a0a8a3SJed Brown 
8758f3b4b4dSDmitry Karpeev /*@
8768f3b4b4dSDmitry Karpeev     PCGASMSetTotalSubdomains - sets the total number of subdomains to use across the
8778f3b4b4dSDmitry Karpeev                                communicator.
8788f3b4b4dSDmitry Karpeev     Logically collective on pc
8798f3b4b4dSDmitry Karpeev 
8808f3b4b4dSDmitry Karpeev     Input Parameters:
8818f3b4b4dSDmitry Karpeev +   pc  - the preconditioner
8828f3b4b4dSDmitry Karpeev -   N   - total number of subdomains
8838f3b4b4dSDmitry Karpeev 
8848f3b4b4dSDmitry Karpeev 
8858f3b4b4dSDmitry Karpeev     Level: beginner
8868f3b4b4dSDmitry Karpeev 
8878f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap()
8888f3b4b4dSDmitry Karpeev           PCGASMCreateSubdomains2D()
8898f3b4b4dSDmitry Karpeev @*/
8908f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetTotalSubdomains(PC pc,PetscInt N)
8918f3b4b4dSDmitry Karpeev {
8928f3b4b4dSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
8938f3b4b4dSDmitry Karpeev   PetscMPIInt    size,rank;
8948f3b4b4dSDmitry Karpeev   PetscErrorCode ierr;
8958f3b4b4dSDmitry Karpeev 
8968f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
8978f3b4b4dSDmitry 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);
8988f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetTotalSubdomains() should be called before calling PCSetUp().");
8998f3b4b4dSDmitry Karpeev 
9002c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9018f3b4b4dSDmitry Karpeev   osm->ois = osm->iis = NULL;
9028f3b4b4dSDmitry Karpeev 
9038f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
9048f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
9058f3b4b4dSDmitry Karpeev   osm->N    = N;
9068f3b4b4dSDmitry Karpeev   osm->n    = PETSC_DETERMINE;
9078f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
9088f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
9098f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
9108f3b4b4dSDmitry Karpeev }
9118f3b4b4dSDmitry Karpeev 
912670417b2SFande Kong 
913b541e6a4SDmitry Karpeev static PetscErrorCode  PCGASMSetSubdomains_GASM(PC pc,PetscInt n,IS iis[],IS ois[])
914b1a0a8a3SJed Brown {
915f746d493SDmitry Karpeev   PC_GASM         *osm = (PC_GASM*)pc->data;
916b1a0a8a3SJed Brown   PetscErrorCode  ierr;
917b1a0a8a3SJed Brown   PetscInt        i;
918b1a0a8a3SJed Brown 
919b1a0a8a3SJed Brown   PetscFunctionBegin;
9208f3b4b4dSDmitry Karpeev   if (n < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Each process must have 1 or more subdomains, got n = %D",n);
9218f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetSubdomains() should be called before calling PCSetUp().");
922b1a0a8a3SJed Brown 
9232c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9248f3b4b4dSDmitry Karpeev   osm->iis  = osm->ois = NULL;
9258f3b4b4dSDmitry Karpeev   osm->n    = n;
9268f3b4b4dSDmitry Karpeev   osm->N    = PETSC_DETERMINE;
9278f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
928a35b7b57SDmitry Karpeev   if (ois) {
929785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->ois);CHKERRQ(ierr);
9308f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9318f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)ois[i]);CHKERRQ(ierr);
9328f3b4b4dSDmitry Karpeev       osm->ois[i] = ois[i];
9338f3b4b4dSDmitry Karpeev     }
9348f3b4b4dSDmitry Karpeev     /*
9358f3b4b4dSDmitry Karpeev        Since the user set the outer subdomains, even if nontrivial overlap was requested via PCGASMSetOverlap(),
9368f3b4b4dSDmitry Karpeev        it will be ignored.  To avoid confusion later on (e.g., when viewing the PC), the overlap size is set to -1.
9378f3b4b4dSDmitry Karpeev     */
938b1a0a8a3SJed Brown     osm->overlap = -1;
939670417b2SFande Kong     /* inner subdomains must be provided  */
940670417b2SFande Kong     if (!iis) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"inner indices have to be provided \n");
941670417b2SFande Kong   }/* end if */
942a35b7b57SDmitry Karpeev   if (iis) {
943785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->iis);CHKERRQ(ierr);
9448f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9458f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)iis[i]);CHKERRQ(ierr);
9468f3b4b4dSDmitry Karpeev       osm->iis[i] = iis[i];
9478f3b4b4dSDmitry Karpeev     }
948a35b7b57SDmitry Karpeev     if (!ois) {
949390e1bf2SBarry Smith       osm->ois = NULL;
950670417b2SFande Kong       /* if user does not provide outer indices, we will create the corresponding outer indices using  osm->overlap =1 in PCSetUp_GASM */
951670417b2SFande Kong     }
952670417b2SFande Kong   }
953670417b2SFande Kong #if defined(PETSC_USE_DEBUG)
954670417b2SFande Kong   {
955670417b2SFande Kong     PetscInt        j,rstart,rend,*covered,lsize;
956670417b2SFande Kong     const PetscInt  *indices;
957670417b2SFande Kong     /* check if the inner indices cover and only cover the local portion of the preconditioning matrix */
958670417b2SFande Kong     ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
959670417b2SFande Kong     ierr = PetscCalloc1(rend-rstart,&covered);CHKERRQ(ierr);
960670417b2SFande Kong     /* check if the current processor owns indices from others */
961a35b7b57SDmitry Karpeev     for (i=0; i<n; i++) {
962670417b2SFande Kong       ierr = ISGetIndices(osm->iis[i],&indices);CHKERRQ(ierr);
963670417b2SFande Kong       ierr = ISGetLocalSize(osm->iis[i],&lsize);CHKERRQ(ierr);
964670417b2SFande Kong       for (j=0; j<lsize; j++) {
965670417b2SFande 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]);
966670417b2SFande 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]);
967670417b2SFande Kong         else covered[indices[j]-rstart] = 1;
968a35b7b57SDmitry Karpeev       }
969670417b2SFande Kong     ierr = ISRestoreIndices(osm->iis[i],&indices);CHKERRQ(ierr);
9708f3b4b4dSDmitry Karpeev     }
971670417b2SFande Kong     /* check if we miss any indices */
972670417b2SFande Kong     for (i=rstart; i<rend; i++) {
973670417b2SFande Kong       if (!covered[i-rstart]) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"local entity %d was not covered by inner subdomains",i);
974a35b7b57SDmitry Karpeev     }
975670417b2SFande Kong     ierr = PetscFree(covered);CHKERRQ(ierr);
976a35b7b57SDmitry Karpeev   }
977670417b2SFande Kong #endif
9788f3b4b4dSDmitry Karpeev   if (iis)  osm->user_subdomains = PETSC_TRUE;
979b1a0a8a3SJed Brown   PetscFunctionReturn(0);
980b1a0a8a3SJed Brown }
981b1a0a8a3SJed Brown 
982b1a0a8a3SJed Brown 
983f7a08781SBarry Smith static PetscErrorCode  PCGASMSetOverlap_GASM(PC pc,PetscInt ovl)
984b1a0a8a3SJed Brown {
985f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
986b1a0a8a3SJed Brown 
987b1a0a8a3SJed Brown   PetscFunctionBegin;
988ce94432eSBarry Smith   if (ovl < 0) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Negative overlap value requested");
989ce94432eSBarry Smith   if (pc->setupcalled && ovl != osm->overlap) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetOverlap() should be called before PCSetUp().");
9902fa5cd67SKarl Rupp   if (!pc->setupcalled) osm->overlap = ovl;
991b1a0a8a3SJed Brown   PetscFunctionReturn(0);
992b1a0a8a3SJed Brown }
993b1a0a8a3SJed Brown 
994f7a08781SBarry Smith static PetscErrorCode  PCGASMSetType_GASM(PC pc,PCGASMType type)
995b1a0a8a3SJed Brown {
996f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
997b1a0a8a3SJed Brown 
998b1a0a8a3SJed Brown   PetscFunctionBegin;
999b1a0a8a3SJed Brown   osm->type     = type;
1000b1a0a8a3SJed Brown   osm->type_set = PETSC_TRUE;
1001b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1002b1a0a8a3SJed Brown }
1003b1a0a8a3SJed Brown 
1004f7a08781SBarry Smith static PetscErrorCode  PCGASMSetSortIndices_GASM(PC pc,PetscBool doSort)
1005b1a0a8a3SJed Brown {
1006f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1007b1a0a8a3SJed Brown 
1008b1a0a8a3SJed Brown   PetscFunctionBegin;
1009b1a0a8a3SJed Brown   osm->sort_indices = doSort;
1010b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1011b1a0a8a3SJed Brown }
1012b1a0a8a3SJed Brown 
101344fe18e5SDmitry Karpeev /*
10148f3b4b4dSDmitry Karpeev    FIXME: This routine might need to be modified now that multiple ranks per subdomain are allowed.
101544fe18e5SDmitry Karpeev         In particular, it would upset the global subdomain number calculation.
101644fe18e5SDmitry Karpeev */
1017f7a08781SBarry Smith static PetscErrorCode  PCGASMGetSubKSP_GASM(PC pc,PetscInt *n,PetscInt *first,KSP **ksp)
1018b1a0a8a3SJed Brown {
1019f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1020b1a0a8a3SJed Brown   PetscErrorCode ierr;
1021b1a0a8a3SJed Brown 
1022b1a0a8a3SJed Brown   PetscFunctionBegin;
1023ce94432eSBarry 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");
1024b1a0a8a3SJed Brown 
10252fa5cd67SKarl Rupp   if (n) *n = osm->n;
1026ab3e923fSDmitry Karpeev   if (first) {
1027ce94432eSBarry Smith     ierr    = MPI_Scan(&osm->n,first,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1028ab3e923fSDmitry Karpeev     *first -= osm->n;
1029b1a0a8a3SJed Brown   }
1030b1a0a8a3SJed Brown   if (ksp) {
1031b1a0a8a3SJed Brown     /* Assume that local solves are now different; not necessarily
103206b43e7eSDmitry Karpeev        true, though!  This flag is used only for PCView_GASM() */
1033b1a0a8a3SJed Brown     *ksp                        = osm->ksp;
10346a4f0f73SDmitry Karpeev     osm->same_subdomain_solvers = PETSC_FALSE;
1035b1a0a8a3SJed Brown   }
1036b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1037ab3e923fSDmitry Karpeev } /* PCGASMGetSubKSP_GASM() */
1038b1a0a8a3SJed Brown 
1039b1a0a8a3SJed Brown /*@C
104006b43e7eSDmitry Karpeev     PCGASMSetSubdomains - Sets the subdomains for this processor
104106b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1042b1a0a8a3SJed Brown 
10438f3b4b4dSDmitry Karpeev     Collective on pc
1044b1a0a8a3SJed Brown 
1045b1a0a8a3SJed Brown     Input Parameters:
10468f3b4b4dSDmitry Karpeev +   pc  - the preconditioner object
104706b43e7eSDmitry Karpeev .   n   - the number of subdomains for this processor
10488f3b4b4dSDmitry Karpeev .   iis - the index sets that define the inner subdomains (or NULL for PETSc to determine subdomains)
10498f3b4b4dSDmitry 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)
1050b1a0a8a3SJed Brown 
1051b1a0a8a3SJed Brown     Notes:
105206b43e7eSDmitry Karpeev     The IS indices use the parallel, global numbering of the vector entries.
10536a4f0f73SDmitry Karpeev     Inner subdomains are those where the correction is applied.
10546a4f0f73SDmitry Karpeev     Outer subdomains are those where the residual necessary to obtain the
10556a4f0f73SDmitry Karpeev     corrections is obtained (see PCGASMType for the use of inner/outer subdomains).
10566a4f0f73SDmitry Karpeev     Both inner and outer subdomains can extend over several processors.
10576a4f0f73SDmitry Karpeev     This processor's portion of a subdomain is known as a local subdomain.
10586a4f0f73SDmitry Karpeev 
1059670417b2SFande Kong     Inner subdomains can not overlap with each other, do not have any entities from remote processors,
1060670417b2SFande Kong     and  have to cover the entire local subdomain owned by the current processor. The index sets on each
1061670417b2SFande Kong     process should be ordered such that the ith local subdomain is connected to the ith remote subdomain
1062670417b2SFande Kong     on another MPI process.
1063670417b2SFande Kong 
10646a4f0f73SDmitry Karpeev     By default the GASM preconditioner uses 1 (local) subdomain per processor.
10656a4f0f73SDmitry Karpeev 
1066b1a0a8a3SJed Brown 
1067b1a0a8a3SJed Brown     Level: advanced
1068b1a0a8a3SJed Brown 
10698f3b4b4dSDmitry Karpeev .seealso: PCGASMSetNumSubdomains(), PCGASMSetOverlap(), PCGASMGetSubKSP(),
107006b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1071b1a0a8a3SJed Brown @*/
10726a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMSetSubdomains(PC pc,PetscInt n,IS iis[],IS ois[])
1073b1a0a8a3SJed Brown {
10748f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1075b1a0a8a3SJed Brown   PetscErrorCode ierr;
1076b1a0a8a3SJed Brown 
1077b1a0a8a3SJed Brown   PetscFunctionBegin;
1078b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
10796a4f0f73SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSubdomains_C",(PC,PetscInt,IS[],IS[]),(pc,n,iis,ois));CHKERRQ(ierr);
10808f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1081b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1082b1a0a8a3SJed Brown }
1083b1a0a8a3SJed Brown 
1084b1a0a8a3SJed Brown 
1085b1a0a8a3SJed Brown /*@
1086f746d493SDmitry Karpeev     PCGASMSetOverlap - Sets the overlap between a pair of subdomains for the
1087b1a0a8a3SJed Brown     additive Schwarz preconditioner.  Either all or no processors in the
10888f3b4b4dSDmitry Karpeev     pc communicator must call this routine.
1089b1a0a8a3SJed Brown 
10908f3b4b4dSDmitry Karpeev     Logically Collective on pc
1091b1a0a8a3SJed Brown 
1092b1a0a8a3SJed Brown     Input Parameters:
1093b1a0a8a3SJed Brown +   pc  - the preconditioner context
10948f3b4b4dSDmitry Karpeev -   ovl - the amount of overlap between subdomains (ovl >= 0, default value = 0)
1095b1a0a8a3SJed Brown 
1096b1a0a8a3SJed Brown     Options Database Key:
109706b43e7eSDmitry Karpeev .   -pc_gasm_overlap <overlap> - Sets overlap
1098b1a0a8a3SJed Brown 
1099b1a0a8a3SJed Brown     Notes:
110006b43e7eSDmitry Karpeev     By default the GASM preconditioner uses 1 subdomain per processor.  To use
11018f3b4b4dSDmitry Karpeev     multiple subdomain per perocessor or "straddling" subdomains that intersect
11028f3b4b4dSDmitry Karpeev     multiple processors use PCGASMSetSubdomains() (or option -pc_gasm_total_subdomains <n>).
1103b1a0a8a3SJed Brown 
11048f3b4b4dSDmitry Karpeev     The overlap defaults to 0, so if one desires that no additional
1105b1a0a8a3SJed Brown     overlap be computed beyond what may have been set with a call to
11068f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), then ovl must be set to be 0.  In particular, if one does
11078f3b4b4dSDmitry Karpeev     not explicitly set the subdomains in application code, then all overlap would be computed
1108f746d493SDmitry Karpeev     internally by PETSc, and using an overlap of 0 would result in an GASM
1109b1a0a8a3SJed Brown     variant that is equivalent to the block Jacobi preconditioner.
1110b1a0a8a3SJed Brown 
1111b1a0a8a3SJed Brown     Note that one can define initial index sets with any overlap via
111206b43e7eSDmitry Karpeev     PCGASMSetSubdomains(); the routine PCGASMSetOverlap() merely allows
111306b43e7eSDmitry Karpeev     PETSc to extend that overlap further, if desired.
1114b1a0a8a3SJed Brown 
1115b1a0a8a3SJed Brown     Level: intermediate
1116b1a0a8a3SJed Brown 
11178f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
111806b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1119b1a0a8a3SJed Brown @*/
11207087cfbeSBarry Smith PetscErrorCode  PCGASMSetOverlap(PC pc,PetscInt ovl)
1121b1a0a8a3SJed Brown {
1122b1a0a8a3SJed Brown   PetscErrorCode ierr;
11238f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1124b1a0a8a3SJed Brown 
1125b1a0a8a3SJed Brown   PetscFunctionBegin;
1126b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1127b1a0a8a3SJed Brown   PetscValidLogicalCollectiveInt(pc,ovl,2);
1128f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetOverlap_C",(PC,PetscInt),(pc,ovl));CHKERRQ(ierr);
11298f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1130b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1131b1a0a8a3SJed Brown }
1132b1a0a8a3SJed Brown 
1133b1a0a8a3SJed Brown /*@
1134f746d493SDmitry Karpeev     PCGASMSetType - Sets the type of restriction and interpolation used
1135b1a0a8a3SJed Brown     for local problems in the additive Schwarz method.
1136b1a0a8a3SJed Brown 
1137b1a0a8a3SJed Brown     Logically Collective on PC
1138b1a0a8a3SJed Brown 
1139b1a0a8a3SJed Brown     Input Parameters:
1140b1a0a8a3SJed Brown +   pc  - the preconditioner context
1141f746d493SDmitry Karpeev -   type - variant of GASM, one of
1142b1a0a8a3SJed Brown .vb
1143f746d493SDmitry Karpeev       PC_GASM_BASIC       - full interpolation and restriction
1144f746d493SDmitry Karpeev       PC_GASM_RESTRICT    - full restriction, local processor interpolation
1145f746d493SDmitry Karpeev       PC_GASM_INTERPOLATE - full interpolation, local processor restriction
1146f746d493SDmitry Karpeev       PC_GASM_NONE        - local processor restriction and interpolation
1147b1a0a8a3SJed Brown .ve
1148b1a0a8a3SJed Brown 
1149b1a0a8a3SJed Brown     Options Database Key:
1150f746d493SDmitry Karpeev .   -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1151b1a0a8a3SJed Brown 
1152b1a0a8a3SJed Brown     Level: intermediate
1153b1a0a8a3SJed Brown 
11548f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1155f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1156b1a0a8a3SJed Brown @*/
11577087cfbeSBarry Smith PetscErrorCode  PCGASMSetType(PC pc,PCGASMType type)
1158b1a0a8a3SJed Brown {
1159b1a0a8a3SJed Brown   PetscErrorCode ierr;
1160b1a0a8a3SJed Brown 
1161b1a0a8a3SJed Brown   PetscFunctionBegin;
1162b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1163b1a0a8a3SJed Brown   PetscValidLogicalCollectiveEnum(pc,type,2);
1164f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetType_C",(PC,PCGASMType),(pc,type));CHKERRQ(ierr);
1165b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1166b1a0a8a3SJed Brown }
1167b1a0a8a3SJed Brown 
1168b1a0a8a3SJed Brown /*@
1169f746d493SDmitry Karpeev     PCGASMSetSortIndices - Determines whether subdomain indices are sorted.
1170b1a0a8a3SJed Brown 
1171b1a0a8a3SJed Brown     Logically Collective on PC
1172b1a0a8a3SJed Brown 
1173b1a0a8a3SJed Brown     Input Parameters:
1174b1a0a8a3SJed Brown +   pc  - the preconditioner context
1175b1a0a8a3SJed Brown -   doSort - sort the subdomain indices
1176b1a0a8a3SJed Brown 
1177b1a0a8a3SJed Brown     Level: intermediate
1178b1a0a8a3SJed Brown 
11798f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1180f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1181b1a0a8a3SJed Brown @*/
11827087cfbeSBarry Smith PetscErrorCode  PCGASMSetSortIndices(PC pc,PetscBool doSort)
1183b1a0a8a3SJed Brown {
1184b1a0a8a3SJed Brown   PetscErrorCode ierr;
1185b1a0a8a3SJed Brown 
1186b1a0a8a3SJed Brown   PetscFunctionBegin;
1187b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1188b1a0a8a3SJed Brown   PetscValidLogicalCollectiveBool(pc,doSort,2);
1189f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSortIndices_C",(PC,PetscBool),(pc,doSort));CHKERRQ(ierr);
1190b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1191b1a0a8a3SJed Brown }
1192b1a0a8a3SJed Brown 
1193b1a0a8a3SJed Brown /*@C
1194f746d493SDmitry Karpeev    PCGASMGetSubKSP - Gets the local KSP contexts for all blocks on
1195b1a0a8a3SJed Brown    this processor.
1196b1a0a8a3SJed Brown 
1197b1a0a8a3SJed Brown    Collective on PC iff first_local is requested
1198b1a0a8a3SJed Brown 
1199b1a0a8a3SJed Brown    Input Parameter:
1200b1a0a8a3SJed Brown .  pc - the preconditioner context
1201b1a0a8a3SJed Brown 
1202b1a0a8a3SJed Brown    Output Parameters:
12030298fd71SBarry Smith +  n_local - the number of blocks on this processor or NULL
12040298fd71SBarry Smith .  first_local - the global number of the first block on this processor or NULL,
12050298fd71SBarry Smith                  all processors must request or all must pass NULL
1206b1a0a8a3SJed Brown -  ksp - the array of KSP contexts
1207b1a0a8a3SJed Brown 
1208b1a0a8a3SJed Brown    Note:
1209f746d493SDmitry Karpeev    After PCGASMGetSubKSP() the array of KSPes is not to be freed
1210b1a0a8a3SJed Brown 
1211b1a0a8a3SJed Brown    Currently for some matrix implementations only 1 block per processor
1212b1a0a8a3SJed Brown    is supported.
1213b1a0a8a3SJed Brown 
1214f746d493SDmitry Karpeev    You must call KSPSetUp() before calling PCGASMGetSubKSP().
1215b1a0a8a3SJed Brown 
1216b1a0a8a3SJed Brown    Level: advanced
1217b1a0a8a3SJed Brown 
12188f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap(),
1219f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D(),
1220b1a0a8a3SJed Brown @*/
12217087cfbeSBarry Smith PetscErrorCode  PCGASMGetSubKSP(PC pc,PetscInt *n_local,PetscInt *first_local,KSP *ksp[])
1222b1a0a8a3SJed Brown {
1223b1a0a8a3SJed Brown   PetscErrorCode ierr;
1224b1a0a8a3SJed Brown 
1225b1a0a8a3SJed Brown   PetscFunctionBegin;
1226b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1227f746d493SDmitry Karpeev   ierr = PetscUseMethod(pc,"PCGASMGetSubKSP_C",(PC,PetscInt*,PetscInt*,KSP **),(pc,n_local,first_local,ksp));CHKERRQ(ierr);
1228b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1229b1a0a8a3SJed Brown }
1230b1a0a8a3SJed Brown 
1231b1a0a8a3SJed Brown /* -------------------------------------------------------------------------------------*/
1232b1a0a8a3SJed Brown /*MC
1233f746d493SDmitry Karpeev    PCGASM - Use the (restricted) additive Schwarz method, each block is (approximately) solved with
1234b1a0a8a3SJed Brown            its own KSP object.
1235b1a0a8a3SJed Brown 
1236b1a0a8a3SJed Brown    Options Database Keys:
12378f3b4b4dSDmitry Karpeev +  -pc_gasm_total_subdomains <n>  - Sets total number of local subdomains to be distributed among processors
123806b43e7eSDmitry Karpeev .  -pc_gasm_view_subdomains       - activates the printing of subdomain indices in PCView(), -ksp_view or -snes_view
123906b43e7eSDmitry Karpeev .  -pc_gasm_print_subdomains      - activates the printing of subdomain indices in PCSetUp()
124006b43e7eSDmitry Karpeev .  -pc_gasm_overlap <ovl>         - Sets overlap by which to (automatically) extend local subdomains
1241f746d493SDmitry Karpeev -  -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1242b1a0a8a3SJed Brown 
1243b1a0a8a3SJed Brown      IMPORTANT: If you run with, for example, 3 blocks on 1 processor or 3 blocks on 3 processors you
1244f746d493SDmitry Karpeev       will get a different convergence rate due to the default option of -pc_gasm_type restrict. Use
1245f746d493SDmitry Karpeev       -pc_gasm_type basic to use the standard GASM.
1246b1a0a8a3SJed Brown 
124795452b02SPatrick Sanan    Notes:
124895452b02SPatrick Sanan     Blocks can be shared by multiple processes.
1249b1a0a8a3SJed Brown 
1250b1a0a8a3SJed Brown      To set options on the solvers for each block append -sub_ to all the KSP, and PC
1251b1a0a8a3SJed Brown         options database keys. For example, -sub_pc_type ilu -sub_pc_factor_levels 1 -sub_ksp_type preonly
1252b1a0a8a3SJed Brown 
1253f746d493SDmitry Karpeev      To set the options on the solvers separate for each block call PCGASMGetSubKSP()
1254b1a0a8a3SJed Brown          and set the options directly on the resulting KSP object (you can access its PC
1255b1a0a8a3SJed Brown          with KSPGetPC())
1256b1a0a8a3SJed Brown 
1257b1a0a8a3SJed Brown 
1258b1a0a8a3SJed Brown    Level: beginner
1259b1a0a8a3SJed Brown 
1260b1a0a8a3SJed Brown     References:
126196a0c994SBarry Smith +   1. - M Dryja, OB Widlund, An additive variant of the Schwarz alternating method for the case of many subregions
126296a0c994SBarry Smith      Courant Institute, New York University Technical report
126396a0c994SBarry Smith -   2. - Barry Smith, Petter Bjorstad, and William Gropp, Domain Decompositions: Parallel Multilevel Methods for Elliptic Partial Differential Equations,
126496a0c994SBarry Smith     Cambridge University Press.
1265b1a0a8a3SJed Brown 
1266b1a0a8a3SJed Brown .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
126749517cdeSBarry Smith            PCBJACOBI,  PCGASMGetSubKSP(), PCGASMSetSubdomains(),
12688f3b4b4dSDmitry Karpeev            PCSetModifySubmatrices(), PCGASMSetOverlap(), PCGASMSetType()
1269b1a0a8a3SJed Brown 
1270b1a0a8a3SJed Brown M*/
1271b1a0a8a3SJed Brown 
12728cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GASM(PC pc)
1273b1a0a8a3SJed Brown {
1274b1a0a8a3SJed Brown   PetscErrorCode ierr;
1275f746d493SDmitry Karpeev   PC_GASM        *osm;
1276b1a0a8a3SJed Brown 
1277b1a0a8a3SJed Brown   PetscFunctionBegin;
1278b00a9115SJed Brown   ierr = PetscNewLog(pc,&osm);CHKERRQ(ierr);
12792fa5cd67SKarl Rupp 
12808f3b4b4dSDmitry Karpeev   osm->N                        = PETSC_DETERMINE;
128106b43e7eSDmitry Karpeev   osm->n                        = PETSC_DECIDE;
12828f3b4b4dSDmitry Karpeev   osm->nmax                     = PETSC_DETERMINE;
12838f3b4b4dSDmitry Karpeev   osm->overlap                  = 0;
1284b1a0a8a3SJed Brown   osm->ksp                      = 0;
12856a4f0f73SDmitry Karpeev   osm->gorestriction            = 0;
12866a4f0f73SDmitry Karpeev   osm->girestriction            = 0;
1287ea91fabdSFande Kong   osm->pctoouter                = 0;
1288ab3e923fSDmitry Karpeev   osm->gx                       = 0;
1289ab3e923fSDmitry Karpeev   osm->gy                       = 0;
1290b1a0a8a3SJed Brown   osm->x                        = 0;
1291b1a0a8a3SJed Brown   osm->y                        = 0;
1292ea91fabdSFande Kong   osm->pcx                      = 0;
1293ea91fabdSFande Kong   osm->pcy                      = 0;
1294ea91fabdSFande Kong   osm->permutationIS            = 0;
1295ea91fabdSFande Kong   osm->permutationP             = 0;
1296ea91fabdSFande Kong   osm->pcmat                    = 0;
12976a4f0f73SDmitry Karpeev   osm->ois                      = 0;
12986a4f0f73SDmitry Karpeev   osm->iis                      = 0;
1299b1a0a8a3SJed Brown   osm->pmat                     = 0;
1300f746d493SDmitry Karpeev   osm->type                     = PC_GASM_RESTRICT;
13016a4f0f73SDmitry Karpeev   osm->same_subdomain_solvers   = PETSC_TRUE;
1302b1a0a8a3SJed Brown   osm->sort_indices             = PETSC_TRUE;
1303d709ea83SDmitry Karpeev   osm->dm_subdomains            = PETSC_FALSE;
1304ea91fabdSFande Kong   osm->hierarchicalpartitioning = PETSC_FALSE;
1305b1a0a8a3SJed Brown 
1306b1a0a8a3SJed Brown   pc->data                 = (void*)osm;
1307f746d493SDmitry Karpeev   pc->ops->apply           = PCApply_GASM;
1308f746d493SDmitry Karpeev   pc->ops->applytranspose  = PCApplyTranspose_GASM;
1309f746d493SDmitry Karpeev   pc->ops->setup           = PCSetUp_GASM;
1310a06653b4SBarry Smith   pc->ops->reset           = PCReset_GASM;
1311f746d493SDmitry Karpeev   pc->ops->destroy         = PCDestroy_GASM;
1312f746d493SDmitry Karpeev   pc->ops->setfromoptions  = PCSetFromOptions_GASM;
1313f746d493SDmitry Karpeev   pc->ops->setuponblocks   = PCSetUpOnBlocks_GASM;
1314f746d493SDmitry Karpeev   pc->ops->view            = PCView_GASM;
1315b1a0a8a3SJed Brown   pc->ops->applyrichardson = 0;
1316b1a0a8a3SJed Brown 
1317bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSubdomains_C",PCGASMSetSubdomains_GASM);CHKERRQ(ierr);
1318bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetOverlap_C",PCGASMSetOverlap_GASM);CHKERRQ(ierr);
1319bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetType_C",PCGASMSetType_GASM);CHKERRQ(ierr);
1320bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSortIndices_C",PCGASMSetSortIndices_GASM);CHKERRQ(ierr);
1321bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMGetSubKSP_C",PCGASMGetSubKSP_GASM);CHKERRQ(ierr);
1322b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1323b1a0a8a3SJed Brown }
1324b1a0a8a3SJed Brown 
1325b1a0a8a3SJed Brown 
13268f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[])
1327b1a0a8a3SJed Brown {
1328b1a0a8a3SJed Brown   MatPartitioning mpart;
1329b1a0a8a3SJed Brown   const char      *prefix;
1330b1a0a8a3SJed Brown   PetscInt        i,j,rstart,rend,bs;
1331976e8c5aSLisandro Dalcin   PetscBool       hasop, isbaij = PETSC_FALSE,foundpart = PETSC_FALSE;
13320298fd71SBarry Smith   Mat             Ad     = NULL, adj;
1333b1a0a8a3SJed Brown   IS              ispart,isnumb,*is;
1334b1a0a8a3SJed Brown   PetscErrorCode  ierr;
1335b1a0a8a3SJed Brown 
1336b1a0a8a3SJed Brown   PetscFunctionBegin;
13378f3b4b4dSDmitry Karpeev   if (nloc < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"number of local subdomains must > 0, got nloc = %D",nloc);
1338b1a0a8a3SJed Brown 
1339b1a0a8a3SJed Brown   /* Get prefix, row distribution, and block size */
1340b1a0a8a3SJed Brown   ierr = MatGetOptionsPrefix(A,&prefix);CHKERRQ(ierr);
1341b1a0a8a3SJed Brown   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
1342b1a0a8a3SJed Brown   ierr = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
1343b1a0a8a3SJed 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);
1344b1a0a8a3SJed Brown 
1345b1a0a8a3SJed Brown   /* Get diagonal block from matrix if possible */
1346976e8c5aSLisandro Dalcin   ierr = MatHasOperation(A,MATOP_GET_DIAGONAL_BLOCK,&hasop);CHKERRQ(ierr);
1347976e8c5aSLisandro Dalcin   if (hasop) {
134811bd1e4dSLisandro Dalcin     ierr = MatGetDiagonalBlock(A,&Ad);CHKERRQ(ierr);
1349b1a0a8a3SJed Brown   }
1350b1a0a8a3SJed Brown   if (Ad) {
1351b9e7e5c1SBarry Smith     ierr = PetscObjectBaseTypeCompare((PetscObject)Ad,MATSEQBAIJ,&isbaij);CHKERRQ(ierr);
1352b9e7e5c1SBarry Smith     if (!isbaij) {ierr = PetscObjectBaseTypeCompare((PetscObject)Ad,MATSEQSBAIJ,&isbaij);CHKERRQ(ierr);}
1353b1a0a8a3SJed Brown   }
13548f3b4b4dSDmitry Karpeev   if (Ad && nloc > 1) {
1355b1a0a8a3SJed Brown     PetscBool  match,done;
1356b1a0a8a3SJed Brown     /* Try to setup a good matrix partitioning if available */
1357b1a0a8a3SJed Brown     ierr = MatPartitioningCreate(PETSC_COMM_SELF,&mpart);CHKERRQ(ierr);
1358b1a0a8a3SJed Brown     ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
1359b1a0a8a3SJed Brown     ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
1360251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGCURRENT,&match);CHKERRQ(ierr);
1361b1a0a8a3SJed Brown     if (!match) {
1362251f4c67SDmitry Karpeev       ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGSQUARE,&match);CHKERRQ(ierr);
1363b1a0a8a3SJed Brown     }
1364b1a0a8a3SJed Brown     if (!match) { /* assume a "good" partitioner is available */
13651a83f524SJed Brown       PetscInt       na;
13661a83f524SJed Brown       const PetscInt *ia,*ja;
1367b1a0a8a3SJed Brown       ierr = MatGetRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1368b1a0a8a3SJed Brown       if (done) {
1369b1a0a8a3SJed Brown         /* Build adjacency matrix by hand. Unfortunately a call to
1370b1a0a8a3SJed Brown            MatConvert(Ad,MATMPIADJ,MAT_INITIAL_MATRIX,&adj) will
1371b1a0a8a3SJed Brown            remove the block-aij structure and we cannot expect
1372b1a0a8a3SJed Brown            MatPartitioning to split vertices as we need */
13731a83f524SJed Brown         PetscInt       i,j,len,nnz,cnt,*iia=0,*jja=0;
13741a83f524SJed Brown         const PetscInt *row;
1375b1a0a8a3SJed Brown         nnz = 0;
1376b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* count number of nonzeros */
1377b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1378b1a0a8a3SJed Brown           row = ja + ia[i];
1379b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
1380b1a0a8a3SJed Brown             if (row[j] == i) { /* don't count diagonal */
1381b1a0a8a3SJed Brown               len--; break;
1382b1a0a8a3SJed Brown             }
1383b1a0a8a3SJed Brown           }
1384b1a0a8a3SJed Brown           nnz += len;
1385b1a0a8a3SJed Brown         }
1386854ce69bSBarry Smith         ierr   = PetscMalloc1(na+1,&iia);CHKERRQ(ierr);
1387854ce69bSBarry Smith         ierr   = PetscMalloc1(nnz,&jja);CHKERRQ(ierr);
1388b1a0a8a3SJed Brown         nnz    = 0;
1389b1a0a8a3SJed Brown         iia[0] = 0;
1390b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* fill adjacency */
1391b1a0a8a3SJed Brown           cnt = 0;
1392b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1393b1a0a8a3SJed Brown           row = ja + ia[i];
1394b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
13952fa5cd67SKarl Rupp             if (row[j] != i) jja[nnz+cnt++] = row[j]; /* if not diagonal */
1396b1a0a8a3SJed Brown           }
1397b1a0a8a3SJed Brown           nnz += cnt;
1398b1a0a8a3SJed Brown           iia[i+1] = nnz;
1399b1a0a8a3SJed Brown         }
1400b1a0a8a3SJed Brown         /* Partitioning of the adjacency matrix */
14010298fd71SBarry Smith         ierr      = MatCreateMPIAdj(PETSC_COMM_SELF,na,na,iia,jja,NULL,&adj);CHKERRQ(ierr);
1402b1a0a8a3SJed Brown         ierr      = MatPartitioningSetAdjacency(mpart,adj);CHKERRQ(ierr);
14038f3b4b4dSDmitry Karpeev         ierr      = MatPartitioningSetNParts(mpart,nloc);CHKERRQ(ierr);
1404b1a0a8a3SJed Brown         ierr      = MatPartitioningApply(mpart,&ispart);CHKERRQ(ierr);
1405b1a0a8a3SJed Brown         ierr      = ISPartitioningToNumbering(ispart,&isnumb);CHKERRQ(ierr);
14066bf464f9SBarry Smith         ierr      = MatDestroy(&adj);CHKERRQ(ierr);
1407b1a0a8a3SJed Brown         foundpart = PETSC_TRUE;
1408b1a0a8a3SJed Brown       }
1409b1a0a8a3SJed Brown       ierr = MatRestoreRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1410b1a0a8a3SJed Brown     }
14116bf464f9SBarry Smith     ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
1412b1a0a8a3SJed Brown   }
14138f3b4b4dSDmitry Karpeev   ierr = PetscMalloc1(nloc,&is);CHKERRQ(ierr);
1414b1a0a8a3SJed Brown   if (!foundpart) {
1415b1a0a8a3SJed Brown 
1416b1a0a8a3SJed Brown     /* Partitioning by contiguous chunks of rows */
1417b1a0a8a3SJed Brown 
1418b1a0a8a3SJed Brown     PetscInt mbs   = (rend-rstart)/bs;
1419b1a0a8a3SJed Brown     PetscInt start = rstart;
14208f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
14218f3b4b4dSDmitry Karpeev       PetscInt count = (mbs/nloc + ((mbs % nloc) > i)) * bs;
1422b1a0a8a3SJed Brown       ierr   = ISCreateStride(PETSC_COMM_SELF,count,start,1,&is[i]);CHKERRQ(ierr);
1423b1a0a8a3SJed Brown       start += count;
1424b1a0a8a3SJed Brown     }
1425b1a0a8a3SJed Brown 
1426b1a0a8a3SJed Brown   } else {
1427b1a0a8a3SJed Brown 
1428b1a0a8a3SJed Brown     /* Partitioning by adjacency of diagonal block  */
1429b1a0a8a3SJed Brown 
1430b1a0a8a3SJed Brown     const PetscInt *numbering;
1431b1a0a8a3SJed Brown     PetscInt       *count,nidx,*indices,*newidx,start=0;
1432b1a0a8a3SJed Brown     /* Get node count in each partition */
14338f3b4b4dSDmitry Karpeev     ierr = PetscMalloc1(nloc,&count);CHKERRQ(ierr);
14348f3b4b4dSDmitry Karpeev     ierr = ISPartitioningCount(ispart,nloc,count);CHKERRQ(ierr);
1435b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
14368f3b4b4dSDmitry Karpeev       for (i=0; i<nloc; i++) count[i] *= bs;
1437b1a0a8a3SJed Brown     }
1438b1a0a8a3SJed Brown     /* Build indices from node numbering */
1439b1a0a8a3SJed Brown     ierr = ISGetLocalSize(isnumb,&nidx);CHKERRQ(ierr);
1440785e854fSJed Brown     ierr = PetscMalloc1(nidx,&indices);CHKERRQ(ierr);
1441b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] = i; /* needs to be initialized */
1442b1a0a8a3SJed Brown     ierr = ISGetIndices(isnumb,&numbering);CHKERRQ(ierr);
1443b1a0a8a3SJed Brown     ierr = PetscSortIntWithPermutation(nidx,numbering,indices);CHKERRQ(ierr);
1444b1a0a8a3SJed Brown     ierr = ISRestoreIndices(isnumb,&numbering);CHKERRQ(ierr);
1445b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
1446785e854fSJed Brown       ierr = PetscMalloc1(nidx*bs,&newidx);CHKERRQ(ierr);
14472fa5cd67SKarl Rupp       for (i=0; i<nidx; i++) {
14482fa5cd67SKarl Rupp         for (j=0; j<bs; j++) newidx[i*bs+j] = indices[i]*bs + j;
14492fa5cd67SKarl Rupp       }
1450b1a0a8a3SJed Brown       ierr    = PetscFree(indices);CHKERRQ(ierr);
1451b1a0a8a3SJed Brown       nidx   *= bs;
1452b1a0a8a3SJed Brown       indices = newidx;
1453b1a0a8a3SJed Brown     }
1454b1a0a8a3SJed Brown     /* Shift to get global indices */
1455b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] += rstart;
1456b1a0a8a3SJed Brown 
1457b1a0a8a3SJed Brown     /* Build the index sets for each block */
14588f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
1459b1a0a8a3SJed Brown       ierr   = ISCreateGeneral(PETSC_COMM_SELF,count[i],&indices[start],PETSC_COPY_VALUES,&is[i]);CHKERRQ(ierr);
1460b1a0a8a3SJed Brown       ierr   = ISSort(is[i]);CHKERRQ(ierr);
1461b1a0a8a3SJed Brown       start += count[i];
1462b1a0a8a3SJed Brown     }
1463b1a0a8a3SJed Brown 
1464302440fdSBarry Smith     ierr = PetscFree(count);CHKERRQ(ierr);
1465302440fdSBarry Smith     ierr = PetscFree(indices);CHKERRQ(ierr);
1466fcfd50ebSBarry Smith     ierr = ISDestroy(&isnumb);CHKERRQ(ierr);
1467fcfd50ebSBarry Smith     ierr = ISDestroy(&ispart);CHKERRQ(ierr);
1468b1a0a8a3SJed Brown   }
14696a4f0f73SDmitry Karpeev   *iis = is;
14708f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
14718f3b4b4dSDmitry Karpeev }
14728f3b4b4dSDmitry Karpeev 
1473b541e6a4SDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateStraddlingSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
14748f3b4b4dSDmitry Karpeev {
14758f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
14768f3b4b4dSDmitry Karpeev 
14778f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
14788f3b4b4dSDmitry Karpeev   ierr = MatSubdomainsCreateCoalesce(A,N,n,iis);CHKERRQ(ierr);
14798f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
14808f3b4b4dSDmitry Karpeev }
14818f3b4b4dSDmitry Karpeev 
14828f3b4b4dSDmitry Karpeev 
14838f3b4b4dSDmitry Karpeev 
14848f3b4b4dSDmitry Karpeev /*@C
14858f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains - Creates n index sets defining n nonoverlapping subdomains for the additive
14868f3b4b4dSDmitry Karpeev    Schwarz preconditioner for a any problem based on its matrix.
14878f3b4b4dSDmitry Karpeev 
14888f3b4b4dSDmitry Karpeev    Collective
14898f3b4b4dSDmitry Karpeev 
14908f3b4b4dSDmitry Karpeev    Input Parameters:
14918f3b4b4dSDmitry Karpeev +  A       - The global matrix operator
14928f3b4b4dSDmitry Karpeev -  N       - the number of global subdomains requested
14938f3b4b4dSDmitry Karpeev 
14948f3b4b4dSDmitry Karpeev    Output Parameters:
14958f3b4b4dSDmitry Karpeev +  n   - the number of subdomains created on this processor
14968f3b4b4dSDmitry Karpeev -  iis - the array of index sets defining the local inner subdomains (on which the correction is applied)
14978f3b4b4dSDmitry Karpeev 
14988f3b4b4dSDmitry Karpeev    Level: advanced
14998f3b4b4dSDmitry Karpeev 
15008f3b4b4dSDmitry Karpeev    Note: When N >= A's communicator size, each subdomain is local -- contained within a single processor.
15018f3b4b4dSDmitry Karpeev          When N < size, the subdomains are 'straddling' (processor boundaries) and are no longer local.
15028f3b4b4dSDmitry Karpeev          The resulting subdomains can be use in PCGASMSetSubdomains(pc,n,iss,NULL).  The overlapping
15038f3b4b4dSDmitry Karpeev 	 outer subdomains will be automatically generated from these according to the requested amount of
15048f3b4b4dSDmitry Karpeev 	 overlap; this is currently supported only with local subdomains.
15058f3b4b4dSDmitry Karpeev 
15068f3b4b4dSDmitry Karpeev 
15078f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMDestroySubdomains()
15088f3b4b4dSDmitry Karpeev @*/
1509b541e6a4SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
15108f3b4b4dSDmitry Karpeev {
15118f3b4b4dSDmitry Karpeev   PetscMPIInt     size;
15128f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
15138f3b4b4dSDmitry Karpeev 
15148f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
15158f3b4b4dSDmitry Karpeev   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
15168f3b4b4dSDmitry Karpeev   PetscValidPointer(iis,4);
15178f3b4b4dSDmitry Karpeev 
15188f3b4b4dSDmitry Karpeev   if (N < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Number of subdomains must be > 0, N = %D",N);
15198f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
15208f3b4b4dSDmitry Karpeev   if (N >= size) {
15218f3b4b4dSDmitry Karpeev     *n = N/size + (N%size);
15228f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateLocalSubdomains(A,*n,iis);CHKERRQ(ierr);
15236a4f0f73SDmitry Karpeev   } else {
15248f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateStraddlingSubdomains(A,N,n,iis);CHKERRQ(ierr);
15256a4f0f73SDmitry Karpeev   }
1526b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1527b1a0a8a3SJed Brown }
1528b1a0a8a3SJed Brown 
1529b1a0a8a3SJed Brown /*@C
1530f746d493SDmitry Karpeev    PCGASMDestroySubdomains - Destroys the index sets created with
15318f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains() or PCGASMCreateSubdomains2D. Should be
153206b43e7eSDmitry Karpeev    called after setting subdomains with PCGASMSetSubdomains().
1533b1a0a8a3SJed Brown 
1534b1a0a8a3SJed Brown    Collective
1535b1a0a8a3SJed Brown 
1536b1a0a8a3SJed Brown    Input Parameters:
1537b1a0a8a3SJed Brown +  n   - the number of index sets
15386a4f0f73SDmitry Karpeev .  iis - the array of inner subdomains,
15390298fd71SBarry Smith -  ois - the array of outer subdomains, can be NULL
1540b1a0a8a3SJed Brown 
15416a4f0f73SDmitry Karpeev    Level: intermediate
15426a4f0f73SDmitry Karpeev 
154395452b02SPatrick Sanan    Notes:
154495452b02SPatrick Sanan     this is merely a convenience subroutine that walks each list,
15452c112581SDmitry Karpeev    destroys each IS on the list, and then frees the list. At the end the
15462c112581SDmitry Karpeev    list pointers are set to NULL.
1547b1a0a8a3SJed Brown 
15488f3b4b4dSDmitry Karpeev .seealso: PCGASMCreateSubdomains(), PCGASMSetSubdomains()
1549b1a0a8a3SJed Brown @*/
15502c112581SDmitry Karpeev PetscErrorCode  PCGASMDestroySubdomains(PetscInt n,IS **iis,IS **ois)
1551b1a0a8a3SJed Brown {
1552b1a0a8a3SJed Brown   PetscInt       i;
1553b1a0a8a3SJed Brown   PetscErrorCode ierr;
15545fd66863SKarl Rupp 
1555b1a0a8a3SJed Brown   PetscFunctionBegin;
1556a35b7b57SDmitry Karpeev   if (n <= 0) PetscFunctionReturn(0);
15576a4f0f73SDmitry Karpeev   if (ois) {
15582c112581SDmitry Karpeev     PetscValidPointer(ois,3);
15592c112581SDmitry Karpeev     if (*ois) {
15602c112581SDmitry Karpeev       PetscValidPointer(*ois,3);
1561a35b7b57SDmitry Karpeev       for (i=0; i<n; i++) {
15622c112581SDmitry Karpeev         ierr = ISDestroy(&(*ois)[i]);CHKERRQ(ierr);
1563a35b7b57SDmitry Karpeev       }
1564135757f6SDmitry Karpeev       ierr = PetscFree((*ois));CHKERRQ(ierr);
15652c112581SDmitry Karpeev     }
1566b1a0a8a3SJed Brown   }
1567b9d0fdaaSFande Kong   if (iis) {
1568b9d0fdaaSFande Kong     PetscValidPointer(iis,2);
1569b9d0fdaaSFande Kong     if (*iis) {
1570b9d0fdaaSFande Kong       PetscValidPointer(*iis,2);
1571b9d0fdaaSFande Kong       for (i=0; i<n; i++) {
1572b9d0fdaaSFande Kong         ierr = ISDestroy(&(*iis)[i]);CHKERRQ(ierr);
1573b9d0fdaaSFande Kong       }
1574b9d0fdaaSFande Kong       ierr = PetscFree((*iis));CHKERRQ(ierr);
1575b9d0fdaaSFande Kong     }
1576b9d0fdaaSFande Kong   }
1577b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1578b1a0a8a3SJed Brown }
1579b1a0a8a3SJed Brown 
1580af538404SDmitry Karpeev 
1581af538404SDmitry Karpeev #define PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,xleft_loc,ylow_loc,xright_loc,yhigh_loc,n) \
1582af538404SDmitry Karpeev   {                                                                                                       \
1583af538404SDmitry Karpeev     PetscInt first_row = first/M, last_row = last/M+1;                                                     \
1584af538404SDmitry Karpeev     /*                                                                                                    \
1585af538404SDmitry Karpeev      Compute ylow_loc and yhigh_loc so that (ylow_loc,xleft) and (yhigh_loc,xright) are the corners       \
1586af538404SDmitry Karpeev      of the bounding box of the intersection of the subdomain with the local ownership range (local       \
1587af538404SDmitry Karpeev      subdomain).                                                                                          \
1588af538404SDmitry Karpeev      Also compute xleft_loc and xright_loc as the lower and upper bounds on the first and last rows       \
1589af538404SDmitry Karpeev      of the intersection.                                                                                 \
1590af538404SDmitry Karpeev     */                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             \
1591af538404SDmitry Karpeev     /* ylow_loc is the grid row containing the first element of the local sumbdomain */                   \
1592eec7e3faSDmitry Karpeev     *ylow_loc = PetscMax(first_row,ylow);                                                                    \
1593af538404SDmitry Karpeev     /* xleft_loc is the offset of first element of the local subdomain within its grid row (might actually be outside the local subdomain) */ \
1594eec7e3faSDmitry Karpeev     *xleft_loc = *ylow_loc==first_row ? PetscMax(first%M,xleft) : xleft;                                                                            \
1595af538404SDmitry Karpeev     /* yhigh_loc is the grid row above the last local subdomain element */                                                                    \
1596eec7e3faSDmitry Karpeev     *yhigh_loc = PetscMin(last_row,yhigh);                                                                                                     \
1597af538404SDmitry Karpeev     /* xright is the offset of the end of the  local subdomain within its grid row (might actually be outside the local subdomain) */         \
1598eec7e3faSDmitry Karpeev     *xright_loc = *yhigh_loc==last_row ? PetscMin(xright,last%M) : xright;                                                                          \
1599af538404SDmitry Karpeev     /* Now compute the size of the local subdomain n. */ \
1600c3518bceSDmitry Karpeev     *n = 0;                                               \
1601eec7e3faSDmitry Karpeev     if (*ylow_loc < *yhigh_loc) {                           \
1602af538404SDmitry Karpeev       PetscInt width = xright-xleft;                     \
1603eec7e3faSDmitry Karpeev       *n += width*(*yhigh_loc-*ylow_loc-1);                 \
1604eec7e3faSDmitry Karpeev       *n += PetscMin(PetscMax(*xright_loc-xleft,0),width); \
1605eec7e3faSDmitry Karpeev       *n -= PetscMin(PetscMax(*xleft_loc-xleft,0), width); \
1606af538404SDmitry Karpeev     } \
1607af538404SDmitry Karpeev   }
1608af538404SDmitry Karpeev 
1609c3518bceSDmitry Karpeev 
1610eec7e3faSDmitry Karpeev 
1611b1a0a8a3SJed Brown /*@
1612f746d493SDmitry Karpeev    PCGASMCreateSubdomains2D - Creates the index sets for the overlapping Schwarz
1613b1a0a8a3SJed Brown    preconditioner for a two-dimensional problem on a regular grid.
1614b1a0a8a3SJed Brown 
1615af538404SDmitry Karpeev    Collective
1616b1a0a8a3SJed Brown 
1617b1a0a8a3SJed Brown    Input Parameters:
161806b43e7eSDmitry Karpeev +  M, N               - the global number of grid points in the x and y directions
1619af538404SDmitry Karpeev .  Mdomains, Ndomains - the global number of subdomains in the x and y directions
1620b1a0a8a3SJed Brown .  dof                - degrees of freedom per node
1621b1a0a8a3SJed Brown -  overlap            - overlap in mesh lines
1622b1a0a8a3SJed Brown 
1623b1a0a8a3SJed Brown    Output Parameters:
1624af538404SDmitry Karpeev +  Nsub - the number of local subdomains created
16256a4f0f73SDmitry Karpeev .  iis  - array of index sets defining inner (nonoverlapping) subdomains
16266a4f0f73SDmitry Karpeev -  ois  - array of index sets defining outer (overlapping, if overlap > 0) subdomains
1627b1a0a8a3SJed Brown 
1628b1a0a8a3SJed Brown 
1629b1a0a8a3SJed Brown    Level: advanced
1630b1a0a8a3SJed Brown 
16318f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(), PCGASMSetOverlap()
1632b1a0a8a3SJed Brown @*/
16336a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains2D(PC pc,PetscInt M,PetscInt N,PetscInt Mdomains,PetscInt Ndomains,PetscInt dof,PetscInt overlap,PetscInt *nsub,IS **iis,IS **ois)
1634b1a0a8a3SJed Brown {
1635b1a0a8a3SJed Brown   PetscErrorCode ierr;
16362bbb417fSDmitry Karpeev   PetscMPIInt    size, rank;
16372bbb417fSDmitry Karpeev   PetscInt       i, j;
16382bbb417fSDmitry Karpeev   PetscInt       maxheight, maxwidth;
16392bbb417fSDmitry Karpeev   PetscInt       xstart, xleft, xright, xleft_loc, xright_loc;
16402bbb417fSDmitry Karpeev   PetscInt       ystart, ylow,  yhigh,  ylow_loc,  yhigh_loc;
1641eec7e3faSDmitry Karpeev   PetscInt       x[2][2], y[2][2], n[2];
16422bbb417fSDmitry Karpeev   PetscInt       first, last;
16432bbb417fSDmitry Karpeev   PetscInt       nidx, *idx;
16442bbb417fSDmitry Karpeev   PetscInt       ii,jj,s,q,d;
1645af538404SDmitry Karpeev   PetscInt       k,kk;
16462bbb417fSDmitry Karpeev   PetscMPIInt    color;
16472bbb417fSDmitry Karpeev   MPI_Comm       comm, subcomm;
16486a4f0f73SDmitry Karpeev   IS             **xis = 0, **is = ois, **is_local = iis;
1649d34fcf5fSBarry Smith 
1650b1a0a8a3SJed Brown   PetscFunctionBegin;
16512bbb417fSDmitry Karpeev   ierr = PetscObjectGetComm((PetscObject)pc, &comm);CHKERRQ(ierr);
16522bbb417fSDmitry Karpeev   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
16532bbb417fSDmitry Karpeev   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
16542bbb417fSDmitry Karpeev   ierr = MatGetOwnershipRange(pc->pmat, &first, &last);CHKERRQ(ierr);
1655d34fcf5fSBarry 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) "
16562bbb417fSDmitry Karpeev                                       "does not respect the number of degrees of freedom per grid point %D", first, last, dof);
1657d34fcf5fSBarry Smith 
1658af538404SDmitry Karpeev   /* Determine the number of domains with nonzero intersections with the local ownership range. */
16592bbb417fSDmitry Karpeev   s      = 0;
1660af538404SDmitry Karpeev   ystart = 0;
1661af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1662af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1663af538404SDmitry 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);
1664eec7e3faSDmitry Karpeev     /* Vertical domain limits with an overlap. */
1665eec7e3faSDmitry Karpeev     ylow   = PetscMax(ystart - overlap,0);
1666eec7e3faSDmitry Karpeev     yhigh  = PetscMin(ystart + maxheight + overlap,N);
1667b1a0a8a3SJed Brown     xstart = 0;
1668af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1669af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1670af538404SDmitry 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);
1671eec7e3faSDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1672eec7e3faSDmitry Karpeev       xleft  = PetscMax(xstart - overlap,0);
1673eec7e3faSDmitry Karpeev       xright = PetscMin(xstart + maxwidth + overlap,M);
1674af538404SDmitry Karpeev       /*
1675af538404SDmitry Karpeev          Determine whether this subdomain intersects this processor's ownership range of pc->pmat.
1676af538404SDmitry Karpeev       */
1677c3518bceSDmitry Karpeev       PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
16782fa5cd67SKarl Rupp       if (nidx) ++s;
1679af538404SDmitry Karpeev       xstart += maxwidth;
1680af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
1681af538404SDmitry Karpeev     ystart += maxheight;
1682af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
16832fa5cd67SKarl Rupp 
1684af538404SDmitry Karpeev   /* Now we can allocate the necessary number of ISs. */
1685af538404SDmitry Karpeev   *nsub  = s;
1686854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is);CHKERRQ(ierr);
1687854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is_local);CHKERRQ(ierr);
1688af538404SDmitry Karpeev   s      = 0;
1689af538404SDmitry Karpeev   ystart = 0;
1690af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1691af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1692af538404SDmitry 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);
1693af538404SDmitry Karpeev     /* Vertical domain limits with an overlap. */
1694eec7e3faSDmitry Karpeev     y[0][0] = PetscMax(ystart - overlap,0);
1695eec7e3faSDmitry Karpeev     y[0][1] = PetscMin(ystart + maxheight + overlap,N);
1696eec7e3faSDmitry Karpeev     /* Vertical domain limits without an overlap. */
1697eec7e3faSDmitry Karpeev     y[1][0] = ystart;
1698eec7e3faSDmitry Karpeev     y[1][1] = PetscMin(ystart + maxheight,N);
1699eec7e3faSDmitry Karpeev     xstart  = 0;
1700af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1701af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1702af538404SDmitry 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);
1703af538404SDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1704eec7e3faSDmitry Karpeev       x[0][0] = PetscMax(xstart - overlap,0);
1705eec7e3faSDmitry Karpeev       x[0][1] = PetscMin(xstart + maxwidth + overlap,M);
1706eec7e3faSDmitry Karpeev       /* Horizontal domain limits without an overlap. */
1707eec7e3faSDmitry Karpeev       x[1][0] = xstart;
1708eec7e3faSDmitry Karpeev       x[1][1] = PetscMin(xstart+maxwidth,M);
17092bbb417fSDmitry Karpeev       /*
17102bbb417fSDmitry Karpeev          Determine whether this domain intersects this processor's ownership range of pc->pmat.
17112bbb417fSDmitry Karpeev          Do this twice: first for the domains with overlaps, and once without.
17122bbb417fSDmitry Karpeev          During the first pass create the subcommunicators, and use them on the second pass as well.
17132bbb417fSDmitry Karpeev       */
17142bbb417fSDmitry Karpeev       for (q = 0; q < 2; ++q) {
1715cc96b2e5SBarry Smith         PetscBool split = PETSC_FALSE;
17162bbb417fSDmitry Karpeev         /*
17172bbb417fSDmitry Karpeev           domain limits, (xleft, xright) and (ylow, yheigh) are adjusted
17182bbb417fSDmitry Karpeev           according to whether the domain with an overlap or without is considered.
17192bbb417fSDmitry Karpeev         */
17202bbb417fSDmitry Karpeev         xleft = x[q][0]; xright = x[q][1];
17212bbb417fSDmitry Karpeev         ylow  = y[q][0]; yhigh  = y[q][1];
1722c3518bceSDmitry Karpeev         PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
1723af538404SDmitry Karpeev         nidx *= dof;
1724eec7e3faSDmitry Karpeev         n[q]  = nidx;
17252bbb417fSDmitry Karpeev         /*
1726eec7e3faSDmitry Karpeev          Based on the counted number of indices in the local domain *with an overlap*,
1727af538404SDmitry Karpeev          construct a subcommunicator of all the processors supporting this domain.
1728eec7e3faSDmitry Karpeev          Observe that a domain with an overlap might have nontrivial local support,
1729eec7e3faSDmitry Karpeev          while the domain without an overlap might not.  Hence, the decision to participate
1730eec7e3faSDmitry Karpeev          in the subcommunicator must be based on the domain with an overlap.
17312bbb417fSDmitry Karpeev          */
17322bbb417fSDmitry Karpeev         if (q == 0) {
17332fa5cd67SKarl Rupp           if (nidx) color = 1;
17342fa5cd67SKarl Rupp           else color = MPI_UNDEFINED;
17352bbb417fSDmitry Karpeev           ierr = MPI_Comm_split(comm, color, rank, &subcomm);CHKERRQ(ierr);
1736cc96b2e5SBarry Smith           split = PETSC_TRUE;
17372bbb417fSDmitry Karpeev         }
1738af538404SDmitry Karpeev         /*
1739eec7e3faSDmitry Karpeev          Proceed only if the number of local indices *with an overlap* is nonzero.
1740af538404SDmitry Karpeev          */
1741eec7e3faSDmitry Karpeev         if (n[0]) {
17422fa5cd67SKarl Rupp           if (q == 0) xis = is;
1743af538404SDmitry Karpeev           if (q == 1) {
1744af538404SDmitry Karpeev             /*
1745eec7e3faSDmitry Karpeev              The IS for the no-overlap subdomain shares a communicator with the overlapping domain.
1746af538404SDmitry Karpeev              Moreover, if the overlap is zero, the two ISs are identical.
1747af538404SDmitry Karpeev              */
1748b1a0a8a3SJed Brown             if (overlap == 0) {
1749eec7e3faSDmitry Karpeev               (*is_local)[s] = (*is)[s];
17502bbb417fSDmitry Karpeev               ierr           = PetscObjectReference((PetscObject)(*is)[s]);CHKERRQ(ierr);
17512bbb417fSDmitry Karpeev               continue;
1752d34fcf5fSBarry Smith             } else {
17536a4f0f73SDmitry Karpeev               xis     = is_local;
1754eec7e3faSDmitry Karpeev               subcomm = ((PetscObject)(*is)[s])->comm;
17552bbb417fSDmitry Karpeev             }
1756af538404SDmitry Karpeev           } /* if (q == 1) */
17570298fd71SBarry Smith           idx  = NULL;
1758785e854fSJed Brown           ierr = PetscMalloc1(nidx,&idx);CHKERRQ(ierr);
1759eec7e3faSDmitry Karpeev           if (nidx) {
17602bbb417fSDmitry Karpeev             k = 0;
17612bbb417fSDmitry Karpeev             for (jj=ylow_loc; jj<yhigh_loc; ++jj) {
1762af538404SDmitry Karpeev               PetscInt x0 = (jj==ylow_loc) ? xleft_loc : xleft;
1763af538404SDmitry Karpeev               PetscInt x1 = (jj==yhigh_loc-1) ? xright_loc : xright;
1764af538404SDmitry Karpeev               kk = dof*(M*jj + x0);
17652bbb417fSDmitry Karpeev               for (ii=x0; ii<x1; ++ii) {
17662bbb417fSDmitry Karpeev                 for (d = 0; d < dof; ++d) {
17672bbb417fSDmitry Karpeev                   idx[k++] = kk++;
1768b1a0a8a3SJed Brown                 }
1769b1a0a8a3SJed Brown               }
1770b1a0a8a3SJed Brown             }
1771eec7e3faSDmitry Karpeev           }
17726a4f0f73SDmitry Karpeev           ierr = ISCreateGeneral(subcomm,nidx,idx,PETSC_OWN_POINTER,(*xis)+s);CHKERRQ(ierr);
1773cc96b2e5SBarry Smith           if (split) {
1774cc96b2e5SBarry Smith             ierr = MPI_Comm_free(&subcomm);CHKERRQ(ierr);
1775cc96b2e5SBarry Smith           }
1776eec7e3faSDmitry Karpeev         }/* if (n[0]) */
17772bbb417fSDmitry Karpeev       }/* for (q = 0; q < 2; ++q) */
17782fa5cd67SKarl Rupp       if (n[0]) ++s;
1779af538404SDmitry Karpeev       xstart += maxwidth;
1780af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
17812bbb417fSDmitry Karpeev     ystart += maxheight;
1782af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
1783b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1784b1a0a8a3SJed Brown }
1785b1a0a8a3SJed Brown 
1786b1a0a8a3SJed Brown /*@C
178706b43e7eSDmitry Karpeev     PCGASMGetSubdomains - Gets the subdomains supported on this processor
178806b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1789b1a0a8a3SJed Brown 
1790b1a0a8a3SJed Brown     Not Collective
1791b1a0a8a3SJed Brown 
1792b1a0a8a3SJed Brown     Input Parameter:
1793b1a0a8a3SJed Brown .   pc - the preconditioner context
1794b1a0a8a3SJed Brown 
1795b1a0a8a3SJed Brown     Output Parameters:
1796b1a0a8a3SJed Brown +   n   - the number of subdomains for this processor (default value = 1)
17970298fd71SBarry Smith .   iis - the index sets that define the inner subdomains (without overlap) supported on this processor (can be NULL)
17980298fd71SBarry Smith -   ois - the index sets that define the outer subdomains (with overlap) supported on this processor (can be NULL)
1799b1a0a8a3SJed Brown 
1800b1a0a8a3SJed Brown 
1801b1a0a8a3SJed Brown     Notes:
18026a4f0f73SDmitry Karpeev     The user is responsible for destroying the ISs and freeing the returned arrays.
1803b1a0a8a3SJed Brown     The IS numbering is in the parallel, global numbering of the vector.
1804b1a0a8a3SJed Brown 
1805b1a0a8a3SJed Brown     Level: advanced
1806b1a0a8a3SJed Brown 
18078f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(), PCGASMCreateSubdomains2D(),
18088f3b4b4dSDmitry Karpeev           PCGASMSetSubdomains(), PCGASMGetSubmatrices()
1809b1a0a8a3SJed Brown @*/
18106a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMGetSubdomains(PC pc,PetscInt *n,IS *iis[],IS *ois[])
1811b1a0a8a3SJed Brown {
1812f746d493SDmitry Karpeev   PC_GASM        *osm;
1813b1a0a8a3SJed Brown   PetscErrorCode ierr;
1814b1a0a8a3SJed Brown   PetscBool      match;
18156a4f0f73SDmitry Karpeev   PetscInt       i;
18165fd66863SKarl Rupp 
1817b1a0a8a3SJed Brown   PetscFunctionBegin;
1818b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1819251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1820ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Incorrect object type: expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1821f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1822ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
18236a4f0f73SDmitry Karpeev   if (iis) {
1824785e854fSJed Brown     ierr = PetscMalloc1(osm->n, iis);CHKERRQ(ierr);
18256a4f0f73SDmitry Karpeev   }
18266a4f0f73SDmitry Karpeev   if (ois) {
1827785e854fSJed Brown     ierr = PetscMalloc1(osm->n, ois);CHKERRQ(ierr);
18286a4f0f73SDmitry Karpeev   }
18296a4f0f73SDmitry Karpeev   if (iis || ois) {
18306a4f0f73SDmitry Karpeev     for (i = 0; i < osm->n; ++i) {
18316a4f0f73SDmitry Karpeev       if (iis) (*iis)[i] = osm->iis[i];
18326a4f0f73SDmitry Karpeev       if (ois) (*ois)[i] = osm->ois[i];
18336a4f0f73SDmitry Karpeev     }
1834b1a0a8a3SJed Brown   }
1835b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1836b1a0a8a3SJed Brown }
1837b1a0a8a3SJed Brown 
1838b1a0a8a3SJed Brown /*@C
183906b43e7eSDmitry Karpeev     PCGASMGetSubmatrices - Gets the local submatrices (for this processor
1840b1a0a8a3SJed Brown     only) for the additive Schwarz preconditioner.
1841b1a0a8a3SJed Brown 
1842b1a0a8a3SJed Brown     Not Collective
1843b1a0a8a3SJed Brown 
1844b1a0a8a3SJed Brown     Input Parameter:
1845b1a0a8a3SJed Brown .   pc - the preconditioner context
1846b1a0a8a3SJed Brown 
1847b1a0a8a3SJed Brown     Output Parameters:
1848b1a0a8a3SJed Brown +   n   - the number of matrices for this processor (default value = 1)
1849b1a0a8a3SJed Brown -   mat - the matrices
1850b1a0a8a3SJed Brown 
185195452b02SPatrick Sanan     Notes:
185295452b02SPatrick Sanan     matrices returned by this routine have the same communicators as the index sets (IS)
18538f3b4b4dSDmitry Karpeev            used to define subdomains in PCGASMSetSubdomains()
1854b1a0a8a3SJed Brown     Level: advanced
1855b1a0a8a3SJed Brown 
18568f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(),
185706b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMSetSubdomains(), PCGASMGetSubdomains()
1858b1a0a8a3SJed Brown @*/
185906b43e7eSDmitry Karpeev PetscErrorCode  PCGASMGetSubmatrices(PC pc,PetscInt *n,Mat *mat[])
1860b1a0a8a3SJed Brown {
1861f746d493SDmitry Karpeev   PC_GASM        *osm;
1862b1a0a8a3SJed Brown   PetscErrorCode ierr;
1863b1a0a8a3SJed Brown   PetscBool      match;
1864b1a0a8a3SJed Brown 
1865b1a0a8a3SJed Brown   PetscFunctionBegin;
1866b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1867b1a0a8a3SJed Brown   PetscValidIntPointer(n,2);
1868b1a0a8a3SJed Brown   if (mat) PetscValidPointer(mat,3);
1869ce94432eSBarry Smith   if (!pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call after KSPSetUP() or PCSetUp().");
1870251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1871ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1872f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1873ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
1874b1a0a8a3SJed Brown   if (mat) *mat = osm->pmat;
1875b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1876b1a0a8a3SJed Brown }
1877d709ea83SDmitry Karpeev 
1878d709ea83SDmitry Karpeev /*@
18798f3b4b4dSDmitry Karpeev     PCGASMSetUseDMSubdomains - Indicates whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1880d709ea83SDmitry Karpeev     Logically Collective
1881d709ea83SDmitry Karpeev 
1882d709ea83SDmitry Karpeev     Input Parameter:
1883d709ea83SDmitry Karpeev +   pc  - the preconditioner
1884d709ea83SDmitry Karpeev -   flg - boolean indicating whether to use subdomains defined by the DM
1885d709ea83SDmitry Karpeev 
1886d709ea83SDmitry Karpeev     Options Database Key:
18878f3b4b4dSDmitry Karpeev .   -pc_gasm_dm_subdomains -pc_gasm_overlap -pc_gasm_total_subdomains
1888d709ea83SDmitry Karpeev 
1889d709ea83SDmitry Karpeev     Level: intermediate
1890d709ea83SDmitry Karpeev 
1891d709ea83SDmitry Karpeev     Notes:
18928f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), PCGASMSetTotalSubdomains() or PCGASMSetOverlap() take precedence over PCGASMSetUseDMSubdomains(),
18938f3b4b4dSDmitry Karpeev     so setting PCGASMSetSubdomains() with nontrivial subdomain ISs or any of PCGASMSetTotalSubdomains() and PCGASMSetOverlap()
18948f3b4b4dSDmitry Karpeev     automatically turns the latter off.
1895d709ea83SDmitry Karpeev 
18968f3b4b4dSDmitry Karpeev .seealso: PCGASMGetUseDMSubdomains(), PCGASMSetSubdomains(), PCGASMSetOverlap()
1897d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
1898d709ea83SDmitry Karpeev @*/
18998f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetUseDMSubdomains(PC pc,PetscBool flg)
1900d709ea83SDmitry Karpeev {
1901d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1902d709ea83SDmitry Karpeev   PetscErrorCode ierr;
1903d709ea83SDmitry Karpeev   PetscBool      match;
1904d709ea83SDmitry Karpeev 
1905d709ea83SDmitry Karpeev   PetscFunctionBegin;
1906d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1907d709ea83SDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
1908d709ea83SDmitry Karpeev   if (pc->setupcalled) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Not for a setup PC.");
1909d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1910d709ea83SDmitry Karpeev   if (match) {
19118f3b4b4dSDmitry Karpeev     if (!osm->user_subdomains && osm->N == PETSC_DETERMINE && osm->overlap < 0) {
1912d709ea83SDmitry Karpeev       osm->dm_subdomains = flg;
1913d709ea83SDmitry Karpeev     }
19148f3b4b4dSDmitry Karpeev   }
1915d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
1916d709ea83SDmitry Karpeev }
1917d709ea83SDmitry Karpeev 
1918d709ea83SDmitry Karpeev /*@
19198f3b4b4dSDmitry Karpeev     PCGASMGetUseDMSubdomains - Returns flag indicating whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1920d709ea83SDmitry Karpeev     Not Collective
1921d709ea83SDmitry Karpeev 
1922d709ea83SDmitry Karpeev     Input Parameter:
1923d709ea83SDmitry Karpeev .   pc  - the preconditioner
1924d709ea83SDmitry Karpeev 
1925d709ea83SDmitry Karpeev     Output Parameter:
1926d709ea83SDmitry Karpeev .   flg - boolean indicating whether to use subdomains defined by the DM
1927d709ea83SDmitry Karpeev 
1928d709ea83SDmitry Karpeev     Level: intermediate
1929d709ea83SDmitry Karpeev 
19308f3b4b4dSDmitry Karpeev .seealso: PCGASMSetUseDMSubdomains(), PCGASMSetOverlap()
1931d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
1932d709ea83SDmitry Karpeev @*/
19338f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMGetUseDMSubdomains(PC pc,PetscBool* flg)
1934d709ea83SDmitry Karpeev {
1935d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1936d709ea83SDmitry Karpeev   PetscErrorCode ierr;
1937d709ea83SDmitry Karpeev   PetscBool      match;
1938d709ea83SDmitry Karpeev 
1939d709ea83SDmitry Karpeev   PetscFunctionBegin;
1940d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1941*534a8f05SLisandro Dalcin   PetscValidBoolPointer(flg,2);
1942d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1943d709ea83SDmitry Karpeev   if (match) {
1944d709ea83SDmitry Karpeev     if (flg) *flg = osm->dm_subdomains;
1945d709ea83SDmitry Karpeev   }
1946d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
1947d709ea83SDmitry Karpeev }
1948