xref: /petsc/src/ksp/pc/impls/gasm/gasm.c (revision ea91fabd689b10ffa874a25595e713551558e06e)
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 */
23*ea91fabdSFande 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 */
32*ea91fabdSFande Kong   VecScatter  pctoouter;
33*ea91fabdSFande Kong   IS          permutationIS;
34*ea91fabdSFande Kong   Mat         permutationP;
35*ea91fabdSFande Kong   Mat         pcmat;
36*ea91fabdSFande Kong   Vec         pcx,pcy;
37f746d493SDmitry Karpeev } PC_GASM;
38b1a0a8a3SJed Brown 
39b1a0a8a3SJed Brown #undef __FUNCT__
408f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMComputeGlobalSubdomainNumbering_Private"
418f3b4b4dSDmitry Karpeev static PetscErrorCode  PCGASMComputeGlobalSubdomainNumbering_Private(PC pc,PetscInt **numbering,PetscInt **permutation)
428f3b4b4dSDmitry Karpeev {
438f3b4b4dSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
448f3b4b4dSDmitry Karpeev   PetscInt       i;
458f3b4b4dSDmitry Karpeev   PetscErrorCode ierr;
468f3b4b4dSDmitry Karpeev 
478f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
488f3b4b4dSDmitry Karpeev   /* Determine the number of globally-distinct subdomains and compute a global numbering for them. */
498f3b4b4dSDmitry Karpeev   ierr = PetscMalloc2(osm->n,numbering,osm->n,permutation);CHKERRQ(ierr);
508f3b4b4dSDmitry Karpeev   ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->iis,NULL,*numbering);CHKERRQ(ierr);
518f3b4b4dSDmitry Karpeev   for (i = 0; i < osm->n; ++i) (*permutation)[i] = i;
528f3b4b4dSDmitry Karpeev   ierr = PetscSortIntWithPermutation(osm->n,*numbering,*permutation);CHKERRQ(ierr);
538f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
548f3b4b4dSDmitry Karpeev }
558f3b4b4dSDmitry Karpeev 
568f3b4b4dSDmitry Karpeev #undef __FUNCT__
5706b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMSubdomainView_Private"
5806b43e7eSDmitry Karpeev static PetscErrorCode  PCGASMSubdomainView_Private(PC pc, PetscInt i, PetscViewer viewer)
59af538404SDmitry Karpeev {
60af538404SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
6106b43e7eSDmitry Karpeev   PetscInt       j,nidx;
62af538404SDmitry Karpeev   const PetscInt *idx;
6306b43e7eSDmitry Karpeev   PetscViewer    sviewer;
64af538404SDmitry Karpeev   char           *cidx;
65af538404SDmitry Karpeev   PetscErrorCode ierr;
66af538404SDmitry Karpeev 
67af538404SDmitry Karpeev   PetscFunctionBegin;
68ce94432eSBarry 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);
694bde246dSDmitry Karpeev   /* Inner subdomains. */
704bde246dSDmitry Karpeev   ierr = ISGetLocalSize(osm->iis[i], &nidx);CHKERRQ(ierr);
714bde246dSDmitry Karpeev   /*
724bde246dSDmitry Karpeev    No more than 15 characters per index plus a space.
734bde246dSDmitry Karpeev    PetscViewerStringSPrintf requires a string of size at least 2, so use (nidx+1) instead of nidx,
744bde246dSDmitry Karpeev    in case nidx == 0. That will take care of the space for the trailing '\0' as well.
754bde246dSDmitry Karpeev    For nidx == 0, the whole string 16 '\0'.
764bde246dSDmitry Karpeev    */
7789d949e2SBarry Smith   ierr = PetscMalloc1(16*(nidx+1)+1, &cidx);CHKERRQ(ierr);
784bde246dSDmitry Karpeev   ierr = PetscViewerStringOpen(PETSC_COMM_SELF, cidx, 16*(nidx+1)+1, &sviewer);CHKERRQ(ierr);
794bde246dSDmitry Karpeev   ierr = ISGetIndices(osm->iis[i], &idx);CHKERRQ(ierr);
804bde246dSDmitry Karpeev   for (j = 0; j < nidx; ++j) {
814bde246dSDmitry Karpeev     ierr = PetscViewerStringSPrintf(sviewer, "%D ", idx[j]);CHKERRQ(ierr);
824bde246dSDmitry Karpeev   }
834bde246dSDmitry Karpeev   ierr = ISRestoreIndices(osm->iis[i],&idx);CHKERRQ(ierr);
844bde246dSDmitry Karpeev   ierr = PetscViewerDestroy(&sviewer);CHKERRQ(ierr);
854bde246dSDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "Inner subdomain:\n");CHKERRQ(ierr);
864bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
871575c14dSBarry Smith   ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
884bde246dSDmitry Karpeev   ierr = PetscViewerASCIISynchronizedPrintf(viewer, "%s", cidx);CHKERRQ(ierr);
894bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
901575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
914bde246dSDmitry Karpeev   ierr = PetscViewerASCIIPrintf(viewer, "\n");CHKERRQ(ierr);
924bde246dSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
934bde246dSDmitry Karpeev   ierr = PetscFree(cidx);CHKERRQ(ierr);
944bde246dSDmitry Karpeev   /* Outer subdomains. */
956a4f0f73SDmitry Karpeev   ierr = ISGetLocalSize(osm->ois[i], &nidx);CHKERRQ(ierr);
96eec7e3faSDmitry Karpeev   /*
97eec7e3faSDmitry Karpeev    No more than 15 characters per index plus a space.
98eec7e3faSDmitry Karpeev    PetscViewerStringSPrintf requires a string of size at least 2, so use (nidx+1) instead of nidx,
99eec7e3faSDmitry Karpeev    in case nidx == 0. That will take care of the space for the trailing '\0' as well.
100eec7e3faSDmitry Karpeev    For nidx == 0, the whole string 16 '\0'.
101eec7e3faSDmitry Karpeev    */
10289d949e2SBarry Smith   ierr = PetscMalloc1(16*(nidx+1)+1, &cidx);CHKERRQ(ierr);
10306b43e7eSDmitry Karpeev   ierr = PetscViewerStringOpen(PETSC_COMM_SELF, cidx, 16*(nidx+1)+1, &sviewer);CHKERRQ(ierr);
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 #undef __FUNCT__
12306b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMPrintSubdomains"
12406b43e7eSDmitry Karpeev static PetscErrorCode  PCGASMPrintSubdomains(PC pc)
12506b43e7eSDmitry Karpeev {
12606b43e7eSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
12706b43e7eSDmitry Karpeev   const char     *prefix;
12806b43e7eSDmitry Karpeev   char           fname[PETSC_MAX_PATH_LEN+1];
1298f3b4b4dSDmitry Karpeev   PetscInt       l, d, count;
1308f3b4b4dSDmitry Karpeev   PetscBool      doprint,found;
1310298fd71SBarry Smith   PetscViewer    viewer, sviewer = NULL;
1328f3b4b4dSDmitry Karpeev   PetscInt       *numbering,*permutation;/* global numbering of locally-supported subdomains and the permutation from the local ordering */
13306b43e7eSDmitry Karpeev   PetscErrorCode ierr;
13406b43e7eSDmitry Karpeev 
13506b43e7eSDmitry Karpeev   PetscFunctionBegin;
13606b43e7eSDmitry Karpeev   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
1378f3b4b4dSDmitry Karpeev   doprint  = PETSC_FALSE;
1388f3b4b4dSDmitry Karpeev   ierr = PetscOptionsGetBool(prefix,"-pc_gasm_print_subdomains",&doprint,NULL);CHKERRQ(ierr);
1398f3b4b4dSDmitry Karpeev   if (!doprint) PetscFunctionReturn(0);
14006b43e7eSDmitry Karpeev   ierr = PetscOptionsGetString(prefix,"-pc_gasm_print_subdomains",fname,PETSC_MAX_PATH_LEN,&found);CHKERRQ(ierr);
14106b43e7eSDmitry Karpeev   if (!found) { ierr = PetscStrcpy(fname,"stdout");CHKERRQ(ierr); };
142ce94432eSBarry Smith   ierr = PetscViewerASCIIOpen(PetscObjectComm((PetscObject)pc),fname,&viewer);CHKERRQ(ierr);
1434bde246dSDmitry Karpeev   /*
1444bde246dSDmitry Karpeev    Make sure the viewer has a name. Otherwise this may cause a deadlock or other weird errors when creating a subcomm viewer:
1454bde246dSDmitry Karpeev    the subcomm viewer will attempt to inherit the viewer's name, which, if not set, will be constructed collectively on the comm.
1464bde246dSDmitry Karpeev   */
1474bde246dSDmitry Karpeev   ierr = PetscObjectName((PetscObject)viewer);CHKERRQ(ierr);
1484bde246dSDmitry Karpeev   l    = 0;
1498f3b4b4dSDmitry Karpeev   ierr = PCGASMComputeGlobalSubdomainNumbering_Private(pc,&numbering,&permutation);CHKERRQ(ierr);
1508f3b4b4dSDmitry Karpeev   for (count = 0; count < osm->N; ++count) {
1514bde246dSDmitry Karpeev     /* Now let subdomains go one at a time in the global numbering order and print their subdomain/solver info. */
1524bde246dSDmitry Karpeev     if (l<osm->n) {
1534bde246dSDmitry Karpeev       d = permutation[l]; /* d is the local number of the l-th smallest (in the global ordering) among the locally supported subdomains */
1544bde246dSDmitry Karpeev       if (numbering[d] == count) {
1553f08860eSBarry Smith         ierr = PetscViewerGetSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
1564bde246dSDmitry Karpeev         ierr = PCGASMSubdomainView_Private(pc,d,sviewer);CHKERRQ(ierr);
1573f08860eSBarry Smith         ierr = PetscViewerRestoreSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
1584bde246dSDmitry Karpeev         ++l;
159af538404SDmitry Karpeev       }
1604bde246dSDmitry Karpeev     }
161ce94432eSBarry Smith     ierr = MPI_Barrier(PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1624bde246dSDmitry Karpeev   }
1638f3b4b4dSDmitry Karpeev   ierr = PetscFree2(numbering,permutation);CHKERRQ(ierr);
1644bde246dSDmitry Karpeev   ierr = PetscViewerDestroy(&viewer);CHKERRQ(ierr);
165af538404SDmitry Karpeev   PetscFunctionReturn(0);
166af538404SDmitry Karpeev }
167af538404SDmitry Karpeev 
168af538404SDmitry Karpeev 
169af538404SDmitry Karpeev #undef __FUNCT__
170f746d493SDmitry Karpeev #define __FUNCT__ "PCView_GASM"
171f746d493SDmitry Karpeev static PetscErrorCode PCView_GASM(PC pc,PetscViewer viewer)
172b1a0a8a3SJed Brown {
173f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
174af538404SDmitry Karpeev   const char     *prefix;
175b1a0a8a3SJed Brown   PetscErrorCode ierr;
176af538404SDmitry Karpeev   PetscMPIInt    rank, size;
1778f3b4b4dSDmitry Karpeev   PetscInt       bsz;
17806b43e7eSDmitry Karpeev   PetscBool      iascii,view_subdomains=PETSC_FALSE;
179b1a0a8a3SJed Brown   PetscViewer    sviewer;
1808f3b4b4dSDmitry Karpeev   PetscInt       count, l;
1816a4f0f73SDmitry Karpeev   char           overlap[256]     = "user-defined overlap";
1826a4f0f73SDmitry Karpeev   char           gsubdomains[256] = "unknown total number of subdomains";
18306b43e7eSDmitry Karpeev   char           msubdomains[256] = "unknown max number of local subdomains";
1848f3b4b4dSDmitry Karpeev   PetscInt       *numbering,*permutation;/* global numbering of locally-supported subdomains and the permutation from the local ordering */
18511aeaf0aSBarry Smith 
186b1a0a8a3SJed Brown   PetscFunctionBegin;
187ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc), &size);CHKERRQ(ierr);
188ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc), &rank);CHKERRQ(ierr);
18906b43e7eSDmitry Karpeev 
19006b43e7eSDmitry Karpeev   if (osm->overlap >= 0) {
19106b43e7eSDmitry Karpeev     ierr = PetscSNPrintf(overlap,sizeof(overlap),"requested amount of overlap = %D",osm->overlap);CHKERRQ(ierr);
19206b43e7eSDmitry Karpeev   }
1938f3b4b4dSDmitry Karpeev   if (osm->N != PETSC_DETERMINE) {
1948f3b4b4dSDmitry Karpeev     ierr = PetscSNPrintf(gsubdomains, sizeof(gsubdomains), "total number of subdomains = %D",osm->N);CHKERRQ(ierr);
19506b43e7eSDmitry Karpeev   }
1968f3b4b4dSDmitry Karpeev   if (osm->nmax != PETSC_DETERMINE) {
19706b43e7eSDmitry Karpeev     ierr = PetscSNPrintf(msubdomains,sizeof(msubdomains),"max number of local subdomains = %D",osm->nmax);CHKERRQ(ierr);
19806b43e7eSDmitry Karpeev   }
19906b43e7eSDmitry Karpeev 
200af538404SDmitry Karpeev   ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
2010298fd71SBarry Smith   ierr = PetscOptionsGetBool(prefix,"-pc_gasm_view_subdomains",&view_subdomains,NULL);CHKERRQ(ierr);
20206b43e7eSDmitry Karpeev 
20306b43e7eSDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
204b1a0a8a3SJed Brown   if (iascii) {
20506b43e7eSDmitry Karpeev     /*
20606b43e7eSDmitry Karpeev      Make sure the viewer has a name. Otherwise this may cause a deadlock when creating a subcomm viewer:
20706b43e7eSDmitry Karpeev      the subcomm viewer will attempt to inherit the viewer's name, which, if not set, will be constructed
20806b43e7eSDmitry Karpeev      collectively on the comm.
20906b43e7eSDmitry Karpeev      */
21006b43e7eSDmitry Karpeev     ierr = PetscObjectName((PetscObject)viewer);CHKERRQ(ierr);
21106b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"Generalized additive Schwarz:\n");CHKERRQ(ierr);
21206b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"Restriction/interpolation type: %s\n",PCGASMTypes[osm->type]);CHKERRQ(ierr);
21306b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"%s\n",overlap);CHKERRQ(ierr);
21406b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"%s\n",gsubdomains);CHKERRQ(ierr);
21506b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"%s\n",msubdomains);CHKERRQ(ierr);
2161575c14dSBarry Smith     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
2178f3b4b4dSDmitry Karpeev     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d|%d] number of locally-supported subdomains = %D\n",rank,size,osm->n);CHKERRQ(ierr);
218af538404SDmitry Karpeev     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2191575c14dSBarry Smith     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
2206a4f0f73SDmitry Karpeev     /* Cannot take advantage of osm->same_subdomain_solvers without a global numbering of subdomains. */
22106b43e7eSDmitry Karpeev     ierr = PetscViewerASCIIPrintf(viewer,"Subdomain solver info is as follows:\n");CHKERRQ(ierr);
222b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
223b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPrintf(viewer,"- - - - - - - - - - - - - - - - - -\n");CHKERRQ(ierr);
22406b43e7eSDmitry Karpeev     /* Make sure that everybody waits for the banner to be printed. */
225ce94432eSBarry Smith     ierr = MPI_Barrier(PetscObjectComm((PetscObject)viewer));CHKERRQ(ierr);
2264bde246dSDmitry Karpeev     /* Now let subdomains go one at a time in the global numbering order and print their subdomain/solver info. */
2278f3b4b4dSDmitry Karpeev     ierr = PCGASMComputeGlobalSubdomainNumbering_Private(pc,&numbering,&permutation);CHKERRQ(ierr);
22806b43e7eSDmitry Karpeev     l = 0;
2298f3b4b4dSDmitry Karpeev     for (count = 0; count < osm->N; ++count) {
23006b43e7eSDmitry Karpeev       PetscMPIInt srank, ssize;
23106b43e7eSDmitry Karpeev       if (l<osm->n) {
23206b43e7eSDmitry Karpeev         PetscInt d = permutation[l]; /* d is the local number of the l-th smallest (in the global ordering) among the locally supported subdomains */
23306b43e7eSDmitry Karpeev         if (numbering[d] == count) {
2346a4f0f73SDmitry Karpeev           ierr = MPI_Comm_size(((PetscObject)osm->ois[d])->comm, &ssize);CHKERRQ(ierr);
2356a4f0f73SDmitry Karpeev           ierr = MPI_Comm_rank(((PetscObject)osm->ois[d])->comm, &srank);CHKERRQ(ierr);
2363f08860eSBarry Smith           ierr = PetscViewerGetSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
2376a4f0f73SDmitry Karpeev           ierr = ISGetLocalSize(osm->ois[d],&bsz);CHKERRQ(ierr);
2388f3b4b4dSDmitry 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);
2396a4f0f73SDmitry Karpeev           ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
24006b43e7eSDmitry Karpeev           if (view_subdomains) {
24106b43e7eSDmitry Karpeev             ierr = PCGASMSubdomainView_Private(pc,d,sviewer);CHKERRQ(ierr);
24206b43e7eSDmitry Karpeev           }
2436a4f0f73SDmitry Karpeev           if (!pc->setupcalled) {
2441575c14dSBarry Smith             ierr = PetscViewerASCIIPrintf(sviewer, "Solver not set up yet: PCSetUp() not yet called\n");CHKERRQ(ierr);
2452fa5cd67SKarl Rupp           } else {
24606b43e7eSDmitry Karpeev             ierr = KSPView(osm->ksp[d],sviewer);CHKERRQ(ierr);
2476a4f0f73SDmitry Karpeev           }
24806b43e7eSDmitry Karpeev           ierr = PetscViewerASCIIPrintf(sviewer,"- - - - - - - - - - - - - - - - - -\n");CHKERRQ(ierr);
2497b23a99aSBarry Smith           ierr = PetscViewerFlush(sviewer);CHKERRQ(ierr);
2503f08860eSBarry Smith           ierr = PetscViewerRestoreSubViewer(viewer,((PetscObject)osm->ois[d])->comm, &sviewer);CHKERRQ(ierr);
25106b43e7eSDmitry Karpeev           ++l;
252b1a0a8a3SJed Brown         }
25306b43e7eSDmitry Karpeev       }
254ce94432eSBarry Smith       ierr = MPI_Barrier(PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
255b1a0a8a3SJed Brown     }
2568f3b4b4dSDmitry Karpeev     ierr = PetscFree2(numbering,permutation);CHKERRQ(ierr);
257b1a0a8a3SJed Brown     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
258b1a0a8a3SJed Brown   }
259c5e4d11fSDmitry Karpeev   ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
2601575c14dSBarry Smith   ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
261b1a0a8a3SJed Brown   PetscFunctionReturn(0);
262b1a0a8a3SJed Brown }
263b1a0a8a3SJed Brown 
2648f3b4b4dSDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[]);
265af538404SDmitry Karpeev 
266*ea91fabdSFande Kong 
267*ea91fabdSFande Kong #undef __FUNCT__
268*ea91fabdSFande Kong #define __FUNCT__ "PCGASMSetHierarchicalPartitioning"
269*ea91fabdSFande Kong 
270*ea91fabdSFande Kong PetscErrorCode PCGASMSetHierarchicalPartitioning(PC pc)
271*ea91fabdSFande Kong {
272*ea91fabdSFande Kong    PC_GASM              *osm = (PC_GASM*)pc->data;
273*ea91fabdSFande Kong    MatPartitioning       part;
274*ea91fabdSFande Kong    MPI_Comm              comm;
275*ea91fabdSFande Kong    PetscMPIInt           size;
276*ea91fabdSFande Kong    PetscInt              nlocalsubdomains,fromrows_localsize;
277*ea91fabdSFande Kong    IS                    partitioning,fromrows,isn;
278*ea91fabdSFande Kong    Vec                   outervec;
279*ea91fabdSFande Kong    PetscErrorCode        ierr;
280*ea91fabdSFande Kong 
281*ea91fabdSFande Kong    PetscFunctionBegin;
282*ea91fabdSFande Kong    ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
283*ea91fabdSFande Kong    ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
284*ea91fabdSFande Kong    /* we do not need a hierarchical partitioning when
285*ea91fabdSFande Kong     * the total number of subdomains is consistent with
286*ea91fabdSFande Kong     * the number of MPI tasks.
287*ea91fabdSFande Kong     * For the following cases, we do not need to use HP
288*ea91fabdSFande Kong     * */
289*ea91fabdSFande Kong    if(osm->N==PETSC_DETERMINE || osm->N>=size || osm->N==1){
290*ea91fabdSFande Kong 	  PetscFunctionReturn(0);
291*ea91fabdSFande Kong    }
292*ea91fabdSFande Kong    if(size%osm->N != 0){
293*ea91fabdSFande Kong      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);
294*ea91fabdSFande Kong    }
295*ea91fabdSFande Kong    nlocalsubdomains = size/osm->N;
296*ea91fabdSFande Kong    osm->n           = 1;
297*ea91fabdSFande Kong    ierr = MatPartitioningCreate(comm,&part);CHKERRQ(ierr);
298*ea91fabdSFande Kong    ierr = MatPartitioningSetAdjacency(part,pc->pmat);CHKERRQ(ierr);
299*ea91fabdSFande Kong    ierr = MatPartitioningSetType(part,MATPARTITIONINGHIERARCH);CHKERRQ(ierr);
300*ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNcoarseparts(part,osm->N);CHKERRQ(ierr);
301*ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNfineparts(part,nlocalsubdomains);CHKERRQ(ierr);
302*ea91fabdSFande Kong    ierr = MatPartitioningSetFromOptions(part);CHKERRQ(ierr);
303*ea91fabdSFande Kong    /* get new processor owner number of each vertex */
304*ea91fabdSFande Kong    ierr = MatPartitioningApply(part,&partitioning);CHKERRQ(ierr);
305*ea91fabdSFande Kong    ierr = ISBuildTwoSided(partitioning,NULL,&fromrows);CHKERRQ(ierr);
306*ea91fabdSFande Kong    ierr = ISPartitioningToNumbering(partitioning,&isn);CHKERRQ(ierr);
307*ea91fabdSFande Kong    ierr = ISDestroy(&isn);CHKERRQ(ierr);
308*ea91fabdSFande Kong    ierr = ISGetLocalSize(fromrows,&fromrows_localsize);CHKERRQ(ierr);
309*ea91fabdSFande Kong    ierr = MatPartitioningDestroy(&part);CHKERRQ(ierr);
310*ea91fabdSFande Kong    ierr = MatCreateVecs(pc->pmat,&outervec,NULL);CHKERRQ(ierr);
311*ea91fabdSFande Kong    ierr = VecCreateMPI(comm,fromrows_localsize,PETSC_DETERMINE,&(osm->pcx));CHKERRQ(ierr);
312*ea91fabdSFande Kong    ierr = VecDuplicate(osm->pcx,&(osm->pcy));CHKERRQ(ierr);
313*ea91fabdSFande Kong    ierr = VecScatterCreate(osm->pcx,NULL,outervec,fromrows,&(osm->pctoouter));CHKERRQ(ierr);
314*ea91fabdSFande Kong    ierr = MatGetSubMatrix(pc->pmat,fromrows,fromrows,MAT_INITIAL_MATRIX,&(osm->permutationP));CHKERRQ(ierr);
315*ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)fromrows);CHKERRQ(ierr);
316*ea91fabdSFande Kong    osm->permutationIS = fromrows;
317*ea91fabdSFande Kong    osm->pcmat =  pc->pmat;
318*ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
319*ea91fabdSFande Kong    pc->pmat = osm->permutationP;
320*ea91fabdSFande Kong    ierr = VecDestroy(&outervec);CHKERRQ(ierr);
321*ea91fabdSFande Kong    ierr = ISDestroy(&fromrows);CHKERRQ(ierr);
322*ea91fabdSFande Kong    ierr = ISDestroy(&partitioning);CHKERRQ(ierr);
323*ea91fabdSFande Kong    osm->n           = PETSC_DETERMINE;
324*ea91fabdSFande Kong    PetscFunctionReturn(0);
325*ea91fabdSFande Kong }
326*ea91fabdSFande Kong 
327*ea91fabdSFande Kong 
328*ea91fabdSFande Kong 
329b1a0a8a3SJed Brown #undef __FUNCT__
330f746d493SDmitry Karpeev #define __FUNCT__ "PCSetUp_GASM"
331f746d493SDmitry Karpeev static PetscErrorCode PCSetUp_GASM(PC pc)
332b1a0a8a3SJed Brown {
333f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
334b1a0a8a3SJed Brown   PetscErrorCode ierr;
335b1a0a8a3SJed Brown   PetscBool      symset,flg;
336*ea91fabdSFande Kong   PetscInt       i,nInnerIndices,nTotalInnerIndices;
337c10bc1a1SDmitry Karpeev   PetscMPIInt    rank, size;
338b1a0a8a3SJed Brown   MatReuse       scall = MAT_REUSE_MATRIX;
339b1a0a8a3SJed Brown   KSP            ksp;
340b1a0a8a3SJed Brown   PC             subpc;
341b1a0a8a3SJed Brown   const char     *prefix,*pprefix;
342f746d493SDmitry Karpeev   Vec            x,y;
3436a4f0f73SDmitry Karpeev   PetscInt       oni;       /* Number of indices in the i-th local outer subdomain.               */
3446a4f0f73SDmitry Karpeev   const PetscInt *oidxi;    /* Indices from the i-th subdomain local outer subdomain.             */
3456a4f0f73SDmitry Karpeev   PetscInt       on;        /* Number of indices in the disjoint union of local outer subdomains. */
3466a4f0f73SDmitry Karpeev   PetscInt       *oidx;     /* Indices in the disjoint union of local outer subdomains. */
3476a4f0f73SDmitry Karpeev   IS             gois;      /* Disjoint union the global indices of outer subdomains.             */
3486a4f0f73SDmitry Karpeev   IS             goid;      /* Identity IS of the size of the disjoint union of outer subdomains. */
349f746d493SDmitry Karpeev   PetscScalar    *gxarray, *gyarray;
350930d09c1SFande Kong   PetscInt       gostart;   /* Start of locally-owned indices in the vectors -- osm->gx,osm->gy -- over the disjoint union of outer subdomains. */
3518f3b4b4dSDmitry Karpeev   PetscInt       num_subdomains    = 0;
3520298fd71SBarry Smith   DM             *subdomain_dm     = NULL;
3538f3b4b4dSDmitry Karpeev   char           **subdomain_names = NULL;
354f771a274SFande Kong   PetscInt       *numbering;
3558f3b4b4dSDmitry Karpeev 
356b1a0a8a3SJed Brown 
357b1a0a8a3SJed Brown   PetscFunctionBegin;
358ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
359ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
360b1a0a8a3SJed Brown   if (!pc->setupcalled) {
361*ea91fabdSFande Kong 	/* use a hierarchical partitioning */
362*ea91fabdSFande Kong     if(osm->hierarchicalpartitioning){
363*ea91fabdSFande Kong       ierr = PCGASMSetHierarchicalPartitioning(pc);CHKERRQ(ierr);
364*ea91fabdSFande Kong     }
365b1a0a8a3SJed Brown     if (!osm->type_set) {
366b1a0a8a3SJed Brown       ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
3672fa5cd67SKarl Rupp       if (symset && flg) osm->type = PC_GASM_BASIC;
368b1a0a8a3SJed Brown     }
369b1a0a8a3SJed Brown 
3708f3b4b4dSDmitry Karpeev     if (osm->n == PETSC_DETERMINE) {
3718f3b4b4dSDmitry Karpeev       if (osm->N != PETSC_DETERMINE) {
3728f3b4b4dSDmitry Karpeev 	   /* No local subdomains given, but the desired number of total subdomains is known, so construct them accordingly. */
3738f3b4b4dSDmitry Karpeev 	   ierr = PCGASMCreateSubdomains(pc->pmat,osm->N,&osm->n,&osm->iis);CHKERRQ(ierr);
3748f3b4b4dSDmitry Karpeev       } else if (osm->dm_subdomains && pc->dm) {
3758f3b4b4dSDmitry Karpeev 	/* try pc->dm next, if allowed */
3768f3b4b4dSDmitry Karpeev 	PetscInt  d;
377a35b7b57SDmitry Karpeev 	IS       *inner_subdomain_is, *outer_subdomain_is;
378a35b7b57SDmitry Karpeev 	ierr = DMCreateDomainDecomposition(pc->dm, &num_subdomains, &subdomain_names, &inner_subdomain_is, &outer_subdomain_is, &subdomain_dm);CHKERRQ(ierr);
379a35b7b57SDmitry Karpeev 	if (num_subdomains) {
380a35b7b57SDmitry Karpeev 	  ierr = PCGASMSetSubdomains(pc, num_subdomains, inner_subdomain_is, outer_subdomain_is);CHKERRQ(ierr);
38169ca1f37SDmitry Karpeev 	}
382a35b7b57SDmitry Karpeev 	for (d = 0; d < num_subdomains; ++d) {
383a35b7b57SDmitry Karpeev 	  if (inner_subdomain_is) {ierr = ISDestroy(&inner_subdomain_is[d]);CHKERRQ(ierr);}
384a35b7b57SDmitry Karpeev 	  if (outer_subdomain_is) {ierr = ISDestroy(&outer_subdomain_is[d]);CHKERRQ(ierr);}
385fdc48646SDmitry Karpeev 	}
386a35b7b57SDmitry Karpeev 	ierr = PetscFree(inner_subdomain_is);CHKERRQ(ierr);
387a35b7b57SDmitry Karpeev 	ierr = PetscFree(outer_subdomain_is);CHKERRQ(ierr);
3888f3b4b4dSDmitry Karpeev       } else {
3898f3b4b4dSDmitry Karpeev 	/* still no subdomains; use one per processor */
39044fe18e5SDmitry Karpeev 	osm->nmax = osm->n = 1;
391ce94432eSBarry Smith 	ierr      = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
392f746d493SDmitry Karpeev 	osm->N    = size;
3938f3b4b4dSDmitry Karpeev 	ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
394fdc48646SDmitry Karpeev       }
39506b43e7eSDmitry Karpeev     }
396a35b7b57SDmitry Karpeev     if (!osm->iis) {
397a35b7b57SDmitry Karpeev       /*
3988f3b4b4dSDmitry Karpeev        osm->n was set in PCGASMSetSubdomains(), but the actual subdomains have not been supplied.
3998f3b4b4dSDmitry Karpeev        We create the requisite number of local inner subdomains and then expand them into
4008f3b4b4dSDmitry Karpeev        out subdomains, if necessary.
401a35b7b57SDmitry Karpeev        */
4028f3b4b4dSDmitry Karpeev       ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
403a35b7b57SDmitry Karpeev     }
4048f3b4b4dSDmitry Karpeev     if (!osm->ois) {
4058f3b4b4dSDmitry Karpeev       /*
4068f3b4b4dSDmitry Karpeev 	    Initially make outer subdomains the same as inner subdomains. If nonzero additional overlap
4078f3b4b4dSDmitry Karpeev 	    has been requested, copy the inner subdomains over so they can be modified.
4088f3b4b4dSDmitry Karpeev       */
4098f3b4b4dSDmitry Karpeev       ierr = PetscMalloc1(osm->n,&osm->ois);CHKERRQ(ierr);
4108f3b4b4dSDmitry Karpeev       for (i=0; i<osm->n; ++i) {
411*ea91fabdSFande Kong 	if (osm->overlap > 0 && osm->N>1) { /* With positive overlap, osm->iis[i] will be modified */
4128f3b4b4dSDmitry Karpeev 	  ierr = ISDuplicate(osm->iis[i],(osm->ois)+i);CHKERRQ(ierr);
4138f3b4b4dSDmitry Karpeev 	  ierr = ISCopy(osm->iis[i],osm->ois[i]);CHKERRQ(ierr);
4148f3b4b4dSDmitry Karpeev 	} else {
4158f3b4b4dSDmitry Karpeev 	  ierr      = PetscObjectReference((PetscObject)((osm->iis)[i]));CHKERRQ(ierr);
4168f3b4b4dSDmitry Karpeev 	  osm->ois[i] = osm->iis[i];
4178f3b4b4dSDmitry Karpeev 	}
4188f3b4b4dSDmitry Karpeev       }
419*ea91fabdSFande Kong       if (osm->overlap>0 && osm->N>1) {
4208f3b4b4dSDmitry Karpeev 	   /* Extend the "overlapping" regions by a number of steps */
421d21f2a47SFande Kong 	   ierr = MatIncreaseOverlapSplit(pc->pmat,osm->n,osm->ois,osm->overlap);CHKERRQ(ierr);
4228f3b4b4dSDmitry Karpeev       }
423b1a0a8a3SJed Brown     }
4246a4f0f73SDmitry Karpeev 
4258f3b4b4dSDmitry Karpeev     /* Now the subdomains are defined.  Determine their global and max local numbers, if necessary. */
4268f3b4b4dSDmitry Karpeev     if (osm->nmax == PETSC_DETERMINE) {
4278f3b4b4dSDmitry Karpeev       PetscMPIInt inwork,outwork;
4288f3b4b4dSDmitry Karpeev       /* determine global number of subdomains and the max number of local subdomains */
4298f3b4b4dSDmitry Karpeev       inwork = osm->n;
430b2566f29SBarry Smith       ierr       = MPIU_Allreduce(&inwork,&outwork,1,MPI_INT,MPI_MAX,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
4318f3b4b4dSDmitry Karpeev       osm->nmax  = outwork;
4328f3b4b4dSDmitry Karpeev     }
4338f3b4b4dSDmitry Karpeev     if (osm->N == PETSC_DETERMINE) {
4348f3b4b4dSDmitry Karpeev       /* Determine the number of globally-distinct subdomains and compute a global numbering for them. */
4358f3b4b4dSDmitry Karpeev       ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,&osm->N,NULL);CHKERRQ(ierr);
4368f3b4b4dSDmitry Karpeev     }
4378f3b4b4dSDmitry Karpeev 
438b1a0a8a3SJed Brown 
439b1a0a8a3SJed Brown     if (osm->sort_indices) {
440f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4416a4f0f73SDmitry Karpeev         ierr = ISSort(osm->ois[i]);CHKERRQ(ierr);
4426a4f0f73SDmitry Karpeev         ierr = ISSort(osm->iis[i]);CHKERRQ(ierr);
443b1a0a8a3SJed Brown       }
444b1a0a8a3SJed Brown     }
4458f3b4b4dSDmitry Karpeev     ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
4468f3b4b4dSDmitry Karpeev     ierr = PCGASMPrintSubdomains(pc);CHKERRQ(ierr);
4478f3b4b4dSDmitry Karpeev 
4486a4f0f73SDmitry Karpeev     /*
4496a4f0f73SDmitry Karpeev        Merge the ISs, create merged vectors and restrictions.
4506a4f0f73SDmitry Karpeev      */
4516a4f0f73SDmitry Karpeev     /* Merge outer subdomain ISs and construct a restriction onto the disjoint union of local outer subdomains. */
4526a4f0f73SDmitry Karpeev     on = 0;
453f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4546a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4556a4f0f73SDmitry Karpeev       on  += oni;
456f746d493SDmitry Karpeev     }
457785e854fSJed Brown     ierr = PetscMalloc1(on, &oidx);CHKERRQ(ierr);
4586a4f0f73SDmitry Karpeev     on   = 0;
459930d09c1SFande Kong     /* Merge local indices together */
460f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4616a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4626a4f0f73SDmitry Karpeev       ierr = ISGetIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4636a4f0f73SDmitry Karpeev       ierr = PetscMemcpy(oidx+on,oidxi,sizeof(PetscInt)*oni);CHKERRQ(ierr);
4646a4f0f73SDmitry Karpeev       ierr = ISRestoreIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4656a4f0f73SDmitry Karpeev       on  += oni;
466f746d493SDmitry Karpeev     }
4676a4f0f73SDmitry Karpeev     ierr = ISCreateGeneral(((PetscObject)(pc))->comm,on,oidx,PETSC_OWN_POINTER,&gois);CHKERRQ(ierr);
468*ea91fabdSFande Kong     nTotalInnerIndices = 0;
469*ea91fabdSFande Kong     for(i=0; i<osm->n; i++){
470*ea91fabdSFande Kong       ierr = ISGetLocalSize(osm->iis[i],&nInnerIndices);CHKERRQ(ierr);
471*ea91fabdSFande Kong       nTotalInnerIndices += nInnerIndices;
472*ea91fabdSFande Kong     }
473*ea91fabdSFande Kong     ierr = VecCreateMPI(((PetscObject)(pc))->comm,nTotalInnerIndices,PETSC_DETERMINE,&x);CHKERRQ(ierr);
474*ea91fabdSFande Kong     ierr = VecDuplicate(x,&y);CHKERRQ(ierr);
475*ea91fabdSFande Kong 
476ce94432eSBarry Smith     ierr = VecCreateMPI(PetscObjectComm((PetscObject)pc),on,PETSC_DECIDE,&osm->gx);CHKERRQ(ierr);
477f746d493SDmitry Karpeev     ierr = VecDuplicate(osm->gx,&osm->gy);CHKERRQ(ierr);
478930d09c1SFande Kong     ierr = VecGetOwnershipRange(osm->gx, &gostart, NULL);CHKERRQ(ierr);
479930d09c1SFande Kong     ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),on,gostart,1, &goid);CHKERRQ(ierr);
480930d09c1SFande Kong     /* gois might indices not on local */
4816a4f0f73SDmitry Karpeev     ierr = VecScatterCreate(x,gois,osm->gx,goid, &(osm->gorestriction));CHKERRQ(ierr);
482f771a274SFande Kong     ierr = PetscMalloc1(osm->n,&numbering);CHKERRQ(ierr);
483f771a274SFande Kong     ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,NULL,numbering);CHKERRQ(ierr);
4846a4f0f73SDmitry Karpeev     ierr = VecDestroy(&x);CHKERRQ(ierr);
4857105d80bSDmitry Karpeev     ierr = ISDestroy(&gois);CHKERRQ(ierr);
4862fa5cd67SKarl Rupp 
4876a4f0f73SDmitry Karpeev     /* Merge inner subdomain ISs and construct a restriction onto the disjoint union of local inner subdomains. */
4882fa5cd67SKarl Rupp     {
4892fa5cd67SKarl Rupp       PetscInt        ini;           /* Number of indices the i-th a local inner subdomain. */
4906a4f0f73SDmitry Karpeev       PetscInt        in;            /* Number of indices in the disjoint uniont of local inner subdomains. */
4916a4f0f73SDmitry Karpeev       PetscInt       *iidx;          /* Global indices in the merged local inner subdomain. */
4926a4f0f73SDmitry Karpeev       PetscInt       *ioidx;         /* Global indices of the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
4936a4f0f73SDmitry Karpeev       IS              giis;          /* IS for the disjoint union of inner subdomains. */
4946a4f0f73SDmitry Karpeev       IS              giois;         /* IS for the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
495f771a274SFande Kong       PetscScalar    *array;
496f771a274SFande Kong       const PetscInt *indices;
497f771a274SFande Kong       PetscInt        k;
4986a4f0f73SDmitry Karpeev       on = 0;
499f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
5006a4f0f73SDmitry Karpeev         ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
5016a4f0f73SDmitry Karpeev         on  += oni;
502f746d493SDmitry Karpeev       }
503f771a274SFande Kong       ierr = PetscMalloc1(on, &iidx);CHKERRQ(ierr);
504f771a274SFande Kong       ierr = PetscMalloc1(on, &ioidx);CHKERRQ(ierr);
505f771a274SFande Kong       ierr = VecGetArray(y,&array);CHKERRQ(ierr);
506e12b4729SFande Kong       /* set communicator id to determine where overlap is */
507f771a274SFande Kong       in   = 0;
508f771a274SFande Kong       for (i=0; i<osm->n; i++) {
509f771a274SFande Kong         ierr   = ISGetLocalSize(osm->iis[i],&ini);CHKERRQ(ierr);
510f771a274SFande Kong         for (k = 0; k < ini; ++k){
511f771a274SFande Kong           array[in+k] = numbering[i];
512f771a274SFande Kong         }
513f771a274SFande Kong         in += ini;
514f771a274SFande Kong       }
515f771a274SFande Kong       ierr = VecRestoreArray(y,&array);CHKERRQ(ierr);
516f771a274SFande Kong       ierr = VecScatterBegin(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
517f771a274SFande Kong       ierr = VecScatterEnd(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
518f771a274SFande Kong       ierr = VecGetOwnershipRange(osm->gy,&gostart, NULL);CHKERRQ(ierr);
519f771a274SFande Kong       ierr = VecGetArray(osm->gy,&array);CHKERRQ(ierr);
520f771a274SFande Kong       on  = 0;
521f771a274SFande Kong       in  = 0;
522f771a274SFande Kong       for (i=0; i<osm->n; i++) {
523f771a274SFande Kong     	ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
524f771a274SFande Kong     	ierr = ISGetIndices(osm->ois[i],&indices);CHKERRQ(ierr);
525f771a274SFande Kong     	for (k=0; k<oni; k++) {
526e12b4729SFande Kong           /*  skip overlapping indices to get inner domain */
52743081b6cSDmitry Karpeev           if(PetscRealPart(array[on+k]) != numbering[i]) continue;
528f771a274SFande Kong           iidx[in]    = indices[k];
529f771a274SFande Kong           ioidx[in++] = gostart+on+k;
530f771a274SFande Kong     	}
531f771a274SFande Kong     	ierr   = ISRestoreIndices(osm->ois[i], &indices);CHKERRQ(ierr);
532f771a274SFande Kong     	on += oni;
533f771a274SFande Kong       }
534f771a274SFande Kong       ierr = VecRestoreArray(osm->gy,&array);CHKERRQ(ierr);
535ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,iidx,PETSC_OWN_POINTER,&giis);CHKERRQ(ierr);
536ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,ioidx,PETSC_OWN_POINTER,&giois);CHKERRQ(ierr);
5376a4f0f73SDmitry Karpeev       ierr = VecScatterCreate(y,giis,osm->gy,giois,&osm->girestriction);CHKERRQ(ierr);
5386a4f0f73SDmitry Karpeev       ierr = VecDestroy(&y);CHKERRQ(ierr);
5396a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giis);CHKERRQ(ierr);
5406a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giois);CHKERRQ(ierr);
541b1a0a8a3SJed Brown     }
5426a4f0f73SDmitry Karpeev     ierr = ISDestroy(&goid);CHKERRQ(ierr);
543f771a274SFande Kong     ierr = PetscFree(numbering);CHKERRQ(ierr);
5442fa5cd67SKarl Rupp 
545f746d493SDmitry Karpeev     /* Create the subdomain work vectors. */
546785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->x);CHKERRQ(ierr);
547785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->y);CHKERRQ(ierr);
548f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gx, &gxarray);CHKERRQ(ierr);
549f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gy, &gyarray);CHKERRQ(ierr);
5506a4f0f73SDmitry Karpeev     for (i=0, on=0; i<osm->n; ++i, on += oni) {
5516a4f0f73SDmitry Karpeev       PetscInt oNi;
5526a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
553930d09c1SFande Kong       /* on a sub communicator */
5546a4f0f73SDmitry Karpeev       ierr = ISGetSize(osm->ois[i],&oNi);CHKERRQ(ierr);
5556a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gxarray+on,&osm->x[i]);CHKERRQ(ierr);
5566a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gyarray+on,&osm->y[i]);CHKERRQ(ierr);
557b1a0a8a3SJed Brown     }
558f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gx, &gxarray);CHKERRQ(ierr);
559f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gy, &gyarray);CHKERRQ(ierr);
5608f3b4b4dSDmitry Karpeev     /* Create the subdomain solvers */
561785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->ksp);CHKERRQ(ierr);
5628f3b4b4dSDmitry Karpeev     for (i=0; i<osm->n; i++) {
5638f3b4b4dSDmitry Karpeev       char subprefix[PETSC_MAX_PATH_LEN+1];
5646a4f0f73SDmitry Karpeev       ierr        = KSPCreate(((PetscObject)(osm->ois[i]))->comm,&ksp);CHKERRQ(ierr);
5653bb1ff40SBarry Smith       ierr        = PetscLogObjectParent((PetscObject)pc,(PetscObject)ksp);CHKERRQ(ierr);
566b1a0a8a3SJed Brown       ierr        = PetscObjectIncrementTabLevel((PetscObject)ksp,(PetscObject)pc,1);CHKERRQ(ierr);
567b1a0a8a3SJed Brown       ierr        = KSPSetType(ksp,KSPPREONLY);CHKERRQ(ierr);
5688f3b4b4dSDmitry Karpeev       ierr        = KSPGetPC(ksp,&subpc);CHKERRQ(ierr); /* Why do we need this here? */
5698f3b4b4dSDmitry Karpeev       if (subdomain_dm) {
5708f3b4b4dSDmitry Karpeev 	    ierr = KSPSetDM(ksp,subdomain_dm[i]);CHKERRQ(ierr);
5718f3b4b4dSDmitry Karpeev 	    ierr = DMDestroy(subdomain_dm+i);CHKERRQ(ierr);
5728f3b4b4dSDmitry Karpeev       }
573b1a0a8a3SJed Brown       ierr        = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
574b1a0a8a3SJed Brown       ierr        = KSPSetOptionsPrefix(ksp,prefix);CHKERRQ(ierr);
5758f3b4b4dSDmitry Karpeev       if (subdomain_names && subdomain_names[i]) {
5768f3b4b4dSDmitry Karpeev 	     ierr = PetscSNPrintf(subprefix,PETSC_MAX_PATH_LEN,"sub_%s_",subdomain_names[i]);CHKERRQ(ierr);
5778f3b4b4dSDmitry Karpeev 	     ierr = KSPAppendOptionsPrefix(ksp,subprefix);CHKERRQ(ierr);
5788f3b4b4dSDmitry Karpeev 	     ierr = PetscFree(subdomain_names[i]);CHKERRQ(ierr);
5798f3b4b4dSDmitry Karpeev       }
580b1a0a8a3SJed Brown       ierr        = KSPAppendOptionsPrefix(ksp,"sub_");CHKERRQ(ierr);
581b1a0a8a3SJed Brown       osm->ksp[i] = ksp;
582b1a0a8a3SJed Brown     }
5838f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_dm);CHKERRQ(ierr);
5848f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_names);CHKERRQ(ierr);
585b1a0a8a3SJed Brown     scall = MAT_INITIAL_MATRIX;
586b1a0a8a3SJed Brown 
5878f3b4b4dSDmitry Karpeev   } else { /* if (pc->setupcalled) */
588b1a0a8a3SJed Brown     /*
5898f3b4b4dSDmitry Karpeev        Destroy the submatrices from the previous iteration
590b1a0a8a3SJed Brown     */
591b1a0a8a3SJed Brown     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
592f746d493SDmitry Karpeev       ierr  = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
593b1a0a8a3SJed Brown       scall = MAT_INITIAL_MATRIX;
594b1a0a8a3SJed Brown     }
595*ea91fabdSFande Kong     if(osm->permutationIS){
596*ea91fabdSFande Kong       ierr = MatGetSubMatrix(pc->pmat,osm->permutationIS,osm->permutationIS,scall,&osm->permutationP);CHKERRQ(ierr);
597*ea91fabdSFande Kong       ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
598*ea91fabdSFande Kong       osm->pcmat = pc->pmat;
599*ea91fabdSFande Kong       pc->pmat   = osm->permutationP;
600b1a0a8a3SJed Brown     }
601b1a0a8a3SJed Brown 
602*ea91fabdSFande Kong   }
603*ea91fabdSFande Kong 
604*ea91fabdSFande Kong 
605b1a0a8a3SJed Brown   /*
606f746d493SDmitry Karpeev      Extract out the submatrices.
607b1a0a8a3SJed Brown   */
60881a5c4aaSDmitry Karpeev   if (size > 1) {
6098f3b4b4dSDmitry Karpeev     ierr = MatGetSubMatricesMPI(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
6102fa5cd67SKarl Rupp   } else {
6116a4f0f73SDmitry Karpeev     ierr = MatGetSubMatrices(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
61281a5c4aaSDmitry Karpeev   }
613b1a0a8a3SJed Brown   if (scall == MAT_INITIAL_MATRIX) {
614b1a0a8a3SJed Brown     ierr = PetscObjectGetOptionsPrefix((PetscObject)pc->pmat,&pprefix);CHKERRQ(ierr);
615f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
6163bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)osm->pmat[i]);CHKERRQ(ierr);
617b1a0a8a3SJed Brown       ierr = PetscObjectSetOptionsPrefix((PetscObject)osm->pmat[i],pprefix);CHKERRQ(ierr);
618b1a0a8a3SJed Brown     }
619b1a0a8a3SJed Brown   }
620b1a0a8a3SJed Brown 
621b1a0a8a3SJed Brown   /* Return control to the user so that the submatrices can be modified (e.g., to apply
622b1a0a8a3SJed Brown      different boundary conditions for the submatrices than for the global problem) */
6236a4f0f73SDmitry Karpeev   ierr = PCModifySubMatrices(pc,osm->n,osm->ois,osm->ois,osm->pmat,pc->modifysubmatricesP);CHKERRQ(ierr);
624b1a0a8a3SJed Brown 
625b1a0a8a3SJed Brown   /*
6266a4f0f73SDmitry Karpeev      Loop over submatrices putting them into local ksps
627b1a0a8a3SJed Brown   */
628f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
62923ee1639SBarry Smith     ierr = KSPSetOperators(osm->ksp[i],osm->pmat[i],osm->pmat[i]);CHKERRQ(ierr);
630b1a0a8a3SJed Brown     if (!pc->setupcalled) {
631b1a0a8a3SJed Brown       ierr = KSPSetFromOptions(osm->ksp[i]);CHKERRQ(ierr);
632b1a0a8a3SJed Brown     }
633b1a0a8a3SJed Brown   }
634*ea91fabdSFande Kong   if(osm->pcmat){
635*ea91fabdSFande Kong     ierr = MatDestroy(&pc->pmat);CHKERRQ(ierr);
636*ea91fabdSFande Kong     pc->pmat   = osm->pcmat;
637*ea91fabdSFande Kong     osm->pcmat = 0;
638*ea91fabdSFande Kong   }
639b1a0a8a3SJed Brown   PetscFunctionReturn(0);
640b1a0a8a3SJed Brown }
641b1a0a8a3SJed Brown 
642b1a0a8a3SJed Brown #undef __FUNCT__
643f746d493SDmitry Karpeev #define __FUNCT__ "PCSetUpOnBlocks_GASM"
644f746d493SDmitry Karpeev static PetscErrorCode PCSetUpOnBlocks_GASM(PC pc)
645b1a0a8a3SJed Brown {
646f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
647b1a0a8a3SJed Brown   PetscErrorCode ierr;
648b1a0a8a3SJed Brown   PetscInt       i;
649b1a0a8a3SJed Brown 
650b1a0a8a3SJed Brown   PetscFunctionBegin;
651f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
652b1a0a8a3SJed Brown     ierr = KSPSetUp(osm->ksp[i]);CHKERRQ(ierr);
653b1a0a8a3SJed Brown   }
654b1a0a8a3SJed Brown   PetscFunctionReturn(0);
655b1a0a8a3SJed Brown }
656b1a0a8a3SJed Brown 
657b1a0a8a3SJed Brown #undef __FUNCT__
658f746d493SDmitry Karpeev #define __FUNCT__ "PCApply_GASM"
659*ea91fabdSFande Kong static PetscErrorCode PCApply_GASM(PC pc,Vec xin,Vec yout)
660b1a0a8a3SJed Brown {
661f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
662b1a0a8a3SJed Brown   PetscErrorCode ierr;
663f746d493SDmitry Karpeev   PetscInt       i;
664*ea91fabdSFande Kong   Vec            x,y;
665b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
666b1a0a8a3SJed Brown 
667b1a0a8a3SJed Brown   PetscFunctionBegin;
668*ea91fabdSFande Kong   if(osm->pctoouter){
669*ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
670*ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
671*ea91fabdSFande Kong     x = osm->pcx;
672*ea91fabdSFande Kong     y = osm->pcy;
673*ea91fabdSFande Kong   }else{
674*ea91fabdSFande Kong 	x = xin;
675*ea91fabdSFande Kong 	y = yout;
676*ea91fabdSFande Kong   }
677b1a0a8a3SJed Brown   /*
6786a4f0f73SDmitry Karpeev      Support for limiting the restriction or interpolation only to the inner
679b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
680b1a0a8a3SJed Brown   */
681f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
682b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
683f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
6846a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6852fa5cd67SKarl Rupp   } else {
6866a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
687b1a0a8a3SJed Brown   }
6886a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
6896a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
6906a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6912fa5cd67SKarl Rupp   } else {
6926a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6936a4f0f73SDmitry Karpeev   }
69486b96d36SDmitry Karpeev   /* do the subdomain solves */
69586b96d36SDmitry Karpeev   for (i=0; i<osm->n; ++i) {
696b1a0a8a3SJed Brown     ierr = KSPSolve(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
697b1a0a8a3SJed Brown   }
698930d09c1SFande Kong   /* Do we need to zero y ?? */
6996a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
7006a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
7016a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
702*ea91fabdSFande Kong     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7032fa5cd67SKarl Rupp   } else {
7046a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
705*ea91fabdSFande Kong     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7066a4f0f73SDmitry Karpeev   }
707*ea91fabdSFande Kong   if(osm->pctoouter){
708*ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
709*ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
710*ea91fabdSFande Kong   }
711*ea91fabdSFande Kong   PetscFunctionReturn(0);
712b1a0a8a3SJed Brown }
713b1a0a8a3SJed Brown 
714b1a0a8a3SJed Brown #undef __FUNCT__
715f746d493SDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_GASM"
716*ea91fabdSFande Kong static PetscErrorCode PCApplyTranspose_GASM(PC pc,Vec xin,Vec yout)
717b1a0a8a3SJed Brown {
718f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
719b1a0a8a3SJed Brown   PetscErrorCode ierr;
720f746d493SDmitry Karpeev   PetscInt       i;
721*ea91fabdSFande Kong   Vec            x,y;
722b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
723b1a0a8a3SJed Brown 
724b1a0a8a3SJed Brown   PetscFunctionBegin;
725*ea91fabdSFande Kong   if(osm->pctoouter){
726*ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
727*ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
728*ea91fabdSFande Kong    x = osm->pcx;
729*ea91fabdSFande Kong    y = osm->pcy;
730*ea91fabdSFande Kong   }else{
731*ea91fabdSFande Kong 	x = xin;
732*ea91fabdSFande Kong 	y = yout;
733*ea91fabdSFande Kong   }
734b1a0a8a3SJed Brown   /*
735b1a0a8a3SJed Brown      Support for limiting the restriction or interpolation to only local
736b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
737b1a0a8a3SJed Brown 
738f746d493SDmitry Karpeev      Note: these are reversed from the PCApply_GASM() because we are applying the
739b1a0a8a3SJed Brown      transpose of the three terms
740b1a0a8a3SJed Brown   */
741f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
742b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
743f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
7446a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7452fa5cd67SKarl Rupp   } else {
7466a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
747b1a0a8a3SJed Brown   }
7486a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
7496a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
7506a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7512fa5cd67SKarl Rupp   } else {
7526a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7536a4f0f73SDmitry Karpeev   }
754b1a0a8a3SJed Brown   /* do the local solves */
755ab3e923fSDmitry 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. */
756b1a0a8a3SJed Brown     ierr = KSPSolveTranspose(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
757b1a0a8a3SJed Brown   }
7586a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
7596a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
7606a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7616a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7622fa5cd67SKarl Rupp   } else {
7636a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7646a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7656a4f0f73SDmitry Karpeev   }
766*ea91fabdSFande Kong   if(osm->pctoouter){
767*ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
768*ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
769*ea91fabdSFande Kong   }
770b1a0a8a3SJed Brown   PetscFunctionReturn(0);
771b1a0a8a3SJed Brown }
772b1a0a8a3SJed Brown 
773b1a0a8a3SJed Brown #undef __FUNCT__
774a06653b4SBarry Smith #define __FUNCT__ "PCReset_GASM"
775a06653b4SBarry Smith static PetscErrorCode PCReset_GASM(PC pc)
776b1a0a8a3SJed Brown {
777f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
778b1a0a8a3SJed Brown   PetscErrorCode ierr;
779b1a0a8a3SJed Brown   PetscInt       i;
780b1a0a8a3SJed Brown 
781b1a0a8a3SJed Brown   PetscFunctionBegin;
782b1a0a8a3SJed Brown   if (osm->ksp) {
783f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
784a06653b4SBarry Smith       ierr = KSPReset(osm->ksp[i]);CHKERRQ(ierr);
785b1a0a8a3SJed Brown     }
786b1a0a8a3SJed Brown   }
787b1a0a8a3SJed Brown   if (osm->pmat) {
788f746d493SDmitry Karpeev     if (osm->n > 0) {
789ab3e923fSDmitry Karpeev       ierr = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
790b1a0a8a3SJed Brown     }
791b1a0a8a3SJed Brown   }
792d34fcf5fSBarry Smith   if (osm->x) {
793f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
794fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->x[i]);CHKERRQ(ierr);
795fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->y[i]);CHKERRQ(ierr);
796b1a0a8a3SJed Brown     }
797d34fcf5fSBarry Smith   }
7986bf464f9SBarry Smith   ierr = VecDestroy(&osm->gx);CHKERRQ(ierr);
7996bf464f9SBarry Smith   ierr = VecDestroy(&osm->gy);CHKERRQ(ierr);
800ab3e923fSDmitry Karpeev 
8016a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->gorestriction);CHKERRQ(ierr);
8026a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->girestriction);CHKERRQ(ierr);
8038f3b4b4dSDmitry Karpeev   if (!osm->user_subdomains) {
8042c112581SDmitry Karpeev     ierr      = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
8058f3b4b4dSDmitry Karpeev     osm->N    = PETSC_DETERMINE;
8068f3b4b4dSDmitry Karpeev     osm->nmax = PETSC_DETERMINE;
8078f3b4b4dSDmitry Karpeev   }
808*ea91fabdSFande Kong   if(osm->pctoouter){
809*ea91fabdSFande Kong 	ierr = VecScatterDestroy(&(osm->pctoouter));CHKERRQ(ierr);
810*ea91fabdSFande Kong   }
811*ea91fabdSFande Kong   if(osm->permutationIS){
812*ea91fabdSFande Kong 	ierr = ISDestroy(&(osm->permutationIS));CHKERRQ(ierr);
813*ea91fabdSFande Kong   }
814*ea91fabdSFande Kong   if(osm->pcx){
815*ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcx));CHKERRQ(ierr);
816*ea91fabdSFande Kong   }
817*ea91fabdSFande Kong   if(osm->pcy){
818*ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcy));CHKERRQ(ierr);
819*ea91fabdSFande Kong   }
820*ea91fabdSFande Kong   if(osm->permutationP){
821*ea91fabdSFande Kong     ierr = MatDestroy(&(osm->permutationP));CHKERRQ(ierr);
822*ea91fabdSFande Kong   }
823*ea91fabdSFande Kong   if(osm->pcmat){
824*ea91fabdSFande Kong 	ierr = MatDestroy(&osm->pcmat);CHKERRQ(ierr);
825*ea91fabdSFande Kong   }
826a06653b4SBarry Smith   PetscFunctionReturn(0);
827a06653b4SBarry Smith }
828a06653b4SBarry Smith 
829a06653b4SBarry Smith #undef __FUNCT__
830a06653b4SBarry Smith #define __FUNCT__ "PCDestroy_GASM"
831a06653b4SBarry Smith static PetscErrorCode PCDestroy_GASM(PC pc)
832a06653b4SBarry Smith {
833a06653b4SBarry Smith   PC_GASM        *osm = (PC_GASM*)pc->data;
834a06653b4SBarry Smith   PetscErrorCode ierr;
835a06653b4SBarry Smith   PetscInt       i;
836a06653b4SBarry Smith 
837a06653b4SBarry Smith   PetscFunctionBegin;
838a06653b4SBarry Smith   ierr = PCReset_GASM(pc);CHKERRQ(ierr);
839135757f6SDmitry Karpeev   /* PCReset will not destroy subdomains, if user_subdomains is true. */
840135757f6SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
841a06653b4SBarry Smith   if (osm->ksp) {
842a06653b4SBarry Smith     for (i=0; i<osm->n; i++) {
8436bf464f9SBarry Smith       ierr = KSPDestroy(&osm->ksp[i]);CHKERRQ(ierr);
844a06653b4SBarry Smith     }
845a06653b4SBarry Smith     ierr = PetscFree(osm->ksp);CHKERRQ(ierr);
846a06653b4SBarry Smith   }
847a06653b4SBarry Smith   ierr = PetscFree(osm->x);CHKERRQ(ierr);
848a06653b4SBarry Smith   ierr = PetscFree(osm->y);CHKERRQ(ierr);
849c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
850b1a0a8a3SJed Brown   PetscFunctionReturn(0);
851b1a0a8a3SJed Brown }
852b1a0a8a3SJed Brown 
853b1a0a8a3SJed Brown #undef __FUNCT__
854f746d493SDmitry Karpeev #define __FUNCT__ "PCSetFromOptions_GASM"
8558c34d3f5SBarry Smith static PetscErrorCode PCSetFromOptions_GASM(PetscOptions *PetscOptionsObject,PC pc)
856a6dfd86eSKarl Rupp {
857f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
858b1a0a8a3SJed Brown   PetscErrorCode ierr;
859b1a0a8a3SJed Brown   PetscInt       blocks,ovl;
860b1a0a8a3SJed Brown   PetscBool      symset,flg;
861f746d493SDmitry Karpeev   PCGASMType     gasmtype;
862b1a0a8a3SJed Brown 
863b1a0a8a3SJed Brown   PetscFunctionBegin;
864b1a0a8a3SJed Brown   /* set the type to symmetric if matrix is symmetric */
865b1a0a8a3SJed Brown   if (!osm->type_set && pc->pmat) {
866b1a0a8a3SJed Brown     ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
8672fa5cd67SKarl Rupp     if (symset && flg) osm->type = PC_GASM_BASIC;
868b1a0a8a3SJed Brown   }
869e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"Generalized additive Schwarz options");CHKERRQ(ierr);
8708f3b4b4dSDmitry 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);
8718f3b4b4dSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_total_subdomains","Total number of subdomains across communicator","PCGASMSetTotalSubdomains",osm->N,&blocks,&flg);CHKERRQ(ierr);
87265db9045SDmitry Karpeev   if (flg) {
8738f3b4b4dSDmitry Karpeev     ierr = PCGASMSetTotalSubdomains(pc,blocks);CHKERRQ(ierr);
87465db9045SDmitry Karpeev   }
87506b43e7eSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_overlap","Number of overlapping degrees of freedom","PCGASMSetOverlap",osm->overlap,&ovl,&flg);CHKERRQ(ierr);
87665db9045SDmitry Karpeev   if (flg) {
87765db9045SDmitry Karpeev     ierr = PCGASMSetOverlap(pc,ovl);CHKERRQ(ierr);
878d709ea83SDmitry Karpeev     osm->dm_subdomains = PETSC_FALSE;
87965db9045SDmitry Karpeev   }
880b1a0a8a3SJed Brown   flg  = PETSC_FALSE;
881f746d493SDmitry Karpeev   ierr = PetscOptionsEnum("-pc_gasm_type","Type of restriction/extension","PCGASMSetType",PCGASMTypes,(PetscEnum)osm->type,(PetscEnum*)&gasmtype,&flg);CHKERRQ(ierr);
882f746d493SDmitry Karpeev   if (flg) {ierr = PCGASMSetType(pc,gasmtype);CHKERRQ(ierr);}
883*ea91fabdSFande Kong   ierr = PetscOptionsBool("-pc_gasm_use_hierachical_partitioning","use hierarchical partitioning",NULL,osm->hierarchicalpartitioning,&osm->hierarchicalpartitioning,&flg);CHKERRQ(ierr);
884b1a0a8a3SJed Brown   ierr = PetscOptionsTail();CHKERRQ(ierr);
885b1a0a8a3SJed Brown   PetscFunctionReturn(0);
886b1a0a8a3SJed Brown }
887b1a0a8a3SJed Brown 
888b1a0a8a3SJed Brown /*------------------------------------------------------------------------------------*/
889b1a0a8a3SJed Brown 
890b1a0a8a3SJed Brown #undef __FUNCT__
8918f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMSetTotalSubdomains"
8928f3b4b4dSDmitry Karpeev /*@
8938f3b4b4dSDmitry Karpeev     PCGASMSetTotalSubdomains - sets the total number of subdomains to use across the
8948f3b4b4dSDmitry Karpeev                                communicator.
8958f3b4b4dSDmitry Karpeev     Logically collective on pc
8968f3b4b4dSDmitry Karpeev 
8978f3b4b4dSDmitry Karpeev     Input Parameters:
8988f3b4b4dSDmitry Karpeev +   pc  - the preconditioner
8998f3b4b4dSDmitry Karpeev -   N   - total number of subdomains
9008f3b4b4dSDmitry Karpeev 
9018f3b4b4dSDmitry Karpeev 
9028f3b4b4dSDmitry Karpeev     Level: beginner
9038f3b4b4dSDmitry Karpeev 
9048f3b4b4dSDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
9058f3b4b4dSDmitry Karpeev 
9068f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap()
9078f3b4b4dSDmitry Karpeev           PCGASMCreateSubdomains2D()
9088f3b4b4dSDmitry Karpeev @*/
9098f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetTotalSubdomains(PC pc,PetscInt N)
9108f3b4b4dSDmitry Karpeev {
9118f3b4b4dSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
9128f3b4b4dSDmitry Karpeev   PetscMPIInt    size,rank;
9138f3b4b4dSDmitry Karpeev   PetscErrorCode ierr;
9148f3b4b4dSDmitry Karpeev 
9158f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
9168f3b4b4dSDmitry 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);
9178f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetTotalSubdomains() should be called before calling PCSetUp().");
9188f3b4b4dSDmitry Karpeev 
9192c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9208f3b4b4dSDmitry Karpeev   osm->ois = osm->iis = NULL;
9218f3b4b4dSDmitry Karpeev 
9228f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
9238f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
9248f3b4b4dSDmitry Karpeev   osm->N    = N;
9258f3b4b4dSDmitry Karpeev   osm->n    = PETSC_DETERMINE;
9268f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
9278f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
9288f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
9298f3b4b4dSDmitry Karpeev }
9308f3b4b4dSDmitry Karpeev 
9318f3b4b4dSDmitry Karpeev #undef __FUNCT__
93206b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMSetSubdomains_GASM"
933b541e6a4SDmitry Karpeev static PetscErrorCode  PCGASMSetSubdomains_GASM(PC pc,PetscInt n,IS iis[],IS ois[])
934b1a0a8a3SJed Brown {
935f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
936b1a0a8a3SJed Brown   PetscErrorCode ierr;
937b1a0a8a3SJed Brown   PetscInt       i;
938b1a0a8a3SJed Brown 
939b1a0a8a3SJed Brown   PetscFunctionBegin;
9408f3b4b4dSDmitry Karpeev   if (n < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Each process must have 1 or more subdomains, got n = %D",n);
9418f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetSubdomains() should be called before calling PCSetUp().");
942b1a0a8a3SJed Brown 
9432c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9448f3b4b4dSDmitry Karpeev   osm->iis  = osm->ois = NULL;
9458f3b4b4dSDmitry Karpeev   osm->n    = n;
9468f3b4b4dSDmitry Karpeev   osm->N    = PETSC_DETERMINE;
9478f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
948a35b7b57SDmitry Karpeev   if (ois) {
949785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->ois);CHKERRQ(ierr);
9508f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9518f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)ois[i]);CHKERRQ(ierr);
9528f3b4b4dSDmitry Karpeev       osm->ois[i] = ois[i];
9538f3b4b4dSDmitry Karpeev     }
9548f3b4b4dSDmitry Karpeev     /*
9558f3b4b4dSDmitry Karpeev        Since the user set the outer subdomains, even if nontrivial overlap was requested via PCGASMSetOverlap(),
9568f3b4b4dSDmitry Karpeev        it will be ignored.  To avoid confusion later on (e.g., when viewing the PC), the overlap size is set to -1.
9578f3b4b4dSDmitry Karpeev     */
958b1a0a8a3SJed Brown     osm->overlap = -1;
959a35b7b57SDmitry Karpeev     if (!iis) {
960785e854fSJed Brown       ierr = PetscMalloc1(n,&osm->iis);CHKERRQ(ierr);
961a35b7b57SDmitry Karpeev       for (i=0; i<n; i++) {
9628f3b4b4dSDmitry Karpeev 	for (i=0; i<n; i++) {
9630e8f3646SDmitry Karpeev 	  ierr = PetscObjectReference((PetscObject)ois[i]);CHKERRQ(ierr);
964a35b7b57SDmitry Karpeev 	  osm->iis[i] = ois[i];
965a35b7b57SDmitry Karpeev 	}
966a35b7b57SDmitry Karpeev       }
967a35b7b57SDmitry Karpeev     }
9688f3b4b4dSDmitry Karpeev   }
969a35b7b57SDmitry Karpeev   if (iis) {
970785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->iis);CHKERRQ(ierr);
9718f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9728f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)iis[i]);CHKERRQ(ierr);
9738f3b4b4dSDmitry Karpeev       osm->iis[i] = iis[i];
9748f3b4b4dSDmitry Karpeev     }
975a35b7b57SDmitry Karpeev     if (!ois) {
976785e854fSJed Brown       ierr = PetscMalloc1(n,&osm->ois);CHKERRQ(ierr);
977a35b7b57SDmitry Karpeev       for (i=0; i<n; i++) {
9788f3b4b4dSDmitry Karpeev 	for (i=0; i<n; i++) {
979a35b7b57SDmitry Karpeev 	  ierr = PetscObjectReference((PetscObject)iis[i]);CHKERRQ(ierr);
980a35b7b57SDmitry Karpeev 	  osm->ois[i] = iis[i];
981a35b7b57SDmitry Karpeev 	}
9828f3b4b4dSDmitry Karpeev       }
9838f3b4b4dSDmitry Karpeev       /* If necessary, osm->ois[i] will be expanded using the requested overlap size in PCSetUp_GASM(). */
984a35b7b57SDmitry Karpeev     }
985a35b7b57SDmitry Karpeev   }
9868f3b4b4dSDmitry Karpeev   if (iis)  osm->user_subdomains = PETSC_TRUE;
987b1a0a8a3SJed Brown   PetscFunctionReturn(0);
988b1a0a8a3SJed Brown }
989b1a0a8a3SJed Brown 
990b1a0a8a3SJed Brown 
991b1a0a8a3SJed Brown #undef __FUNCT__
992f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetOverlap_GASM"
993f7a08781SBarry Smith static PetscErrorCode  PCGASMSetOverlap_GASM(PC pc,PetscInt ovl)
994b1a0a8a3SJed Brown {
995f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
996b1a0a8a3SJed Brown 
997b1a0a8a3SJed Brown   PetscFunctionBegin;
998ce94432eSBarry Smith   if (ovl < 0) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Negative overlap value requested");
999ce94432eSBarry Smith   if (pc->setupcalled && ovl != osm->overlap) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetOverlap() should be called before PCSetUp().");
10002fa5cd67SKarl Rupp   if (!pc->setupcalled) osm->overlap = ovl;
1001b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1002b1a0a8a3SJed Brown }
1003b1a0a8a3SJed Brown 
1004b1a0a8a3SJed Brown #undef __FUNCT__
1005f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetType_GASM"
1006f7a08781SBarry Smith static PetscErrorCode  PCGASMSetType_GASM(PC pc,PCGASMType type)
1007b1a0a8a3SJed Brown {
1008f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1009b1a0a8a3SJed Brown 
1010b1a0a8a3SJed Brown   PetscFunctionBegin;
1011b1a0a8a3SJed Brown   osm->type     = type;
1012b1a0a8a3SJed Brown   osm->type_set = PETSC_TRUE;
1013b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1014b1a0a8a3SJed Brown }
1015b1a0a8a3SJed Brown 
1016b1a0a8a3SJed Brown #undef __FUNCT__
1017f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetSortIndices_GASM"
1018f7a08781SBarry Smith static PetscErrorCode  PCGASMSetSortIndices_GASM(PC pc,PetscBool doSort)
1019b1a0a8a3SJed Brown {
1020f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1021b1a0a8a3SJed Brown 
1022b1a0a8a3SJed Brown   PetscFunctionBegin;
1023b1a0a8a3SJed Brown   osm->sort_indices = doSort;
1024b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1025b1a0a8a3SJed Brown }
1026b1a0a8a3SJed Brown 
1027b1a0a8a3SJed Brown #undef __FUNCT__
1028f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMGetSubKSP_GASM"
102944fe18e5SDmitry Karpeev /*
10308f3b4b4dSDmitry Karpeev    FIXME: This routine might need to be modified now that multiple ranks per subdomain are allowed.
103144fe18e5SDmitry Karpeev         In particular, it would upset the global subdomain number calculation.
103244fe18e5SDmitry Karpeev */
1033f7a08781SBarry Smith static PetscErrorCode  PCGASMGetSubKSP_GASM(PC pc,PetscInt *n,PetscInt *first,KSP **ksp)
1034b1a0a8a3SJed Brown {
1035f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1036b1a0a8a3SJed Brown   PetscErrorCode ierr;
1037b1a0a8a3SJed Brown 
1038b1a0a8a3SJed Brown   PetscFunctionBegin;
1039ce94432eSBarry 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");
1040b1a0a8a3SJed Brown 
10412fa5cd67SKarl Rupp   if (n) *n = osm->n;
1042ab3e923fSDmitry Karpeev   if (first) {
1043ce94432eSBarry Smith     ierr    = MPI_Scan(&osm->n,first,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1044ab3e923fSDmitry Karpeev     *first -= osm->n;
1045b1a0a8a3SJed Brown   }
1046b1a0a8a3SJed Brown   if (ksp) {
1047b1a0a8a3SJed Brown     /* Assume that local solves are now different; not necessarily
104806b43e7eSDmitry Karpeev        true, though!  This flag is used only for PCView_GASM() */
1049b1a0a8a3SJed Brown     *ksp                        = osm->ksp;
10506a4f0f73SDmitry Karpeev     osm->same_subdomain_solvers = PETSC_FALSE;
1051b1a0a8a3SJed Brown   }
1052b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1053ab3e923fSDmitry Karpeev } /* PCGASMGetSubKSP_GASM() */
1054b1a0a8a3SJed Brown 
1055b1a0a8a3SJed Brown #undef __FUNCT__
105606b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMSetSubdomains"
1057b1a0a8a3SJed Brown /*@C
105806b43e7eSDmitry Karpeev     PCGASMSetSubdomains - Sets the subdomains for this processor
105906b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1060b1a0a8a3SJed Brown 
10618f3b4b4dSDmitry Karpeev     Collective on pc
1062b1a0a8a3SJed Brown 
1063b1a0a8a3SJed Brown     Input Parameters:
10648f3b4b4dSDmitry Karpeev +   pc  - the preconditioner object
106506b43e7eSDmitry Karpeev .   n   - the number of subdomains for this processor
10668f3b4b4dSDmitry Karpeev .   iis - the index sets that define the inner subdomains (or NULL for PETSc to determine subdomains)
10678f3b4b4dSDmitry 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)
1068b1a0a8a3SJed Brown 
1069b1a0a8a3SJed Brown     Notes:
107006b43e7eSDmitry Karpeev     The IS indices use the parallel, global numbering of the vector entries.
10716a4f0f73SDmitry Karpeev     Inner subdomains are those where the correction is applied.
10726a4f0f73SDmitry Karpeev     Outer subdomains are those where the residual necessary to obtain the
10736a4f0f73SDmitry Karpeev     corrections is obtained (see PCGASMType for the use of inner/outer subdomains).
10746a4f0f73SDmitry Karpeev     Both inner and outer subdomains can extend over several processors.
10756a4f0f73SDmitry Karpeev     This processor's portion of a subdomain is known as a local subdomain.
10766a4f0f73SDmitry Karpeev 
10776a4f0f73SDmitry Karpeev     By default the GASM preconditioner uses 1 (local) subdomain per processor.
10786a4f0f73SDmitry Karpeev 
1079b1a0a8a3SJed Brown 
1080b1a0a8a3SJed Brown     Level: advanced
1081b1a0a8a3SJed Brown 
108206b43e7eSDmitry Karpeev .keywords: PC, GASM, set, subdomains, additive Schwarz
1083b1a0a8a3SJed Brown 
10848f3b4b4dSDmitry Karpeev .seealso: PCGASMSetNumSubdomains(), PCGASMSetOverlap(), PCGASMGetSubKSP(),
108506b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1086b1a0a8a3SJed Brown @*/
10876a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMSetSubdomains(PC pc,PetscInt n,IS iis[],IS ois[])
1088b1a0a8a3SJed Brown {
10898f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1090b1a0a8a3SJed Brown   PetscErrorCode ierr;
1091b1a0a8a3SJed Brown 
1092b1a0a8a3SJed Brown   PetscFunctionBegin;
1093b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
10946a4f0f73SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSubdomains_C",(PC,PetscInt,IS[],IS[]),(pc,n,iis,ois));CHKERRQ(ierr);
10958f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1096b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1097b1a0a8a3SJed Brown }
1098b1a0a8a3SJed Brown 
1099b1a0a8a3SJed Brown 
1100b1a0a8a3SJed Brown #undef __FUNCT__
1101f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetOverlap"
1102b1a0a8a3SJed Brown /*@
1103f746d493SDmitry Karpeev     PCGASMSetOverlap - Sets the overlap between a pair of subdomains for the
1104b1a0a8a3SJed Brown     additive Schwarz preconditioner.  Either all or no processors in the
11058f3b4b4dSDmitry Karpeev     pc communicator must call this routine.
1106b1a0a8a3SJed Brown 
11078f3b4b4dSDmitry Karpeev     Logically Collective on pc
1108b1a0a8a3SJed Brown 
1109b1a0a8a3SJed Brown     Input Parameters:
1110b1a0a8a3SJed Brown +   pc  - the preconditioner context
11118f3b4b4dSDmitry Karpeev -   ovl - the amount of overlap between subdomains (ovl >= 0, default value = 0)
1112b1a0a8a3SJed Brown 
1113b1a0a8a3SJed Brown     Options Database Key:
111406b43e7eSDmitry Karpeev .   -pc_gasm_overlap <overlap> - Sets overlap
1115b1a0a8a3SJed Brown 
1116b1a0a8a3SJed Brown     Notes:
111706b43e7eSDmitry Karpeev     By default the GASM preconditioner uses 1 subdomain per processor.  To use
11188f3b4b4dSDmitry Karpeev     multiple subdomain per perocessor or "straddling" subdomains that intersect
11198f3b4b4dSDmitry Karpeev     multiple processors use PCGASMSetSubdomains() (or option -pc_gasm_total_subdomains <n>).
1120b1a0a8a3SJed Brown 
11218f3b4b4dSDmitry Karpeev     The overlap defaults to 0, so if one desires that no additional
1122b1a0a8a3SJed Brown     overlap be computed beyond what may have been set with a call to
11238f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), then ovl must be set to be 0.  In particular, if one does
11248f3b4b4dSDmitry Karpeev     not explicitly set the subdomains in application code, then all overlap would be computed
1125f746d493SDmitry Karpeev     internally by PETSc, and using an overlap of 0 would result in an GASM
1126b1a0a8a3SJed Brown     variant that is equivalent to the block Jacobi preconditioner.
1127b1a0a8a3SJed Brown 
1128b1a0a8a3SJed Brown     Note that one can define initial index sets with any overlap via
112906b43e7eSDmitry Karpeev     PCGASMSetSubdomains(); the routine PCGASMSetOverlap() merely allows
113006b43e7eSDmitry Karpeev     PETSc to extend that overlap further, if desired.
1131b1a0a8a3SJed Brown 
1132b1a0a8a3SJed Brown     Level: intermediate
1133b1a0a8a3SJed Brown 
1134f746d493SDmitry Karpeev .keywords: PC, GASM, set, overlap
1135b1a0a8a3SJed Brown 
11368f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
113706b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1138b1a0a8a3SJed Brown @*/
11397087cfbeSBarry Smith PetscErrorCode  PCGASMSetOverlap(PC pc,PetscInt ovl)
1140b1a0a8a3SJed Brown {
1141b1a0a8a3SJed Brown   PetscErrorCode ierr;
11428f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1143b1a0a8a3SJed Brown 
1144b1a0a8a3SJed Brown   PetscFunctionBegin;
1145b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1146b1a0a8a3SJed Brown   PetscValidLogicalCollectiveInt(pc,ovl,2);
1147f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetOverlap_C",(PC,PetscInt),(pc,ovl));CHKERRQ(ierr);
11488f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1149b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1150b1a0a8a3SJed Brown }
1151b1a0a8a3SJed Brown 
1152b1a0a8a3SJed Brown #undef __FUNCT__
1153f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetType"
1154b1a0a8a3SJed Brown /*@
1155f746d493SDmitry Karpeev     PCGASMSetType - Sets the type of restriction and interpolation used
1156b1a0a8a3SJed Brown     for local problems in the additive Schwarz method.
1157b1a0a8a3SJed Brown 
1158b1a0a8a3SJed Brown     Logically Collective on PC
1159b1a0a8a3SJed Brown 
1160b1a0a8a3SJed Brown     Input Parameters:
1161b1a0a8a3SJed Brown +   pc  - the preconditioner context
1162f746d493SDmitry Karpeev -   type - variant of GASM, one of
1163b1a0a8a3SJed Brown .vb
1164f746d493SDmitry Karpeev       PC_GASM_BASIC       - full interpolation and restriction
1165f746d493SDmitry Karpeev       PC_GASM_RESTRICT    - full restriction, local processor interpolation
1166f746d493SDmitry Karpeev       PC_GASM_INTERPOLATE - full interpolation, local processor restriction
1167f746d493SDmitry Karpeev       PC_GASM_NONE        - local processor restriction and interpolation
1168b1a0a8a3SJed Brown .ve
1169b1a0a8a3SJed Brown 
1170b1a0a8a3SJed Brown     Options Database Key:
1171f746d493SDmitry Karpeev .   -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1172b1a0a8a3SJed Brown 
1173b1a0a8a3SJed Brown     Level: intermediate
1174b1a0a8a3SJed Brown 
1175f746d493SDmitry Karpeev .keywords: PC, GASM, set, type
1176b1a0a8a3SJed Brown 
11778f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1178f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1179b1a0a8a3SJed Brown @*/
11807087cfbeSBarry Smith PetscErrorCode  PCGASMSetType(PC pc,PCGASMType type)
1181b1a0a8a3SJed Brown {
1182b1a0a8a3SJed Brown   PetscErrorCode ierr;
1183b1a0a8a3SJed Brown 
1184b1a0a8a3SJed Brown   PetscFunctionBegin;
1185b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1186b1a0a8a3SJed Brown   PetscValidLogicalCollectiveEnum(pc,type,2);
1187f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetType_C",(PC,PCGASMType),(pc,type));CHKERRQ(ierr);
1188b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1189b1a0a8a3SJed Brown }
1190b1a0a8a3SJed Brown 
1191b1a0a8a3SJed Brown #undef __FUNCT__
1192f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetSortIndices"
1193b1a0a8a3SJed Brown /*@
1194f746d493SDmitry Karpeev     PCGASMSetSortIndices - Determines whether subdomain indices are sorted.
1195b1a0a8a3SJed Brown 
1196b1a0a8a3SJed Brown     Logically Collective on PC
1197b1a0a8a3SJed Brown 
1198b1a0a8a3SJed Brown     Input Parameters:
1199b1a0a8a3SJed Brown +   pc  - the preconditioner context
1200b1a0a8a3SJed Brown -   doSort - sort the subdomain indices
1201b1a0a8a3SJed Brown 
1202b1a0a8a3SJed Brown     Level: intermediate
1203b1a0a8a3SJed Brown 
1204f746d493SDmitry Karpeev .keywords: PC, GASM, set, type
1205b1a0a8a3SJed Brown 
12068f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1207f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1208b1a0a8a3SJed Brown @*/
12097087cfbeSBarry Smith PetscErrorCode  PCGASMSetSortIndices(PC pc,PetscBool doSort)
1210b1a0a8a3SJed Brown {
1211b1a0a8a3SJed Brown   PetscErrorCode ierr;
1212b1a0a8a3SJed Brown 
1213b1a0a8a3SJed Brown   PetscFunctionBegin;
1214b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1215b1a0a8a3SJed Brown   PetscValidLogicalCollectiveBool(pc,doSort,2);
1216f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSortIndices_C",(PC,PetscBool),(pc,doSort));CHKERRQ(ierr);
1217b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1218b1a0a8a3SJed Brown }
1219b1a0a8a3SJed Brown 
1220b1a0a8a3SJed Brown #undef __FUNCT__
1221f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMGetSubKSP"
1222b1a0a8a3SJed Brown /*@C
1223f746d493SDmitry Karpeev    PCGASMGetSubKSP - Gets the local KSP contexts for all blocks on
1224b1a0a8a3SJed Brown    this processor.
1225b1a0a8a3SJed Brown 
1226b1a0a8a3SJed Brown    Collective on PC iff first_local is requested
1227b1a0a8a3SJed Brown 
1228b1a0a8a3SJed Brown    Input Parameter:
1229b1a0a8a3SJed Brown .  pc - the preconditioner context
1230b1a0a8a3SJed Brown 
1231b1a0a8a3SJed Brown    Output Parameters:
12320298fd71SBarry Smith +  n_local - the number of blocks on this processor or NULL
12330298fd71SBarry Smith .  first_local - the global number of the first block on this processor or NULL,
12340298fd71SBarry Smith                  all processors must request or all must pass NULL
1235b1a0a8a3SJed Brown -  ksp - the array of KSP contexts
1236b1a0a8a3SJed Brown 
1237b1a0a8a3SJed Brown    Note:
1238f746d493SDmitry Karpeev    After PCGASMGetSubKSP() the array of KSPes is not to be freed
1239b1a0a8a3SJed Brown 
1240b1a0a8a3SJed Brown    Currently for some matrix implementations only 1 block per processor
1241b1a0a8a3SJed Brown    is supported.
1242b1a0a8a3SJed Brown 
1243f746d493SDmitry Karpeev    You must call KSPSetUp() before calling PCGASMGetSubKSP().
1244b1a0a8a3SJed Brown 
1245b1a0a8a3SJed Brown    Level: advanced
1246b1a0a8a3SJed Brown 
1247f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, get, sub, KSP, context
1248b1a0a8a3SJed Brown 
12498f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap(),
1250f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D(),
1251b1a0a8a3SJed Brown @*/
12527087cfbeSBarry Smith PetscErrorCode  PCGASMGetSubKSP(PC pc,PetscInt *n_local,PetscInt *first_local,KSP *ksp[])
1253b1a0a8a3SJed Brown {
1254b1a0a8a3SJed Brown   PetscErrorCode ierr;
1255b1a0a8a3SJed Brown 
1256b1a0a8a3SJed Brown   PetscFunctionBegin;
1257b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1258f746d493SDmitry Karpeev   ierr = PetscUseMethod(pc,"PCGASMGetSubKSP_C",(PC,PetscInt*,PetscInt*,KSP **),(pc,n_local,first_local,ksp));CHKERRQ(ierr);
1259b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1260b1a0a8a3SJed Brown }
1261b1a0a8a3SJed Brown 
1262b1a0a8a3SJed Brown /* -------------------------------------------------------------------------------------*/
1263b1a0a8a3SJed Brown /*MC
1264f746d493SDmitry Karpeev    PCGASM - Use the (restricted) additive Schwarz method, each block is (approximately) solved with
1265b1a0a8a3SJed Brown            its own KSP object.
1266b1a0a8a3SJed Brown 
1267b1a0a8a3SJed Brown    Options Database Keys:
12688f3b4b4dSDmitry Karpeev +  -pc_gasm_total_subdomains <n>  - Sets total number of local subdomains to be distributed among processors
126906b43e7eSDmitry Karpeev .  -pc_gasm_view_subdomains       - activates the printing of subdomain indices in PCView(), -ksp_view or -snes_view
127006b43e7eSDmitry Karpeev .  -pc_gasm_print_subdomains      - activates the printing of subdomain indices in PCSetUp()
127106b43e7eSDmitry Karpeev .  -pc_gasm_overlap <ovl>         - Sets overlap by which to (automatically) extend local subdomains
1272f746d493SDmitry Karpeev -  -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1273b1a0a8a3SJed Brown 
1274b1a0a8a3SJed Brown      IMPORTANT: If you run with, for example, 3 blocks on 1 processor or 3 blocks on 3 processors you
1275f746d493SDmitry Karpeev       will get a different convergence rate due to the default option of -pc_gasm_type restrict. Use
1276f746d493SDmitry Karpeev       -pc_gasm_type basic to use the standard GASM.
1277b1a0a8a3SJed Brown 
1278b1a0a8a3SJed Brown    Notes: Each processor can have one or more blocks, but a block cannot be shared by more
1279b1a0a8a3SJed Brown      than one processor. Defaults to one block per processor.
1280b1a0a8a3SJed Brown 
1281b1a0a8a3SJed Brown      To set options on the solvers for each block append -sub_ to all the KSP, and PC
1282b1a0a8a3SJed Brown         options database keys. For example, -sub_pc_type ilu -sub_pc_factor_levels 1 -sub_ksp_type preonly
1283b1a0a8a3SJed Brown 
1284f746d493SDmitry Karpeev      To set the options on the solvers separate for each block call PCGASMGetSubKSP()
1285b1a0a8a3SJed Brown          and set the options directly on the resulting KSP object (you can access its PC
1286b1a0a8a3SJed Brown          with KSPGetPC())
1287b1a0a8a3SJed Brown 
1288b1a0a8a3SJed Brown 
1289b1a0a8a3SJed Brown    Level: beginner
1290b1a0a8a3SJed Brown 
1291b1a0a8a3SJed Brown    Concepts: additive Schwarz method
1292b1a0a8a3SJed Brown 
1293b1a0a8a3SJed Brown     References:
1294b1a0a8a3SJed Brown     An additive variant of the Schwarz alternating method for the case of many subregions
1295b1a0a8a3SJed Brown     M Dryja, OB Widlund - Courant Institute, New York University Technical report
1296b1a0a8a3SJed Brown 
1297b1a0a8a3SJed Brown     Domain Decompositions: Parallel Multilevel Methods for Elliptic Partial Differential Equations,
1298b1a0a8a3SJed Brown     Barry Smith, Petter Bjorstad, and William Gropp, Cambridge University Press, ISBN 0-521-49589-X.
1299b1a0a8a3SJed Brown 
1300b1a0a8a3SJed Brown .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
130149517cdeSBarry Smith            PCBJACOBI,  PCGASMGetSubKSP(), PCGASMSetSubdomains(),
13028f3b4b4dSDmitry Karpeev            PCSetModifySubmatrices(), PCGASMSetOverlap(), PCGASMSetType()
1303b1a0a8a3SJed Brown 
1304b1a0a8a3SJed Brown M*/
1305b1a0a8a3SJed Brown 
1306b1a0a8a3SJed Brown #undef __FUNCT__
1307f746d493SDmitry Karpeev #define __FUNCT__ "PCCreate_GASM"
13088cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GASM(PC pc)
1309b1a0a8a3SJed Brown {
1310b1a0a8a3SJed Brown   PetscErrorCode ierr;
1311f746d493SDmitry Karpeev   PC_GASM        *osm;
1312b1a0a8a3SJed Brown 
1313b1a0a8a3SJed Brown   PetscFunctionBegin;
1314b00a9115SJed Brown   ierr = PetscNewLog(pc,&osm);CHKERRQ(ierr);
13152fa5cd67SKarl Rupp 
13168f3b4b4dSDmitry Karpeev   osm->N                        = PETSC_DETERMINE;
131706b43e7eSDmitry Karpeev   osm->n                        = PETSC_DECIDE;
13188f3b4b4dSDmitry Karpeev   osm->nmax                     = PETSC_DETERMINE;
13198f3b4b4dSDmitry Karpeev   osm->overlap                  = 0;
1320b1a0a8a3SJed Brown   osm->ksp                      = 0;
13216a4f0f73SDmitry Karpeev   osm->gorestriction            = 0;
13226a4f0f73SDmitry Karpeev   osm->girestriction            = 0;
1323*ea91fabdSFande Kong   osm->pctoouter                = 0;
1324ab3e923fSDmitry Karpeev   osm->gx                       = 0;
1325ab3e923fSDmitry Karpeev   osm->gy                       = 0;
1326b1a0a8a3SJed Brown   osm->x                        = 0;
1327b1a0a8a3SJed Brown   osm->y                        = 0;
1328*ea91fabdSFande Kong   osm->pcx                      = 0;
1329*ea91fabdSFande Kong   osm->pcy                      = 0;
1330*ea91fabdSFande Kong   osm->permutationIS            = 0;
1331*ea91fabdSFande Kong   osm->permutationP             = 0;
1332*ea91fabdSFande Kong   osm->pcmat                    = 0;
13336a4f0f73SDmitry Karpeev   osm->ois                      = 0;
13346a4f0f73SDmitry Karpeev   osm->iis                      = 0;
1335b1a0a8a3SJed Brown   osm->pmat                     = 0;
1336f746d493SDmitry Karpeev   osm->type                     = PC_GASM_RESTRICT;
13376a4f0f73SDmitry Karpeev   osm->same_subdomain_solvers   = PETSC_TRUE;
1338b1a0a8a3SJed Brown   osm->sort_indices             = PETSC_TRUE;
1339d709ea83SDmitry Karpeev   osm->dm_subdomains            = PETSC_FALSE;
1340*ea91fabdSFande Kong   osm->hierarchicalpartitioning = PETSC_FALSE;
1341b1a0a8a3SJed Brown 
1342b1a0a8a3SJed Brown   pc->data                 = (void*)osm;
1343f746d493SDmitry Karpeev   pc->ops->apply           = PCApply_GASM;
1344f746d493SDmitry Karpeev   pc->ops->applytranspose  = PCApplyTranspose_GASM;
1345f746d493SDmitry Karpeev   pc->ops->setup           = PCSetUp_GASM;
1346a06653b4SBarry Smith   pc->ops->reset           = PCReset_GASM;
1347f746d493SDmitry Karpeev   pc->ops->destroy         = PCDestroy_GASM;
1348f746d493SDmitry Karpeev   pc->ops->setfromoptions  = PCSetFromOptions_GASM;
1349f746d493SDmitry Karpeev   pc->ops->setuponblocks   = PCSetUpOnBlocks_GASM;
1350f746d493SDmitry Karpeev   pc->ops->view            = PCView_GASM;
1351b1a0a8a3SJed Brown   pc->ops->applyrichardson = 0;
1352b1a0a8a3SJed Brown 
1353bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSubdomains_C",PCGASMSetSubdomains_GASM);CHKERRQ(ierr);
1354bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetOverlap_C",PCGASMSetOverlap_GASM);CHKERRQ(ierr);
1355bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetType_C",PCGASMSetType_GASM);CHKERRQ(ierr);
1356bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSortIndices_C",PCGASMSetSortIndices_GASM);CHKERRQ(ierr);
1357bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMGetSubKSP_C",PCGASMGetSubKSP_GASM);CHKERRQ(ierr);
1358b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1359b1a0a8a3SJed Brown }
1360b1a0a8a3SJed Brown 
1361b1a0a8a3SJed Brown 
1362b1a0a8a3SJed Brown #undef __FUNCT__
136306b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMCreateLocalSubdomains"
13648f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[])
1365b1a0a8a3SJed Brown {
1366b1a0a8a3SJed Brown   MatPartitioning mpart;
1367b1a0a8a3SJed Brown   const char      *prefix;
136811bd1e4dSLisandro Dalcin   PetscErrorCode  (*f)(Mat,MatReuse,Mat*);
1369b1a0a8a3SJed Brown   PetscMPIInt     size;
1370b1a0a8a3SJed Brown   PetscInt        i,j,rstart,rend,bs;
137111bd1e4dSLisandro Dalcin   PetscBool       isbaij = PETSC_FALSE,foundpart = PETSC_FALSE;
13720298fd71SBarry Smith   Mat             Ad     = NULL, adj;
1373b1a0a8a3SJed Brown   IS              ispart,isnumb,*is;
1374b1a0a8a3SJed Brown   PetscErrorCode  ierr;
1375b1a0a8a3SJed Brown 
1376b1a0a8a3SJed Brown   PetscFunctionBegin;
13778f3b4b4dSDmitry Karpeev   if (nloc < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"number of local subdomains must > 0, got nloc = %D",nloc);
1378b1a0a8a3SJed Brown 
1379b1a0a8a3SJed Brown   /* Get prefix, row distribution, and block size */
1380b1a0a8a3SJed Brown   ierr = MatGetOptionsPrefix(A,&prefix);CHKERRQ(ierr);
1381b1a0a8a3SJed Brown   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
1382b1a0a8a3SJed Brown   ierr = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
1383b1a0a8a3SJed 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);
1384b1a0a8a3SJed Brown 
1385b1a0a8a3SJed Brown   /* Get diagonal block from matrix if possible */
1386ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
13870005d66cSJed Brown   ierr = PetscObjectQueryFunction((PetscObject)A,"MatGetDiagonalBlock_C",&f);CHKERRQ(ierr);
1388b1a0a8a3SJed Brown   if (f) {
138911bd1e4dSLisandro Dalcin     ierr = MatGetDiagonalBlock(A,&Ad);CHKERRQ(ierr);
1390b1a0a8a3SJed Brown   } else if (size == 1) {
139111bd1e4dSLisandro Dalcin     Ad = A;
1392b1a0a8a3SJed Brown   }
1393b1a0a8a3SJed Brown   if (Ad) {
1394251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)Ad,MATSEQBAIJ,&isbaij);CHKERRQ(ierr);
1395251f4c67SDmitry Karpeev     if (!isbaij) {ierr = PetscObjectTypeCompare((PetscObject)Ad,MATSEQSBAIJ,&isbaij);CHKERRQ(ierr);}
1396b1a0a8a3SJed Brown   }
13978f3b4b4dSDmitry Karpeev   if (Ad && nloc > 1) {
1398b1a0a8a3SJed Brown     PetscBool  match,done;
1399b1a0a8a3SJed Brown     /* Try to setup a good matrix partitioning if available */
1400b1a0a8a3SJed Brown     ierr = MatPartitioningCreate(PETSC_COMM_SELF,&mpart);CHKERRQ(ierr);
1401b1a0a8a3SJed Brown     ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
1402b1a0a8a3SJed Brown     ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
1403251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGCURRENT,&match);CHKERRQ(ierr);
1404b1a0a8a3SJed Brown     if (!match) {
1405251f4c67SDmitry Karpeev       ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGSQUARE,&match);CHKERRQ(ierr);
1406b1a0a8a3SJed Brown     }
1407b1a0a8a3SJed Brown     if (!match) { /* assume a "good" partitioner is available */
14081a83f524SJed Brown       PetscInt       na;
14091a83f524SJed Brown       const PetscInt *ia,*ja;
1410b1a0a8a3SJed Brown       ierr = MatGetRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1411b1a0a8a3SJed Brown       if (done) {
1412b1a0a8a3SJed Brown         /* Build adjacency matrix by hand. Unfortunately a call to
1413b1a0a8a3SJed Brown            MatConvert(Ad,MATMPIADJ,MAT_INITIAL_MATRIX,&adj) will
1414b1a0a8a3SJed Brown            remove the block-aij structure and we cannot expect
1415b1a0a8a3SJed Brown            MatPartitioning to split vertices as we need */
14161a83f524SJed Brown         PetscInt       i,j,len,nnz,cnt,*iia=0,*jja=0;
14171a83f524SJed Brown         const PetscInt *row;
1418b1a0a8a3SJed Brown         nnz = 0;
1419b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* count number of nonzeros */
1420b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1421b1a0a8a3SJed Brown           row = ja + ia[i];
1422b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
1423b1a0a8a3SJed Brown             if (row[j] == i) { /* don't count diagonal */
1424b1a0a8a3SJed Brown               len--; break;
1425b1a0a8a3SJed Brown             }
1426b1a0a8a3SJed Brown           }
1427b1a0a8a3SJed Brown           nnz += len;
1428b1a0a8a3SJed Brown         }
1429854ce69bSBarry Smith         ierr   = PetscMalloc1(na+1,&iia);CHKERRQ(ierr);
1430854ce69bSBarry Smith         ierr   = PetscMalloc1(nnz,&jja);CHKERRQ(ierr);
1431b1a0a8a3SJed Brown         nnz    = 0;
1432b1a0a8a3SJed Brown         iia[0] = 0;
1433b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* fill adjacency */
1434b1a0a8a3SJed Brown           cnt = 0;
1435b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1436b1a0a8a3SJed Brown           row = ja + ia[i];
1437b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
14382fa5cd67SKarl Rupp             if (row[j] != i) jja[nnz+cnt++] = row[j]; /* if not diagonal */
1439b1a0a8a3SJed Brown           }
1440b1a0a8a3SJed Brown           nnz += cnt;
1441b1a0a8a3SJed Brown           iia[i+1] = nnz;
1442b1a0a8a3SJed Brown         }
1443b1a0a8a3SJed Brown         /* Partitioning of the adjacency matrix */
14440298fd71SBarry Smith         ierr      = MatCreateMPIAdj(PETSC_COMM_SELF,na,na,iia,jja,NULL,&adj);CHKERRQ(ierr);
1445b1a0a8a3SJed Brown         ierr      = MatPartitioningSetAdjacency(mpart,adj);CHKERRQ(ierr);
14468f3b4b4dSDmitry Karpeev         ierr      = MatPartitioningSetNParts(mpart,nloc);CHKERRQ(ierr);
1447b1a0a8a3SJed Brown         ierr      = MatPartitioningApply(mpart,&ispart);CHKERRQ(ierr);
1448b1a0a8a3SJed Brown         ierr      = ISPartitioningToNumbering(ispart,&isnumb);CHKERRQ(ierr);
14496bf464f9SBarry Smith         ierr      = MatDestroy(&adj);CHKERRQ(ierr);
1450b1a0a8a3SJed Brown         foundpart = PETSC_TRUE;
1451b1a0a8a3SJed Brown       }
1452b1a0a8a3SJed Brown       ierr = MatRestoreRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1453b1a0a8a3SJed Brown     }
14546bf464f9SBarry Smith     ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
1455b1a0a8a3SJed Brown   }
14568f3b4b4dSDmitry Karpeev   ierr = PetscMalloc1(nloc,&is);CHKERRQ(ierr);
1457b1a0a8a3SJed Brown   if (!foundpart) {
1458b1a0a8a3SJed Brown 
1459b1a0a8a3SJed Brown     /* Partitioning by contiguous chunks of rows */
1460b1a0a8a3SJed Brown 
1461b1a0a8a3SJed Brown     PetscInt mbs   = (rend-rstart)/bs;
1462b1a0a8a3SJed Brown     PetscInt start = rstart;
14638f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
14648f3b4b4dSDmitry Karpeev       PetscInt count = (mbs/nloc + ((mbs % nloc) > i)) * bs;
1465b1a0a8a3SJed Brown       ierr   = ISCreateStride(PETSC_COMM_SELF,count,start,1,&is[i]);CHKERRQ(ierr);
1466b1a0a8a3SJed Brown       start += count;
1467b1a0a8a3SJed Brown     }
1468b1a0a8a3SJed Brown 
1469b1a0a8a3SJed Brown   } else {
1470b1a0a8a3SJed Brown 
1471b1a0a8a3SJed Brown     /* Partitioning by adjacency of diagonal block  */
1472b1a0a8a3SJed Brown 
1473b1a0a8a3SJed Brown     const PetscInt *numbering;
1474b1a0a8a3SJed Brown     PetscInt       *count,nidx,*indices,*newidx,start=0;
1475b1a0a8a3SJed Brown     /* Get node count in each partition */
14768f3b4b4dSDmitry Karpeev     ierr = PetscMalloc1(nloc,&count);CHKERRQ(ierr);
14778f3b4b4dSDmitry Karpeev     ierr = ISPartitioningCount(ispart,nloc,count);CHKERRQ(ierr);
1478b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
14798f3b4b4dSDmitry Karpeev       for (i=0; i<nloc; i++) count[i] *= bs;
1480b1a0a8a3SJed Brown     }
1481b1a0a8a3SJed Brown     /* Build indices from node numbering */
1482b1a0a8a3SJed Brown     ierr = ISGetLocalSize(isnumb,&nidx);CHKERRQ(ierr);
1483785e854fSJed Brown     ierr = PetscMalloc1(nidx,&indices);CHKERRQ(ierr);
1484b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] = i; /* needs to be initialized */
1485b1a0a8a3SJed Brown     ierr = ISGetIndices(isnumb,&numbering);CHKERRQ(ierr);
1486b1a0a8a3SJed Brown     ierr = PetscSortIntWithPermutation(nidx,numbering,indices);CHKERRQ(ierr);
1487b1a0a8a3SJed Brown     ierr = ISRestoreIndices(isnumb,&numbering);CHKERRQ(ierr);
1488b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
1489785e854fSJed Brown       ierr = PetscMalloc1(nidx*bs,&newidx);CHKERRQ(ierr);
14902fa5cd67SKarl Rupp       for (i=0; i<nidx; i++) {
14912fa5cd67SKarl Rupp         for (j=0; j<bs; j++) newidx[i*bs+j] = indices[i]*bs + j;
14922fa5cd67SKarl Rupp       }
1493b1a0a8a3SJed Brown       ierr    = PetscFree(indices);CHKERRQ(ierr);
1494b1a0a8a3SJed Brown       nidx   *= bs;
1495b1a0a8a3SJed Brown       indices = newidx;
1496b1a0a8a3SJed Brown     }
1497b1a0a8a3SJed Brown     /* Shift to get global indices */
1498b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] += rstart;
1499b1a0a8a3SJed Brown 
1500b1a0a8a3SJed Brown     /* Build the index sets for each block */
15018f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
1502b1a0a8a3SJed Brown       ierr   = ISCreateGeneral(PETSC_COMM_SELF,count[i],&indices[start],PETSC_COPY_VALUES,&is[i]);CHKERRQ(ierr);
1503b1a0a8a3SJed Brown       ierr   = ISSort(is[i]);CHKERRQ(ierr);
1504b1a0a8a3SJed Brown       start += count[i];
1505b1a0a8a3SJed Brown     }
1506b1a0a8a3SJed Brown 
1507302440fdSBarry Smith     ierr = PetscFree(count);CHKERRQ(ierr);
1508302440fdSBarry Smith     ierr = PetscFree(indices);CHKERRQ(ierr);
1509fcfd50ebSBarry Smith     ierr = ISDestroy(&isnumb);CHKERRQ(ierr);
1510fcfd50ebSBarry Smith     ierr = ISDestroy(&ispart);CHKERRQ(ierr);
1511b1a0a8a3SJed Brown   }
15126a4f0f73SDmitry Karpeev   *iis = is;
15138f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
15148f3b4b4dSDmitry Karpeev }
15158f3b4b4dSDmitry Karpeev 
15168f3b4b4dSDmitry Karpeev #undef __FUNCT__
15178f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMCreateStraddlingSubdomains"
1518b541e6a4SDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateStraddlingSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
15198f3b4b4dSDmitry Karpeev {
15208f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
15218f3b4b4dSDmitry Karpeev 
15228f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
15238f3b4b4dSDmitry Karpeev   ierr = MatSubdomainsCreateCoalesce(A,N,n,iis);CHKERRQ(ierr);
15248f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
15258f3b4b4dSDmitry Karpeev }
15268f3b4b4dSDmitry Karpeev 
15278f3b4b4dSDmitry Karpeev 
15288f3b4b4dSDmitry Karpeev 
15298f3b4b4dSDmitry Karpeev #undef __FUNCT__
15308f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMCreateSubdomains"
15318f3b4b4dSDmitry Karpeev /*@C
15328f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains - Creates n index sets defining n nonoverlapping subdomains for the additive
15338f3b4b4dSDmitry Karpeev    Schwarz preconditioner for a any problem based on its matrix.
15348f3b4b4dSDmitry Karpeev 
15358f3b4b4dSDmitry Karpeev    Collective
15368f3b4b4dSDmitry Karpeev 
15378f3b4b4dSDmitry Karpeev    Input Parameters:
15388f3b4b4dSDmitry Karpeev +  A       - The global matrix operator
15398f3b4b4dSDmitry Karpeev -  N       - the number of global subdomains requested
15408f3b4b4dSDmitry Karpeev 
15418f3b4b4dSDmitry Karpeev    Output Parameters:
15428f3b4b4dSDmitry Karpeev +  n   - the number of subdomains created on this processor
15438f3b4b4dSDmitry Karpeev -  iis - the array of index sets defining the local inner subdomains (on which the correction is applied)
15448f3b4b4dSDmitry Karpeev 
15458f3b4b4dSDmitry Karpeev    Level: advanced
15468f3b4b4dSDmitry Karpeev 
15478f3b4b4dSDmitry Karpeev    Note: When N >= A's communicator size, each subdomain is local -- contained within a single processor.
15488f3b4b4dSDmitry Karpeev          When N < size, the subdomains are 'straddling' (processor boundaries) and are no longer local.
15498f3b4b4dSDmitry Karpeev          The resulting subdomains can be use in PCGASMSetSubdomains(pc,n,iss,NULL).  The overlapping
15508f3b4b4dSDmitry Karpeev 	 outer subdomains will be automatically generated from these according to the requested amount of
15518f3b4b4dSDmitry Karpeev 	 overlap; this is currently supported only with local subdomains.
15528f3b4b4dSDmitry Karpeev 
15538f3b4b4dSDmitry Karpeev 
15548f3b4b4dSDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, unstructured grid
15558f3b4b4dSDmitry Karpeev 
15568f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMDestroySubdomains()
15578f3b4b4dSDmitry Karpeev @*/
1558b541e6a4SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
15598f3b4b4dSDmitry Karpeev {
15608f3b4b4dSDmitry Karpeev   PetscMPIInt     size;
15618f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
15628f3b4b4dSDmitry Karpeev 
15638f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
15648f3b4b4dSDmitry Karpeev   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
15658f3b4b4dSDmitry Karpeev   PetscValidPointer(iis,4);
15668f3b4b4dSDmitry Karpeev 
15678f3b4b4dSDmitry Karpeev   if (N < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Number of subdomains must be > 0, N = %D",N);
15688f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
15698f3b4b4dSDmitry Karpeev   if (N >= size) {
15708f3b4b4dSDmitry Karpeev     *n = N/size + (N%size);
15718f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateLocalSubdomains(A,*n,iis);CHKERRQ(ierr);
15726a4f0f73SDmitry Karpeev   } else {
15738f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateStraddlingSubdomains(A,N,n,iis);CHKERRQ(ierr);
15746a4f0f73SDmitry Karpeev   }
1575b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1576b1a0a8a3SJed Brown }
1577b1a0a8a3SJed Brown 
1578b1a0a8a3SJed Brown #undef __FUNCT__
1579f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMDestroySubdomains"
1580b1a0a8a3SJed Brown /*@C
1581f746d493SDmitry Karpeev    PCGASMDestroySubdomains - Destroys the index sets created with
15828f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains() or PCGASMCreateSubdomains2D. Should be
158306b43e7eSDmitry Karpeev    called after setting subdomains with PCGASMSetSubdomains().
1584b1a0a8a3SJed Brown 
1585b1a0a8a3SJed Brown    Collective
1586b1a0a8a3SJed Brown 
1587b1a0a8a3SJed Brown    Input Parameters:
1588b1a0a8a3SJed Brown +  n   - the number of index sets
15896a4f0f73SDmitry Karpeev .  iis - the array of inner subdomains,
15900298fd71SBarry Smith -  ois - the array of outer subdomains, can be NULL
1591b1a0a8a3SJed Brown 
15926a4f0f73SDmitry Karpeev    Level: intermediate
15936a4f0f73SDmitry Karpeev 
15946a4f0f73SDmitry Karpeev    Notes: this is merely a convenience subroutine that walks each list,
15952c112581SDmitry Karpeev    destroys each IS on the list, and then frees the list. At the end the
15962c112581SDmitry Karpeev    list pointers are set to NULL.
1597b1a0a8a3SJed Brown 
1598f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, unstructured grid
1599b1a0a8a3SJed Brown 
16008f3b4b4dSDmitry Karpeev .seealso: PCGASMCreateSubdomains(), PCGASMSetSubdomains()
1601b1a0a8a3SJed Brown @*/
16022c112581SDmitry Karpeev PetscErrorCode  PCGASMDestroySubdomains(PetscInt n,IS **iis,IS **ois)
1603b1a0a8a3SJed Brown {
1604b1a0a8a3SJed Brown   PetscInt       i;
1605b1a0a8a3SJed Brown   PetscErrorCode ierr;
16065fd66863SKarl Rupp 
1607b1a0a8a3SJed Brown   PetscFunctionBegin;
1608a35b7b57SDmitry Karpeev   if (n <= 0) PetscFunctionReturn(0);
16096a4f0f73SDmitry Karpeev   if (ois) {
16102c112581SDmitry Karpeev     PetscValidPointer(ois,3);
16112c112581SDmitry Karpeev     if (*ois) {
16122c112581SDmitry Karpeev       PetscValidPointer(*ois,3);
1613a35b7b57SDmitry Karpeev       for (i=0; i<n; i++) {
16142c112581SDmitry Karpeev         ierr = ISDestroy(&(*ois)[i]);CHKERRQ(ierr);
1615a35b7b57SDmitry Karpeev       }
1616135757f6SDmitry Karpeev       ierr = PetscFree((*ois));CHKERRQ(ierr);
16172c112581SDmitry Karpeev     }
1618b1a0a8a3SJed Brown   }
1619b9d0fdaaSFande Kong   if (iis) {
1620b9d0fdaaSFande Kong     PetscValidPointer(iis,2);
1621b9d0fdaaSFande Kong     if (*iis) {
1622b9d0fdaaSFande Kong       PetscValidPointer(*iis,2);
1623b9d0fdaaSFande Kong       for (i=0; i<n; i++) {
1624b9d0fdaaSFande Kong         ierr = ISDestroy(&(*iis)[i]);CHKERRQ(ierr);
1625b9d0fdaaSFande Kong       }
1626b9d0fdaaSFande Kong       ierr = PetscFree((*iis));CHKERRQ(ierr);
1627b9d0fdaaSFande Kong     }
1628b9d0fdaaSFande Kong   }
1629b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1630b1a0a8a3SJed Brown }
1631b1a0a8a3SJed Brown 
1632af538404SDmitry Karpeev 
1633af538404SDmitry Karpeev #define PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,xleft_loc,ylow_loc,xright_loc,yhigh_loc,n) \
1634af538404SDmitry Karpeev   {                                                                                                       \
1635af538404SDmitry Karpeev     PetscInt first_row = first/M, last_row = last/M+1;                                                     \
1636af538404SDmitry Karpeev     /*                                                                                                    \
1637af538404SDmitry Karpeev      Compute ylow_loc and yhigh_loc so that (ylow_loc,xleft) and (yhigh_loc,xright) are the corners       \
1638af538404SDmitry Karpeev      of the bounding box of the intersection of the subdomain with the local ownership range (local       \
1639af538404SDmitry Karpeev      subdomain).                                                                                          \
1640af538404SDmitry Karpeev      Also compute xleft_loc and xright_loc as the lower and upper bounds on the first and last rows       \
1641af538404SDmitry Karpeev      of the intersection.                                                                                 \
1642af538404SDmitry Karpeev     */                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             \
1643af538404SDmitry Karpeev     /* ylow_loc is the grid row containing the first element of the local sumbdomain */                   \
1644eec7e3faSDmitry Karpeev     *ylow_loc = PetscMax(first_row,ylow);                                                                    \
1645af538404SDmitry Karpeev     /* xleft_loc is the offset of first element of the local subdomain within its grid row (might actually be outside the local subdomain) */ \
1646eec7e3faSDmitry Karpeev     *xleft_loc = *ylow_loc==first_row ? PetscMax(first%M,xleft) : xleft;                                                                            \
1647af538404SDmitry Karpeev     /* yhigh_loc is the grid row above the last local subdomain element */                                                                    \
1648eec7e3faSDmitry Karpeev     *yhigh_loc = PetscMin(last_row,yhigh);                                                                                                     \
1649af538404SDmitry Karpeev     /* xright is the offset of the end of the  local subdomain within its grid row (might actually be outside the local subdomain) */         \
1650eec7e3faSDmitry Karpeev     *xright_loc = *yhigh_loc==last_row ? PetscMin(xright,last%M) : xright;                                                                          \
1651af538404SDmitry Karpeev     /* Now compute the size of the local subdomain n. */ \
1652c3518bceSDmitry Karpeev     *n = 0;                                               \
1653eec7e3faSDmitry Karpeev     if (*ylow_loc < *yhigh_loc) {                           \
1654af538404SDmitry Karpeev       PetscInt width = xright-xleft;                     \
1655eec7e3faSDmitry Karpeev       *n += width*(*yhigh_loc-*ylow_loc-1);                 \
1656eec7e3faSDmitry Karpeev       *n += PetscMin(PetscMax(*xright_loc-xleft,0),width); \
1657eec7e3faSDmitry Karpeev       *n -= PetscMin(PetscMax(*xleft_loc-xleft,0), width); \
1658af538404SDmitry Karpeev     } \
1659af538404SDmitry Karpeev   }
1660af538404SDmitry Karpeev 
1661c3518bceSDmitry Karpeev 
1662eec7e3faSDmitry Karpeev 
1663eec7e3faSDmitry Karpeev #undef __FUNCT__
1664f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMCreateSubdomains2D"
1665b1a0a8a3SJed Brown /*@
1666f746d493SDmitry Karpeev    PCGASMCreateSubdomains2D - Creates the index sets for the overlapping Schwarz
1667b1a0a8a3SJed Brown    preconditioner for a two-dimensional problem on a regular grid.
1668b1a0a8a3SJed Brown 
1669af538404SDmitry Karpeev    Collective
1670b1a0a8a3SJed Brown 
1671b1a0a8a3SJed Brown    Input Parameters:
167206b43e7eSDmitry Karpeev +  M, N               - the global number of grid points in the x and y directions
1673af538404SDmitry Karpeev .  Mdomains, Ndomains - the global number of subdomains in the x and y directions
1674b1a0a8a3SJed Brown .  dof                - degrees of freedom per node
1675b1a0a8a3SJed Brown -  overlap            - overlap in mesh lines
1676b1a0a8a3SJed Brown 
1677b1a0a8a3SJed Brown    Output Parameters:
1678af538404SDmitry Karpeev +  Nsub - the number of local subdomains created
16796a4f0f73SDmitry Karpeev .  iis  - array of index sets defining inner (nonoverlapping) subdomains
16806a4f0f73SDmitry Karpeev -  ois  - array of index sets defining outer (overlapping, if overlap > 0) subdomains
1681b1a0a8a3SJed Brown 
1682b1a0a8a3SJed Brown 
1683b1a0a8a3SJed Brown    Level: advanced
1684b1a0a8a3SJed Brown 
1685f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, 2D, regular grid
1686b1a0a8a3SJed Brown 
16878f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(), PCGASMSetOverlap()
1688b1a0a8a3SJed Brown @*/
16896a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains2D(PC pc,PetscInt M,PetscInt N,PetscInt Mdomains,PetscInt Ndomains,PetscInt dof,PetscInt overlap,PetscInt *nsub,IS **iis,IS **ois)
1690b1a0a8a3SJed Brown {
1691b1a0a8a3SJed Brown   PetscErrorCode ierr;
16922bbb417fSDmitry Karpeev   PetscMPIInt    size, rank;
16932bbb417fSDmitry Karpeev   PetscInt       i, j;
16942bbb417fSDmitry Karpeev   PetscInt       maxheight, maxwidth;
16952bbb417fSDmitry Karpeev   PetscInt       xstart, xleft, xright, xleft_loc, xright_loc;
16962bbb417fSDmitry Karpeev   PetscInt       ystart, ylow,  yhigh,  ylow_loc,  yhigh_loc;
1697eec7e3faSDmitry Karpeev   PetscInt       x[2][2], y[2][2], n[2];
16982bbb417fSDmitry Karpeev   PetscInt       first, last;
16992bbb417fSDmitry Karpeev   PetscInt       nidx, *idx;
17002bbb417fSDmitry Karpeev   PetscInt       ii,jj,s,q,d;
1701af538404SDmitry Karpeev   PetscInt       k,kk;
17022bbb417fSDmitry Karpeev   PetscMPIInt    color;
17032bbb417fSDmitry Karpeev   MPI_Comm       comm, subcomm;
17046a4f0f73SDmitry Karpeev   IS             **xis = 0, **is = ois, **is_local = iis;
1705d34fcf5fSBarry Smith 
1706b1a0a8a3SJed Brown   PetscFunctionBegin;
17072bbb417fSDmitry Karpeev   ierr = PetscObjectGetComm((PetscObject)pc, &comm);CHKERRQ(ierr);
17082bbb417fSDmitry Karpeev   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
17092bbb417fSDmitry Karpeev   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
17102bbb417fSDmitry Karpeev   ierr = MatGetOwnershipRange(pc->pmat, &first, &last);CHKERRQ(ierr);
1711d34fcf5fSBarry 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) "
17122bbb417fSDmitry Karpeev                                       "does not respect the number of degrees of freedom per grid point %D", first, last, dof);
1713d34fcf5fSBarry Smith 
1714af538404SDmitry Karpeev   /* Determine the number of domains with nonzero intersections with the local ownership range. */
17152bbb417fSDmitry Karpeev   s      = 0;
1716af538404SDmitry Karpeev   ystart = 0;
1717af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1718af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1719af538404SDmitry 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);
1720eec7e3faSDmitry Karpeev     /* Vertical domain limits with an overlap. */
1721eec7e3faSDmitry Karpeev     ylow   = PetscMax(ystart - overlap,0);
1722eec7e3faSDmitry Karpeev     yhigh  = PetscMin(ystart + maxheight + overlap,N);
1723b1a0a8a3SJed Brown     xstart = 0;
1724af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1725af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1726af538404SDmitry 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);
1727eec7e3faSDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1728eec7e3faSDmitry Karpeev       xleft  = PetscMax(xstart - overlap,0);
1729eec7e3faSDmitry Karpeev       xright = PetscMin(xstart + maxwidth + overlap,M);
1730af538404SDmitry Karpeev       /*
1731af538404SDmitry Karpeev          Determine whether this subdomain intersects this processor's ownership range of pc->pmat.
1732af538404SDmitry Karpeev       */
1733c3518bceSDmitry Karpeev       PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
17342fa5cd67SKarl Rupp       if (nidx) ++s;
1735af538404SDmitry Karpeev       xstart += maxwidth;
1736af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
1737af538404SDmitry Karpeev     ystart += maxheight;
1738af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
17392fa5cd67SKarl Rupp 
1740af538404SDmitry Karpeev   /* Now we can allocate the necessary number of ISs. */
1741af538404SDmitry Karpeev   *nsub  = s;
1742854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is);CHKERRQ(ierr);
1743854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is_local);CHKERRQ(ierr);
1744af538404SDmitry Karpeev   s      = 0;
1745af538404SDmitry Karpeev   ystart = 0;
1746af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1747af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1748af538404SDmitry 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);
1749af538404SDmitry Karpeev     /* Vertical domain limits with an overlap. */
1750eec7e3faSDmitry Karpeev     y[0][0] = PetscMax(ystart - overlap,0);
1751eec7e3faSDmitry Karpeev     y[0][1] = PetscMin(ystart + maxheight + overlap,N);
1752eec7e3faSDmitry Karpeev     /* Vertical domain limits without an overlap. */
1753eec7e3faSDmitry Karpeev     y[1][0] = ystart;
1754eec7e3faSDmitry Karpeev     y[1][1] = PetscMin(ystart + maxheight,N);
1755eec7e3faSDmitry Karpeev     xstart  = 0;
1756af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1757af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1758af538404SDmitry 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);
1759af538404SDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1760eec7e3faSDmitry Karpeev       x[0][0] = PetscMax(xstart - overlap,0);
1761eec7e3faSDmitry Karpeev       x[0][1] = PetscMin(xstart + maxwidth + overlap,M);
1762eec7e3faSDmitry Karpeev       /* Horizontal domain limits without an overlap. */
1763eec7e3faSDmitry Karpeev       x[1][0] = xstart;
1764eec7e3faSDmitry Karpeev       x[1][1] = PetscMin(xstart+maxwidth,M);
17652bbb417fSDmitry Karpeev       /*
17662bbb417fSDmitry Karpeev          Determine whether this domain intersects this processor's ownership range of pc->pmat.
17672bbb417fSDmitry Karpeev          Do this twice: first for the domains with overlaps, and once without.
17682bbb417fSDmitry Karpeev          During the first pass create the subcommunicators, and use them on the second pass as well.
17692bbb417fSDmitry Karpeev       */
17702bbb417fSDmitry Karpeev       for (q = 0; q < 2; ++q) {
1771cc96b2e5SBarry Smith         PetscBool split = PETSC_FALSE;
17722bbb417fSDmitry Karpeev         /*
17732bbb417fSDmitry Karpeev           domain limits, (xleft, xright) and (ylow, yheigh) are adjusted
17742bbb417fSDmitry Karpeev           according to whether the domain with an overlap or without is considered.
17752bbb417fSDmitry Karpeev         */
17762bbb417fSDmitry Karpeev         xleft = x[q][0]; xright = x[q][1];
17772bbb417fSDmitry Karpeev         ylow  = y[q][0]; yhigh  = y[q][1];
1778c3518bceSDmitry Karpeev         PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
1779af538404SDmitry Karpeev         nidx *= dof;
1780eec7e3faSDmitry Karpeev         n[q]  = nidx;
17812bbb417fSDmitry Karpeev         /*
1782eec7e3faSDmitry Karpeev          Based on the counted number of indices in the local domain *with an overlap*,
1783af538404SDmitry Karpeev          construct a subcommunicator of all the processors supporting this domain.
1784eec7e3faSDmitry Karpeev          Observe that a domain with an overlap might have nontrivial local support,
1785eec7e3faSDmitry Karpeev          while the domain without an overlap might not.  Hence, the decision to participate
1786eec7e3faSDmitry Karpeev          in the subcommunicator must be based on the domain with an overlap.
17872bbb417fSDmitry Karpeev          */
17882bbb417fSDmitry Karpeev         if (q == 0) {
17892fa5cd67SKarl Rupp           if (nidx) color = 1;
17902fa5cd67SKarl Rupp           else color = MPI_UNDEFINED;
17912bbb417fSDmitry Karpeev           ierr = MPI_Comm_split(comm, color, rank, &subcomm);CHKERRQ(ierr);
1792cc96b2e5SBarry Smith           split = PETSC_TRUE;
17932bbb417fSDmitry Karpeev         }
1794af538404SDmitry Karpeev         /*
1795eec7e3faSDmitry Karpeev          Proceed only if the number of local indices *with an overlap* is nonzero.
1796af538404SDmitry Karpeev          */
1797eec7e3faSDmitry Karpeev         if (n[0]) {
17982fa5cd67SKarl Rupp           if (q == 0) xis = is;
1799af538404SDmitry Karpeev           if (q == 1) {
1800af538404SDmitry Karpeev             /*
1801eec7e3faSDmitry Karpeev              The IS for the no-overlap subdomain shares a communicator with the overlapping domain.
1802af538404SDmitry Karpeev              Moreover, if the overlap is zero, the two ISs are identical.
1803af538404SDmitry Karpeev              */
1804b1a0a8a3SJed Brown             if (overlap == 0) {
1805eec7e3faSDmitry Karpeev               (*is_local)[s] = (*is)[s];
18062bbb417fSDmitry Karpeev               ierr           = PetscObjectReference((PetscObject)(*is)[s]);CHKERRQ(ierr);
18072bbb417fSDmitry Karpeev               continue;
1808d34fcf5fSBarry Smith             } else {
18096a4f0f73SDmitry Karpeev               xis     = is_local;
1810eec7e3faSDmitry Karpeev               subcomm = ((PetscObject)(*is)[s])->comm;
18112bbb417fSDmitry Karpeev             }
1812af538404SDmitry Karpeev           } /* if (q == 1) */
18130298fd71SBarry Smith           idx  = NULL;
1814785e854fSJed Brown           ierr = PetscMalloc1(nidx,&idx);CHKERRQ(ierr);
1815eec7e3faSDmitry Karpeev           if (nidx) {
18162bbb417fSDmitry Karpeev             k = 0;
18172bbb417fSDmitry Karpeev             for (jj=ylow_loc; jj<yhigh_loc; ++jj) {
1818af538404SDmitry Karpeev               PetscInt x0 = (jj==ylow_loc) ? xleft_loc : xleft;
1819af538404SDmitry Karpeev               PetscInt x1 = (jj==yhigh_loc-1) ? xright_loc : xright;
1820af538404SDmitry Karpeev               kk = dof*(M*jj + x0);
18212bbb417fSDmitry Karpeev               for (ii=x0; ii<x1; ++ii) {
18222bbb417fSDmitry Karpeev                 for (d = 0; d < dof; ++d) {
18232bbb417fSDmitry Karpeev                   idx[k++] = kk++;
1824b1a0a8a3SJed Brown                 }
1825b1a0a8a3SJed Brown               }
1826b1a0a8a3SJed Brown             }
1827eec7e3faSDmitry Karpeev           }
18286a4f0f73SDmitry Karpeev           ierr = ISCreateGeneral(subcomm,nidx,idx,PETSC_OWN_POINTER,(*xis)+s);CHKERRQ(ierr);
1829cc96b2e5SBarry Smith           if (split) {
1830cc96b2e5SBarry Smith             ierr = MPI_Comm_free(&subcomm);CHKERRQ(ierr);
1831cc96b2e5SBarry Smith           }
1832eec7e3faSDmitry Karpeev         }/* if (n[0]) */
18332bbb417fSDmitry Karpeev       }/* for (q = 0; q < 2; ++q) */
18342fa5cd67SKarl Rupp       if (n[0]) ++s;
1835af538404SDmitry Karpeev       xstart += maxwidth;
1836af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
18372bbb417fSDmitry Karpeev     ystart += maxheight;
1838af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
1839b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1840b1a0a8a3SJed Brown }
1841b1a0a8a3SJed Brown 
1842b1a0a8a3SJed Brown #undef __FUNCT__
184306b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMGetSubdomains"
1844b1a0a8a3SJed Brown /*@C
184506b43e7eSDmitry Karpeev     PCGASMGetSubdomains - Gets the subdomains supported on this processor
184606b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1847b1a0a8a3SJed Brown 
1848b1a0a8a3SJed Brown     Not Collective
1849b1a0a8a3SJed Brown 
1850b1a0a8a3SJed Brown     Input Parameter:
1851b1a0a8a3SJed Brown .   pc - the preconditioner context
1852b1a0a8a3SJed Brown 
1853b1a0a8a3SJed Brown     Output Parameters:
1854b1a0a8a3SJed Brown +   n   - the number of subdomains for this processor (default value = 1)
18550298fd71SBarry Smith .   iis - the index sets that define the inner subdomains (without overlap) supported on this processor (can be NULL)
18560298fd71SBarry Smith -   ois - the index sets that define the outer subdomains (with overlap) supported on this processor (can be NULL)
1857b1a0a8a3SJed Brown 
1858b1a0a8a3SJed Brown 
1859b1a0a8a3SJed Brown     Notes:
18606a4f0f73SDmitry Karpeev     The user is responsible for destroying the ISs and freeing the returned arrays.
1861b1a0a8a3SJed Brown     The IS numbering is in the parallel, global numbering of the vector.
1862b1a0a8a3SJed Brown 
1863b1a0a8a3SJed Brown     Level: advanced
1864b1a0a8a3SJed Brown 
186506b43e7eSDmitry Karpeev .keywords: PC, GASM, get, subdomains, additive Schwarz
1866b1a0a8a3SJed Brown 
18678f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(), PCGASMCreateSubdomains2D(),
18688f3b4b4dSDmitry Karpeev           PCGASMSetSubdomains(), PCGASMGetSubmatrices()
1869b1a0a8a3SJed Brown @*/
18706a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMGetSubdomains(PC pc,PetscInt *n,IS *iis[],IS *ois[])
1871b1a0a8a3SJed Brown {
1872f746d493SDmitry Karpeev   PC_GASM        *osm;
1873b1a0a8a3SJed Brown   PetscErrorCode ierr;
1874b1a0a8a3SJed Brown   PetscBool      match;
18756a4f0f73SDmitry Karpeev   PetscInt       i;
18765fd66863SKarl Rupp 
1877b1a0a8a3SJed Brown   PetscFunctionBegin;
1878b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1879251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1880ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Incorrect object type: expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1881f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1882ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
18836a4f0f73SDmitry Karpeev   if (iis) {
1884785e854fSJed Brown     ierr = PetscMalloc1(osm->n, iis);CHKERRQ(ierr);
18856a4f0f73SDmitry Karpeev   }
18866a4f0f73SDmitry Karpeev   if (ois) {
1887785e854fSJed Brown     ierr = PetscMalloc1(osm->n, ois);CHKERRQ(ierr);
18886a4f0f73SDmitry Karpeev   }
18896a4f0f73SDmitry Karpeev   if (iis || ois) {
18906a4f0f73SDmitry Karpeev     for (i = 0; i < osm->n; ++i) {
18916a4f0f73SDmitry Karpeev       if (iis) (*iis)[i] = osm->iis[i];
18926a4f0f73SDmitry Karpeev       if (ois) (*ois)[i] = osm->ois[i];
18936a4f0f73SDmitry Karpeev     }
1894b1a0a8a3SJed Brown   }
1895b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1896b1a0a8a3SJed Brown }
1897b1a0a8a3SJed Brown 
1898b1a0a8a3SJed Brown #undef __FUNCT__
189906b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMGetSubmatrices"
1900b1a0a8a3SJed Brown /*@C
190106b43e7eSDmitry Karpeev     PCGASMGetSubmatrices - Gets the local submatrices (for this processor
1902b1a0a8a3SJed Brown     only) for the additive Schwarz preconditioner.
1903b1a0a8a3SJed Brown 
1904b1a0a8a3SJed Brown     Not Collective
1905b1a0a8a3SJed Brown 
1906b1a0a8a3SJed Brown     Input Parameter:
1907b1a0a8a3SJed Brown .   pc - the preconditioner context
1908b1a0a8a3SJed Brown 
1909b1a0a8a3SJed Brown     Output Parameters:
1910b1a0a8a3SJed Brown +   n   - the number of matrices for this processor (default value = 1)
1911b1a0a8a3SJed Brown -   mat - the matrices
1912b1a0a8a3SJed Brown 
191306b43e7eSDmitry Karpeev     Notes: matrices returned by this routine have the same communicators as the index sets (IS)
19148f3b4b4dSDmitry Karpeev            used to define subdomains in PCGASMSetSubdomains()
1915b1a0a8a3SJed Brown     Level: advanced
1916b1a0a8a3SJed Brown 
1917f746d493SDmitry Karpeev .keywords: PC, GASM, set, local, subdomains, additive Schwarz, block Jacobi
1918b1a0a8a3SJed Brown 
19198f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(),
192006b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMSetSubdomains(), PCGASMGetSubdomains()
1921b1a0a8a3SJed Brown @*/
192206b43e7eSDmitry Karpeev PetscErrorCode  PCGASMGetSubmatrices(PC pc,PetscInt *n,Mat *mat[])
1923b1a0a8a3SJed Brown {
1924f746d493SDmitry Karpeev   PC_GASM        *osm;
1925b1a0a8a3SJed Brown   PetscErrorCode ierr;
1926b1a0a8a3SJed Brown   PetscBool      match;
1927b1a0a8a3SJed Brown 
1928b1a0a8a3SJed Brown   PetscFunctionBegin;
1929b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1930b1a0a8a3SJed Brown   PetscValidIntPointer(n,2);
1931b1a0a8a3SJed Brown   if (mat) PetscValidPointer(mat,3);
1932ce94432eSBarry Smith   if (!pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call after KSPSetUP() or PCSetUp().");
1933251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1934ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1935f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1936ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
1937b1a0a8a3SJed Brown   if (mat) *mat = osm->pmat;
1938b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1939b1a0a8a3SJed Brown }
1940d709ea83SDmitry Karpeev 
1941d709ea83SDmitry Karpeev #undef __FUNCT__
19428f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMSetUseDMSubdomains"
1943d709ea83SDmitry Karpeev /*@
19448f3b4b4dSDmitry Karpeev     PCGASMSetUseDMSubdomains - Indicates whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1945d709ea83SDmitry Karpeev     Logically Collective
1946d709ea83SDmitry Karpeev 
1947d709ea83SDmitry Karpeev     Input Parameter:
1948d709ea83SDmitry Karpeev +   pc  - the preconditioner
1949d709ea83SDmitry Karpeev -   flg - boolean indicating whether to use subdomains defined by the DM
1950d709ea83SDmitry Karpeev 
1951d709ea83SDmitry Karpeev     Options Database Key:
19528f3b4b4dSDmitry Karpeev .   -pc_gasm_dm_subdomains -pc_gasm_overlap -pc_gasm_total_subdomains
1953d709ea83SDmitry Karpeev 
1954d709ea83SDmitry Karpeev     Level: intermediate
1955d709ea83SDmitry Karpeev 
1956d709ea83SDmitry Karpeev     Notes:
19578f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), PCGASMSetTotalSubdomains() or PCGASMSetOverlap() take precedence over PCGASMSetUseDMSubdomains(),
19588f3b4b4dSDmitry Karpeev     so setting PCGASMSetSubdomains() with nontrivial subdomain ISs or any of PCGASMSetTotalSubdomains() and PCGASMSetOverlap()
19598f3b4b4dSDmitry Karpeev     automatically turns the latter off.
1960d709ea83SDmitry Karpeev 
1961d709ea83SDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
1962d709ea83SDmitry Karpeev 
19638f3b4b4dSDmitry Karpeev .seealso: PCGASMGetUseDMSubdomains(), PCGASMSetSubdomains(), PCGASMSetOverlap()
1964d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
1965d709ea83SDmitry Karpeev @*/
19668f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetUseDMSubdomains(PC pc,PetscBool flg)
1967d709ea83SDmitry Karpeev {
1968d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1969d709ea83SDmitry Karpeev   PetscErrorCode ierr;
1970d709ea83SDmitry Karpeev   PetscBool      match;
1971d709ea83SDmitry Karpeev 
1972d709ea83SDmitry Karpeev   PetscFunctionBegin;
1973d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1974d709ea83SDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
1975d709ea83SDmitry Karpeev   if (pc->setupcalled) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Not for a setup PC.");
1976d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1977d709ea83SDmitry Karpeev   if (match) {
19788f3b4b4dSDmitry Karpeev     if (!osm->user_subdomains && osm->N == PETSC_DETERMINE && osm->overlap < 0) {
1979d709ea83SDmitry Karpeev       osm->dm_subdomains = flg;
1980d709ea83SDmitry Karpeev     }
19818f3b4b4dSDmitry Karpeev   }
1982d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
1983d709ea83SDmitry Karpeev }
1984d709ea83SDmitry Karpeev 
1985d709ea83SDmitry Karpeev #undef __FUNCT__
19868f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMGetUseDMSubdomains"
1987d709ea83SDmitry Karpeev /*@
19888f3b4b4dSDmitry Karpeev     PCGASMGetUseDMSubdomains - Returns flag indicating whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1989d709ea83SDmitry Karpeev     Not Collective
1990d709ea83SDmitry Karpeev 
1991d709ea83SDmitry Karpeev     Input Parameter:
1992d709ea83SDmitry Karpeev .   pc  - the preconditioner
1993d709ea83SDmitry Karpeev 
1994d709ea83SDmitry Karpeev     Output Parameter:
1995d709ea83SDmitry Karpeev .   flg - boolean indicating whether to use subdomains defined by the DM
1996d709ea83SDmitry Karpeev 
1997d709ea83SDmitry Karpeev     Level: intermediate
1998d709ea83SDmitry Karpeev 
1999d709ea83SDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
2000d709ea83SDmitry Karpeev 
20018f3b4b4dSDmitry Karpeev .seealso: PCGASMSetUseDMSubdomains(), PCGASMSetOverlap()
2002d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
2003d709ea83SDmitry Karpeev @*/
20048f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMGetUseDMSubdomains(PC pc,PetscBool* flg)
2005d709ea83SDmitry Karpeev {
2006d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
2007d709ea83SDmitry Karpeev   PetscErrorCode ierr;
2008d709ea83SDmitry Karpeev   PetscBool      match;
2009d709ea83SDmitry Karpeev 
2010d709ea83SDmitry Karpeev   PetscFunctionBegin;
2011d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2012d709ea83SDmitry Karpeev   PetscValidPointer(flg,2);
2013d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
2014d709ea83SDmitry Karpeev   if (match) {
2015d709ea83SDmitry Karpeev     if (flg) *flg = osm->dm_subdomains;
2016d709ea83SDmitry Karpeev   }
2017d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
2018d709ea83SDmitry Karpeev }
2019