xref: /petsc/src/vec/is/sf/interface/sf.c (revision 4cc19a0c3736bb6cc12f018d87ef63c2c74635cc)
1af0996ceSBarry Smith #include <petsc/private/sfimpl.h> /*I "petscsf.h" I*/
2c4e6a40aSLawrence Mitchell #include <petsc/private/hashseti.h>
395fce210SBarry Smith #include <petscctable.h>
495fce210SBarry Smith 
595fce210SBarry Smith #if defined(PETSC_USE_DEBUG)
695fce210SBarry Smith #  define PetscSFCheckGraphSet(sf,arg) do {                          \
795fce210SBarry Smith     if (PetscUnlikely(!(sf)->graphset))                              \
8dd5b3ca6SJunchao Zhang       SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetGraph() or PetscSFSetGraphWithPattern() on argument %D \"%s\" before %s()",(arg),#sf,PETSC_FUNCTION_NAME); \
995fce210SBarry Smith   } while (0)
1095fce210SBarry Smith #else
1195fce210SBarry Smith #  define PetscSFCheckGraphSet(sf,arg) do {} while (0)
1295fce210SBarry Smith #endif
1395fce210SBarry Smith 
1495fce210SBarry Smith const char *const PetscSFDuplicateOptions[] = {"CONFONLY","RANKS","GRAPH","PetscSFDuplicateOption","PETSCSF_DUPLICATE_",0};
1595fce210SBarry Smith 
168af6ec1cSBarry Smith /*@
1795fce210SBarry Smith    PetscSFCreate - create a star forest communication context
1895fce210SBarry Smith 
19d083f849SBarry Smith    Collective
2095fce210SBarry Smith 
2195fce210SBarry Smith    Input Arguments:
2295fce210SBarry Smith .  comm - communicator on which the star forest will operate
2395fce210SBarry Smith 
2495fce210SBarry Smith    Output Arguments:
2595fce210SBarry Smith .  sf - new star forest context
2695fce210SBarry Smith 
27dd5b3ca6SJunchao Zhang    Options Database Keys:
28dd5b3ca6SJunchao Zhang +  -sf_type basic     -Use MPI persistent Isend/Irecv for communication (Default)
29dd5b3ca6SJunchao Zhang .  -sf_type window    -Use MPI-3 one-sided window for communication
30dd5b3ca6SJunchao Zhang -  -sf_type neighbor  -Use MPI-3 neighborhood collectives for communication
31dd5b3ca6SJunchao Zhang 
3295fce210SBarry Smith    Level: intermediate
3395fce210SBarry Smith 
34dd5b3ca6SJunchao Zhang    Notes:
35dd5b3ca6SJunchao Zhang    When one knows the communication graph is one of the predefined graph, such as MPI_Alltoall, MPI_Allgatherv,
36dd5b3ca6SJunchao Zhang    MPI_Gatherv, one can create a PetscSF and then set its graph with PetscSFSetGraphWithPattern(). These special
37dd5b3ca6SJunchao Zhang    SFs are optimized and they have better performance than general SFs.
38dd5b3ca6SJunchao Zhang 
39dd5b3ca6SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFSetGraphWithPattern(), PetscSFDestroy()
4095fce210SBarry Smith @*/
4195fce210SBarry Smith PetscErrorCode PetscSFCreate(MPI_Comm comm,PetscSF *sf)
4295fce210SBarry Smith {
4395fce210SBarry Smith   PetscErrorCode ierr;
4495fce210SBarry Smith   PetscSF        b;
4595fce210SBarry Smith 
4695fce210SBarry Smith   PetscFunctionBegin;
4795fce210SBarry Smith   PetscValidPointer(sf,2);
48607a6623SBarry Smith   ierr = PetscSFInitializePackage();CHKERRQ(ierr);
4995fce210SBarry Smith 
5073107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(b,PETSCSF_CLASSID,"PetscSF","Star Forest","PetscSF",comm,PetscSFDestroy,PetscSFView);CHKERRQ(ierr);
5195fce210SBarry Smith 
5295fce210SBarry Smith   b->nroots    = -1;
5395fce210SBarry Smith   b->nleaves   = -1;
5429046d53SLisandro Dalcin   b->minleaf   = PETSC_MAX_INT;
5529046d53SLisandro Dalcin   b->maxleaf   = PETSC_MIN_INT;
5695fce210SBarry Smith   b->nranks    = -1;
5795fce210SBarry Smith   b->rankorder = PETSC_TRUE;
5895fce210SBarry Smith   b->ingroup   = MPI_GROUP_NULL;
5995fce210SBarry Smith   b->outgroup  = MPI_GROUP_NULL;
6095fce210SBarry Smith   b->graphset  = PETSC_FALSE;
6195fce210SBarry Smith 
6295fce210SBarry Smith   *sf = b;
6395fce210SBarry Smith   PetscFunctionReturn(0);
6495fce210SBarry Smith }
6595fce210SBarry Smith 
6629046d53SLisandro Dalcin /*@
6795fce210SBarry Smith    PetscSFReset - Reset a star forest so that different sizes or neighbors can be used
6895fce210SBarry Smith 
6995fce210SBarry Smith    Collective
7095fce210SBarry Smith 
7195fce210SBarry Smith    Input Arguments:
7295fce210SBarry Smith .  sf - star forest
7395fce210SBarry Smith 
7495fce210SBarry Smith    Level: advanced
7595fce210SBarry Smith 
7695fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph(), PetscSFDestroy()
7795fce210SBarry Smith @*/
7895fce210SBarry Smith PetscErrorCode PetscSFReset(PetscSF sf)
7995fce210SBarry Smith {
8095fce210SBarry Smith   PetscErrorCode ierr;
8195fce210SBarry Smith 
8295fce210SBarry Smith   PetscFunctionBegin;
8395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
8479715d56SJed Brown   if (sf->ops->Reset) {ierr = (*sf->ops->Reset)(sf);CHKERRQ(ierr);}
8529046d53SLisandro Dalcin   sf->nroots   = -1;
8629046d53SLisandro Dalcin   sf->nleaves  = -1;
8729046d53SLisandro Dalcin   sf->minleaf  = PETSC_MAX_INT;
8829046d53SLisandro Dalcin   sf->maxleaf  = PETSC_MIN_INT;
8995fce210SBarry Smith   sf->mine     = NULL;
9095fce210SBarry Smith   sf->remote   = NULL;
9129046d53SLisandro Dalcin   sf->graphset = PETSC_FALSE;
9229046d53SLisandro Dalcin   ierr = PetscFree(sf->mine_alloc);CHKERRQ(ierr);
9395fce210SBarry Smith   ierr = PetscFree(sf->remote_alloc);CHKERRQ(ierr);
9421c688dcSJed Brown   sf->nranks = -1;
9529046d53SLisandro Dalcin   ierr = PetscFree4(sf->ranks,sf->roffset,sf->rmine,sf->rremote);CHKERRQ(ierr);
96eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
97eb02082bSJunchao Zhang   if (sf->rmine_d) {cudaError_t err = cudaFree(sf->rmine_d);CHKERRCUDA(err);sf->rmine_d=NULL;}
98eb02082bSJunchao Zhang #endif
9929046d53SLisandro Dalcin   sf->degreeknown = PETSC_FALSE;
10095fce210SBarry Smith   ierr = PetscFree(sf->degree);CHKERRQ(ierr);
10195fce210SBarry Smith   if (sf->ingroup  != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->ingroup);CHKERRQ(ierr);}
10295fce210SBarry Smith   if (sf->outgroup != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->outgroup);CHKERRQ(ierr);}
10395fce210SBarry Smith   ierr = PetscSFDestroy(&sf->multi);CHKERRQ(ierr);
104dd5b3ca6SJunchao Zhang   ierr = PetscLayoutDestroy(&sf->map);CHKERRQ(ierr);
10595fce210SBarry Smith   sf->setupcalled = PETSC_FALSE;
10695fce210SBarry Smith   PetscFunctionReturn(0);
10795fce210SBarry Smith }
10895fce210SBarry Smith 
10995fce210SBarry Smith /*@C
11029046d53SLisandro Dalcin    PetscSFSetType - Set the PetscSF communication implementation
11195fce210SBarry Smith 
11295fce210SBarry Smith    Collective on PetscSF
11395fce210SBarry Smith 
11495fce210SBarry Smith    Input Parameters:
11595fce210SBarry Smith +  sf - the PetscSF context
11695fce210SBarry Smith -  type - a known method
11795fce210SBarry Smith 
11895fce210SBarry Smith    Options Database Key:
11995fce210SBarry Smith .  -sf_type <type> - Sets the method; use -help for a list
12070616304SStefano Zampini    of available methods (for instance, window, basic, neighbor)
12195fce210SBarry Smith 
12295fce210SBarry Smith    Notes:
12395fce210SBarry Smith    See "include/petscsf.h" for available methods (for instance)
12495fce210SBarry Smith +    PETSCSFWINDOW - MPI-2/3 one-sided
12595fce210SBarry Smith -    PETSCSFBASIC - basic implementation using MPI-1 two-sided
12695fce210SBarry Smith 
12795fce210SBarry Smith   Level: intermediate
12895fce210SBarry Smith 
12995fce210SBarry Smith .seealso: PetscSFType, PetscSFCreate()
13095fce210SBarry Smith @*/
13195fce210SBarry Smith PetscErrorCode PetscSFSetType(PetscSF sf,PetscSFType type)
13295fce210SBarry Smith {
13395fce210SBarry Smith   PetscErrorCode ierr,(*r)(PetscSF);
13495fce210SBarry Smith   PetscBool      match;
13595fce210SBarry Smith 
13695fce210SBarry Smith   PetscFunctionBegin;
13795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
13895fce210SBarry Smith   PetscValidCharPointer(type,2);
13995fce210SBarry Smith 
14095fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)sf,type,&match);CHKERRQ(ierr);
14195fce210SBarry Smith   if (match) PetscFunctionReturn(0);
14295fce210SBarry Smith 
143adc40e5bSBarry Smith   ierr = PetscFunctionListFind(PetscSFList,type,&r);CHKERRQ(ierr);
14495fce210SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested PetscSF type %s",type);
14529046d53SLisandro Dalcin   /* Destroy the previous PetscSF implementation context */
14629046d53SLisandro Dalcin   if (sf->ops->Destroy) {ierr = (*(sf)->ops->Destroy)(sf);CHKERRQ(ierr);}
14795fce210SBarry Smith   ierr = PetscMemzero(sf->ops,sizeof(*sf->ops));CHKERRQ(ierr);
14895fce210SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)sf,type);CHKERRQ(ierr);
14995fce210SBarry Smith   ierr = (*r)(sf);CHKERRQ(ierr);
15095fce210SBarry Smith   PetscFunctionReturn(0);
15195fce210SBarry Smith }
15295fce210SBarry Smith 
15329046d53SLisandro Dalcin /*@C
15429046d53SLisandro Dalcin   PetscSFGetType - Get the PetscSF communication implementation
15529046d53SLisandro Dalcin 
15629046d53SLisandro Dalcin   Not Collective
15729046d53SLisandro Dalcin 
15829046d53SLisandro Dalcin   Input Parameter:
15929046d53SLisandro Dalcin . sf  - the PetscSF context
16029046d53SLisandro Dalcin 
16129046d53SLisandro Dalcin   Output Parameter:
16229046d53SLisandro Dalcin . type - the PetscSF type name
16329046d53SLisandro Dalcin 
16429046d53SLisandro Dalcin   Level: intermediate
16529046d53SLisandro Dalcin 
16629046d53SLisandro Dalcin .seealso: PetscSFSetType(), PetscSFCreate()
16729046d53SLisandro Dalcin @*/
16829046d53SLisandro Dalcin PetscErrorCode PetscSFGetType(PetscSF sf, PetscSFType *type)
16929046d53SLisandro Dalcin {
17029046d53SLisandro Dalcin   PetscFunctionBegin;
17129046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID,1);
17229046d53SLisandro Dalcin   PetscValidPointer(type,2);
17329046d53SLisandro Dalcin   *type = ((PetscObject)sf)->type_name;
17429046d53SLisandro Dalcin   PetscFunctionReturn(0);
17529046d53SLisandro Dalcin }
17629046d53SLisandro Dalcin 
177d36d33e4SMatthew G. Knepley /*@
17895fce210SBarry Smith    PetscSFDestroy - destroy star forest
17995fce210SBarry Smith 
18095fce210SBarry Smith    Collective
18195fce210SBarry Smith 
18295fce210SBarry Smith    Input Arguments:
18395fce210SBarry Smith .  sf - address of star forest
18495fce210SBarry Smith 
18595fce210SBarry Smith    Level: intermediate
18695fce210SBarry Smith 
18795fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFReset()
18895fce210SBarry Smith @*/
18995fce210SBarry Smith PetscErrorCode PetscSFDestroy(PetscSF *sf)
19095fce210SBarry Smith {
19195fce210SBarry Smith   PetscErrorCode ierr;
19295fce210SBarry Smith 
19395fce210SBarry Smith   PetscFunctionBegin;
19495fce210SBarry Smith   if (!*sf) PetscFunctionReturn(0);
19595fce210SBarry Smith   PetscValidHeaderSpecific((*sf),PETSCSF_CLASSID,1);
19629046d53SLisandro Dalcin   if (--((PetscObject)(*sf))->refct > 0) {*sf = NULL; PetscFunctionReturn(0);}
19795fce210SBarry Smith   ierr = PetscSFReset(*sf);CHKERRQ(ierr);
19895fce210SBarry Smith   if ((*sf)->ops->Destroy) {ierr = (*(*sf)->ops->Destroy)(*sf);CHKERRQ(ierr);}
19995fce210SBarry Smith   ierr = PetscHeaderDestroy(sf);CHKERRQ(ierr);
20095fce210SBarry Smith   PetscFunctionReturn(0);
20195fce210SBarry Smith }
20295fce210SBarry Smith 
203c4e6a40aSLawrence Mitchell static PetscErrorCode PetscSFCheckGraphValid_Private(PetscSF sf)
204c4e6a40aSLawrence Mitchell {
205c4e6a40aSLawrence Mitchell #if defined(PETSC_USE_DEBUG)
206c4e6a40aSLawrence Mitchell   PetscInt           i, nleaves;
207c4e6a40aSLawrence Mitchell   PetscMPIInt        size;
208c4e6a40aSLawrence Mitchell   const PetscInt    *ilocal;
209c4e6a40aSLawrence Mitchell   const PetscSFNode *iremote;
210c4e6a40aSLawrence Mitchell   PetscErrorCode     ierr;
211c4e6a40aSLawrence Mitchell 
212c4e6a40aSLawrence Mitchell   PetscFunctionBegin;
213c4e6a40aSLawrence Mitchell   if (!sf->graphset) PetscFunctionReturn(0);
214c4e6a40aSLawrence Mitchell   ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
215c4e6a40aSLawrence Mitchell   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRQ(ierr);
216c4e6a40aSLawrence Mitchell   for (i = 0; i < nleaves; i++) {
217c4e6a40aSLawrence Mitchell     const PetscInt rank = iremote[i].rank;
218c4e6a40aSLawrence Mitchell     const PetscInt remote = iremote[i].index;
219c4e6a40aSLawrence Mitchell     const PetscInt leaf = ilocal ? ilocal[i] : i;
220c4e6a40aSLawrence Mitchell     if (rank < 0 || rank >= size) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided rank (%D) for remote %D is invalid, should be in [0, %d)",rank,i,size);
221c4e6a40aSLawrence Mitchell     if (remote < 0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided index (%D) for remote %D is invalid, should be >= 0",remote,i);
222c4e6a40aSLawrence Mitchell     if (leaf < 0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided location (%D) for leaf %D is invalid, should be >= 0",leaf,i);
223c4e6a40aSLawrence Mitchell   }
224c4e6a40aSLawrence Mitchell   PetscFunctionReturn(0);
225c4e6a40aSLawrence Mitchell #else
226c4e6a40aSLawrence Mitchell   PetscFunctionBegin;
227c4e6a40aSLawrence Mitchell   PetscFunctionReturn(0);
228c4e6a40aSLawrence Mitchell #endif
229c4e6a40aSLawrence Mitchell }
230c4e6a40aSLawrence Mitchell 
23195fce210SBarry Smith /*@
23295fce210SBarry Smith    PetscSFSetUp - set up communication structures
23395fce210SBarry Smith 
23495fce210SBarry Smith    Collective
23595fce210SBarry Smith 
23695fce210SBarry Smith    Input Arguments:
23795fce210SBarry Smith .  sf - star forest communication object
23895fce210SBarry Smith 
23995fce210SBarry Smith    Level: beginner
24095fce210SBarry Smith 
24195fce210SBarry Smith .seealso: PetscSFSetFromOptions(), PetscSFSetType()
24295fce210SBarry Smith @*/
24395fce210SBarry Smith PetscErrorCode PetscSFSetUp(PetscSF sf)
24495fce210SBarry Smith {
24595fce210SBarry Smith   PetscErrorCode ierr;
24695fce210SBarry Smith 
24795fce210SBarry Smith   PetscFunctionBegin;
24829046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
24929046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
25095fce210SBarry Smith   if (sf->setupcalled) PetscFunctionReturn(0);
251c4e6a40aSLawrence Mitchell   ierr = PetscSFCheckGraphValid_Private(sf);CHKERRQ(ierr);
25295fce210SBarry Smith   if (!((PetscObject)sf)->type_name) {ierr = PetscSFSetType(sf,PETSCSFBASIC);CHKERRQ(ierr);}
25329046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr);
25495fce210SBarry Smith   if (sf->ops->SetUp) {ierr = (*sf->ops->SetUp)(sf);CHKERRQ(ierr);}
25529046d53SLisandro Dalcin   ierr = PetscLogEventEnd(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr);
25695fce210SBarry Smith   sf->setupcalled = PETSC_TRUE;
25795fce210SBarry Smith   PetscFunctionReturn(0);
25895fce210SBarry Smith }
25995fce210SBarry Smith 
2608af6ec1cSBarry Smith /*@
26195fce210SBarry Smith    PetscSFSetFromOptions - set PetscSF options using the options database
26295fce210SBarry Smith 
26395fce210SBarry Smith    Logically Collective
26495fce210SBarry Smith 
26595fce210SBarry Smith    Input Arguments:
26695fce210SBarry Smith .  sf - star forest
26795fce210SBarry Smith 
26895fce210SBarry Smith    Options Database Keys:
26960263706SJed Brown +  -sf_type              - implementation type, see PetscSFSetType()
27051ccb202SJunchao Zhang .  -sf_rank_order        - sort composite points for gathers and scatters in rank order, gathers are non-deterministic otherwise
27151ccb202SJunchao Zhang -  -sf_use_pinned_buffer - use pinned (nonpagable) memory for send/recv buffers on host when communicating GPU data but GPU-aware MPI is not used.
27251ccb202SJunchao Zhang                            Only available for SF types of basic and neighbor.
27395fce210SBarry Smith 
27495fce210SBarry Smith    Level: intermediate
27595fce210SBarry Smith @*/
27695fce210SBarry Smith PetscErrorCode PetscSFSetFromOptions(PetscSF sf)
27795fce210SBarry Smith {
27895fce210SBarry Smith   PetscSFType    deft;
27995fce210SBarry Smith   char           type[256];
28095fce210SBarry Smith   PetscErrorCode ierr;
28195fce210SBarry Smith   PetscBool      flg;
28295fce210SBarry Smith 
28395fce210SBarry Smith   PetscFunctionBegin;
28495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
28595fce210SBarry Smith   ierr = PetscObjectOptionsBegin((PetscObject)sf);CHKERRQ(ierr);
28695fce210SBarry Smith   deft = ((PetscObject)sf)->type_name ? ((PetscObject)sf)->type_name : PETSCSFBASIC;
28729046d53SLisandro Dalcin   ierr = PetscOptionsFList("-sf_type","PetscSF implementation type","PetscSFSetType",PetscSFList,deft,type,sizeof(type),&flg);CHKERRQ(ierr);
28895fce210SBarry Smith   ierr = PetscSFSetType(sf,flg ? type : deft);CHKERRQ(ierr);
28995fce210SBarry Smith   ierr = PetscOptionsBool("-sf_rank_order","sort composite points for gathers and scatters in rank order, gathers are non-deterministic otherwise","PetscSFSetRankOrder",sf->rankorder,&sf->rankorder,NULL);CHKERRQ(ierr);
290e55864a3SBarry Smith   if (sf->ops->SetFromOptions) {ierr = (*sf->ops->SetFromOptions)(PetscOptionsObject,sf);CHKERRQ(ierr);}
29195fce210SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
29295fce210SBarry Smith   PetscFunctionReturn(0);
29395fce210SBarry Smith }
29495fce210SBarry Smith 
29529046d53SLisandro Dalcin /*@
29695fce210SBarry Smith    PetscSFSetRankOrder - sort multi-points for gathers and scatters by rank order
29795fce210SBarry Smith 
29895fce210SBarry Smith    Logically Collective
29995fce210SBarry Smith 
30095fce210SBarry Smith    Input Arguments:
30195fce210SBarry Smith +  sf - star forest
30295fce210SBarry Smith -  flg - PETSC_TRUE to sort, PETSC_FALSE to skip sorting (lower setup cost, but non-deterministic)
30395fce210SBarry Smith 
30495fce210SBarry Smith    Level: advanced
30595fce210SBarry Smith 
30695fce210SBarry Smith .seealso: PetscSFGatherBegin(), PetscSFScatterBegin()
30795fce210SBarry Smith @*/
30895fce210SBarry Smith PetscErrorCode PetscSFSetRankOrder(PetscSF sf,PetscBool flg)
30995fce210SBarry Smith {
31095fce210SBarry Smith 
31195fce210SBarry Smith   PetscFunctionBegin;
31295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
31395fce210SBarry Smith   PetscValidLogicalCollectiveBool(sf,flg,2);
31495fce210SBarry Smith   if (sf->multi) SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_WRONGSTATE,"Rank ordering must be set before first call to PetscSFGatherBegin() or PetscSFScatterBegin()");
31595fce210SBarry Smith   sf->rankorder = flg;
31695fce210SBarry Smith   PetscFunctionReturn(0);
31795fce210SBarry Smith }
31895fce210SBarry Smith 
3198af6ec1cSBarry Smith /*@
32095fce210SBarry Smith    PetscSFSetGraph - Set a parallel star forest
32195fce210SBarry Smith 
32295fce210SBarry Smith    Collective
32395fce210SBarry Smith 
32495fce210SBarry Smith    Input Arguments:
32595fce210SBarry Smith +  sf - star forest
32695fce210SBarry Smith .  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
32795fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
328c4e6a40aSLawrence Mitchell .  ilocal - locations of leaves in leafdata buffers, pass NULL for contiguous storage (locations must be >= 0, enforced
329c4e6a40aSLawrence Mitchell during setup in debug mode)
33095fce210SBarry Smith .  localmode - copy mode for ilocal
331c4e6a40aSLawrence Mitchell .  iremote - remote locations of root vertices for each leaf on the current process (locations must be >= 0, enforced
332c4e6a40aSLawrence Mitchell during setup in debug mode)
33395fce210SBarry Smith -  remotemode - copy mode for iremote
33495fce210SBarry Smith 
33595fce210SBarry Smith    Level: intermediate
33695fce210SBarry Smith 
33795452b02SPatrick Sanan    Notes:
33895452b02SPatrick Sanan     In Fortran you must use PETSC_COPY_VALUES for localmode and remotemode
33938ab3f8aSBarry Smith 
3402ad1e87fSLisandro Dalcin    Developers Note: Local indices which are the identity permutation in the range [0,nleaves) are discarded as they
3412ad1e87fSLisandro Dalcin    encode contiguous storage. In such case, if localmode is PETSC_OWN_POINTER, the memory is deallocated as it is not
3422ad1e87fSLisandro Dalcin    needed
3432ad1e87fSLisandro Dalcin 
344c4e6a40aSLawrence Mitchell    Developers Note: This object does not necessarily encode a true star forest in the graph theoretic sense, since leaf
345c4e6a40aSLawrence Mitchell    indices are not required to be unique. Some functions, however, rely on unique leaf indices (checked in debug mode).
346c4e6a40aSLawrence Mitchell 
34795fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFGetGraph()
34895fce210SBarry Smith @*/
34995fce210SBarry Smith PetscErrorCode PetscSFSetGraph(PetscSF sf,PetscInt nroots,PetscInt nleaves,const PetscInt *ilocal,PetscCopyMode localmode,const PetscSFNode *iremote,PetscCopyMode remotemode)
35095fce210SBarry Smith {
35195fce210SBarry Smith   PetscErrorCode ierr;
35295fce210SBarry Smith 
35395fce210SBarry Smith   PetscFunctionBegin;
35495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
35529046d53SLisandro Dalcin   if (nleaves > 0 && ilocal) PetscValidIntPointer(ilocal,4);
35629046d53SLisandro Dalcin   if (nleaves > 0) PetscValidPointer(iremote,6);
35729046d53SLisandro Dalcin   if (nroots  < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nroots %D, cannot be negative",nroots);
35895fce210SBarry Smith   if (nleaves < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nleaves %D, cannot be negative",nleaves);
35929046d53SLisandro Dalcin 
3602a67d2daSStefano Zampini   if (sf->nroots >= 0) { /* Reset only if graph already set */
36195fce210SBarry Smith     ierr = PetscSFReset(sf);CHKERRQ(ierr);
3622a67d2daSStefano Zampini   }
3632a67d2daSStefano Zampini 
36429046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
36529046d53SLisandro Dalcin 
36695fce210SBarry Smith   sf->nroots  = nroots;
36795fce210SBarry Smith   sf->nleaves = nleaves;
36829046d53SLisandro Dalcin 
36929046d53SLisandro Dalcin   if (nleaves && ilocal) {
37021c688dcSJed Brown     PetscInt i;
37129046d53SLisandro Dalcin     PetscInt minleaf = PETSC_MAX_INT;
37229046d53SLisandro Dalcin     PetscInt maxleaf = PETSC_MIN_INT;
3732ad1e87fSLisandro Dalcin     int      contiguous = 1;
37429046d53SLisandro Dalcin     for (i=0; i<nleaves; i++) {
37529046d53SLisandro Dalcin       minleaf = PetscMin(minleaf,ilocal[i]);
37629046d53SLisandro Dalcin       maxleaf = PetscMax(maxleaf,ilocal[i]);
3772ad1e87fSLisandro Dalcin       contiguous &= (ilocal[i] == i);
37829046d53SLisandro Dalcin     }
37929046d53SLisandro Dalcin     sf->minleaf = minleaf;
38029046d53SLisandro Dalcin     sf->maxleaf = maxleaf;
3812ad1e87fSLisandro Dalcin     if (contiguous) {
3822ad1e87fSLisandro Dalcin       if (localmode == PETSC_OWN_POINTER) {
3832ad1e87fSLisandro Dalcin         ierr = PetscFree(ilocal);CHKERRQ(ierr);
3842ad1e87fSLisandro Dalcin       }
3852ad1e87fSLisandro Dalcin       ilocal = NULL;
3862ad1e87fSLisandro Dalcin     }
38729046d53SLisandro Dalcin   } else {
38829046d53SLisandro Dalcin     sf->minleaf = 0;
38929046d53SLisandro Dalcin     sf->maxleaf = nleaves - 1;
39029046d53SLisandro Dalcin   }
39129046d53SLisandro Dalcin 
39229046d53SLisandro Dalcin   if (ilocal) {
39395fce210SBarry Smith     switch (localmode) {
39495fce210SBarry Smith     case PETSC_COPY_VALUES:
395785e854fSJed Brown       ierr = PetscMalloc1(nleaves,&sf->mine_alloc);CHKERRQ(ierr);
396580bdb30SBarry Smith       ierr = PetscArraycpy(sf->mine_alloc,ilocal,nleaves);CHKERRQ(ierr);
39795fce210SBarry Smith       sf->mine = sf->mine_alloc;
39895fce210SBarry Smith       break;
39995fce210SBarry Smith     case PETSC_OWN_POINTER:
40095fce210SBarry Smith       sf->mine_alloc = (PetscInt*)ilocal;
40195fce210SBarry Smith       sf->mine       = sf->mine_alloc;
40295fce210SBarry Smith       break;
40395fce210SBarry Smith     case PETSC_USE_POINTER:
40429046d53SLisandro Dalcin       sf->mine_alloc = NULL;
40595fce210SBarry Smith       sf->mine       = (PetscInt*)ilocal;
40695fce210SBarry Smith       break;
40795fce210SBarry Smith     default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown localmode");
40895fce210SBarry Smith     }
40995fce210SBarry Smith   }
41029046d53SLisandro Dalcin 
41195fce210SBarry Smith   switch (remotemode) {
41295fce210SBarry Smith   case PETSC_COPY_VALUES:
413785e854fSJed Brown     ierr = PetscMalloc1(nleaves,&sf->remote_alloc);CHKERRQ(ierr);
414580bdb30SBarry Smith     ierr = PetscArraycpy(sf->remote_alloc,iremote,nleaves);CHKERRQ(ierr);
41595fce210SBarry Smith     sf->remote = sf->remote_alloc;
41695fce210SBarry Smith     break;
41795fce210SBarry Smith   case PETSC_OWN_POINTER:
41895fce210SBarry Smith     sf->remote_alloc = (PetscSFNode*)iremote;
41995fce210SBarry Smith     sf->remote       = sf->remote_alloc;
42095fce210SBarry Smith     break;
42195fce210SBarry Smith   case PETSC_USE_POINTER:
42229046d53SLisandro Dalcin     sf->remote_alloc = NULL;
42395fce210SBarry Smith     sf->remote       = (PetscSFNode*)iremote;
42495fce210SBarry Smith     break;
42595fce210SBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown remotemode");
42695fce210SBarry Smith   }
42795fce210SBarry Smith 
428563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
42929046d53SLisandro Dalcin   sf->graphset = PETSC_TRUE;
43095fce210SBarry Smith   PetscFunctionReturn(0);
43195fce210SBarry Smith }
43295fce210SBarry Smith 
43329046d53SLisandro Dalcin /*@
434dd5b3ca6SJunchao Zhang   PetscSFSetGraphWithPattern - Sets the graph of an SF with a specific pattern
435dd5b3ca6SJunchao Zhang 
436dd5b3ca6SJunchao Zhang   Collective
437dd5b3ca6SJunchao Zhang 
438dd5b3ca6SJunchao Zhang   Input Parameters:
439dd5b3ca6SJunchao Zhang + sf      - The PetscSF
440dd5b3ca6SJunchao Zhang . map     - Layout of roots over all processes (insignificant when pattern is PETSCSF_PATTERN_ALLTOALL)
441dd5b3ca6SJunchao Zhang - pattern - One of PETSCSF_PATTERN_ALLGATHER, PETSCSF_PATTERN_GATHER, PETSCSF_PATTERN_ALLTOALL
442dd5b3ca6SJunchao Zhang 
443dd5b3ca6SJunchao Zhang   Notes:
444dd5b3ca6SJunchao Zhang   It is easier to explain PetscSFPattern using vectors. Suppose we have an MPI vector x and its layout is map.
445dd5b3ca6SJunchao Zhang   n and N are local and global sizes of x respectively.
446dd5b3ca6SJunchao Zhang 
447dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_ALLGATHER, the routine creates a graph that if one does Bcast on it, it will copy x to
448dd5b3ca6SJunchao Zhang   sequential vectors y on all ranks.
449dd5b3ca6SJunchao Zhang 
450dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_GATHER, the routine creates a graph that if one does Bcast on it, it will copy x to a
451dd5b3ca6SJunchao Zhang   sequential vector y on rank 0.
452dd5b3ca6SJunchao Zhang 
453dd5b3ca6SJunchao Zhang   In above cases, entries of x are roots and entries of y are leaves.
454dd5b3ca6SJunchao Zhang 
455dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_ALLTOALL, map is insignificant. Suppose NP is size of sf's communicator. The routine
456dd5b3ca6SJunchao Zhang   creates a graph that every rank has NP leaves and NP roots. On rank i, its leaf j is connected to root i
457dd5b3ca6SJunchao Zhang   of rank j. Here 0 <=i,j<NP. It is a kind of MPI_Alltoall with sendcount/recvcount being 1. Note that it does
458dd5b3ca6SJunchao Zhang   not mean one can not send multiple items. One just needs to create a new MPI datatype for the mulptiple data
459dd5b3ca6SJunchao Zhang   items with MPI_Type_contiguous() and use that as the <unit> argument in SF routines.
460dd5b3ca6SJunchao Zhang 
461dd5b3ca6SJunchao Zhang   In this case, roots and leaves are symmetric.
462dd5b3ca6SJunchao Zhang 
463dd5b3ca6SJunchao Zhang   Level: intermediate
464dd5b3ca6SJunchao Zhang  @*/
465dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFSetGraphWithPattern(PetscSF sf,PetscLayout map,PetscSFPattern pattern)
466dd5b3ca6SJunchao Zhang {
467dd5b3ca6SJunchao Zhang   MPI_Comm       comm;
468dd5b3ca6SJunchao Zhang   PetscInt       n,N,res[2];
469dd5b3ca6SJunchao Zhang   PetscMPIInt    rank,size;
470dd5b3ca6SJunchao Zhang   PetscSFType    type;
471dd5b3ca6SJunchao Zhang   PetscErrorCode ierr;
472dd5b3ca6SJunchao Zhang 
473dd5b3ca6SJunchao Zhang   PetscFunctionBegin;
474dd5b3ca6SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf, &comm);CHKERRQ(ierr);
475dd5b3ca6SJunchao Zhang   if (pattern < PETSCSF_PATTERN_ALLGATHER || pattern > PETSCSF_PATTERN_ALLTOALL) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unsupported PetscSFPattern %D\n",pattern);
476dd5b3ca6SJunchao Zhang   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
477dd5b3ca6SJunchao Zhang   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
478dd5b3ca6SJunchao Zhang 
479dd5b3ca6SJunchao Zhang   if (pattern == PETSCSF_PATTERN_ALLTOALL) {
480dd5b3ca6SJunchao Zhang     type = PETSCSFALLTOALL;
481dd5b3ca6SJunchao Zhang     ierr = PetscLayoutCreate(comm,&sf->map);CHKERRQ(ierr);
482dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetLocalSize(sf->map,size);CHKERRQ(ierr);
483dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetSize(sf->map,((PetscInt)size)*size);CHKERRQ(ierr);
484dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetUp(sf->map);CHKERRQ(ierr);
485dd5b3ca6SJunchao Zhang   } else {
486dd5b3ca6SJunchao Zhang     ierr   = PetscLayoutGetLocalSize(map,&n);CHKERRQ(ierr);
487dd5b3ca6SJunchao Zhang     ierr   = PetscLayoutGetSize(map,&N);CHKERRQ(ierr);
488dd5b3ca6SJunchao Zhang     res[0] = n;
489dd5b3ca6SJunchao Zhang     res[1] = -n;
490dd5b3ca6SJunchao Zhang     /* Check if n are same over all ranks so that we can optimize it */
491dd5b3ca6SJunchao Zhang     ierr   = MPIU_Allreduce(MPI_IN_PLACE,res,2,MPIU_INT,MPI_MAX,comm);CHKERRQ(ierr);
492dd5b3ca6SJunchao Zhang     if (res[0] == -res[1]) { /* same n */
493dd5b3ca6SJunchao Zhang       type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHER  : PETSCSFGATHER;
494dd5b3ca6SJunchao Zhang     } else {
495dd5b3ca6SJunchao Zhang       type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHERV : PETSCSFGATHERV;
496dd5b3ca6SJunchao Zhang     }
497dd5b3ca6SJunchao Zhang     ierr = PetscLayoutReference(map,&sf->map);CHKERRQ(ierr);
498dd5b3ca6SJunchao Zhang   }
499dd5b3ca6SJunchao Zhang   ierr = PetscSFSetType(sf,type);CHKERRQ(ierr);
500dd5b3ca6SJunchao Zhang 
501dd5b3ca6SJunchao Zhang   sf->pattern = pattern;
502dd5b3ca6SJunchao Zhang   sf->mine    = NULL; /* Contiguous */
503dd5b3ca6SJunchao Zhang 
504dd5b3ca6SJunchao Zhang   /* Set nleaves, nroots here in case user calls PetscSFGetGraph, which is legal to call even before PetscSFSetUp is called.
505dd5b3ca6SJunchao Zhang      Also set other easy stuff.
506dd5b3ca6SJunchao Zhang    */
507dd5b3ca6SJunchao Zhang   if (pattern == PETSCSF_PATTERN_ALLGATHER) {
508dd5b3ca6SJunchao Zhang     sf->nleaves      = N;
509dd5b3ca6SJunchao Zhang     sf->nroots       = n;
510dd5b3ca6SJunchao Zhang     sf->nranks       = size;
511dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
512dd5b3ca6SJunchao Zhang     sf->maxleaf      = N - 1;
513dd5b3ca6SJunchao Zhang   } else if (pattern == PETSCSF_PATTERN_GATHER) {
514dd5b3ca6SJunchao Zhang     sf->nleaves      = rank ? 0 : N;
515dd5b3ca6SJunchao Zhang     sf->nroots       = n;
516dd5b3ca6SJunchao Zhang     sf->nranks       = rank ? 0 : size;
517dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
518dd5b3ca6SJunchao Zhang     sf->maxleaf      = rank ? -1 : N - 1;
519dd5b3ca6SJunchao Zhang   } else if (pattern == PETSCSF_PATTERN_ALLTOALL) {
520dd5b3ca6SJunchao Zhang     sf->nleaves      = size;
521dd5b3ca6SJunchao Zhang     sf->nroots       = size;
522dd5b3ca6SJunchao Zhang     sf->nranks       = size;
523dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
524dd5b3ca6SJunchao Zhang     sf->maxleaf      = size - 1;
525dd5b3ca6SJunchao Zhang   }
526dd5b3ca6SJunchao Zhang   sf->ndranks  = 0; /* We do not need to separate out distinguished ranks for patterned graphs to improve communication performance */
527dd5b3ca6SJunchao Zhang   sf->graphset = PETSC_TRUE;
528dd5b3ca6SJunchao Zhang   PetscFunctionReturn(0);
529dd5b3ca6SJunchao Zhang }
530dd5b3ca6SJunchao Zhang 
531dd5b3ca6SJunchao Zhang /*@
53295fce210SBarry Smith    PetscSFCreateInverseSF - given a PetscSF in which all vertices have degree 1, creates the inverse map
53395fce210SBarry Smith 
53495fce210SBarry Smith    Collective
53595fce210SBarry Smith 
53695fce210SBarry Smith    Input Arguments:
537dd5b3ca6SJunchao Zhang 
53895fce210SBarry Smith .  sf - star forest to invert
53995fce210SBarry Smith 
54095fce210SBarry Smith    Output Arguments:
54195fce210SBarry Smith .  isf - inverse of sf
54295fce210SBarry Smith    Level: advanced
54395fce210SBarry Smith 
54495fce210SBarry Smith    Notes:
54595fce210SBarry Smith    All roots must have degree 1.
54695fce210SBarry Smith 
54795fce210SBarry Smith    The local space may be a permutation, but cannot be sparse.
54895fce210SBarry Smith 
54995fce210SBarry Smith .seealso: PetscSFSetGraph()
55095fce210SBarry Smith @*/
55195fce210SBarry Smith PetscErrorCode PetscSFCreateInverseSF(PetscSF sf,PetscSF *isf)
55295fce210SBarry Smith {
55395fce210SBarry Smith   PetscErrorCode ierr;
55495fce210SBarry Smith   PetscMPIInt    rank;
55595fce210SBarry Smith   PetscInt       i,nroots,nleaves,maxlocal,count,*newilocal;
55695fce210SBarry Smith   const PetscInt *ilocal;
55795fce210SBarry Smith   PetscSFNode    *roots,*leaves;
55895fce210SBarry Smith 
55995fce210SBarry Smith   PetscFunctionBegin;
56029046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
56129046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
56229046d53SLisandro Dalcin   PetscValidPointer(isf,2);
56329046d53SLisandro Dalcin 
56495fce210SBarry Smith   ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
56529046d53SLisandro Dalcin   maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
56629046d53SLisandro Dalcin 
56729046d53SLisandro Dalcin   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
568ae9aee6dSMatthew G. Knepley   ierr = PetscMalloc2(nroots,&roots,maxlocal,&leaves);CHKERRQ(ierr);
569ae9aee6dSMatthew G. Knepley   for (i=0; i<maxlocal; i++) {
57095fce210SBarry Smith     leaves[i].rank  = rank;
57195fce210SBarry Smith     leaves[i].index = i;
57295fce210SBarry Smith   }
57395fce210SBarry Smith   for (i=0; i <nroots; i++) {
57495fce210SBarry Smith     roots[i].rank  = -1;
57595fce210SBarry Smith     roots[i].index = -1;
57695fce210SBarry Smith   }
5778bfbc91cSJed Brown   ierr = PetscSFReduceBegin(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr);
5788bfbc91cSJed Brown   ierr = PetscSFReduceEnd(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr);
57995fce210SBarry Smith 
58095fce210SBarry Smith   /* Check whether our leaves are sparse */
58195fce210SBarry Smith   for (i=0,count=0; i<nroots; i++) if (roots[i].rank >= 0) count++;
58295fce210SBarry Smith   if (count == nroots) newilocal = NULL;
58395fce210SBarry Smith   else {                        /* Index for sparse leaves and compact "roots" array (which is to become our leaves). */
584785e854fSJed Brown     ierr = PetscMalloc1(count,&newilocal);CHKERRQ(ierr);
58595fce210SBarry Smith     for (i=0,count=0; i<nroots; i++) {
58695fce210SBarry Smith       if (roots[i].rank >= 0) {
58795fce210SBarry Smith         newilocal[count]   = i;
58895fce210SBarry Smith         roots[count].rank  = roots[i].rank;
58995fce210SBarry Smith         roots[count].index = roots[i].index;
59095fce210SBarry Smith         count++;
59195fce210SBarry Smith       }
59295fce210SBarry Smith     }
59395fce210SBarry Smith   }
59495fce210SBarry Smith 
59595fce210SBarry Smith   ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,isf);CHKERRQ(ierr);
59695fce210SBarry Smith   ierr = PetscSFSetGraph(*isf,maxlocal,count,newilocal,PETSC_OWN_POINTER,roots,PETSC_COPY_VALUES);CHKERRQ(ierr);
59795fce210SBarry Smith   ierr = PetscFree2(roots,leaves);CHKERRQ(ierr);
59895fce210SBarry Smith   PetscFunctionReturn(0);
59995fce210SBarry Smith }
60095fce210SBarry Smith 
60195fce210SBarry Smith /*@
60295fce210SBarry Smith    PetscSFDuplicate - duplicate a PetscSF, optionally preserving rank connectivity and graph
60395fce210SBarry Smith 
60495fce210SBarry Smith    Collective
60595fce210SBarry Smith 
60695fce210SBarry Smith    Input Arguments:
60795fce210SBarry Smith +  sf - communication object to duplicate
60895fce210SBarry Smith -  opt - PETSCSF_DUPLICATE_CONFONLY, PETSCSF_DUPLICATE_RANKS, or PETSCSF_DUPLICATE_GRAPH (see PetscSFDuplicateOption)
60995fce210SBarry Smith 
61095fce210SBarry Smith    Output Arguments:
61195fce210SBarry Smith .  newsf - new communication object
61295fce210SBarry Smith 
61395fce210SBarry Smith    Level: beginner
61495fce210SBarry Smith 
61595fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetType(), PetscSFSetGraph()
61695fce210SBarry Smith @*/
61795fce210SBarry Smith PetscErrorCode PetscSFDuplicate(PetscSF sf,PetscSFDuplicateOption opt,PetscSF *newsf)
61895fce210SBarry Smith {
61929046d53SLisandro Dalcin   PetscSFType    type;
62095fce210SBarry Smith   PetscErrorCode ierr;
62195fce210SBarry Smith 
62295fce210SBarry Smith   PetscFunctionBegin;
62329046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
62429046d53SLisandro Dalcin   PetscValidLogicalCollectiveEnum(sf,opt,2);
62529046d53SLisandro Dalcin   PetscValidPointer(newsf,3);
62695fce210SBarry Smith   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sf),newsf);CHKERRQ(ierr);
62729046d53SLisandro Dalcin   ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
62829046d53SLisandro Dalcin   if (type) {ierr = PetscSFSetType(*newsf,type);CHKERRQ(ierr);}
62995fce210SBarry Smith   if (opt == PETSCSF_DUPLICATE_GRAPH) {
630dd5b3ca6SJunchao Zhang     PetscSFCheckGraphSet(sf,1);
631dd5b3ca6SJunchao Zhang     if (sf->pattern == PETSCSF_PATTERN_GENERAL) {
63295fce210SBarry Smith       PetscInt          nroots,nleaves;
63395fce210SBarry Smith       const PetscInt    *ilocal;
63495fce210SBarry Smith       const PetscSFNode *iremote;
63595fce210SBarry Smith       ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
63695fce210SBarry Smith       ierr = PetscSFSetGraph(*newsf,nroots,nleaves,ilocal,PETSC_COPY_VALUES,iremote,PETSC_COPY_VALUES);CHKERRQ(ierr);
637dd5b3ca6SJunchao Zhang     } else {
638dd5b3ca6SJunchao Zhang       ierr = PetscSFSetGraphWithPattern(*newsf,sf->map,sf->pattern);CHKERRQ(ierr);
639dd5b3ca6SJunchao Zhang     }
64095fce210SBarry Smith   }
64129046d53SLisandro Dalcin   if (sf->ops->Duplicate) {ierr = (*sf->ops->Duplicate)(sf,opt,*newsf);CHKERRQ(ierr);}
64295fce210SBarry Smith   PetscFunctionReturn(0);
64395fce210SBarry Smith }
64495fce210SBarry Smith 
64595fce210SBarry Smith /*@C
64695fce210SBarry Smith    PetscSFGetGraph - Get the graph specifying a parallel star forest
64795fce210SBarry Smith 
64895fce210SBarry Smith    Not Collective
64995fce210SBarry Smith 
65095fce210SBarry Smith    Input Arguments:
65195fce210SBarry Smith .  sf - star forest
65295fce210SBarry Smith 
65395fce210SBarry Smith    Output Arguments:
65495fce210SBarry Smith +  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
65595fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
65695fce210SBarry Smith .  ilocal - locations of leaves in leafdata buffers
65795fce210SBarry Smith -  iremote - remote locations of root vertices for each leaf on the current process
65895fce210SBarry Smith 
659373e0d91SLisandro Dalcin    Notes:
660373e0d91SLisandro Dalcin    We are not currently requiring that the graph is set, thus returning nroots=-1 if it has not been set yet
661373e0d91SLisandro Dalcin 
662ca797d7aSLawrence Mitchell    When called from Fortran, the returned iremote array is a copy and must deallocated after use. Consequently, if you
663ca797d7aSLawrence Mitchell    want to update the graph, you must call PetscSFSetGraph after modifying the iremote array.
664ca797d7aSLawrence Mitchell 
66595fce210SBarry Smith    Level: intermediate
66695fce210SBarry Smith 
66795fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph()
66895fce210SBarry Smith @*/
66995fce210SBarry Smith PetscErrorCode PetscSFGetGraph(PetscSF sf,PetscInt *nroots,PetscInt *nleaves,const PetscInt **ilocal,const PetscSFNode **iremote)
67095fce210SBarry Smith {
671b8dee149SJunchao Zhang   PetscErrorCode ierr;
67295fce210SBarry Smith 
67395fce210SBarry Smith   PetscFunctionBegin;
67495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
675b8dee149SJunchao Zhang   if (sf->ops->GetGraph) {
676b8dee149SJunchao Zhang     ierr = (sf->ops->GetGraph)(sf,nroots,nleaves,ilocal,iremote);CHKERRQ(ierr);
677b8dee149SJunchao Zhang   } else {
67895fce210SBarry Smith     if (nroots) *nroots = sf->nroots;
67995fce210SBarry Smith     if (nleaves) *nleaves = sf->nleaves;
68095fce210SBarry Smith     if (ilocal) *ilocal = sf->mine;
68195fce210SBarry Smith     if (iremote) *iremote = sf->remote;
682b8dee149SJunchao Zhang   }
68395fce210SBarry Smith   PetscFunctionReturn(0);
68495fce210SBarry Smith }
68595fce210SBarry Smith 
68629046d53SLisandro Dalcin /*@
68795fce210SBarry Smith    PetscSFGetLeafRange - Get the active leaf ranges
68895fce210SBarry Smith 
68995fce210SBarry Smith    Not Collective
69095fce210SBarry Smith 
69195fce210SBarry Smith    Input Arguments:
69295fce210SBarry Smith .  sf - star forest
69395fce210SBarry Smith 
69495fce210SBarry Smith    Output Arguments:
695dd5b3ca6SJunchao Zhang +  minleaf - minimum active leaf on this process. Return 0 if there are no leaves.
696dd5b3ca6SJunchao Zhang -  maxleaf - maximum active leaf on this process. Return -1 if there are no leaves.
69795fce210SBarry Smith 
69895fce210SBarry Smith    Level: developer
69995fce210SBarry Smith 
70095fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph(), PetscSFGetGraph()
70195fce210SBarry Smith @*/
70295fce210SBarry Smith PetscErrorCode PetscSFGetLeafRange(PetscSF sf,PetscInt *minleaf,PetscInt *maxleaf)
70395fce210SBarry Smith {
70495fce210SBarry Smith 
70595fce210SBarry Smith   PetscFunctionBegin;
70695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
70729046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
70895fce210SBarry Smith   if (minleaf) *minleaf = sf->minleaf;
70995fce210SBarry Smith   if (maxleaf) *maxleaf = sf->maxleaf;
71095fce210SBarry Smith   PetscFunctionReturn(0);
71195fce210SBarry Smith }
71295fce210SBarry Smith 
71395fce210SBarry Smith /*@C
714fe2efc57SMark    PetscSFViewFromOptions - View from Options
715fe2efc57SMark 
716fe2efc57SMark    Collective on PetscSF
717fe2efc57SMark 
718fe2efc57SMark    Input Parameters:
719fe2efc57SMark +  A - the star forest
720736c3998SJose E. Roman .  obj - Optional object
721736c3998SJose E. Roman -  name - command line option
722fe2efc57SMark 
723fe2efc57SMark    Level: intermediate
724fe2efc57SMark .seealso:  PetscSF, PetscSFView, PetscObjectViewFromOptions(), PetscSFCreate()
725fe2efc57SMark @*/
726fe2efc57SMark PetscErrorCode  PetscSFViewFromOptions(PetscSF A,PetscObject obj,const char name[])
727fe2efc57SMark {
728fe2efc57SMark   PetscErrorCode ierr;
729fe2efc57SMark 
730fe2efc57SMark   PetscFunctionBegin;
731fe2efc57SMark   PetscValidHeaderSpecific(A,PETSCSF_CLASSID,1);
732fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
733fe2efc57SMark   PetscFunctionReturn(0);
734fe2efc57SMark }
735fe2efc57SMark 
736fe2efc57SMark /*@C
73795fce210SBarry Smith    PetscSFView - view a star forest
73895fce210SBarry Smith 
73995fce210SBarry Smith    Collective
74095fce210SBarry Smith 
74195fce210SBarry Smith    Input Arguments:
74295fce210SBarry Smith +  sf - star forest
74395fce210SBarry Smith -  viewer - viewer to display graph, for example PETSC_VIEWER_STDOUT_WORLD
74495fce210SBarry Smith 
74595fce210SBarry Smith    Level: beginner
74695fce210SBarry Smith 
74795fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph()
74895fce210SBarry Smith @*/
74995fce210SBarry Smith PetscErrorCode PetscSFView(PetscSF sf,PetscViewer viewer)
75095fce210SBarry Smith {
75195fce210SBarry Smith   PetscErrorCode    ierr;
75295fce210SBarry Smith   PetscBool         iascii;
75395fce210SBarry Smith   PetscViewerFormat format;
75495fce210SBarry Smith 
75595fce210SBarry Smith   PetscFunctionBegin;
75695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
75795fce210SBarry Smith   if (!viewer) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sf),&viewer);CHKERRQ(ierr);}
75895fce210SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
75995fce210SBarry Smith   PetscCheckSameComm(sf,1,viewer,2);
76080153354SVaclav Hapla   if (sf->graphset) {ierr = PetscSFSetUp(sf);CHKERRQ(ierr);}
76195fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
76295fce210SBarry Smith   if (iascii) {
76395fce210SBarry Smith     PetscMPIInt rank;
76481bfa7aaSJed Brown     PetscInt    ii,i,j;
76595fce210SBarry Smith 
766dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)sf,viewer);CHKERRQ(ierr);
76795fce210SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
76895fce210SBarry Smith     if (sf->ops->View) {ierr = (*sf->ops->View)(sf,viewer);CHKERRQ(ierr);}
769dd5b3ca6SJunchao Zhang     if (sf->pattern == PETSCSF_PATTERN_GENERAL) {
77080153354SVaclav Hapla       if (!sf->graphset) {
77180153354SVaclav Hapla         ierr = PetscViewerASCIIPrintf(viewer,"PetscSFSetGraph() has not been called yet\n");CHKERRQ(ierr);
77280153354SVaclav Hapla         ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
77380153354SVaclav Hapla         PetscFunctionReturn(0);
77480153354SVaclav Hapla       }
77595fce210SBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
7761575c14dSBarry Smith       ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
77795fce210SBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Number of roots=%D, leaves=%D, remote ranks=%D\n",rank,sf->nroots,sf->nleaves,sf->nranks);CHKERRQ(ierr);
77895fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
77995fce210SBarry Smith         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %D <- (%D,%D)\n",rank,sf->mine ? sf->mine[i] : i,sf->remote[i].rank,sf->remote[i].index);CHKERRQ(ierr);
78095fce210SBarry Smith       }
78195fce210SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
78295fce210SBarry Smith       ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
78395fce210SBarry Smith       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
78481bfa7aaSJed Brown         PetscMPIInt *tmpranks,*perm;
78581bfa7aaSJed Brown         ierr = PetscMalloc2(sf->nranks,&tmpranks,sf->nranks,&perm);CHKERRQ(ierr);
786580bdb30SBarry Smith         ierr = PetscArraycpy(tmpranks,sf->ranks,sf->nranks);CHKERRQ(ierr);
78781bfa7aaSJed Brown         for (i=0; i<sf->nranks; i++) perm[i] = i;
78881bfa7aaSJed Brown         ierr = PetscSortMPIIntWithArray(sf->nranks,tmpranks,perm);CHKERRQ(ierr);
78995fce210SBarry Smith         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Roots referenced by my leaves, by rank\n",rank);CHKERRQ(ierr);
79081bfa7aaSJed Brown         for (ii=0; ii<sf->nranks; ii++) {
79181bfa7aaSJed Brown           i = perm[ii];
7927904a332SBarry Smith           ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %d: %D edges\n",rank,sf->ranks[i],sf->roffset[i+1]-sf->roffset[i]);CHKERRQ(ierr);
79395fce210SBarry Smith           for (j=sf->roffset[i]; j<sf->roffset[i+1]; j++) {
79495fce210SBarry Smith             ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d]    %D <- %D\n",rank,sf->rmine[j],sf->rremote[j]);CHKERRQ(ierr);
79595fce210SBarry Smith           }
79695fce210SBarry Smith         }
79781bfa7aaSJed Brown         ierr = PetscFree2(tmpranks,perm);CHKERRQ(ierr);
79895fce210SBarry Smith       }
79995fce210SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
8001575c14dSBarry Smith       ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
801dd5b3ca6SJunchao Zhang     }
80295fce210SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
80395fce210SBarry Smith   }
80495fce210SBarry Smith   PetscFunctionReturn(0);
80595fce210SBarry Smith }
80695fce210SBarry Smith 
80795fce210SBarry Smith /*@C
808dec1416fSJunchao Zhang    PetscSFGetRootRanks - Get root ranks and number of vertices referenced by leaves on this process
80995fce210SBarry Smith 
81095fce210SBarry Smith    Not Collective
81195fce210SBarry Smith 
81295fce210SBarry Smith    Input Arguments:
81395fce210SBarry Smith .  sf - star forest
81495fce210SBarry Smith 
81595fce210SBarry Smith    Output Arguments:
81695fce210SBarry Smith +  nranks - number of ranks referenced by local part
81795fce210SBarry Smith .  ranks - array of ranks
81895fce210SBarry Smith .  roffset - offset in rmine/rremote for each rank (length nranks+1)
81995fce210SBarry Smith .  rmine - concatenated array holding local indices referencing each remote rank
82095fce210SBarry Smith -  rremote - concatenated array holding remote indices referenced for each remote rank
82195fce210SBarry Smith 
82295fce210SBarry Smith    Level: developer
82395fce210SBarry Smith 
824dec1416fSJunchao Zhang .seealso: PetscSFGetLeafRanks()
82595fce210SBarry Smith @*/
826dec1416fSJunchao Zhang PetscErrorCode PetscSFGetRootRanks(PetscSF sf,PetscInt *nranks,const PetscMPIInt **ranks,const PetscInt **roffset,const PetscInt **rmine,const PetscInt **rremote)
82795fce210SBarry Smith {
828dec1416fSJunchao Zhang   PetscErrorCode ierr;
82995fce210SBarry Smith 
83095fce210SBarry Smith   PetscFunctionBegin;
83195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
83229046d53SLisandro Dalcin   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
833dec1416fSJunchao Zhang   if (sf->ops->GetRootRanks) {
834dec1416fSJunchao Zhang     ierr = (sf->ops->GetRootRanks)(sf,nranks,ranks,roffset,rmine,rremote);CHKERRQ(ierr);
835dec1416fSJunchao Zhang   } else {
836dec1416fSJunchao Zhang     /* The generic implementation */
83795fce210SBarry Smith     if (nranks)  *nranks  = sf->nranks;
83895fce210SBarry Smith     if (ranks)   *ranks   = sf->ranks;
83995fce210SBarry Smith     if (roffset) *roffset = sf->roffset;
84095fce210SBarry Smith     if (rmine)   *rmine   = sf->rmine;
84195fce210SBarry Smith     if (rremote) *rremote = sf->rremote;
842dec1416fSJunchao Zhang   }
84395fce210SBarry Smith   PetscFunctionReturn(0);
84495fce210SBarry Smith }
84595fce210SBarry Smith 
8468750ddebSJunchao Zhang /*@C
8478750ddebSJunchao Zhang    PetscSFGetLeafRanks - Get leaf ranks referencing roots on this process
8488750ddebSJunchao Zhang 
8498750ddebSJunchao Zhang    Not Collective
8508750ddebSJunchao Zhang 
8518750ddebSJunchao Zhang    Input Arguments:
8528750ddebSJunchao Zhang .  sf - star forest
8538750ddebSJunchao Zhang 
8548750ddebSJunchao Zhang    Output Arguments:
8558750ddebSJunchao Zhang +  niranks - number of leaf ranks referencing roots on this process
8568750ddebSJunchao Zhang .  iranks - array of ranks
8578750ddebSJunchao Zhang .  ioffset - offset in irootloc for each rank (length niranks+1)
8588750ddebSJunchao Zhang -  irootloc - concatenated array holding local indices of roots referenced by each leaf rank
8598750ddebSJunchao Zhang 
8608750ddebSJunchao Zhang    Level: developer
8618750ddebSJunchao Zhang 
862dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
8638750ddebSJunchao Zhang @*/
8648750ddebSJunchao Zhang PetscErrorCode PetscSFGetLeafRanks(PetscSF sf,PetscInt *niranks,const PetscMPIInt **iranks,const PetscInt **ioffset,const PetscInt **irootloc)
8658750ddebSJunchao Zhang {
8668750ddebSJunchao Zhang   PetscErrorCode ierr;
8678750ddebSJunchao Zhang 
8688750ddebSJunchao Zhang   PetscFunctionBegin;
8698750ddebSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
8708750ddebSJunchao Zhang   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
8718750ddebSJunchao Zhang   if (sf->ops->GetLeafRanks) {
8728750ddebSJunchao Zhang     ierr = (sf->ops->GetLeafRanks)(sf,niranks,iranks,ioffset,irootloc);CHKERRQ(ierr);
8738750ddebSJunchao Zhang   } else {
8748750ddebSJunchao Zhang     PetscSFType type;
8758750ddebSJunchao Zhang     ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
8768750ddebSJunchao Zhang     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFGetLeafRanks() is not supported on this StarForest type: %s", type);
8778750ddebSJunchao Zhang   }
8788750ddebSJunchao Zhang   PetscFunctionReturn(0);
8798750ddebSJunchao Zhang }
8808750ddebSJunchao Zhang 
881b5a8e515SJed Brown static PetscBool InList(PetscMPIInt needle,PetscMPIInt n,const PetscMPIInt *list) {
882b5a8e515SJed Brown   PetscInt i;
883b5a8e515SJed Brown   for (i=0; i<n; i++) {
884b5a8e515SJed Brown     if (needle == list[i]) return PETSC_TRUE;
885b5a8e515SJed Brown   }
886b5a8e515SJed Brown   return PETSC_FALSE;
887b5a8e515SJed Brown }
888b5a8e515SJed Brown 
88995fce210SBarry Smith /*@C
89021c688dcSJed Brown    PetscSFSetUpRanks - Set up data structures associated with ranks; this is for internal use by PetscSF implementations.
89121c688dcSJed Brown 
89221c688dcSJed Brown    Collective
89321c688dcSJed Brown 
89421c688dcSJed Brown    Input Arguments:
895b5a8e515SJed Brown +  sf - PetscSF to set up; PetscSFSetGraph() must have been called
896b5a8e515SJed Brown -  dgroup - MPI_Group of ranks to be distinguished (e.g., for self or shared memory exchange)
89721c688dcSJed Brown 
89821c688dcSJed Brown    Level: developer
89921c688dcSJed Brown 
900dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
90121c688dcSJed Brown @*/
902b5a8e515SJed Brown PetscErrorCode PetscSFSetUpRanks(PetscSF sf,MPI_Group dgroup)
90321c688dcSJed Brown {
90421c688dcSJed Brown   PetscErrorCode     ierr;
90521c688dcSJed Brown   PetscTable         table;
90621c688dcSJed Brown   PetscTablePosition pos;
907b5a8e515SJed Brown   PetscMPIInt        size,groupsize,*groupranks;
908247e8311SStefano Zampini   PetscInt           *rcount,*ranks;
909247e8311SStefano Zampini   PetscInt           i, irank = -1,orank = -1;
91021c688dcSJed Brown 
91121c688dcSJed Brown   PetscFunctionBegin;
91221c688dcSJed Brown   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
91329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
91421c688dcSJed Brown   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRQ(ierr);
91521c688dcSJed Brown   ierr = PetscTableCreate(10,size,&table);CHKERRQ(ierr);
91621c688dcSJed Brown   for (i=0; i<sf->nleaves; i++) {
91721c688dcSJed Brown     /* Log 1-based rank */
91821c688dcSJed Brown     ierr = PetscTableAdd(table,sf->remote[i].rank+1,1,ADD_VALUES);CHKERRQ(ierr);
91921c688dcSJed Brown   }
92021c688dcSJed Brown   ierr = PetscTableGetCount(table,&sf->nranks);CHKERRQ(ierr);
92121c688dcSJed Brown   ierr = PetscMalloc4(sf->nranks,&sf->ranks,sf->nranks+1,&sf->roffset,sf->nleaves,&sf->rmine,sf->nleaves,&sf->rremote);CHKERRQ(ierr);
92221c688dcSJed Brown   ierr = PetscMalloc2(sf->nranks,&rcount,sf->nranks,&ranks);CHKERRQ(ierr);
92321c688dcSJed Brown   ierr = PetscTableGetHeadPosition(table,&pos);CHKERRQ(ierr);
92421c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
92521c688dcSJed Brown     ierr = PetscTableGetNext(table,&pos,&ranks[i],&rcount[i]);CHKERRQ(ierr);
92621c688dcSJed Brown     ranks[i]--;             /* Convert back to 0-based */
92721c688dcSJed Brown   }
92821c688dcSJed Brown   ierr = PetscTableDestroy(&table);CHKERRQ(ierr);
929b5a8e515SJed Brown 
930b5a8e515SJed Brown   /* We expect that dgroup is reliably "small" while nranks could be large */
931b5a8e515SJed Brown   {
9327fb8a5e4SKarl Rupp     MPI_Group group = MPI_GROUP_NULL;
933b5a8e515SJed Brown     PetscMPIInt *dgroupranks;
934b5a8e515SJed Brown     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
935b5a8e515SJed Brown     ierr = MPI_Group_size(dgroup,&groupsize);CHKERRQ(ierr);
936b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&dgroupranks);CHKERRQ(ierr);
937b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&groupranks);CHKERRQ(ierr);
938b5a8e515SJed Brown     for (i=0; i<groupsize; i++) dgroupranks[i] = i;
939f3fc9a17SJed Brown     if (groupsize) {ierr = MPI_Group_translate_ranks(dgroup,groupsize,dgroupranks,group,groupranks);CHKERRQ(ierr);}
940b5a8e515SJed Brown     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
941b5a8e515SJed Brown     ierr = PetscFree(dgroupranks);CHKERRQ(ierr);
942b5a8e515SJed Brown   }
943b5a8e515SJed Brown 
944b5a8e515SJed Brown   /* Partition ranks[] into distinguished (first sf->ndranks) followed by non-distinguished */
945b5a8e515SJed Brown   for (sf->ndranks=0,i=sf->nranks; sf->ndranks<i; ) {
946b5a8e515SJed Brown     for (i--; sf->ndranks<i; i--) { /* Scan i backward looking for distinguished rank */
947b5a8e515SJed Brown       if (InList(ranks[i],groupsize,groupranks)) break;
948b5a8e515SJed Brown     }
949b5a8e515SJed Brown     for ( ; sf->ndranks<=i; sf->ndranks++) { /* Scan sf->ndranks forward looking for non-distinguished rank */
950b5a8e515SJed Brown       if (!InList(ranks[sf->ndranks],groupsize,groupranks)) break;
951b5a8e515SJed Brown     }
952b5a8e515SJed Brown     if (sf->ndranks < i) {                         /* Swap ranks[sf->ndranks] with ranks[i] */
953b5a8e515SJed Brown       PetscInt tmprank,tmpcount;
954247e8311SStefano Zampini 
955b5a8e515SJed Brown       tmprank             = ranks[i];
956b5a8e515SJed Brown       tmpcount            = rcount[i];
957b5a8e515SJed Brown       ranks[i]            = ranks[sf->ndranks];
958b5a8e515SJed Brown       rcount[i]           = rcount[sf->ndranks];
959b5a8e515SJed Brown       ranks[sf->ndranks]  = tmprank;
960b5a8e515SJed Brown       rcount[sf->ndranks] = tmpcount;
961b5a8e515SJed Brown       sf->ndranks++;
962b5a8e515SJed Brown     }
963b5a8e515SJed Brown   }
964b5a8e515SJed Brown   ierr = PetscFree(groupranks);CHKERRQ(ierr);
965b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->ndranks,ranks,rcount);CHKERRQ(ierr);
966b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->nranks-sf->ndranks,ranks+sf->ndranks,rcount+sf->ndranks);CHKERRQ(ierr);
96721c688dcSJed Brown   sf->roffset[0] = 0;
96821c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
96921c688dcSJed Brown     ierr = PetscMPIIntCast(ranks[i],sf->ranks+i);CHKERRQ(ierr);
97021c688dcSJed Brown     sf->roffset[i+1] = sf->roffset[i] + rcount[i];
97121c688dcSJed Brown     rcount[i]        = 0;
97221c688dcSJed Brown   }
973247e8311SStefano Zampini   for (i=0, irank = -1, orank = -1; i<sf->nleaves; i++) {
974247e8311SStefano Zampini     /* short circuit */
975247e8311SStefano Zampini     if (orank != sf->remote[i].rank) {
97621c688dcSJed Brown       /* Search for index of iremote[i].rank in sf->ranks */
977b5a8e515SJed Brown       ierr = PetscFindMPIInt(sf->remote[i].rank,sf->ndranks,sf->ranks,&irank);CHKERRQ(ierr);
978b5a8e515SJed Brown       if (irank < 0) {
979b5a8e515SJed Brown         ierr = PetscFindMPIInt(sf->remote[i].rank,sf->nranks-sf->ndranks,sf->ranks+sf->ndranks,&irank);CHKERRQ(ierr);
980b5a8e515SJed Brown         if (irank >= 0) irank += sf->ndranks;
98121c688dcSJed Brown       }
982247e8311SStefano Zampini       orank = sf->remote[i].rank;
983247e8311SStefano Zampini     }
984b5a8e515SJed Brown     if (irank < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Could not find rank %D in array",sf->remote[i].rank);
98521c688dcSJed Brown     sf->rmine[sf->roffset[irank] + rcount[irank]]   = sf->mine ? sf->mine[i] : i;
98621c688dcSJed Brown     sf->rremote[sf->roffset[irank] + rcount[irank]] = sf->remote[i].index;
98721c688dcSJed Brown     rcount[irank]++;
98821c688dcSJed Brown   }
98921c688dcSJed Brown   ierr = PetscFree2(rcount,ranks);CHKERRQ(ierr);
99021c688dcSJed Brown   PetscFunctionReturn(0);
99121c688dcSJed Brown }
99221c688dcSJed Brown 
99321c688dcSJed Brown /*@C
99495fce210SBarry Smith    PetscSFGetGroups - gets incoming and outgoing process groups
99595fce210SBarry Smith 
99695fce210SBarry Smith    Collective
99795fce210SBarry Smith 
99895fce210SBarry Smith    Input Argument:
99995fce210SBarry Smith .  sf - star forest
100095fce210SBarry Smith 
100195fce210SBarry Smith    Output Arguments:
100295fce210SBarry Smith +  incoming - group of origin processes for incoming edges (leaves that reference my roots)
100395fce210SBarry Smith -  outgoing - group of destination processes for outgoing edges (roots that I reference)
100495fce210SBarry Smith 
100595fce210SBarry Smith    Level: developer
100695fce210SBarry Smith 
100795fce210SBarry Smith .seealso: PetscSFGetWindow(), PetscSFRestoreWindow()
100895fce210SBarry Smith @*/
100995fce210SBarry Smith PetscErrorCode PetscSFGetGroups(PetscSF sf,MPI_Group *incoming,MPI_Group *outgoing)
101095fce210SBarry Smith {
101195fce210SBarry Smith   PetscErrorCode ierr;
10127fb8a5e4SKarl Rupp   MPI_Group      group = MPI_GROUP_NULL;
101395fce210SBarry Smith 
101495fce210SBarry Smith   PetscFunctionBegin;
101544ee17edSStefano Zampini   if (sf->nranks < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUpRanks() before obtaining groups");
101695fce210SBarry Smith   if (sf->ingroup == MPI_GROUP_NULL) {
101795fce210SBarry Smith     PetscInt       i;
101895fce210SBarry Smith     const PetscInt *indegree;
101995fce210SBarry Smith     PetscMPIInt    rank,*outranks,*inranks;
102095fce210SBarry Smith     PetscSFNode    *remote;
102195fce210SBarry Smith     PetscSF        bgcount;
102295fce210SBarry Smith 
102395fce210SBarry Smith     /* Compute the number of incoming ranks */
1024785e854fSJed Brown     ierr = PetscMalloc1(sf->nranks,&remote);CHKERRQ(ierr);
102595fce210SBarry Smith     for (i=0; i<sf->nranks; i++) {
102695fce210SBarry Smith       remote[i].rank  = sf->ranks[i];
102795fce210SBarry Smith       remote[i].index = 0;
102895fce210SBarry Smith     }
102995fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,&bgcount);CHKERRQ(ierr);
103095fce210SBarry Smith     ierr = PetscSFSetGraph(bgcount,1,sf->nranks,NULL,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
103195fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(bgcount,&indegree);CHKERRQ(ierr);
103295fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(bgcount,&indegree);CHKERRQ(ierr);
103395fce210SBarry Smith 
103495fce210SBarry Smith     /* Enumerate the incoming ranks */
1035dcca6d9dSJed Brown     ierr = PetscMalloc2(indegree[0],&inranks,sf->nranks,&outranks);CHKERRQ(ierr);
103695fce210SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
103795fce210SBarry Smith     for (i=0; i<sf->nranks; i++) outranks[i] = rank;
103895fce210SBarry Smith     ierr = PetscSFGatherBegin(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
103995fce210SBarry Smith     ierr = PetscSFGatherEnd(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
104095fce210SBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
104195fce210SBarry Smith     ierr = MPI_Group_incl(group,indegree[0],inranks,&sf->ingroup);CHKERRQ(ierr);
104295fce210SBarry Smith     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
104395fce210SBarry Smith     ierr = PetscFree2(inranks,outranks);CHKERRQ(ierr);
104495fce210SBarry Smith     ierr = PetscSFDestroy(&bgcount);CHKERRQ(ierr);
104595fce210SBarry Smith   }
104695fce210SBarry Smith   *incoming = sf->ingroup;
104795fce210SBarry Smith 
104895fce210SBarry Smith   if (sf->outgroup == MPI_GROUP_NULL) {
104995fce210SBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
105095fce210SBarry Smith     ierr = MPI_Group_incl(group,sf->nranks,sf->ranks,&sf->outgroup);CHKERRQ(ierr);
105195fce210SBarry Smith     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
105295fce210SBarry Smith   }
105395fce210SBarry Smith   *outgoing = sf->outgroup;
105495fce210SBarry Smith   PetscFunctionReturn(0);
105595fce210SBarry Smith }
105695fce210SBarry Smith 
105729046d53SLisandro Dalcin /*@
105895fce210SBarry Smith    PetscSFGetMultiSF - gets the inner SF implemeting gathers and scatters
105995fce210SBarry Smith 
106095fce210SBarry Smith    Collective
106195fce210SBarry Smith 
106295fce210SBarry Smith    Input Argument:
106395fce210SBarry Smith .  sf - star forest that may contain roots with 0 or with more than 1 vertex
106495fce210SBarry Smith 
106595fce210SBarry Smith    Output Arguments:
106695fce210SBarry Smith .  multi - star forest with split roots, such that each root has degree exactly 1
106795fce210SBarry Smith 
106895fce210SBarry Smith    Level: developer
106995fce210SBarry Smith 
107095fce210SBarry Smith    Notes:
107195fce210SBarry Smith 
107295fce210SBarry Smith    In most cases, users should use PetscSFGatherBegin() and PetscSFScatterBegin() instead of manipulating multi
107395fce210SBarry Smith    directly. Since multi satisfies the stronger condition that each entry in the global space has exactly one incoming
107495fce210SBarry Smith    edge, it is a candidate for future optimization that might involve its removal.
107595fce210SBarry Smith 
1076673100f5SVaclav Hapla .seealso: PetscSFSetGraph(), PetscSFGatherBegin(), PetscSFScatterBegin(), PetscSFComputeMultiRootOriginalNumbering()
107795fce210SBarry Smith @*/
107895fce210SBarry Smith PetscErrorCode PetscSFGetMultiSF(PetscSF sf,PetscSF *multi)
107995fce210SBarry Smith {
108095fce210SBarry Smith   PetscErrorCode ierr;
108195fce210SBarry Smith 
108295fce210SBarry Smith   PetscFunctionBegin;
108395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
108495fce210SBarry Smith   PetscValidPointer(multi,2);
108595fce210SBarry Smith   if (sf->nroots < 0) {         /* Graph has not been set yet; why do we need this? */
108695fce210SBarry Smith     ierr   = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
108795fce210SBarry Smith     *multi = sf->multi;
108895fce210SBarry Smith     PetscFunctionReturn(0);
108995fce210SBarry Smith   }
109095fce210SBarry Smith   if (!sf->multi) {
109195fce210SBarry Smith     const PetscInt *indegree;
10929837ea96SMatthew G. Knepley     PetscInt       i,*inoffset,*outones,*outoffset,maxlocal;
109395fce210SBarry Smith     PetscSFNode    *remote;
109429046d53SLisandro Dalcin     maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
109595fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(sf,&indegree);CHKERRQ(ierr);
109695fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(sf,&indegree);CHKERRQ(ierr);
10979837ea96SMatthew G. Knepley     ierr = PetscMalloc3(sf->nroots+1,&inoffset,maxlocal,&outones,maxlocal,&outoffset);CHKERRQ(ierr);
109895fce210SBarry Smith     inoffset[0] = 0;
109995fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i+1] = inoffset[i] + indegree[i];
11009837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) outones[i] = 1;
1101dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpBegin(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
1102dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpEnd(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
110395fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i] -= indegree[i]; /* Undo the increment */
110495fce210SBarry Smith #if 0
110595fce210SBarry Smith #if defined(PETSC_USE_DEBUG)                                 /* Check that the expected number of increments occurred */
110695fce210SBarry Smith     for (i=0; i<sf->nroots; i++) {
110795fce210SBarry Smith       if (inoffset[i] + indegree[i] != inoffset[i+1]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Incorrect result after PetscSFFetchAndOp");
110895fce210SBarry Smith     }
110995fce210SBarry Smith #endif
111095fce210SBarry Smith #endif
1111785e854fSJed Brown     ierr = PetscMalloc1(sf->nleaves,&remote);CHKERRQ(ierr);
111295fce210SBarry Smith     for (i=0; i<sf->nleaves; i++) {
111395fce210SBarry Smith       remote[i].rank  = sf->remote[i].rank;
111438e7336fSToby Isaac       remote[i].index = outoffset[sf->mine ? sf->mine[i] : i];
111595fce210SBarry Smith     }
111695fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
111701365b40SToby Isaac     ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
111895fce210SBarry Smith     if (sf->rankorder) {        /* Sort the ranks */
111995fce210SBarry Smith       PetscMPIInt rank;
112095fce210SBarry Smith       PetscInt    *inranks,*newoffset,*outranks,*newoutoffset,*tmpoffset,maxdegree;
112195fce210SBarry Smith       PetscSFNode *newremote;
112295fce210SBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
112395fce210SBarry Smith       for (i=0,maxdegree=0; i<sf->nroots; i++) maxdegree = PetscMax(maxdegree,indegree[i]);
11249837ea96SMatthew G. Knepley       ierr = PetscMalloc5(sf->multi->nroots,&inranks,sf->multi->nroots,&newoffset,maxlocal,&outranks,maxlocal,&newoutoffset,maxdegree,&tmpoffset);CHKERRQ(ierr);
11259837ea96SMatthew G. Knepley       for (i=0; i<maxlocal; i++) outranks[i] = rank;
11268bfbc91cSJed Brown       ierr = PetscSFReduceBegin(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr);
11278bfbc91cSJed Brown       ierr = PetscSFReduceEnd(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr);
112895fce210SBarry Smith       /* Sort the incoming ranks at each vertex, build the inverse map */
112995fce210SBarry Smith       for (i=0; i<sf->nroots; i++) {
113095fce210SBarry Smith         PetscInt j;
113195fce210SBarry Smith         for (j=0; j<indegree[i]; j++) tmpoffset[j] = j;
113295fce210SBarry Smith         ierr = PetscSortIntWithArray(indegree[i],inranks+inoffset[i],tmpoffset);CHKERRQ(ierr);
113395fce210SBarry Smith         for (j=0; j<indegree[i]; j++) newoffset[inoffset[i] + tmpoffset[j]] = inoffset[i] + j;
113495fce210SBarry Smith       }
113595fce210SBarry Smith       ierr = PetscSFBcastBegin(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr);
113695fce210SBarry Smith       ierr = PetscSFBcastEnd(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr);
1137785e854fSJed Brown       ierr = PetscMalloc1(sf->nleaves,&newremote);CHKERRQ(ierr);
113895fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
113995fce210SBarry Smith         newremote[i].rank  = sf->remote[i].rank;
114001365b40SToby Isaac         newremote[i].index = newoutoffset[sf->mine ? sf->mine[i] : i];
114195fce210SBarry Smith       }
114201365b40SToby Isaac       ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,newremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
114395fce210SBarry Smith       ierr = PetscFree5(inranks,newoffset,outranks,newoutoffset,tmpoffset);CHKERRQ(ierr);
114495fce210SBarry Smith     }
114595fce210SBarry Smith     ierr = PetscFree3(inoffset,outones,outoffset);CHKERRQ(ierr);
114695fce210SBarry Smith   }
114795fce210SBarry Smith   *multi = sf->multi;
114895fce210SBarry Smith   PetscFunctionReturn(0);
114995fce210SBarry Smith }
115095fce210SBarry Smith 
115195fce210SBarry Smith /*@C
115295fce210SBarry Smith    PetscSFCreateEmbeddedSF - removes edges from all but the selected roots, does not remap indices
115395fce210SBarry Smith 
115495fce210SBarry Smith    Collective
115595fce210SBarry Smith 
115695fce210SBarry Smith    Input Arguments:
115795fce210SBarry Smith +  sf - original star forest
1158ba2a7774SJunchao Zhang .  nselected  - number of selected roots on this process
1159ba2a7774SJunchao Zhang -  selected   - indices of the selected roots on this process
116095fce210SBarry Smith 
116195fce210SBarry Smith    Output Arguments:
116295fce210SBarry Smith .  newsf - new star forest
116395fce210SBarry Smith 
116495fce210SBarry Smith    Level: advanced
116595fce210SBarry Smith 
116695fce210SBarry Smith    Note:
116795fce210SBarry Smith    To use the new PetscSF, it may be necessary to know the indices of the leaves that are still participating. This can
116895fce210SBarry Smith    be done by calling PetscSFGetGraph().
116995fce210SBarry Smith 
117095fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFGetGraph()
117195fce210SBarry Smith @*/
1172ba2a7774SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
117395fce210SBarry Smith {
1174f659e5c7SJunchao Zhang   PetscInt          i,n,*roots,*rootdata,*leafdata,nroots,nleaves,connected_leaves,*new_ilocal;
1175ba2a7774SJunchao Zhang   const PetscSFNode *iremote;
1176f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1177ba2a7774SJunchao Zhang   PetscSF           tmpsf;
1178f659e5c7SJunchao Zhang   MPI_Comm          comm;
11790511a646SMatthew G. Knepley   PetscErrorCode    ierr;
118095fce210SBarry Smith 
118195fce210SBarry Smith   PetscFunctionBegin;
118295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
118329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1184ba2a7774SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
118595fce210SBarry Smith   PetscValidPointer(newsf,4);
11860511a646SMatthew G. Knepley 
1187f659e5c7SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1188140a1472SStefano Zampini   ierr = PetscLogEventBegin(PETSCSF_EmbedSF,sf,0,0,0);CHKERRQ(ierr);
1189f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in roots[] */
1190f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1191f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&roots);CHKERRQ(ierr);
1192dd5b3ca6SJunchao Zhang   ierr = PetscArraycpy(roots,selected,nselected);CHKERRQ(ierr);
1193f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,roots);CHKERRQ(ierr);
1194f659e5c7SJunchao Zhang   if (nselected && (roots[0] < 0 || roots[nselected-1] >= sf->nroots)) SETERRQ3(comm,PETSC_ERR_ARG_OUTOFRANGE,"Min/Max root indices %D/%D are not in [0,%D)",roots[0],roots[nselected-1],sf->nroots);
1195f659e5c7SJunchao Zhang 
1196f659e5c7SJunchao Zhang   if (sf->ops->CreateEmbeddedSF) {
1197f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedSF)(sf,nselected,roots,newsf);CHKERRQ(ierr);
1198f659e5c7SJunchao Zhang   } else {
1199f659e5c7SJunchao Zhang     /* A generic version of creating embedded sf. Note that we called PetscSFSetGraph() twice, which is certainly expensive */
1200ba2a7774SJunchao Zhang     /* Find out which leaves (not leaf data items) are still connected to roots in the embedded sf */
1201f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,NULL,&iremote);CHKERRQ(ierr);
1202ba2a7774SJunchao Zhang     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&tmpsf);CHKERRQ(ierr);
1203ba2a7774SJunchao Zhang     ierr = PetscSFSetGraph(tmpsf,nroots,nleaves,NULL/*contiguous*/,PETSC_USE_POINTER,iremote,PETSC_USE_POINTER);CHKERRQ(ierr);
1204ba2a7774SJunchao Zhang     ierr = PetscCalloc2(nroots,&rootdata,nleaves,&leafdata);CHKERRQ(ierr);
1205f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) rootdata[roots[i]] = 1;
1206ba2a7774SJunchao Zhang     ierr = PetscSFBcastBegin(tmpsf,MPIU_INT,rootdata,leafdata);CHKERRQ(ierr);
1207ba2a7774SJunchao Zhang     ierr = PetscSFBcastEnd(tmpsf,MPIU_INT,rootdata,leafdata);CHKERRQ(ierr);
1208ba2a7774SJunchao Zhang     ierr = PetscSFDestroy(&tmpsf);CHKERRQ(ierr);
1209ba2a7774SJunchao Zhang 
1210ba2a7774SJunchao Zhang     /* Build newsf with leaves that are still connected */
1211f659e5c7SJunchao Zhang     connected_leaves = 0;
1212f659e5c7SJunchao Zhang     for (i=0; i<nleaves; ++i) connected_leaves += leafdata[i];
1213f659e5c7SJunchao Zhang     ierr = PetscMalloc1(connected_leaves,&new_ilocal);CHKERRQ(ierr);
1214f659e5c7SJunchao Zhang     ierr = PetscMalloc1(connected_leaves,&new_iremote);CHKERRQ(ierr);
1215ba2a7774SJunchao Zhang     for (i=0, n=0; i<nleaves; ++i) {
1216ba2a7774SJunchao Zhang       if (leafdata[i]) {
1217ba2a7774SJunchao Zhang         new_ilocal[n]        = sf->mine ? sf->mine[i] : i;
1218ba2a7774SJunchao Zhang         new_iremote[n].rank  = sf->remote[i].rank;
1219ba2a7774SJunchao Zhang         new_iremote[n].index = sf->remote[i].index;
1220fc1ede2bSMatthew G. Knepley         ++n;
122195fce210SBarry Smith       }
122295fce210SBarry Smith     }
1223f659e5c7SJunchao Zhang 
1224f659e5c7SJunchao Zhang     if (n != connected_leaves) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_PLIB,"There is a size mismatch in the SF embedding, %d != %d",n,connected_leaves);
1225*4cc19a0cSStefano Zampini     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,newsf);CHKERRQ(ierr);
1226f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,connected_leaves,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
122795fce210SBarry Smith     ierr = PetscFree2(rootdata,leafdata);CHKERRQ(ierr);
1228f659e5c7SJunchao Zhang   }
1229f659e5c7SJunchao Zhang   ierr = PetscFree(roots);CHKERRQ(ierr);
1230140a1472SStefano Zampini   ierr = PetscSFSetUp(*newsf);CHKERRQ(ierr);
1231140a1472SStefano Zampini   ierr = PetscLogEventEnd(PETSCSF_EmbedSF,sf,0,0,0);CHKERRQ(ierr);
123295fce210SBarry Smith   PetscFunctionReturn(0);
123395fce210SBarry Smith }
123495fce210SBarry Smith 
12352f5fb4c2SMatthew G. Knepley /*@C
12362f5fb4c2SMatthew G. Knepley   PetscSFCreateEmbeddedLeafSF - removes edges from all but the selected leaves, does not remap indices
12372f5fb4c2SMatthew G. Knepley 
12382f5fb4c2SMatthew G. Knepley   Collective
12392f5fb4c2SMatthew G. Knepley 
12402f5fb4c2SMatthew G. Knepley   Input Arguments:
12412f5fb4c2SMatthew G. Knepley + sf - original star forest
1242f659e5c7SJunchao Zhang . nselected  - number of selected leaves on this process
1243f659e5c7SJunchao Zhang - selected   - indices of the selected leaves on this process
12442f5fb4c2SMatthew G. Knepley 
12452f5fb4c2SMatthew G. Knepley   Output Arguments:
12462f5fb4c2SMatthew G. Knepley .  newsf - new star forest
12472f5fb4c2SMatthew G. Knepley 
12482f5fb4c2SMatthew G. Knepley   Level: advanced
12492f5fb4c2SMatthew G. Knepley 
12502f5fb4c2SMatthew G. Knepley .seealso: PetscSFCreateEmbeddedSF(), PetscSFSetGraph(), PetscSFGetGraph()
12512f5fb4c2SMatthew G. Knepley @*/
1252f659e5c7SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
12532f5fb4c2SMatthew G. Knepley {
1254f659e5c7SJunchao Zhang   const PetscSFNode *iremote;
1255f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1256f659e5c7SJunchao Zhang   const PetscInt    *ilocal;
1257f659e5c7SJunchao Zhang   PetscInt          i,nroots,*leaves,*new_ilocal;
1258f659e5c7SJunchao Zhang   MPI_Comm          comm;
12592f5fb4c2SMatthew G. Knepley   PetscErrorCode    ierr;
12602f5fb4c2SMatthew G. Knepley 
12612f5fb4c2SMatthew G. Knepley   PetscFunctionBegin;
12622f5fb4c2SMatthew G. Knepley   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
126329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1264f659e5c7SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
12652f5fb4c2SMatthew G. Knepley   PetscValidPointer(newsf,4);
12662f5fb4c2SMatthew G. Knepley 
1267f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in leaves[] */
1268f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1269f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&leaves);CHKERRQ(ierr);
1270dd5b3ca6SJunchao Zhang   ierr = PetscArraycpy(leaves,selected,nselected);CHKERRQ(ierr);
1271f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,leaves);CHKERRQ(ierr);
1272f659e5c7SJunchao Zhang   if (nselected && (leaves[0] < 0 || leaves[nselected-1] >= sf->nleaves)) SETERRQ3(comm,PETSC_ERR_ARG_OUTOFRANGE,"Min/Max leaf indices %D/%D are not in [0,%D)",leaves[0],leaves[nselected-1],sf->nleaves);
1273f659e5c7SJunchao Zhang 
1274f659e5c7SJunchao Zhang   /* Optimize the routine only when sf is setup and hence we can reuse sf's communication pattern */
1275f659e5c7SJunchao Zhang   if (sf->setupcalled && sf->ops->CreateEmbeddedLeafSF) {
1276f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedLeafSF)(sf,nselected,leaves,newsf);CHKERRQ(ierr);
1277f659e5c7SJunchao Zhang   } else {
1278f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,NULL,&ilocal,&iremote);CHKERRQ(ierr);
1279f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_ilocal);CHKERRQ(ierr);
1280f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_iremote);CHKERRQ(ierr);
1281f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) {
1282f659e5c7SJunchao Zhang       const PetscInt l     = leaves[i];
1283f659e5c7SJunchao Zhang       new_ilocal[i]        = ilocal ? ilocal[l] : l;
1284f659e5c7SJunchao Zhang       new_iremote[i].rank  = iremote[l].rank;
1285f659e5c7SJunchao Zhang       new_iremote[i].index = iremote[l].index;
12862f5fb4c2SMatthew G. Knepley     }
1287*4cc19a0cSStefano Zampini     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,newsf);CHKERRQ(ierr);
1288f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,nselected,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
1289f659e5c7SJunchao Zhang   }
1290f659e5c7SJunchao Zhang   ierr = PetscFree(leaves);CHKERRQ(ierr);
12912f5fb4c2SMatthew G. Knepley   PetscFunctionReturn(0);
12922f5fb4c2SMatthew G. Knepley }
12932f5fb4c2SMatthew G. Knepley 
129495fce210SBarry Smith /*@C
12953482bfa8SJunchao Zhang    PetscSFBcastAndOpBegin - begin pointwise broadcast with root value being reduced to leaf value, to be concluded with call to PetscSFBcastAndOpEnd()
12963482bfa8SJunchao Zhang 
12973482bfa8SJunchao Zhang    Collective on PetscSF
12983482bfa8SJunchao Zhang 
12993482bfa8SJunchao Zhang    Input Arguments:
13003482bfa8SJunchao Zhang +  sf - star forest on which to communicate
13013482bfa8SJunchao Zhang .  unit - data type associated with each node
13023482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
13033482bfa8SJunchao Zhang -  op - operation to use for reduction
13043482bfa8SJunchao Zhang 
13053482bfa8SJunchao Zhang    Output Arguments:
13063482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
13073482bfa8SJunchao Zhang 
13083482bfa8SJunchao Zhang    Level: intermediate
13093482bfa8SJunchao Zhang 
13103482bfa8SJunchao Zhang .seealso: PetscSFBcastAndOpEnd(), PetscSFBcastBegin(), PetscSFBcastEnd()
13113482bfa8SJunchao Zhang @*/
13123482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpBegin(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
13133482bfa8SJunchao Zhang {
13143482bfa8SJunchao Zhang   PetscErrorCode ierr;
1315eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
13163482bfa8SJunchao Zhang 
13173482bfa8SJunchao Zhang   PetscFunctionBegin;
13183482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
13193482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
13203482bfa8SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1321eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1322eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1323eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
1324eb02082bSJunchao Zhang   /*  Shall we assume rootdata, leafdata are ready to use (instead of being computed by some asynchronous kernels)?
1325eb02082bSJunchao Zhang     To be similar to MPI, I'd like to have this assumption, since MPI does not have a concept of stream.
1326eb02082bSJunchao Zhang     But currently this assumption is not enforecd in Petsc. To be safe, I do synchronization here. Otherwise, if
1327eb02082bSJunchao Zhang     we do not sync now and call the Pack kernel directly on the default NULL stream (assume petsc objects are also
1328eb02082bSJunchao Zhang     computed on it), we have to sync the NULL stream before calling MPI routines. So, it looks a cudaDeviceSynchronize
1329eb02082bSJunchao Zhang     is inevitable. We do it now and put pack/unpack kernels to non-NULL streams.
1330eb02082bSJunchao Zhang    */
1331eb02082bSJunchao Zhang   if (rootmtype == PETSC_MEMTYPE_DEVICE || leafmtype == PETSC_MEMTYPE_DEVICE) {cudaError_t err = cudaDeviceSynchronize();CHKERRCUDA(err);}
1332eb02082bSJunchao Zhang #endif
1333eb02082bSJunchao Zhang   ierr = (*sf->ops->BcastAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr);
13343482bfa8SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
13353482bfa8SJunchao Zhang   PetscFunctionReturn(0);
13363482bfa8SJunchao Zhang }
13373482bfa8SJunchao Zhang 
13383482bfa8SJunchao Zhang /*@C
13393482bfa8SJunchao Zhang    PetscSFBcastAndOpEnd - end a broadcast & reduce operation started with PetscSFBcastAndOpBegin()
13403482bfa8SJunchao Zhang 
13413482bfa8SJunchao Zhang    Collective
13423482bfa8SJunchao Zhang 
13433482bfa8SJunchao Zhang    Input Arguments:
13443482bfa8SJunchao Zhang +  sf - star forest
13453482bfa8SJunchao Zhang .  unit - data type
13463482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
13473482bfa8SJunchao Zhang -  op - operation to use for reduction
13483482bfa8SJunchao Zhang 
13493482bfa8SJunchao Zhang    Output Arguments:
13503482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
13513482bfa8SJunchao Zhang 
13523482bfa8SJunchao Zhang    Level: intermediate
13533482bfa8SJunchao Zhang 
13543482bfa8SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFReduceEnd()
13553482bfa8SJunchao Zhang @*/
13563482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpEnd(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
13573482bfa8SJunchao Zhang {
13583482bfa8SJunchao Zhang   PetscErrorCode ierr;
1359eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
13603482bfa8SJunchao Zhang 
13613482bfa8SJunchao Zhang   PetscFunctionBegin;
13623482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
13633482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
13643482bfa8SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1365eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1366eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1367eb02082bSJunchao Zhang   ierr = (*sf->ops->BcastAndOpEnd)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr);
13683482bfa8SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
13693482bfa8SJunchao Zhang   PetscFunctionReturn(0);
13703482bfa8SJunchao Zhang }
13713482bfa8SJunchao Zhang 
13723482bfa8SJunchao Zhang /*@C
137395fce210SBarry Smith    PetscSFReduceBegin - begin reduction of leafdata into rootdata, to be completed with call to PetscSFReduceEnd()
137495fce210SBarry Smith 
137595fce210SBarry Smith    Collective
137695fce210SBarry Smith 
137795fce210SBarry Smith    Input Arguments:
137895fce210SBarry Smith +  sf - star forest
137995fce210SBarry Smith .  unit - data type
138095fce210SBarry Smith .  leafdata - values to reduce
138195fce210SBarry Smith -  op - reduction operation
138295fce210SBarry Smith 
138395fce210SBarry Smith    Output Arguments:
138495fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
138595fce210SBarry Smith 
138695fce210SBarry Smith    Level: intermediate
138795fce210SBarry Smith 
138895fce210SBarry Smith .seealso: PetscSFBcastBegin()
138995fce210SBarry Smith @*/
139095fce210SBarry Smith PetscErrorCode PetscSFReduceBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
139195fce210SBarry Smith {
139295fce210SBarry Smith   PetscErrorCode ierr;
1393eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
139495fce210SBarry Smith 
139595fce210SBarry Smith   PetscFunctionBegin;
139695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
139795fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
139829046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);
1399eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1400eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1401eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
1402eb02082bSJunchao Zhang   if (rootmtype == PETSC_MEMTYPE_DEVICE || leafmtype == PETSC_MEMTYPE_DEVICE) {cudaError_t err = cudaDeviceSynchronize();CHKERRCUDA(err);}
1403eb02082bSJunchao Zhang #endif
1404eb02082bSJunchao Zhang   ierr = (sf->ops->ReduceBegin)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr);
1405563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);
140695fce210SBarry Smith   PetscFunctionReturn(0);
140795fce210SBarry Smith }
140895fce210SBarry Smith 
140995fce210SBarry Smith /*@C
141095fce210SBarry Smith    PetscSFReduceEnd - end a reduction operation started with PetscSFReduceBegin()
141195fce210SBarry Smith 
141295fce210SBarry Smith    Collective
141395fce210SBarry Smith 
141495fce210SBarry Smith    Input Arguments:
141595fce210SBarry Smith +  sf - star forest
141695fce210SBarry Smith .  unit - data type
141795fce210SBarry Smith .  leafdata - values to reduce
141895fce210SBarry Smith -  op - reduction operation
141995fce210SBarry Smith 
142095fce210SBarry Smith    Output Arguments:
142195fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
142295fce210SBarry Smith 
142395fce210SBarry Smith    Level: intermediate
142495fce210SBarry Smith 
142595fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFBcastEnd()
142695fce210SBarry Smith @*/
142795fce210SBarry Smith PetscErrorCode PetscSFReduceEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
142895fce210SBarry Smith {
142995fce210SBarry Smith   PetscErrorCode ierr;
1430eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
143195fce210SBarry Smith 
143295fce210SBarry Smith   PetscFunctionBegin;
143395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
143495fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
143529046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);
1436eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1437eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1438eb02082bSJunchao Zhang   ierr = (*sf->ops->ReduceEnd)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr);
1439563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);
144095fce210SBarry Smith   PetscFunctionReturn(0);
144195fce210SBarry Smith }
144295fce210SBarry Smith 
144395fce210SBarry Smith /*@C
1444a1729e3fSJunchao Zhang    PetscSFFetchAndOpBegin - begin operation that fetches values from root and updates atomically by applying operation using my leaf value, to be completed with PetscSFFetchAndOpEnd()
1445a1729e3fSJunchao Zhang 
1446a1729e3fSJunchao Zhang    Collective
1447a1729e3fSJunchao Zhang 
1448a1729e3fSJunchao Zhang    Input Arguments:
1449a1729e3fSJunchao Zhang +  sf - star forest
1450a1729e3fSJunchao Zhang .  unit - data type
1451a1729e3fSJunchao Zhang .  leafdata - leaf values to use in reduction
1452a1729e3fSJunchao Zhang -  op - operation to use for reduction
1453a1729e3fSJunchao Zhang 
1454a1729e3fSJunchao Zhang    Output Arguments:
1455a1729e3fSJunchao Zhang +  rootdata - root values to be updated, input state is seen by first process to perform an update
1456a1729e3fSJunchao Zhang -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
1457a1729e3fSJunchao Zhang 
1458a1729e3fSJunchao Zhang    Level: advanced
1459a1729e3fSJunchao Zhang 
1460a1729e3fSJunchao Zhang    Note:
1461a1729e3fSJunchao Zhang    The update is only atomic at the granularity provided by the hardware. Different roots referenced by the same process
1462a1729e3fSJunchao Zhang    might be updated in a different order. Furthermore, if a composite type is used for the unit datatype, atomicity is
1463a1729e3fSJunchao Zhang    not guaranteed across the whole vertex. Therefore, this function is mostly only used with primitive types such as
1464a1729e3fSJunchao Zhang    integers.
1465a1729e3fSJunchao Zhang 
1466a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeBegin(), PetscSFReduceBegin(), PetscSFSetGraph()
1467a1729e3fSJunchao Zhang @*/
1468a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpBegin(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
1469a1729e3fSJunchao Zhang {
1470a1729e3fSJunchao Zhang   PetscErrorCode ierr;
1471eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype,leafupdatemtype;
1472a1729e3fSJunchao Zhang 
1473a1729e3fSJunchao Zhang   PetscFunctionBegin;
1474a1729e3fSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1475a1729e3fSJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1476a1729e3fSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1477eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1478eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1479eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafupdate,&leafupdatemtype);CHKERRQ(ierr);
1480eb02082bSJunchao Zhang   if (leafmtype != leafupdatemtype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for leafdata and leafupdate in different memory types");
1481eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
1482eb02082bSJunchao Zhang   if (rootmtype == PETSC_MEMTYPE_DEVICE || leafmtype == PETSC_MEMTYPE_DEVICE) {cudaError_t err = cudaDeviceSynchronize();CHKERRCUDA(err);}
1483eb02082bSJunchao Zhang #endif
1484eb02082bSJunchao Zhang   ierr = (*sf->ops->FetchAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,leafupdate,op);CHKERRQ(ierr);
1485a1729e3fSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1486a1729e3fSJunchao Zhang   PetscFunctionReturn(0);
1487a1729e3fSJunchao Zhang }
1488a1729e3fSJunchao Zhang 
1489a1729e3fSJunchao Zhang /*@C
1490a1729e3fSJunchao Zhang    PetscSFFetchAndOpEnd - end operation started in matching call to PetscSFFetchAndOpBegin() to fetch values from roots and update atomically by applying operation using my leaf value
1491a1729e3fSJunchao Zhang 
1492a1729e3fSJunchao Zhang    Collective
1493a1729e3fSJunchao Zhang 
1494a1729e3fSJunchao Zhang    Input Arguments:
1495a1729e3fSJunchao Zhang +  sf - star forest
1496a1729e3fSJunchao Zhang .  unit - data type
1497a1729e3fSJunchao Zhang .  leafdata - leaf values to use in reduction
1498a1729e3fSJunchao Zhang -  op - operation to use for reduction
1499a1729e3fSJunchao Zhang 
1500a1729e3fSJunchao Zhang    Output Arguments:
1501a1729e3fSJunchao Zhang +  rootdata - root values to be updated, input state is seen by first process to perform an update
1502a1729e3fSJunchao Zhang -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
1503a1729e3fSJunchao Zhang 
1504a1729e3fSJunchao Zhang    Level: advanced
1505a1729e3fSJunchao Zhang 
1506a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeEnd(), PetscSFReduceEnd(), PetscSFSetGraph()
1507a1729e3fSJunchao Zhang @*/
1508a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpEnd(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
1509a1729e3fSJunchao Zhang {
1510a1729e3fSJunchao Zhang   PetscErrorCode ierr;
1511eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype,leafupdatemtype;
1512a1729e3fSJunchao Zhang 
1513a1729e3fSJunchao Zhang   PetscFunctionBegin;
1514a1729e3fSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1515a1729e3fSJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1516a1729e3fSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1517eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1518eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1519eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafupdate,&leafupdatemtype);CHKERRQ(ierr);
1520eb02082bSJunchao Zhang   if (leafmtype != leafupdatemtype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for leafdata and leafupdate in different memory types");
1521eb02082bSJunchao Zhang   ierr = (*sf->ops->FetchAndOpEnd)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,leafupdate,op);CHKERRQ(ierr);
1522a1729e3fSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1523a1729e3fSJunchao Zhang   PetscFunctionReturn(0);
1524a1729e3fSJunchao Zhang }
1525a1729e3fSJunchao Zhang 
1526a1729e3fSJunchao Zhang /*@C
152795fce210SBarry Smith    PetscSFComputeDegreeBegin - begin computation of degree for each root vertex, to be completed with PetscSFComputeDegreeEnd()
152895fce210SBarry Smith 
152995fce210SBarry Smith    Collective
153095fce210SBarry Smith 
153195fce210SBarry Smith    Input Arguments:
153295fce210SBarry Smith .  sf - star forest
153395fce210SBarry Smith 
153495fce210SBarry Smith    Output Arguments:
153595fce210SBarry Smith .  degree - degree of each root vertex
153695fce210SBarry Smith 
153795fce210SBarry Smith    Level: advanced
153895fce210SBarry Smith 
1539ffe67aa5SVáclav Hapla    Notes:
1540ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1541ffe67aa5SVáclav Hapla 
154295fce210SBarry Smith .seealso: PetscSFGatherBegin()
154395fce210SBarry Smith @*/
154495fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeBegin(PetscSF sf,const PetscInt **degree)
154595fce210SBarry Smith {
154695fce210SBarry Smith   PetscErrorCode ierr;
154795fce210SBarry Smith 
154895fce210SBarry Smith   PetscFunctionBegin;
154995fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
155095fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
155195fce210SBarry Smith   PetscValidPointer(degree,2);
1552803bd9e8SMatthew G. Knepley   if (!sf->degreeknown) {
155329046d53SLisandro Dalcin     PetscInt i, nroots = sf->nroots, maxlocal = sf->maxleaf+1;  /* TODO: We should use PetscSFGetLeafRange() */
1554803bd9e8SMatthew G. Knepley     if (sf->degree) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Calls to PetscSFComputeDegreeBegin() cannot be nested.");
155529046d53SLisandro Dalcin     ierr = PetscMalloc1(nroots,&sf->degree);CHKERRQ(ierr);
155629046d53SLisandro Dalcin     ierr = PetscMalloc1(PetscMax(maxlocal,1),&sf->degreetmp);CHKERRQ(ierr); /* allocate at least one entry, see check in PetscSFComputeDegreeEnd() */
155729046d53SLisandro Dalcin     for (i=0; i<nroots; i++) sf->degree[i] = 0;
15589837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) sf->degreetmp[i] = 1;
1559dbd2ff41SBarry Smith     ierr = PetscSFReduceBegin(sf,MPIU_INT,sf->degreetmp,sf->degree,MPI_SUM);CHKERRQ(ierr);
156095fce210SBarry Smith   }
156195fce210SBarry Smith   *degree = NULL;
156295fce210SBarry Smith   PetscFunctionReturn(0);
156395fce210SBarry Smith }
156495fce210SBarry Smith 
156595fce210SBarry Smith /*@C
156695fce210SBarry Smith    PetscSFComputeDegreeEnd - complete computation of degree for each root vertex, started with PetscSFComputeDegreeBegin()
156795fce210SBarry Smith 
156895fce210SBarry Smith    Collective
156995fce210SBarry Smith 
157095fce210SBarry Smith    Input Arguments:
157195fce210SBarry Smith .  sf - star forest
157295fce210SBarry Smith 
157395fce210SBarry Smith    Output Arguments:
157495fce210SBarry Smith .  degree - degree of each root vertex
157595fce210SBarry Smith 
157695fce210SBarry Smith    Level: developer
157795fce210SBarry Smith 
1578ffe67aa5SVáclav Hapla    Notes:
1579ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1580ffe67aa5SVáclav Hapla 
158195fce210SBarry Smith .seealso:
158295fce210SBarry Smith @*/
158395fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeEnd(PetscSF sf,const PetscInt **degree)
158495fce210SBarry Smith {
158595fce210SBarry Smith   PetscErrorCode ierr;
158695fce210SBarry Smith 
158795fce210SBarry Smith   PetscFunctionBegin;
158895fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
158995fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
159029046d53SLisandro Dalcin   PetscValidPointer(degree,2);
159195fce210SBarry Smith   if (!sf->degreeknown) {
159229046d53SLisandro Dalcin     if (!sf->degreetmp) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call PetscSFComputeDegreeBegin() before PetscSFComputeDegreeEnd()");
1593dbd2ff41SBarry Smith     ierr = PetscSFReduceEnd(sf,MPIU_INT,sf->degreetmp,sf->degree,MPI_SUM);CHKERRQ(ierr);
159495fce210SBarry Smith     ierr = PetscFree(sf->degreetmp);CHKERRQ(ierr);
159595fce210SBarry Smith     sf->degreeknown = PETSC_TRUE;
159695fce210SBarry Smith   }
159795fce210SBarry Smith   *degree = sf->degree;
159895fce210SBarry Smith   PetscFunctionReturn(0);
159995fce210SBarry Smith }
160095fce210SBarry Smith 
1601673100f5SVaclav Hapla 
1602673100f5SVaclav Hapla /*@C
160366dfcd1aSVaclav Hapla    PetscSFComputeMultiRootOriginalNumbering - Returns original numbering of multi-roots (roots of multi-SF returned by PetscSFGetMultiSF()).
160466dfcd1aSVaclav Hapla    Each multi-root is assigned index of the corresponding original root.
1605673100f5SVaclav Hapla 
1606673100f5SVaclav Hapla    Collective
1607673100f5SVaclav Hapla 
1608673100f5SVaclav Hapla    Input Arguments:
1609673100f5SVaclav Hapla +  sf - star forest
1610673100f5SVaclav Hapla -  degree - degree of each root vertex, computed with PetscSFComputeDegreeBegin()/PetscSFComputeDegreeEnd()
1611673100f5SVaclav Hapla 
1612673100f5SVaclav Hapla    Output Arguments:
161366dfcd1aSVaclav Hapla +  nMultiRoots - (optional) number of multi-roots (roots of multi-SF)
161466dfcd1aSVaclav Hapla -  multiRootsOrigNumbering - original indices of multi-roots; length of this array is nMultiRoots
1615673100f5SVaclav Hapla 
1616673100f5SVaclav Hapla    Level: developer
1617673100f5SVaclav Hapla 
1618ffe67aa5SVáclav Hapla    Notes:
1619ffe67aa5SVáclav Hapla    The returned array multiRootsOrigNumbering is newly allocated and should be destroyed with PetscFree() when no longer needed.
1620ffe67aa5SVáclav Hapla 
1621673100f5SVaclav Hapla .seealso: PetscSFComputeDegreeBegin(), PetscSFComputeDegreeEnd(), PetscSFGetMultiSF()
1622673100f5SVaclav Hapla @*/
162366dfcd1aSVaclav Hapla PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF sf, const PetscInt degree[], PetscInt *nMultiRoots, PetscInt *multiRootsOrigNumbering[])
1624673100f5SVaclav Hapla {
1625673100f5SVaclav Hapla   PetscSF             msf;
1626673100f5SVaclav Hapla   PetscInt            i, j, k, nroots, nmroots;
1627673100f5SVaclav Hapla   PetscErrorCode      ierr;
1628673100f5SVaclav Hapla 
1629673100f5SVaclav Hapla   PetscFunctionBegin;
1630673100f5SVaclav Hapla   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1631673100f5SVaclav Hapla   ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
163229328920SVaclav Hapla   if (nroots) PetscValidIntPointer(degree,2);
163366dfcd1aSVaclav Hapla   if (nMultiRoots) PetscValidIntPointer(nMultiRoots,3);
163466dfcd1aSVaclav Hapla   PetscValidPointer(multiRootsOrigNumbering,4);
1635673100f5SVaclav Hapla   ierr = PetscSFGetMultiSF(sf,&msf);CHKERRQ(ierr);
1636673100f5SVaclav Hapla   ierr = PetscSFGetGraph(msf, &nmroots, NULL, NULL, NULL);CHKERRQ(ierr);
163766dfcd1aSVaclav Hapla   ierr = PetscMalloc1(nmroots, multiRootsOrigNumbering);CHKERRQ(ierr);
1638673100f5SVaclav Hapla   for (i=0,j=0,k=0; i<nroots; i++) {
1639673100f5SVaclav Hapla     if (!degree[i]) continue;
1640673100f5SVaclav Hapla     for (j=0; j<degree[i]; j++,k++) {
164166dfcd1aSVaclav Hapla       (*multiRootsOrigNumbering)[k] = i;
1642673100f5SVaclav Hapla     }
1643673100f5SVaclav Hapla   }
1644673100f5SVaclav Hapla #if defined(PETSC_USE_DEBUG)
1645673100f5SVaclav Hapla   if (PetscUnlikely(k != nmroots)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"sanity check fail");
1646673100f5SVaclav Hapla #endif
164766dfcd1aSVaclav Hapla   if (nMultiRoots) *nMultiRoots = nmroots;
1648673100f5SVaclav Hapla   PetscFunctionReturn(0);
1649673100f5SVaclav Hapla }
1650673100f5SVaclav Hapla 
165195fce210SBarry Smith /*@C
165295fce210SBarry Smith    PetscSFGatherBegin - begin pointwise gather of all leaves into multi-roots, to be completed with PetscSFGatherEnd()
165395fce210SBarry Smith 
165495fce210SBarry Smith    Collective
165595fce210SBarry Smith 
165695fce210SBarry Smith    Input Arguments:
165795fce210SBarry Smith +  sf - star forest
165895fce210SBarry Smith .  unit - data type
165995fce210SBarry Smith -  leafdata - leaf data to gather to roots
166095fce210SBarry Smith 
166195fce210SBarry Smith    Output Argument:
166295fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
166395fce210SBarry Smith 
166495fce210SBarry Smith    Level: intermediate
166595fce210SBarry Smith 
166695fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
166795fce210SBarry Smith @*/
166895fce210SBarry Smith PetscErrorCode PetscSFGatherBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
166995fce210SBarry Smith {
167095fce210SBarry Smith   PetscErrorCode ierr;
167195fce210SBarry Smith   PetscSF        multi;
167295fce210SBarry Smith 
167395fce210SBarry Smith   PetscFunctionBegin;
167495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
167529046d53SLisandro Dalcin   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
167695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
16778bfbc91cSJed Brown   ierr = PetscSFReduceBegin(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr);
167895fce210SBarry Smith   PetscFunctionReturn(0);
167995fce210SBarry Smith }
168095fce210SBarry Smith 
168195fce210SBarry Smith /*@C
168295fce210SBarry Smith    PetscSFGatherEnd - ends pointwise gather operation that was started with PetscSFGatherBegin()
168395fce210SBarry Smith 
168495fce210SBarry Smith    Collective
168595fce210SBarry Smith 
168695fce210SBarry Smith    Input Arguments:
168795fce210SBarry Smith +  sf - star forest
168895fce210SBarry Smith .  unit - data type
168995fce210SBarry Smith -  leafdata - leaf data to gather to roots
169095fce210SBarry Smith 
169195fce210SBarry Smith    Output Argument:
169295fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
169395fce210SBarry Smith 
169495fce210SBarry Smith    Level: intermediate
169595fce210SBarry Smith 
169695fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
169795fce210SBarry Smith @*/
169895fce210SBarry Smith PetscErrorCode PetscSFGatherEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
169995fce210SBarry Smith {
170095fce210SBarry Smith   PetscErrorCode ierr;
170195fce210SBarry Smith   PetscSF        multi;
170295fce210SBarry Smith 
170395fce210SBarry Smith   PetscFunctionBegin;
170495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
170595fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
170695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
17078bfbc91cSJed Brown   ierr = PetscSFReduceEnd(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr);
170895fce210SBarry Smith   PetscFunctionReturn(0);
170995fce210SBarry Smith }
171095fce210SBarry Smith 
171195fce210SBarry Smith /*@C
171295fce210SBarry Smith    PetscSFScatterBegin - begin pointwise scatter operation from multi-roots to leaves, to be completed with PetscSFScatterEnd()
171395fce210SBarry Smith 
171495fce210SBarry Smith    Collective
171595fce210SBarry Smith 
171695fce210SBarry Smith    Input Arguments:
171795fce210SBarry Smith +  sf - star forest
171895fce210SBarry Smith .  unit - data type
171995fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
172095fce210SBarry Smith 
172195fce210SBarry Smith    Output Argument:
172295fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
172395fce210SBarry Smith 
172495fce210SBarry Smith    Level: intermediate
172595fce210SBarry Smith 
172695fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
172795fce210SBarry Smith @*/
172895fce210SBarry Smith PetscErrorCode PetscSFScatterBegin(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
172995fce210SBarry Smith {
173095fce210SBarry Smith   PetscErrorCode ierr;
173195fce210SBarry Smith   PetscSF        multi;
173295fce210SBarry Smith 
173395fce210SBarry Smith   PetscFunctionBegin;
173495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
173595fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
173695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
173795fce210SBarry Smith   ierr = PetscSFBcastBegin(multi,unit,multirootdata,leafdata);CHKERRQ(ierr);
173895fce210SBarry Smith   PetscFunctionReturn(0);
173995fce210SBarry Smith }
174095fce210SBarry Smith 
174195fce210SBarry Smith /*@C
174295fce210SBarry Smith    PetscSFScatterEnd - ends pointwise scatter operation that was started with PetscSFScatterBegin()
174395fce210SBarry Smith 
174495fce210SBarry Smith    Collective
174595fce210SBarry Smith 
174695fce210SBarry Smith    Input Arguments:
174795fce210SBarry Smith +  sf - star forest
174895fce210SBarry Smith .  unit - data type
174995fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
175095fce210SBarry Smith 
175195fce210SBarry Smith    Output Argument:
175295fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
175395fce210SBarry Smith 
175495fce210SBarry Smith    Level: intermediate
175595fce210SBarry Smith 
175695fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
175795fce210SBarry Smith @*/
175895fce210SBarry Smith PetscErrorCode PetscSFScatterEnd(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
175995fce210SBarry Smith {
176095fce210SBarry Smith   PetscErrorCode ierr;
176195fce210SBarry Smith   PetscSF        multi;
176295fce210SBarry Smith 
176395fce210SBarry Smith   PetscFunctionBegin;
176495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
176595fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
176695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
176795fce210SBarry Smith   ierr = PetscSFBcastEnd(multi,unit,multirootdata,leafdata);CHKERRQ(ierr);
176895fce210SBarry Smith   PetscFunctionReturn(0);
176995fce210SBarry Smith }
1770a7b3aa13SAta Mesgarnejad 
1771a072220fSLawrence Mitchell static PetscErrorCode PetscSFCheckLeavesUnique_Private(PetscSF sf)
1772a072220fSLawrence Mitchell {
1773a072220fSLawrence Mitchell #if defined(PETSC_USE_DEBUG)
1774a072220fSLawrence Mitchell   PetscInt        i, n, nleaves;
1775a072220fSLawrence Mitchell   const PetscInt *ilocal = NULL;
1776a072220fSLawrence Mitchell   PetscHSetI      seen;
1777a072220fSLawrence Mitchell   PetscErrorCode  ierr;
1778a072220fSLawrence Mitchell 
1779a072220fSLawrence Mitchell   PetscFunctionBegin;
1780a072220fSLawrence Mitchell   ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
1781a072220fSLawrence Mitchell   ierr = PetscHSetICreate(&seen);CHKERRQ(ierr);
1782a072220fSLawrence Mitchell   for (i = 0; i < nleaves; i++) {
1783a072220fSLawrence Mitchell     const PetscInt leaf = ilocal ? ilocal[i] : i;
1784a072220fSLawrence Mitchell     ierr = PetscHSetIAdd(seen,leaf);CHKERRQ(ierr);
1785a072220fSLawrence Mitchell   }
1786a072220fSLawrence Mitchell   ierr = PetscHSetIGetSize(seen,&n);CHKERRQ(ierr);
1787a072220fSLawrence Mitchell   if (n != nleaves) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided leaves have repeated values: all leaves must be unique");
1788a072220fSLawrence Mitchell   ierr = PetscHSetIDestroy(&seen);CHKERRQ(ierr);
1789a072220fSLawrence Mitchell   PetscFunctionReturn(0);
1790a072220fSLawrence Mitchell #else
1791a072220fSLawrence Mitchell   PetscFunctionBegin;
1792a072220fSLawrence Mitchell   PetscFunctionReturn(0);
1793a072220fSLawrence Mitchell #endif
1794a072220fSLawrence Mitchell }
179554729392SStefano Zampini 
1796a7b3aa13SAta Mesgarnejad /*@
179704c0ada0SJunchao Zhang   PetscSFCompose - Compose a new PetscSF by putting the second SF under the first one in a top (roots) down (leaves) view
1798a7b3aa13SAta Mesgarnejad 
1799a7b3aa13SAta Mesgarnejad   Input Parameters:
180054729392SStefano Zampini + sfA - The first PetscSF
180154729392SStefano Zampini - sfB - The second PetscSF
1802a7b3aa13SAta Mesgarnejad 
1803a7b3aa13SAta Mesgarnejad   Output Parameters:
180454729392SStefano Zampini . sfBA - The composite SF
1805a7b3aa13SAta Mesgarnejad 
1806a7b3aa13SAta Mesgarnejad   Level: developer
1807a7b3aa13SAta Mesgarnejad 
1808a072220fSLawrence Mitchell   Notes:
180954729392SStefano Zampini   Currently, the two SFs must be defined on congruent communicators and they must be true star
181054729392SStefano Zampini   forests, i.e. the same leaf is not connected with different roots.
181154729392SStefano Zampini 
181254729392SStefano Zampini   sfA's leaf space and sfB's root space might be partially overlapped. The composition builds
181354729392SStefano Zampini   a graph with sfA's roots and sfB's leaves only when there is a path between them. Unconnected
181454729392SStefano Zampini   nodes (roots or leaves) are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a
181554729392SStefano Zampini   Bcast on sfA, then a Bcast on sfB, on connected nodes.
1816a072220fSLawrence Mitchell 
181704c0ada0SJunchao Zhang .seealso: PetscSF, PetscSFComposeInverse(), PetscSFGetGraph(), PetscSFSetGraph()
1818a7b3aa13SAta Mesgarnejad @*/
1819a7b3aa13SAta Mesgarnejad PetscErrorCode PetscSFCompose(PetscSF sfA,PetscSF sfB,PetscSF *sfBA)
1820a7b3aa13SAta Mesgarnejad {
182104c0ada0SJunchao Zhang   PetscErrorCode    ierr;
1822a7b3aa13SAta Mesgarnejad   const PetscSFNode *remotePointsA,*remotePointsB;
1823d41018fbSJunchao Zhang   PetscSFNode       *remotePointsBA=NULL,*reorderedRemotePointsA = NULL,*leafdataB;
182454729392SStefano Zampini   const PetscInt    *localPointsA,*localPointsB;
182554729392SStefano Zampini   PetscInt          *localPointsBA;
182654729392SStefano Zampini   PetscInt          i,numRootsA,numLeavesA,numRootsB,numLeavesB,minleaf,maxleaf,numLeavesBA;
182754729392SStefano Zampini   PetscBool         denseB;
1828a7b3aa13SAta Mesgarnejad 
1829a7b3aa13SAta Mesgarnejad   PetscFunctionBegin;
1830a7b3aa13SAta Mesgarnejad   PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1);
183129046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfA,1);
183229046d53SLisandro Dalcin   PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2);
183329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfB,2);
183454729392SStefano Zampini   PetscCheckSameComm(sfA,1,sfB,2);
183529046d53SLisandro Dalcin   PetscValidPointer(sfBA,3);
183654729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr);
183754729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr);
183854729392SStefano Zampini 
1839a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfA,&numRootsA,&numLeavesA,&localPointsA,&remotePointsA);CHKERRQ(ierr);
1840a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfB,&numRootsB,&numLeavesB,&localPointsB,&remotePointsB);CHKERRQ(ierr);
1841d41018fbSJunchao Zhang   if (localPointsA) {
184254729392SStefano Zampini     ierr = PetscMalloc1(numRootsB,&reorderedRemotePointsA);CHKERRQ(ierr);
184354729392SStefano Zampini     for (i=0; i<numRootsB; i++) {
184454729392SStefano Zampini       reorderedRemotePointsA[i].rank = -1;
184554729392SStefano Zampini       reorderedRemotePointsA[i].index = -1;
184654729392SStefano Zampini     }
184754729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
184854729392SStefano Zampini       if (localPointsA[i] >= numRootsB) continue;
184954729392SStefano Zampini       reorderedRemotePointsA[localPointsA[i]] = remotePointsA[i];
185054729392SStefano Zampini     }
1851d41018fbSJunchao Zhang     remotePointsA = reorderedRemotePointsA;
1852d41018fbSJunchao Zhang   }
1853d41018fbSJunchao Zhang   ierr = PetscSFGetLeafRange(sfB,&minleaf,&maxleaf);CHKERRQ(ierr);
1854d41018fbSJunchao Zhang   ierr = PetscMalloc1(maxleaf-minleaf+1,&leafdataB);CHKERRQ(ierr);
1855d41018fbSJunchao Zhang   ierr = PetscSFBcastBegin(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf);CHKERRQ(ierr);
1856d41018fbSJunchao Zhang   ierr = PetscSFBcastEnd(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf);CHKERRQ(ierr);
1857d41018fbSJunchao Zhang   ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr);
1858d41018fbSJunchao Zhang 
185954729392SStefano Zampini   denseB = (PetscBool)!localPointsB;
186054729392SStefano Zampini   for (i=0,numLeavesBA=0; i<numLeavesB; i++) {
186154729392SStefano Zampini     if (leafdataB[localPointsB ? localPointsB[i]-minleaf : i].rank == -1) denseB = PETSC_FALSE;
186254729392SStefano Zampini     else numLeavesBA++;
186354729392SStefano Zampini   }
186454729392SStefano Zampini   if (denseB) {
1865d41018fbSJunchao Zhang     localPointsBA  = NULL;
1866d41018fbSJunchao Zhang     remotePointsBA = leafdataB;
1867d41018fbSJunchao Zhang   } else {
186854729392SStefano Zampini     ierr = PetscMalloc1(numLeavesBA,&localPointsBA);CHKERRQ(ierr);
186954729392SStefano Zampini     ierr = PetscMalloc1(numLeavesBA,&remotePointsBA);CHKERRQ(ierr);
187054729392SStefano Zampini     for (i=0,numLeavesBA=0; i<numLeavesB; i++) {
187154729392SStefano Zampini       const PetscInt l = localPointsB ? localPointsB[i] : i;
187254729392SStefano Zampini 
187354729392SStefano Zampini       if (leafdataB[l-minleaf].rank == -1) continue;
187454729392SStefano Zampini       remotePointsBA[numLeavesBA] = leafdataB[l-minleaf];
187554729392SStefano Zampini       localPointsBA[numLeavesBA] = l;
187654729392SStefano Zampini       numLeavesBA++;
187754729392SStefano Zampini     }
1878d41018fbSJunchao Zhang     ierr = PetscFree(leafdataB);CHKERRQ(ierr);
1879d41018fbSJunchao Zhang   }
188054729392SStefano Zampini   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr);
188154729392SStefano Zampini   ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr);
1882a7b3aa13SAta Mesgarnejad   PetscFunctionReturn(0);
1883a7b3aa13SAta Mesgarnejad }
18841c6ba672SJunchao Zhang 
188504c0ada0SJunchao Zhang /*@
188654729392SStefano Zampini   PetscSFComposeInverse - Compose a new PetscSF by putting the inverse of the second SF under the first one
188704c0ada0SJunchao Zhang 
188804c0ada0SJunchao Zhang   Input Parameters:
188954729392SStefano Zampini + sfA - The first PetscSF
189054729392SStefano Zampini - sfB - The second PetscSF
189104c0ada0SJunchao Zhang 
189204c0ada0SJunchao Zhang   Output Parameters:
189354729392SStefano Zampini . sfBA - The composite SF.
189404c0ada0SJunchao Zhang 
189504c0ada0SJunchao Zhang   Level: developer
189604c0ada0SJunchao Zhang 
189754729392SStefano Zampini   Notes:
189854729392SStefano Zampini   Currently, the two SFs must be defined on congruent communicators and they must be true star
189954729392SStefano Zampini   forests, i.e. the same leaf is not connected with different roots. Even more, all roots of the
190054729392SStefano Zampini   second SF must have a degree of 1, i.e., no roots have more than one leaf connected.
190154729392SStefano Zampini 
190254729392SStefano Zampini   sfA's leaf space and sfB's leaf space might be partially overlapped. The composition builds
190354729392SStefano Zampini   a graph with sfA's roots and sfB's roots only when there is a path between them. Unconnected
190454729392SStefano Zampini   roots are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a Bcast on sfA, then
190554729392SStefano Zampini   a Reduce on sfB, on connected roots.
190654729392SStefano Zampini 
190754729392SStefano Zampini .seealso: PetscSF, PetscSFCompose(), PetscSFGetGraph(), PetscSFSetGraph(), PetscSFCreateInverseSF()
190804c0ada0SJunchao Zhang @*/
190904c0ada0SJunchao Zhang PetscErrorCode PetscSFComposeInverse(PetscSF sfA,PetscSF sfB,PetscSF *sfBA)
191004c0ada0SJunchao Zhang {
191104c0ada0SJunchao Zhang   PetscErrorCode    ierr;
191204c0ada0SJunchao Zhang   const PetscSFNode *remotePointsA,*remotePointsB;
191304c0ada0SJunchao Zhang   PetscSFNode       *remotePointsBA;
191404c0ada0SJunchao Zhang   const PetscInt    *localPointsA,*localPointsB;
191554729392SStefano Zampini   PetscSFNode       *reorderedRemotePointsA = NULL;
191654729392SStefano Zampini   PetscInt          i,numRootsA,numLeavesA,numLeavesBA,numRootsB,numLeavesB,minleaf,maxleaf,*localPointsBA;
191704c0ada0SJunchao Zhang 
191804c0ada0SJunchao Zhang   PetscFunctionBegin;
191904c0ada0SJunchao Zhang   PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1);
192004c0ada0SJunchao Zhang   PetscSFCheckGraphSet(sfA,1);
192104c0ada0SJunchao Zhang   PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2);
192204c0ada0SJunchao Zhang   PetscSFCheckGraphSet(sfB,2);
192354729392SStefano Zampini   PetscCheckSameComm(sfA,1,sfB,2);
192404c0ada0SJunchao Zhang   PetscValidPointer(sfBA,3);
192554729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr);
192654729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr);
192754729392SStefano Zampini   /* TODO: Check roots of sfB have degree of 1 */
192854729392SStefano Zampini 
192904c0ada0SJunchao Zhang   ierr = PetscSFGetGraph(sfA, &numRootsA, &numLeavesA, &localPointsA, &remotePointsA);CHKERRQ(ierr);
193004c0ada0SJunchao Zhang   ierr = PetscSFGetGraph(sfB, &numRootsB, &numLeavesB, &localPointsB, &remotePointsB);CHKERRQ(ierr);
193154729392SStefano Zampini   ierr = PetscSFGetLeafRange(sfB, &minleaf, &maxleaf);CHKERRQ(ierr);
193254729392SStefano Zampini   ierr = PetscMalloc1(maxleaf - minleaf + 1,&reorderedRemotePointsA);CHKERRQ(ierr);
193354729392SStefano Zampini   for (i=0; i<maxleaf - minleaf + 1; i++) {
193454729392SStefano Zampini     reorderedRemotePointsA[i].rank = -1;
193554729392SStefano Zampini     reorderedRemotePointsA[i].index = -1;
193654729392SStefano Zampini   }
193754729392SStefano Zampini   if (localPointsA) {
193854729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
193954729392SStefano Zampini       if (localPointsA[i] > maxleaf || localPointsA[i] < minleaf) continue;
194054729392SStefano Zampini       reorderedRemotePointsA[localPointsA[i] - minleaf] = remotePointsA[i];
194154729392SStefano Zampini     }
194254729392SStefano Zampini   } else {
194354729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
194454729392SStefano Zampini       if (i > maxleaf || i < minleaf) continue;
194554729392SStefano Zampini       reorderedRemotePointsA[i - minleaf] = remotePointsA[i];
194654729392SStefano Zampini     }
194754729392SStefano Zampini   }
194854729392SStefano Zampini 
194954729392SStefano Zampini   ierr = PetscMalloc1(numRootsB,&localPointsBA);CHKERRQ(ierr);
195004c0ada0SJunchao Zhang   ierr = PetscMalloc1(numRootsB,&remotePointsBA);CHKERRQ(ierr);
195154729392SStefano Zampini   for (i=0; i<numRootsB; i++) {
195254729392SStefano Zampini     remotePointsBA[i].rank = -1;
195354729392SStefano Zampini     remotePointsBA[i].index = -1;
195454729392SStefano Zampini   }
195554729392SStefano Zampini 
195654729392SStefano Zampini   /* Once we implement the TODO above (check all roots of sfB have degree of 1), we can replace the MPI_MAXLOC
195754729392SStefano Zampini      with MPIU_REPLACE. In that case, MPI_MAXLOC and MPIU_REPLACE have the same effect.
195854729392SStefano Zampini    */
195954729392SStefano Zampini   ierr = PetscSFReduceBegin(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,MPI_MAXLOC);CHKERRQ(ierr);
196054729392SStefano Zampini   ierr = PetscSFReduceEnd(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,MPI_MAXLOC);CHKERRQ(ierr);
196154729392SStefano Zampini   ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr);
196254729392SStefano Zampini   for (i=0,numLeavesBA=0; i<numRootsB; i++) {
196354729392SStefano Zampini     if (remotePointsBA[i].rank == -1) continue;
196454729392SStefano Zampini     remotePointsBA[numLeavesBA].rank = remotePointsBA[i].rank;
196554729392SStefano Zampini     remotePointsBA[numLeavesBA].index = remotePointsBA[i].index;
196654729392SStefano Zampini     localPointsBA[numLeavesBA] = i;
196754729392SStefano Zampini     numLeavesBA++;
196854729392SStefano Zampini   }
196954729392SStefano Zampini   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr);
197054729392SStefano Zampini   ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr);
197104c0ada0SJunchao Zhang   PetscFunctionReturn(0);
197204c0ada0SJunchao Zhang }
197304c0ada0SJunchao Zhang 
19741c6ba672SJunchao Zhang /*
19751c6ba672SJunchao Zhang   PetscSFCreateLocalSF_Private - Creates a local PetscSF that only has intra-process edges of the global PetscSF
19761c6ba672SJunchao Zhang 
19771c6ba672SJunchao Zhang   Input Parameters:
19781c6ba672SJunchao Zhang . sf - The global PetscSF
19791c6ba672SJunchao Zhang 
19801c6ba672SJunchao Zhang   Output Parameters:
19811c6ba672SJunchao Zhang . out - The local PetscSF
19821c6ba672SJunchao Zhang  */
19831c6ba672SJunchao Zhang PetscErrorCode PetscSFCreateLocalSF_Private(PetscSF sf,PetscSF *out)
19841c6ba672SJunchao Zhang {
19851c6ba672SJunchao Zhang   MPI_Comm           comm;
19861c6ba672SJunchao Zhang   PetscMPIInt        myrank;
19871c6ba672SJunchao Zhang   const PetscInt     *ilocal;
19881c6ba672SJunchao Zhang   const PetscSFNode  *iremote;
19891c6ba672SJunchao Zhang   PetscInt           i,j,nroots,nleaves,lnleaves,*lilocal;
19901c6ba672SJunchao Zhang   PetscSFNode        *liremote;
19911c6ba672SJunchao Zhang   PetscSF            lsf;
19921c6ba672SJunchao Zhang   PetscErrorCode     ierr;
19931c6ba672SJunchao Zhang 
19941c6ba672SJunchao Zhang   PetscFunctionBegin;
19951c6ba672SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
19961c6ba672SJunchao Zhang   if (sf->ops->CreateLocalSF) {
19971c6ba672SJunchao Zhang     ierr = (*sf->ops->CreateLocalSF)(sf,out);CHKERRQ(ierr);
19981c6ba672SJunchao Zhang   } else {
19991c6ba672SJunchao Zhang     /* Could use PetscSFCreateEmbeddedLeafSF, but since we know the comm is PETSC_COMM_SELF, we can make it fast */
20001c6ba672SJunchao Zhang     ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
20011c6ba672SJunchao Zhang     ierr = MPI_Comm_rank(comm,&myrank);CHKERRQ(ierr);
20021c6ba672SJunchao Zhang 
20031c6ba672SJunchao Zhang     /* Find out local edges and build a local SF */
20041c6ba672SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
20051c6ba672SJunchao Zhang     for (i=lnleaves=0; i<nleaves; i++) {if (iremote[i].rank == (PetscInt)myrank) lnleaves++;}
20061c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&lilocal);CHKERRQ(ierr);
20071c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&liremote);CHKERRQ(ierr);
20081c6ba672SJunchao Zhang 
20091c6ba672SJunchao Zhang     for (i=j=0; i<nleaves; i++) {
20101c6ba672SJunchao Zhang       if (iremote[i].rank == (PetscInt)myrank) {
20111c6ba672SJunchao Zhang         lilocal[j]        = ilocal? ilocal[i] : i; /* ilocal=NULL for contiguous storage */
20121c6ba672SJunchao Zhang         liremote[j].rank  = 0; /* rank in PETSC_COMM_SELF */
20131c6ba672SJunchao Zhang         liremote[j].index = iremote[i].index;
20141c6ba672SJunchao Zhang         j++;
20151c6ba672SJunchao Zhang       }
20161c6ba672SJunchao Zhang     }
20171c6ba672SJunchao Zhang     ierr = PetscSFCreate(PETSC_COMM_SELF,&lsf);CHKERRQ(ierr);
20181c6ba672SJunchao Zhang     ierr = PetscSFSetGraph(lsf,nroots,lnleaves,lilocal,PETSC_OWN_POINTER,liremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
20191c6ba672SJunchao Zhang     ierr = PetscSFSetUp(lsf);CHKERRQ(ierr);
20201c6ba672SJunchao Zhang     *out = lsf;
20211c6ba672SJunchao Zhang   }
20221c6ba672SJunchao Zhang   PetscFunctionReturn(0);
20231c6ba672SJunchao Zhang }
2024dd5b3ca6SJunchao Zhang 
2025dd5b3ca6SJunchao Zhang /* Similar to PetscSFBcast, but only Bcast to leaves on rank 0 */
2026dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFBcastToZero_Private(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata)
2027dd5b3ca6SJunchao Zhang {
2028dd5b3ca6SJunchao Zhang   PetscErrorCode     ierr;
2029eb02082bSJunchao Zhang   PetscMemType       rootmtype,leafmtype;
2030dd5b3ca6SJunchao Zhang 
2031dd5b3ca6SJunchao Zhang   PetscFunctionBegin;
2032dd5b3ca6SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
2033dd5b3ca6SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
2034dd5b3ca6SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
2035eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
2036eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
2037dd5b3ca6SJunchao Zhang   if (sf->ops->BcastToZero) {
2038eb02082bSJunchao Zhang     ierr = (*sf->ops->BcastToZero)(sf,unit,rootmtype,rootdata,leafmtype,leafdata);CHKERRQ(ierr);
2039dd5b3ca6SJunchao Zhang   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFBcastToZero_Private is not supported on this SF type");
2040dd5b3ca6SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
2041dd5b3ca6SJunchao Zhang   PetscFunctionReturn(0);
2042dd5b3ca6SJunchao Zhang }
2043dd5b3ca6SJunchao Zhang 
2044