xref: /petsc/src/vec/is/sf/interface/sf.c (revision 51ccb202724f7096f70b1178150053ad1fe5b38d)
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
12095fce210SBarry Smith    of available methods (for instance, window, pt2pt, 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()
270*51ccb202SJunchao Zhang .  -sf_rank_order        - sort composite points for gathers and scatters in rank order, gathers are non-deterministic otherwise
271*51ccb202SJunchao 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.
272*51ccb202SJunchao Zhang                            Only available for SF types of basic and neighbor.
27395fce210SBarry Smith 
27495fce210SBarry Smith    Level: intermediate
27595fce210SBarry Smith 
27695fce210SBarry Smith .seealso: PetscSFWindowSetSyncType()
27795fce210SBarry Smith @*/
27895fce210SBarry Smith PetscErrorCode PetscSFSetFromOptions(PetscSF sf)
27995fce210SBarry Smith {
28095fce210SBarry Smith   PetscSFType    deft;
28195fce210SBarry Smith   char           type[256];
28295fce210SBarry Smith   PetscErrorCode ierr;
28395fce210SBarry Smith   PetscBool      flg;
28495fce210SBarry Smith 
28595fce210SBarry Smith   PetscFunctionBegin;
28695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
28795fce210SBarry Smith   ierr = PetscObjectOptionsBegin((PetscObject)sf);CHKERRQ(ierr);
28895fce210SBarry Smith   deft = ((PetscObject)sf)->type_name ? ((PetscObject)sf)->type_name : PETSCSFBASIC;
28929046d53SLisandro Dalcin   ierr = PetscOptionsFList("-sf_type","PetscSF implementation type","PetscSFSetType",PetscSFList,deft,type,sizeof(type),&flg);CHKERRQ(ierr);
29095fce210SBarry Smith   ierr = PetscSFSetType(sf,flg ? type : deft);CHKERRQ(ierr);
29195fce210SBarry 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);
292e55864a3SBarry Smith   if (sf->ops->SetFromOptions) {ierr = (*sf->ops->SetFromOptions)(PetscOptionsObject,sf);CHKERRQ(ierr);}
29395fce210SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
29495fce210SBarry Smith   PetscFunctionReturn(0);
29595fce210SBarry Smith }
29695fce210SBarry Smith 
29729046d53SLisandro Dalcin /*@
29895fce210SBarry Smith    PetscSFSetRankOrder - sort multi-points for gathers and scatters by rank order
29995fce210SBarry Smith 
30095fce210SBarry Smith    Logically Collective
30195fce210SBarry Smith 
30295fce210SBarry Smith    Input Arguments:
30395fce210SBarry Smith +  sf - star forest
30495fce210SBarry Smith -  flg - PETSC_TRUE to sort, PETSC_FALSE to skip sorting (lower setup cost, but non-deterministic)
30595fce210SBarry Smith 
30695fce210SBarry Smith    Level: advanced
30795fce210SBarry Smith 
30895fce210SBarry Smith .seealso: PetscSFGatherBegin(), PetscSFScatterBegin()
30995fce210SBarry Smith @*/
31095fce210SBarry Smith PetscErrorCode PetscSFSetRankOrder(PetscSF sf,PetscBool flg)
31195fce210SBarry Smith {
31295fce210SBarry Smith 
31395fce210SBarry Smith   PetscFunctionBegin;
31495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
31595fce210SBarry Smith   PetscValidLogicalCollectiveBool(sf,flg,2);
31695fce210SBarry Smith   if (sf->multi) SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_WRONGSTATE,"Rank ordering must be set before first call to PetscSFGatherBegin() or PetscSFScatterBegin()");
31795fce210SBarry Smith   sf->rankorder = flg;
31895fce210SBarry Smith   PetscFunctionReturn(0);
31995fce210SBarry Smith }
32095fce210SBarry Smith 
3218af6ec1cSBarry Smith /*@
32295fce210SBarry Smith    PetscSFSetGraph - Set a parallel star forest
32395fce210SBarry Smith 
32495fce210SBarry Smith    Collective
32595fce210SBarry Smith 
32695fce210SBarry Smith    Input Arguments:
32795fce210SBarry Smith +  sf - star forest
32895fce210SBarry Smith .  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
32995fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
330c4e6a40aSLawrence Mitchell .  ilocal - locations of leaves in leafdata buffers, pass NULL for contiguous storage (locations must be >= 0, enforced
331c4e6a40aSLawrence Mitchell during setup in debug mode)
33295fce210SBarry Smith .  localmode - copy mode for ilocal
333c4e6a40aSLawrence Mitchell .  iremote - remote locations of root vertices for each leaf on the current process (locations must be >= 0, enforced
334c4e6a40aSLawrence Mitchell during setup in debug mode)
33595fce210SBarry Smith -  remotemode - copy mode for iremote
33695fce210SBarry Smith 
33795fce210SBarry Smith    Level: intermediate
33895fce210SBarry Smith 
33995452b02SPatrick Sanan    Notes:
34095452b02SPatrick Sanan     In Fortran you must use PETSC_COPY_VALUES for localmode and remotemode
34138ab3f8aSBarry Smith 
3422ad1e87fSLisandro Dalcin    Developers Note: Local indices which are the identity permutation in the range [0,nleaves) are discarded as they
3432ad1e87fSLisandro Dalcin    encode contiguous storage. In such case, if localmode is PETSC_OWN_POINTER, the memory is deallocated as it is not
3442ad1e87fSLisandro Dalcin    needed
3452ad1e87fSLisandro Dalcin 
346c4e6a40aSLawrence Mitchell    Developers Note: This object does not necessarily encode a true star forest in the graph theoretic sense, since leaf
347c4e6a40aSLawrence Mitchell    indices are not required to be unique. Some functions, however, rely on unique leaf indices (checked in debug mode).
348c4e6a40aSLawrence Mitchell 
34995fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFGetGraph()
35095fce210SBarry Smith @*/
35195fce210SBarry Smith PetscErrorCode PetscSFSetGraph(PetscSF sf,PetscInt nroots,PetscInt nleaves,const PetscInt *ilocal,PetscCopyMode localmode,const PetscSFNode *iremote,PetscCopyMode remotemode)
35295fce210SBarry Smith {
35395fce210SBarry Smith   PetscErrorCode ierr;
35495fce210SBarry Smith 
35595fce210SBarry Smith   PetscFunctionBegin;
35695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
35729046d53SLisandro Dalcin   if (nleaves > 0 && ilocal) PetscValidIntPointer(ilocal,4);
35829046d53SLisandro Dalcin   if (nleaves > 0) PetscValidPointer(iremote,6);
35929046d53SLisandro Dalcin   if (nroots  < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nroots %D, cannot be negative",nroots);
36095fce210SBarry Smith   if (nleaves < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nleaves %D, cannot be negative",nleaves);
36129046d53SLisandro Dalcin 
36295fce210SBarry Smith   ierr = PetscSFReset(sf);CHKERRQ(ierr);
36329046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
36429046d53SLisandro Dalcin 
36595fce210SBarry Smith   sf->nroots  = nroots;
36695fce210SBarry Smith   sf->nleaves = nleaves;
36729046d53SLisandro Dalcin 
36829046d53SLisandro Dalcin   if (nleaves && ilocal) {
36921c688dcSJed Brown     PetscInt i;
37029046d53SLisandro Dalcin     PetscInt minleaf = PETSC_MAX_INT;
37129046d53SLisandro Dalcin     PetscInt maxleaf = PETSC_MIN_INT;
3722ad1e87fSLisandro Dalcin     int      contiguous = 1;
37329046d53SLisandro Dalcin     for (i=0; i<nleaves; i++) {
37429046d53SLisandro Dalcin       minleaf = PetscMin(minleaf,ilocal[i]);
37529046d53SLisandro Dalcin       maxleaf = PetscMax(maxleaf,ilocal[i]);
3762ad1e87fSLisandro Dalcin       contiguous &= (ilocal[i] == i);
37729046d53SLisandro Dalcin     }
37829046d53SLisandro Dalcin     sf->minleaf = minleaf;
37929046d53SLisandro Dalcin     sf->maxleaf = maxleaf;
3802ad1e87fSLisandro Dalcin     if (contiguous) {
3812ad1e87fSLisandro Dalcin       if (localmode == PETSC_OWN_POINTER) {
3822ad1e87fSLisandro Dalcin         ierr = PetscFree(ilocal);CHKERRQ(ierr);
3832ad1e87fSLisandro Dalcin       }
3842ad1e87fSLisandro Dalcin       ilocal = NULL;
3852ad1e87fSLisandro Dalcin     }
38629046d53SLisandro Dalcin   } else {
38729046d53SLisandro Dalcin     sf->minleaf = 0;
38829046d53SLisandro Dalcin     sf->maxleaf = nleaves - 1;
38929046d53SLisandro Dalcin   }
39029046d53SLisandro Dalcin 
39129046d53SLisandro Dalcin   if (ilocal) {
39295fce210SBarry Smith     switch (localmode) {
39395fce210SBarry Smith     case PETSC_COPY_VALUES:
394785e854fSJed Brown       ierr = PetscMalloc1(nleaves,&sf->mine_alloc);CHKERRQ(ierr);
395580bdb30SBarry Smith       ierr = PetscArraycpy(sf->mine_alloc,ilocal,nleaves);CHKERRQ(ierr);
39695fce210SBarry Smith       sf->mine = sf->mine_alloc;
39795fce210SBarry Smith       break;
39895fce210SBarry Smith     case PETSC_OWN_POINTER:
39995fce210SBarry Smith       sf->mine_alloc = (PetscInt*)ilocal;
40095fce210SBarry Smith       sf->mine       = sf->mine_alloc;
40195fce210SBarry Smith       break;
40295fce210SBarry Smith     case PETSC_USE_POINTER:
40329046d53SLisandro Dalcin       sf->mine_alloc = NULL;
40495fce210SBarry Smith       sf->mine       = (PetscInt*)ilocal;
40595fce210SBarry Smith       break;
40695fce210SBarry Smith     default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown localmode");
40795fce210SBarry Smith     }
40895fce210SBarry Smith   }
40929046d53SLisandro Dalcin 
41095fce210SBarry Smith   switch (remotemode) {
41195fce210SBarry Smith   case PETSC_COPY_VALUES:
412785e854fSJed Brown     ierr = PetscMalloc1(nleaves,&sf->remote_alloc);CHKERRQ(ierr);
413580bdb30SBarry Smith     ierr = PetscArraycpy(sf->remote_alloc,iremote,nleaves);CHKERRQ(ierr);
41495fce210SBarry Smith     sf->remote = sf->remote_alloc;
41595fce210SBarry Smith     break;
41695fce210SBarry Smith   case PETSC_OWN_POINTER:
41795fce210SBarry Smith     sf->remote_alloc = (PetscSFNode*)iremote;
41895fce210SBarry Smith     sf->remote       = sf->remote_alloc;
41995fce210SBarry Smith     break;
42095fce210SBarry Smith   case PETSC_USE_POINTER:
42129046d53SLisandro Dalcin     sf->remote_alloc = NULL;
42295fce210SBarry Smith     sf->remote       = (PetscSFNode*)iremote;
42395fce210SBarry Smith     break;
42495fce210SBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown remotemode");
42595fce210SBarry Smith   }
42695fce210SBarry Smith 
427563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
42829046d53SLisandro Dalcin   sf->graphset = PETSC_TRUE;
42995fce210SBarry Smith   PetscFunctionReturn(0);
43095fce210SBarry Smith }
43195fce210SBarry Smith 
43229046d53SLisandro Dalcin /*@
433dd5b3ca6SJunchao Zhang   PetscSFSetGraphWithPattern - Sets the graph of an SF with a specific pattern
434dd5b3ca6SJunchao Zhang 
435dd5b3ca6SJunchao Zhang   Collective
436dd5b3ca6SJunchao Zhang 
437dd5b3ca6SJunchao Zhang   Input Parameters:
438dd5b3ca6SJunchao Zhang + sf      - The PetscSF
439dd5b3ca6SJunchao Zhang . map     - Layout of roots over all processes (insignificant when pattern is PETSCSF_PATTERN_ALLTOALL)
440dd5b3ca6SJunchao Zhang - pattern - One of PETSCSF_PATTERN_ALLGATHER, PETSCSF_PATTERN_GATHER, PETSCSF_PATTERN_ALLTOALL
441dd5b3ca6SJunchao Zhang 
442dd5b3ca6SJunchao Zhang   Notes:
443dd5b3ca6SJunchao Zhang   It is easier to explain PetscSFPattern using vectors. Suppose we have an MPI vector x and its layout is map.
444dd5b3ca6SJunchao Zhang   n and N are local and global sizes of x respectively.
445dd5b3ca6SJunchao Zhang 
446dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_ALLGATHER, the routine creates a graph that if one does Bcast on it, it will copy x to
447dd5b3ca6SJunchao Zhang   sequential vectors y on all ranks.
448dd5b3ca6SJunchao Zhang 
449dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_GATHER, the routine creates a graph that if one does Bcast on it, it will copy x to a
450dd5b3ca6SJunchao Zhang   sequential vector y on rank 0.
451dd5b3ca6SJunchao Zhang 
452dd5b3ca6SJunchao Zhang   In above cases, entries of x are roots and entries of y are leaves.
453dd5b3ca6SJunchao Zhang 
454dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_ALLTOALL, map is insignificant. Suppose NP is size of sf's communicator. The routine
455dd5b3ca6SJunchao Zhang   creates a graph that every rank has NP leaves and NP roots. On rank i, its leaf j is connected to root i
456dd5b3ca6SJunchao 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
457dd5b3ca6SJunchao Zhang   not mean one can not send multiple items. One just needs to create a new MPI datatype for the mulptiple data
458dd5b3ca6SJunchao Zhang   items with MPI_Type_contiguous() and use that as the <unit> argument in SF routines.
459dd5b3ca6SJunchao Zhang 
460dd5b3ca6SJunchao Zhang   In this case, roots and leaves are symmetric.
461dd5b3ca6SJunchao Zhang 
462dd5b3ca6SJunchao Zhang   Level: intermediate
463dd5b3ca6SJunchao Zhang  @*/
464dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFSetGraphWithPattern(PetscSF sf,PetscLayout map,PetscSFPattern pattern)
465dd5b3ca6SJunchao Zhang {
466dd5b3ca6SJunchao Zhang   MPI_Comm       comm;
467dd5b3ca6SJunchao Zhang   PetscInt       n,N,res[2];
468dd5b3ca6SJunchao Zhang   PetscMPIInt    rank,size;
469dd5b3ca6SJunchao Zhang   PetscSFType    type;
470dd5b3ca6SJunchao Zhang   PetscErrorCode ierr;
471dd5b3ca6SJunchao Zhang 
472dd5b3ca6SJunchao Zhang   PetscFunctionBegin;
473dd5b3ca6SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf, &comm);CHKERRQ(ierr);
474dd5b3ca6SJunchao Zhang   if (pattern < PETSCSF_PATTERN_ALLGATHER || pattern > PETSCSF_PATTERN_ALLTOALL) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unsupported PetscSFPattern %D\n",pattern);
475dd5b3ca6SJunchao Zhang   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
476dd5b3ca6SJunchao Zhang   ierr = MPI_Comm_size(comm,&size);CHKERRQ(ierr);
477dd5b3ca6SJunchao Zhang 
478dd5b3ca6SJunchao Zhang   if (pattern == PETSCSF_PATTERN_ALLTOALL) {
479dd5b3ca6SJunchao Zhang     type = PETSCSFALLTOALL;
480dd5b3ca6SJunchao Zhang     ierr = PetscLayoutCreate(comm,&sf->map);CHKERRQ(ierr);
481dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetLocalSize(sf->map,size);CHKERRQ(ierr);
482dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetSize(sf->map,((PetscInt)size)*size);CHKERRQ(ierr);
483dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetUp(sf->map);CHKERRQ(ierr);
484dd5b3ca6SJunchao Zhang   } else {
485dd5b3ca6SJunchao Zhang     ierr   = PetscLayoutGetLocalSize(map,&n);CHKERRQ(ierr);
486dd5b3ca6SJunchao Zhang     ierr   = PetscLayoutGetSize(map,&N);CHKERRQ(ierr);
487dd5b3ca6SJunchao Zhang     res[0] = n;
488dd5b3ca6SJunchao Zhang     res[1] = -n;
489dd5b3ca6SJunchao Zhang     /* Check if n are same over all ranks so that we can optimize it */
490dd5b3ca6SJunchao Zhang     ierr   = MPIU_Allreduce(MPI_IN_PLACE,res,2,MPIU_INT,MPI_MAX,comm);CHKERRQ(ierr);
491dd5b3ca6SJunchao Zhang     if (res[0] == -res[1]) { /* same n */
492dd5b3ca6SJunchao Zhang       type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHER  : PETSCSFGATHER;
493dd5b3ca6SJunchao Zhang     } else {
494dd5b3ca6SJunchao Zhang       type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHERV : PETSCSFGATHERV;
495dd5b3ca6SJunchao Zhang     }
496dd5b3ca6SJunchao Zhang     ierr = PetscLayoutReference(map,&sf->map);CHKERRQ(ierr);
497dd5b3ca6SJunchao Zhang   }
498dd5b3ca6SJunchao Zhang   ierr = PetscSFSetType(sf,type);CHKERRQ(ierr);
499dd5b3ca6SJunchao Zhang 
500dd5b3ca6SJunchao Zhang   sf->pattern = pattern;
501dd5b3ca6SJunchao Zhang   sf->mine    = NULL; /* Contiguous */
502dd5b3ca6SJunchao Zhang 
503dd5b3ca6SJunchao Zhang   /* Set nleaves, nroots here in case user calls PetscSFGetGraph, which is legal to call even before PetscSFSetUp is called.
504dd5b3ca6SJunchao Zhang      Also set other easy stuff.
505dd5b3ca6SJunchao Zhang    */
506dd5b3ca6SJunchao Zhang   if (pattern == PETSCSF_PATTERN_ALLGATHER) {
507dd5b3ca6SJunchao Zhang     sf->nleaves      = N;
508dd5b3ca6SJunchao Zhang     sf->nroots       = n;
509dd5b3ca6SJunchao Zhang     sf->nranks       = size;
510dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
511dd5b3ca6SJunchao Zhang     sf->maxleaf      = N - 1;
512dd5b3ca6SJunchao Zhang   } else if (pattern == PETSCSF_PATTERN_GATHER) {
513dd5b3ca6SJunchao Zhang     sf->nleaves      = rank ? 0 : N;
514dd5b3ca6SJunchao Zhang     sf->nroots       = n;
515dd5b3ca6SJunchao Zhang     sf->nranks       = rank ? 0 : size;
516dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
517dd5b3ca6SJunchao Zhang     sf->maxleaf      = rank ? -1 : N - 1;
518dd5b3ca6SJunchao Zhang   } else if (pattern == PETSCSF_PATTERN_ALLTOALL) {
519dd5b3ca6SJunchao Zhang     sf->nleaves      = size;
520dd5b3ca6SJunchao Zhang     sf->nroots       = size;
521dd5b3ca6SJunchao Zhang     sf->nranks       = size;
522dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
523dd5b3ca6SJunchao Zhang     sf->maxleaf      = size - 1;
524dd5b3ca6SJunchao Zhang   }
525dd5b3ca6SJunchao Zhang   sf->ndranks  = 0; /* We do not need to separate out distinguished ranks for patterned graphs to improve communication performance */
526dd5b3ca6SJunchao Zhang   sf->graphset = PETSC_TRUE;
527dd5b3ca6SJunchao Zhang   PetscFunctionReturn(0);
528dd5b3ca6SJunchao Zhang }
529dd5b3ca6SJunchao Zhang 
530dd5b3ca6SJunchao Zhang /*@
53195fce210SBarry Smith    PetscSFCreateInverseSF - given a PetscSF in which all vertices have degree 1, creates the inverse map
53295fce210SBarry Smith 
53395fce210SBarry Smith    Collective
53495fce210SBarry Smith 
53595fce210SBarry Smith    Input Arguments:
536dd5b3ca6SJunchao Zhang 
53795fce210SBarry Smith .  sf - star forest to invert
53895fce210SBarry Smith 
53995fce210SBarry Smith    Output Arguments:
54095fce210SBarry Smith .  isf - inverse of sf
54195fce210SBarry Smith    Level: advanced
54295fce210SBarry Smith 
54395fce210SBarry Smith    Notes:
54495fce210SBarry Smith    All roots must have degree 1.
54595fce210SBarry Smith 
54695fce210SBarry Smith    The local space may be a permutation, but cannot be sparse.
54795fce210SBarry Smith 
54895fce210SBarry Smith .seealso: PetscSFSetGraph()
54995fce210SBarry Smith @*/
55095fce210SBarry Smith PetscErrorCode PetscSFCreateInverseSF(PetscSF sf,PetscSF *isf)
55195fce210SBarry Smith {
55295fce210SBarry Smith   PetscErrorCode ierr;
55395fce210SBarry Smith   PetscMPIInt    rank;
55495fce210SBarry Smith   PetscInt       i,nroots,nleaves,maxlocal,count,*newilocal;
55595fce210SBarry Smith   const PetscInt *ilocal;
55695fce210SBarry Smith   PetscSFNode    *roots,*leaves;
55795fce210SBarry Smith 
55895fce210SBarry Smith   PetscFunctionBegin;
55929046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
56029046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
56129046d53SLisandro Dalcin   PetscValidPointer(isf,2);
56229046d53SLisandro Dalcin 
56395fce210SBarry Smith   ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
56429046d53SLisandro Dalcin   maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
56529046d53SLisandro Dalcin 
56629046d53SLisandro Dalcin   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
567ae9aee6dSMatthew G. Knepley   ierr = PetscMalloc2(nroots,&roots,maxlocal,&leaves);CHKERRQ(ierr);
568ae9aee6dSMatthew G. Knepley   for (i=0; i<maxlocal; i++) {
56995fce210SBarry Smith     leaves[i].rank  = rank;
57095fce210SBarry Smith     leaves[i].index = i;
57195fce210SBarry Smith   }
57295fce210SBarry Smith   for (i=0; i <nroots; i++) {
57395fce210SBarry Smith     roots[i].rank  = -1;
57495fce210SBarry Smith     roots[i].index = -1;
57595fce210SBarry Smith   }
5768bfbc91cSJed Brown   ierr = PetscSFReduceBegin(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr);
5778bfbc91cSJed Brown   ierr = PetscSFReduceEnd(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr);
57895fce210SBarry Smith 
57995fce210SBarry Smith   /* Check whether our leaves are sparse */
58095fce210SBarry Smith   for (i=0,count=0; i<nroots; i++) if (roots[i].rank >= 0) count++;
58195fce210SBarry Smith   if (count == nroots) newilocal = NULL;
58295fce210SBarry Smith   else {                        /* Index for sparse leaves and compact "roots" array (which is to become our leaves). */
583785e854fSJed Brown     ierr = PetscMalloc1(count,&newilocal);CHKERRQ(ierr);
58495fce210SBarry Smith     for (i=0,count=0; i<nroots; i++) {
58595fce210SBarry Smith       if (roots[i].rank >= 0) {
58695fce210SBarry Smith         newilocal[count]   = i;
58795fce210SBarry Smith         roots[count].rank  = roots[i].rank;
58895fce210SBarry Smith         roots[count].index = roots[i].index;
58995fce210SBarry Smith         count++;
59095fce210SBarry Smith       }
59195fce210SBarry Smith     }
59295fce210SBarry Smith   }
59395fce210SBarry Smith 
59495fce210SBarry Smith   ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,isf);CHKERRQ(ierr);
59595fce210SBarry Smith   ierr = PetscSFSetGraph(*isf,maxlocal,count,newilocal,PETSC_OWN_POINTER,roots,PETSC_COPY_VALUES);CHKERRQ(ierr);
59695fce210SBarry Smith   ierr = PetscFree2(roots,leaves);CHKERRQ(ierr);
59795fce210SBarry Smith   PetscFunctionReturn(0);
59895fce210SBarry Smith }
59995fce210SBarry Smith 
60095fce210SBarry Smith /*@
60195fce210SBarry Smith    PetscSFDuplicate - duplicate a PetscSF, optionally preserving rank connectivity and graph
60295fce210SBarry Smith 
60395fce210SBarry Smith    Collective
60495fce210SBarry Smith 
60595fce210SBarry Smith    Input Arguments:
60695fce210SBarry Smith +  sf - communication object to duplicate
60795fce210SBarry Smith -  opt - PETSCSF_DUPLICATE_CONFONLY, PETSCSF_DUPLICATE_RANKS, or PETSCSF_DUPLICATE_GRAPH (see PetscSFDuplicateOption)
60895fce210SBarry Smith 
60995fce210SBarry Smith    Output Arguments:
61095fce210SBarry Smith .  newsf - new communication object
61195fce210SBarry Smith 
61295fce210SBarry Smith    Level: beginner
61395fce210SBarry Smith 
61495fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetType(), PetscSFSetGraph()
61595fce210SBarry Smith @*/
61695fce210SBarry Smith PetscErrorCode PetscSFDuplicate(PetscSF sf,PetscSFDuplicateOption opt,PetscSF *newsf)
61795fce210SBarry Smith {
61829046d53SLisandro Dalcin   PetscSFType    type;
61995fce210SBarry Smith   PetscErrorCode ierr;
62095fce210SBarry Smith 
62195fce210SBarry Smith   PetscFunctionBegin;
62229046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
62329046d53SLisandro Dalcin   PetscValidLogicalCollectiveEnum(sf,opt,2);
62429046d53SLisandro Dalcin   PetscValidPointer(newsf,3);
62595fce210SBarry Smith   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sf),newsf);CHKERRQ(ierr);
62629046d53SLisandro Dalcin   ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
62729046d53SLisandro Dalcin   if (type) {ierr = PetscSFSetType(*newsf,type);CHKERRQ(ierr);}
62895fce210SBarry Smith   if (opt == PETSCSF_DUPLICATE_GRAPH) {
629dd5b3ca6SJunchao Zhang     PetscSFCheckGraphSet(sf,1);
630dd5b3ca6SJunchao Zhang     if (sf->pattern == PETSCSF_PATTERN_GENERAL) {
63195fce210SBarry Smith       PetscInt          nroots,nleaves;
63295fce210SBarry Smith       const PetscInt    *ilocal;
63395fce210SBarry Smith       const PetscSFNode *iremote;
63495fce210SBarry Smith       ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
63595fce210SBarry Smith       ierr = PetscSFSetGraph(*newsf,nroots,nleaves,ilocal,PETSC_COPY_VALUES,iremote,PETSC_COPY_VALUES);CHKERRQ(ierr);
636dd5b3ca6SJunchao Zhang     } else {
637dd5b3ca6SJunchao Zhang       ierr = PetscSFSetGraphWithPattern(*newsf,sf->map,sf->pattern);CHKERRQ(ierr);
638dd5b3ca6SJunchao Zhang     }
63995fce210SBarry Smith   }
64029046d53SLisandro Dalcin   if (sf->ops->Duplicate) {ierr = (*sf->ops->Duplicate)(sf,opt,*newsf);CHKERRQ(ierr);}
64195fce210SBarry Smith   PetscFunctionReturn(0);
64295fce210SBarry Smith }
64395fce210SBarry Smith 
64495fce210SBarry Smith /*@C
64595fce210SBarry Smith    PetscSFGetGraph - Get the graph specifying a parallel star forest
64695fce210SBarry Smith 
64795fce210SBarry Smith    Not Collective
64895fce210SBarry Smith 
64995fce210SBarry Smith    Input Arguments:
65095fce210SBarry Smith .  sf - star forest
65195fce210SBarry Smith 
65295fce210SBarry Smith    Output Arguments:
65395fce210SBarry Smith +  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
65495fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
65595fce210SBarry Smith .  ilocal - locations of leaves in leafdata buffers
65695fce210SBarry Smith -  iremote - remote locations of root vertices for each leaf on the current process
65795fce210SBarry Smith 
658373e0d91SLisandro Dalcin    Notes:
659373e0d91SLisandro Dalcin    We are not currently requiring that the graph is set, thus returning nroots=-1 if it has not been set yet
660373e0d91SLisandro Dalcin 
66195fce210SBarry Smith    Level: intermediate
66295fce210SBarry Smith 
66395fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph()
66495fce210SBarry Smith @*/
66595fce210SBarry Smith PetscErrorCode PetscSFGetGraph(PetscSF sf,PetscInt *nroots,PetscInt *nleaves,const PetscInt **ilocal,const PetscSFNode **iremote)
66695fce210SBarry Smith {
667b8dee149SJunchao Zhang   PetscErrorCode ierr;
66895fce210SBarry Smith 
66995fce210SBarry Smith   PetscFunctionBegin;
67095fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
671b8dee149SJunchao Zhang   if (sf->ops->GetGraph) {
672b8dee149SJunchao Zhang     ierr = (sf->ops->GetGraph)(sf,nroots,nleaves,ilocal,iremote);CHKERRQ(ierr);
673b8dee149SJunchao Zhang   } else {
67495fce210SBarry Smith     if (nroots) *nroots = sf->nroots;
67595fce210SBarry Smith     if (nleaves) *nleaves = sf->nleaves;
67695fce210SBarry Smith     if (ilocal) *ilocal = sf->mine;
67795fce210SBarry Smith     if (iremote) *iremote = sf->remote;
678b8dee149SJunchao Zhang   }
67995fce210SBarry Smith   PetscFunctionReturn(0);
68095fce210SBarry Smith }
68195fce210SBarry Smith 
68229046d53SLisandro Dalcin /*@
68395fce210SBarry Smith    PetscSFGetLeafRange - Get the active leaf ranges
68495fce210SBarry Smith 
68595fce210SBarry Smith    Not Collective
68695fce210SBarry Smith 
68795fce210SBarry Smith    Input Arguments:
68895fce210SBarry Smith .  sf - star forest
68995fce210SBarry Smith 
69095fce210SBarry Smith    Output Arguments:
691dd5b3ca6SJunchao Zhang +  minleaf - minimum active leaf on this process. Return 0 if there are no leaves.
692dd5b3ca6SJunchao Zhang -  maxleaf - maximum active leaf on this process. Return -1 if there are no leaves.
69395fce210SBarry Smith 
69495fce210SBarry Smith    Level: developer
69595fce210SBarry Smith 
69695fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph(), PetscSFGetGraph()
69795fce210SBarry Smith @*/
69895fce210SBarry Smith PetscErrorCode PetscSFGetLeafRange(PetscSF sf,PetscInt *minleaf,PetscInt *maxleaf)
69995fce210SBarry Smith {
70095fce210SBarry Smith 
70195fce210SBarry Smith   PetscFunctionBegin;
70295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
70329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
70495fce210SBarry Smith   if (minleaf) *minleaf = sf->minleaf;
70595fce210SBarry Smith   if (maxleaf) *maxleaf = sf->maxleaf;
70695fce210SBarry Smith   PetscFunctionReturn(0);
70795fce210SBarry Smith }
70895fce210SBarry Smith 
70995fce210SBarry Smith /*@C
71095fce210SBarry Smith    PetscSFView - view a star forest
71195fce210SBarry Smith 
71295fce210SBarry Smith    Collective
71395fce210SBarry Smith 
71495fce210SBarry Smith    Input Arguments:
71595fce210SBarry Smith +  sf - star forest
71695fce210SBarry Smith -  viewer - viewer to display graph, for example PETSC_VIEWER_STDOUT_WORLD
71795fce210SBarry Smith 
71895fce210SBarry Smith    Level: beginner
71995fce210SBarry Smith 
72095fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph()
72195fce210SBarry Smith @*/
72295fce210SBarry Smith PetscErrorCode PetscSFView(PetscSF sf,PetscViewer viewer)
72395fce210SBarry Smith {
72495fce210SBarry Smith   PetscErrorCode    ierr;
72595fce210SBarry Smith   PetscBool         iascii;
72695fce210SBarry Smith   PetscViewerFormat format;
72795fce210SBarry Smith 
72895fce210SBarry Smith   PetscFunctionBegin;
72995fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
73095fce210SBarry Smith   if (!viewer) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sf),&viewer);CHKERRQ(ierr);}
73195fce210SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
73295fce210SBarry Smith   PetscCheckSameComm(sf,1,viewer,2);
73380153354SVaclav Hapla   if (sf->graphset) {ierr = PetscSFSetUp(sf);CHKERRQ(ierr);}
73495fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
73595fce210SBarry Smith   if (iascii) {
73695fce210SBarry Smith     PetscMPIInt rank;
73781bfa7aaSJed Brown     PetscInt    ii,i,j;
73895fce210SBarry Smith 
739dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)sf,viewer);CHKERRQ(ierr);
74095fce210SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
74195fce210SBarry Smith     if (sf->ops->View) {ierr = (*sf->ops->View)(sf,viewer);CHKERRQ(ierr);}
742dd5b3ca6SJunchao Zhang     if (sf->pattern == PETSCSF_PATTERN_GENERAL) {
74380153354SVaclav Hapla       if (!sf->graphset) {
74480153354SVaclav Hapla         ierr = PetscViewerASCIIPrintf(viewer,"PetscSFSetGraph() has not been called yet\n");CHKERRQ(ierr);
74580153354SVaclav Hapla         ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
74680153354SVaclav Hapla         PetscFunctionReturn(0);
74780153354SVaclav Hapla       }
74895fce210SBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
7491575c14dSBarry Smith       ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
75095fce210SBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Number of roots=%D, leaves=%D, remote ranks=%D\n",rank,sf->nroots,sf->nleaves,sf->nranks);CHKERRQ(ierr);
75195fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
75295fce210SBarry 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);
75395fce210SBarry Smith       }
75495fce210SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
75595fce210SBarry Smith       ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
75695fce210SBarry Smith       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
75781bfa7aaSJed Brown         PetscMPIInt *tmpranks,*perm;
75881bfa7aaSJed Brown         ierr = PetscMalloc2(sf->nranks,&tmpranks,sf->nranks,&perm);CHKERRQ(ierr);
759580bdb30SBarry Smith         ierr = PetscArraycpy(tmpranks,sf->ranks,sf->nranks);CHKERRQ(ierr);
76081bfa7aaSJed Brown         for (i=0; i<sf->nranks; i++) perm[i] = i;
76181bfa7aaSJed Brown         ierr = PetscSortMPIIntWithArray(sf->nranks,tmpranks,perm);CHKERRQ(ierr);
76295fce210SBarry Smith         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Roots referenced by my leaves, by rank\n",rank);CHKERRQ(ierr);
76381bfa7aaSJed Brown         for (ii=0; ii<sf->nranks; ii++) {
76481bfa7aaSJed Brown           i = perm[ii];
7657904a332SBarry Smith           ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %d: %D edges\n",rank,sf->ranks[i],sf->roffset[i+1]-sf->roffset[i]);CHKERRQ(ierr);
76695fce210SBarry Smith           for (j=sf->roffset[i]; j<sf->roffset[i+1]; j++) {
76795fce210SBarry Smith             ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d]    %D <- %D\n",rank,sf->rmine[j],sf->rremote[j]);CHKERRQ(ierr);
76895fce210SBarry Smith           }
76995fce210SBarry Smith         }
77081bfa7aaSJed Brown         ierr = PetscFree2(tmpranks,perm);CHKERRQ(ierr);
77195fce210SBarry Smith       }
77295fce210SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
7731575c14dSBarry Smith       ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
774dd5b3ca6SJunchao Zhang     }
77595fce210SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
77695fce210SBarry Smith   }
77795fce210SBarry Smith   PetscFunctionReturn(0);
77895fce210SBarry Smith }
77995fce210SBarry Smith 
78095fce210SBarry Smith /*@C
781dec1416fSJunchao Zhang    PetscSFGetRootRanks - Get root ranks and number of vertices referenced by leaves on this process
78295fce210SBarry Smith 
78395fce210SBarry Smith    Not Collective
78495fce210SBarry Smith 
78595fce210SBarry Smith    Input Arguments:
78695fce210SBarry Smith .  sf - star forest
78795fce210SBarry Smith 
78895fce210SBarry Smith    Output Arguments:
78995fce210SBarry Smith +  nranks - number of ranks referenced by local part
79095fce210SBarry Smith .  ranks - array of ranks
79195fce210SBarry Smith .  roffset - offset in rmine/rremote for each rank (length nranks+1)
79295fce210SBarry Smith .  rmine - concatenated array holding local indices referencing each remote rank
79395fce210SBarry Smith -  rremote - concatenated array holding remote indices referenced for each remote rank
79495fce210SBarry Smith 
79595fce210SBarry Smith    Level: developer
79695fce210SBarry Smith 
797dec1416fSJunchao Zhang .seealso: PetscSFGetLeafRanks()
79895fce210SBarry Smith @*/
799dec1416fSJunchao Zhang PetscErrorCode PetscSFGetRootRanks(PetscSF sf,PetscInt *nranks,const PetscMPIInt **ranks,const PetscInt **roffset,const PetscInt **rmine,const PetscInt **rremote)
80095fce210SBarry Smith {
801dec1416fSJunchao Zhang   PetscErrorCode ierr;
80295fce210SBarry Smith 
80395fce210SBarry Smith   PetscFunctionBegin;
80495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
80529046d53SLisandro Dalcin   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
806dec1416fSJunchao Zhang   if (sf->ops->GetRootRanks) {
807dec1416fSJunchao Zhang     ierr = (sf->ops->GetRootRanks)(sf,nranks,ranks,roffset,rmine,rremote);CHKERRQ(ierr);
808dec1416fSJunchao Zhang   } else {
809dec1416fSJunchao Zhang     /* The generic implementation */
81095fce210SBarry Smith     if (nranks)  *nranks  = sf->nranks;
81195fce210SBarry Smith     if (ranks)   *ranks   = sf->ranks;
81295fce210SBarry Smith     if (roffset) *roffset = sf->roffset;
81395fce210SBarry Smith     if (rmine)   *rmine   = sf->rmine;
81495fce210SBarry Smith     if (rremote) *rremote = sf->rremote;
815dec1416fSJunchao Zhang   }
81695fce210SBarry Smith   PetscFunctionReturn(0);
81795fce210SBarry Smith }
81895fce210SBarry Smith 
8198750ddebSJunchao Zhang /*@C
8208750ddebSJunchao Zhang    PetscSFGetLeafRanks - Get leaf ranks referencing roots on this process
8218750ddebSJunchao Zhang 
8228750ddebSJunchao Zhang    Not Collective
8238750ddebSJunchao Zhang 
8248750ddebSJunchao Zhang    Input Arguments:
8258750ddebSJunchao Zhang .  sf - star forest
8268750ddebSJunchao Zhang 
8278750ddebSJunchao Zhang    Output Arguments:
8288750ddebSJunchao Zhang +  niranks - number of leaf ranks referencing roots on this process
8298750ddebSJunchao Zhang .  iranks - array of ranks
8308750ddebSJunchao Zhang .  ioffset - offset in irootloc for each rank (length niranks+1)
8318750ddebSJunchao Zhang -  irootloc - concatenated array holding local indices of roots referenced by each leaf rank
8328750ddebSJunchao Zhang 
8338750ddebSJunchao Zhang    Level: developer
8348750ddebSJunchao Zhang 
835dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
8368750ddebSJunchao Zhang @*/
8378750ddebSJunchao Zhang PetscErrorCode PetscSFGetLeafRanks(PetscSF sf,PetscInt *niranks,const PetscMPIInt **iranks,const PetscInt **ioffset,const PetscInt **irootloc)
8388750ddebSJunchao Zhang {
8398750ddebSJunchao Zhang   PetscErrorCode ierr;
8408750ddebSJunchao Zhang 
8418750ddebSJunchao Zhang   PetscFunctionBegin;
8428750ddebSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
8438750ddebSJunchao Zhang   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
8448750ddebSJunchao Zhang   if (sf->ops->GetLeafRanks) {
8458750ddebSJunchao Zhang     ierr = (sf->ops->GetLeafRanks)(sf,niranks,iranks,ioffset,irootloc);CHKERRQ(ierr);
8468750ddebSJunchao Zhang   } else {
8478750ddebSJunchao Zhang     PetscSFType type;
8488750ddebSJunchao Zhang     ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
8498750ddebSJunchao Zhang     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFGetLeafRanks() is not supported on this StarForest type: %s", type);
8508750ddebSJunchao Zhang   }
8518750ddebSJunchao Zhang   PetscFunctionReturn(0);
8528750ddebSJunchao Zhang }
8538750ddebSJunchao Zhang 
854b5a8e515SJed Brown static PetscBool InList(PetscMPIInt needle,PetscMPIInt n,const PetscMPIInt *list) {
855b5a8e515SJed Brown   PetscInt i;
856b5a8e515SJed Brown   for (i=0; i<n; i++) {
857b5a8e515SJed Brown     if (needle == list[i]) return PETSC_TRUE;
858b5a8e515SJed Brown   }
859b5a8e515SJed Brown   return PETSC_FALSE;
860b5a8e515SJed Brown }
861b5a8e515SJed Brown 
86295fce210SBarry Smith /*@C
86321c688dcSJed Brown    PetscSFSetUpRanks - Set up data structures associated with ranks; this is for internal use by PetscSF implementations.
86421c688dcSJed Brown 
86521c688dcSJed Brown    Collective
86621c688dcSJed Brown 
86721c688dcSJed Brown    Input Arguments:
868b5a8e515SJed Brown +  sf - PetscSF to set up; PetscSFSetGraph() must have been called
869b5a8e515SJed Brown -  dgroup - MPI_Group of ranks to be distinguished (e.g., for self or shared memory exchange)
87021c688dcSJed Brown 
87121c688dcSJed Brown    Level: developer
87221c688dcSJed Brown 
873dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
87421c688dcSJed Brown @*/
875b5a8e515SJed Brown PetscErrorCode PetscSFSetUpRanks(PetscSF sf,MPI_Group dgroup)
87621c688dcSJed Brown {
87721c688dcSJed Brown   PetscErrorCode     ierr;
87821c688dcSJed Brown   PetscTable         table;
87921c688dcSJed Brown   PetscTablePosition pos;
880b5a8e515SJed Brown   PetscMPIInt        size,groupsize,*groupranks;
881247e8311SStefano Zampini   PetscInt           *rcount,*ranks;
882247e8311SStefano Zampini   PetscInt           i, irank = -1,orank = -1;
88321c688dcSJed Brown 
88421c688dcSJed Brown   PetscFunctionBegin;
88521c688dcSJed Brown   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
88629046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
88721c688dcSJed Brown   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRQ(ierr);
88821c688dcSJed Brown   ierr = PetscTableCreate(10,size,&table);CHKERRQ(ierr);
88921c688dcSJed Brown   for (i=0; i<sf->nleaves; i++) {
89021c688dcSJed Brown     /* Log 1-based rank */
89121c688dcSJed Brown     ierr = PetscTableAdd(table,sf->remote[i].rank+1,1,ADD_VALUES);CHKERRQ(ierr);
89221c688dcSJed Brown   }
89321c688dcSJed Brown   ierr = PetscTableGetCount(table,&sf->nranks);CHKERRQ(ierr);
89421c688dcSJed Brown   ierr = PetscMalloc4(sf->nranks,&sf->ranks,sf->nranks+1,&sf->roffset,sf->nleaves,&sf->rmine,sf->nleaves,&sf->rremote);CHKERRQ(ierr);
89521c688dcSJed Brown   ierr = PetscMalloc2(sf->nranks,&rcount,sf->nranks,&ranks);CHKERRQ(ierr);
89621c688dcSJed Brown   ierr = PetscTableGetHeadPosition(table,&pos);CHKERRQ(ierr);
89721c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
89821c688dcSJed Brown     ierr = PetscTableGetNext(table,&pos,&ranks[i],&rcount[i]);CHKERRQ(ierr);
89921c688dcSJed Brown     ranks[i]--;             /* Convert back to 0-based */
90021c688dcSJed Brown   }
90121c688dcSJed Brown   ierr = PetscTableDestroy(&table);CHKERRQ(ierr);
902b5a8e515SJed Brown 
903b5a8e515SJed Brown   /* We expect that dgroup is reliably "small" while nranks could be large */
904b5a8e515SJed Brown   {
9057fb8a5e4SKarl Rupp     MPI_Group group = MPI_GROUP_NULL;
906b5a8e515SJed Brown     PetscMPIInt *dgroupranks;
907b5a8e515SJed Brown     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
908b5a8e515SJed Brown     ierr = MPI_Group_size(dgroup,&groupsize);CHKERRQ(ierr);
909b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&dgroupranks);CHKERRQ(ierr);
910b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&groupranks);CHKERRQ(ierr);
911b5a8e515SJed Brown     for (i=0; i<groupsize; i++) dgroupranks[i] = i;
912f3fc9a17SJed Brown     if (groupsize) {ierr = MPI_Group_translate_ranks(dgroup,groupsize,dgroupranks,group,groupranks);CHKERRQ(ierr);}
913b5a8e515SJed Brown     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
914b5a8e515SJed Brown     ierr = PetscFree(dgroupranks);CHKERRQ(ierr);
915b5a8e515SJed Brown   }
916b5a8e515SJed Brown 
917b5a8e515SJed Brown   /* Partition ranks[] into distinguished (first sf->ndranks) followed by non-distinguished */
918b5a8e515SJed Brown   for (sf->ndranks=0,i=sf->nranks; sf->ndranks<i; ) {
919b5a8e515SJed Brown     for (i--; sf->ndranks<i; i--) { /* Scan i backward looking for distinguished rank */
920b5a8e515SJed Brown       if (InList(ranks[i],groupsize,groupranks)) break;
921b5a8e515SJed Brown     }
922b5a8e515SJed Brown     for ( ; sf->ndranks<=i; sf->ndranks++) { /* Scan sf->ndranks forward looking for non-distinguished rank */
923b5a8e515SJed Brown       if (!InList(ranks[sf->ndranks],groupsize,groupranks)) break;
924b5a8e515SJed Brown     }
925b5a8e515SJed Brown     if (sf->ndranks < i) {                         /* Swap ranks[sf->ndranks] with ranks[i] */
926b5a8e515SJed Brown       PetscInt    tmprank,tmpcount;
927247e8311SStefano Zampini 
928b5a8e515SJed Brown       tmprank             = ranks[i];
929b5a8e515SJed Brown       tmpcount            = rcount[i];
930b5a8e515SJed Brown       ranks[i]            = ranks[sf->ndranks];
931b5a8e515SJed Brown       rcount[i]           = rcount[sf->ndranks];
932b5a8e515SJed Brown       ranks[sf->ndranks]  = tmprank;
933b5a8e515SJed Brown       rcount[sf->ndranks] = tmpcount;
934b5a8e515SJed Brown       sf->ndranks++;
935b5a8e515SJed Brown     }
936b5a8e515SJed Brown   }
937b5a8e515SJed Brown   ierr = PetscFree(groupranks);CHKERRQ(ierr);
938b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->ndranks,ranks,rcount);CHKERRQ(ierr);
939b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->nranks-sf->ndranks,ranks+sf->ndranks,rcount+sf->ndranks);CHKERRQ(ierr);
94021c688dcSJed Brown   sf->roffset[0] = 0;
94121c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
94221c688dcSJed Brown     ierr = PetscMPIIntCast(ranks[i],sf->ranks+i);CHKERRQ(ierr);
94321c688dcSJed Brown     sf->roffset[i+1] = sf->roffset[i] + rcount[i];
94421c688dcSJed Brown     rcount[i]        = 0;
94521c688dcSJed Brown   }
946247e8311SStefano Zampini   for (i=0, irank = -1, orank = -1; i<sf->nleaves; i++) {
947247e8311SStefano Zampini     /* short circuit */
948247e8311SStefano Zampini     if (orank != sf->remote[i].rank) {
94921c688dcSJed Brown       /* Search for index of iremote[i].rank in sf->ranks */
950b5a8e515SJed Brown       ierr = PetscFindMPIInt(sf->remote[i].rank,sf->ndranks,sf->ranks,&irank);CHKERRQ(ierr);
951b5a8e515SJed Brown       if (irank < 0) {
952b5a8e515SJed Brown         ierr = PetscFindMPIInt(sf->remote[i].rank,sf->nranks-sf->ndranks,sf->ranks+sf->ndranks,&irank);CHKERRQ(ierr);
953b5a8e515SJed Brown         if (irank >= 0) irank += sf->ndranks;
95421c688dcSJed Brown       }
955247e8311SStefano Zampini       orank = sf->remote[i].rank;
956247e8311SStefano Zampini     }
957b5a8e515SJed Brown     if (irank < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Could not find rank %D in array",sf->remote[i].rank);
95821c688dcSJed Brown     sf->rmine[sf->roffset[irank] + rcount[irank]]   = sf->mine ? sf->mine[i] : i;
95921c688dcSJed Brown     sf->rremote[sf->roffset[irank] + rcount[irank]] = sf->remote[i].index;
96021c688dcSJed Brown     rcount[irank]++;
96121c688dcSJed Brown   }
96221c688dcSJed Brown   ierr = PetscFree2(rcount,ranks);CHKERRQ(ierr);
96321c688dcSJed Brown   PetscFunctionReturn(0);
96421c688dcSJed Brown }
96521c688dcSJed Brown 
96621c688dcSJed Brown /*@C
96795fce210SBarry Smith    PetscSFGetGroups - gets incoming and outgoing process groups
96895fce210SBarry Smith 
96995fce210SBarry Smith    Collective
97095fce210SBarry Smith 
97195fce210SBarry Smith    Input Argument:
97295fce210SBarry Smith .  sf - star forest
97395fce210SBarry Smith 
97495fce210SBarry Smith    Output Arguments:
97595fce210SBarry Smith +  incoming - group of origin processes for incoming edges (leaves that reference my roots)
97695fce210SBarry Smith -  outgoing - group of destination processes for outgoing edges (roots that I reference)
97795fce210SBarry Smith 
97895fce210SBarry Smith    Level: developer
97995fce210SBarry Smith 
98095fce210SBarry Smith .seealso: PetscSFGetWindow(), PetscSFRestoreWindow()
98195fce210SBarry Smith @*/
98295fce210SBarry Smith PetscErrorCode PetscSFGetGroups(PetscSF sf,MPI_Group *incoming,MPI_Group *outgoing)
98395fce210SBarry Smith {
98495fce210SBarry Smith   PetscErrorCode ierr;
9857fb8a5e4SKarl Rupp   MPI_Group      group = MPI_GROUP_NULL;
98695fce210SBarry Smith 
98795fce210SBarry Smith   PetscFunctionBegin;
98829046d53SLisandro Dalcin   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining groups");
98995fce210SBarry Smith   if (sf->ingroup == MPI_GROUP_NULL) {
99095fce210SBarry Smith     PetscInt       i;
99195fce210SBarry Smith     const PetscInt *indegree;
99295fce210SBarry Smith     PetscMPIInt    rank,*outranks,*inranks;
99395fce210SBarry Smith     PetscSFNode    *remote;
99495fce210SBarry Smith     PetscSF        bgcount;
99595fce210SBarry Smith 
99695fce210SBarry Smith     /* Compute the number of incoming ranks */
997785e854fSJed Brown     ierr = PetscMalloc1(sf->nranks,&remote);CHKERRQ(ierr);
99895fce210SBarry Smith     for (i=0; i<sf->nranks; i++) {
99995fce210SBarry Smith       remote[i].rank  = sf->ranks[i];
100095fce210SBarry Smith       remote[i].index = 0;
100195fce210SBarry Smith     }
100295fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,&bgcount);CHKERRQ(ierr);
100395fce210SBarry Smith     ierr = PetscSFSetGraph(bgcount,1,sf->nranks,NULL,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
100495fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(bgcount,&indegree);CHKERRQ(ierr);
100595fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(bgcount,&indegree);CHKERRQ(ierr);
100695fce210SBarry Smith 
100795fce210SBarry Smith     /* Enumerate the incoming ranks */
1008dcca6d9dSJed Brown     ierr = PetscMalloc2(indegree[0],&inranks,sf->nranks,&outranks);CHKERRQ(ierr);
100995fce210SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
101095fce210SBarry Smith     for (i=0; i<sf->nranks; i++) outranks[i] = rank;
101195fce210SBarry Smith     ierr = PetscSFGatherBegin(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
101295fce210SBarry Smith     ierr = PetscSFGatherEnd(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
101395fce210SBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
101495fce210SBarry Smith     ierr = MPI_Group_incl(group,indegree[0],inranks,&sf->ingroup);CHKERRQ(ierr);
101595fce210SBarry Smith     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
101695fce210SBarry Smith     ierr = PetscFree2(inranks,outranks);CHKERRQ(ierr);
101795fce210SBarry Smith     ierr = PetscSFDestroy(&bgcount);CHKERRQ(ierr);
101895fce210SBarry Smith   }
101995fce210SBarry Smith   *incoming = sf->ingroup;
102095fce210SBarry Smith 
102195fce210SBarry Smith   if (sf->outgroup == MPI_GROUP_NULL) {
102295fce210SBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
102395fce210SBarry Smith     ierr = MPI_Group_incl(group,sf->nranks,sf->ranks,&sf->outgroup);CHKERRQ(ierr);
102495fce210SBarry Smith     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
102595fce210SBarry Smith   }
102695fce210SBarry Smith   *outgoing = sf->outgroup;
102795fce210SBarry Smith   PetscFunctionReturn(0);
102895fce210SBarry Smith }
102995fce210SBarry Smith 
103029046d53SLisandro Dalcin /*@
103195fce210SBarry Smith    PetscSFGetMultiSF - gets the inner SF implemeting gathers and scatters
103295fce210SBarry Smith 
103395fce210SBarry Smith    Collective
103495fce210SBarry Smith 
103595fce210SBarry Smith    Input Argument:
103695fce210SBarry Smith .  sf - star forest that may contain roots with 0 or with more than 1 vertex
103795fce210SBarry Smith 
103895fce210SBarry Smith    Output Arguments:
103995fce210SBarry Smith .  multi - star forest with split roots, such that each root has degree exactly 1
104095fce210SBarry Smith 
104195fce210SBarry Smith    Level: developer
104295fce210SBarry Smith 
104395fce210SBarry Smith    Notes:
104495fce210SBarry Smith 
104595fce210SBarry Smith    In most cases, users should use PetscSFGatherBegin() and PetscSFScatterBegin() instead of manipulating multi
104695fce210SBarry Smith    directly. Since multi satisfies the stronger condition that each entry in the global space has exactly one incoming
104795fce210SBarry Smith    edge, it is a candidate for future optimization that might involve its removal.
104895fce210SBarry Smith 
1049673100f5SVaclav Hapla .seealso: PetscSFSetGraph(), PetscSFGatherBegin(), PetscSFScatterBegin(), PetscSFComputeMultiRootOriginalNumbering()
105095fce210SBarry Smith @*/
105195fce210SBarry Smith PetscErrorCode PetscSFGetMultiSF(PetscSF sf,PetscSF *multi)
105295fce210SBarry Smith {
105395fce210SBarry Smith   PetscErrorCode ierr;
105495fce210SBarry Smith 
105595fce210SBarry Smith   PetscFunctionBegin;
105695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
105795fce210SBarry Smith   PetscValidPointer(multi,2);
105895fce210SBarry Smith   if (sf->nroots < 0) {         /* Graph has not been set yet; why do we need this? */
105995fce210SBarry Smith     ierr   = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
106095fce210SBarry Smith     *multi = sf->multi;
106195fce210SBarry Smith     PetscFunctionReturn(0);
106295fce210SBarry Smith   }
106395fce210SBarry Smith   if (!sf->multi) {
106495fce210SBarry Smith     const PetscInt *indegree;
10659837ea96SMatthew G. Knepley     PetscInt       i,*inoffset,*outones,*outoffset,maxlocal;
106695fce210SBarry Smith     PetscSFNode    *remote;
106729046d53SLisandro Dalcin     maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
106895fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(sf,&indegree);CHKERRQ(ierr);
106995fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(sf,&indegree);CHKERRQ(ierr);
10709837ea96SMatthew G. Knepley     ierr = PetscMalloc3(sf->nroots+1,&inoffset,maxlocal,&outones,maxlocal,&outoffset);CHKERRQ(ierr);
107195fce210SBarry Smith     inoffset[0] = 0;
107295fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i+1] = inoffset[i] + indegree[i];
10739837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) outones[i] = 1;
1074dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpBegin(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
1075dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpEnd(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
107695fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i] -= indegree[i]; /* Undo the increment */
107795fce210SBarry Smith #if 0
107895fce210SBarry Smith #if defined(PETSC_USE_DEBUG)                                 /* Check that the expected number of increments occurred */
107995fce210SBarry Smith     for (i=0; i<sf->nroots; i++) {
108095fce210SBarry Smith       if (inoffset[i] + indegree[i] != inoffset[i+1]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Incorrect result after PetscSFFetchAndOp");
108195fce210SBarry Smith     }
108295fce210SBarry Smith #endif
108395fce210SBarry Smith #endif
1084785e854fSJed Brown     ierr = PetscMalloc1(sf->nleaves,&remote);CHKERRQ(ierr);
108595fce210SBarry Smith     for (i=0; i<sf->nleaves; i++) {
108695fce210SBarry Smith       remote[i].rank  = sf->remote[i].rank;
108738e7336fSToby Isaac       remote[i].index = outoffset[sf->mine ? sf->mine[i] : i];
108895fce210SBarry Smith     }
108995fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
109001365b40SToby Isaac     ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
109195fce210SBarry Smith     if (sf->rankorder) {        /* Sort the ranks */
109295fce210SBarry Smith       PetscMPIInt rank;
109395fce210SBarry Smith       PetscInt    *inranks,*newoffset,*outranks,*newoutoffset,*tmpoffset,maxdegree;
109495fce210SBarry Smith       PetscSFNode *newremote;
109595fce210SBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
109695fce210SBarry Smith       for (i=0,maxdegree=0; i<sf->nroots; i++) maxdegree = PetscMax(maxdegree,indegree[i]);
10979837ea96SMatthew G. Knepley       ierr = PetscMalloc5(sf->multi->nroots,&inranks,sf->multi->nroots,&newoffset,maxlocal,&outranks,maxlocal,&newoutoffset,maxdegree,&tmpoffset);CHKERRQ(ierr);
10989837ea96SMatthew G. Knepley       for (i=0; i<maxlocal; i++) outranks[i] = rank;
10998bfbc91cSJed Brown       ierr = PetscSFReduceBegin(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr);
11008bfbc91cSJed Brown       ierr = PetscSFReduceEnd(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr);
110195fce210SBarry Smith       /* Sort the incoming ranks at each vertex, build the inverse map */
110295fce210SBarry Smith       for (i=0; i<sf->nroots; i++) {
110395fce210SBarry Smith         PetscInt j;
110495fce210SBarry Smith         for (j=0; j<indegree[i]; j++) tmpoffset[j] = j;
110595fce210SBarry Smith         ierr = PetscSortIntWithArray(indegree[i],inranks+inoffset[i],tmpoffset);CHKERRQ(ierr);
110695fce210SBarry Smith         for (j=0; j<indegree[i]; j++) newoffset[inoffset[i] + tmpoffset[j]] = inoffset[i] + j;
110795fce210SBarry Smith       }
110895fce210SBarry Smith       ierr = PetscSFBcastBegin(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr);
110995fce210SBarry Smith       ierr = PetscSFBcastEnd(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr);
1110785e854fSJed Brown       ierr = PetscMalloc1(sf->nleaves,&newremote);CHKERRQ(ierr);
111195fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
111295fce210SBarry Smith         newremote[i].rank  = sf->remote[i].rank;
111301365b40SToby Isaac         newremote[i].index = newoutoffset[sf->mine ? sf->mine[i] : i];
111495fce210SBarry Smith       }
111501365b40SToby Isaac       ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,newremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
111695fce210SBarry Smith       ierr = PetscFree5(inranks,newoffset,outranks,newoutoffset,tmpoffset);CHKERRQ(ierr);
111795fce210SBarry Smith     }
111895fce210SBarry Smith     ierr = PetscFree3(inoffset,outones,outoffset);CHKERRQ(ierr);
111995fce210SBarry Smith   }
112095fce210SBarry Smith   *multi = sf->multi;
112195fce210SBarry Smith   PetscFunctionReturn(0);
112295fce210SBarry Smith }
112395fce210SBarry Smith 
112495fce210SBarry Smith /*@C
112595fce210SBarry Smith    PetscSFCreateEmbeddedSF - removes edges from all but the selected roots, does not remap indices
112695fce210SBarry Smith 
112795fce210SBarry Smith    Collective
112895fce210SBarry Smith 
112995fce210SBarry Smith    Input Arguments:
113095fce210SBarry Smith +  sf - original star forest
1131ba2a7774SJunchao Zhang .  nselected  - number of selected roots on this process
1132ba2a7774SJunchao Zhang -  selected   - indices of the selected roots on this process
113395fce210SBarry Smith 
113495fce210SBarry Smith    Output Arguments:
113595fce210SBarry Smith .  newsf - new star forest
113695fce210SBarry Smith 
113795fce210SBarry Smith    Level: advanced
113895fce210SBarry Smith 
113995fce210SBarry Smith    Note:
114095fce210SBarry Smith    To use the new PetscSF, it may be necessary to know the indices of the leaves that are still participating. This can
114195fce210SBarry Smith    be done by calling PetscSFGetGraph().
114295fce210SBarry Smith 
114395fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFGetGraph()
114495fce210SBarry Smith @*/
1145ba2a7774SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
114695fce210SBarry Smith {
1147f659e5c7SJunchao Zhang   PetscInt          i,n,*roots,*rootdata,*leafdata,nroots,nleaves,connected_leaves,*new_ilocal;
1148ba2a7774SJunchao Zhang   const PetscSFNode *iremote;
1149f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1150ba2a7774SJunchao Zhang   PetscSF           tmpsf;
1151f659e5c7SJunchao Zhang   MPI_Comm          comm;
11520511a646SMatthew G. Knepley   PetscErrorCode    ierr;
115395fce210SBarry Smith 
115495fce210SBarry Smith   PetscFunctionBegin;
115595fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
115629046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1157ba2a7774SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
115895fce210SBarry Smith   PetscValidPointer(newsf,4);
11590511a646SMatthew G. Knepley 
1160f659e5c7SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1161f659e5c7SJunchao Zhang 
1162f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in roots[] */
1163f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1164f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&roots);CHKERRQ(ierr);
1165dd5b3ca6SJunchao Zhang   ierr = PetscArraycpy(roots,selected,nselected);CHKERRQ(ierr);
1166f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,roots);CHKERRQ(ierr);
1167f659e5c7SJunchao 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);
1168f659e5c7SJunchao Zhang 
1169f659e5c7SJunchao Zhang   if (sf->ops->CreateEmbeddedSF) {
1170f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedSF)(sf,nselected,roots,newsf);CHKERRQ(ierr);
1171f659e5c7SJunchao Zhang   } else {
1172f659e5c7SJunchao Zhang     /* A generic version of creating embedded sf. Note that we called PetscSFSetGraph() twice, which is certainly expensive */
1173ba2a7774SJunchao Zhang     /* Find out which leaves (not leaf data items) are still connected to roots in the embedded sf */
1174f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,NULL,&iremote);CHKERRQ(ierr);
1175ba2a7774SJunchao Zhang     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&tmpsf);CHKERRQ(ierr);
1176ba2a7774SJunchao Zhang     ierr = PetscSFSetGraph(tmpsf,nroots,nleaves,NULL/*contiguous*/,PETSC_USE_POINTER,iremote,PETSC_USE_POINTER);CHKERRQ(ierr);
1177ba2a7774SJunchao Zhang     ierr = PetscCalloc2(nroots,&rootdata,nleaves,&leafdata);CHKERRQ(ierr);
1178f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) rootdata[roots[i]] = 1;
1179ba2a7774SJunchao Zhang     ierr = PetscSFBcastBegin(tmpsf,MPIU_INT,rootdata,leafdata);CHKERRQ(ierr);
1180ba2a7774SJunchao Zhang     ierr = PetscSFBcastEnd(tmpsf,MPIU_INT,rootdata,leafdata);CHKERRQ(ierr);
1181ba2a7774SJunchao Zhang     ierr = PetscSFDestroy(&tmpsf);CHKERRQ(ierr);
1182ba2a7774SJunchao Zhang 
1183ba2a7774SJunchao Zhang     /* Build newsf with leaves that are still connected */
1184f659e5c7SJunchao Zhang     connected_leaves = 0;
1185f659e5c7SJunchao Zhang     for (i=0; i<nleaves; ++i) connected_leaves += leafdata[i];
1186f659e5c7SJunchao Zhang     ierr = PetscMalloc1(connected_leaves,&new_ilocal);CHKERRQ(ierr);
1187f659e5c7SJunchao Zhang     ierr = PetscMalloc1(connected_leaves,&new_iremote);CHKERRQ(ierr);
1188ba2a7774SJunchao Zhang     for (i=0, n=0; i<nleaves; ++i) {
1189ba2a7774SJunchao Zhang       if (leafdata[i]) {
1190ba2a7774SJunchao Zhang         new_ilocal[n]        = sf->mine ? sf->mine[i] : i;
1191ba2a7774SJunchao Zhang         new_iremote[n].rank  = sf->remote[i].rank;
1192ba2a7774SJunchao Zhang         new_iremote[n].index = sf->remote[i].index;
1193fc1ede2bSMatthew G. Knepley         ++n;
119495fce210SBarry Smith       }
119595fce210SBarry Smith     }
1196f659e5c7SJunchao Zhang 
1197f659e5c7SJunchao 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);
1198f659e5c7SJunchao Zhang     ierr = PetscSFCreate(comm,newsf);CHKERRQ(ierr);
1199f659e5c7SJunchao Zhang     ierr = PetscSFSetFromOptions(*newsf);CHKERRQ(ierr);
1200f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,connected_leaves,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
120195fce210SBarry Smith     ierr = PetscFree2(rootdata,leafdata);CHKERRQ(ierr);
1202f659e5c7SJunchao Zhang   }
1203f659e5c7SJunchao Zhang   ierr = PetscFree(roots);CHKERRQ(ierr);
120495fce210SBarry Smith   PetscFunctionReturn(0);
120595fce210SBarry Smith }
120695fce210SBarry Smith 
12072f5fb4c2SMatthew G. Knepley /*@C
12082f5fb4c2SMatthew G. Knepley   PetscSFCreateEmbeddedLeafSF - removes edges from all but the selected leaves, does not remap indices
12092f5fb4c2SMatthew G. Knepley 
12102f5fb4c2SMatthew G. Knepley   Collective
12112f5fb4c2SMatthew G. Knepley 
12122f5fb4c2SMatthew G. Knepley   Input Arguments:
12132f5fb4c2SMatthew G. Knepley + sf - original star forest
1214f659e5c7SJunchao Zhang . nselected  - number of selected leaves on this process
1215f659e5c7SJunchao Zhang - selected   - indices of the selected leaves on this process
12162f5fb4c2SMatthew G. Knepley 
12172f5fb4c2SMatthew G. Knepley   Output Arguments:
12182f5fb4c2SMatthew G. Knepley .  newsf - new star forest
12192f5fb4c2SMatthew G. Knepley 
12202f5fb4c2SMatthew G. Knepley   Level: advanced
12212f5fb4c2SMatthew G. Knepley 
12222f5fb4c2SMatthew G. Knepley .seealso: PetscSFCreateEmbeddedSF(), PetscSFSetGraph(), PetscSFGetGraph()
12232f5fb4c2SMatthew G. Knepley @*/
1224f659e5c7SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
12252f5fb4c2SMatthew G. Knepley {
1226f659e5c7SJunchao Zhang   const PetscSFNode *iremote;
1227f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1228f659e5c7SJunchao Zhang   const PetscInt    *ilocal;
1229f659e5c7SJunchao Zhang   PetscInt          i,nroots,*leaves,*new_ilocal;
1230f659e5c7SJunchao Zhang   MPI_Comm          comm;
12312f5fb4c2SMatthew G. Knepley   PetscErrorCode    ierr;
12322f5fb4c2SMatthew G. Knepley 
12332f5fb4c2SMatthew G. Knepley   PetscFunctionBegin;
12342f5fb4c2SMatthew G. Knepley   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
123529046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1236f659e5c7SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
12372f5fb4c2SMatthew G. Knepley   PetscValidPointer(newsf,4);
12382f5fb4c2SMatthew G. Knepley 
1239f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in leaves[] */
1240f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1241f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&leaves);CHKERRQ(ierr);
1242dd5b3ca6SJunchao Zhang   ierr = PetscArraycpy(leaves,selected,nselected);CHKERRQ(ierr);
1243f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,leaves);CHKERRQ(ierr);
1244f659e5c7SJunchao 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);
1245f659e5c7SJunchao Zhang 
1246f659e5c7SJunchao Zhang   /* Optimize the routine only when sf is setup and hence we can reuse sf's communication pattern */
1247f659e5c7SJunchao Zhang   if (sf->setupcalled && sf->ops->CreateEmbeddedLeafSF) {
1248f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedLeafSF)(sf,nselected,leaves,newsf);CHKERRQ(ierr);
1249f659e5c7SJunchao Zhang   } else {
1250f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,NULL,&ilocal,&iremote);CHKERRQ(ierr);
1251f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_ilocal);CHKERRQ(ierr);
1252f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_iremote);CHKERRQ(ierr);
1253f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) {
1254f659e5c7SJunchao Zhang       const PetscInt l     = leaves[i];
1255f659e5c7SJunchao Zhang       new_ilocal[i]        = ilocal ? ilocal[l] : l;
1256f659e5c7SJunchao Zhang       new_iremote[i].rank  = iremote[l].rank;
1257f659e5c7SJunchao Zhang       new_iremote[i].index = iremote[l].index;
12582f5fb4c2SMatthew G. Knepley     }
1259f659e5c7SJunchao Zhang     ierr = PetscSFCreate(comm,newsf);CHKERRQ(ierr);
1260f659e5c7SJunchao Zhang     ierr = PetscSFSetFromOptions(*newsf);CHKERRQ(ierr);
1261f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,nselected,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
1262f659e5c7SJunchao Zhang   }
1263f659e5c7SJunchao Zhang   ierr = PetscFree(leaves);CHKERRQ(ierr);
12642f5fb4c2SMatthew G. Knepley   PetscFunctionReturn(0);
12652f5fb4c2SMatthew G. Knepley }
12662f5fb4c2SMatthew G. Knepley 
126795fce210SBarry Smith /*@C
12683482bfa8SJunchao Zhang    PetscSFBcastAndOpBegin - begin pointwise broadcast with root value being reduced to leaf value, to be concluded with call to PetscSFBcastAndOpEnd()
12693482bfa8SJunchao Zhang 
12703482bfa8SJunchao Zhang    Collective on PetscSF
12713482bfa8SJunchao Zhang 
12723482bfa8SJunchao Zhang    Input Arguments:
12733482bfa8SJunchao Zhang +  sf - star forest on which to communicate
12743482bfa8SJunchao Zhang .  unit - data type associated with each node
12753482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
12763482bfa8SJunchao Zhang -  op - operation to use for reduction
12773482bfa8SJunchao Zhang 
12783482bfa8SJunchao Zhang    Output Arguments:
12793482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
12803482bfa8SJunchao Zhang 
12813482bfa8SJunchao Zhang    Level: intermediate
12823482bfa8SJunchao Zhang 
12833482bfa8SJunchao Zhang .seealso: PetscSFBcastAndOpEnd(), PetscSFBcastBegin(), PetscSFBcastEnd()
12843482bfa8SJunchao Zhang @*/
12853482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpBegin(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
12863482bfa8SJunchao Zhang {
12873482bfa8SJunchao Zhang   PetscErrorCode ierr;
1288eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
12893482bfa8SJunchao Zhang 
12903482bfa8SJunchao Zhang   PetscFunctionBegin;
12913482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
12923482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
12933482bfa8SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1294eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1295eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1296eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
1297eb02082bSJunchao Zhang   /*  Shall we assume rootdata, leafdata are ready to use (instead of being computed by some asynchronous kernels)?
1298eb02082bSJunchao Zhang     To be similar to MPI, I'd like to have this assumption, since MPI does not have a concept of stream.
1299eb02082bSJunchao Zhang     But currently this assumption is not enforecd in Petsc. To be safe, I do synchronization here. Otherwise, if
1300eb02082bSJunchao Zhang     we do not sync now and call the Pack kernel directly on the default NULL stream (assume petsc objects are also
1301eb02082bSJunchao Zhang     computed on it), we have to sync the NULL stream before calling MPI routines. So, it looks a cudaDeviceSynchronize
1302eb02082bSJunchao Zhang     is inevitable. We do it now and put pack/unpack kernels to non-NULL streams.
1303eb02082bSJunchao Zhang    */
1304eb02082bSJunchao Zhang   if (rootmtype == PETSC_MEMTYPE_DEVICE || leafmtype == PETSC_MEMTYPE_DEVICE) {cudaError_t err = cudaDeviceSynchronize();CHKERRCUDA(err);}
1305eb02082bSJunchao Zhang #endif
1306eb02082bSJunchao Zhang   ierr = (*sf->ops->BcastAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr);
13073482bfa8SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
13083482bfa8SJunchao Zhang   PetscFunctionReturn(0);
13093482bfa8SJunchao Zhang }
13103482bfa8SJunchao Zhang 
13113482bfa8SJunchao Zhang /*@C
13123482bfa8SJunchao Zhang    PetscSFBcastAndOpEnd - end a broadcast & reduce operation started with PetscSFBcastAndOpBegin()
13133482bfa8SJunchao Zhang 
13143482bfa8SJunchao Zhang    Collective
13153482bfa8SJunchao Zhang 
13163482bfa8SJunchao Zhang    Input Arguments:
13173482bfa8SJunchao Zhang +  sf - star forest
13183482bfa8SJunchao Zhang .  unit - data type
13193482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
13203482bfa8SJunchao Zhang -  op - operation to use for reduction
13213482bfa8SJunchao Zhang 
13223482bfa8SJunchao Zhang    Output Arguments:
13233482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
13243482bfa8SJunchao Zhang 
13253482bfa8SJunchao Zhang    Level: intermediate
13263482bfa8SJunchao Zhang 
13273482bfa8SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFReduceEnd()
13283482bfa8SJunchao Zhang @*/
13293482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpEnd(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
13303482bfa8SJunchao Zhang {
13313482bfa8SJunchao Zhang   PetscErrorCode ierr;
1332eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
13333482bfa8SJunchao Zhang 
13343482bfa8SJunchao Zhang   PetscFunctionBegin;
13353482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
13363482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
13373482bfa8SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1338eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1339eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1340eb02082bSJunchao Zhang   ierr = (*sf->ops->BcastAndOpEnd)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr);
13413482bfa8SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
13423482bfa8SJunchao Zhang   PetscFunctionReturn(0);
13433482bfa8SJunchao Zhang }
13443482bfa8SJunchao Zhang 
13453482bfa8SJunchao Zhang /*@C
134695fce210SBarry Smith    PetscSFReduceBegin - begin reduction of leafdata into rootdata, to be completed with call to PetscSFReduceEnd()
134795fce210SBarry Smith 
134895fce210SBarry Smith    Collective
134995fce210SBarry Smith 
135095fce210SBarry Smith    Input Arguments:
135195fce210SBarry Smith +  sf - star forest
135295fce210SBarry Smith .  unit - data type
135395fce210SBarry Smith .  leafdata - values to reduce
135495fce210SBarry Smith -  op - reduction operation
135595fce210SBarry Smith 
135695fce210SBarry Smith    Output Arguments:
135795fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
135895fce210SBarry Smith 
135995fce210SBarry Smith    Level: intermediate
136095fce210SBarry Smith 
136195fce210SBarry Smith .seealso: PetscSFBcastBegin()
136295fce210SBarry Smith @*/
136395fce210SBarry Smith PetscErrorCode PetscSFReduceBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
136495fce210SBarry Smith {
136595fce210SBarry Smith   PetscErrorCode ierr;
1366eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
136795fce210SBarry Smith 
136895fce210SBarry Smith   PetscFunctionBegin;
136995fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
137095fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
137129046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);
1372eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1373eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1374eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
1375eb02082bSJunchao Zhang   if (rootmtype == PETSC_MEMTYPE_DEVICE || leafmtype == PETSC_MEMTYPE_DEVICE) {cudaError_t err = cudaDeviceSynchronize();CHKERRCUDA(err);}
1376eb02082bSJunchao Zhang #endif
1377eb02082bSJunchao Zhang   ierr = (sf->ops->ReduceBegin)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr);
1378563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);
137995fce210SBarry Smith   PetscFunctionReturn(0);
138095fce210SBarry Smith }
138195fce210SBarry Smith 
138295fce210SBarry Smith /*@C
138395fce210SBarry Smith    PetscSFReduceEnd - end a reduction operation started with PetscSFReduceBegin()
138495fce210SBarry Smith 
138595fce210SBarry Smith    Collective
138695fce210SBarry Smith 
138795fce210SBarry Smith    Input Arguments:
138895fce210SBarry Smith +  sf - star forest
138995fce210SBarry Smith .  unit - data type
139095fce210SBarry Smith .  leafdata - values to reduce
139195fce210SBarry Smith -  op - reduction operation
139295fce210SBarry Smith 
139395fce210SBarry Smith    Output Arguments:
139495fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
139595fce210SBarry Smith 
139695fce210SBarry Smith    Level: intermediate
139795fce210SBarry Smith 
139895fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFBcastEnd()
139995fce210SBarry Smith @*/
140095fce210SBarry Smith PetscErrorCode PetscSFReduceEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
140195fce210SBarry Smith {
140295fce210SBarry Smith   PetscErrorCode ierr;
1403eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
140495fce210SBarry Smith 
140595fce210SBarry Smith   PetscFunctionBegin;
140695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
140795fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
140829046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);
1409eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1410eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1411eb02082bSJunchao Zhang   ierr = (*sf->ops->ReduceEnd)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr);
1412563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);
141395fce210SBarry Smith   PetscFunctionReturn(0);
141495fce210SBarry Smith }
141595fce210SBarry Smith 
141695fce210SBarry Smith /*@C
1417a1729e3fSJunchao Zhang    PetscSFFetchAndOpBegin - begin operation that fetches values from root and updates atomically by applying operation using my leaf value, to be completed with PetscSFFetchAndOpEnd()
1418a1729e3fSJunchao Zhang 
1419a1729e3fSJunchao Zhang    Collective
1420a1729e3fSJunchao Zhang 
1421a1729e3fSJunchao Zhang    Input Arguments:
1422a1729e3fSJunchao Zhang +  sf - star forest
1423a1729e3fSJunchao Zhang .  unit - data type
1424a1729e3fSJunchao Zhang .  leafdata - leaf values to use in reduction
1425a1729e3fSJunchao Zhang -  op - operation to use for reduction
1426a1729e3fSJunchao Zhang 
1427a1729e3fSJunchao Zhang    Output Arguments:
1428a1729e3fSJunchao Zhang +  rootdata - root values to be updated, input state is seen by first process to perform an update
1429a1729e3fSJunchao Zhang -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
1430a1729e3fSJunchao Zhang 
1431a1729e3fSJunchao Zhang    Level: advanced
1432a1729e3fSJunchao Zhang 
1433a1729e3fSJunchao Zhang    Note:
1434a1729e3fSJunchao Zhang    The update is only atomic at the granularity provided by the hardware. Different roots referenced by the same process
1435a1729e3fSJunchao Zhang    might be updated in a different order. Furthermore, if a composite type is used for the unit datatype, atomicity is
1436a1729e3fSJunchao Zhang    not guaranteed across the whole vertex. Therefore, this function is mostly only used with primitive types such as
1437a1729e3fSJunchao Zhang    integers.
1438a1729e3fSJunchao Zhang 
1439a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeBegin(), PetscSFReduceBegin(), PetscSFSetGraph()
1440a1729e3fSJunchao Zhang @*/
1441a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpBegin(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
1442a1729e3fSJunchao Zhang {
1443a1729e3fSJunchao Zhang   PetscErrorCode ierr;
1444eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype,leafupdatemtype;
1445a1729e3fSJunchao Zhang 
1446a1729e3fSJunchao Zhang   PetscFunctionBegin;
1447a1729e3fSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1448a1729e3fSJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1449a1729e3fSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1450eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1451eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1452eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafupdate,&leafupdatemtype);CHKERRQ(ierr);
1453eb02082bSJunchao Zhang   if (leafmtype != leafupdatemtype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for leafdata and leafupdate in different memory types");
1454eb02082bSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
1455eb02082bSJunchao Zhang   if (rootmtype == PETSC_MEMTYPE_DEVICE || leafmtype == PETSC_MEMTYPE_DEVICE) {cudaError_t err = cudaDeviceSynchronize();CHKERRCUDA(err);}
1456eb02082bSJunchao Zhang #endif
1457eb02082bSJunchao Zhang   ierr = (*sf->ops->FetchAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,leafupdate,op);CHKERRQ(ierr);
1458a1729e3fSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1459a1729e3fSJunchao Zhang   PetscFunctionReturn(0);
1460a1729e3fSJunchao Zhang }
1461a1729e3fSJunchao Zhang 
1462a1729e3fSJunchao Zhang /*@C
1463a1729e3fSJunchao 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
1464a1729e3fSJunchao Zhang 
1465a1729e3fSJunchao Zhang    Collective
1466a1729e3fSJunchao Zhang 
1467a1729e3fSJunchao Zhang    Input Arguments:
1468a1729e3fSJunchao Zhang +  sf - star forest
1469a1729e3fSJunchao Zhang .  unit - data type
1470a1729e3fSJunchao Zhang .  leafdata - leaf values to use in reduction
1471a1729e3fSJunchao Zhang -  op - operation to use for reduction
1472a1729e3fSJunchao Zhang 
1473a1729e3fSJunchao Zhang    Output Arguments:
1474a1729e3fSJunchao Zhang +  rootdata - root values to be updated, input state is seen by first process to perform an update
1475a1729e3fSJunchao Zhang -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
1476a1729e3fSJunchao Zhang 
1477a1729e3fSJunchao Zhang    Level: advanced
1478a1729e3fSJunchao Zhang 
1479a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeEnd(), PetscSFReduceEnd(), PetscSFSetGraph()
1480a1729e3fSJunchao Zhang @*/
1481a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpEnd(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
1482a1729e3fSJunchao Zhang {
1483a1729e3fSJunchao Zhang   PetscErrorCode ierr;
1484eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype,leafupdatemtype;
1485a1729e3fSJunchao Zhang 
1486a1729e3fSJunchao Zhang   PetscFunctionBegin;
1487a1729e3fSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1488a1729e3fSJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1489a1729e3fSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1490eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1491eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1492eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafupdate,&leafupdatemtype);CHKERRQ(ierr);
1493eb02082bSJunchao Zhang   if (leafmtype != leafupdatemtype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for leafdata and leafupdate in different memory types");
1494eb02082bSJunchao Zhang   ierr = (*sf->ops->FetchAndOpEnd)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,leafupdate,op);CHKERRQ(ierr);
1495a1729e3fSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1496a1729e3fSJunchao Zhang   PetscFunctionReturn(0);
1497a1729e3fSJunchao Zhang }
1498a1729e3fSJunchao Zhang 
1499a1729e3fSJunchao Zhang /*@C
150095fce210SBarry Smith    PetscSFComputeDegreeBegin - begin computation of degree for each root vertex, to be completed with PetscSFComputeDegreeEnd()
150195fce210SBarry Smith 
150295fce210SBarry Smith    Collective
150395fce210SBarry Smith 
150495fce210SBarry Smith    Input Arguments:
150595fce210SBarry Smith .  sf - star forest
150695fce210SBarry Smith 
150795fce210SBarry Smith    Output Arguments:
150895fce210SBarry Smith .  degree - degree of each root vertex
150995fce210SBarry Smith 
151095fce210SBarry Smith    Level: advanced
151195fce210SBarry Smith 
1512ffe67aa5SVáclav Hapla    Notes:
1513ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1514ffe67aa5SVáclav Hapla 
151595fce210SBarry Smith .seealso: PetscSFGatherBegin()
151695fce210SBarry Smith @*/
151795fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeBegin(PetscSF sf,const PetscInt **degree)
151895fce210SBarry Smith {
151995fce210SBarry Smith   PetscErrorCode ierr;
152095fce210SBarry Smith 
152195fce210SBarry Smith   PetscFunctionBegin;
152295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
152395fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
152495fce210SBarry Smith   PetscValidPointer(degree,2);
1525803bd9e8SMatthew G. Knepley   if (!sf->degreeknown) {
152629046d53SLisandro Dalcin     PetscInt i, nroots = sf->nroots, maxlocal = sf->maxleaf+1;  /* TODO: We should use PetscSFGetLeafRange() */
1527803bd9e8SMatthew G. Knepley     if (sf->degree) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Calls to PetscSFComputeDegreeBegin() cannot be nested.");
152829046d53SLisandro Dalcin     ierr = PetscMalloc1(nroots,&sf->degree);CHKERRQ(ierr);
152929046d53SLisandro Dalcin     ierr = PetscMalloc1(PetscMax(maxlocal,1),&sf->degreetmp);CHKERRQ(ierr); /* allocate at least one entry, see check in PetscSFComputeDegreeEnd() */
153029046d53SLisandro Dalcin     for (i=0; i<nroots; i++) sf->degree[i] = 0;
15319837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) sf->degreetmp[i] = 1;
1532dbd2ff41SBarry Smith     ierr = PetscSFReduceBegin(sf,MPIU_INT,sf->degreetmp,sf->degree,MPI_SUM);CHKERRQ(ierr);
153395fce210SBarry Smith   }
153495fce210SBarry Smith   *degree = NULL;
153595fce210SBarry Smith   PetscFunctionReturn(0);
153695fce210SBarry Smith }
153795fce210SBarry Smith 
153895fce210SBarry Smith /*@C
153995fce210SBarry Smith    PetscSFComputeDegreeEnd - complete computation of degree for each root vertex, started with PetscSFComputeDegreeBegin()
154095fce210SBarry Smith 
154195fce210SBarry Smith    Collective
154295fce210SBarry Smith 
154395fce210SBarry Smith    Input Arguments:
154495fce210SBarry Smith .  sf - star forest
154595fce210SBarry Smith 
154695fce210SBarry Smith    Output Arguments:
154795fce210SBarry Smith .  degree - degree of each root vertex
154895fce210SBarry Smith 
154995fce210SBarry Smith    Level: developer
155095fce210SBarry Smith 
1551ffe67aa5SVáclav Hapla    Notes:
1552ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1553ffe67aa5SVáclav Hapla 
155495fce210SBarry Smith .seealso:
155595fce210SBarry Smith @*/
155695fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeEnd(PetscSF sf,const PetscInt **degree)
155795fce210SBarry Smith {
155895fce210SBarry Smith   PetscErrorCode ierr;
155995fce210SBarry Smith 
156095fce210SBarry Smith   PetscFunctionBegin;
156195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
156295fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
156329046d53SLisandro Dalcin   PetscValidPointer(degree,2);
156495fce210SBarry Smith   if (!sf->degreeknown) {
156529046d53SLisandro Dalcin     if (!sf->degreetmp) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call PetscSFComputeDegreeBegin() before PetscSFComputeDegreeEnd()");
1566dbd2ff41SBarry Smith     ierr = PetscSFReduceEnd(sf,MPIU_INT,sf->degreetmp,sf->degree,MPI_SUM);CHKERRQ(ierr);
156795fce210SBarry Smith     ierr = PetscFree(sf->degreetmp);CHKERRQ(ierr);
156895fce210SBarry Smith     sf->degreeknown = PETSC_TRUE;
156995fce210SBarry Smith   }
157095fce210SBarry Smith   *degree = sf->degree;
157195fce210SBarry Smith   PetscFunctionReturn(0);
157295fce210SBarry Smith }
157395fce210SBarry Smith 
1574673100f5SVaclav Hapla 
1575673100f5SVaclav Hapla /*@C
157666dfcd1aSVaclav Hapla    PetscSFComputeMultiRootOriginalNumbering - Returns original numbering of multi-roots (roots of multi-SF returned by PetscSFGetMultiSF()).
157766dfcd1aSVaclav Hapla    Each multi-root is assigned index of the corresponding original root.
1578673100f5SVaclav Hapla 
1579673100f5SVaclav Hapla    Collective
1580673100f5SVaclav Hapla 
1581673100f5SVaclav Hapla    Input Arguments:
1582673100f5SVaclav Hapla +  sf - star forest
1583673100f5SVaclav Hapla -  degree - degree of each root vertex, computed with PetscSFComputeDegreeBegin()/PetscSFComputeDegreeEnd()
1584673100f5SVaclav Hapla 
1585673100f5SVaclav Hapla    Output Arguments:
158666dfcd1aSVaclav Hapla +  nMultiRoots - (optional) number of multi-roots (roots of multi-SF)
158766dfcd1aSVaclav Hapla -  multiRootsOrigNumbering - original indices of multi-roots; length of this array is nMultiRoots
1588673100f5SVaclav Hapla 
1589673100f5SVaclav Hapla    Level: developer
1590673100f5SVaclav Hapla 
1591ffe67aa5SVáclav Hapla    Notes:
1592ffe67aa5SVáclav Hapla    The returned array multiRootsOrigNumbering is newly allocated and should be destroyed with PetscFree() when no longer needed.
1593ffe67aa5SVáclav Hapla 
1594673100f5SVaclav Hapla .seealso: PetscSFComputeDegreeBegin(), PetscSFComputeDegreeEnd(), PetscSFGetMultiSF()
1595673100f5SVaclav Hapla @*/
159666dfcd1aSVaclav Hapla PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF sf, const PetscInt degree[], PetscInt *nMultiRoots, PetscInt *multiRootsOrigNumbering[])
1597673100f5SVaclav Hapla {
1598673100f5SVaclav Hapla   PetscSF             msf;
1599673100f5SVaclav Hapla   PetscInt            i, j, k, nroots, nmroots;
1600673100f5SVaclav Hapla   PetscErrorCode      ierr;
1601673100f5SVaclav Hapla 
1602673100f5SVaclav Hapla   PetscFunctionBegin;
1603673100f5SVaclav Hapla   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1604673100f5SVaclav Hapla   ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
160529328920SVaclav Hapla   if (nroots) PetscValidIntPointer(degree,2);
160666dfcd1aSVaclav Hapla   if (nMultiRoots) PetscValidIntPointer(nMultiRoots,3);
160766dfcd1aSVaclav Hapla   PetscValidPointer(multiRootsOrigNumbering,4);
1608673100f5SVaclav Hapla   ierr = PetscSFGetMultiSF(sf,&msf);CHKERRQ(ierr);
1609673100f5SVaclav Hapla   ierr = PetscSFGetGraph(msf, &nmroots, NULL, NULL, NULL);CHKERRQ(ierr);
161066dfcd1aSVaclav Hapla   ierr = PetscMalloc1(nmroots, multiRootsOrigNumbering);CHKERRQ(ierr);
1611673100f5SVaclav Hapla   for (i=0,j=0,k=0; i<nroots; i++) {
1612673100f5SVaclav Hapla     if (!degree[i]) continue;
1613673100f5SVaclav Hapla     for (j=0; j<degree[i]; j++,k++) {
161466dfcd1aSVaclav Hapla       (*multiRootsOrigNumbering)[k] = i;
1615673100f5SVaclav Hapla     }
1616673100f5SVaclav Hapla   }
1617673100f5SVaclav Hapla #if defined(PETSC_USE_DEBUG)
1618673100f5SVaclav Hapla   if (PetscUnlikely(k != nmroots)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"sanity check fail");
1619673100f5SVaclav Hapla #endif
162066dfcd1aSVaclav Hapla   if (nMultiRoots) *nMultiRoots = nmroots;
1621673100f5SVaclav Hapla   PetscFunctionReturn(0);
1622673100f5SVaclav Hapla }
1623673100f5SVaclav Hapla 
162495fce210SBarry Smith /*@C
162595fce210SBarry Smith    PetscSFGatherBegin - begin pointwise gather of all leaves into multi-roots, to be completed with PetscSFGatherEnd()
162695fce210SBarry Smith 
162795fce210SBarry Smith    Collective
162895fce210SBarry Smith 
162995fce210SBarry Smith    Input Arguments:
163095fce210SBarry Smith +  sf - star forest
163195fce210SBarry Smith .  unit - data type
163295fce210SBarry Smith -  leafdata - leaf data to gather to roots
163395fce210SBarry Smith 
163495fce210SBarry Smith    Output Argument:
163595fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
163695fce210SBarry Smith 
163795fce210SBarry Smith    Level: intermediate
163895fce210SBarry Smith 
163995fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
164095fce210SBarry Smith @*/
164195fce210SBarry Smith PetscErrorCode PetscSFGatherBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
164295fce210SBarry Smith {
164395fce210SBarry Smith   PetscErrorCode ierr;
164495fce210SBarry Smith   PetscSF        multi;
164595fce210SBarry Smith 
164695fce210SBarry Smith   PetscFunctionBegin;
164795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
164829046d53SLisandro Dalcin   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
164995fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
16508bfbc91cSJed Brown   ierr = PetscSFReduceBegin(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr);
165195fce210SBarry Smith   PetscFunctionReturn(0);
165295fce210SBarry Smith }
165395fce210SBarry Smith 
165495fce210SBarry Smith /*@C
165595fce210SBarry Smith    PetscSFGatherEnd - ends pointwise gather operation that was started with PetscSFGatherBegin()
165695fce210SBarry Smith 
165795fce210SBarry Smith    Collective
165895fce210SBarry Smith 
165995fce210SBarry Smith    Input Arguments:
166095fce210SBarry Smith +  sf - star forest
166195fce210SBarry Smith .  unit - data type
166295fce210SBarry Smith -  leafdata - leaf data to gather to roots
166395fce210SBarry Smith 
166495fce210SBarry Smith    Output Argument:
166595fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
166695fce210SBarry Smith 
166795fce210SBarry Smith    Level: intermediate
166895fce210SBarry Smith 
166995fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
167095fce210SBarry Smith @*/
167195fce210SBarry Smith PetscErrorCode PetscSFGatherEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
167295fce210SBarry Smith {
167395fce210SBarry Smith   PetscErrorCode ierr;
167495fce210SBarry Smith   PetscSF        multi;
167595fce210SBarry Smith 
167695fce210SBarry Smith   PetscFunctionBegin;
167795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
167895fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
167995fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
16808bfbc91cSJed Brown   ierr = PetscSFReduceEnd(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr);
168195fce210SBarry Smith   PetscFunctionReturn(0);
168295fce210SBarry Smith }
168395fce210SBarry Smith 
168495fce210SBarry Smith /*@C
168595fce210SBarry Smith    PetscSFScatterBegin - begin pointwise scatter operation from multi-roots to leaves, to be completed with PetscSFScatterEnd()
168695fce210SBarry Smith 
168795fce210SBarry Smith    Collective
168895fce210SBarry Smith 
168995fce210SBarry Smith    Input Arguments:
169095fce210SBarry Smith +  sf - star forest
169195fce210SBarry Smith .  unit - data type
169295fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
169395fce210SBarry Smith 
169495fce210SBarry Smith    Output Argument:
169595fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
169695fce210SBarry Smith 
169795fce210SBarry Smith    Level: intermediate
169895fce210SBarry Smith 
169995fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
170095fce210SBarry Smith @*/
170195fce210SBarry Smith PetscErrorCode PetscSFScatterBegin(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
170295fce210SBarry Smith {
170395fce210SBarry Smith   PetscErrorCode ierr;
170495fce210SBarry Smith   PetscSF        multi;
170595fce210SBarry Smith 
170695fce210SBarry Smith   PetscFunctionBegin;
170795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
170895fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
170995fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
171095fce210SBarry Smith   ierr = PetscSFBcastBegin(multi,unit,multirootdata,leafdata);CHKERRQ(ierr);
171195fce210SBarry Smith   PetscFunctionReturn(0);
171295fce210SBarry Smith }
171395fce210SBarry Smith 
171495fce210SBarry Smith /*@C
171595fce210SBarry Smith    PetscSFScatterEnd - ends pointwise scatter operation that was started with PetscSFScatterBegin()
171695fce210SBarry Smith 
171795fce210SBarry Smith    Collective
171895fce210SBarry Smith 
171995fce210SBarry Smith    Input Arguments:
172095fce210SBarry Smith +  sf - star forest
172195fce210SBarry Smith .  unit - data type
172295fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
172395fce210SBarry Smith 
172495fce210SBarry Smith    Output Argument:
172595fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
172695fce210SBarry Smith 
172795fce210SBarry Smith    Level: intermediate
172895fce210SBarry Smith 
172995fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
173095fce210SBarry Smith @*/
173195fce210SBarry Smith PetscErrorCode PetscSFScatterEnd(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
173295fce210SBarry Smith {
173395fce210SBarry Smith   PetscErrorCode ierr;
173495fce210SBarry Smith   PetscSF        multi;
173595fce210SBarry Smith 
173695fce210SBarry Smith   PetscFunctionBegin;
173795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
173895fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
173995fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
174095fce210SBarry Smith   ierr = PetscSFBcastEnd(multi,unit,multirootdata,leafdata);CHKERRQ(ierr);
174195fce210SBarry Smith   PetscFunctionReturn(0);
174295fce210SBarry Smith }
1743a7b3aa13SAta Mesgarnejad 
1744a072220fSLawrence Mitchell static PetscErrorCode PetscSFCheckLeavesUnique_Private(PetscSF sf)
1745a072220fSLawrence Mitchell {
1746a072220fSLawrence Mitchell #if defined(PETSC_USE_DEBUG)
1747a072220fSLawrence Mitchell   PetscInt        i, n, nleaves;
1748a072220fSLawrence Mitchell   const PetscInt *ilocal = NULL;
1749a072220fSLawrence Mitchell   PetscHSetI      seen;
1750a072220fSLawrence Mitchell   PetscErrorCode  ierr;
1751a072220fSLawrence Mitchell 
1752a072220fSLawrence Mitchell   PetscFunctionBegin;
1753a072220fSLawrence Mitchell   ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
1754a072220fSLawrence Mitchell   ierr = PetscHSetICreate(&seen);CHKERRQ(ierr);
1755a072220fSLawrence Mitchell   for (i = 0; i < nleaves; i++) {
1756a072220fSLawrence Mitchell     const PetscInt leaf = ilocal ? ilocal[i] : i;
1757a072220fSLawrence Mitchell     ierr = PetscHSetIAdd(seen,leaf);CHKERRQ(ierr);
1758a072220fSLawrence Mitchell   }
1759a072220fSLawrence Mitchell   ierr = PetscHSetIGetSize(seen,&n);CHKERRQ(ierr);
1760a072220fSLawrence Mitchell   if (n != nleaves) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided leaves have repeated values: all leaves must be unique");
1761a072220fSLawrence Mitchell   ierr = PetscHSetIDestroy(&seen);CHKERRQ(ierr);
1762a072220fSLawrence Mitchell   PetscFunctionReturn(0);
1763a072220fSLawrence Mitchell #else
1764a072220fSLawrence Mitchell   PetscFunctionBegin;
1765a072220fSLawrence Mitchell   PetscFunctionReturn(0);
1766a072220fSLawrence Mitchell #endif
1767a072220fSLawrence Mitchell }
176854729392SStefano Zampini 
1769a7b3aa13SAta Mesgarnejad /*@
177004c0ada0SJunchao Zhang   PetscSFCompose - Compose a new PetscSF by putting the second SF under the first one in a top (roots) down (leaves) view
1771a7b3aa13SAta Mesgarnejad 
1772a7b3aa13SAta Mesgarnejad   Input Parameters:
177354729392SStefano Zampini + sfA - The first PetscSF
177454729392SStefano Zampini - sfB - The second PetscSF
1775a7b3aa13SAta Mesgarnejad 
1776a7b3aa13SAta Mesgarnejad   Output Parameters:
177754729392SStefano Zampini . sfBA - The composite SF
1778a7b3aa13SAta Mesgarnejad 
1779a7b3aa13SAta Mesgarnejad   Level: developer
1780a7b3aa13SAta Mesgarnejad 
1781a072220fSLawrence Mitchell   Notes:
178254729392SStefano Zampini   Currently, the two SFs must be defined on congruent communicators and they must be true star
178354729392SStefano Zampini   forests, i.e. the same leaf is not connected with different roots.
178454729392SStefano Zampini 
178554729392SStefano Zampini   sfA's leaf space and sfB's root space might be partially overlapped. The composition builds
178654729392SStefano Zampini   a graph with sfA's roots and sfB's leaves only when there is a path between them. Unconnected
178754729392SStefano Zampini   nodes (roots or leaves) are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a
178854729392SStefano Zampini   Bcast on sfA, then a Bcast on sfB, on connected nodes.
1789a072220fSLawrence Mitchell 
179004c0ada0SJunchao Zhang .seealso: PetscSF, PetscSFComposeInverse(), PetscSFGetGraph(), PetscSFSetGraph()
1791a7b3aa13SAta Mesgarnejad @*/
1792a7b3aa13SAta Mesgarnejad PetscErrorCode PetscSFCompose(PetscSF sfA,PetscSF sfB,PetscSF *sfBA)
1793a7b3aa13SAta Mesgarnejad {
179404c0ada0SJunchao Zhang   PetscErrorCode    ierr;
1795a7b3aa13SAta Mesgarnejad   const PetscSFNode *remotePointsA,*remotePointsB;
1796d41018fbSJunchao Zhang   PetscSFNode       *remotePointsBA=NULL,*reorderedRemotePointsA = NULL,*leafdataB;
179754729392SStefano Zampini   const PetscInt    *localPointsA,*localPointsB;
179854729392SStefano Zampini   PetscInt          *localPointsBA;
179954729392SStefano Zampini   PetscInt          i,numRootsA,numLeavesA,numRootsB,numLeavesB,minleaf,maxleaf,numLeavesBA;
180054729392SStefano Zampini   PetscBool         denseB;
1801a7b3aa13SAta Mesgarnejad 
1802a7b3aa13SAta Mesgarnejad   PetscFunctionBegin;
1803a7b3aa13SAta Mesgarnejad   PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1);
180429046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfA,1);
180529046d53SLisandro Dalcin   PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2);
180629046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfB,2);
180754729392SStefano Zampini   PetscCheckSameComm(sfA,1,sfB,2);
180829046d53SLisandro Dalcin   PetscValidPointer(sfBA,3);
180954729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr);
181054729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr);
181154729392SStefano Zampini 
1812a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfA,&numRootsA,&numLeavesA,&localPointsA,&remotePointsA);CHKERRQ(ierr);
1813a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfB,&numRootsB,&numLeavesB,&localPointsB,&remotePointsB);CHKERRQ(ierr);
1814d41018fbSJunchao Zhang   if (localPointsA) {
181554729392SStefano Zampini     ierr = PetscMalloc1(numRootsB,&reorderedRemotePointsA);CHKERRQ(ierr);
181654729392SStefano Zampini     for (i=0; i<numRootsB; i++) {
181754729392SStefano Zampini       reorderedRemotePointsA[i].rank = -1;
181854729392SStefano Zampini       reorderedRemotePointsA[i].index = -1;
181954729392SStefano Zampini     }
182054729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
182154729392SStefano Zampini       if (localPointsA[i] >= numRootsB) continue;
182254729392SStefano Zampini       reorderedRemotePointsA[localPointsA[i]] = remotePointsA[i];
182354729392SStefano Zampini     }
1824d41018fbSJunchao Zhang     remotePointsA = reorderedRemotePointsA;
1825d41018fbSJunchao Zhang   }
1826d41018fbSJunchao Zhang   ierr = PetscSFGetLeafRange(sfB,&minleaf,&maxleaf);CHKERRQ(ierr);
1827d41018fbSJunchao Zhang   ierr = PetscMalloc1(maxleaf-minleaf+1,&leafdataB);CHKERRQ(ierr);
1828d41018fbSJunchao Zhang   ierr = PetscSFBcastBegin(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf);CHKERRQ(ierr);
1829d41018fbSJunchao Zhang   ierr = PetscSFBcastEnd(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf);CHKERRQ(ierr);
1830d41018fbSJunchao Zhang   ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr);
1831d41018fbSJunchao Zhang 
183254729392SStefano Zampini   denseB = (PetscBool)!localPointsB;
183354729392SStefano Zampini   for (i=0,numLeavesBA=0; i<numLeavesB; i++) {
183454729392SStefano Zampini     if (leafdataB[localPointsB ? localPointsB[i]-minleaf : i].rank == -1) denseB = PETSC_FALSE;
183554729392SStefano Zampini     else numLeavesBA++;
183654729392SStefano Zampini   }
183754729392SStefano Zampini   if (denseB) {
1838d41018fbSJunchao Zhang     localPointsBA  = NULL;
1839d41018fbSJunchao Zhang     remotePointsBA = leafdataB;
1840d41018fbSJunchao Zhang   } else {
184154729392SStefano Zampini     ierr = PetscMalloc1(numLeavesBA,&localPointsBA);CHKERRQ(ierr);
184254729392SStefano Zampini     ierr = PetscMalloc1(numLeavesBA,&remotePointsBA);CHKERRQ(ierr);
184354729392SStefano Zampini     for (i=0,numLeavesBA=0; i<numLeavesB; i++) {
184454729392SStefano Zampini       const PetscInt l = localPointsB ? localPointsB[i] : i;
184554729392SStefano Zampini 
184654729392SStefano Zampini       if (leafdataB[l-minleaf].rank == -1) continue;
184754729392SStefano Zampini       remotePointsBA[numLeavesBA] = leafdataB[l-minleaf];
184854729392SStefano Zampini       localPointsBA[numLeavesBA] = l;
184954729392SStefano Zampini       numLeavesBA++;
185054729392SStefano Zampini     }
1851d41018fbSJunchao Zhang     ierr = PetscFree(leafdataB);CHKERRQ(ierr);
1852d41018fbSJunchao Zhang   }
185354729392SStefano Zampini   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr);
185454729392SStefano Zampini   ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr);
1855a7b3aa13SAta Mesgarnejad   PetscFunctionReturn(0);
1856a7b3aa13SAta Mesgarnejad }
18571c6ba672SJunchao Zhang 
185804c0ada0SJunchao Zhang /*@
185954729392SStefano Zampini   PetscSFComposeInverse - Compose a new PetscSF by putting the inverse of the second SF under the first one
186004c0ada0SJunchao Zhang 
186104c0ada0SJunchao Zhang   Input Parameters:
186254729392SStefano Zampini + sfA - The first PetscSF
186354729392SStefano Zampini - sfB - The second PetscSF
186404c0ada0SJunchao Zhang 
186504c0ada0SJunchao Zhang   Output Parameters:
186654729392SStefano Zampini . sfBA - The composite SF.
186704c0ada0SJunchao Zhang 
186804c0ada0SJunchao Zhang   Level: developer
186904c0ada0SJunchao Zhang 
187054729392SStefano Zampini   Notes:
187154729392SStefano Zampini   Currently, the two SFs must be defined on congruent communicators and they must be true star
187254729392SStefano Zampini   forests, i.e. the same leaf is not connected with different roots. Even more, all roots of the
187354729392SStefano Zampini   second SF must have a degree of 1, i.e., no roots have more than one leaf connected.
187454729392SStefano Zampini 
187554729392SStefano Zampini   sfA's leaf space and sfB's leaf space might be partially overlapped. The composition builds
187654729392SStefano Zampini   a graph with sfA's roots and sfB's roots only when there is a path between them. Unconnected
187754729392SStefano Zampini   roots are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a Bcast on sfA, then
187854729392SStefano Zampini   a Reduce on sfB, on connected roots.
187954729392SStefano Zampini 
188054729392SStefano Zampini .seealso: PetscSF, PetscSFCompose(), PetscSFGetGraph(), PetscSFSetGraph(), PetscSFCreateInverseSF()
188104c0ada0SJunchao Zhang @*/
188204c0ada0SJunchao Zhang PetscErrorCode PetscSFComposeInverse(PetscSF sfA,PetscSF sfB,PetscSF *sfBA)
188304c0ada0SJunchao Zhang {
188404c0ada0SJunchao Zhang   PetscErrorCode    ierr;
188504c0ada0SJunchao Zhang   const PetscSFNode *remotePointsA,*remotePointsB;
188604c0ada0SJunchao Zhang   PetscSFNode       *remotePointsBA;
188704c0ada0SJunchao Zhang   const PetscInt    *localPointsA,*localPointsB;
188854729392SStefano Zampini   PetscSFNode       *reorderedRemotePointsA = NULL;
188954729392SStefano Zampini   PetscInt          i,numRootsA,numLeavesA,numLeavesBA,numRootsB,numLeavesB,minleaf,maxleaf,*localPointsBA;
189004c0ada0SJunchao Zhang 
189104c0ada0SJunchao Zhang   PetscFunctionBegin;
189204c0ada0SJunchao Zhang   PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1);
189304c0ada0SJunchao Zhang   PetscSFCheckGraphSet(sfA,1);
189404c0ada0SJunchao Zhang   PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2);
189504c0ada0SJunchao Zhang   PetscSFCheckGraphSet(sfB,2);
189654729392SStefano Zampini   PetscCheckSameComm(sfA,1,sfB,2);
189704c0ada0SJunchao Zhang   PetscValidPointer(sfBA,3);
189854729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr);
189954729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr);
190054729392SStefano Zampini   /* TODO: Check roots of sfB have degree of 1 */
190154729392SStefano Zampini 
190204c0ada0SJunchao Zhang   ierr = PetscSFGetGraph(sfA, &numRootsA, &numLeavesA, &localPointsA, &remotePointsA);CHKERRQ(ierr);
190304c0ada0SJunchao Zhang   ierr = PetscSFGetGraph(sfB, &numRootsB, &numLeavesB, &localPointsB, &remotePointsB);CHKERRQ(ierr);
190454729392SStefano Zampini   ierr = PetscSFGetLeafRange(sfB, &minleaf, &maxleaf);CHKERRQ(ierr);
190554729392SStefano Zampini   ierr = PetscMalloc1(maxleaf - minleaf + 1,&reorderedRemotePointsA);CHKERRQ(ierr);
190654729392SStefano Zampini   for (i=0; i<maxleaf - minleaf + 1; i++) {
190754729392SStefano Zampini     reorderedRemotePointsA[i].rank = -1;
190854729392SStefano Zampini     reorderedRemotePointsA[i].index = -1;
190954729392SStefano Zampini   }
191054729392SStefano Zampini   if (localPointsA) {
191154729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
191254729392SStefano Zampini       if (localPointsA[i] > maxleaf || localPointsA[i] < minleaf) continue;
191354729392SStefano Zampini       reorderedRemotePointsA[localPointsA[i] - minleaf] = remotePointsA[i];
191454729392SStefano Zampini     }
191554729392SStefano Zampini   } else {
191654729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
191754729392SStefano Zampini       if (i > maxleaf || i < minleaf) continue;
191854729392SStefano Zampini       reorderedRemotePointsA[i - minleaf] = remotePointsA[i];
191954729392SStefano Zampini     }
192054729392SStefano Zampini   }
192154729392SStefano Zampini 
192254729392SStefano Zampini   ierr = PetscMalloc1(numRootsB,&localPointsBA);CHKERRQ(ierr);
192304c0ada0SJunchao Zhang   ierr = PetscMalloc1(numRootsB,&remotePointsBA);CHKERRQ(ierr);
192454729392SStefano Zampini   for (i=0; i<numRootsB; i++) {
192554729392SStefano Zampini     remotePointsBA[i].rank = -1;
192654729392SStefano Zampini     remotePointsBA[i].index = -1;
192754729392SStefano Zampini   }
192854729392SStefano Zampini 
192954729392SStefano Zampini   /* Once we implement the TODO above (check all roots of sfB have degree of 1), we can replace the MPI_MAXLOC
193054729392SStefano Zampini      with MPIU_REPLACE. In that case, MPI_MAXLOC and MPIU_REPLACE have the same effect.
193154729392SStefano Zampini    */
193254729392SStefano Zampini   ierr = PetscSFReduceBegin(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,MPI_MAXLOC);CHKERRQ(ierr);
193354729392SStefano Zampini   ierr = PetscSFReduceEnd(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,MPI_MAXLOC);CHKERRQ(ierr);
193454729392SStefano Zampini   ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr);
193554729392SStefano Zampini   for (i=0,numLeavesBA=0; i<numRootsB; i++) {
193654729392SStefano Zampini     if (remotePointsBA[i].rank == -1) continue;
193754729392SStefano Zampini     remotePointsBA[numLeavesBA].rank = remotePointsBA[i].rank;
193854729392SStefano Zampini     remotePointsBA[numLeavesBA].index = remotePointsBA[i].index;
193954729392SStefano Zampini     localPointsBA[numLeavesBA] = i;
194054729392SStefano Zampini     numLeavesBA++;
194154729392SStefano Zampini   }
194254729392SStefano Zampini   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr);
194354729392SStefano Zampini   ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr);
194404c0ada0SJunchao Zhang   PetscFunctionReturn(0);
194504c0ada0SJunchao Zhang }
194604c0ada0SJunchao Zhang 
19471c6ba672SJunchao Zhang /*
19481c6ba672SJunchao Zhang   PetscSFCreateLocalSF_Private - Creates a local PetscSF that only has intra-process edges of the global PetscSF
19491c6ba672SJunchao Zhang 
19501c6ba672SJunchao Zhang   Input Parameters:
19511c6ba672SJunchao Zhang . sf - The global PetscSF
19521c6ba672SJunchao Zhang 
19531c6ba672SJunchao Zhang   Output Parameters:
19541c6ba672SJunchao Zhang . out - The local PetscSF
19551c6ba672SJunchao Zhang  */
19561c6ba672SJunchao Zhang PetscErrorCode PetscSFCreateLocalSF_Private(PetscSF sf,PetscSF *out)
19571c6ba672SJunchao Zhang {
19581c6ba672SJunchao Zhang   MPI_Comm           comm;
19591c6ba672SJunchao Zhang   PetscMPIInt        myrank;
19601c6ba672SJunchao Zhang   const PetscInt     *ilocal;
19611c6ba672SJunchao Zhang   const PetscSFNode  *iremote;
19621c6ba672SJunchao Zhang   PetscInt           i,j,nroots,nleaves,lnleaves,*lilocal;
19631c6ba672SJunchao Zhang   PetscSFNode        *liremote;
19641c6ba672SJunchao Zhang   PetscSF            lsf;
19651c6ba672SJunchao Zhang   PetscErrorCode     ierr;
19661c6ba672SJunchao Zhang 
19671c6ba672SJunchao Zhang   PetscFunctionBegin;
19681c6ba672SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
19691c6ba672SJunchao Zhang   if (sf->ops->CreateLocalSF) {
19701c6ba672SJunchao Zhang     ierr = (*sf->ops->CreateLocalSF)(sf,out);CHKERRQ(ierr);
19711c6ba672SJunchao Zhang   } else {
19721c6ba672SJunchao Zhang     /* Could use PetscSFCreateEmbeddedLeafSF, but since we know the comm is PETSC_COMM_SELF, we can make it fast */
19731c6ba672SJunchao Zhang     ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
19741c6ba672SJunchao Zhang     ierr = MPI_Comm_rank(comm,&myrank);CHKERRQ(ierr);
19751c6ba672SJunchao Zhang 
19761c6ba672SJunchao Zhang     /* Find out local edges and build a local SF */
19771c6ba672SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
19781c6ba672SJunchao Zhang     for (i=lnleaves=0; i<nleaves; i++) {if (iremote[i].rank == (PetscInt)myrank) lnleaves++;}
19791c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&lilocal);CHKERRQ(ierr);
19801c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&liremote);CHKERRQ(ierr);
19811c6ba672SJunchao Zhang 
19821c6ba672SJunchao Zhang     for (i=j=0; i<nleaves; i++) {
19831c6ba672SJunchao Zhang       if (iremote[i].rank == (PetscInt)myrank) {
19841c6ba672SJunchao Zhang         lilocal[j]        = ilocal? ilocal[i] : i; /* ilocal=NULL for contiguous storage */
19851c6ba672SJunchao Zhang         liremote[j].rank  = 0; /* rank in PETSC_COMM_SELF */
19861c6ba672SJunchao Zhang         liremote[j].index = iremote[i].index;
19871c6ba672SJunchao Zhang         j++;
19881c6ba672SJunchao Zhang       }
19891c6ba672SJunchao Zhang     }
19901c6ba672SJunchao Zhang     ierr = PetscSFCreate(PETSC_COMM_SELF,&lsf);CHKERRQ(ierr);
19911c6ba672SJunchao Zhang     ierr = PetscSFSetGraph(lsf,nroots,lnleaves,lilocal,PETSC_OWN_POINTER,liremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
19921c6ba672SJunchao Zhang     ierr = PetscSFSetUp(lsf);CHKERRQ(ierr);
19931c6ba672SJunchao Zhang     *out = lsf;
19941c6ba672SJunchao Zhang   }
19951c6ba672SJunchao Zhang   PetscFunctionReturn(0);
19961c6ba672SJunchao Zhang }
1997dd5b3ca6SJunchao Zhang 
1998dd5b3ca6SJunchao Zhang /* Similar to PetscSFBcast, but only Bcast to leaves on rank 0 */
1999dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFBcastToZero_Private(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata)
2000dd5b3ca6SJunchao Zhang {
2001dd5b3ca6SJunchao Zhang   PetscErrorCode     ierr;
2002eb02082bSJunchao Zhang   PetscMemType       rootmtype,leafmtype;
2003dd5b3ca6SJunchao Zhang 
2004dd5b3ca6SJunchao Zhang   PetscFunctionBegin;
2005dd5b3ca6SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
2006dd5b3ca6SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
2007dd5b3ca6SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
2008eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
2009eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
2010dd5b3ca6SJunchao Zhang   if (sf->ops->BcastToZero) {
2011eb02082bSJunchao Zhang     ierr = (*sf->ops->BcastToZero)(sf,unit,rootmtype,rootdata,leafmtype,leafdata);CHKERRQ(ierr);
2012dd5b3ca6SJunchao Zhang   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFBcastToZero_Private is not supported on this SF type");
2013dd5b3ca6SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
2014dd5b3ca6SJunchao Zhang   PetscFunctionReturn(0);
2015dd5b3ca6SJunchao Zhang }
2016dd5b3ca6SJunchao Zhang 
2017