xref: /petsc/src/vec/is/sf/interface/sf.c (revision b8dee149cebb0df1d9ad7b1e4169e24a3c108940)
1af0996ceSBarry Smith #include <petsc/private/sfimpl.h> /*I "petscsf.h" I*/
295fce210SBarry Smith #include <petscctable.h>
395fce210SBarry Smith 
495fce210SBarry Smith #if defined(PETSC_USE_DEBUG)
595fce210SBarry Smith #  define PetscSFCheckGraphSet(sf,arg) do {                          \
695fce210SBarry Smith     if (PetscUnlikely(!(sf)->graphset))                              \
795fce210SBarry Smith       SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetGraph() on argument %D \"%s\" before %s()",(arg),#sf,PETSC_FUNCTION_NAME); \
895fce210SBarry Smith   } while (0)
995fce210SBarry Smith #else
1095fce210SBarry Smith #  define PetscSFCheckGraphSet(sf,arg) do {} while (0)
1195fce210SBarry Smith #endif
1295fce210SBarry Smith 
1395fce210SBarry Smith const char *const PetscSFDuplicateOptions[] = {"CONFONLY","RANKS","GRAPH","PetscSFDuplicateOption","PETSCSF_DUPLICATE_",0};
1495fce210SBarry Smith 
158af6ec1cSBarry Smith /*@
1695fce210SBarry Smith    PetscSFCreate - create a star forest communication context
1795fce210SBarry Smith 
18d083f849SBarry Smith    Collective
1995fce210SBarry Smith 
2095fce210SBarry Smith    Input Arguments:
2195fce210SBarry Smith .  comm - communicator on which the star forest will operate
2295fce210SBarry Smith 
2395fce210SBarry Smith    Output Arguments:
2495fce210SBarry Smith .  sf - new star forest context
2595fce210SBarry Smith 
2695fce210SBarry Smith    Level: intermediate
2795fce210SBarry Smith 
2895fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFDestroy()
2995fce210SBarry Smith @*/
3095fce210SBarry Smith PetscErrorCode PetscSFCreate(MPI_Comm comm,PetscSF *sf)
3195fce210SBarry Smith {
3295fce210SBarry Smith   PetscErrorCode ierr;
3395fce210SBarry Smith   PetscSF        b;
3495fce210SBarry Smith 
3595fce210SBarry Smith   PetscFunctionBegin;
3695fce210SBarry Smith   PetscValidPointer(sf,2);
37607a6623SBarry Smith   ierr = PetscSFInitializePackage();CHKERRQ(ierr);
3895fce210SBarry Smith 
3973107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(b,PETSCSF_CLASSID,"PetscSF","Star Forest","PetscSF",comm,PetscSFDestroy,PetscSFView);CHKERRQ(ierr);
4095fce210SBarry Smith 
4195fce210SBarry Smith   b->nroots    = -1;
4295fce210SBarry Smith   b->nleaves   = -1;
4329046d53SLisandro Dalcin   b->minleaf   = PETSC_MAX_INT;
4429046d53SLisandro Dalcin   b->maxleaf   = PETSC_MIN_INT;
4595fce210SBarry Smith   b->nranks    = -1;
4695fce210SBarry Smith   b->rankorder = PETSC_TRUE;
4795fce210SBarry Smith   b->ingroup   = MPI_GROUP_NULL;
4895fce210SBarry Smith   b->outgroup  = MPI_GROUP_NULL;
4995fce210SBarry Smith   b->graphset  = PETSC_FALSE;
5095fce210SBarry Smith 
5195fce210SBarry Smith   *sf = b;
5295fce210SBarry Smith   PetscFunctionReturn(0);
5395fce210SBarry Smith }
5495fce210SBarry Smith 
5529046d53SLisandro Dalcin /*@
5695fce210SBarry Smith    PetscSFReset - Reset a star forest so that different sizes or neighbors can be used
5795fce210SBarry Smith 
5895fce210SBarry Smith    Collective
5995fce210SBarry Smith 
6095fce210SBarry Smith    Input Arguments:
6195fce210SBarry Smith .  sf - star forest
6295fce210SBarry Smith 
6395fce210SBarry Smith    Level: advanced
6495fce210SBarry Smith 
6595fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph(), PetscSFDestroy()
6695fce210SBarry Smith @*/
6795fce210SBarry Smith PetscErrorCode PetscSFReset(PetscSF sf)
6895fce210SBarry Smith {
6995fce210SBarry Smith   PetscErrorCode ierr;
7095fce210SBarry Smith 
7195fce210SBarry Smith   PetscFunctionBegin;
7295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
7379715d56SJed Brown   if (sf->ops->Reset) {ierr = (*sf->ops->Reset)(sf);CHKERRQ(ierr);}
7429046d53SLisandro Dalcin   sf->nroots   = -1;
7529046d53SLisandro Dalcin   sf->nleaves  = -1;
7629046d53SLisandro Dalcin   sf->minleaf  = PETSC_MAX_INT;
7729046d53SLisandro Dalcin   sf->maxleaf  = PETSC_MIN_INT;
7895fce210SBarry Smith   sf->mine     = NULL;
7995fce210SBarry Smith   sf->remote   = NULL;
8029046d53SLisandro Dalcin   sf->graphset = PETSC_FALSE;
8129046d53SLisandro Dalcin   ierr = PetscFree(sf->mine_alloc);CHKERRQ(ierr);
8295fce210SBarry Smith   ierr = PetscFree(sf->remote_alloc);CHKERRQ(ierr);
8321c688dcSJed Brown   sf->nranks = -1;
8429046d53SLisandro Dalcin   ierr = PetscFree4(sf->ranks,sf->roffset,sf->rmine,sf->rremote);CHKERRQ(ierr);
8529046d53SLisandro Dalcin   sf->degreeknown = PETSC_FALSE;
8695fce210SBarry Smith   ierr = PetscFree(sf->degree);CHKERRQ(ierr);
8795fce210SBarry Smith   if (sf->ingroup  != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->ingroup);CHKERRQ(ierr);}
8895fce210SBarry Smith   if (sf->outgroup != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->outgroup);CHKERRQ(ierr);}
8995fce210SBarry Smith   ierr = PetscSFDestroy(&sf->multi);CHKERRQ(ierr);
9095fce210SBarry Smith   sf->setupcalled = PETSC_FALSE;
9195fce210SBarry Smith   PetscFunctionReturn(0);
9295fce210SBarry Smith }
9395fce210SBarry Smith 
9495fce210SBarry Smith /*@C
9529046d53SLisandro Dalcin    PetscSFSetType - Set the PetscSF communication implementation
9695fce210SBarry Smith 
9795fce210SBarry Smith    Collective on PetscSF
9895fce210SBarry Smith 
9995fce210SBarry Smith    Input Parameters:
10095fce210SBarry Smith +  sf - the PetscSF context
10195fce210SBarry Smith -  type - a known method
10295fce210SBarry Smith 
10395fce210SBarry Smith    Options Database Key:
10495fce210SBarry Smith .  -sf_type <type> - Sets the method; use -help for a list
10595fce210SBarry Smith    of available methods (for instance, window, pt2pt, neighbor)
10695fce210SBarry Smith 
10795fce210SBarry Smith    Notes:
10895fce210SBarry Smith    See "include/petscsf.h" for available methods (for instance)
10995fce210SBarry Smith +    PETSCSFWINDOW - MPI-2/3 one-sided
11095fce210SBarry Smith -    PETSCSFBASIC - basic implementation using MPI-1 two-sided
11195fce210SBarry Smith 
11295fce210SBarry Smith   Level: intermediate
11395fce210SBarry Smith 
11495fce210SBarry Smith .seealso: PetscSFType, PetscSFCreate()
11595fce210SBarry Smith @*/
11695fce210SBarry Smith PetscErrorCode PetscSFSetType(PetscSF sf,PetscSFType type)
11795fce210SBarry Smith {
11895fce210SBarry Smith   PetscErrorCode ierr,(*r)(PetscSF);
11995fce210SBarry Smith   PetscBool      match;
12095fce210SBarry Smith 
12195fce210SBarry Smith   PetscFunctionBegin;
12295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
12395fce210SBarry Smith   PetscValidCharPointer(type,2);
12495fce210SBarry Smith 
12595fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)sf,type,&match);CHKERRQ(ierr);
12695fce210SBarry Smith   if (match) PetscFunctionReturn(0);
12795fce210SBarry Smith 
128adc40e5bSBarry Smith   ierr = PetscFunctionListFind(PetscSFList,type,&r);CHKERRQ(ierr);
12995fce210SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested PetscSF type %s",type);
13029046d53SLisandro Dalcin   /* Destroy the previous PetscSF implementation context */
13129046d53SLisandro Dalcin   if (sf->ops->Destroy) {ierr = (*(sf)->ops->Destroy)(sf);CHKERRQ(ierr);}
13295fce210SBarry Smith   ierr = PetscMemzero(sf->ops,sizeof(*sf->ops));CHKERRQ(ierr);
13395fce210SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)sf,type);CHKERRQ(ierr);
13495fce210SBarry Smith   ierr = (*r)(sf);CHKERRQ(ierr);
13595fce210SBarry Smith   PetscFunctionReturn(0);
13695fce210SBarry Smith }
13795fce210SBarry Smith 
13829046d53SLisandro Dalcin /*@C
13929046d53SLisandro Dalcin   PetscSFGetType - Get the PetscSF communication implementation
14029046d53SLisandro Dalcin 
14129046d53SLisandro Dalcin   Not Collective
14229046d53SLisandro Dalcin 
14329046d53SLisandro Dalcin   Input Parameter:
14429046d53SLisandro Dalcin . sf  - the PetscSF context
14529046d53SLisandro Dalcin 
14629046d53SLisandro Dalcin   Output Parameter:
14729046d53SLisandro Dalcin . type - the PetscSF type name
14829046d53SLisandro Dalcin 
14929046d53SLisandro Dalcin   Level: intermediate
15029046d53SLisandro Dalcin 
15129046d53SLisandro Dalcin .seealso: PetscSFSetType(), PetscSFCreate()
15229046d53SLisandro Dalcin @*/
15329046d53SLisandro Dalcin PetscErrorCode PetscSFGetType(PetscSF sf, PetscSFType *type)
15429046d53SLisandro Dalcin {
15529046d53SLisandro Dalcin   PetscFunctionBegin;
15629046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID,1);
15729046d53SLisandro Dalcin   PetscValidPointer(type,2);
15829046d53SLisandro Dalcin   *type = ((PetscObject)sf)->type_name;
15929046d53SLisandro Dalcin   PetscFunctionReturn(0);
16029046d53SLisandro Dalcin }
16129046d53SLisandro Dalcin 
162d36d33e4SMatthew G. Knepley /*@
16395fce210SBarry Smith    PetscSFDestroy - destroy star forest
16495fce210SBarry Smith 
16595fce210SBarry Smith    Collective
16695fce210SBarry Smith 
16795fce210SBarry Smith    Input Arguments:
16895fce210SBarry Smith .  sf - address of star forest
16995fce210SBarry Smith 
17095fce210SBarry Smith    Level: intermediate
17195fce210SBarry Smith 
17295fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFReset()
17395fce210SBarry Smith @*/
17495fce210SBarry Smith PetscErrorCode PetscSFDestroy(PetscSF *sf)
17595fce210SBarry Smith {
17695fce210SBarry Smith   PetscErrorCode ierr;
17795fce210SBarry Smith 
17895fce210SBarry Smith   PetscFunctionBegin;
17995fce210SBarry Smith   if (!*sf) PetscFunctionReturn(0);
18095fce210SBarry Smith   PetscValidHeaderSpecific((*sf),PETSCSF_CLASSID,1);
18129046d53SLisandro Dalcin   if (--((PetscObject)(*sf))->refct > 0) {*sf = NULL; PetscFunctionReturn(0);}
18295fce210SBarry Smith   ierr = PetscSFReset(*sf);CHKERRQ(ierr);
18395fce210SBarry Smith   if ((*sf)->ops->Destroy) {ierr = (*(*sf)->ops->Destroy)(*sf);CHKERRQ(ierr);}
18495fce210SBarry Smith   ierr = PetscHeaderDestroy(sf);CHKERRQ(ierr);
18595fce210SBarry Smith   PetscFunctionReturn(0);
18695fce210SBarry Smith }
18795fce210SBarry Smith 
18895fce210SBarry Smith /*@
18995fce210SBarry Smith    PetscSFSetUp - set up communication structures
19095fce210SBarry Smith 
19195fce210SBarry Smith    Collective
19295fce210SBarry Smith 
19395fce210SBarry Smith    Input Arguments:
19495fce210SBarry Smith .  sf - star forest communication object
19595fce210SBarry Smith 
19695fce210SBarry Smith    Level: beginner
19795fce210SBarry Smith 
19895fce210SBarry Smith .seealso: PetscSFSetFromOptions(), PetscSFSetType()
19995fce210SBarry Smith @*/
20095fce210SBarry Smith PetscErrorCode PetscSFSetUp(PetscSF sf)
20195fce210SBarry Smith {
20295fce210SBarry Smith   PetscErrorCode ierr;
20395fce210SBarry Smith 
20495fce210SBarry Smith   PetscFunctionBegin;
20529046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
20629046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
20795fce210SBarry Smith   if (sf->setupcalled) PetscFunctionReturn(0);
20895fce210SBarry Smith   if (!((PetscObject)sf)->type_name) {ierr = PetscSFSetType(sf,PETSCSFBASIC);CHKERRQ(ierr);}
20929046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr);
21095fce210SBarry Smith   if (sf->ops->SetUp) {ierr = (*sf->ops->SetUp)(sf);CHKERRQ(ierr);}
21129046d53SLisandro Dalcin   ierr = PetscLogEventEnd(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr);
21295fce210SBarry Smith   sf->setupcalled = PETSC_TRUE;
21395fce210SBarry Smith   PetscFunctionReturn(0);
21495fce210SBarry Smith }
21595fce210SBarry Smith 
2168af6ec1cSBarry Smith /*@
21795fce210SBarry Smith    PetscSFSetFromOptions - set PetscSF options using the options database
21895fce210SBarry Smith 
21995fce210SBarry Smith    Logically Collective
22095fce210SBarry Smith 
22195fce210SBarry Smith    Input Arguments:
22295fce210SBarry Smith .  sf - star forest
22395fce210SBarry Smith 
22495fce210SBarry Smith    Options Database Keys:
22560263706SJed Brown +  -sf_type - implementation type, see PetscSFSetType()
22660263706SJed Brown -  -sf_rank_order - sort composite points for gathers and scatters in rank order, gathers are non-deterministic otherwise
22795fce210SBarry Smith 
22895fce210SBarry Smith    Level: intermediate
22995fce210SBarry Smith 
23095fce210SBarry Smith .seealso: PetscSFWindowSetSyncType()
23195fce210SBarry Smith @*/
23295fce210SBarry Smith PetscErrorCode PetscSFSetFromOptions(PetscSF sf)
23395fce210SBarry Smith {
23495fce210SBarry Smith   PetscSFType    deft;
23595fce210SBarry Smith   char           type[256];
23695fce210SBarry Smith   PetscErrorCode ierr;
23795fce210SBarry Smith   PetscBool      flg;
23895fce210SBarry Smith 
23995fce210SBarry Smith   PetscFunctionBegin;
24095fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
24195fce210SBarry Smith   ierr = PetscObjectOptionsBegin((PetscObject)sf);CHKERRQ(ierr);
24295fce210SBarry Smith   deft = ((PetscObject)sf)->type_name ? ((PetscObject)sf)->type_name : PETSCSFBASIC;
24329046d53SLisandro Dalcin   ierr = PetscOptionsFList("-sf_type","PetscSF implementation type","PetscSFSetType",PetscSFList,deft,type,sizeof(type),&flg);CHKERRQ(ierr);
24495fce210SBarry Smith   ierr = PetscSFSetType(sf,flg ? type : deft);CHKERRQ(ierr);
24595fce210SBarry 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);
246e55864a3SBarry Smith   if (sf->ops->SetFromOptions) {ierr = (*sf->ops->SetFromOptions)(PetscOptionsObject,sf);CHKERRQ(ierr);}
24795fce210SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
24895fce210SBarry Smith   PetscFunctionReturn(0);
24995fce210SBarry Smith }
25095fce210SBarry Smith 
25129046d53SLisandro Dalcin /*@
25295fce210SBarry Smith    PetscSFSetRankOrder - sort multi-points for gathers and scatters by rank order
25395fce210SBarry Smith 
25495fce210SBarry Smith    Logically Collective
25595fce210SBarry Smith 
25695fce210SBarry Smith    Input Arguments:
25795fce210SBarry Smith +  sf - star forest
25895fce210SBarry Smith -  flg - PETSC_TRUE to sort, PETSC_FALSE to skip sorting (lower setup cost, but non-deterministic)
25995fce210SBarry Smith 
26095fce210SBarry Smith    Level: advanced
26195fce210SBarry Smith 
26295fce210SBarry Smith .seealso: PetscSFGatherBegin(), PetscSFScatterBegin()
26395fce210SBarry Smith @*/
26495fce210SBarry Smith PetscErrorCode PetscSFSetRankOrder(PetscSF sf,PetscBool flg)
26595fce210SBarry Smith {
26695fce210SBarry Smith 
26795fce210SBarry Smith   PetscFunctionBegin;
26895fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
26995fce210SBarry Smith   PetscValidLogicalCollectiveBool(sf,flg,2);
27095fce210SBarry Smith   if (sf->multi) SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_WRONGSTATE,"Rank ordering must be set before first call to PetscSFGatherBegin() or PetscSFScatterBegin()");
27195fce210SBarry Smith   sf->rankorder = flg;
27295fce210SBarry Smith   PetscFunctionReturn(0);
27395fce210SBarry Smith }
27495fce210SBarry Smith 
2758af6ec1cSBarry Smith /*@
27695fce210SBarry Smith    PetscSFSetGraph - Set a parallel star forest
27795fce210SBarry Smith 
27895fce210SBarry Smith    Collective
27995fce210SBarry Smith 
28095fce210SBarry Smith    Input Arguments:
28195fce210SBarry Smith +  sf - star forest
28295fce210SBarry Smith .  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
28395fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
28495fce210SBarry Smith .  ilocal - locations of leaves in leafdata buffers, pass NULL for contiguous storage
28595fce210SBarry Smith .  localmode - copy mode for ilocal
28695fce210SBarry Smith .  iremote - remote locations of root vertices for each leaf on the current process
28795fce210SBarry Smith -  remotemode - copy mode for iremote
28895fce210SBarry Smith 
28995fce210SBarry Smith    Level: intermediate
29095fce210SBarry Smith 
29195452b02SPatrick Sanan    Notes:
29295452b02SPatrick Sanan     In Fortran you must use PETSC_COPY_VALUES for localmode and remotemode
29338ab3f8aSBarry Smith 
2942ad1e87fSLisandro Dalcin    Developers Note: Local indices which are the identity permutation in the range [0,nleaves) are discarded as they
2952ad1e87fSLisandro Dalcin    encode contiguous storage. In such case, if localmode is PETSC_OWN_POINTER, the memory is deallocated as it is not
2962ad1e87fSLisandro Dalcin    needed
2972ad1e87fSLisandro Dalcin 
29895fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFGetGraph()
29995fce210SBarry Smith @*/
30095fce210SBarry Smith PetscErrorCode PetscSFSetGraph(PetscSF sf,PetscInt nroots,PetscInt nleaves,const PetscInt *ilocal,PetscCopyMode localmode,const PetscSFNode *iremote,PetscCopyMode remotemode)
30195fce210SBarry Smith {
30295fce210SBarry Smith   PetscErrorCode ierr;
30395fce210SBarry Smith 
30495fce210SBarry Smith   PetscFunctionBegin;
30595fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
30629046d53SLisandro Dalcin   if (nleaves > 0 && ilocal) PetscValidIntPointer(ilocal,4);
30729046d53SLisandro Dalcin   if (nleaves > 0) PetscValidPointer(iremote,6);
30829046d53SLisandro Dalcin   if (nroots  < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nroots %D, cannot be negative",nroots);
30995fce210SBarry Smith   if (nleaves < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nleaves %D, cannot be negative",nleaves);
31029046d53SLisandro Dalcin 
31195fce210SBarry Smith   ierr = PetscSFReset(sf);CHKERRQ(ierr);
31229046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
31329046d53SLisandro Dalcin 
31495fce210SBarry Smith   sf->nroots  = nroots;
31595fce210SBarry Smith   sf->nleaves = nleaves;
31629046d53SLisandro Dalcin 
31729046d53SLisandro Dalcin   if (nleaves && ilocal) {
31821c688dcSJed Brown     PetscInt i;
31929046d53SLisandro Dalcin     PetscInt minleaf = PETSC_MAX_INT;
32029046d53SLisandro Dalcin     PetscInt maxleaf = PETSC_MIN_INT;
3212ad1e87fSLisandro Dalcin     int      contiguous = 1;
32229046d53SLisandro Dalcin     for (i=0; i<nleaves; i++) {
32329046d53SLisandro Dalcin       minleaf = PetscMin(minleaf,ilocal[i]);
32429046d53SLisandro Dalcin       maxleaf = PetscMax(maxleaf,ilocal[i]);
3252ad1e87fSLisandro Dalcin       contiguous &= (ilocal[i] == i);
32629046d53SLisandro Dalcin     }
32729046d53SLisandro Dalcin     sf->minleaf = minleaf;
32829046d53SLisandro Dalcin     sf->maxleaf = maxleaf;
3292ad1e87fSLisandro Dalcin     if (contiguous) {
3302ad1e87fSLisandro Dalcin       if (localmode == PETSC_OWN_POINTER) {
3312ad1e87fSLisandro Dalcin         ierr = PetscFree(ilocal);CHKERRQ(ierr);
3322ad1e87fSLisandro Dalcin       }
3332ad1e87fSLisandro Dalcin       ilocal = NULL;
3342ad1e87fSLisandro Dalcin     }
33529046d53SLisandro Dalcin   } else {
33629046d53SLisandro Dalcin     sf->minleaf = 0;
33729046d53SLisandro Dalcin     sf->maxleaf = nleaves - 1;
33829046d53SLisandro Dalcin   }
33929046d53SLisandro Dalcin 
34029046d53SLisandro Dalcin   if (ilocal) {
34195fce210SBarry Smith     switch (localmode) {
34295fce210SBarry Smith     case PETSC_COPY_VALUES:
343785e854fSJed Brown       ierr = PetscMalloc1(nleaves,&sf->mine_alloc);CHKERRQ(ierr);
344580bdb30SBarry Smith       ierr = PetscArraycpy(sf->mine_alloc,ilocal,nleaves);CHKERRQ(ierr);
34595fce210SBarry Smith       sf->mine = sf->mine_alloc;
34695fce210SBarry Smith       break;
34795fce210SBarry Smith     case PETSC_OWN_POINTER:
34895fce210SBarry Smith       sf->mine_alloc = (PetscInt*)ilocal;
34995fce210SBarry Smith       sf->mine       = sf->mine_alloc;
35095fce210SBarry Smith       break;
35195fce210SBarry Smith     case PETSC_USE_POINTER:
35229046d53SLisandro Dalcin       sf->mine_alloc = NULL;
35395fce210SBarry Smith       sf->mine       = (PetscInt*)ilocal;
35495fce210SBarry Smith       break;
35595fce210SBarry Smith     default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown localmode");
35695fce210SBarry Smith     }
35795fce210SBarry Smith   }
35829046d53SLisandro Dalcin 
35995fce210SBarry Smith   switch (remotemode) {
36095fce210SBarry Smith   case PETSC_COPY_VALUES:
361785e854fSJed Brown     ierr = PetscMalloc1(nleaves,&sf->remote_alloc);CHKERRQ(ierr);
362580bdb30SBarry Smith     ierr = PetscArraycpy(sf->remote_alloc,iremote,nleaves);CHKERRQ(ierr);
36395fce210SBarry Smith     sf->remote = sf->remote_alloc;
36495fce210SBarry Smith     break;
36595fce210SBarry Smith   case PETSC_OWN_POINTER:
36695fce210SBarry Smith     sf->remote_alloc = (PetscSFNode*)iremote;
36795fce210SBarry Smith     sf->remote       = sf->remote_alloc;
36895fce210SBarry Smith     break;
36995fce210SBarry Smith   case PETSC_USE_POINTER:
37029046d53SLisandro Dalcin     sf->remote_alloc = NULL;
37195fce210SBarry Smith     sf->remote       = (PetscSFNode*)iremote;
37295fce210SBarry Smith     break;
37395fce210SBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown remotemode");
37495fce210SBarry Smith   }
37595fce210SBarry Smith 
376563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
37729046d53SLisandro Dalcin   sf->graphset = PETSC_TRUE;
37895fce210SBarry Smith   PetscFunctionReturn(0);
37995fce210SBarry Smith }
38095fce210SBarry Smith 
38129046d53SLisandro Dalcin /*@
38295fce210SBarry Smith    PetscSFCreateInverseSF - given a PetscSF in which all vertices have degree 1, creates the inverse map
38395fce210SBarry Smith 
38495fce210SBarry Smith    Collective
38595fce210SBarry Smith 
38695fce210SBarry Smith    Input Arguments:
38795fce210SBarry Smith .  sf - star forest to invert
38895fce210SBarry Smith 
38995fce210SBarry Smith    Output Arguments:
39095fce210SBarry Smith .  isf - inverse of sf
39195fce210SBarry Smith 
39295fce210SBarry Smith    Level: advanced
39395fce210SBarry Smith 
39495fce210SBarry Smith    Notes:
39595fce210SBarry Smith    All roots must have degree 1.
39695fce210SBarry Smith 
39795fce210SBarry Smith    The local space may be a permutation, but cannot be sparse.
39895fce210SBarry Smith 
39995fce210SBarry Smith .seealso: PetscSFSetGraph()
40095fce210SBarry Smith @*/
40195fce210SBarry Smith PetscErrorCode PetscSFCreateInverseSF(PetscSF sf,PetscSF *isf)
40295fce210SBarry Smith {
40395fce210SBarry Smith   PetscErrorCode ierr;
40495fce210SBarry Smith   PetscMPIInt    rank;
40595fce210SBarry Smith   PetscInt       i,nroots,nleaves,maxlocal,count,*newilocal;
40695fce210SBarry Smith   const PetscInt *ilocal;
40795fce210SBarry Smith   PetscSFNode    *roots,*leaves;
40895fce210SBarry Smith 
40995fce210SBarry Smith   PetscFunctionBegin;
41029046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
41129046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
41229046d53SLisandro Dalcin   PetscValidPointer(isf,2);
41329046d53SLisandro Dalcin 
41495fce210SBarry Smith   ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
41529046d53SLisandro Dalcin   maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
41629046d53SLisandro Dalcin 
41729046d53SLisandro Dalcin   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
418ae9aee6dSMatthew G. Knepley   ierr = PetscMalloc2(nroots,&roots,maxlocal,&leaves);CHKERRQ(ierr);
419ae9aee6dSMatthew G. Knepley   for (i=0; i<maxlocal; i++) {
42095fce210SBarry Smith     leaves[i].rank  = rank;
42195fce210SBarry Smith     leaves[i].index = i;
42295fce210SBarry Smith   }
42395fce210SBarry Smith   for (i=0; i <nroots; i++) {
42495fce210SBarry Smith     roots[i].rank  = -1;
42595fce210SBarry Smith     roots[i].index = -1;
42695fce210SBarry Smith   }
4278bfbc91cSJed Brown   ierr = PetscSFReduceBegin(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr);
4288bfbc91cSJed Brown   ierr = PetscSFReduceEnd(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr);
42995fce210SBarry Smith 
43095fce210SBarry Smith   /* Check whether our leaves are sparse */
43195fce210SBarry Smith   for (i=0,count=0; i<nroots; i++) if (roots[i].rank >= 0) count++;
43295fce210SBarry Smith   if (count == nroots) newilocal = NULL;
43395fce210SBarry Smith   else {                        /* Index for sparse leaves and compact "roots" array (which is to become our leaves). */
434785e854fSJed Brown     ierr = PetscMalloc1(count,&newilocal);CHKERRQ(ierr);
43595fce210SBarry Smith     for (i=0,count=0; i<nroots; i++) {
43695fce210SBarry Smith       if (roots[i].rank >= 0) {
43795fce210SBarry Smith         newilocal[count]   = i;
43895fce210SBarry Smith         roots[count].rank  = roots[i].rank;
43995fce210SBarry Smith         roots[count].index = roots[i].index;
44095fce210SBarry Smith         count++;
44195fce210SBarry Smith       }
44295fce210SBarry Smith     }
44395fce210SBarry Smith   }
44495fce210SBarry Smith 
44595fce210SBarry Smith   ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,isf);CHKERRQ(ierr);
44695fce210SBarry Smith   ierr = PetscSFSetGraph(*isf,maxlocal,count,newilocal,PETSC_OWN_POINTER,roots,PETSC_COPY_VALUES);CHKERRQ(ierr);
44795fce210SBarry Smith   ierr = PetscFree2(roots,leaves);CHKERRQ(ierr);
44895fce210SBarry Smith   PetscFunctionReturn(0);
44995fce210SBarry Smith }
45095fce210SBarry Smith 
45195fce210SBarry Smith /*@
45295fce210SBarry Smith    PetscSFDuplicate - duplicate a PetscSF, optionally preserving rank connectivity and graph
45395fce210SBarry Smith 
45495fce210SBarry Smith    Collective
45595fce210SBarry Smith 
45695fce210SBarry Smith    Input Arguments:
45795fce210SBarry Smith +  sf - communication object to duplicate
45895fce210SBarry Smith -  opt - PETSCSF_DUPLICATE_CONFONLY, PETSCSF_DUPLICATE_RANKS, or PETSCSF_DUPLICATE_GRAPH (see PetscSFDuplicateOption)
45995fce210SBarry Smith 
46095fce210SBarry Smith    Output Arguments:
46195fce210SBarry Smith .  newsf - new communication object
46295fce210SBarry Smith 
46395fce210SBarry Smith    Level: beginner
46495fce210SBarry Smith 
46595fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetType(), PetscSFSetGraph()
46695fce210SBarry Smith @*/
46795fce210SBarry Smith PetscErrorCode PetscSFDuplicate(PetscSF sf,PetscSFDuplicateOption opt,PetscSF *newsf)
46895fce210SBarry Smith {
46929046d53SLisandro Dalcin   PetscSFType    type;
47095fce210SBarry Smith   PetscErrorCode ierr;
47195fce210SBarry Smith 
47295fce210SBarry Smith   PetscFunctionBegin;
47329046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
47429046d53SLisandro Dalcin   PetscValidLogicalCollectiveEnum(sf,opt,2);
47529046d53SLisandro Dalcin   PetscValidPointer(newsf,3);
47695fce210SBarry Smith   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sf),newsf);CHKERRQ(ierr);
47729046d53SLisandro Dalcin   ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
47829046d53SLisandro Dalcin   if (type) {ierr = PetscSFSetType(*newsf,type);CHKERRQ(ierr);}
47995fce210SBarry Smith   if (opt == PETSCSF_DUPLICATE_GRAPH) {
48095fce210SBarry Smith     PetscInt          nroots,nleaves;
48195fce210SBarry Smith     const PetscInt    *ilocal;
48295fce210SBarry Smith     const PetscSFNode *iremote;
48329046d53SLisandro Dalcin     PetscSFCheckGraphSet(sf,1);
48495fce210SBarry Smith     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
48595fce210SBarry Smith     ierr = PetscSFSetGraph(*newsf,nroots,nleaves,ilocal,PETSC_COPY_VALUES,iremote,PETSC_COPY_VALUES);CHKERRQ(ierr);
48695fce210SBarry Smith   }
48729046d53SLisandro Dalcin   if (sf->ops->Duplicate) {ierr = (*sf->ops->Duplicate)(sf,opt,*newsf);CHKERRQ(ierr);}
48895fce210SBarry Smith   PetscFunctionReturn(0);
48995fce210SBarry Smith }
49095fce210SBarry Smith 
49195fce210SBarry Smith /*@C
49295fce210SBarry Smith    PetscSFGetGraph - Get the graph specifying a parallel star forest
49395fce210SBarry Smith 
49495fce210SBarry Smith    Not Collective
49595fce210SBarry Smith 
49695fce210SBarry Smith    Input Arguments:
49795fce210SBarry Smith .  sf - star forest
49895fce210SBarry Smith 
49995fce210SBarry Smith    Output Arguments:
50095fce210SBarry Smith +  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
50195fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
50295fce210SBarry Smith .  ilocal - locations of leaves in leafdata buffers
50395fce210SBarry Smith -  iremote - remote locations of root vertices for each leaf on the current process
50495fce210SBarry Smith 
505373e0d91SLisandro Dalcin    Notes:
506373e0d91SLisandro Dalcin    We are not currently requiring that the graph is set, thus returning nroots=-1 if it has not been set yet
507373e0d91SLisandro Dalcin 
50895fce210SBarry Smith    Level: intermediate
50995fce210SBarry Smith 
51095fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph()
51195fce210SBarry Smith @*/
51295fce210SBarry Smith PetscErrorCode PetscSFGetGraph(PetscSF sf,PetscInt *nroots,PetscInt *nleaves,const PetscInt **ilocal,const PetscSFNode **iremote)
51395fce210SBarry Smith {
514*b8dee149SJunchao Zhang   PetscErrorCode ierr;
51595fce210SBarry Smith 
51695fce210SBarry Smith   PetscFunctionBegin;
51795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
518*b8dee149SJunchao Zhang   if (sf->ops->GetGraph) {
519*b8dee149SJunchao Zhang     ierr = (sf->ops->GetGraph)(sf,nroots,nleaves,ilocal,iremote);CHKERRQ(ierr);
520*b8dee149SJunchao Zhang   } else {
52195fce210SBarry Smith     if (nroots) *nroots = sf->nroots;
52295fce210SBarry Smith     if (nleaves) *nleaves = sf->nleaves;
52395fce210SBarry Smith     if (ilocal) *ilocal = sf->mine;
52495fce210SBarry Smith     if (iremote) *iremote = sf->remote;
525*b8dee149SJunchao Zhang   }
52695fce210SBarry Smith   PetscFunctionReturn(0);
52795fce210SBarry Smith }
52895fce210SBarry Smith 
52929046d53SLisandro Dalcin /*@
53095fce210SBarry Smith    PetscSFGetLeafRange - Get the active leaf ranges
53195fce210SBarry Smith 
53295fce210SBarry Smith    Not Collective
53395fce210SBarry Smith 
53495fce210SBarry Smith    Input Arguments:
53595fce210SBarry Smith .  sf - star forest
53695fce210SBarry Smith 
53795fce210SBarry Smith    Output Arguments:
53895fce210SBarry Smith +  minleaf - minimum active leaf on this process
53995fce210SBarry Smith -  maxleaf - maximum active leaf on this process
54095fce210SBarry Smith 
54195fce210SBarry Smith    Level: developer
54295fce210SBarry Smith 
54395fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph(), PetscSFGetGraph()
54495fce210SBarry Smith @*/
54595fce210SBarry Smith PetscErrorCode PetscSFGetLeafRange(PetscSF sf,PetscInt *minleaf,PetscInt *maxleaf)
54695fce210SBarry Smith {
54795fce210SBarry Smith 
54895fce210SBarry Smith   PetscFunctionBegin;
54995fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
55029046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
55195fce210SBarry Smith   if (minleaf) *minleaf = sf->minleaf;
55295fce210SBarry Smith   if (maxleaf) *maxleaf = sf->maxleaf;
55395fce210SBarry Smith   PetscFunctionReturn(0);
55495fce210SBarry Smith }
55595fce210SBarry Smith 
55695fce210SBarry Smith /*@C
55795fce210SBarry Smith    PetscSFView - view a star forest
55895fce210SBarry Smith 
55995fce210SBarry Smith    Collective
56095fce210SBarry Smith 
56195fce210SBarry Smith    Input Arguments:
56295fce210SBarry Smith +  sf - star forest
56395fce210SBarry Smith -  viewer - viewer to display graph, for example PETSC_VIEWER_STDOUT_WORLD
56495fce210SBarry Smith 
56595fce210SBarry Smith    Level: beginner
56695fce210SBarry Smith 
56795fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph()
56895fce210SBarry Smith @*/
56995fce210SBarry Smith PetscErrorCode PetscSFView(PetscSF sf,PetscViewer viewer)
57095fce210SBarry Smith {
57195fce210SBarry Smith   PetscErrorCode    ierr;
57295fce210SBarry Smith   PetscBool         iascii;
57395fce210SBarry Smith   PetscViewerFormat format;
57495fce210SBarry Smith 
57595fce210SBarry Smith   PetscFunctionBegin;
57695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
57795fce210SBarry Smith   if (!viewer) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sf),&viewer);CHKERRQ(ierr);}
57895fce210SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
57995fce210SBarry Smith   PetscCheckSameComm(sf,1,viewer,2);
58080153354SVaclav Hapla   if (sf->graphset) {ierr = PetscSFSetUp(sf);CHKERRQ(ierr);}
58195fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
58295fce210SBarry Smith   if (iascii) {
58395fce210SBarry Smith     PetscMPIInt rank;
58481bfa7aaSJed Brown     PetscInt    ii,i,j;
58595fce210SBarry Smith 
586dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)sf,viewer);CHKERRQ(ierr);
58795fce210SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
58895fce210SBarry Smith     if (sf->ops->View) {ierr = (*sf->ops->View)(sf,viewer);CHKERRQ(ierr);}
58980153354SVaclav Hapla     if (!sf->graphset) {
59080153354SVaclav Hapla       ierr = PetscViewerASCIIPrintf(viewer,"PetscSFSetGraph() has not been called yet\n");CHKERRQ(ierr);
59180153354SVaclav Hapla       ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
59280153354SVaclav Hapla       PetscFunctionReturn(0);
59380153354SVaclav Hapla     }
59495fce210SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
5951575c14dSBarry Smith     ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
59695fce210SBarry Smith     ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Number of roots=%D, leaves=%D, remote ranks=%D\n",rank,sf->nroots,sf->nleaves,sf->nranks);CHKERRQ(ierr);
59795fce210SBarry Smith     for (i=0; i<sf->nleaves; i++) {
59895fce210SBarry 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);
59995fce210SBarry Smith     }
60095fce210SBarry Smith     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
60195fce210SBarry Smith     ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
60295fce210SBarry Smith     if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
60381bfa7aaSJed Brown       PetscMPIInt *tmpranks,*perm;
60481bfa7aaSJed Brown       ierr = PetscMalloc2(sf->nranks,&tmpranks,sf->nranks,&perm);CHKERRQ(ierr);
605580bdb30SBarry Smith       ierr = PetscArraycpy(tmpranks,sf->ranks,sf->nranks);CHKERRQ(ierr);
60681bfa7aaSJed Brown       for (i=0; i<sf->nranks; i++) perm[i] = i;
60781bfa7aaSJed Brown       ierr = PetscSortMPIIntWithArray(sf->nranks,tmpranks,perm);CHKERRQ(ierr);
60895fce210SBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Roots referenced by my leaves, by rank\n",rank);CHKERRQ(ierr);
60981bfa7aaSJed Brown       for (ii=0; ii<sf->nranks; ii++) {
61081bfa7aaSJed Brown         i = perm[ii];
6117904a332SBarry Smith         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %d: %D edges\n",rank,sf->ranks[i],sf->roffset[i+1]-sf->roffset[i]);CHKERRQ(ierr);
61295fce210SBarry Smith         for (j=sf->roffset[i]; j<sf->roffset[i+1]; j++) {
61395fce210SBarry Smith           ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d]    %D <- %D\n",rank,sf->rmine[j],sf->rremote[j]);CHKERRQ(ierr);
61495fce210SBarry Smith         }
61595fce210SBarry Smith       }
61681bfa7aaSJed Brown       ierr = PetscFree2(tmpranks,perm);CHKERRQ(ierr);
61795fce210SBarry Smith     }
61895fce210SBarry Smith     ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
6191575c14dSBarry Smith     ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
62095fce210SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
62195fce210SBarry Smith   }
62295fce210SBarry Smith   PetscFunctionReturn(0);
62395fce210SBarry Smith }
62495fce210SBarry Smith 
62595fce210SBarry Smith /*@C
626dec1416fSJunchao Zhang    PetscSFGetRootRanks - Get root ranks and number of vertices referenced by leaves on this process
62795fce210SBarry Smith 
62895fce210SBarry Smith    Not Collective
62995fce210SBarry Smith 
63095fce210SBarry Smith    Input Arguments:
63195fce210SBarry Smith .  sf - star forest
63295fce210SBarry Smith 
63395fce210SBarry Smith    Output Arguments:
63495fce210SBarry Smith +  nranks - number of ranks referenced by local part
63595fce210SBarry Smith .  ranks - array of ranks
63695fce210SBarry Smith .  roffset - offset in rmine/rremote for each rank (length nranks+1)
63795fce210SBarry Smith .  rmine - concatenated array holding local indices referencing each remote rank
63895fce210SBarry Smith -  rremote - concatenated array holding remote indices referenced for each remote rank
63995fce210SBarry Smith 
64095fce210SBarry Smith    Level: developer
64195fce210SBarry Smith 
642dec1416fSJunchao Zhang .seealso: PetscSFGetLeafRanks()
64395fce210SBarry Smith @*/
644dec1416fSJunchao Zhang PetscErrorCode PetscSFGetRootRanks(PetscSF sf,PetscInt *nranks,const PetscMPIInt **ranks,const PetscInt **roffset,const PetscInt **rmine,const PetscInt **rremote)
64595fce210SBarry Smith {
646dec1416fSJunchao Zhang   PetscErrorCode ierr;
64795fce210SBarry Smith 
64895fce210SBarry Smith   PetscFunctionBegin;
64995fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
65029046d53SLisandro Dalcin   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
651dec1416fSJunchao Zhang   if (sf->ops->GetRootRanks) {
652dec1416fSJunchao Zhang     ierr = (sf->ops->GetRootRanks)(sf,nranks,ranks,roffset,rmine,rremote);CHKERRQ(ierr);
653dec1416fSJunchao Zhang   } else {
654dec1416fSJunchao Zhang     /* The generic implementation */
65595fce210SBarry Smith     if (nranks)  *nranks  = sf->nranks;
65695fce210SBarry Smith     if (ranks)   *ranks   = sf->ranks;
65795fce210SBarry Smith     if (roffset) *roffset = sf->roffset;
65895fce210SBarry Smith     if (rmine)   *rmine   = sf->rmine;
65995fce210SBarry Smith     if (rremote) *rremote = sf->rremote;
660dec1416fSJunchao Zhang   }
66195fce210SBarry Smith   PetscFunctionReturn(0);
66295fce210SBarry Smith }
66395fce210SBarry Smith 
6648750ddebSJunchao Zhang /*@C
6658750ddebSJunchao Zhang    PetscSFGetLeafRanks - Get leaf ranks referencing roots on this process
6668750ddebSJunchao Zhang 
6678750ddebSJunchao Zhang    Not Collective
6688750ddebSJunchao Zhang 
6698750ddebSJunchao Zhang    Input Arguments:
6708750ddebSJunchao Zhang .  sf - star forest
6718750ddebSJunchao Zhang 
6728750ddebSJunchao Zhang    Output Arguments:
6738750ddebSJunchao Zhang +  niranks - number of leaf ranks referencing roots on this process
6748750ddebSJunchao Zhang .  iranks - array of ranks
6758750ddebSJunchao Zhang .  ioffset - offset in irootloc for each rank (length niranks+1)
6768750ddebSJunchao Zhang -  irootloc - concatenated array holding local indices of roots referenced by each leaf rank
6778750ddebSJunchao Zhang 
6788750ddebSJunchao Zhang    Level: developer
6798750ddebSJunchao Zhang 
680dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
6818750ddebSJunchao Zhang @*/
6828750ddebSJunchao Zhang PetscErrorCode PetscSFGetLeafRanks(PetscSF sf,PetscInt *niranks,const PetscMPIInt **iranks,const PetscInt **ioffset,const PetscInt **irootloc)
6838750ddebSJunchao Zhang {
6848750ddebSJunchao Zhang   PetscErrorCode ierr;
6858750ddebSJunchao Zhang 
6868750ddebSJunchao Zhang   PetscFunctionBegin;
6878750ddebSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
6888750ddebSJunchao Zhang   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
6898750ddebSJunchao Zhang   if (sf->ops->GetLeafRanks) {
6908750ddebSJunchao Zhang     ierr = (sf->ops->GetLeafRanks)(sf,niranks,iranks,ioffset,irootloc);CHKERRQ(ierr);
6918750ddebSJunchao Zhang   } else {
6928750ddebSJunchao Zhang     PetscSFType type;
6938750ddebSJunchao Zhang     ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
6948750ddebSJunchao Zhang     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFGetLeafRanks() is not supported on this StarForest type: %s", type);
6958750ddebSJunchao Zhang   }
6968750ddebSJunchao Zhang   PetscFunctionReturn(0);
6978750ddebSJunchao Zhang }
6988750ddebSJunchao Zhang 
699b5a8e515SJed Brown static PetscBool InList(PetscMPIInt needle,PetscMPIInt n,const PetscMPIInt *list) {
700b5a8e515SJed Brown   PetscInt i;
701b5a8e515SJed Brown   for (i=0; i<n; i++) {
702b5a8e515SJed Brown     if (needle == list[i]) return PETSC_TRUE;
703b5a8e515SJed Brown   }
704b5a8e515SJed Brown   return PETSC_FALSE;
705b5a8e515SJed Brown }
706b5a8e515SJed Brown 
70795fce210SBarry Smith /*@C
70821c688dcSJed Brown    PetscSFSetUpRanks - Set up data structures associated with ranks; this is for internal use by PetscSF implementations.
70921c688dcSJed Brown 
71021c688dcSJed Brown    Collective
71121c688dcSJed Brown 
71221c688dcSJed Brown    Input Arguments:
713b5a8e515SJed Brown +  sf - PetscSF to set up; PetscSFSetGraph() must have been called
714b5a8e515SJed Brown -  dgroup - MPI_Group of ranks to be distinguished (e.g., for self or shared memory exchange)
71521c688dcSJed Brown 
71621c688dcSJed Brown    Level: developer
71721c688dcSJed Brown 
718dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
71921c688dcSJed Brown @*/
720b5a8e515SJed Brown PetscErrorCode PetscSFSetUpRanks(PetscSF sf,MPI_Group dgroup)
72121c688dcSJed Brown {
72221c688dcSJed Brown   PetscErrorCode     ierr;
72321c688dcSJed Brown   PetscTable         table;
72421c688dcSJed Brown   PetscTablePosition pos;
725b5a8e515SJed Brown   PetscMPIInt        size,groupsize,*groupranks;
726247e8311SStefano Zampini   PetscInt           *rcount,*ranks;
727247e8311SStefano Zampini   PetscInt           i, irank = -1,orank = -1;
72821c688dcSJed Brown 
72921c688dcSJed Brown   PetscFunctionBegin;
73021c688dcSJed Brown   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
73129046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
73221c688dcSJed Brown   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRQ(ierr);
73321c688dcSJed Brown   ierr = PetscTableCreate(10,size,&table);CHKERRQ(ierr);
73421c688dcSJed Brown   for (i=0; i<sf->nleaves; i++) {
73521c688dcSJed Brown     /* Log 1-based rank */
73621c688dcSJed Brown     ierr = PetscTableAdd(table,sf->remote[i].rank+1,1,ADD_VALUES);CHKERRQ(ierr);
73721c688dcSJed Brown   }
73821c688dcSJed Brown   ierr = PetscTableGetCount(table,&sf->nranks);CHKERRQ(ierr);
73921c688dcSJed Brown   ierr = PetscMalloc4(sf->nranks,&sf->ranks,sf->nranks+1,&sf->roffset,sf->nleaves,&sf->rmine,sf->nleaves,&sf->rremote);CHKERRQ(ierr);
74021c688dcSJed Brown   ierr = PetscMalloc2(sf->nranks,&rcount,sf->nranks,&ranks);CHKERRQ(ierr);
74121c688dcSJed Brown   ierr = PetscTableGetHeadPosition(table,&pos);CHKERRQ(ierr);
74221c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
74321c688dcSJed Brown     ierr = PetscTableGetNext(table,&pos,&ranks[i],&rcount[i]);CHKERRQ(ierr);
74421c688dcSJed Brown     ranks[i]--;             /* Convert back to 0-based */
74521c688dcSJed Brown   }
74621c688dcSJed Brown   ierr = PetscTableDestroy(&table);CHKERRQ(ierr);
747b5a8e515SJed Brown 
748b5a8e515SJed Brown   /* We expect that dgroup is reliably "small" while nranks could be large */
749b5a8e515SJed Brown   {
7507fb8a5e4SKarl Rupp     MPI_Group group = MPI_GROUP_NULL;
751b5a8e515SJed Brown     PetscMPIInt *dgroupranks;
752b5a8e515SJed Brown     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
753b5a8e515SJed Brown     ierr = MPI_Group_size(dgroup,&groupsize);CHKERRQ(ierr);
754b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&dgroupranks);CHKERRQ(ierr);
755b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&groupranks);CHKERRQ(ierr);
756b5a8e515SJed Brown     for (i=0; i<groupsize; i++) dgroupranks[i] = i;
757f3fc9a17SJed Brown     if (groupsize) {ierr = MPI_Group_translate_ranks(dgroup,groupsize,dgroupranks,group,groupranks);CHKERRQ(ierr);}
758b5a8e515SJed Brown     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
759b5a8e515SJed Brown     ierr = PetscFree(dgroupranks);CHKERRQ(ierr);
760b5a8e515SJed Brown   }
761b5a8e515SJed Brown 
762b5a8e515SJed Brown   /* Partition ranks[] into distinguished (first sf->ndranks) followed by non-distinguished */
763b5a8e515SJed Brown   for (sf->ndranks=0,i=sf->nranks; sf->ndranks<i; ) {
764b5a8e515SJed Brown     for (i--; sf->ndranks<i; i--) { /* Scan i backward looking for distinguished rank */
765b5a8e515SJed Brown       if (InList(ranks[i],groupsize,groupranks)) break;
766b5a8e515SJed Brown     }
767b5a8e515SJed Brown     for ( ; sf->ndranks<=i; sf->ndranks++) { /* Scan sf->ndranks forward looking for non-distinguished rank */
768b5a8e515SJed Brown       if (!InList(ranks[sf->ndranks],groupsize,groupranks)) break;
769b5a8e515SJed Brown     }
770b5a8e515SJed Brown     if (sf->ndranks < i) {                         /* Swap ranks[sf->ndranks] with ranks[i] */
771b5a8e515SJed Brown       PetscInt    tmprank,tmpcount;
772247e8311SStefano Zampini 
773b5a8e515SJed Brown       tmprank             = ranks[i];
774b5a8e515SJed Brown       tmpcount            = rcount[i];
775b5a8e515SJed Brown       ranks[i]            = ranks[sf->ndranks];
776b5a8e515SJed Brown       rcount[i]           = rcount[sf->ndranks];
777b5a8e515SJed Brown       ranks[sf->ndranks]  = tmprank;
778b5a8e515SJed Brown       rcount[sf->ndranks] = tmpcount;
779b5a8e515SJed Brown       sf->ndranks++;
780b5a8e515SJed Brown     }
781b5a8e515SJed Brown   }
782b5a8e515SJed Brown   ierr = PetscFree(groupranks);CHKERRQ(ierr);
783b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->ndranks,ranks,rcount);CHKERRQ(ierr);
784b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->nranks-sf->ndranks,ranks+sf->ndranks,rcount+sf->ndranks);CHKERRQ(ierr);
78521c688dcSJed Brown   sf->roffset[0] = 0;
78621c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
78721c688dcSJed Brown     ierr = PetscMPIIntCast(ranks[i],sf->ranks+i);CHKERRQ(ierr);
78821c688dcSJed Brown     sf->roffset[i+1] = sf->roffset[i] + rcount[i];
78921c688dcSJed Brown     rcount[i]        = 0;
79021c688dcSJed Brown   }
791247e8311SStefano Zampini   for (i=0, irank = -1, orank = -1; i<sf->nleaves; i++) {
792247e8311SStefano Zampini     /* short circuit */
793247e8311SStefano Zampini     if (orank != sf->remote[i].rank) {
79421c688dcSJed Brown       /* Search for index of iremote[i].rank in sf->ranks */
795b5a8e515SJed Brown       ierr = PetscFindMPIInt(sf->remote[i].rank,sf->ndranks,sf->ranks,&irank);CHKERRQ(ierr);
796b5a8e515SJed Brown       if (irank < 0) {
797b5a8e515SJed Brown         ierr = PetscFindMPIInt(sf->remote[i].rank,sf->nranks-sf->ndranks,sf->ranks+sf->ndranks,&irank);CHKERRQ(ierr);
798b5a8e515SJed Brown         if (irank >= 0) irank += sf->ndranks;
79921c688dcSJed Brown       }
800247e8311SStefano Zampini       orank = sf->remote[i].rank;
801247e8311SStefano Zampini     }
802b5a8e515SJed Brown     if (irank < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Could not find rank %D in array",sf->remote[i].rank);
80321c688dcSJed Brown     sf->rmine[sf->roffset[irank] + rcount[irank]]   = sf->mine ? sf->mine[i] : i;
80421c688dcSJed Brown     sf->rremote[sf->roffset[irank] + rcount[irank]] = sf->remote[i].index;
80521c688dcSJed Brown     rcount[irank]++;
80621c688dcSJed Brown   }
80721c688dcSJed Brown   ierr = PetscFree2(rcount,ranks);CHKERRQ(ierr);
80821c688dcSJed Brown   PetscFunctionReturn(0);
80921c688dcSJed Brown }
81021c688dcSJed Brown 
81121c688dcSJed Brown /*@C
81295fce210SBarry Smith    PetscSFGetGroups - gets incoming and outgoing process groups
81395fce210SBarry Smith 
81495fce210SBarry Smith    Collective
81595fce210SBarry Smith 
81695fce210SBarry Smith    Input Argument:
81795fce210SBarry Smith .  sf - star forest
81895fce210SBarry Smith 
81995fce210SBarry Smith    Output Arguments:
82095fce210SBarry Smith +  incoming - group of origin processes for incoming edges (leaves that reference my roots)
82195fce210SBarry Smith -  outgoing - group of destination processes for outgoing edges (roots that I reference)
82295fce210SBarry Smith 
82395fce210SBarry Smith    Level: developer
82495fce210SBarry Smith 
82595fce210SBarry Smith .seealso: PetscSFGetWindow(), PetscSFRestoreWindow()
82695fce210SBarry Smith @*/
82795fce210SBarry Smith PetscErrorCode PetscSFGetGroups(PetscSF sf,MPI_Group *incoming,MPI_Group *outgoing)
82895fce210SBarry Smith {
82995fce210SBarry Smith   PetscErrorCode ierr;
8307fb8a5e4SKarl Rupp   MPI_Group      group = MPI_GROUP_NULL;
83195fce210SBarry Smith 
83295fce210SBarry Smith   PetscFunctionBegin;
83329046d53SLisandro Dalcin   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining groups");
83495fce210SBarry Smith   if (sf->ingroup == MPI_GROUP_NULL) {
83595fce210SBarry Smith     PetscInt       i;
83695fce210SBarry Smith     const PetscInt *indegree;
83795fce210SBarry Smith     PetscMPIInt    rank,*outranks,*inranks;
83895fce210SBarry Smith     PetscSFNode    *remote;
83995fce210SBarry Smith     PetscSF        bgcount;
84095fce210SBarry Smith 
84195fce210SBarry Smith     /* Compute the number of incoming ranks */
842785e854fSJed Brown     ierr = PetscMalloc1(sf->nranks,&remote);CHKERRQ(ierr);
84395fce210SBarry Smith     for (i=0; i<sf->nranks; i++) {
84495fce210SBarry Smith       remote[i].rank  = sf->ranks[i];
84595fce210SBarry Smith       remote[i].index = 0;
84695fce210SBarry Smith     }
84795fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,&bgcount);CHKERRQ(ierr);
84895fce210SBarry Smith     ierr = PetscSFSetGraph(bgcount,1,sf->nranks,NULL,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
84995fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(bgcount,&indegree);CHKERRQ(ierr);
85095fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(bgcount,&indegree);CHKERRQ(ierr);
85195fce210SBarry Smith 
85295fce210SBarry Smith     /* Enumerate the incoming ranks */
853dcca6d9dSJed Brown     ierr = PetscMalloc2(indegree[0],&inranks,sf->nranks,&outranks);CHKERRQ(ierr);
85495fce210SBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
85595fce210SBarry Smith     for (i=0; i<sf->nranks; i++) outranks[i] = rank;
85695fce210SBarry Smith     ierr = PetscSFGatherBegin(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
85795fce210SBarry Smith     ierr = PetscSFGatherEnd(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
85895fce210SBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
85995fce210SBarry Smith     ierr = MPI_Group_incl(group,indegree[0],inranks,&sf->ingroup);CHKERRQ(ierr);
86095fce210SBarry Smith     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
86195fce210SBarry Smith     ierr = PetscFree2(inranks,outranks);CHKERRQ(ierr);
86295fce210SBarry Smith     ierr = PetscSFDestroy(&bgcount);CHKERRQ(ierr);
86395fce210SBarry Smith   }
86495fce210SBarry Smith   *incoming = sf->ingroup;
86595fce210SBarry Smith 
86695fce210SBarry Smith   if (sf->outgroup == MPI_GROUP_NULL) {
86795fce210SBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRQ(ierr);
86895fce210SBarry Smith     ierr = MPI_Group_incl(group,sf->nranks,sf->ranks,&sf->outgroup);CHKERRQ(ierr);
86995fce210SBarry Smith     ierr = MPI_Group_free(&group);CHKERRQ(ierr);
87095fce210SBarry Smith   }
87195fce210SBarry Smith   *outgoing = sf->outgroup;
87295fce210SBarry Smith   PetscFunctionReturn(0);
87395fce210SBarry Smith }
87495fce210SBarry Smith 
87529046d53SLisandro Dalcin /*@
87695fce210SBarry Smith    PetscSFGetMultiSF - gets the inner SF implemeting gathers and scatters
87795fce210SBarry Smith 
87895fce210SBarry Smith    Collective
87995fce210SBarry Smith 
88095fce210SBarry Smith    Input Argument:
88195fce210SBarry Smith .  sf - star forest that may contain roots with 0 or with more than 1 vertex
88295fce210SBarry Smith 
88395fce210SBarry Smith    Output Arguments:
88495fce210SBarry Smith .  multi - star forest with split roots, such that each root has degree exactly 1
88595fce210SBarry Smith 
88695fce210SBarry Smith    Level: developer
88795fce210SBarry Smith 
88895fce210SBarry Smith    Notes:
88995fce210SBarry Smith 
89095fce210SBarry Smith    In most cases, users should use PetscSFGatherBegin() and PetscSFScatterBegin() instead of manipulating multi
89195fce210SBarry Smith    directly. Since multi satisfies the stronger condition that each entry in the global space has exactly one incoming
89295fce210SBarry Smith    edge, it is a candidate for future optimization that might involve its removal.
89395fce210SBarry Smith 
894673100f5SVaclav Hapla .seealso: PetscSFSetGraph(), PetscSFGatherBegin(), PetscSFScatterBegin(), PetscSFComputeMultiRootOriginalNumbering()
89595fce210SBarry Smith @*/
89695fce210SBarry Smith PetscErrorCode PetscSFGetMultiSF(PetscSF sf,PetscSF *multi)
89795fce210SBarry Smith {
89895fce210SBarry Smith   PetscErrorCode ierr;
89995fce210SBarry Smith 
90095fce210SBarry Smith   PetscFunctionBegin;
90195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
90295fce210SBarry Smith   PetscValidPointer(multi,2);
90395fce210SBarry Smith   if (sf->nroots < 0) {         /* Graph has not been set yet; why do we need this? */
90495fce210SBarry Smith     ierr   = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
90595fce210SBarry Smith     *multi = sf->multi;
90695fce210SBarry Smith     PetscFunctionReturn(0);
90795fce210SBarry Smith   }
90895fce210SBarry Smith   if (!sf->multi) {
90995fce210SBarry Smith     const PetscInt *indegree;
9109837ea96SMatthew G. Knepley     PetscInt       i,*inoffset,*outones,*outoffset,maxlocal;
91195fce210SBarry Smith     PetscSFNode    *remote;
91229046d53SLisandro Dalcin     maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
91395fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(sf,&indegree);CHKERRQ(ierr);
91495fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(sf,&indegree);CHKERRQ(ierr);
9159837ea96SMatthew G. Knepley     ierr = PetscMalloc3(sf->nroots+1,&inoffset,maxlocal,&outones,maxlocal,&outoffset);CHKERRQ(ierr);
91695fce210SBarry Smith     inoffset[0] = 0;
91795fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i+1] = inoffset[i] + indegree[i];
9189837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) outones[i] = 1;
919dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpBegin(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
920dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpEnd(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
92195fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i] -= indegree[i]; /* Undo the increment */
92295fce210SBarry Smith #if 0
92395fce210SBarry Smith #if defined(PETSC_USE_DEBUG)                                 /* Check that the expected number of increments occurred */
92495fce210SBarry Smith     for (i=0; i<sf->nroots; i++) {
92595fce210SBarry Smith       if (inoffset[i] + indegree[i] != inoffset[i+1]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Incorrect result after PetscSFFetchAndOp");
92695fce210SBarry Smith     }
92795fce210SBarry Smith #endif
92895fce210SBarry Smith #endif
929785e854fSJed Brown     ierr = PetscMalloc1(sf->nleaves,&remote);CHKERRQ(ierr);
93095fce210SBarry Smith     for (i=0; i<sf->nleaves; i++) {
93195fce210SBarry Smith       remote[i].rank  = sf->remote[i].rank;
93238e7336fSToby Isaac       remote[i].index = outoffset[sf->mine ? sf->mine[i] : i];
93395fce210SBarry Smith     }
93495fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
93501365b40SToby Isaac     ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
93695fce210SBarry Smith     if (sf->rankorder) {        /* Sort the ranks */
93795fce210SBarry Smith       PetscMPIInt rank;
93895fce210SBarry Smith       PetscInt    *inranks,*newoffset,*outranks,*newoutoffset,*tmpoffset,maxdegree;
93995fce210SBarry Smith       PetscSFNode *newremote;
94095fce210SBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRQ(ierr);
94195fce210SBarry Smith       for (i=0,maxdegree=0; i<sf->nroots; i++) maxdegree = PetscMax(maxdegree,indegree[i]);
9429837ea96SMatthew G. Knepley       ierr = PetscMalloc5(sf->multi->nroots,&inranks,sf->multi->nroots,&newoffset,maxlocal,&outranks,maxlocal,&newoutoffset,maxdegree,&tmpoffset);CHKERRQ(ierr);
9439837ea96SMatthew G. Knepley       for (i=0; i<maxlocal; i++) outranks[i] = rank;
9448bfbc91cSJed Brown       ierr = PetscSFReduceBegin(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr);
9458bfbc91cSJed Brown       ierr = PetscSFReduceEnd(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr);
94695fce210SBarry Smith       /* Sort the incoming ranks at each vertex, build the inverse map */
94795fce210SBarry Smith       for (i=0; i<sf->nroots; i++) {
94895fce210SBarry Smith         PetscInt j;
94995fce210SBarry Smith         for (j=0; j<indegree[i]; j++) tmpoffset[j] = j;
95095fce210SBarry Smith         ierr = PetscSortIntWithArray(indegree[i],inranks+inoffset[i],tmpoffset);CHKERRQ(ierr);
95195fce210SBarry Smith         for (j=0; j<indegree[i]; j++) newoffset[inoffset[i] + tmpoffset[j]] = inoffset[i] + j;
95295fce210SBarry Smith       }
95395fce210SBarry Smith       ierr = PetscSFBcastBegin(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr);
95495fce210SBarry Smith       ierr = PetscSFBcastEnd(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr);
955785e854fSJed Brown       ierr = PetscMalloc1(sf->nleaves,&newremote);CHKERRQ(ierr);
95695fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
95795fce210SBarry Smith         newremote[i].rank  = sf->remote[i].rank;
95801365b40SToby Isaac         newremote[i].index = newoutoffset[sf->mine ? sf->mine[i] : i];
95995fce210SBarry Smith       }
96001365b40SToby Isaac       ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,newremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
96195fce210SBarry Smith       ierr = PetscFree5(inranks,newoffset,outranks,newoutoffset,tmpoffset);CHKERRQ(ierr);
96295fce210SBarry Smith     }
96395fce210SBarry Smith     ierr = PetscFree3(inoffset,outones,outoffset);CHKERRQ(ierr);
96495fce210SBarry Smith   }
96595fce210SBarry Smith   *multi = sf->multi;
96695fce210SBarry Smith   PetscFunctionReturn(0);
96795fce210SBarry Smith }
96895fce210SBarry Smith 
96995fce210SBarry Smith /*@C
97095fce210SBarry Smith    PetscSFCreateEmbeddedSF - removes edges from all but the selected roots, does not remap indices
97195fce210SBarry Smith 
97295fce210SBarry Smith    Collective
97395fce210SBarry Smith 
97495fce210SBarry Smith    Input Arguments:
97595fce210SBarry Smith +  sf - original star forest
976ba2a7774SJunchao Zhang .  nselected  - number of selected roots on this process
977ba2a7774SJunchao Zhang -  selected   - indices of the selected roots on this process
97895fce210SBarry Smith 
97995fce210SBarry Smith    Output Arguments:
98095fce210SBarry Smith .  newsf - new star forest
98195fce210SBarry Smith 
98295fce210SBarry Smith    Level: advanced
98395fce210SBarry Smith 
98495fce210SBarry Smith    Note:
98595fce210SBarry Smith    To use the new PetscSF, it may be necessary to know the indices of the leaves that are still participating. This can
98695fce210SBarry Smith    be done by calling PetscSFGetGraph().
98795fce210SBarry Smith 
98895fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFGetGraph()
98995fce210SBarry Smith @*/
990ba2a7774SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
99195fce210SBarry Smith {
992f659e5c7SJunchao Zhang   PetscInt          i,n,*roots,*rootdata,*leafdata,nroots,nleaves,connected_leaves,*new_ilocal;
993ba2a7774SJunchao Zhang   const PetscSFNode *iremote;
994f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
995ba2a7774SJunchao Zhang   PetscSF           tmpsf;
996f659e5c7SJunchao Zhang   MPI_Comm          comm;
9970511a646SMatthew G. Knepley   PetscErrorCode    ierr;
99895fce210SBarry Smith 
99995fce210SBarry Smith   PetscFunctionBegin;
100095fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
100129046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1002ba2a7774SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
100395fce210SBarry Smith   PetscValidPointer(newsf,4);
10040511a646SMatthew G. Knepley 
1005f659e5c7SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1006f659e5c7SJunchao Zhang 
1007f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in roots[] */
1008f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1009f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&roots);CHKERRQ(ierr);
1010f659e5c7SJunchao Zhang   ierr = PetscMemcpy(roots,selected,sizeof(PetscInt)*nselected);CHKERRQ(ierr);
1011f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,roots);CHKERRQ(ierr);
1012f659e5c7SJunchao 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);
1013f659e5c7SJunchao Zhang 
1014f659e5c7SJunchao Zhang   if (sf->ops->CreateEmbeddedSF) {
1015f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedSF)(sf,nselected,roots,newsf);CHKERRQ(ierr);
1016f659e5c7SJunchao Zhang   } else {
1017f659e5c7SJunchao Zhang     /* A generic version of creating embedded sf. Note that we called PetscSFSetGraph() twice, which is certainly expensive */
1018ba2a7774SJunchao Zhang     /* Find out which leaves (not leaf data items) are still connected to roots in the embedded sf */
1019f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,NULL,&iremote);CHKERRQ(ierr);
1020ba2a7774SJunchao Zhang     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&tmpsf);CHKERRQ(ierr);
1021ba2a7774SJunchao Zhang     ierr = PetscSFSetGraph(tmpsf,nroots,nleaves,NULL/*contiguous*/,PETSC_USE_POINTER,iremote,PETSC_USE_POINTER);CHKERRQ(ierr);
1022ba2a7774SJunchao Zhang     ierr = PetscCalloc2(nroots,&rootdata,nleaves,&leafdata);CHKERRQ(ierr);
1023f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) rootdata[roots[i]] = 1;
1024ba2a7774SJunchao Zhang     ierr = PetscSFBcastBegin(tmpsf,MPIU_INT,rootdata,leafdata);CHKERRQ(ierr);
1025ba2a7774SJunchao Zhang     ierr = PetscSFBcastEnd(tmpsf,MPIU_INT,rootdata,leafdata);CHKERRQ(ierr);
1026ba2a7774SJunchao Zhang     ierr = PetscSFDestroy(&tmpsf);CHKERRQ(ierr);
1027ba2a7774SJunchao Zhang 
1028ba2a7774SJunchao Zhang     /* Build newsf with leaves that are still connected */
1029f659e5c7SJunchao Zhang     connected_leaves = 0;
1030f659e5c7SJunchao Zhang     for (i=0; i<nleaves; ++i) connected_leaves += leafdata[i];
1031f659e5c7SJunchao Zhang     ierr = PetscMalloc1(connected_leaves,&new_ilocal);CHKERRQ(ierr);
1032f659e5c7SJunchao Zhang     ierr = PetscMalloc1(connected_leaves,&new_iremote);CHKERRQ(ierr);
1033ba2a7774SJunchao Zhang     for (i=0, n=0; i<nleaves; ++i) {
1034ba2a7774SJunchao Zhang       if (leafdata[i]) {
1035ba2a7774SJunchao Zhang         new_ilocal[n]        = sf->mine ? sf->mine[i] : i;
1036ba2a7774SJunchao Zhang         new_iremote[n].rank  = sf->remote[i].rank;
1037ba2a7774SJunchao Zhang         new_iremote[n].index = sf->remote[i].index;
1038fc1ede2bSMatthew G. Knepley         ++n;
103995fce210SBarry Smith       }
104095fce210SBarry Smith     }
1041f659e5c7SJunchao Zhang 
1042f659e5c7SJunchao 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);
1043f659e5c7SJunchao Zhang     ierr = PetscSFCreate(comm,newsf);CHKERRQ(ierr);
1044f659e5c7SJunchao Zhang     ierr = PetscSFSetFromOptions(*newsf);CHKERRQ(ierr);
1045f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,connected_leaves,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
104695fce210SBarry Smith     ierr = PetscFree2(rootdata,leafdata);CHKERRQ(ierr);
1047f659e5c7SJunchao Zhang   }
1048f659e5c7SJunchao Zhang   ierr = PetscFree(roots);CHKERRQ(ierr);
104995fce210SBarry Smith   PetscFunctionReturn(0);
105095fce210SBarry Smith }
105195fce210SBarry Smith 
10522f5fb4c2SMatthew G. Knepley /*@C
10532f5fb4c2SMatthew G. Knepley   PetscSFCreateEmbeddedLeafSF - removes edges from all but the selected leaves, does not remap indices
10542f5fb4c2SMatthew G. Knepley 
10552f5fb4c2SMatthew G. Knepley   Collective
10562f5fb4c2SMatthew G. Knepley 
10572f5fb4c2SMatthew G. Knepley   Input Arguments:
10582f5fb4c2SMatthew G. Knepley + sf - original star forest
1059f659e5c7SJunchao Zhang . nselected  - number of selected leaves on this process
1060f659e5c7SJunchao Zhang - selected   - indices of the selected leaves on this process
10612f5fb4c2SMatthew G. Knepley 
10622f5fb4c2SMatthew G. Knepley   Output Arguments:
10632f5fb4c2SMatthew G. Knepley .  newsf - new star forest
10642f5fb4c2SMatthew G. Knepley 
10652f5fb4c2SMatthew G. Knepley   Level: advanced
10662f5fb4c2SMatthew G. Knepley 
10672f5fb4c2SMatthew G. Knepley .seealso: PetscSFCreateEmbeddedSF(), PetscSFSetGraph(), PetscSFGetGraph()
10682f5fb4c2SMatthew G. Knepley @*/
1069f659e5c7SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
10702f5fb4c2SMatthew G. Knepley {
1071f659e5c7SJunchao Zhang   const PetscSFNode *iremote;
1072f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1073f659e5c7SJunchao Zhang   const PetscInt    *ilocal;
1074f659e5c7SJunchao Zhang   PetscInt          i,nroots,*leaves,*new_ilocal;
1075f659e5c7SJunchao Zhang   MPI_Comm          comm;
10762f5fb4c2SMatthew G. Knepley   PetscErrorCode    ierr;
10772f5fb4c2SMatthew G. Knepley 
10782f5fb4c2SMatthew G. Knepley   PetscFunctionBegin;
10792f5fb4c2SMatthew G. Knepley   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
108029046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1081f659e5c7SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
10822f5fb4c2SMatthew G. Knepley   PetscValidPointer(newsf,4);
10832f5fb4c2SMatthew G. Knepley 
1084f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in leaves[] */
1085f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1086f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&leaves);CHKERRQ(ierr);
1087f659e5c7SJunchao Zhang   ierr = PetscMemcpy(leaves,selected,sizeof(PetscInt)*nselected);CHKERRQ(ierr);
1088f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,leaves);CHKERRQ(ierr);
1089f659e5c7SJunchao 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);
1090f659e5c7SJunchao Zhang 
1091f659e5c7SJunchao Zhang   /* Optimize the routine only when sf is setup and hence we can reuse sf's communication pattern */
1092f659e5c7SJunchao Zhang   if (sf->setupcalled && sf->ops->CreateEmbeddedLeafSF) {
1093f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedLeafSF)(sf,nselected,leaves,newsf);CHKERRQ(ierr);
1094f659e5c7SJunchao Zhang   } else {
1095f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,NULL,&ilocal,&iremote);CHKERRQ(ierr);
1096f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_ilocal);CHKERRQ(ierr);
1097f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_iremote);CHKERRQ(ierr);
1098f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) {
1099f659e5c7SJunchao Zhang       const PetscInt l     = leaves[i];
1100f659e5c7SJunchao Zhang       new_ilocal[i]        = ilocal ? ilocal[l] : l;
1101f659e5c7SJunchao Zhang       new_iremote[i].rank  = iremote[l].rank;
1102f659e5c7SJunchao Zhang       new_iremote[i].index = iremote[l].index;
11032f5fb4c2SMatthew G. Knepley     }
1104f659e5c7SJunchao Zhang     ierr = PetscSFCreate(comm,newsf);CHKERRQ(ierr);
1105f659e5c7SJunchao Zhang     ierr = PetscSFSetFromOptions(*newsf);CHKERRQ(ierr);
1106f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,nselected,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
1107f659e5c7SJunchao Zhang   }
1108f659e5c7SJunchao Zhang   ierr = PetscFree(leaves);CHKERRQ(ierr);
11092f5fb4c2SMatthew G. Knepley   PetscFunctionReturn(0);
11102f5fb4c2SMatthew G. Knepley }
11112f5fb4c2SMatthew G. Knepley 
111295fce210SBarry Smith /*@C
11133482bfa8SJunchao Zhang    PetscSFBcastAndOpBegin - begin pointwise broadcast with root value being reduced to leaf value, to be concluded with call to PetscSFBcastAndOpEnd()
11143482bfa8SJunchao Zhang 
11153482bfa8SJunchao Zhang    Collective on PetscSF
11163482bfa8SJunchao Zhang 
11173482bfa8SJunchao Zhang    Input Arguments:
11183482bfa8SJunchao Zhang +  sf - star forest on which to communicate
11193482bfa8SJunchao Zhang .  unit - data type associated with each node
11203482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
11213482bfa8SJunchao Zhang -  op - operation to use for reduction
11223482bfa8SJunchao Zhang 
11233482bfa8SJunchao Zhang    Output Arguments:
11243482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
11253482bfa8SJunchao Zhang 
11263482bfa8SJunchao Zhang    Level: intermediate
11273482bfa8SJunchao Zhang 
11283482bfa8SJunchao Zhang .seealso: PetscSFBcastAndOpEnd(), PetscSFBcastBegin(), PetscSFBcastEnd()
11293482bfa8SJunchao Zhang @*/
11303482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpBegin(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
11313482bfa8SJunchao Zhang {
11323482bfa8SJunchao Zhang   PetscErrorCode ierr;
11333482bfa8SJunchao Zhang 
11343482bfa8SJunchao Zhang   PetscFunctionBegin;
11353482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
11363482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
11373482bfa8SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
11383482bfa8SJunchao Zhang   ierr = (*sf->ops->BcastAndOpBegin)(sf,unit,rootdata,leafdata,op);CHKERRQ(ierr);
11393482bfa8SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
11403482bfa8SJunchao Zhang   PetscFunctionReturn(0);
11413482bfa8SJunchao Zhang }
11423482bfa8SJunchao Zhang 
11433482bfa8SJunchao Zhang /*@C
11443482bfa8SJunchao Zhang    PetscSFBcastAndOpEnd - end a broadcast & reduce operation started with PetscSFBcastAndOpBegin()
11453482bfa8SJunchao Zhang 
11463482bfa8SJunchao Zhang    Collective
11473482bfa8SJunchao Zhang 
11483482bfa8SJunchao Zhang    Input Arguments:
11493482bfa8SJunchao Zhang +  sf - star forest
11503482bfa8SJunchao Zhang .  unit - data type
11513482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
11523482bfa8SJunchao Zhang -  op - operation to use for reduction
11533482bfa8SJunchao Zhang 
11543482bfa8SJunchao Zhang    Output Arguments:
11553482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
11563482bfa8SJunchao Zhang 
11573482bfa8SJunchao Zhang    Level: intermediate
11583482bfa8SJunchao Zhang 
11593482bfa8SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFReduceEnd()
11603482bfa8SJunchao Zhang @*/
11613482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpEnd(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
11623482bfa8SJunchao Zhang {
11633482bfa8SJunchao Zhang   PetscErrorCode ierr;
11643482bfa8SJunchao Zhang 
11653482bfa8SJunchao Zhang   PetscFunctionBegin;
11663482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
11673482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
11683482bfa8SJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
11693482bfa8SJunchao Zhang   ierr = (*sf->ops->BcastAndOpEnd)(sf,unit,rootdata,leafdata,op);CHKERRQ(ierr);
11703482bfa8SJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
11713482bfa8SJunchao Zhang   PetscFunctionReturn(0);
11723482bfa8SJunchao Zhang }
11733482bfa8SJunchao Zhang 
11743482bfa8SJunchao Zhang /*@C
117595fce210SBarry Smith    PetscSFReduceBegin - begin reduction of leafdata into rootdata, to be completed with call to PetscSFReduceEnd()
117695fce210SBarry Smith 
117795fce210SBarry Smith    Collective
117895fce210SBarry Smith 
117995fce210SBarry Smith    Input Arguments:
118095fce210SBarry Smith +  sf - star forest
118195fce210SBarry Smith .  unit - data type
118295fce210SBarry Smith .  leafdata - values to reduce
118395fce210SBarry Smith -  op - reduction operation
118495fce210SBarry Smith 
118595fce210SBarry Smith    Output Arguments:
118695fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
118795fce210SBarry Smith 
118895fce210SBarry Smith    Level: intermediate
118995fce210SBarry Smith 
119095fce210SBarry Smith .seealso: PetscSFBcastBegin()
119195fce210SBarry Smith @*/
119295fce210SBarry Smith PetscErrorCode PetscSFReduceBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
119395fce210SBarry Smith {
119495fce210SBarry Smith   PetscErrorCode ierr;
119595fce210SBarry Smith 
119695fce210SBarry Smith   PetscFunctionBegin;
119795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
119895fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
119929046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);
120095fce210SBarry Smith   ierr = (sf->ops->ReduceBegin)(sf,unit,leafdata,rootdata,op);CHKERRQ(ierr);
1201563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);
120295fce210SBarry Smith   PetscFunctionReturn(0);
120395fce210SBarry Smith }
120495fce210SBarry Smith 
120595fce210SBarry Smith /*@C
120695fce210SBarry Smith    PetscSFReduceEnd - end a reduction operation started with PetscSFReduceBegin()
120795fce210SBarry Smith 
120895fce210SBarry Smith    Collective
120995fce210SBarry Smith 
121095fce210SBarry Smith    Input Arguments:
121195fce210SBarry Smith +  sf - star forest
121295fce210SBarry Smith .  unit - data type
121395fce210SBarry Smith .  leafdata - values to reduce
121495fce210SBarry Smith -  op - reduction operation
121595fce210SBarry Smith 
121695fce210SBarry Smith    Output Arguments:
121795fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
121895fce210SBarry Smith 
121995fce210SBarry Smith    Level: intermediate
122095fce210SBarry Smith 
122195fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFBcastEnd()
122295fce210SBarry Smith @*/
122395fce210SBarry Smith PetscErrorCode PetscSFReduceEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
122495fce210SBarry Smith {
122595fce210SBarry Smith   PetscErrorCode ierr;
122695fce210SBarry Smith 
122795fce210SBarry Smith   PetscFunctionBegin;
122895fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
122995fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
123029046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);
123195fce210SBarry Smith   ierr = (*sf->ops->ReduceEnd)(sf,unit,leafdata,rootdata,op);CHKERRQ(ierr);
1232563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);
123395fce210SBarry Smith   PetscFunctionReturn(0);
123495fce210SBarry Smith }
123595fce210SBarry Smith 
123695fce210SBarry Smith /*@C
123795fce210SBarry Smith    PetscSFComputeDegreeBegin - begin computation of degree for each root vertex, to be completed with PetscSFComputeDegreeEnd()
123895fce210SBarry Smith 
123995fce210SBarry Smith    Collective
124095fce210SBarry Smith 
124195fce210SBarry Smith    Input Arguments:
124295fce210SBarry Smith .  sf - star forest
124395fce210SBarry Smith 
124495fce210SBarry Smith    Output Arguments:
124595fce210SBarry Smith .  degree - degree of each root vertex
124695fce210SBarry Smith 
124795fce210SBarry Smith    Level: advanced
124895fce210SBarry Smith 
1249ffe67aa5SVáclav Hapla    Notes:
1250ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1251ffe67aa5SVáclav Hapla 
125295fce210SBarry Smith .seealso: PetscSFGatherBegin()
125395fce210SBarry Smith @*/
125495fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeBegin(PetscSF sf,const PetscInt **degree)
125595fce210SBarry Smith {
125695fce210SBarry Smith   PetscErrorCode ierr;
125795fce210SBarry Smith 
125895fce210SBarry Smith   PetscFunctionBegin;
125995fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
126095fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
126195fce210SBarry Smith   PetscValidPointer(degree,2);
1262803bd9e8SMatthew G. Knepley   if (!sf->degreeknown) {
126329046d53SLisandro Dalcin     PetscInt i, nroots = sf->nroots, maxlocal = sf->maxleaf+1;  /* TODO: We should use PetscSFGetLeafRange() */
1264803bd9e8SMatthew G. Knepley     if (sf->degree) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Calls to PetscSFComputeDegreeBegin() cannot be nested.");
126529046d53SLisandro Dalcin     ierr = PetscMalloc1(nroots,&sf->degree);CHKERRQ(ierr);
126629046d53SLisandro Dalcin     ierr = PetscMalloc1(PetscMax(maxlocal,1),&sf->degreetmp);CHKERRQ(ierr); /* allocate at least one entry, see check in PetscSFComputeDegreeEnd() */
126729046d53SLisandro Dalcin     for (i=0; i<nroots; i++) sf->degree[i] = 0;
12689837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) sf->degreetmp[i] = 1;
1269dbd2ff41SBarry Smith     ierr = PetscSFReduceBegin(sf,MPIU_INT,sf->degreetmp,sf->degree,MPI_SUM);CHKERRQ(ierr);
127095fce210SBarry Smith   }
127195fce210SBarry Smith   *degree = NULL;
127295fce210SBarry Smith   PetscFunctionReturn(0);
127395fce210SBarry Smith }
127495fce210SBarry Smith 
127595fce210SBarry Smith /*@C
127695fce210SBarry Smith    PetscSFComputeDegreeEnd - complete computation of degree for each root vertex, started with PetscSFComputeDegreeBegin()
127795fce210SBarry Smith 
127895fce210SBarry Smith    Collective
127995fce210SBarry Smith 
128095fce210SBarry Smith    Input Arguments:
128195fce210SBarry Smith .  sf - star forest
128295fce210SBarry Smith 
128395fce210SBarry Smith    Output Arguments:
128495fce210SBarry Smith .  degree - degree of each root vertex
128595fce210SBarry Smith 
128695fce210SBarry Smith    Level: developer
128795fce210SBarry Smith 
1288ffe67aa5SVáclav Hapla    Notes:
1289ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1290ffe67aa5SVáclav Hapla 
129195fce210SBarry Smith .seealso:
129295fce210SBarry Smith @*/
129395fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeEnd(PetscSF sf,const PetscInt **degree)
129495fce210SBarry Smith {
129595fce210SBarry Smith   PetscErrorCode ierr;
129695fce210SBarry Smith 
129795fce210SBarry Smith   PetscFunctionBegin;
129895fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
129995fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
130029046d53SLisandro Dalcin   PetscValidPointer(degree,2);
130195fce210SBarry Smith   if (!sf->degreeknown) {
130229046d53SLisandro Dalcin     if (!sf->degreetmp) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call PetscSFComputeDegreeBegin() before PetscSFComputeDegreeEnd()");
1303dbd2ff41SBarry Smith     ierr = PetscSFReduceEnd(sf,MPIU_INT,sf->degreetmp,sf->degree,MPI_SUM);CHKERRQ(ierr);
130495fce210SBarry Smith     ierr = PetscFree(sf->degreetmp);CHKERRQ(ierr);
130595fce210SBarry Smith     sf->degreeknown = PETSC_TRUE;
130695fce210SBarry Smith   }
130795fce210SBarry Smith   *degree = sf->degree;
130895fce210SBarry Smith   PetscFunctionReturn(0);
130995fce210SBarry Smith }
131095fce210SBarry Smith 
1311673100f5SVaclav Hapla 
1312673100f5SVaclav Hapla /*@C
131366dfcd1aSVaclav Hapla    PetscSFComputeMultiRootOriginalNumbering - Returns original numbering of multi-roots (roots of multi-SF returned by PetscSFGetMultiSF()).
131466dfcd1aSVaclav Hapla    Each multi-root is assigned index of the corresponding original root.
1315673100f5SVaclav Hapla 
1316673100f5SVaclav Hapla    Collective
1317673100f5SVaclav Hapla 
1318673100f5SVaclav Hapla    Input Arguments:
1319673100f5SVaclav Hapla +  sf - star forest
1320673100f5SVaclav Hapla -  degree - degree of each root vertex, computed with PetscSFComputeDegreeBegin()/PetscSFComputeDegreeEnd()
1321673100f5SVaclav Hapla 
1322673100f5SVaclav Hapla    Output Arguments:
132366dfcd1aSVaclav Hapla +  nMultiRoots - (optional) number of multi-roots (roots of multi-SF)
132466dfcd1aSVaclav Hapla -  multiRootsOrigNumbering - original indices of multi-roots; length of this array is nMultiRoots
1325673100f5SVaclav Hapla 
1326673100f5SVaclav Hapla    Level: developer
1327673100f5SVaclav Hapla 
1328ffe67aa5SVáclav Hapla    Notes:
1329ffe67aa5SVáclav Hapla    The returned array multiRootsOrigNumbering is newly allocated and should be destroyed with PetscFree() when no longer needed.
1330ffe67aa5SVáclav Hapla 
1331673100f5SVaclav Hapla .seealso: PetscSFComputeDegreeBegin(), PetscSFComputeDegreeEnd(), PetscSFGetMultiSF()
1332673100f5SVaclav Hapla @*/
133366dfcd1aSVaclav Hapla PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF sf, const PetscInt degree[], PetscInt *nMultiRoots, PetscInt *multiRootsOrigNumbering[])
1334673100f5SVaclav Hapla {
1335673100f5SVaclav Hapla   PetscSF             msf;
1336673100f5SVaclav Hapla   PetscInt            i, j, k, nroots, nmroots;
1337673100f5SVaclav Hapla   PetscErrorCode      ierr;
1338673100f5SVaclav Hapla 
1339673100f5SVaclav Hapla   PetscFunctionBegin;
1340673100f5SVaclav Hapla   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1341673100f5SVaclav Hapla   ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
134229328920SVaclav Hapla   if (nroots) PetscValidIntPointer(degree,2);
134366dfcd1aSVaclav Hapla   if (nMultiRoots) PetscValidIntPointer(nMultiRoots,3);
134466dfcd1aSVaclav Hapla   PetscValidPointer(multiRootsOrigNumbering,4);
1345673100f5SVaclav Hapla   ierr = PetscSFGetMultiSF(sf,&msf);CHKERRQ(ierr);
1346673100f5SVaclav Hapla   ierr = PetscSFGetGraph(msf, &nmroots, NULL, NULL, NULL);CHKERRQ(ierr);
134766dfcd1aSVaclav Hapla   ierr = PetscMalloc1(nmroots, multiRootsOrigNumbering);CHKERRQ(ierr);
1348673100f5SVaclav Hapla   for (i=0,j=0,k=0; i<nroots; i++) {
1349673100f5SVaclav Hapla     if (!degree[i]) continue;
1350673100f5SVaclav Hapla     for (j=0; j<degree[i]; j++,k++) {
135166dfcd1aSVaclav Hapla       (*multiRootsOrigNumbering)[k] = i;
1352673100f5SVaclav Hapla     }
1353673100f5SVaclav Hapla   }
1354673100f5SVaclav Hapla #if defined(PETSC_USE_DEBUG)
1355673100f5SVaclav Hapla   if (PetscUnlikely(k != nmroots)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"sanity check fail");
1356673100f5SVaclav Hapla #endif
135766dfcd1aSVaclav Hapla   if (nMultiRoots) *nMultiRoots = nmroots;
1358673100f5SVaclav Hapla   PetscFunctionReturn(0);
1359673100f5SVaclav Hapla }
1360673100f5SVaclav Hapla 
136195fce210SBarry Smith /*@C
136295fce210SBarry Smith    PetscSFFetchAndOpBegin - begin operation that fetches values from root and updates atomically by applying operation using my leaf value, to be completed with PetscSFFetchAndOpEnd()
136395fce210SBarry Smith 
136495fce210SBarry Smith    Collective
136595fce210SBarry Smith 
136695fce210SBarry Smith    Input Arguments:
136795fce210SBarry Smith +  sf - star forest
136895fce210SBarry Smith .  unit - data type
136995fce210SBarry Smith .  leafdata - leaf values to use in reduction
137095fce210SBarry Smith -  op - operation to use for reduction
137195fce210SBarry Smith 
137295fce210SBarry Smith    Output Arguments:
137395fce210SBarry Smith +  rootdata - root values to be updated, input state is seen by first process to perform an update
137495fce210SBarry Smith -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
137595fce210SBarry Smith 
137695fce210SBarry Smith    Level: advanced
137795fce210SBarry Smith 
137895fce210SBarry Smith    Note:
137995fce210SBarry Smith    The update is only atomic at the granularity provided by the hardware. Different roots referenced by the same process
138095fce210SBarry Smith    might be updated in a different order. Furthermore, if a composite type is used for the unit datatype, atomicity is
138195fce210SBarry Smith    not guaranteed across the whole vertex. Therefore, this function is mostly only used with primitive types such as
138295fce210SBarry Smith    integers.
138395fce210SBarry Smith 
138495fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFReduceBegin(), PetscSFSetGraph()
138595fce210SBarry Smith @*/
138695fce210SBarry Smith PetscErrorCode PetscSFFetchAndOpBegin(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
138795fce210SBarry Smith {
138895fce210SBarry Smith   PetscErrorCode ierr;
138995fce210SBarry Smith 
139095fce210SBarry Smith   PetscFunctionBegin;
139195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
139295fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
139329046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
139495fce210SBarry Smith   ierr = (*sf->ops->FetchAndOpBegin)(sf,unit,rootdata,leafdata,leafupdate,op);CHKERRQ(ierr);
1395563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
139695fce210SBarry Smith   PetscFunctionReturn(0);
139795fce210SBarry Smith }
139895fce210SBarry Smith 
139995fce210SBarry Smith /*@C
140095fce210SBarry Smith    PetscSFFetchAndOpEnd - end operation started in matching call to PetscSFFetchAndOpBegin() to fetch values from roots and update atomically by applying operation using my leaf value
140195fce210SBarry Smith 
140295fce210SBarry Smith    Collective
140395fce210SBarry Smith 
140495fce210SBarry Smith    Input Arguments:
140595fce210SBarry Smith +  sf - star forest
140695fce210SBarry Smith .  unit - data type
140795fce210SBarry Smith .  leafdata - leaf values to use in reduction
140895fce210SBarry Smith -  op - operation to use for reduction
140995fce210SBarry Smith 
141095fce210SBarry Smith    Output Arguments:
141195fce210SBarry Smith +  rootdata - root values to be updated, input state is seen by first process to perform an update
141295fce210SBarry Smith -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
141395fce210SBarry Smith 
141495fce210SBarry Smith    Level: advanced
141595fce210SBarry Smith 
141695fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFReduceEnd(), PetscSFSetGraph()
141795fce210SBarry Smith @*/
141895fce210SBarry Smith PetscErrorCode PetscSFFetchAndOpEnd(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
141995fce210SBarry Smith {
142095fce210SBarry Smith   PetscErrorCode ierr;
142195fce210SBarry Smith 
142295fce210SBarry Smith   PetscFunctionBegin;
142395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
142495fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
142529046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
142695fce210SBarry Smith   ierr = (*sf->ops->FetchAndOpEnd)(sf,unit,rootdata,leafdata,leafupdate,op);CHKERRQ(ierr);
1427563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
142895fce210SBarry Smith   PetscFunctionReturn(0);
142995fce210SBarry Smith }
143095fce210SBarry Smith 
143195fce210SBarry Smith /*@C
143295fce210SBarry Smith    PetscSFGatherBegin - begin pointwise gather of all leaves into multi-roots, to be completed with PetscSFGatherEnd()
143395fce210SBarry Smith 
143495fce210SBarry Smith    Collective
143595fce210SBarry Smith 
143695fce210SBarry Smith    Input Arguments:
143795fce210SBarry Smith +  sf - star forest
143895fce210SBarry Smith .  unit - data type
143995fce210SBarry Smith -  leafdata - leaf data to gather to roots
144095fce210SBarry Smith 
144195fce210SBarry Smith    Output Argument:
144295fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
144395fce210SBarry Smith 
144495fce210SBarry Smith    Level: intermediate
144595fce210SBarry Smith 
144695fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
144795fce210SBarry Smith @*/
144895fce210SBarry Smith PetscErrorCode PetscSFGatherBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
144995fce210SBarry Smith {
145095fce210SBarry Smith   PetscErrorCode ierr;
145195fce210SBarry Smith   PetscSF        multi;
145295fce210SBarry Smith 
145395fce210SBarry Smith   PetscFunctionBegin;
145495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
145529046d53SLisandro Dalcin   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
145695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
14578bfbc91cSJed Brown   ierr = PetscSFReduceBegin(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr);
145895fce210SBarry Smith   PetscFunctionReturn(0);
145995fce210SBarry Smith }
146095fce210SBarry Smith 
146195fce210SBarry Smith /*@C
146295fce210SBarry Smith    PetscSFGatherEnd - ends pointwise gather operation that was started with PetscSFGatherBegin()
146395fce210SBarry Smith 
146495fce210SBarry Smith    Collective
146595fce210SBarry Smith 
146695fce210SBarry Smith    Input Arguments:
146795fce210SBarry Smith +  sf - star forest
146895fce210SBarry Smith .  unit - data type
146995fce210SBarry Smith -  leafdata - leaf data to gather to roots
147095fce210SBarry Smith 
147195fce210SBarry Smith    Output Argument:
147295fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
147395fce210SBarry Smith 
147495fce210SBarry Smith    Level: intermediate
147595fce210SBarry Smith 
147695fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
147795fce210SBarry Smith @*/
147895fce210SBarry Smith PetscErrorCode PetscSFGatherEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
147995fce210SBarry Smith {
148095fce210SBarry Smith   PetscErrorCode ierr;
148195fce210SBarry Smith   PetscSF        multi;
148295fce210SBarry Smith 
148395fce210SBarry Smith   PetscFunctionBegin;
148495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
148595fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
148695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
14878bfbc91cSJed Brown   ierr = PetscSFReduceEnd(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr);
148895fce210SBarry Smith   PetscFunctionReturn(0);
148995fce210SBarry Smith }
149095fce210SBarry Smith 
149195fce210SBarry Smith /*@C
149295fce210SBarry Smith    PetscSFScatterBegin - begin pointwise scatter operation from multi-roots to leaves, to be completed with PetscSFScatterEnd()
149395fce210SBarry Smith 
149495fce210SBarry Smith    Collective
149595fce210SBarry Smith 
149695fce210SBarry Smith    Input Arguments:
149795fce210SBarry Smith +  sf - star forest
149895fce210SBarry Smith .  unit - data type
149995fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
150095fce210SBarry Smith 
150195fce210SBarry Smith    Output Argument:
150295fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
150395fce210SBarry Smith 
150495fce210SBarry Smith    Level: intermediate
150595fce210SBarry Smith 
150695fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
150795fce210SBarry Smith @*/
150895fce210SBarry Smith PetscErrorCode PetscSFScatterBegin(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
150995fce210SBarry Smith {
151095fce210SBarry Smith   PetscErrorCode ierr;
151195fce210SBarry Smith   PetscSF        multi;
151295fce210SBarry Smith 
151395fce210SBarry Smith   PetscFunctionBegin;
151495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
151595fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
151695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
151795fce210SBarry Smith   ierr = PetscSFBcastBegin(multi,unit,multirootdata,leafdata);CHKERRQ(ierr);
151895fce210SBarry Smith   PetscFunctionReturn(0);
151995fce210SBarry Smith }
152095fce210SBarry Smith 
152195fce210SBarry Smith /*@C
152295fce210SBarry Smith    PetscSFScatterEnd - ends pointwise scatter operation that was started with PetscSFScatterBegin()
152395fce210SBarry Smith 
152495fce210SBarry Smith    Collective
152595fce210SBarry Smith 
152695fce210SBarry Smith    Input Arguments:
152795fce210SBarry Smith +  sf - star forest
152895fce210SBarry Smith .  unit - data type
152995fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
153095fce210SBarry Smith 
153195fce210SBarry Smith    Output Argument:
153295fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
153395fce210SBarry Smith 
153495fce210SBarry Smith    Level: intermediate
153595fce210SBarry Smith 
153695fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
153795fce210SBarry Smith @*/
153895fce210SBarry Smith PetscErrorCode PetscSFScatterEnd(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
153995fce210SBarry Smith {
154095fce210SBarry Smith   PetscErrorCode ierr;
154195fce210SBarry Smith   PetscSF        multi;
154295fce210SBarry Smith 
154395fce210SBarry Smith   PetscFunctionBegin;
154495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
154595fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
154695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
154795fce210SBarry Smith   ierr = PetscSFBcastEnd(multi,unit,multirootdata,leafdata);CHKERRQ(ierr);
154895fce210SBarry Smith   PetscFunctionReturn(0);
154995fce210SBarry Smith }
1550a7b3aa13SAta Mesgarnejad 
1551a7b3aa13SAta Mesgarnejad /*@
1552a7b3aa13SAta Mesgarnejad   PetscSFCompose - Compose a new PetscSF equivalent to action to PetscSFs
1553a7b3aa13SAta Mesgarnejad 
1554a7b3aa13SAta Mesgarnejad   Input Parameters:
1555a7b3aa13SAta Mesgarnejad + sfA - The first PetscSF
1556a7b3aa13SAta Mesgarnejad - sfB - The second PetscSF
1557a7b3aa13SAta Mesgarnejad 
1558a7b3aa13SAta Mesgarnejad   Output Parameters:
1559a7b3aa13SAta Mesgarnejad . sfBA - equvalent PetscSF for applying A then B
1560a7b3aa13SAta Mesgarnejad 
1561a7b3aa13SAta Mesgarnejad   Level: developer
1562a7b3aa13SAta Mesgarnejad 
1563a7b3aa13SAta Mesgarnejad .seealso: PetscSF, PetscSFGetGraph(), PetscSFSetGraph()
1564a7b3aa13SAta Mesgarnejad @*/
1565a7b3aa13SAta Mesgarnejad PetscErrorCode PetscSFCompose(PetscSF sfA, PetscSF sfB, PetscSF *sfBA)
1566a7b3aa13SAta Mesgarnejad {
1567a7b3aa13SAta Mesgarnejad   MPI_Comm           comm;
1568a7b3aa13SAta Mesgarnejad   const PetscSFNode *remotePointsA, *remotePointsB;
1569a7b3aa13SAta Mesgarnejad   PetscSFNode       *remotePointsBA;
1570a7b3aa13SAta Mesgarnejad   const PetscInt    *localPointsA, *localPointsB;
1571a7b3aa13SAta Mesgarnejad   PetscInt           numRootsA, numLeavesA, numRootsB, numLeavesB;
1572a7b3aa13SAta Mesgarnejad   PetscErrorCode     ierr;
1573a7b3aa13SAta Mesgarnejad 
1574a7b3aa13SAta Mesgarnejad   PetscFunctionBegin;
1575a7b3aa13SAta Mesgarnejad   PetscValidHeaderSpecific(sfA, PETSCSF_CLASSID, 1);
157629046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfA, 1);
157729046d53SLisandro Dalcin   PetscValidHeaderSpecific(sfB, PETSCSF_CLASSID, 2);
157829046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfB, 2);
157929046d53SLisandro Dalcin   PetscValidPointer(sfBA, 3);
1580a7b3aa13SAta Mesgarnejad   ierr = PetscObjectGetComm((PetscObject) sfA, &comm);CHKERRQ(ierr);
1581a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfA, &numRootsA, &numLeavesA, &localPointsA, &remotePointsA);CHKERRQ(ierr);
1582a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfB, &numRootsB, &numLeavesB, &localPointsB, &remotePointsB);CHKERRQ(ierr);
1583a7b3aa13SAta Mesgarnejad   ierr = PetscMalloc1(numLeavesB, &remotePointsBA);CHKERRQ(ierr);
1584a7b3aa13SAta Mesgarnejad   ierr = PetscSFBcastBegin(sfB, MPIU_2INT, remotePointsA, remotePointsBA);CHKERRQ(ierr);
1585a7b3aa13SAta Mesgarnejad   ierr = PetscSFBcastEnd(sfB, MPIU_2INT, remotePointsA, remotePointsBA);CHKERRQ(ierr);
1586a7b3aa13SAta Mesgarnejad   ierr = PetscSFCreate(comm, sfBA);CHKERRQ(ierr);
1587a7b3aa13SAta Mesgarnejad   ierr = PetscSFSetGraph(*sfBA, numRootsA, numLeavesB, localPointsB, PETSC_COPY_VALUES, remotePointsBA, PETSC_OWN_POINTER);CHKERRQ(ierr);
1588a7b3aa13SAta Mesgarnejad   PetscFunctionReturn(0);
1589a7b3aa13SAta Mesgarnejad }
15901c6ba672SJunchao Zhang 
15911c6ba672SJunchao Zhang /*
15921c6ba672SJunchao Zhang   PetscSFCreateLocalSF_Private - Creates a local PetscSF that only has intra-process edges of the global PetscSF
15931c6ba672SJunchao Zhang 
15941c6ba672SJunchao Zhang   Input Parameters:
15951c6ba672SJunchao Zhang . sf - The global PetscSF
15961c6ba672SJunchao Zhang 
15971c6ba672SJunchao Zhang   Output Parameters:
15981c6ba672SJunchao Zhang . out - The local PetscSF
15991c6ba672SJunchao Zhang  */
16001c6ba672SJunchao Zhang PetscErrorCode PetscSFCreateLocalSF_Private(PetscSF sf,PetscSF *out)
16011c6ba672SJunchao Zhang {
16021c6ba672SJunchao Zhang   MPI_Comm           comm;
16031c6ba672SJunchao Zhang   PetscMPIInt        myrank;
16041c6ba672SJunchao Zhang   const PetscInt     *ilocal;
16051c6ba672SJunchao Zhang   const PetscSFNode  *iremote;
16061c6ba672SJunchao Zhang   PetscInt           i,j,nroots,nleaves,lnleaves,*lilocal;
16071c6ba672SJunchao Zhang   PetscSFNode        *liremote;
16081c6ba672SJunchao Zhang   PetscSF            lsf;
16091c6ba672SJunchao Zhang   PetscErrorCode     ierr;
16101c6ba672SJunchao Zhang 
16111c6ba672SJunchao Zhang   PetscFunctionBegin;
16121c6ba672SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
16131c6ba672SJunchao Zhang   if (sf->ops->CreateLocalSF) {
16141c6ba672SJunchao Zhang     ierr = (*sf->ops->CreateLocalSF)(sf,out);CHKERRQ(ierr);
16151c6ba672SJunchao Zhang   } else {
16161c6ba672SJunchao Zhang     /* Could use PetscSFCreateEmbeddedLeafSF, but since we know the comm is PETSC_COMM_SELF, we can make it fast */
16171c6ba672SJunchao Zhang     ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
16181c6ba672SJunchao Zhang     ierr = MPI_Comm_rank(comm,&myrank);CHKERRQ(ierr);
16191c6ba672SJunchao Zhang 
16201c6ba672SJunchao Zhang     /* Find out local edges and build a local SF */
16211c6ba672SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
16221c6ba672SJunchao Zhang     for (i=lnleaves=0; i<nleaves; i++) {if (iremote[i].rank == (PetscInt)myrank) lnleaves++;}
16231c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&lilocal);CHKERRQ(ierr);
16241c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&liremote);CHKERRQ(ierr);
16251c6ba672SJunchao Zhang 
16261c6ba672SJunchao Zhang     for (i=j=0; i<nleaves; i++) {
16271c6ba672SJunchao Zhang       if (iremote[i].rank == (PetscInt)myrank) {
16281c6ba672SJunchao Zhang         lilocal[j]        = ilocal? ilocal[i] : i; /* ilocal=NULL for contiguous storage */
16291c6ba672SJunchao Zhang         liremote[j].rank  = 0; /* rank in PETSC_COMM_SELF */
16301c6ba672SJunchao Zhang         liremote[j].index = iremote[i].index;
16311c6ba672SJunchao Zhang         j++;
16321c6ba672SJunchao Zhang       }
16331c6ba672SJunchao Zhang     }
16341c6ba672SJunchao Zhang     ierr = PetscSFCreate(PETSC_COMM_SELF,&lsf);CHKERRQ(ierr);
16351c6ba672SJunchao Zhang     ierr = PetscSFSetGraph(lsf,nroots,lnleaves,lilocal,PETSC_OWN_POINTER,liremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
16361c6ba672SJunchao Zhang     ierr = PetscSFSetUp(lsf);CHKERRQ(ierr);
16371c6ba672SJunchao Zhang     *out = lsf;
16381c6ba672SJunchao Zhang   }
16391c6ba672SJunchao Zhang   PetscFunctionReturn(0);
16401c6ba672SJunchao Zhang }
1641