xref: /petsc/src/ksp/pc/impls/gasm/gasm.c (revision c56a70eef2ab668538752a5e77050a8eabd3308a)
1b1a0a8a3SJed Brown /*
2f746d493SDmitry Karpeev   This file defines an "generalized" additive Schwarz preconditioner for any Mat implementation.
36a4f0f73SDmitry Karpeev   In this version each processor may intersect multiple subdomains and any subdomain may
46a4f0f73SDmitry Karpeev   intersect multiple processors.  Intersections of subdomains with processors are called *local
56a4f0f73SDmitry Karpeev   subdomains*.
6b1a0a8a3SJed Brown 
78f3b4b4dSDmitry Karpeev        N    - total number of distinct global subdomains          (set explicitly in PCGASMSetTotalSubdomains() or implicitly PCGASMSetSubdomains() and then calculated in PCSetUp_GASM())
86a4f0f73SDmitry Karpeev        n    - actual number of local subdomains on this processor (set in PCGASMSetSubdomains() or calculated in PCGASMSetTotalSubdomains())
98f3b4b4dSDmitry Karpeev        nmax - maximum number of local subdomains per processor    (calculated in PCSetUp_GASM())
10b1a0a8a3SJed Brown */
11af0996ceSBarry Smith #include <petsc/private/pcimpl.h>     /*I "petscpc.h" I*/
121e25c274SJed Brown #include <petscdm.h>
13b1a0a8a3SJed Brown 
14b1a0a8a3SJed Brown typedef struct {
15f746d493SDmitry Karpeev   PetscInt    N,n,nmax;
16b1a0a8a3SJed Brown   PetscInt    overlap;                  /* overlap requested by user */
178f3b4b4dSDmitry Karpeev   PCGASMType  type;                     /* use reduced interpolation, restriction or both */
188f3b4b4dSDmitry Karpeev   PetscBool   type_set;                 /* if user set this value (so won't change it for symmetric problems) */
198f3b4b4dSDmitry Karpeev   PetscBool   same_subdomain_solvers;   /* flag indicating whether all local solvers are same */
208f3b4b4dSDmitry Karpeev   PetscBool   sort_indices;             /* flag to sort subdomain indices */
218f3b4b4dSDmitry Karpeev   PetscBool   user_subdomains;          /* whether the user set explicit subdomain index sets -- keep them on PCReset() */
228f3b4b4dSDmitry Karpeev   PetscBool   dm_subdomains;            /* whether DM is allowed to define subdomains */
23ea91fabdSFande Kong   PetscBool   hierarchicalpartitioning;
248f3b4b4dSDmitry Karpeev   IS          *ois;                     /* index sets that define the outer (conceptually, overlapping) subdomains */
258f3b4b4dSDmitry Karpeev   IS          *iis;                     /* index sets that define the inner (conceptually, nonoverlapping) subdomains */
268f3b4b4dSDmitry Karpeev   KSP         *ksp;                     /* linear solvers for each subdomain */
278f3b4b4dSDmitry Karpeev   Mat         *pmat;                    /* subdomain block matrices */
28f746d493SDmitry Karpeev   Vec         gx,gy;                    /* Merged work vectors */
29f746d493SDmitry Karpeev   Vec         *x,*y;                    /* Split work vectors; storage aliases pieces of storage of the above merged vectors. */
306a4f0f73SDmitry Karpeev   VecScatter  gorestriction;            /* merged restriction to disjoint union of outer subdomains */
316a4f0f73SDmitry Karpeev   VecScatter  girestriction;            /* merged restriction to disjoint union of inner subdomains */
32ea91fabdSFande Kong   VecScatter  pctoouter;
33ea91fabdSFande Kong   IS          permutationIS;
34ea91fabdSFande Kong   Mat         permutationP;
35ea91fabdSFande Kong   Mat         pcmat;
36ea91fabdSFande Kong   Vec         pcx,pcy;
37f746d493SDmitry Karpeev } PC_GASM;
38b1a0a8a3SJed Brown 
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;
138c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,prefix,"-pc_gasm_print_subdomains",&doprint,NULL);CHKERRQ(ierr);
1398f3b4b4dSDmitry Karpeev   if (!doprint) PetscFunctionReturn(0);
140c5929fdfSBarry Smith   ierr = PetscOptionsGetString(NULL,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);
201c5929fdfSBarry Smith   ierr = PetscOptionsGetBool(NULL,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 
266ea91fabdSFande Kong 
267ea91fabdSFande Kong #undef __FUNCT__
268ea91fabdSFande Kong #define __FUNCT__ "PCGASMSetHierarchicalPartitioning"
269ea91fabdSFande Kong 
270ea91fabdSFande Kong PetscErrorCode PCGASMSetHierarchicalPartitioning(PC pc)
271ea91fabdSFande Kong {
272ea91fabdSFande Kong    PC_GASM              *osm = (PC_GASM*)pc->data;
273ea91fabdSFande Kong    MatPartitioning       part;
274ea91fabdSFande Kong    MPI_Comm              comm;
275ea91fabdSFande Kong    PetscMPIInt           size;
276ea91fabdSFande Kong    PetscInt              nlocalsubdomains,fromrows_localsize;
277ea91fabdSFande Kong    IS                    partitioning,fromrows,isn;
278ea91fabdSFande Kong    Vec                   outervec;
279ea91fabdSFande Kong    PetscErrorCode        ierr;
280ea91fabdSFande Kong 
281ea91fabdSFande Kong    PetscFunctionBegin;
282ea91fabdSFande Kong    ierr = PetscObjectGetComm((PetscObject)pc,&comm);CHKERRQ(ierr);
283ea91fabdSFande Kong    ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
284ea91fabdSFande Kong    /* we do not need a hierarchical partitioning when
285ea91fabdSFande Kong     * the total number of subdomains is consistent with
286ea91fabdSFande Kong     * the number of MPI tasks.
287ea91fabdSFande Kong     * For the following cases, we do not need to use HP
288ea91fabdSFande Kong     * */
289670417b2SFande Kong    if(osm->N==PETSC_DETERMINE || osm->N>=size || osm->N==1) PetscFunctionReturn(0);
290670417b2SFande Kong    if(size%osm->N != 0) SETERRQ2(PETSC_COMM_WORLD,PETSC_ERR_ARG_INCOMP,"have to specify the total number of subdomains %D to be a factor of the number of processors %d \n",osm->N,size);
291ea91fabdSFande Kong    nlocalsubdomains = size/osm->N;
292ea91fabdSFande Kong    osm->n           = 1;
293ea91fabdSFande Kong    ierr = MatPartitioningCreate(comm,&part);CHKERRQ(ierr);
294ea91fabdSFande Kong    ierr = MatPartitioningSetAdjacency(part,pc->pmat);CHKERRQ(ierr);
295ea91fabdSFande Kong    ierr = MatPartitioningSetType(part,MATPARTITIONINGHIERARCH);CHKERRQ(ierr);
296ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNcoarseparts(part,osm->N);CHKERRQ(ierr);
297ea91fabdSFande Kong    ierr = MatPartitioningHierarchicalSetNfineparts(part,nlocalsubdomains);CHKERRQ(ierr);
298ea91fabdSFande Kong    ierr = MatPartitioningSetFromOptions(part);CHKERRQ(ierr);
299ea91fabdSFande Kong    /* get new processor owner number of each vertex */
300ea91fabdSFande Kong    ierr = MatPartitioningApply(part,&partitioning);CHKERRQ(ierr);
301ea91fabdSFande Kong    ierr = ISBuildTwoSided(partitioning,NULL,&fromrows);CHKERRQ(ierr);
302ea91fabdSFande Kong    ierr = ISPartitioningToNumbering(partitioning,&isn);CHKERRQ(ierr);
303ea91fabdSFande Kong    ierr = ISDestroy(&isn);CHKERRQ(ierr);
304ea91fabdSFande Kong    ierr = ISGetLocalSize(fromrows,&fromrows_localsize);CHKERRQ(ierr);
305ea91fabdSFande Kong    ierr = MatPartitioningDestroy(&part);CHKERRQ(ierr);
306ea91fabdSFande Kong    ierr = MatCreateVecs(pc->pmat,&outervec,NULL);CHKERRQ(ierr);
307ea91fabdSFande Kong    ierr = VecCreateMPI(comm,fromrows_localsize,PETSC_DETERMINE,&(osm->pcx));CHKERRQ(ierr);
308ea91fabdSFande Kong    ierr = VecDuplicate(osm->pcx,&(osm->pcy));CHKERRQ(ierr);
309ea91fabdSFande Kong    ierr = VecScatterCreate(osm->pcx,NULL,outervec,fromrows,&(osm->pctoouter));CHKERRQ(ierr);
310ea91fabdSFande Kong    ierr = MatGetSubMatrix(pc->pmat,fromrows,fromrows,MAT_INITIAL_MATRIX,&(osm->permutationP));CHKERRQ(ierr);
311ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)fromrows);CHKERRQ(ierr);
312ea91fabdSFande Kong    osm->permutationIS = fromrows;
313ea91fabdSFande Kong    osm->pcmat =  pc->pmat;
314ea91fabdSFande Kong    ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
315ea91fabdSFande Kong    pc->pmat = osm->permutationP;
316ea91fabdSFande Kong    ierr = VecDestroy(&outervec);CHKERRQ(ierr);
317ea91fabdSFande Kong    ierr = ISDestroy(&fromrows);CHKERRQ(ierr);
318ea91fabdSFande Kong    ierr = ISDestroy(&partitioning);CHKERRQ(ierr);
319ea91fabdSFande Kong    osm->n           = PETSC_DETERMINE;
320ea91fabdSFande Kong    PetscFunctionReturn(0);
321ea91fabdSFande Kong }
322ea91fabdSFande Kong 
323ea91fabdSFande Kong 
324ea91fabdSFande Kong 
325b1a0a8a3SJed Brown #undef __FUNCT__
326f746d493SDmitry Karpeev #define __FUNCT__ "PCSetUp_GASM"
327f746d493SDmitry Karpeev static PetscErrorCode PCSetUp_GASM(PC pc)
328b1a0a8a3SJed Brown {
329f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
330b1a0a8a3SJed Brown   PetscErrorCode ierr;
331b1a0a8a3SJed Brown   PetscBool      symset,flg;
332ea91fabdSFande Kong   PetscInt       i,nInnerIndices,nTotalInnerIndices;
333c10bc1a1SDmitry Karpeev   PetscMPIInt    rank, size;
334b1a0a8a3SJed Brown   MatReuse       scall = MAT_REUSE_MATRIX;
335b1a0a8a3SJed Brown   KSP            ksp;
336b1a0a8a3SJed Brown   PC             subpc;
337b1a0a8a3SJed Brown   const char     *prefix,*pprefix;
338f746d493SDmitry Karpeev   Vec            x,y;
3396a4f0f73SDmitry Karpeev   PetscInt       oni;       /* Number of indices in the i-th local outer subdomain.               */
3406a4f0f73SDmitry Karpeev   const PetscInt *oidxi;    /* Indices from the i-th subdomain local outer subdomain.             */
3416a4f0f73SDmitry Karpeev   PetscInt       on;        /* Number of indices in the disjoint union of local outer subdomains. */
3426a4f0f73SDmitry Karpeev   PetscInt       *oidx;     /* Indices in the disjoint union of local outer subdomains. */
3436a4f0f73SDmitry Karpeev   IS             gois;      /* Disjoint union the global indices of outer subdomains.             */
3446a4f0f73SDmitry Karpeev   IS             goid;      /* Identity IS of the size of the disjoint union of outer subdomains. */
345f746d493SDmitry Karpeev   PetscScalar    *gxarray, *gyarray;
346930d09c1SFande Kong   PetscInt       gostart;   /* Start of locally-owned indices in the vectors -- osm->gx,osm->gy -- over the disjoint union of outer subdomains. */
3478f3b4b4dSDmitry Karpeev   PetscInt       num_subdomains    = 0;
3480298fd71SBarry Smith   DM             *subdomain_dm     = NULL;
3498f3b4b4dSDmitry Karpeev   char           **subdomain_names = NULL;
350f771a274SFande Kong   PetscInt       *numbering;
3518f3b4b4dSDmitry Karpeev 
352b1a0a8a3SJed Brown 
353b1a0a8a3SJed Brown   PetscFunctionBegin;
354ce94432eSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
355ce94432eSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
356b1a0a8a3SJed Brown   if (!pc->setupcalled) {
357ea91fabdSFande Kong 	/* use a hierarchical partitioning */
358ea91fabdSFande Kong     if(osm->hierarchicalpartitioning){
359ea91fabdSFande Kong       ierr = PCGASMSetHierarchicalPartitioning(pc);CHKERRQ(ierr);
360ea91fabdSFande Kong     }
361b1a0a8a3SJed Brown     if (!osm->type_set) {
362b1a0a8a3SJed Brown       ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
3632fa5cd67SKarl Rupp       if (symset && flg) osm->type = PC_GASM_BASIC;
364b1a0a8a3SJed Brown     }
365b1a0a8a3SJed Brown 
3668f3b4b4dSDmitry Karpeev     if (osm->n == PETSC_DETERMINE) {
3678f3b4b4dSDmitry Karpeev       if (osm->N != PETSC_DETERMINE) {
3688f3b4b4dSDmitry Karpeev 	   /* No local subdomains given, but the desired number of total subdomains is known, so construct them accordingly. */
3698f3b4b4dSDmitry Karpeev 	   ierr = PCGASMCreateSubdomains(pc->pmat,osm->N,&osm->n,&osm->iis);CHKERRQ(ierr);
3708f3b4b4dSDmitry Karpeev       } else if (osm->dm_subdomains && pc->dm) {
3718f3b4b4dSDmitry Karpeev 	/* try pc->dm next, if allowed */
3728f3b4b4dSDmitry Karpeev 	PetscInt  d;
373a35b7b57SDmitry Karpeev 	IS       *inner_subdomain_is, *outer_subdomain_is;
374a35b7b57SDmitry Karpeev 	ierr = DMCreateDomainDecomposition(pc->dm, &num_subdomains, &subdomain_names, &inner_subdomain_is, &outer_subdomain_is, &subdomain_dm);CHKERRQ(ierr);
375a35b7b57SDmitry Karpeev 	if (num_subdomains) {
376a35b7b57SDmitry Karpeev 	  ierr = PCGASMSetSubdomains(pc, num_subdomains, inner_subdomain_is, outer_subdomain_is);CHKERRQ(ierr);
37769ca1f37SDmitry Karpeev 	}
378a35b7b57SDmitry Karpeev 	for (d = 0; d < num_subdomains; ++d) {
379a35b7b57SDmitry Karpeev 	  if (inner_subdomain_is) {ierr = ISDestroy(&inner_subdomain_is[d]);CHKERRQ(ierr);}
380a35b7b57SDmitry Karpeev 	  if (outer_subdomain_is) {ierr = ISDestroy(&outer_subdomain_is[d]);CHKERRQ(ierr);}
381fdc48646SDmitry Karpeev 	}
382a35b7b57SDmitry Karpeev 	ierr = PetscFree(inner_subdomain_is);CHKERRQ(ierr);
383a35b7b57SDmitry Karpeev 	ierr = PetscFree(outer_subdomain_is);CHKERRQ(ierr);
3848f3b4b4dSDmitry Karpeev       } else {
3858f3b4b4dSDmitry Karpeev 	/* still no subdomains; use one per processor */
38644fe18e5SDmitry Karpeev 	osm->nmax = osm->n = 1;
387ce94432eSBarry Smith 	ierr      = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
388f746d493SDmitry Karpeev 	osm->N    = size;
3898f3b4b4dSDmitry Karpeev 	ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
390fdc48646SDmitry Karpeev       }
39106b43e7eSDmitry Karpeev     }
392a35b7b57SDmitry Karpeev     if (!osm->iis) {
393a35b7b57SDmitry Karpeev       /*
3948f3b4b4dSDmitry Karpeev        osm->n was set in PCGASMSetSubdomains(), but the actual subdomains have not been supplied.
3958f3b4b4dSDmitry Karpeev        We create the requisite number of local inner subdomains and then expand them into
3968f3b4b4dSDmitry Karpeev        out subdomains, if necessary.
397a35b7b57SDmitry Karpeev        */
3988f3b4b4dSDmitry Karpeev       ierr = PCGASMCreateLocalSubdomains(pc->pmat,osm->n,&osm->iis);CHKERRQ(ierr);
399a35b7b57SDmitry Karpeev     }
4008f3b4b4dSDmitry Karpeev     if (!osm->ois) {
4018f3b4b4dSDmitry Karpeev       /*
4028f3b4b4dSDmitry Karpeev 	    Initially make outer subdomains the same as inner subdomains. If nonzero additional overlap
4038f3b4b4dSDmitry Karpeev 	    has been requested, copy the inner subdomains over so they can be modified.
4048f3b4b4dSDmitry Karpeev       */
4058f3b4b4dSDmitry Karpeev       ierr = PetscMalloc1(osm->n,&osm->ois);CHKERRQ(ierr);
4068f3b4b4dSDmitry Karpeev       for (i=0; i<osm->n; ++i) {
407ea91fabdSFande Kong 	if (osm->overlap > 0 && osm->N>1) { /* With positive overlap, osm->iis[i] will be modified */
4088f3b4b4dSDmitry Karpeev 	  ierr = ISDuplicate(osm->iis[i],(osm->ois)+i);CHKERRQ(ierr);
4098f3b4b4dSDmitry Karpeev 	  ierr = ISCopy(osm->iis[i],osm->ois[i]);CHKERRQ(ierr);
4108f3b4b4dSDmitry Karpeev 	} else {
4118f3b4b4dSDmitry Karpeev 	  ierr      = PetscObjectReference((PetscObject)((osm->iis)[i]));CHKERRQ(ierr);
4128f3b4b4dSDmitry Karpeev 	  osm->ois[i] = osm->iis[i];
4138f3b4b4dSDmitry Karpeev 	}
4148f3b4b4dSDmitry Karpeev       }
415ea91fabdSFande Kong       if (osm->overlap>0 && osm->N>1) {
4168f3b4b4dSDmitry Karpeev 	   /* Extend the "overlapping" regions by a number of steps */
417d21f2a47SFande Kong 	   ierr = MatIncreaseOverlapSplit(pc->pmat,osm->n,osm->ois,osm->overlap);CHKERRQ(ierr);
4188f3b4b4dSDmitry Karpeev       }
419b1a0a8a3SJed Brown     }
4206a4f0f73SDmitry Karpeev 
4218f3b4b4dSDmitry Karpeev     /* Now the subdomains are defined.  Determine their global and max local numbers, if necessary. */
4228f3b4b4dSDmitry Karpeev     if (osm->nmax == PETSC_DETERMINE) {
4238f3b4b4dSDmitry Karpeev       PetscMPIInt inwork,outwork;
4248f3b4b4dSDmitry Karpeev       /* determine global number of subdomains and the max number of local subdomains */
4258f3b4b4dSDmitry Karpeev       inwork = osm->n;
426b2566f29SBarry Smith       ierr       = MPIU_Allreduce(&inwork,&outwork,1,MPI_INT,MPI_MAX,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
4278f3b4b4dSDmitry Karpeev       osm->nmax  = outwork;
4288f3b4b4dSDmitry Karpeev     }
4298f3b4b4dSDmitry Karpeev     if (osm->N == PETSC_DETERMINE) {
4308f3b4b4dSDmitry Karpeev       /* Determine the number of globally-distinct subdomains and compute a global numbering for them. */
4318f3b4b4dSDmitry Karpeev       ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,&osm->N,NULL);CHKERRQ(ierr);
4328f3b4b4dSDmitry Karpeev     }
4338f3b4b4dSDmitry Karpeev 
434b1a0a8a3SJed Brown 
435b1a0a8a3SJed Brown     if (osm->sort_indices) {
436f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4376a4f0f73SDmitry Karpeev         ierr = ISSort(osm->ois[i]);CHKERRQ(ierr);
4386a4f0f73SDmitry Karpeev         ierr = ISSort(osm->iis[i]);CHKERRQ(ierr);
439b1a0a8a3SJed Brown       }
440b1a0a8a3SJed Brown     }
4418f3b4b4dSDmitry Karpeev     ierr = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
4428f3b4b4dSDmitry Karpeev     ierr = PCGASMPrintSubdomains(pc);CHKERRQ(ierr);
4438f3b4b4dSDmitry Karpeev 
4446a4f0f73SDmitry Karpeev     /*
4456a4f0f73SDmitry Karpeev        Merge the ISs, create merged vectors and restrictions.
4466a4f0f73SDmitry Karpeev      */
4476a4f0f73SDmitry Karpeev     /* Merge outer subdomain ISs and construct a restriction onto the disjoint union of local outer subdomains. */
4486a4f0f73SDmitry Karpeev     on = 0;
449f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4506a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4516a4f0f73SDmitry Karpeev       on  += oni;
452f746d493SDmitry Karpeev     }
453785e854fSJed Brown     ierr = PetscMalloc1(on, &oidx);CHKERRQ(ierr);
4546a4f0f73SDmitry Karpeev     on   = 0;
455930d09c1SFande Kong     /* Merge local indices together */
456f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
4576a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4586a4f0f73SDmitry Karpeev       ierr = ISGetIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4596a4f0f73SDmitry Karpeev       ierr = PetscMemcpy(oidx+on,oidxi,sizeof(PetscInt)*oni);CHKERRQ(ierr);
4606a4f0f73SDmitry Karpeev       ierr = ISRestoreIndices(osm->ois[i],&oidxi);CHKERRQ(ierr);
4616a4f0f73SDmitry Karpeev       on  += oni;
462f746d493SDmitry Karpeev     }
4636a4f0f73SDmitry Karpeev     ierr = ISCreateGeneral(((PetscObject)(pc))->comm,on,oidx,PETSC_OWN_POINTER,&gois);CHKERRQ(ierr);
464ea91fabdSFande Kong     nTotalInnerIndices = 0;
465ea91fabdSFande Kong     for(i=0; i<osm->n; i++){
466ea91fabdSFande Kong       ierr = ISGetLocalSize(osm->iis[i],&nInnerIndices);CHKERRQ(ierr);
467ea91fabdSFande Kong       nTotalInnerIndices += nInnerIndices;
468ea91fabdSFande Kong     }
469ea91fabdSFande Kong     ierr = VecCreateMPI(((PetscObject)(pc))->comm,nTotalInnerIndices,PETSC_DETERMINE,&x);CHKERRQ(ierr);
470ea91fabdSFande Kong     ierr = VecDuplicate(x,&y);CHKERRQ(ierr);
471ea91fabdSFande Kong 
472ce94432eSBarry Smith     ierr = VecCreateMPI(PetscObjectComm((PetscObject)pc),on,PETSC_DECIDE,&osm->gx);CHKERRQ(ierr);
473f746d493SDmitry Karpeev     ierr = VecDuplicate(osm->gx,&osm->gy);CHKERRQ(ierr);
474930d09c1SFande Kong     ierr = VecGetOwnershipRange(osm->gx, &gostart, NULL);CHKERRQ(ierr);
475930d09c1SFande Kong     ierr = ISCreateStride(PetscObjectComm((PetscObject)pc),on,gostart,1, &goid);CHKERRQ(ierr);
476930d09c1SFande Kong     /* gois might indices not on local */
4776a4f0f73SDmitry Karpeev     ierr = VecScatterCreate(x,gois,osm->gx,goid, &(osm->gorestriction));CHKERRQ(ierr);
478f771a274SFande Kong     ierr = PetscMalloc1(osm->n,&numbering);CHKERRQ(ierr);
479f771a274SFande Kong     ierr = PetscObjectsListGetGlobalNumbering(PetscObjectComm((PetscObject)pc),osm->n,(PetscObject*)osm->ois,NULL,numbering);CHKERRQ(ierr);
4806a4f0f73SDmitry Karpeev     ierr = VecDestroy(&x);CHKERRQ(ierr);
4817105d80bSDmitry Karpeev     ierr = ISDestroy(&gois);CHKERRQ(ierr);
4822fa5cd67SKarl Rupp 
4836a4f0f73SDmitry Karpeev     /* Merge inner subdomain ISs and construct a restriction onto the disjoint union of local inner subdomains. */
4842fa5cd67SKarl Rupp     {
4852fa5cd67SKarl Rupp       PetscInt        ini;           /* Number of indices the i-th a local inner subdomain. */
4866a4f0f73SDmitry Karpeev       PetscInt        in;            /* Number of indices in the disjoint uniont of local inner subdomains. */
4876a4f0f73SDmitry Karpeev       PetscInt       *iidx;          /* Global indices in the merged local inner subdomain. */
4886a4f0f73SDmitry Karpeev       PetscInt       *ioidx;         /* Global indices of the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
4896a4f0f73SDmitry Karpeev       IS              giis;          /* IS for the disjoint union of inner subdomains. */
4906a4f0f73SDmitry Karpeev       IS              giois;         /* IS for the disjoint union of inner subdomains within the disjoint union of outer subdomains. */
491f771a274SFande Kong       PetscScalar    *array;
492f771a274SFande Kong       const PetscInt *indices;
493f771a274SFande Kong       PetscInt        k;
4946a4f0f73SDmitry Karpeev       on = 0;
495f746d493SDmitry Karpeev       for (i=0; i<osm->n; i++) {
4966a4f0f73SDmitry Karpeev         ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
4976a4f0f73SDmitry Karpeev         on  += oni;
498f746d493SDmitry Karpeev       }
499f771a274SFande Kong       ierr = PetscMalloc1(on, &iidx);CHKERRQ(ierr);
500f771a274SFande Kong       ierr = PetscMalloc1(on, &ioidx);CHKERRQ(ierr);
501f771a274SFande Kong       ierr = VecGetArray(y,&array);CHKERRQ(ierr);
502e12b4729SFande Kong       /* set communicator id to determine where overlap is */
503f771a274SFande Kong       in   = 0;
504f771a274SFande Kong       for (i=0; i<osm->n; i++) {
505f771a274SFande Kong         ierr   = ISGetLocalSize(osm->iis[i],&ini);CHKERRQ(ierr);
506f771a274SFande Kong         for (k = 0; k < ini; ++k){
507f771a274SFande Kong           array[in+k] = numbering[i];
508f771a274SFande Kong         }
509f771a274SFande Kong         in += ini;
510f771a274SFande Kong       }
511f771a274SFande Kong       ierr = VecRestoreArray(y,&array);CHKERRQ(ierr);
512f771a274SFande Kong       ierr = VecScatterBegin(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
513f771a274SFande Kong       ierr = VecScatterEnd(osm->gorestriction,y,osm->gy,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
514f771a274SFande Kong       ierr = VecGetOwnershipRange(osm->gy,&gostart, NULL);CHKERRQ(ierr);
515f771a274SFande Kong       ierr = VecGetArray(osm->gy,&array);CHKERRQ(ierr);
516f771a274SFande Kong       on  = 0;
517f771a274SFande Kong       in  = 0;
518f771a274SFande Kong       for (i=0; i<osm->n; i++) {
519f771a274SFande Kong     	ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
520f771a274SFande Kong     	ierr = ISGetIndices(osm->ois[i],&indices);CHKERRQ(ierr);
521f771a274SFande Kong     	for (k=0; k<oni; k++) {
522e12b4729SFande Kong           /*  skip overlapping indices to get inner domain */
52343081b6cSDmitry Karpeev           if(PetscRealPart(array[on+k]) != numbering[i]) continue;
524f771a274SFande Kong           iidx[in]    = indices[k];
525f771a274SFande Kong           ioidx[in++] = gostart+on+k;
526f771a274SFande Kong     	}
527f771a274SFande Kong     	ierr   = ISRestoreIndices(osm->ois[i], &indices);CHKERRQ(ierr);
528f771a274SFande Kong     	on += oni;
529f771a274SFande Kong       }
530f771a274SFande Kong       ierr = VecRestoreArray(osm->gy,&array);CHKERRQ(ierr);
531ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,iidx,PETSC_OWN_POINTER,&giis);CHKERRQ(ierr);
532ce94432eSBarry Smith       ierr = ISCreateGeneral(PetscObjectComm((PetscObject)pc),in,ioidx,PETSC_OWN_POINTER,&giois);CHKERRQ(ierr);
5336a4f0f73SDmitry Karpeev       ierr = VecScatterCreate(y,giis,osm->gy,giois,&osm->girestriction);CHKERRQ(ierr);
5346a4f0f73SDmitry Karpeev       ierr = VecDestroy(&y);CHKERRQ(ierr);
5356a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giis);CHKERRQ(ierr);
5366a4f0f73SDmitry Karpeev       ierr = ISDestroy(&giois);CHKERRQ(ierr);
537b1a0a8a3SJed Brown     }
5386a4f0f73SDmitry Karpeev     ierr = ISDestroy(&goid);CHKERRQ(ierr);
539f771a274SFande Kong     ierr = PetscFree(numbering);CHKERRQ(ierr);
5402fa5cd67SKarl Rupp 
541f746d493SDmitry Karpeev     /* Create the subdomain work vectors. */
542785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->x);CHKERRQ(ierr);
543785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->y);CHKERRQ(ierr);
544f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gx, &gxarray);CHKERRQ(ierr);
545f746d493SDmitry Karpeev     ierr = VecGetArray(osm->gy, &gyarray);CHKERRQ(ierr);
5466a4f0f73SDmitry Karpeev     for (i=0, on=0; i<osm->n; ++i, on += oni) {
5476a4f0f73SDmitry Karpeev       PetscInt oNi;
5486a4f0f73SDmitry Karpeev       ierr = ISGetLocalSize(osm->ois[i],&oni);CHKERRQ(ierr);
549930d09c1SFande Kong       /* on a sub communicator */
5506a4f0f73SDmitry Karpeev       ierr = ISGetSize(osm->ois[i],&oNi);CHKERRQ(ierr);
5516a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gxarray+on,&osm->x[i]);CHKERRQ(ierr);
5526a4f0f73SDmitry Karpeev       ierr = VecCreateMPIWithArray(((PetscObject)(osm->ois[i]))->comm,1,oni,oNi,gyarray+on,&osm->y[i]);CHKERRQ(ierr);
553b1a0a8a3SJed Brown     }
554f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gx, &gxarray);CHKERRQ(ierr);
555f746d493SDmitry Karpeev     ierr = VecRestoreArray(osm->gy, &gyarray);CHKERRQ(ierr);
5568f3b4b4dSDmitry Karpeev     /* Create the subdomain solvers */
557785e854fSJed Brown     ierr = PetscMalloc1(osm->n,&osm->ksp);CHKERRQ(ierr);
5588f3b4b4dSDmitry Karpeev     for (i=0; i<osm->n; i++) {
5598f3b4b4dSDmitry Karpeev       char subprefix[PETSC_MAX_PATH_LEN+1];
5606a4f0f73SDmitry Karpeev       ierr        = KSPCreate(((PetscObject)(osm->ois[i]))->comm,&ksp);CHKERRQ(ierr);
5613bb1ff40SBarry Smith       ierr        = PetscLogObjectParent((PetscObject)pc,(PetscObject)ksp);CHKERRQ(ierr);
562b1a0a8a3SJed Brown       ierr        = PetscObjectIncrementTabLevel((PetscObject)ksp,(PetscObject)pc,1);CHKERRQ(ierr);
563b1a0a8a3SJed Brown       ierr        = KSPSetType(ksp,KSPPREONLY);CHKERRQ(ierr);
5648f3b4b4dSDmitry Karpeev       ierr        = KSPGetPC(ksp,&subpc);CHKERRQ(ierr); /* Why do we need this here? */
5658f3b4b4dSDmitry Karpeev       if (subdomain_dm) {
5668f3b4b4dSDmitry Karpeev 	    ierr = KSPSetDM(ksp,subdomain_dm[i]);CHKERRQ(ierr);
5678f3b4b4dSDmitry Karpeev 	    ierr = DMDestroy(subdomain_dm+i);CHKERRQ(ierr);
5688f3b4b4dSDmitry Karpeev       }
569b1a0a8a3SJed Brown       ierr        = PCGetOptionsPrefix(pc,&prefix);CHKERRQ(ierr);
570b1a0a8a3SJed Brown       ierr        = KSPSetOptionsPrefix(ksp,prefix);CHKERRQ(ierr);
5718f3b4b4dSDmitry Karpeev       if (subdomain_names && subdomain_names[i]) {
5728f3b4b4dSDmitry Karpeev 	     ierr = PetscSNPrintf(subprefix,PETSC_MAX_PATH_LEN,"sub_%s_",subdomain_names[i]);CHKERRQ(ierr);
5738f3b4b4dSDmitry Karpeev 	     ierr = KSPAppendOptionsPrefix(ksp,subprefix);CHKERRQ(ierr);
5748f3b4b4dSDmitry Karpeev 	     ierr = PetscFree(subdomain_names[i]);CHKERRQ(ierr);
5758f3b4b4dSDmitry Karpeev       }
576b1a0a8a3SJed Brown       ierr        = KSPAppendOptionsPrefix(ksp,"sub_");CHKERRQ(ierr);
577b1a0a8a3SJed Brown       osm->ksp[i] = ksp;
578b1a0a8a3SJed Brown     }
5798f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_dm);CHKERRQ(ierr);
5808f3b4b4dSDmitry Karpeev     ierr = PetscFree(subdomain_names);CHKERRQ(ierr);
581b1a0a8a3SJed Brown     scall = MAT_INITIAL_MATRIX;
582b1a0a8a3SJed Brown 
5838f3b4b4dSDmitry Karpeev   } else { /* if (pc->setupcalled) */
584b1a0a8a3SJed Brown     /*
5858f3b4b4dSDmitry Karpeev        Destroy the submatrices from the previous iteration
586b1a0a8a3SJed Brown     */
587b1a0a8a3SJed Brown     if (pc->flag == DIFFERENT_NONZERO_PATTERN) {
588f746d493SDmitry Karpeev       ierr  = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
589b1a0a8a3SJed Brown       scall = MAT_INITIAL_MATRIX;
590b1a0a8a3SJed Brown     }
591ea91fabdSFande Kong     if(osm->permutationIS){
592ea91fabdSFande Kong       ierr = MatGetSubMatrix(pc->pmat,osm->permutationIS,osm->permutationIS,scall,&osm->permutationP);CHKERRQ(ierr);
593ea91fabdSFande Kong       ierr = PetscObjectReference((PetscObject)osm->permutationP);CHKERRQ(ierr);
594ea91fabdSFande Kong       osm->pcmat = pc->pmat;
595ea91fabdSFande Kong       pc->pmat   = osm->permutationP;
596b1a0a8a3SJed Brown     }
597b1a0a8a3SJed Brown 
598ea91fabdSFande Kong   }
599ea91fabdSFande Kong 
600ea91fabdSFande Kong 
601b1a0a8a3SJed Brown   /*
602f746d493SDmitry Karpeev      Extract out the submatrices.
603b1a0a8a3SJed Brown   */
60481a5c4aaSDmitry Karpeev   if (size > 1) {
6058f3b4b4dSDmitry Karpeev     ierr = MatGetSubMatricesMPI(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
6062fa5cd67SKarl Rupp   } else {
6076a4f0f73SDmitry Karpeev     ierr = MatGetSubMatrices(pc->pmat,osm->n,osm->ois,osm->ois,scall,&osm->pmat);CHKERRQ(ierr);
60881a5c4aaSDmitry Karpeev   }
609b1a0a8a3SJed Brown   if (scall == MAT_INITIAL_MATRIX) {
610b1a0a8a3SJed Brown     ierr = PetscObjectGetOptionsPrefix((PetscObject)pc->pmat,&pprefix);CHKERRQ(ierr);
611f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
6123bb1ff40SBarry Smith       ierr = PetscLogObjectParent((PetscObject)pc,(PetscObject)osm->pmat[i]);CHKERRQ(ierr);
613b1a0a8a3SJed Brown       ierr = PetscObjectSetOptionsPrefix((PetscObject)osm->pmat[i],pprefix);CHKERRQ(ierr);
614b1a0a8a3SJed Brown     }
615b1a0a8a3SJed Brown   }
616b1a0a8a3SJed Brown 
617b1a0a8a3SJed Brown   /* Return control to the user so that the submatrices can be modified (e.g., to apply
618b1a0a8a3SJed Brown      different boundary conditions for the submatrices than for the global problem) */
6196a4f0f73SDmitry Karpeev   ierr = PCModifySubMatrices(pc,osm->n,osm->ois,osm->ois,osm->pmat,pc->modifysubmatricesP);CHKERRQ(ierr);
620b1a0a8a3SJed Brown 
621b1a0a8a3SJed Brown   /*
6226a4f0f73SDmitry Karpeev      Loop over submatrices putting them into local ksps
623b1a0a8a3SJed Brown   */
624f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
62523ee1639SBarry Smith     ierr = KSPSetOperators(osm->ksp[i],osm->pmat[i],osm->pmat[i]);CHKERRQ(ierr);
626b1a0a8a3SJed Brown     if (!pc->setupcalled) {
627b1a0a8a3SJed Brown       ierr = KSPSetFromOptions(osm->ksp[i]);CHKERRQ(ierr);
628b1a0a8a3SJed Brown     }
629b1a0a8a3SJed Brown   }
630ea91fabdSFande Kong   if(osm->pcmat){
631ea91fabdSFande Kong     ierr = MatDestroy(&pc->pmat);CHKERRQ(ierr);
632ea91fabdSFande Kong     pc->pmat   = osm->pcmat;
633ea91fabdSFande Kong     osm->pcmat = 0;
634ea91fabdSFande Kong   }
635b1a0a8a3SJed Brown   PetscFunctionReturn(0);
636b1a0a8a3SJed Brown }
637b1a0a8a3SJed Brown 
638b1a0a8a3SJed Brown #undef __FUNCT__
639f746d493SDmitry Karpeev #define __FUNCT__ "PCSetUpOnBlocks_GASM"
640f746d493SDmitry Karpeev static PetscErrorCode PCSetUpOnBlocks_GASM(PC pc)
641b1a0a8a3SJed Brown {
642f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
643b1a0a8a3SJed Brown   PetscErrorCode ierr;
644b1a0a8a3SJed Brown   PetscInt       i;
645b1a0a8a3SJed Brown 
646b1a0a8a3SJed Brown   PetscFunctionBegin;
647f746d493SDmitry Karpeev   for (i=0; i<osm->n; i++) {
648b1a0a8a3SJed Brown     ierr = KSPSetUp(osm->ksp[i]);CHKERRQ(ierr);
649b1a0a8a3SJed Brown   }
650b1a0a8a3SJed Brown   PetscFunctionReturn(0);
651b1a0a8a3SJed Brown }
652b1a0a8a3SJed Brown 
653b1a0a8a3SJed Brown #undef __FUNCT__
654f746d493SDmitry Karpeev #define __FUNCT__ "PCApply_GASM"
655ea91fabdSFande Kong static PetscErrorCode PCApply_GASM(PC pc,Vec xin,Vec yout)
656b1a0a8a3SJed Brown {
657f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
658b1a0a8a3SJed Brown   PetscErrorCode ierr;
659f746d493SDmitry Karpeev   PetscInt       i;
660ea91fabdSFande Kong   Vec            x,y;
661b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
662b1a0a8a3SJed Brown 
663b1a0a8a3SJed Brown   PetscFunctionBegin;
664ea91fabdSFande Kong   if(osm->pctoouter){
665ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
666ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
667ea91fabdSFande Kong     x = osm->pcx;
668ea91fabdSFande Kong     y = osm->pcy;
669ea91fabdSFande Kong   }else{
670ea91fabdSFande Kong 	x = xin;
671ea91fabdSFande Kong 	y = yout;
672ea91fabdSFande Kong   }
673b1a0a8a3SJed Brown   /*
6746a4f0f73SDmitry Karpeev      Support for limiting the restriction or interpolation only to the inner
675b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
676b1a0a8a3SJed Brown   */
677f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
678b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
679f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
6806a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6812fa5cd67SKarl Rupp   } else {
6826a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
683b1a0a8a3SJed Brown   }
6846a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
6856a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
6866a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6872fa5cd67SKarl Rupp   } else {
6886a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
6896a4f0f73SDmitry Karpeev   }
69086b96d36SDmitry Karpeev   /* do the subdomain solves */
69186b96d36SDmitry Karpeev   for (i=0; i<osm->n; ++i) {
692b1a0a8a3SJed Brown     ierr = KSPSolve(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
693b1a0a8a3SJed Brown   }
694930d09c1SFande Kong   /* Do we need to zero y ?? */
6956a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
6966a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
6976a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
698ea91fabdSFande Kong     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
6992fa5cd67SKarl Rupp   } else {
7006a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
701ea91fabdSFande Kong     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7026a4f0f73SDmitry Karpeev   }
703ea91fabdSFande Kong   if(osm->pctoouter){
704ea91fabdSFande Kong     ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
705ea91fabdSFande Kong     ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
706ea91fabdSFande Kong   }
707ea91fabdSFande Kong   PetscFunctionReturn(0);
708b1a0a8a3SJed Brown }
709b1a0a8a3SJed Brown 
710b1a0a8a3SJed Brown #undef __FUNCT__
711f746d493SDmitry Karpeev #define __FUNCT__ "PCApplyTranspose_GASM"
712ea91fabdSFande Kong static PetscErrorCode PCApplyTranspose_GASM(PC pc,Vec xin,Vec yout)
713b1a0a8a3SJed Brown {
714f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
715b1a0a8a3SJed Brown   PetscErrorCode ierr;
716f746d493SDmitry Karpeev   PetscInt       i;
717ea91fabdSFande Kong   Vec            x,y;
718b1a0a8a3SJed Brown   ScatterMode    forward = SCATTER_FORWARD,reverse = SCATTER_REVERSE;
719b1a0a8a3SJed Brown 
720b1a0a8a3SJed Brown   PetscFunctionBegin;
721ea91fabdSFande Kong   if(osm->pctoouter){
722ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
723ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,xin,osm->pcx,INSERT_VALUES,SCATTER_REVERSE);CHKERRQ(ierr);
724ea91fabdSFande Kong    x = osm->pcx;
725ea91fabdSFande Kong    y = osm->pcy;
726ea91fabdSFande Kong   }else{
727ea91fabdSFande Kong 	x = xin;
728ea91fabdSFande Kong 	y = yout;
729ea91fabdSFande Kong   }
730b1a0a8a3SJed Brown   /*
731b1a0a8a3SJed Brown      Support for limiting the restriction or interpolation to only local
732b1a0a8a3SJed Brown      subdomain values (leaving the other values 0).
733b1a0a8a3SJed Brown 
734f746d493SDmitry Karpeev      Note: these are reversed from the PCApply_GASM() because we are applying the
735b1a0a8a3SJed Brown      transpose of the three terms
736b1a0a8a3SJed Brown   */
737f746d493SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
738b1a0a8a3SJed Brown     /* have to zero the work RHS since scatter may leave some slots empty */
739f746d493SDmitry Karpeev     ierr = VecZeroEntries(osm->gx);CHKERRQ(ierr);
7406a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7412fa5cd67SKarl Rupp   } else {
7426a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
743b1a0a8a3SJed Brown   }
7446a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(osm->gy);CHKERRQ(ierr);
7456a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_INTERPOLATE)) {
7466a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7472fa5cd67SKarl Rupp   } else {
7486a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,x,osm->gx,INSERT_VALUES,forward);CHKERRQ(ierr);
7496a4f0f73SDmitry Karpeev   }
750b1a0a8a3SJed Brown   /* do the local solves */
751ab3e923fSDmitry 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. */
752b1a0a8a3SJed Brown     ierr = KSPSolveTranspose(osm->ksp[i],osm->x[i],osm->y[i]);CHKERRQ(ierr);
753b1a0a8a3SJed Brown   }
7546a4f0f73SDmitry Karpeev   ierr = VecZeroEntries(y);CHKERRQ(ierr);
7556a4f0f73SDmitry Karpeev   if (!(osm->type & PC_GASM_RESTRICT)) {
7566a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7576a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->girestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7582fa5cd67SKarl Rupp   } else {
7596a4f0f73SDmitry Karpeev     ierr = VecScatterBegin(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7606a4f0f73SDmitry Karpeev     ierr = VecScatterEnd(osm->gorestriction,osm->gy,y,ADD_VALUES,reverse);CHKERRQ(ierr);
7616a4f0f73SDmitry Karpeev   }
762ea91fabdSFande Kong   if(osm->pctoouter){
763ea91fabdSFande Kong    ierr = VecScatterBegin(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
764ea91fabdSFande Kong    ierr = VecScatterEnd(osm->pctoouter,y,yout,INSERT_VALUES,SCATTER_FORWARD);CHKERRQ(ierr);
765ea91fabdSFande Kong   }
766b1a0a8a3SJed Brown   PetscFunctionReturn(0);
767b1a0a8a3SJed Brown }
768b1a0a8a3SJed Brown 
769b1a0a8a3SJed Brown #undef __FUNCT__
770a06653b4SBarry Smith #define __FUNCT__ "PCReset_GASM"
771a06653b4SBarry Smith static PetscErrorCode PCReset_GASM(PC pc)
772b1a0a8a3SJed Brown {
773f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
774b1a0a8a3SJed Brown   PetscErrorCode ierr;
775b1a0a8a3SJed Brown   PetscInt       i;
776b1a0a8a3SJed Brown 
777b1a0a8a3SJed Brown   PetscFunctionBegin;
778b1a0a8a3SJed Brown   if (osm->ksp) {
779f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
780a06653b4SBarry Smith       ierr = KSPReset(osm->ksp[i]);CHKERRQ(ierr);
781b1a0a8a3SJed Brown     }
782b1a0a8a3SJed Brown   }
783b1a0a8a3SJed Brown   if (osm->pmat) {
784f746d493SDmitry Karpeev     if (osm->n > 0) {
785ab3e923fSDmitry Karpeev       ierr = MatDestroyMatrices(osm->n,&osm->pmat);CHKERRQ(ierr);
786b1a0a8a3SJed Brown     }
787b1a0a8a3SJed Brown   }
788d34fcf5fSBarry Smith   if (osm->x) {
789f746d493SDmitry Karpeev     for (i=0; i<osm->n; i++) {
790fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->x[i]);CHKERRQ(ierr);
791fcfd50ebSBarry Smith       ierr = VecDestroy(&osm->y[i]);CHKERRQ(ierr);
792b1a0a8a3SJed Brown     }
793d34fcf5fSBarry Smith   }
7946bf464f9SBarry Smith   ierr = VecDestroy(&osm->gx);CHKERRQ(ierr);
7956bf464f9SBarry Smith   ierr = VecDestroy(&osm->gy);CHKERRQ(ierr);
796ab3e923fSDmitry Karpeev 
7976a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->gorestriction);CHKERRQ(ierr);
7986a4f0f73SDmitry Karpeev   ierr = VecScatterDestroy(&osm->girestriction);CHKERRQ(ierr);
7998f3b4b4dSDmitry Karpeev   if (!osm->user_subdomains) {
8002c112581SDmitry Karpeev     ierr      = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
8018f3b4b4dSDmitry Karpeev     osm->N    = PETSC_DETERMINE;
8028f3b4b4dSDmitry Karpeev     osm->nmax = PETSC_DETERMINE;
8038f3b4b4dSDmitry Karpeev   }
804ea91fabdSFande Kong   if(osm->pctoouter){
805ea91fabdSFande Kong 	ierr = VecScatterDestroy(&(osm->pctoouter));CHKERRQ(ierr);
806ea91fabdSFande Kong   }
807ea91fabdSFande Kong   if(osm->permutationIS){
808ea91fabdSFande Kong 	ierr = ISDestroy(&(osm->permutationIS));CHKERRQ(ierr);
809ea91fabdSFande Kong   }
810ea91fabdSFande Kong   if(osm->pcx){
811ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcx));CHKERRQ(ierr);
812ea91fabdSFande Kong   }
813ea91fabdSFande Kong   if(osm->pcy){
814ea91fabdSFande Kong 	ierr = VecDestroy(&(osm->pcy));CHKERRQ(ierr);
815ea91fabdSFande Kong   }
816ea91fabdSFande Kong   if(osm->permutationP){
817ea91fabdSFande Kong     ierr = MatDestroy(&(osm->permutationP));CHKERRQ(ierr);
818ea91fabdSFande Kong   }
819ea91fabdSFande Kong   if(osm->pcmat){
820ea91fabdSFande Kong 	ierr = MatDestroy(&osm->pcmat);CHKERRQ(ierr);
821ea91fabdSFande Kong   }
822a06653b4SBarry Smith   PetscFunctionReturn(0);
823a06653b4SBarry Smith }
824a06653b4SBarry Smith 
825a06653b4SBarry Smith #undef __FUNCT__
826a06653b4SBarry Smith #define __FUNCT__ "PCDestroy_GASM"
827a06653b4SBarry Smith static PetscErrorCode PCDestroy_GASM(PC pc)
828a06653b4SBarry Smith {
829a06653b4SBarry Smith   PC_GASM        *osm = (PC_GASM*)pc->data;
830a06653b4SBarry Smith   PetscErrorCode ierr;
831a06653b4SBarry Smith   PetscInt       i;
832a06653b4SBarry Smith 
833a06653b4SBarry Smith   PetscFunctionBegin;
834a06653b4SBarry Smith   ierr = PCReset_GASM(pc);CHKERRQ(ierr);
835135757f6SDmitry Karpeev   /* PCReset will not destroy subdomains, if user_subdomains is true. */
836135757f6SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->ois,&osm->iis);CHKERRQ(ierr);
837a06653b4SBarry Smith   if (osm->ksp) {
838a06653b4SBarry Smith     for (i=0; i<osm->n; i++) {
8396bf464f9SBarry Smith       ierr = KSPDestroy(&osm->ksp[i]);CHKERRQ(ierr);
840a06653b4SBarry Smith     }
841a06653b4SBarry Smith     ierr = PetscFree(osm->ksp);CHKERRQ(ierr);
842a06653b4SBarry Smith   }
843a06653b4SBarry Smith   ierr = PetscFree(osm->x);CHKERRQ(ierr);
844a06653b4SBarry Smith   ierr = PetscFree(osm->y);CHKERRQ(ierr);
845c31cb41cSBarry Smith   ierr = PetscFree(pc->data);CHKERRQ(ierr);
846b1a0a8a3SJed Brown   PetscFunctionReturn(0);
847b1a0a8a3SJed Brown }
848b1a0a8a3SJed Brown 
849b1a0a8a3SJed Brown #undef __FUNCT__
850f746d493SDmitry Karpeev #define __FUNCT__ "PCSetFromOptions_GASM"
8514416b707SBarry Smith static PetscErrorCode PCSetFromOptions_GASM(PetscOptionItems *PetscOptionsObject,PC pc)
852a6dfd86eSKarl Rupp {
853f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
854b1a0a8a3SJed Brown   PetscErrorCode ierr;
855b1a0a8a3SJed Brown   PetscInt       blocks,ovl;
856b1a0a8a3SJed Brown   PetscBool      symset,flg;
857f746d493SDmitry Karpeev   PCGASMType     gasmtype;
858b1a0a8a3SJed Brown 
859b1a0a8a3SJed Brown   PetscFunctionBegin;
860b1a0a8a3SJed Brown   /* set the type to symmetric if matrix is symmetric */
861b1a0a8a3SJed Brown   if (!osm->type_set && pc->pmat) {
862b1a0a8a3SJed Brown     ierr = MatIsSymmetricKnown(pc->pmat,&symset,&flg);CHKERRQ(ierr);
8632fa5cd67SKarl Rupp     if (symset && flg) osm->type = PC_GASM_BASIC;
864b1a0a8a3SJed Brown   }
865e55864a3SBarry Smith   ierr = PetscOptionsHead(PetscOptionsObject,"Generalized additive Schwarz options");CHKERRQ(ierr);
8668f3b4b4dSDmitry 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);
8678f3b4b4dSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_total_subdomains","Total number of subdomains across communicator","PCGASMSetTotalSubdomains",osm->N,&blocks,&flg);CHKERRQ(ierr);
86865db9045SDmitry Karpeev   if (flg) {
8698f3b4b4dSDmitry Karpeev     ierr = PCGASMSetTotalSubdomains(pc,blocks);CHKERRQ(ierr);
87065db9045SDmitry Karpeev   }
87106b43e7eSDmitry Karpeev   ierr = PetscOptionsInt("-pc_gasm_overlap","Number of overlapping degrees of freedom","PCGASMSetOverlap",osm->overlap,&ovl,&flg);CHKERRQ(ierr);
87265db9045SDmitry Karpeev   if (flg) {
87365db9045SDmitry Karpeev     ierr = PCGASMSetOverlap(pc,ovl);CHKERRQ(ierr);
874d709ea83SDmitry Karpeev     osm->dm_subdomains = PETSC_FALSE;
87565db9045SDmitry Karpeev   }
876b1a0a8a3SJed Brown   flg  = PETSC_FALSE;
877f746d493SDmitry Karpeev   ierr = PetscOptionsEnum("-pc_gasm_type","Type of restriction/extension","PCGASMSetType",PCGASMTypes,(PetscEnum)osm->type,(PetscEnum*)&gasmtype,&flg);CHKERRQ(ierr);
878f746d493SDmitry Karpeev   if (flg) {ierr = PCGASMSetType(pc,gasmtype);CHKERRQ(ierr);}
879ea91fabdSFande Kong   ierr = PetscOptionsBool("-pc_gasm_use_hierachical_partitioning","use hierarchical partitioning",NULL,osm->hierarchicalpartitioning,&osm->hierarchicalpartitioning,&flg);CHKERRQ(ierr);
880b1a0a8a3SJed Brown   ierr = PetscOptionsTail();CHKERRQ(ierr);
881b1a0a8a3SJed Brown   PetscFunctionReturn(0);
882b1a0a8a3SJed Brown }
883b1a0a8a3SJed Brown 
884b1a0a8a3SJed Brown /*------------------------------------------------------------------------------------*/
885b1a0a8a3SJed Brown 
886b1a0a8a3SJed Brown #undef __FUNCT__
8878f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMSetTotalSubdomains"
8888f3b4b4dSDmitry Karpeev /*@
8898f3b4b4dSDmitry Karpeev     PCGASMSetTotalSubdomains - sets the total number of subdomains to use across the
8908f3b4b4dSDmitry Karpeev                                communicator.
8918f3b4b4dSDmitry Karpeev     Logically collective on pc
8928f3b4b4dSDmitry Karpeev 
8938f3b4b4dSDmitry Karpeev     Input Parameters:
8948f3b4b4dSDmitry Karpeev +   pc  - the preconditioner
8958f3b4b4dSDmitry Karpeev -   N   - total number of subdomains
8968f3b4b4dSDmitry Karpeev 
8978f3b4b4dSDmitry Karpeev 
8988f3b4b4dSDmitry Karpeev     Level: beginner
8998f3b4b4dSDmitry Karpeev 
9008f3b4b4dSDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
9018f3b4b4dSDmitry Karpeev 
9028f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap()
9038f3b4b4dSDmitry Karpeev           PCGASMCreateSubdomains2D()
9048f3b4b4dSDmitry Karpeev @*/
9058f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetTotalSubdomains(PC pc,PetscInt N)
9068f3b4b4dSDmitry Karpeev {
9078f3b4b4dSDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
9088f3b4b4dSDmitry Karpeev   PetscMPIInt    size,rank;
9098f3b4b4dSDmitry Karpeev   PetscErrorCode ierr;
9108f3b4b4dSDmitry Karpeev 
9118f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
9128f3b4b4dSDmitry 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);
9138f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetTotalSubdomains() should be called before calling PCSetUp().");
9148f3b4b4dSDmitry Karpeev 
9152c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9168f3b4b4dSDmitry Karpeev   osm->ois = osm->iis = NULL;
9178f3b4b4dSDmitry Karpeev 
9188f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)pc),&size);CHKERRQ(ierr);
9198f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)pc),&rank);CHKERRQ(ierr);
9208f3b4b4dSDmitry Karpeev   osm->N    = N;
9218f3b4b4dSDmitry Karpeev   osm->n    = PETSC_DETERMINE;
9228f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
9238f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
9248f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
9258f3b4b4dSDmitry Karpeev }
9268f3b4b4dSDmitry Karpeev 
927670417b2SFande Kong 
9288f3b4b4dSDmitry Karpeev #undef __FUNCT__
92906b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMSetSubdomains_GASM"
930b541e6a4SDmitry Karpeev static PetscErrorCode  PCGASMSetSubdomains_GASM(PC pc,PetscInt n,IS iis[],IS ois[])
931b1a0a8a3SJed Brown {
932f746d493SDmitry Karpeev   PC_GASM         *osm = (PC_GASM*)pc->data;
933b1a0a8a3SJed Brown   PetscErrorCode  ierr;
934b1a0a8a3SJed Brown   PetscInt        i;
935b1a0a8a3SJed Brown 
936b1a0a8a3SJed Brown   PetscFunctionBegin;
9378f3b4b4dSDmitry Karpeev   if (n < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Each process must have 1 or more subdomains, got n = %D",n);
9388f3b4b4dSDmitry Karpeev   if (pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetSubdomains() should be called before calling PCSetUp().");
939b1a0a8a3SJed Brown 
9402c112581SDmitry Karpeev   ierr = PCGASMDestroySubdomains(osm->n,&osm->iis,&osm->ois);CHKERRQ(ierr);
9418f3b4b4dSDmitry Karpeev   osm->iis  = osm->ois = NULL;
9428f3b4b4dSDmitry Karpeev   osm->n    = n;
9438f3b4b4dSDmitry Karpeev   osm->N    = PETSC_DETERMINE;
9448f3b4b4dSDmitry Karpeev   osm->nmax = PETSC_DETERMINE;
945a35b7b57SDmitry Karpeev   if (ois) {
946785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->ois);CHKERRQ(ierr);
9478f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9488f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)ois[i]);CHKERRQ(ierr);
9498f3b4b4dSDmitry Karpeev       osm->ois[i] = ois[i];
9508f3b4b4dSDmitry Karpeev     }
9518f3b4b4dSDmitry Karpeev     /*
9528f3b4b4dSDmitry Karpeev        Since the user set the outer subdomains, even if nontrivial overlap was requested via PCGASMSetOverlap(),
9538f3b4b4dSDmitry Karpeev        it will be ignored.  To avoid confusion later on (e.g., when viewing the PC), the overlap size is set to -1.
9548f3b4b4dSDmitry Karpeev     */
955b1a0a8a3SJed Brown     osm->overlap = -1;
956670417b2SFande Kong     /* inner subdomains must be provided  */
957670417b2SFande Kong     if (!iis) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"inner indices have to be provided \n");
958670417b2SFande Kong   }/* end if */
959a35b7b57SDmitry Karpeev   if (iis) {
960785e854fSJed Brown     ierr = PetscMalloc1(n,&osm->iis);CHKERRQ(ierr);
9618f3b4b4dSDmitry Karpeev     for (i=0; i<n; i++) {
9628f3b4b4dSDmitry Karpeev       ierr = PetscObjectReference((PetscObject)iis[i]);CHKERRQ(ierr);
9638f3b4b4dSDmitry Karpeev       osm->iis[i] = iis[i];
9648f3b4b4dSDmitry Karpeev     }
965a35b7b57SDmitry Karpeev     if (!ois) {
966670417b2SFande Kong       osm->ois = PETSC_NULL;
967670417b2SFande Kong       /* if user does not provide outer indices, we will create the corresponding outer indices using  osm->overlap =1 in PCSetUp_GASM */
968670417b2SFande Kong     }
969670417b2SFande Kong   }
970670417b2SFande Kong #if defined(PETSC_USE_DEBUG)
971670417b2SFande Kong   {
972670417b2SFande Kong     PetscInt        j,rstart,rend,*covered,lsize;
973670417b2SFande Kong     const PetscInt  *indices;
974670417b2SFande Kong     /* check if the inner indices cover and only cover the local portion of the preconditioning matrix */
975670417b2SFande Kong     ierr = MatGetOwnershipRange(pc->pmat,&rstart,&rend);CHKERRQ(ierr);
976670417b2SFande Kong     ierr = PetscCalloc1(rend-rstart,&covered);CHKERRQ(ierr);
977670417b2SFande Kong     /* check if the current processor owns indices from others */
978a35b7b57SDmitry Karpeev     for (i=0; i<n; i++) {
979670417b2SFande Kong       ierr = ISGetIndices(osm->iis[i],&indices);CHKERRQ(ierr);
980670417b2SFande Kong       ierr = ISGetLocalSize(osm->iis[i],&lsize);CHKERRQ(ierr);
981670417b2SFande Kong       for (j=0; j<lsize; j++) {
982670417b2SFande Kong         if (indices[j]<rstart || indices[j]>=rend) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"inner subdomains can not own an index %d from other processors", indices[j]);
983670417b2SFande Kong         else if (covered[indices[j]-rstart]==1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"inner subdomains can not have an overlapping index %d ",indices[j]);
984670417b2SFande Kong         else covered[indices[j]-rstart] = 1;
985a35b7b57SDmitry Karpeev       }
986670417b2SFande Kong     ierr = ISRestoreIndices(osm->iis[i],&indices);CHKERRQ(ierr);
9878f3b4b4dSDmitry Karpeev     }
988670417b2SFande Kong     /* check if we miss any indices */
989670417b2SFande Kong     for (i=rstart; i<rend; i++) {
990670417b2SFande Kong       if (!covered[i-rstart]) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_NULL,"local entity %d was not covered by inner subdomains",i);
991a35b7b57SDmitry Karpeev     }
992670417b2SFande Kong     ierr = PetscFree(covered);CHKERRQ(ierr);
993a35b7b57SDmitry Karpeev   }
994670417b2SFande Kong #endif
9958f3b4b4dSDmitry Karpeev   if (iis)  osm->user_subdomains = PETSC_TRUE;
996b1a0a8a3SJed Brown   PetscFunctionReturn(0);
997b1a0a8a3SJed Brown }
998b1a0a8a3SJed Brown 
999b1a0a8a3SJed Brown 
1000b1a0a8a3SJed Brown #undef __FUNCT__
1001f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetOverlap_GASM"
1002f7a08781SBarry Smith static PetscErrorCode  PCGASMSetOverlap_GASM(PC pc,PetscInt ovl)
1003b1a0a8a3SJed Brown {
1004f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1005b1a0a8a3SJed Brown 
1006b1a0a8a3SJed Brown   PetscFunctionBegin;
1007ce94432eSBarry Smith   if (ovl < 0) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_OUTOFRANGE,"Negative overlap value requested");
1008ce94432eSBarry Smith   if (pc->setupcalled && ovl != osm->overlap) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"PCGASMSetOverlap() should be called before PCSetUp().");
10092fa5cd67SKarl Rupp   if (!pc->setupcalled) osm->overlap = ovl;
1010b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1011b1a0a8a3SJed Brown }
1012b1a0a8a3SJed Brown 
1013b1a0a8a3SJed Brown #undef __FUNCT__
1014f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetType_GASM"
1015f7a08781SBarry Smith static PetscErrorCode  PCGASMSetType_GASM(PC pc,PCGASMType type)
1016b1a0a8a3SJed Brown {
1017f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1018b1a0a8a3SJed Brown 
1019b1a0a8a3SJed Brown   PetscFunctionBegin;
1020b1a0a8a3SJed Brown   osm->type     = type;
1021b1a0a8a3SJed Brown   osm->type_set = PETSC_TRUE;
1022b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1023b1a0a8a3SJed Brown }
1024b1a0a8a3SJed Brown 
1025b1a0a8a3SJed Brown #undef __FUNCT__
1026f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetSortIndices_GASM"
1027f7a08781SBarry Smith static PetscErrorCode  PCGASMSetSortIndices_GASM(PC pc,PetscBool doSort)
1028b1a0a8a3SJed Brown {
1029f746d493SDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1030b1a0a8a3SJed Brown 
1031b1a0a8a3SJed Brown   PetscFunctionBegin;
1032b1a0a8a3SJed Brown   osm->sort_indices = doSort;
1033b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1034b1a0a8a3SJed Brown }
1035b1a0a8a3SJed Brown 
1036b1a0a8a3SJed Brown #undef __FUNCT__
1037f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMGetSubKSP_GASM"
103844fe18e5SDmitry Karpeev /*
10398f3b4b4dSDmitry Karpeev    FIXME: This routine might need to be modified now that multiple ranks per subdomain are allowed.
104044fe18e5SDmitry Karpeev         In particular, it would upset the global subdomain number calculation.
104144fe18e5SDmitry Karpeev */
1042f7a08781SBarry Smith static PetscErrorCode  PCGASMGetSubKSP_GASM(PC pc,PetscInt *n,PetscInt *first,KSP **ksp)
1043b1a0a8a3SJed Brown {
1044f746d493SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1045b1a0a8a3SJed Brown   PetscErrorCode ierr;
1046b1a0a8a3SJed Brown 
1047b1a0a8a3SJed Brown   PetscFunctionBegin;
1048ce94432eSBarry 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");
1049b1a0a8a3SJed Brown 
10502fa5cd67SKarl Rupp   if (n) *n = osm->n;
1051ab3e923fSDmitry Karpeev   if (first) {
1052ce94432eSBarry Smith     ierr    = MPI_Scan(&osm->n,first,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)pc));CHKERRQ(ierr);
1053ab3e923fSDmitry Karpeev     *first -= osm->n;
1054b1a0a8a3SJed Brown   }
1055b1a0a8a3SJed Brown   if (ksp) {
1056b1a0a8a3SJed Brown     /* Assume that local solves are now different; not necessarily
105706b43e7eSDmitry Karpeev        true, though!  This flag is used only for PCView_GASM() */
1058b1a0a8a3SJed Brown     *ksp                        = osm->ksp;
10596a4f0f73SDmitry Karpeev     osm->same_subdomain_solvers = PETSC_FALSE;
1060b1a0a8a3SJed Brown   }
1061b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1062ab3e923fSDmitry Karpeev } /* PCGASMGetSubKSP_GASM() */
1063b1a0a8a3SJed Brown 
1064b1a0a8a3SJed Brown #undef __FUNCT__
106506b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMSetSubdomains"
1066b1a0a8a3SJed Brown /*@C
106706b43e7eSDmitry Karpeev     PCGASMSetSubdomains - Sets the subdomains for this processor
106806b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1069b1a0a8a3SJed Brown 
10708f3b4b4dSDmitry Karpeev     Collective on pc
1071b1a0a8a3SJed Brown 
1072b1a0a8a3SJed Brown     Input Parameters:
10738f3b4b4dSDmitry Karpeev +   pc  - the preconditioner object
107406b43e7eSDmitry Karpeev .   n   - the number of subdomains for this processor
10758f3b4b4dSDmitry Karpeev .   iis - the index sets that define the inner subdomains (or NULL for PETSc to determine subdomains)
10768f3b4b4dSDmitry 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)
1077b1a0a8a3SJed Brown 
1078b1a0a8a3SJed Brown     Notes:
107906b43e7eSDmitry Karpeev     The IS indices use the parallel, global numbering of the vector entries.
10806a4f0f73SDmitry Karpeev     Inner subdomains are those where the correction is applied.
10816a4f0f73SDmitry Karpeev     Outer subdomains are those where the residual necessary to obtain the
10826a4f0f73SDmitry Karpeev     corrections is obtained (see PCGASMType for the use of inner/outer subdomains).
10836a4f0f73SDmitry Karpeev     Both inner and outer subdomains can extend over several processors.
10846a4f0f73SDmitry Karpeev     This processor's portion of a subdomain is known as a local subdomain.
10856a4f0f73SDmitry Karpeev 
1086670417b2SFande Kong     Inner subdomains can not overlap with each other, do not have any entities from remote processors,
1087670417b2SFande Kong     and  have to cover the entire local subdomain owned by the current processor. The index sets on each
1088670417b2SFande Kong     process should be ordered such that the ith local subdomain is connected to the ith remote subdomain
1089670417b2SFande Kong     on another MPI process.
1090670417b2SFande Kong 
10916a4f0f73SDmitry Karpeev     By default the GASM preconditioner uses 1 (local) subdomain per processor.
10926a4f0f73SDmitry Karpeev 
1093b1a0a8a3SJed Brown 
1094b1a0a8a3SJed Brown     Level: advanced
1095b1a0a8a3SJed Brown 
109606b43e7eSDmitry Karpeev .keywords: PC, GASM, set, subdomains, additive Schwarz
1097b1a0a8a3SJed Brown 
10988f3b4b4dSDmitry Karpeev .seealso: PCGASMSetNumSubdomains(), PCGASMSetOverlap(), PCGASMGetSubKSP(),
109906b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1100b1a0a8a3SJed Brown @*/
11016a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMSetSubdomains(PC pc,PetscInt n,IS iis[],IS ois[])
1102b1a0a8a3SJed Brown {
11038f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1104b1a0a8a3SJed Brown   PetscErrorCode ierr;
1105b1a0a8a3SJed Brown 
1106b1a0a8a3SJed Brown   PetscFunctionBegin;
1107b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
11086a4f0f73SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSubdomains_C",(PC,PetscInt,IS[],IS[]),(pc,n,iis,ois));CHKERRQ(ierr);
11098f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1110b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1111b1a0a8a3SJed Brown }
1112b1a0a8a3SJed Brown 
1113b1a0a8a3SJed Brown 
1114b1a0a8a3SJed Brown #undef __FUNCT__
1115f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetOverlap"
1116b1a0a8a3SJed Brown /*@
1117f746d493SDmitry Karpeev     PCGASMSetOverlap - Sets the overlap between a pair of subdomains for the
1118b1a0a8a3SJed Brown     additive Schwarz preconditioner.  Either all or no processors in the
11198f3b4b4dSDmitry Karpeev     pc communicator must call this routine.
1120b1a0a8a3SJed Brown 
11218f3b4b4dSDmitry Karpeev     Logically Collective on pc
1122b1a0a8a3SJed Brown 
1123b1a0a8a3SJed Brown     Input Parameters:
1124b1a0a8a3SJed Brown +   pc  - the preconditioner context
11258f3b4b4dSDmitry Karpeev -   ovl - the amount of overlap between subdomains (ovl >= 0, default value = 0)
1126b1a0a8a3SJed Brown 
1127b1a0a8a3SJed Brown     Options Database Key:
112806b43e7eSDmitry Karpeev .   -pc_gasm_overlap <overlap> - Sets overlap
1129b1a0a8a3SJed Brown 
1130b1a0a8a3SJed Brown     Notes:
113106b43e7eSDmitry Karpeev     By default the GASM preconditioner uses 1 subdomain per processor.  To use
11328f3b4b4dSDmitry Karpeev     multiple subdomain per perocessor or "straddling" subdomains that intersect
11338f3b4b4dSDmitry Karpeev     multiple processors use PCGASMSetSubdomains() (or option -pc_gasm_total_subdomains <n>).
1134b1a0a8a3SJed Brown 
11358f3b4b4dSDmitry Karpeev     The overlap defaults to 0, so if one desires that no additional
1136b1a0a8a3SJed Brown     overlap be computed beyond what may have been set with a call to
11378f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), then ovl must be set to be 0.  In particular, if one does
11388f3b4b4dSDmitry Karpeev     not explicitly set the subdomains in application code, then all overlap would be computed
1139f746d493SDmitry Karpeev     internally by PETSc, and using an overlap of 0 would result in an GASM
1140b1a0a8a3SJed Brown     variant that is equivalent to the block Jacobi preconditioner.
1141b1a0a8a3SJed Brown 
1142b1a0a8a3SJed Brown     Note that one can define initial index sets with any overlap via
114306b43e7eSDmitry Karpeev     PCGASMSetSubdomains(); the routine PCGASMSetOverlap() merely allows
114406b43e7eSDmitry Karpeev     PETSc to extend that overlap further, if desired.
1145b1a0a8a3SJed Brown 
1146b1a0a8a3SJed Brown     Level: intermediate
1147b1a0a8a3SJed Brown 
1148f746d493SDmitry Karpeev .keywords: PC, GASM, set, overlap
1149b1a0a8a3SJed Brown 
11508f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
115106b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMGetSubdomains()
1152b1a0a8a3SJed Brown @*/
11537087cfbeSBarry Smith PetscErrorCode  PCGASMSetOverlap(PC pc,PetscInt ovl)
1154b1a0a8a3SJed Brown {
1155b1a0a8a3SJed Brown   PetscErrorCode ierr;
11568f3b4b4dSDmitry Karpeev   PC_GASM *osm = (PC_GASM*)pc->data;
1157b1a0a8a3SJed Brown 
1158b1a0a8a3SJed Brown   PetscFunctionBegin;
1159b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1160b1a0a8a3SJed Brown   PetscValidLogicalCollectiveInt(pc,ovl,2);
1161f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetOverlap_C",(PC,PetscInt),(pc,ovl));CHKERRQ(ierr);
11628f3b4b4dSDmitry Karpeev   osm->dm_subdomains = PETSC_FALSE;
1163b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1164b1a0a8a3SJed Brown }
1165b1a0a8a3SJed Brown 
1166b1a0a8a3SJed Brown #undef __FUNCT__
1167f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetType"
1168b1a0a8a3SJed Brown /*@
1169f746d493SDmitry Karpeev     PCGASMSetType - Sets the type of restriction and interpolation used
1170b1a0a8a3SJed Brown     for local problems in the additive Schwarz method.
1171b1a0a8a3SJed Brown 
1172b1a0a8a3SJed Brown     Logically Collective on PC
1173b1a0a8a3SJed Brown 
1174b1a0a8a3SJed Brown     Input Parameters:
1175b1a0a8a3SJed Brown +   pc  - the preconditioner context
1176f746d493SDmitry Karpeev -   type - variant of GASM, one of
1177b1a0a8a3SJed Brown .vb
1178f746d493SDmitry Karpeev       PC_GASM_BASIC       - full interpolation and restriction
1179f746d493SDmitry Karpeev       PC_GASM_RESTRICT    - full restriction, local processor interpolation
1180f746d493SDmitry Karpeev       PC_GASM_INTERPOLATE - full interpolation, local processor restriction
1181f746d493SDmitry Karpeev       PC_GASM_NONE        - local processor restriction and interpolation
1182b1a0a8a3SJed Brown .ve
1183b1a0a8a3SJed Brown 
1184b1a0a8a3SJed Brown     Options Database Key:
1185f746d493SDmitry Karpeev .   -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1186b1a0a8a3SJed Brown 
1187b1a0a8a3SJed Brown     Level: intermediate
1188b1a0a8a3SJed Brown 
1189f746d493SDmitry Karpeev .keywords: PC, GASM, set, type
1190b1a0a8a3SJed Brown 
11918f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1192f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1193b1a0a8a3SJed Brown @*/
11947087cfbeSBarry Smith PetscErrorCode  PCGASMSetType(PC pc,PCGASMType type)
1195b1a0a8a3SJed Brown {
1196b1a0a8a3SJed Brown   PetscErrorCode ierr;
1197b1a0a8a3SJed Brown 
1198b1a0a8a3SJed Brown   PetscFunctionBegin;
1199b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1200b1a0a8a3SJed Brown   PetscValidLogicalCollectiveEnum(pc,type,2);
1201f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetType_C",(PC,PCGASMType),(pc,type));CHKERRQ(ierr);
1202b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1203b1a0a8a3SJed Brown }
1204b1a0a8a3SJed Brown 
1205b1a0a8a3SJed Brown #undef __FUNCT__
1206f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMSetSortIndices"
1207b1a0a8a3SJed Brown /*@
1208f746d493SDmitry Karpeev     PCGASMSetSortIndices - Determines whether subdomain indices are sorted.
1209b1a0a8a3SJed Brown 
1210b1a0a8a3SJed Brown     Logically Collective on PC
1211b1a0a8a3SJed Brown 
1212b1a0a8a3SJed Brown     Input Parameters:
1213b1a0a8a3SJed Brown +   pc  - the preconditioner context
1214b1a0a8a3SJed Brown -   doSort - sort the subdomain indices
1215b1a0a8a3SJed Brown 
1216b1a0a8a3SJed Brown     Level: intermediate
1217b1a0a8a3SJed Brown 
1218f746d493SDmitry Karpeev .keywords: PC, GASM, set, type
1219b1a0a8a3SJed Brown 
12208f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(),
1221f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D()
1222b1a0a8a3SJed Brown @*/
12237087cfbeSBarry Smith PetscErrorCode  PCGASMSetSortIndices(PC pc,PetscBool doSort)
1224b1a0a8a3SJed Brown {
1225b1a0a8a3SJed Brown   PetscErrorCode ierr;
1226b1a0a8a3SJed Brown 
1227b1a0a8a3SJed Brown   PetscFunctionBegin;
1228b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1229b1a0a8a3SJed Brown   PetscValidLogicalCollectiveBool(pc,doSort,2);
1230f746d493SDmitry Karpeev   ierr = PetscTryMethod(pc,"PCGASMSetSortIndices_C",(PC,PetscBool),(pc,doSort));CHKERRQ(ierr);
1231b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1232b1a0a8a3SJed Brown }
1233b1a0a8a3SJed Brown 
1234b1a0a8a3SJed Brown #undef __FUNCT__
1235f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMGetSubKSP"
1236b1a0a8a3SJed Brown /*@C
1237f746d493SDmitry Karpeev    PCGASMGetSubKSP - Gets the local KSP contexts for all blocks on
1238b1a0a8a3SJed Brown    this processor.
1239b1a0a8a3SJed Brown 
1240b1a0a8a3SJed Brown    Collective on PC iff first_local is requested
1241b1a0a8a3SJed Brown 
1242b1a0a8a3SJed Brown    Input Parameter:
1243b1a0a8a3SJed Brown .  pc - the preconditioner context
1244b1a0a8a3SJed Brown 
1245b1a0a8a3SJed Brown    Output Parameters:
12460298fd71SBarry Smith +  n_local - the number of blocks on this processor or NULL
12470298fd71SBarry Smith .  first_local - the global number of the first block on this processor or NULL,
12480298fd71SBarry Smith                  all processors must request or all must pass NULL
1249b1a0a8a3SJed Brown -  ksp - the array of KSP contexts
1250b1a0a8a3SJed Brown 
1251b1a0a8a3SJed Brown    Note:
1252f746d493SDmitry Karpeev    After PCGASMGetSubKSP() the array of KSPes is not to be freed
1253b1a0a8a3SJed Brown 
1254b1a0a8a3SJed Brown    Currently for some matrix implementations only 1 block per processor
1255b1a0a8a3SJed Brown    is supported.
1256b1a0a8a3SJed Brown 
1257f746d493SDmitry Karpeev    You must call KSPSetUp() before calling PCGASMGetSubKSP().
1258b1a0a8a3SJed Brown 
1259b1a0a8a3SJed Brown    Level: advanced
1260b1a0a8a3SJed Brown 
1261f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, get, sub, KSP, context
1262b1a0a8a3SJed Brown 
12638f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMSetOverlap(),
1264f746d493SDmitry Karpeev           PCGASMCreateSubdomains2D(),
1265b1a0a8a3SJed Brown @*/
12667087cfbeSBarry Smith PetscErrorCode  PCGASMGetSubKSP(PC pc,PetscInt *n_local,PetscInt *first_local,KSP *ksp[])
1267b1a0a8a3SJed Brown {
1268b1a0a8a3SJed Brown   PetscErrorCode ierr;
1269b1a0a8a3SJed Brown 
1270b1a0a8a3SJed Brown   PetscFunctionBegin;
1271b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1272f746d493SDmitry Karpeev   ierr = PetscUseMethod(pc,"PCGASMGetSubKSP_C",(PC,PetscInt*,PetscInt*,KSP **),(pc,n_local,first_local,ksp));CHKERRQ(ierr);
1273b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1274b1a0a8a3SJed Brown }
1275b1a0a8a3SJed Brown 
1276b1a0a8a3SJed Brown /* -------------------------------------------------------------------------------------*/
1277b1a0a8a3SJed Brown /*MC
1278f746d493SDmitry Karpeev    PCGASM - Use the (restricted) additive Schwarz method, each block is (approximately) solved with
1279b1a0a8a3SJed Brown            its own KSP object.
1280b1a0a8a3SJed Brown 
1281b1a0a8a3SJed Brown    Options Database Keys:
12828f3b4b4dSDmitry Karpeev +  -pc_gasm_total_subdomains <n>  - Sets total number of local subdomains to be distributed among processors
128306b43e7eSDmitry Karpeev .  -pc_gasm_view_subdomains       - activates the printing of subdomain indices in PCView(), -ksp_view or -snes_view
128406b43e7eSDmitry Karpeev .  -pc_gasm_print_subdomains      - activates the printing of subdomain indices in PCSetUp()
128506b43e7eSDmitry Karpeev .  -pc_gasm_overlap <ovl>         - Sets overlap by which to (automatically) extend local subdomains
1286f746d493SDmitry Karpeev -  -pc_gasm_type [basic,restrict,interpolate,none] - Sets GASM type
1287b1a0a8a3SJed Brown 
1288b1a0a8a3SJed Brown      IMPORTANT: If you run with, for example, 3 blocks on 1 processor or 3 blocks on 3 processors you
1289f746d493SDmitry Karpeev       will get a different convergence rate due to the default option of -pc_gasm_type restrict. Use
1290f746d493SDmitry Karpeev       -pc_gasm_type basic to use the standard GASM.
1291b1a0a8a3SJed Brown 
1292b1a0a8a3SJed Brown    Notes: Each processor can have one or more blocks, but a block cannot be shared by more
1293b1a0a8a3SJed Brown      than one processor. Defaults to one block per processor.
1294b1a0a8a3SJed Brown 
1295b1a0a8a3SJed Brown      To set options on the solvers for each block append -sub_ to all the KSP, and PC
1296b1a0a8a3SJed Brown         options database keys. For example, -sub_pc_type ilu -sub_pc_factor_levels 1 -sub_ksp_type preonly
1297b1a0a8a3SJed Brown 
1298f746d493SDmitry Karpeev      To set the options on the solvers separate for each block call PCGASMGetSubKSP()
1299b1a0a8a3SJed Brown          and set the options directly on the resulting KSP object (you can access its PC
1300b1a0a8a3SJed Brown          with KSPGetPC())
1301b1a0a8a3SJed Brown 
1302b1a0a8a3SJed Brown 
1303b1a0a8a3SJed Brown    Level: beginner
1304b1a0a8a3SJed Brown 
1305b1a0a8a3SJed Brown    Concepts: additive Schwarz method
1306b1a0a8a3SJed Brown 
1307b1a0a8a3SJed Brown     References:
130896a0c994SBarry Smith +   1. - M Dryja, OB Widlund, An additive variant of the Schwarz alternating method for the case of many subregions
130996a0c994SBarry Smith      Courant Institute, New York University Technical report
131096a0c994SBarry Smith -   2. - Barry Smith, Petter Bjorstad, and William Gropp, Domain Decompositions: Parallel Multilevel Methods for Elliptic Partial Differential Equations,
131196a0c994SBarry Smith     Cambridge University Press.
1312b1a0a8a3SJed Brown 
1313b1a0a8a3SJed Brown .seealso:  PCCreate(), PCSetType(), PCType (for list of available types), PC,
131449517cdeSBarry Smith            PCBJACOBI,  PCGASMGetSubKSP(), PCGASMSetSubdomains(),
13158f3b4b4dSDmitry Karpeev            PCSetModifySubmatrices(), PCGASMSetOverlap(), PCGASMSetType()
1316b1a0a8a3SJed Brown 
1317b1a0a8a3SJed Brown M*/
1318b1a0a8a3SJed Brown 
1319b1a0a8a3SJed Brown #undef __FUNCT__
1320f746d493SDmitry Karpeev #define __FUNCT__ "PCCreate_GASM"
13218cc058d9SJed Brown PETSC_EXTERN PetscErrorCode PCCreate_GASM(PC pc)
1322b1a0a8a3SJed Brown {
1323b1a0a8a3SJed Brown   PetscErrorCode ierr;
1324f746d493SDmitry Karpeev   PC_GASM        *osm;
1325b1a0a8a3SJed Brown 
1326b1a0a8a3SJed Brown   PetscFunctionBegin;
1327b00a9115SJed Brown   ierr = PetscNewLog(pc,&osm);CHKERRQ(ierr);
13282fa5cd67SKarl Rupp 
13298f3b4b4dSDmitry Karpeev   osm->N                        = PETSC_DETERMINE;
133006b43e7eSDmitry Karpeev   osm->n                        = PETSC_DECIDE;
13318f3b4b4dSDmitry Karpeev   osm->nmax                     = PETSC_DETERMINE;
13328f3b4b4dSDmitry Karpeev   osm->overlap                  = 0;
1333b1a0a8a3SJed Brown   osm->ksp                      = 0;
13346a4f0f73SDmitry Karpeev   osm->gorestriction            = 0;
13356a4f0f73SDmitry Karpeev   osm->girestriction            = 0;
1336ea91fabdSFande Kong   osm->pctoouter                = 0;
1337ab3e923fSDmitry Karpeev   osm->gx                       = 0;
1338ab3e923fSDmitry Karpeev   osm->gy                       = 0;
1339b1a0a8a3SJed Brown   osm->x                        = 0;
1340b1a0a8a3SJed Brown   osm->y                        = 0;
1341ea91fabdSFande Kong   osm->pcx                      = 0;
1342ea91fabdSFande Kong   osm->pcy                      = 0;
1343ea91fabdSFande Kong   osm->permutationIS            = 0;
1344ea91fabdSFande Kong   osm->permutationP             = 0;
1345ea91fabdSFande Kong   osm->pcmat                    = 0;
13466a4f0f73SDmitry Karpeev   osm->ois                      = 0;
13476a4f0f73SDmitry Karpeev   osm->iis                      = 0;
1348b1a0a8a3SJed Brown   osm->pmat                     = 0;
1349f746d493SDmitry Karpeev   osm->type                     = PC_GASM_RESTRICT;
13506a4f0f73SDmitry Karpeev   osm->same_subdomain_solvers   = PETSC_TRUE;
1351b1a0a8a3SJed Brown   osm->sort_indices             = PETSC_TRUE;
1352d709ea83SDmitry Karpeev   osm->dm_subdomains            = PETSC_FALSE;
1353ea91fabdSFande Kong   osm->hierarchicalpartitioning = PETSC_FALSE;
1354b1a0a8a3SJed Brown 
1355b1a0a8a3SJed Brown   pc->data                 = (void*)osm;
1356f746d493SDmitry Karpeev   pc->ops->apply           = PCApply_GASM;
1357f746d493SDmitry Karpeev   pc->ops->applytranspose  = PCApplyTranspose_GASM;
1358f746d493SDmitry Karpeev   pc->ops->setup           = PCSetUp_GASM;
1359a06653b4SBarry Smith   pc->ops->reset           = PCReset_GASM;
1360f746d493SDmitry Karpeev   pc->ops->destroy         = PCDestroy_GASM;
1361f746d493SDmitry Karpeev   pc->ops->setfromoptions  = PCSetFromOptions_GASM;
1362f746d493SDmitry Karpeev   pc->ops->setuponblocks   = PCSetUpOnBlocks_GASM;
1363f746d493SDmitry Karpeev   pc->ops->view            = PCView_GASM;
1364b1a0a8a3SJed Brown   pc->ops->applyrichardson = 0;
1365b1a0a8a3SJed Brown 
1366bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSubdomains_C",PCGASMSetSubdomains_GASM);CHKERRQ(ierr);
1367bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetOverlap_C",PCGASMSetOverlap_GASM);CHKERRQ(ierr);
1368bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetType_C",PCGASMSetType_GASM);CHKERRQ(ierr);
1369bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMSetSortIndices_C",PCGASMSetSortIndices_GASM);CHKERRQ(ierr);
1370bdf89e91SBarry Smith   ierr = PetscObjectComposeFunction((PetscObject)pc,"PCGASMGetSubKSP_C",PCGASMGetSubKSP_GASM);CHKERRQ(ierr);
1371b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1372b1a0a8a3SJed Brown }
1373b1a0a8a3SJed Brown 
1374b1a0a8a3SJed Brown 
1375b1a0a8a3SJed Brown #undef __FUNCT__
137606b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMCreateLocalSubdomains"
13778f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMCreateLocalSubdomains(Mat A, PetscInt nloc, IS *iis[])
1378b1a0a8a3SJed Brown {
1379b1a0a8a3SJed Brown   MatPartitioning mpart;
1380b1a0a8a3SJed Brown   const char      *prefix;
1381*c56a70eeSBarry Smith   void            (*f)(void);
1382b1a0a8a3SJed Brown   PetscInt        i,j,rstart,rend,bs;
138311bd1e4dSLisandro Dalcin   PetscBool       isbaij = PETSC_FALSE,foundpart = PETSC_FALSE;
13840298fd71SBarry Smith   Mat             Ad     = NULL, adj;
1385b1a0a8a3SJed Brown   IS              ispart,isnumb,*is;
1386b1a0a8a3SJed Brown   PetscErrorCode  ierr;
1387b1a0a8a3SJed Brown 
1388b1a0a8a3SJed Brown   PetscFunctionBegin;
13898f3b4b4dSDmitry Karpeev   if (nloc < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"number of local subdomains must > 0, got nloc = %D",nloc);
1390b1a0a8a3SJed Brown 
1391b1a0a8a3SJed Brown   /* Get prefix, row distribution, and block size */
1392b1a0a8a3SJed Brown   ierr = MatGetOptionsPrefix(A,&prefix);CHKERRQ(ierr);
1393b1a0a8a3SJed Brown   ierr = MatGetOwnershipRange(A,&rstart,&rend);CHKERRQ(ierr);
1394b1a0a8a3SJed Brown   ierr = MatGetBlockSize(A,&bs);CHKERRQ(ierr);
1395b1a0a8a3SJed 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);
1396b1a0a8a3SJed Brown 
1397b1a0a8a3SJed Brown   /* Get diagonal block from matrix if possible */
1398*c56a70eeSBarry Smith   ierr = MatShellGetOperation(A,MATOP_GET_DIAGONAL_BLOCK,&f);CHKERRQ(ierr);
1399b1a0a8a3SJed Brown   if (f) {
140011bd1e4dSLisandro Dalcin     ierr = MatGetDiagonalBlock(A,&Ad);CHKERRQ(ierr);
1401b1a0a8a3SJed Brown   }
1402b1a0a8a3SJed Brown   if (Ad) {
1403251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)Ad,MATSEQBAIJ,&isbaij);CHKERRQ(ierr);
1404251f4c67SDmitry Karpeev     if (!isbaij) {ierr = PetscObjectTypeCompare((PetscObject)Ad,MATSEQSBAIJ,&isbaij);CHKERRQ(ierr);}
1405b1a0a8a3SJed Brown   }
14068f3b4b4dSDmitry Karpeev   if (Ad && nloc > 1) {
1407b1a0a8a3SJed Brown     PetscBool  match,done;
1408b1a0a8a3SJed Brown     /* Try to setup a good matrix partitioning if available */
1409b1a0a8a3SJed Brown     ierr = MatPartitioningCreate(PETSC_COMM_SELF,&mpart);CHKERRQ(ierr);
1410b1a0a8a3SJed Brown     ierr = PetscObjectSetOptionsPrefix((PetscObject)mpart,prefix);CHKERRQ(ierr);
1411b1a0a8a3SJed Brown     ierr = MatPartitioningSetFromOptions(mpart);CHKERRQ(ierr);
1412251f4c67SDmitry Karpeev     ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGCURRENT,&match);CHKERRQ(ierr);
1413b1a0a8a3SJed Brown     if (!match) {
1414251f4c67SDmitry Karpeev       ierr = PetscObjectTypeCompare((PetscObject)mpart,MATPARTITIONINGSQUARE,&match);CHKERRQ(ierr);
1415b1a0a8a3SJed Brown     }
1416b1a0a8a3SJed Brown     if (!match) { /* assume a "good" partitioner is available */
14171a83f524SJed Brown       PetscInt       na;
14181a83f524SJed Brown       const PetscInt *ia,*ja;
1419b1a0a8a3SJed Brown       ierr = MatGetRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1420b1a0a8a3SJed Brown       if (done) {
1421b1a0a8a3SJed Brown         /* Build adjacency matrix by hand. Unfortunately a call to
1422b1a0a8a3SJed Brown            MatConvert(Ad,MATMPIADJ,MAT_INITIAL_MATRIX,&adj) will
1423b1a0a8a3SJed Brown            remove the block-aij structure and we cannot expect
1424b1a0a8a3SJed Brown            MatPartitioning to split vertices as we need */
14251a83f524SJed Brown         PetscInt       i,j,len,nnz,cnt,*iia=0,*jja=0;
14261a83f524SJed Brown         const PetscInt *row;
1427b1a0a8a3SJed Brown         nnz = 0;
1428b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* count number of nonzeros */
1429b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1430b1a0a8a3SJed Brown           row = ja + ia[i];
1431b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
1432b1a0a8a3SJed Brown             if (row[j] == i) { /* don't count diagonal */
1433b1a0a8a3SJed Brown               len--; break;
1434b1a0a8a3SJed Brown             }
1435b1a0a8a3SJed Brown           }
1436b1a0a8a3SJed Brown           nnz += len;
1437b1a0a8a3SJed Brown         }
1438854ce69bSBarry Smith         ierr   = PetscMalloc1(na+1,&iia);CHKERRQ(ierr);
1439854ce69bSBarry Smith         ierr   = PetscMalloc1(nnz,&jja);CHKERRQ(ierr);
1440b1a0a8a3SJed Brown         nnz    = 0;
1441b1a0a8a3SJed Brown         iia[0] = 0;
1442b1a0a8a3SJed Brown         for (i=0; i<na; i++) { /* fill adjacency */
1443b1a0a8a3SJed Brown           cnt = 0;
1444b1a0a8a3SJed Brown           len = ia[i+1] - ia[i];
1445b1a0a8a3SJed Brown           row = ja + ia[i];
1446b1a0a8a3SJed Brown           for (j=0; j<len; j++) {
14472fa5cd67SKarl Rupp             if (row[j] != i) jja[nnz+cnt++] = row[j]; /* if not diagonal */
1448b1a0a8a3SJed Brown           }
1449b1a0a8a3SJed Brown           nnz += cnt;
1450b1a0a8a3SJed Brown           iia[i+1] = nnz;
1451b1a0a8a3SJed Brown         }
1452b1a0a8a3SJed Brown         /* Partitioning of the adjacency matrix */
14530298fd71SBarry Smith         ierr      = MatCreateMPIAdj(PETSC_COMM_SELF,na,na,iia,jja,NULL,&adj);CHKERRQ(ierr);
1454b1a0a8a3SJed Brown         ierr      = MatPartitioningSetAdjacency(mpart,adj);CHKERRQ(ierr);
14558f3b4b4dSDmitry Karpeev         ierr      = MatPartitioningSetNParts(mpart,nloc);CHKERRQ(ierr);
1456b1a0a8a3SJed Brown         ierr      = MatPartitioningApply(mpart,&ispart);CHKERRQ(ierr);
1457b1a0a8a3SJed Brown         ierr      = ISPartitioningToNumbering(ispart,&isnumb);CHKERRQ(ierr);
14586bf464f9SBarry Smith         ierr      = MatDestroy(&adj);CHKERRQ(ierr);
1459b1a0a8a3SJed Brown         foundpart = PETSC_TRUE;
1460b1a0a8a3SJed Brown       }
1461b1a0a8a3SJed Brown       ierr = MatRestoreRowIJ(Ad,0,PETSC_TRUE,isbaij,&na,&ia,&ja,&done);CHKERRQ(ierr);
1462b1a0a8a3SJed Brown     }
14636bf464f9SBarry Smith     ierr = MatPartitioningDestroy(&mpart);CHKERRQ(ierr);
1464b1a0a8a3SJed Brown   }
14658f3b4b4dSDmitry Karpeev   ierr = PetscMalloc1(nloc,&is);CHKERRQ(ierr);
1466b1a0a8a3SJed Brown   if (!foundpart) {
1467b1a0a8a3SJed Brown 
1468b1a0a8a3SJed Brown     /* Partitioning by contiguous chunks of rows */
1469b1a0a8a3SJed Brown 
1470b1a0a8a3SJed Brown     PetscInt mbs   = (rend-rstart)/bs;
1471b1a0a8a3SJed Brown     PetscInt start = rstart;
14728f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
14738f3b4b4dSDmitry Karpeev       PetscInt count = (mbs/nloc + ((mbs % nloc) > i)) * bs;
1474b1a0a8a3SJed Brown       ierr   = ISCreateStride(PETSC_COMM_SELF,count,start,1,&is[i]);CHKERRQ(ierr);
1475b1a0a8a3SJed Brown       start += count;
1476b1a0a8a3SJed Brown     }
1477b1a0a8a3SJed Brown 
1478b1a0a8a3SJed Brown   } else {
1479b1a0a8a3SJed Brown 
1480b1a0a8a3SJed Brown     /* Partitioning by adjacency of diagonal block  */
1481b1a0a8a3SJed Brown 
1482b1a0a8a3SJed Brown     const PetscInt *numbering;
1483b1a0a8a3SJed Brown     PetscInt       *count,nidx,*indices,*newidx,start=0;
1484b1a0a8a3SJed Brown     /* Get node count in each partition */
14858f3b4b4dSDmitry Karpeev     ierr = PetscMalloc1(nloc,&count);CHKERRQ(ierr);
14868f3b4b4dSDmitry Karpeev     ierr = ISPartitioningCount(ispart,nloc,count);CHKERRQ(ierr);
1487b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
14888f3b4b4dSDmitry Karpeev       for (i=0; i<nloc; i++) count[i] *= bs;
1489b1a0a8a3SJed Brown     }
1490b1a0a8a3SJed Brown     /* Build indices from node numbering */
1491b1a0a8a3SJed Brown     ierr = ISGetLocalSize(isnumb,&nidx);CHKERRQ(ierr);
1492785e854fSJed Brown     ierr = PetscMalloc1(nidx,&indices);CHKERRQ(ierr);
1493b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] = i; /* needs to be initialized */
1494b1a0a8a3SJed Brown     ierr = ISGetIndices(isnumb,&numbering);CHKERRQ(ierr);
1495b1a0a8a3SJed Brown     ierr = PetscSortIntWithPermutation(nidx,numbering,indices);CHKERRQ(ierr);
1496b1a0a8a3SJed Brown     ierr = ISRestoreIndices(isnumb,&numbering);CHKERRQ(ierr);
1497b1a0a8a3SJed Brown     if (isbaij && bs > 1) { /* adjust for the block-aij case */
1498785e854fSJed Brown       ierr = PetscMalloc1(nidx*bs,&newidx);CHKERRQ(ierr);
14992fa5cd67SKarl Rupp       for (i=0; i<nidx; i++) {
15002fa5cd67SKarl Rupp         for (j=0; j<bs; j++) newidx[i*bs+j] = indices[i]*bs + j;
15012fa5cd67SKarl Rupp       }
1502b1a0a8a3SJed Brown       ierr    = PetscFree(indices);CHKERRQ(ierr);
1503b1a0a8a3SJed Brown       nidx   *= bs;
1504b1a0a8a3SJed Brown       indices = newidx;
1505b1a0a8a3SJed Brown     }
1506b1a0a8a3SJed Brown     /* Shift to get global indices */
1507b1a0a8a3SJed Brown     for (i=0; i<nidx; i++) indices[i] += rstart;
1508b1a0a8a3SJed Brown 
1509b1a0a8a3SJed Brown     /* Build the index sets for each block */
15108f3b4b4dSDmitry Karpeev     for (i=0; i<nloc; i++) {
1511b1a0a8a3SJed Brown       ierr   = ISCreateGeneral(PETSC_COMM_SELF,count[i],&indices[start],PETSC_COPY_VALUES,&is[i]);CHKERRQ(ierr);
1512b1a0a8a3SJed Brown       ierr   = ISSort(is[i]);CHKERRQ(ierr);
1513b1a0a8a3SJed Brown       start += count[i];
1514b1a0a8a3SJed Brown     }
1515b1a0a8a3SJed Brown 
1516302440fdSBarry Smith     ierr = PetscFree(count);CHKERRQ(ierr);
1517302440fdSBarry Smith     ierr = PetscFree(indices);CHKERRQ(ierr);
1518fcfd50ebSBarry Smith     ierr = ISDestroy(&isnumb);CHKERRQ(ierr);
1519fcfd50ebSBarry Smith     ierr = ISDestroy(&ispart);CHKERRQ(ierr);
1520b1a0a8a3SJed Brown   }
15216a4f0f73SDmitry Karpeev   *iis = is;
15228f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
15238f3b4b4dSDmitry Karpeev }
15248f3b4b4dSDmitry Karpeev 
15258f3b4b4dSDmitry Karpeev #undef __FUNCT__
15268f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMCreateStraddlingSubdomains"
1527b541e6a4SDmitry Karpeev PETSC_INTERN PetscErrorCode  PCGASMCreateStraddlingSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
15288f3b4b4dSDmitry Karpeev {
15298f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
15308f3b4b4dSDmitry Karpeev 
15318f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
15328f3b4b4dSDmitry Karpeev   ierr = MatSubdomainsCreateCoalesce(A,N,n,iis);CHKERRQ(ierr);
15338f3b4b4dSDmitry Karpeev   PetscFunctionReturn(0);
15348f3b4b4dSDmitry Karpeev }
15358f3b4b4dSDmitry Karpeev 
15368f3b4b4dSDmitry Karpeev 
15378f3b4b4dSDmitry Karpeev 
15388f3b4b4dSDmitry Karpeev #undef __FUNCT__
15398f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMCreateSubdomains"
15408f3b4b4dSDmitry Karpeev /*@C
15418f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains - Creates n index sets defining n nonoverlapping subdomains for the additive
15428f3b4b4dSDmitry Karpeev    Schwarz preconditioner for a any problem based on its matrix.
15438f3b4b4dSDmitry Karpeev 
15448f3b4b4dSDmitry Karpeev    Collective
15458f3b4b4dSDmitry Karpeev 
15468f3b4b4dSDmitry Karpeev    Input Parameters:
15478f3b4b4dSDmitry Karpeev +  A       - The global matrix operator
15488f3b4b4dSDmitry Karpeev -  N       - the number of global subdomains requested
15498f3b4b4dSDmitry Karpeev 
15508f3b4b4dSDmitry Karpeev    Output Parameters:
15518f3b4b4dSDmitry Karpeev +  n   - the number of subdomains created on this processor
15528f3b4b4dSDmitry Karpeev -  iis - the array of index sets defining the local inner subdomains (on which the correction is applied)
15538f3b4b4dSDmitry Karpeev 
15548f3b4b4dSDmitry Karpeev    Level: advanced
15558f3b4b4dSDmitry Karpeev 
15568f3b4b4dSDmitry Karpeev    Note: When N >= A's communicator size, each subdomain is local -- contained within a single processor.
15578f3b4b4dSDmitry Karpeev          When N < size, the subdomains are 'straddling' (processor boundaries) and are no longer local.
15588f3b4b4dSDmitry Karpeev          The resulting subdomains can be use in PCGASMSetSubdomains(pc,n,iss,NULL).  The overlapping
15598f3b4b4dSDmitry Karpeev 	 outer subdomains will be automatically generated from these according to the requested amount of
15608f3b4b4dSDmitry Karpeev 	 overlap; this is currently supported only with local subdomains.
15618f3b4b4dSDmitry Karpeev 
15628f3b4b4dSDmitry Karpeev 
15638f3b4b4dSDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, unstructured grid
15648f3b4b4dSDmitry Karpeev 
15658f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMDestroySubdomains()
15668f3b4b4dSDmitry Karpeev @*/
1567b541e6a4SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains(Mat A,PetscInt N,PetscInt *n,IS *iis[])
15688f3b4b4dSDmitry Karpeev {
15698f3b4b4dSDmitry Karpeev   PetscMPIInt     size;
15708f3b4b4dSDmitry Karpeev   PetscErrorCode  ierr;
15718f3b4b4dSDmitry Karpeev 
15728f3b4b4dSDmitry Karpeev   PetscFunctionBegin;
15738f3b4b4dSDmitry Karpeev   PetscValidHeaderSpecific(A,MAT_CLASSID,1);
15748f3b4b4dSDmitry Karpeev   PetscValidPointer(iis,4);
15758f3b4b4dSDmitry Karpeev 
15768f3b4b4dSDmitry Karpeev   if (N < 1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"Number of subdomains must be > 0, N = %D",N);
15778f3b4b4dSDmitry Karpeev   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)A),&size);CHKERRQ(ierr);
15788f3b4b4dSDmitry Karpeev   if (N >= size) {
15798f3b4b4dSDmitry Karpeev     *n = N/size + (N%size);
15808f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateLocalSubdomains(A,*n,iis);CHKERRQ(ierr);
15816a4f0f73SDmitry Karpeev   } else {
15828f3b4b4dSDmitry Karpeev     ierr = PCGASMCreateStraddlingSubdomains(A,N,n,iis);CHKERRQ(ierr);
15836a4f0f73SDmitry Karpeev   }
1584b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1585b1a0a8a3SJed Brown }
1586b1a0a8a3SJed Brown 
1587b1a0a8a3SJed Brown #undef __FUNCT__
1588f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMDestroySubdomains"
1589b1a0a8a3SJed Brown /*@C
1590f746d493SDmitry Karpeev    PCGASMDestroySubdomains - Destroys the index sets created with
15918f3b4b4dSDmitry Karpeev    PCGASMCreateSubdomains() or PCGASMCreateSubdomains2D. Should be
159206b43e7eSDmitry Karpeev    called after setting subdomains with PCGASMSetSubdomains().
1593b1a0a8a3SJed Brown 
1594b1a0a8a3SJed Brown    Collective
1595b1a0a8a3SJed Brown 
1596b1a0a8a3SJed Brown    Input Parameters:
1597b1a0a8a3SJed Brown +  n   - the number of index sets
15986a4f0f73SDmitry Karpeev .  iis - the array of inner subdomains,
15990298fd71SBarry Smith -  ois - the array of outer subdomains, can be NULL
1600b1a0a8a3SJed Brown 
16016a4f0f73SDmitry Karpeev    Level: intermediate
16026a4f0f73SDmitry Karpeev 
16036a4f0f73SDmitry Karpeev    Notes: this is merely a convenience subroutine that walks each list,
16042c112581SDmitry Karpeev    destroys each IS on the list, and then frees the list. At the end the
16052c112581SDmitry Karpeev    list pointers are set to NULL.
1606b1a0a8a3SJed Brown 
1607f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, unstructured grid
1608b1a0a8a3SJed Brown 
16098f3b4b4dSDmitry Karpeev .seealso: PCGASMCreateSubdomains(), PCGASMSetSubdomains()
1610b1a0a8a3SJed Brown @*/
16112c112581SDmitry Karpeev PetscErrorCode  PCGASMDestroySubdomains(PetscInt n,IS **iis,IS **ois)
1612b1a0a8a3SJed Brown {
1613b1a0a8a3SJed Brown   PetscInt       i;
1614b1a0a8a3SJed Brown   PetscErrorCode ierr;
16155fd66863SKarl Rupp 
1616b1a0a8a3SJed Brown   PetscFunctionBegin;
1617a35b7b57SDmitry Karpeev   if (n <= 0) PetscFunctionReturn(0);
16186a4f0f73SDmitry Karpeev   if (ois) {
16192c112581SDmitry Karpeev     PetscValidPointer(ois,3);
16202c112581SDmitry Karpeev     if (*ois) {
16212c112581SDmitry Karpeev       PetscValidPointer(*ois,3);
1622a35b7b57SDmitry Karpeev       for (i=0; i<n; i++) {
16232c112581SDmitry Karpeev         ierr = ISDestroy(&(*ois)[i]);CHKERRQ(ierr);
1624a35b7b57SDmitry Karpeev       }
1625135757f6SDmitry Karpeev       ierr = PetscFree((*ois));CHKERRQ(ierr);
16262c112581SDmitry Karpeev     }
1627b1a0a8a3SJed Brown   }
1628b9d0fdaaSFande Kong   if (iis) {
1629b9d0fdaaSFande Kong     PetscValidPointer(iis,2);
1630b9d0fdaaSFande Kong     if (*iis) {
1631b9d0fdaaSFande Kong       PetscValidPointer(*iis,2);
1632b9d0fdaaSFande Kong       for (i=0; i<n; i++) {
1633b9d0fdaaSFande Kong         ierr = ISDestroy(&(*iis)[i]);CHKERRQ(ierr);
1634b9d0fdaaSFande Kong       }
1635b9d0fdaaSFande Kong       ierr = PetscFree((*iis));CHKERRQ(ierr);
1636b9d0fdaaSFande Kong     }
1637b9d0fdaaSFande Kong   }
1638b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1639b1a0a8a3SJed Brown }
1640b1a0a8a3SJed Brown 
1641af538404SDmitry Karpeev 
1642af538404SDmitry Karpeev #define PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,xleft_loc,ylow_loc,xright_loc,yhigh_loc,n) \
1643af538404SDmitry Karpeev   {                                                                                                       \
1644af538404SDmitry Karpeev     PetscInt first_row = first/M, last_row = last/M+1;                                                     \
1645af538404SDmitry Karpeev     /*                                                                                                    \
1646af538404SDmitry Karpeev      Compute ylow_loc and yhigh_loc so that (ylow_loc,xleft) and (yhigh_loc,xright) are the corners       \
1647af538404SDmitry Karpeev      of the bounding box of the intersection of the subdomain with the local ownership range (local       \
1648af538404SDmitry Karpeev      subdomain).                                                                                          \
1649af538404SDmitry Karpeev      Also compute xleft_loc and xright_loc as the lower and upper bounds on the first and last rows       \
1650af538404SDmitry Karpeev      of the intersection.                                                                                 \
1651af538404SDmitry Karpeev     */                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             \
1652af538404SDmitry Karpeev     /* ylow_loc is the grid row containing the first element of the local sumbdomain */                   \
1653eec7e3faSDmitry Karpeev     *ylow_loc = PetscMax(first_row,ylow);                                                                    \
1654af538404SDmitry Karpeev     /* xleft_loc is the offset of first element of the local subdomain within its grid row (might actually be outside the local subdomain) */ \
1655eec7e3faSDmitry Karpeev     *xleft_loc = *ylow_loc==first_row ? PetscMax(first%M,xleft) : xleft;                                                                            \
1656af538404SDmitry Karpeev     /* yhigh_loc is the grid row above the last local subdomain element */                                                                    \
1657eec7e3faSDmitry Karpeev     *yhigh_loc = PetscMin(last_row,yhigh);                                                                                                     \
1658af538404SDmitry Karpeev     /* xright is the offset of the end of the  local subdomain within its grid row (might actually be outside the local subdomain) */         \
1659eec7e3faSDmitry Karpeev     *xright_loc = *yhigh_loc==last_row ? PetscMin(xright,last%M) : xright;                                                                          \
1660af538404SDmitry Karpeev     /* Now compute the size of the local subdomain n. */ \
1661c3518bceSDmitry Karpeev     *n = 0;                                               \
1662eec7e3faSDmitry Karpeev     if (*ylow_loc < *yhigh_loc) {                           \
1663af538404SDmitry Karpeev       PetscInt width = xright-xleft;                     \
1664eec7e3faSDmitry Karpeev       *n += width*(*yhigh_loc-*ylow_loc-1);                 \
1665eec7e3faSDmitry Karpeev       *n += PetscMin(PetscMax(*xright_loc-xleft,0),width); \
1666eec7e3faSDmitry Karpeev       *n -= PetscMin(PetscMax(*xleft_loc-xleft,0), width); \
1667af538404SDmitry Karpeev     } \
1668af538404SDmitry Karpeev   }
1669af538404SDmitry Karpeev 
1670c3518bceSDmitry Karpeev 
1671eec7e3faSDmitry Karpeev 
1672eec7e3faSDmitry Karpeev #undef __FUNCT__
1673f746d493SDmitry Karpeev #define __FUNCT__ "PCGASMCreateSubdomains2D"
1674b1a0a8a3SJed Brown /*@
1675f746d493SDmitry Karpeev    PCGASMCreateSubdomains2D - Creates the index sets for the overlapping Schwarz
1676b1a0a8a3SJed Brown    preconditioner for a two-dimensional problem on a regular grid.
1677b1a0a8a3SJed Brown 
1678af538404SDmitry Karpeev    Collective
1679b1a0a8a3SJed Brown 
1680b1a0a8a3SJed Brown    Input Parameters:
168106b43e7eSDmitry Karpeev +  M, N               - the global number of grid points in the x and y directions
1682af538404SDmitry Karpeev .  Mdomains, Ndomains - the global number of subdomains in the x and y directions
1683b1a0a8a3SJed Brown .  dof                - degrees of freedom per node
1684b1a0a8a3SJed Brown -  overlap            - overlap in mesh lines
1685b1a0a8a3SJed Brown 
1686b1a0a8a3SJed Brown    Output Parameters:
1687af538404SDmitry Karpeev +  Nsub - the number of local subdomains created
16886a4f0f73SDmitry Karpeev .  iis  - array of index sets defining inner (nonoverlapping) subdomains
16896a4f0f73SDmitry Karpeev -  ois  - array of index sets defining outer (overlapping, if overlap > 0) subdomains
1690b1a0a8a3SJed Brown 
1691b1a0a8a3SJed Brown 
1692b1a0a8a3SJed Brown    Level: advanced
1693b1a0a8a3SJed Brown 
1694f746d493SDmitry Karpeev .keywords: PC, GASM, additive Schwarz, create, subdomains, 2D, regular grid
1695b1a0a8a3SJed Brown 
16968f3b4b4dSDmitry Karpeev .seealso: PCGASMSetSubdomains(), PCGASMGetSubKSP(), PCGASMSetOverlap()
1697b1a0a8a3SJed Brown @*/
16986a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMCreateSubdomains2D(PC pc,PetscInt M,PetscInt N,PetscInt Mdomains,PetscInt Ndomains,PetscInt dof,PetscInt overlap,PetscInt *nsub,IS **iis,IS **ois)
1699b1a0a8a3SJed Brown {
1700b1a0a8a3SJed Brown   PetscErrorCode ierr;
17012bbb417fSDmitry Karpeev   PetscMPIInt    size, rank;
17022bbb417fSDmitry Karpeev   PetscInt       i, j;
17032bbb417fSDmitry Karpeev   PetscInt       maxheight, maxwidth;
17042bbb417fSDmitry Karpeev   PetscInt       xstart, xleft, xright, xleft_loc, xright_loc;
17052bbb417fSDmitry Karpeev   PetscInt       ystart, ylow,  yhigh,  ylow_loc,  yhigh_loc;
1706eec7e3faSDmitry Karpeev   PetscInt       x[2][2], y[2][2], n[2];
17072bbb417fSDmitry Karpeev   PetscInt       first, last;
17082bbb417fSDmitry Karpeev   PetscInt       nidx, *idx;
17092bbb417fSDmitry Karpeev   PetscInt       ii,jj,s,q,d;
1710af538404SDmitry Karpeev   PetscInt       k,kk;
17112bbb417fSDmitry Karpeev   PetscMPIInt    color;
17122bbb417fSDmitry Karpeev   MPI_Comm       comm, subcomm;
17136a4f0f73SDmitry Karpeev   IS             **xis = 0, **is = ois, **is_local = iis;
1714d34fcf5fSBarry Smith 
1715b1a0a8a3SJed Brown   PetscFunctionBegin;
17162bbb417fSDmitry Karpeev   ierr = PetscObjectGetComm((PetscObject)pc, &comm);CHKERRQ(ierr);
17172bbb417fSDmitry Karpeev   ierr = MPI_Comm_size(comm, &size);CHKERRQ(ierr);
17182bbb417fSDmitry Karpeev   ierr = MPI_Comm_rank(comm, &rank);CHKERRQ(ierr);
17192bbb417fSDmitry Karpeev   ierr = MatGetOwnershipRange(pc->pmat, &first, &last);CHKERRQ(ierr);
1720d34fcf5fSBarry 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) "
17212bbb417fSDmitry Karpeev                                       "does not respect the number of degrees of freedom per grid point %D", first, last, dof);
1722d34fcf5fSBarry Smith 
1723af538404SDmitry Karpeev   /* Determine the number of domains with nonzero intersections with the local ownership range. */
17242bbb417fSDmitry Karpeev   s      = 0;
1725af538404SDmitry Karpeev   ystart = 0;
1726af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1727af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1728af538404SDmitry 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);
1729eec7e3faSDmitry Karpeev     /* Vertical domain limits with an overlap. */
1730eec7e3faSDmitry Karpeev     ylow   = PetscMax(ystart - overlap,0);
1731eec7e3faSDmitry Karpeev     yhigh  = PetscMin(ystart + maxheight + overlap,N);
1732b1a0a8a3SJed Brown     xstart = 0;
1733af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1734af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1735af538404SDmitry 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);
1736eec7e3faSDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1737eec7e3faSDmitry Karpeev       xleft  = PetscMax(xstart - overlap,0);
1738eec7e3faSDmitry Karpeev       xright = PetscMin(xstart + maxwidth + overlap,M);
1739af538404SDmitry Karpeev       /*
1740af538404SDmitry Karpeev          Determine whether this subdomain intersects this processor's ownership range of pc->pmat.
1741af538404SDmitry Karpeev       */
1742c3518bceSDmitry Karpeev       PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
17432fa5cd67SKarl Rupp       if (nidx) ++s;
1744af538404SDmitry Karpeev       xstart += maxwidth;
1745af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
1746af538404SDmitry Karpeev     ystart += maxheight;
1747af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
17482fa5cd67SKarl Rupp 
1749af538404SDmitry Karpeev   /* Now we can allocate the necessary number of ISs. */
1750af538404SDmitry Karpeev   *nsub  = s;
1751854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is);CHKERRQ(ierr);
1752854ce69bSBarry Smith   ierr   = PetscMalloc1(*nsub,is_local);CHKERRQ(ierr);
1753af538404SDmitry Karpeev   s      = 0;
1754af538404SDmitry Karpeev   ystart = 0;
1755af538404SDmitry Karpeev   for (j=0; j<Ndomains; ++j) {
1756af538404SDmitry Karpeev     maxheight = N/Ndomains + ((N % Ndomains) > j); /* Maximal height of subdomain */
1757af538404SDmitry 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);
1758af538404SDmitry Karpeev     /* Vertical domain limits with an overlap. */
1759eec7e3faSDmitry Karpeev     y[0][0] = PetscMax(ystart - overlap,0);
1760eec7e3faSDmitry Karpeev     y[0][1] = PetscMin(ystart + maxheight + overlap,N);
1761eec7e3faSDmitry Karpeev     /* Vertical domain limits without an overlap. */
1762eec7e3faSDmitry Karpeev     y[1][0] = ystart;
1763eec7e3faSDmitry Karpeev     y[1][1] = PetscMin(ystart + maxheight,N);
1764eec7e3faSDmitry Karpeev     xstart  = 0;
1765af538404SDmitry Karpeev     for (i=0; i<Mdomains; ++i) {
1766af538404SDmitry Karpeev       maxwidth = M/Mdomains + ((M % Mdomains) > i); /* Maximal width of subdomain */
1767af538404SDmitry 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);
1768af538404SDmitry Karpeev       /* Horizontal domain limits with an overlap. */
1769eec7e3faSDmitry Karpeev       x[0][0] = PetscMax(xstart - overlap,0);
1770eec7e3faSDmitry Karpeev       x[0][1] = PetscMin(xstart + maxwidth + overlap,M);
1771eec7e3faSDmitry Karpeev       /* Horizontal domain limits without an overlap. */
1772eec7e3faSDmitry Karpeev       x[1][0] = xstart;
1773eec7e3faSDmitry Karpeev       x[1][1] = PetscMin(xstart+maxwidth,M);
17742bbb417fSDmitry Karpeev       /*
17752bbb417fSDmitry Karpeev          Determine whether this domain intersects this processor's ownership range of pc->pmat.
17762bbb417fSDmitry Karpeev          Do this twice: first for the domains with overlaps, and once without.
17772bbb417fSDmitry Karpeev          During the first pass create the subcommunicators, and use them on the second pass as well.
17782bbb417fSDmitry Karpeev       */
17792bbb417fSDmitry Karpeev       for (q = 0; q < 2; ++q) {
1780cc96b2e5SBarry Smith         PetscBool split = PETSC_FALSE;
17812bbb417fSDmitry Karpeev         /*
17822bbb417fSDmitry Karpeev           domain limits, (xleft, xright) and (ylow, yheigh) are adjusted
17832bbb417fSDmitry Karpeev           according to whether the domain with an overlap or without is considered.
17842bbb417fSDmitry Karpeev         */
17852bbb417fSDmitry Karpeev         xleft = x[q][0]; xright = x[q][1];
17862bbb417fSDmitry Karpeev         ylow  = y[q][0]; yhigh  = y[q][1];
1787c3518bceSDmitry Karpeev         PCGASMLocalSubdomainBounds2D(M,N,xleft,ylow,xright,yhigh,first,last,(&xleft_loc),(&ylow_loc),(&xright_loc),(&yhigh_loc),(&nidx));
1788af538404SDmitry Karpeev         nidx *= dof;
1789eec7e3faSDmitry Karpeev         n[q]  = nidx;
17902bbb417fSDmitry Karpeev         /*
1791eec7e3faSDmitry Karpeev          Based on the counted number of indices in the local domain *with an overlap*,
1792af538404SDmitry Karpeev          construct a subcommunicator of all the processors supporting this domain.
1793eec7e3faSDmitry Karpeev          Observe that a domain with an overlap might have nontrivial local support,
1794eec7e3faSDmitry Karpeev          while the domain without an overlap might not.  Hence, the decision to participate
1795eec7e3faSDmitry Karpeev          in the subcommunicator must be based on the domain with an overlap.
17962bbb417fSDmitry Karpeev          */
17972bbb417fSDmitry Karpeev         if (q == 0) {
17982fa5cd67SKarl Rupp           if (nidx) color = 1;
17992fa5cd67SKarl Rupp           else color = MPI_UNDEFINED;
18002bbb417fSDmitry Karpeev           ierr = MPI_Comm_split(comm, color, rank, &subcomm);CHKERRQ(ierr);
1801cc96b2e5SBarry Smith           split = PETSC_TRUE;
18022bbb417fSDmitry Karpeev         }
1803af538404SDmitry Karpeev         /*
1804eec7e3faSDmitry Karpeev          Proceed only if the number of local indices *with an overlap* is nonzero.
1805af538404SDmitry Karpeev          */
1806eec7e3faSDmitry Karpeev         if (n[0]) {
18072fa5cd67SKarl Rupp           if (q == 0) xis = is;
1808af538404SDmitry Karpeev           if (q == 1) {
1809af538404SDmitry Karpeev             /*
1810eec7e3faSDmitry Karpeev              The IS for the no-overlap subdomain shares a communicator with the overlapping domain.
1811af538404SDmitry Karpeev              Moreover, if the overlap is zero, the two ISs are identical.
1812af538404SDmitry Karpeev              */
1813b1a0a8a3SJed Brown             if (overlap == 0) {
1814eec7e3faSDmitry Karpeev               (*is_local)[s] = (*is)[s];
18152bbb417fSDmitry Karpeev               ierr           = PetscObjectReference((PetscObject)(*is)[s]);CHKERRQ(ierr);
18162bbb417fSDmitry Karpeev               continue;
1817d34fcf5fSBarry Smith             } else {
18186a4f0f73SDmitry Karpeev               xis     = is_local;
1819eec7e3faSDmitry Karpeev               subcomm = ((PetscObject)(*is)[s])->comm;
18202bbb417fSDmitry Karpeev             }
1821af538404SDmitry Karpeev           } /* if (q == 1) */
18220298fd71SBarry Smith           idx  = NULL;
1823785e854fSJed Brown           ierr = PetscMalloc1(nidx,&idx);CHKERRQ(ierr);
1824eec7e3faSDmitry Karpeev           if (nidx) {
18252bbb417fSDmitry Karpeev             k = 0;
18262bbb417fSDmitry Karpeev             for (jj=ylow_loc; jj<yhigh_loc; ++jj) {
1827af538404SDmitry Karpeev               PetscInt x0 = (jj==ylow_loc) ? xleft_loc : xleft;
1828af538404SDmitry Karpeev               PetscInt x1 = (jj==yhigh_loc-1) ? xright_loc : xright;
1829af538404SDmitry Karpeev               kk = dof*(M*jj + x0);
18302bbb417fSDmitry Karpeev               for (ii=x0; ii<x1; ++ii) {
18312bbb417fSDmitry Karpeev                 for (d = 0; d < dof; ++d) {
18322bbb417fSDmitry Karpeev                   idx[k++] = kk++;
1833b1a0a8a3SJed Brown                 }
1834b1a0a8a3SJed Brown               }
1835b1a0a8a3SJed Brown             }
1836eec7e3faSDmitry Karpeev           }
18376a4f0f73SDmitry Karpeev           ierr = ISCreateGeneral(subcomm,nidx,idx,PETSC_OWN_POINTER,(*xis)+s);CHKERRQ(ierr);
1838cc96b2e5SBarry Smith           if (split) {
1839cc96b2e5SBarry Smith             ierr = MPI_Comm_free(&subcomm);CHKERRQ(ierr);
1840cc96b2e5SBarry Smith           }
1841eec7e3faSDmitry Karpeev         }/* if (n[0]) */
18422bbb417fSDmitry Karpeev       }/* for (q = 0; q < 2; ++q) */
18432fa5cd67SKarl Rupp       if (n[0]) ++s;
1844af538404SDmitry Karpeev       xstart += maxwidth;
1845af538404SDmitry Karpeev     } /* for (i = 0; i < Mdomains; ++i) */
18462bbb417fSDmitry Karpeev     ystart += maxheight;
1847af538404SDmitry Karpeev   } /* for (j = 0; j < Ndomains; ++j) */
1848b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1849b1a0a8a3SJed Brown }
1850b1a0a8a3SJed Brown 
1851b1a0a8a3SJed Brown #undef __FUNCT__
185206b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMGetSubdomains"
1853b1a0a8a3SJed Brown /*@C
185406b43e7eSDmitry Karpeev     PCGASMGetSubdomains - Gets the subdomains supported on this processor
185506b43e7eSDmitry Karpeev     for the additive Schwarz preconditioner.
1856b1a0a8a3SJed Brown 
1857b1a0a8a3SJed Brown     Not Collective
1858b1a0a8a3SJed Brown 
1859b1a0a8a3SJed Brown     Input Parameter:
1860b1a0a8a3SJed Brown .   pc - the preconditioner context
1861b1a0a8a3SJed Brown 
1862b1a0a8a3SJed Brown     Output Parameters:
1863b1a0a8a3SJed Brown +   n   - the number of subdomains for this processor (default value = 1)
18640298fd71SBarry Smith .   iis - the index sets that define the inner subdomains (without overlap) supported on this processor (can be NULL)
18650298fd71SBarry Smith -   ois - the index sets that define the outer subdomains (with overlap) supported on this processor (can be NULL)
1866b1a0a8a3SJed Brown 
1867b1a0a8a3SJed Brown 
1868b1a0a8a3SJed Brown     Notes:
18696a4f0f73SDmitry Karpeev     The user is responsible for destroying the ISs and freeing the returned arrays.
1870b1a0a8a3SJed Brown     The IS numbering is in the parallel, global numbering of the vector.
1871b1a0a8a3SJed Brown 
1872b1a0a8a3SJed Brown     Level: advanced
1873b1a0a8a3SJed Brown 
187406b43e7eSDmitry Karpeev .keywords: PC, GASM, get, subdomains, additive Schwarz
1875b1a0a8a3SJed Brown 
18768f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(), PCGASMCreateSubdomains2D(),
18778f3b4b4dSDmitry Karpeev           PCGASMSetSubdomains(), PCGASMGetSubmatrices()
1878b1a0a8a3SJed Brown @*/
18796a4f0f73SDmitry Karpeev PetscErrorCode  PCGASMGetSubdomains(PC pc,PetscInt *n,IS *iis[],IS *ois[])
1880b1a0a8a3SJed Brown {
1881f746d493SDmitry Karpeev   PC_GASM        *osm;
1882b1a0a8a3SJed Brown   PetscErrorCode ierr;
1883b1a0a8a3SJed Brown   PetscBool      match;
18846a4f0f73SDmitry Karpeev   PetscInt       i;
18855fd66863SKarl Rupp 
1886b1a0a8a3SJed Brown   PetscFunctionBegin;
1887b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1888251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1889ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Incorrect object type: expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1890f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1891ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
18926a4f0f73SDmitry Karpeev   if (iis) {
1893785e854fSJed Brown     ierr = PetscMalloc1(osm->n, iis);CHKERRQ(ierr);
18946a4f0f73SDmitry Karpeev   }
18956a4f0f73SDmitry Karpeev   if (ois) {
1896785e854fSJed Brown     ierr = PetscMalloc1(osm->n, ois);CHKERRQ(ierr);
18976a4f0f73SDmitry Karpeev   }
18986a4f0f73SDmitry Karpeev   if (iis || ois) {
18996a4f0f73SDmitry Karpeev     for (i = 0; i < osm->n; ++i) {
19006a4f0f73SDmitry Karpeev       if (iis) (*iis)[i] = osm->iis[i];
19016a4f0f73SDmitry Karpeev       if (ois) (*ois)[i] = osm->ois[i];
19026a4f0f73SDmitry Karpeev     }
1903b1a0a8a3SJed Brown   }
1904b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1905b1a0a8a3SJed Brown }
1906b1a0a8a3SJed Brown 
1907b1a0a8a3SJed Brown #undef __FUNCT__
190806b43e7eSDmitry Karpeev #define __FUNCT__ "PCGASMGetSubmatrices"
1909b1a0a8a3SJed Brown /*@C
191006b43e7eSDmitry Karpeev     PCGASMGetSubmatrices - Gets the local submatrices (for this processor
1911b1a0a8a3SJed Brown     only) for the additive Schwarz preconditioner.
1912b1a0a8a3SJed Brown 
1913b1a0a8a3SJed Brown     Not Collective
1914b1a0a8a3SJed Brown 
1915b1a0a8a3SJed Brown     Input Parameter:
1916b1a0a8a3SJed Brown .   pc - the preconditioner context
1917b1a0a8a3SJed Brown 
1918b1a0a8a3SJed Brown     Output Parameters:
1919b1a0a8a3SJed Brown +   n   - the number of matrices for this processor (default value = 1)
1920b1a0a8a3SJed Brown -   mat - the matrices
1921b1a0a8a3SJed Brown 
192206b43e7eSDmitry Karpeev     Notes: matrices returned by this routine have the same communicators as the index sets (IS)
19238f3b4b4dSDmitry Karpeev            used to define subdomains in PCGASMSetSubdomains()
1924b1a0a8a3SJed Brown     Level: advanced
1925b1a0a8a3SJed Brown 
1926f746d493SDmitry Karpeev .keywords: PC, GASM, set, local, subdomains, additive Schwarz, block Jacobi
1927b1a0a8a3SJed Brown 
19288f3b4b4dSDmitry Karpeev .seealso: PCGASMSetOverlap(), PCGASMGetSubKSP(),
192906b43e7eSDmitry Karpeev           PCGASMCreateSubdomains2D(), PCGASMSetSubdomains(), PCGASMGetSubdomains()
1930b1a0a8a3SJed Brown @*/
193106b43e7eSDmitry Karpeev PetscErrorCode  PCGASMGetSubmatrices(PC pc,PetscInt *n,Mat *mat[])
1932b1a0a8a3SJed Brown {
1933f746d493SDmitry Karpeev   PC_GASM        *osm;
1934b1a0a8a3SJed Brown   PetscErrorCode ierr;
1935b1a0a8a3SJed Brown   PetscBool      match;
1936b1a0a8a3SJed Brown 
1937b1a0a8a3SJed Brown   PetscFunctionBegin;
1938b1a0a8a3SJed Brown   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1939b1a0a8a3SJed Brown   PetscValidIntPointer(n,2);
1940b1a0a8a3SJed Brown   if (mat) PetscValidPointer(mat,3);
1941ce94432eSBarry Smith   if (!pc->setupcalled) SETERRQ(PetscObjectComm((PetscObject)pc),PETSC_ERR_ARG_WRONGSTATE,"Must call after KSPSetUP() or PCSetUp().");
1942251f4c67SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1943ce94432eSBarry Smith   if (!match) SETERRQ2(PetscObjectComm((PetscObject)pc), PETSC_ERR_ARG_WRONG, "Expected %s, got %s instead", PCGASM, ((PetscObject)pc)->type_name);
1944f746d493SDmitry Karpeev   osm = (PC_GASM*)pc->data;
1945ab3e923fSDmitry Karpeev   if (n) *n = osm->n;
1946b1a0a8a3SJed Brown   if (mat) *mat = osm->pmat;
1947b1a0a8a3SJed Brown   PetscFunctionReturn(0);
1948b1a0a8a3SJed Brown }
1949d709ea83SDmitry Karpeev 
1950d709ea83SDmitry Karpeev #undef __FUNCT__
19518f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMSetUseDMSubdomains"
1952d709ea83SDmitry Karpeev /*@
19538f3b4b4dSDmitry Karpeev     PCGASMSetUseDMSubdomains - Indicates whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1954d709ea83SDmitry Karpeev     Logically Collective
1955d709ea83SDmitry Karpeev 
1956d709ea83SDmitry Karpeev     Input Parameter:
1957d709ea83SDmitry Karpeev +   pc  - the preconditioner
1958d709ea83SDmitry Karpeev -   flg - boolean indicating whether to use subdomains defined by the DM
1959d709ea83SDmitry Karpeev 
1960d709ea83SDmitry Karpeev     Options Database Key:
19618f3b4b4dSDmitry Karpeev .   -pc_gasm_dm_subdomains -pc_gasm_overlap -pc_gasm_total_subdomains
1962d709ea83SDmitry Karpeev 
1963d709ea83SDmitry Karpeev     Level: intermediate
1964d709ea83SDmitry Karpeev 
1965d709ea83SDmitry Karpeev     Notes:
19668f3b4b4dSDmitry Karpeev     PCGASMSetSubdomains(), PCGASMSetTotalSubdomains() or PCGASMSetOverlap() take precedence over PCGASMSetUseDMSubdomains(),
19678f3b4b4dSDmitry Karpeev     so setting PCGASMSetSubdomains() with nontrivial subdomain ISs or any of PCGASMSetTotalSubdomains() and PCGASMSetOverlap()
19688f3b4b4dSDmitry Karpeev     automatically turns the latter off.
1969d709ea83SDmitry Karpeev 
1970d709ea83SDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
1971d709ea83SDmitry Karpeev 
19728f3b4b4dSDmitry Karpeev .seealso: PCGASMGetUseDMSubdomains(), PCGASMSetSubdomains(), PCGASMSetOverlap()
1973d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
1974d709ea83SDmitry Karpeev @*/
19758f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMSetUseDMSubdomains(PC pc,PetscBool flg)
1976d709ea83SDmitry Karpeev {
1977d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
1978d709ea83SDmitry Karpeev   PetscErrorCode ierr;
1979d709ea83SDmitry Karpeev   PetscBool      match;
1980d709ea83SDmitry Karpeev 
1981d709ea83SDmitry Karpeev   PetscFunctionBegin;
1982d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
1983d709ea83SDmitry Karpeev   PetscValidLogicalCollectiveBool(pc,flg,2);
1984d709ea83SDmitry Karpeev   if (pc->setupcalled) SETERRQ(((PetscObject)pc)->comm,PETSC_ERR_ARG_WRONGSTATE,"Not for a setup PC.");
1985d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
1986d709ea83SDmitry Karpeev   if (match) {
19878f3b4b4dSDmitry Karpeev     if (!osm->user_subdomains && osm->N == PETSC_DETERMINE && osm->overlap < 0) {
1988d709ea83SDmitry Karpeev       osm->dm_subdomains = flg;
1989d709ea83SDmitry Karpeev     }
19908f3b4b4dSDmitry Karpeev   }
1991d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
1992d709ea83SDmitry Karpeev }
1993d709ea83SDmitry Karpeev 
1994d709ea83SDmitry Karpeev #undef __FUNCT__
19958f3b4b4dSDmitry Karpeev #define __FUNCT__ "PCGASMGetUseDMSubdomains"
1996d709ea83SDmitry Karpeev /*@
19978f3b4b4dSDmitry Karpeev     PCGASMGetUseDMSubdomains - Returns flag indicating whether to use DMCreateDomainDecomposition() to define the subdomains, whenever possible.
1998d709ea83SDmitry Karpeev     Not Collective
1999d709ea83SDmitry Karpeev 
2000d709ea83SDmitry Karpeev     Input Parameter:
2001d709ea83SDmitry Karpeev .   pc  - the preconditioner
2002d709ea83SDmitry Karpeev 
2003d709ea83SDmitry Karpeev     Output Parameter:
2004d709ea83SDmitry Karpeev .   flg - boolean indicating whether to use subdomains defined by the DM
2005d709ea83SDmitry Karpeev 
2006d709ea83SDmitry Karpeev     Level: intermediate
2007d709ea83SDmitry Karpeev 
2008d709ea83SDmitry Karpeev .keywords: PC, ASM, DM, set, subdomains, additive Schwarz
2009d709ea83SDmitry Karpeev 
20108f3b4b4dSDmitry Karpeev .seealso: PCGASMSetUseDMSubdomains(), PCGASMSetOverlap()
2011d709ea83SDmitry Karpeev           PCGASMCreateSubdomains2D()
2012d709ea83SDmitry Karpeev @*/
20138f3b4b4dSDmitry Karpeev PetscErrorCode  PCGASMGetUseDMSubdomains(PC pc,PetscBool* flg)
2014d709ea83SDmitry Karpeev {
2015d709ea83SDmitry Karpeev   PC_GASM        *osm = (PC_GASM*)pc->data;
2016d709ea83SDmitry Karpeev   PetscErrorCode ierr;
2017d709ea83SDmitry Karpeev   PetscBool      match;
2018d709ea83SDmitry Karpeev 
2019d709ea83SDmitry Karpeev   PetscFunctionBegin;
2020d709ea83SDmitry Karpeev   PetscValidHeaderSpecific(pc,PC_CLASSID,1);
2021d709ea83SDmitry Karpeev   PetscValidPointer(flg,2);
2022d709ea83SDmitry Karpeev   ierr = PetscObjectTypeCompare((PetscObject)pc,PCGASM,&match);CHKERRQ(ierr);
2023d709ea83SDmitry Karpeev   if (match) {
2024d709ea83SDmitry Karpeev     if (flg) *flg = osm->dm_subdomains;
2025d709ea83SDmitry Karpeev   }
2026d709ea83SDmitry Karpeev   PetscFunctionReturn(0);
2027d709ea83SDmitry Karpeev }
2028