xref: /petsc/src/vec/is/sf/interface/sf.c (revision 8dbb0df66754dee4fb72dff2ad56e76db1e6b7c7)
1af0996ceSBarry Smith #include <petsc/private/sfimpl.h> /*I "petscsf.h" I*/
2c4e6a40aSLawrence Mitchell #include <petsc/private/hashseti.h>
395fce210SBarry Smith #include <petscctable.h>
495fce210SBarry Smith 
57fd2d3dbSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
67fd2d3dbSJunchao Zhang   #include <cuda_runtime.h>
77fd2d3dbSJunchao Zhang #endif
87fd2d3dbSJunchao Zhang 
97fd2d3dbSJunchao Zhang #if defined(PETSC_HAVE_HIP)
107fd2d3dbSJunchao Zhang   #include <hip/hip_runtime.h>
117fd2d3dbSJunchao Zhang #endif
127fd2d3dbSJunchao Zhang 
1395fce210SBarry Smith #if defined(PETSC_USE_DEBUG)
1495fce210SBarry Smith #  define PetscSFCheckGraphSet(sf,arg) do {                          \
1595fce210SBarry Smith     if (PetscUnlikely(!(sf)->graphset))                              \
16dd5b3ca6SJunchao Zhang       SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetGraph() or PetscSFSetGraphWithPattern() on argument %D \"%s\" before %s()",(arg),#sf,PETSC_FUNCTION_NAME); \
1795fce210SBarry Smith   } while (0)
1895fce210SBarry Smith #else
1995fce210SBarry Smith #  define PetscSFCheckGraphSet(sf,arg) do {} while (0)
2095fce210SBarry Smith #endif
2195fce210SBarry Smith 
224c8fdceaSLisandro Dalcin const char *const PetscSFDuplicateOptions[] = {"CONFONLY","RANKS","GRAPH","PetscSFDuplicateOption","PETSCSF_DUPLICATE_",NULL};
2395fce210SBarry Smith 
247fd2d3dbSJunchao Zhang PETSC_STATIC_INLINE PetscErrorCode PetscGetMemType(const void *data,PetscMemType *type)
257fd2d3dbSJunchao Zhang {
267fd2d3dbSJunchao Zhang   PetscFunctionBegin;
277fd2d3dbSJunchao Zhang   PetscValidPointer(type,2);
287fd2d3dbSJunchao Zhang   *type = PETSC_MEMTYPE_HOST;
297fd2d3dbSJunchao Zhang #if defined(PETSC_HAVE_CUDA)
307fd2d3dbSJunchao Zhang   if (PetscCUDAInitialized && data) {
317fd2d3dbSJunchao Zhang     cudaError_t                  cerr;
327fd2d3dbSJunchao Zhang     struct cudaPointerAttributes attr;
337fd2d3dbSJunchao Zhang     enum cudaMemoryType          mtype;
347fd2d3dbSJunchao Zhang     cerr = cudaPointerGetAttributes(&attr,data); /* Do not check error since before CUDA 11.0, passing a host pointer returns cudaErrorInvalidValue */
357fd2d3dbSJunchao Zhang     cudaGetLastError(); /* Reset the last error */
367fd2d3dbSJunchao Zhang     #if (CUDART_VERSION < 10000)
377fd2d3dbSJunchao Zhang       mtype = attr.memoryType;
387fd2d3dbSJunchao Zhang     #else
397fd2d3dbSJunchao Zhang       mtype = attr.type;
407fd2d3dbSJunchao Zhang     #endif
417fd2d3dbSJunchao Zhang     if (cerr == cudaSuccess && mtype == cudaMemoryTypeDevice) *type = PETSC_MEMTYPE_DEVICE;
427fd2d3dbSJunchao Zhang   }
437fd2d3dbSJunchao Zhang #endif
447fd2d3dbSJunchao Zhang 
457fd2d3dbSJunchao Zhang #if defined(PETSC_HAVE_HIP)
467fd2d3dbSJunchao Zhang   if (PetscHIPInitialized && data) {
477fd2d3dbSJunchao Zhang     hipError_t                   cerr;
487fd2d3dbSJunchao Zhang     struct hipPointerAttribute_t attr;
497fd2d3dbSJunchao Zhang     enum hipMemoryType           mtype;
5059af0bd3SScott Kruger     cerr = hipPointerGetAttributes(&attr,data);
517fd2d3dbSJunchao Zhang     hipGetLastError(); /* Reset the last error */
527fd2d3dbSJunchao Zhang     mtype = attr.memoryType;
537fd2d3dbSJunchao Zhang     if (cerr == hipSuccess && mtype == hipMemoryTypeDevice) *type = PETSC_MEMTYPE_DEVICE;
547fd2d3dbSJunchao Zhang   }
557fd2d3dbSJunchao Zhang #endif
567fd2d3dbSJunchao Zhang   PetscFunctionReturn(0);
577fd2d3dbSJunchao Zhang }
587fd2d3dbSJunchao Zhang 
598af6ec1cSBarry Smith /*@
6095fce210SBarry Smith    PetscSFCreate - create a star forest communication context
6195fce210SBarry Smith 
62d083f849SBarry Smith    Collective
6395fce210SBarry Smith 
644165533cSJose E. Roman    Input Parameter:
6595fce210SBarry Smith .  comm - communicator on which the star forest will operate
6695fce210SBarry Smith 
674165533cSJose E. Roman    Output Parameter:
6895fce210SBarry Smith .  sf - new star forest context
6995fce210SBarry Smith 
70dd5b3ca6SJunchao Zhang    Options Database Keys:
71dd5b3ca6SJunchao Zhang +  -sf_type basic     -Use MPI persistent Isend/Irecv for communication (Default)
72dd5b3ca6SJunchao Zhang .  -sf_type window    -Use MPI-3 one-sided window for communication
73dd5b3ca6SJunchao Zhang -  -sf_type neighbor  -Use MPI-3 neighborhood collectives for communication
74dd5b3ca6SJunchao Zhang 
7595fce210SBarry Smith    Level: intermediate
7695fce210SBarry Smith 
77dd5b3ca6SJunchao Zhang    Notes:
78dd5b3ca6SJunchao Zhang    When one knows the communication graph is one of the predefined graph, such as MPI_Alltoall, MPI_Allgatherv,
79dd5b3ca6SJunchao Zhang    MPI_Gatherv, one can create a PetscSF and then set its graph with PetscSFSetGraphWithPattern(). These special
80dd5b3ca6SJunchao Zhang    SFs are optimized and they have better performance than general SFs.
81dd5b3ca6SJunchao Zhang 
82dd5b3ca6SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFSetGraphWithPattern(), PetscSFDestroy()
8395fce210SBarry Smith @*/
8495fce210SBarry Smith PetscErrorCode PetscSFCreate(MPI_Comm comm,PetscSF *sf)
8595fce210SBarry Smith {
8695fce210SBarry Smith   PetscErrorCode ierr;
8795fce210SBarry Smith   PetscSF        b;
8895fce210SBarry Smith 
8995fce210SBarry Smith   PetscFunctionBegin;
9095fce210SBarry Smith   PetscValidPointer(sf,2);
91607a6623SBarry Smith   ierr = PetscSFInitializePackage();CHKERRQ(ierr);
9295fce210SBarry Smith 
9373107ff1SLisandro Dalcin   ierr = PetscHeaderCreate(b,PETSCSF_CLASSID,"PetscSF","Star Forest","PetscSF",comm,PetscSFDestroy,PetscSFView);CHKERRQ(ierr);
9495fce210SBarry Smith 
9595fce210SBarry Smith   b->nroots    = -1;
9695fce210SBarry Smith   b->nleaves   = -1;
9729046d53SLisandro Dalcin   b->minleaf   = PETSC_MAX_INT;
9829046d53SLisandro Dalcin   b->maxleaf   = PETSC_MIN_INT;
9995fce210SBarry Smith   b->nranks    = -1;
10095fce210SBarry Smith   b->rankorder = PETSC_TRUE;
10195fce210SBarry Smith   b->ingroup   = MPI_GROUP_NULL;
10295fce210SBarry Smith   b->outgroup  = MPI_GROUP_NULL;
10395fce210SBarry Smith   b->graphset  = PETSC_FALSE;
10420c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
10520c24465SJunchao Zhang   b->use_gpu_aware_mpi    = use_gpu_aware_mpi;
10620c24465SJunchao Zhang   b->use_stream_aware_mpi = PETSC_FALSE;
10771438e86SJunchao Zhang   b->unknown_input_stream= PETSC_FALSE;
10827f636e8SJunchao Zhang   #if defined(PETSC_HAVE_KOKKOS) /* Prefer kokkos over cuda*/
10920c24465SJunchao Zhang     b->backend = PETSCSF_BACKEND_KOKKOS;
11027f636e8SJunchao Zhang   #elif defined(PETSC_HAVE_CUDA)
11127f636e8SJunchao Zhang     b->backend = PETSCSF_BACKEND_CUDA;
11259af0bd3SScott Kruger   #elif defined(PETSC_HAVE_HIP)
11359af0bd3SScott Kruger     b->backend = PETSCSF_BACKEND_HIP;
11420c24465SJunchao Zhang   #endif
11571438e86SJunchao Zhang 
11671438e86SJunchao Zhang   #if defined(PETSC_HAVE_NVSHMEM)
11771438e86SJunchao Zhang     b->use_nvshmem     = PETSC_FALSE; /* Default is not to try NVSHMEM */
11871438e86SJunchao Zhang     b->use_nvshmem_get = PETSC_FALSE; /* Default is to use nvshmem_put based protocol */
11971438e86SJunchao Zhang     ierr = PetscOptionsGetBool(NULL,NULL,"-use_nvshmem",&b->use_nvshmem,NULL);CHKERRQ(ierr);
12071438e86SJunchao Zhang     ierr = PetscOptionsGetBool(NULL,NULL,"-use_nvshmem_get",&b->use_nvshmem_get,NULL);CHKERRQ(ierr);
12171438e86SJunchao Zhang   #endif
12220c24465SJunchao Zhang #endif
12360c22052SBarry Smith   b->vscat.from_n = -1;
12460c22052SBarry Smith   b->vscat.to_n   = -1;
12560c22052SBarry Smith   b->vscat.unit   = MPIU_SCALAR;
12695fce210SBarry Smith  *sf = b;
12795fce210SBarry Smith   PetscFunctionReturn(0);
12895fce210SBarry Smith }
12995fce210SBarry Smith 
13029046d53SLisandro Dalcin /*@
13195fce210SBarry Smith    PetscSFReset - Reset a star forest so that different sizes or neighbors can be used
13295fce210SBarry Smith 
13395fce210SBarry Smith    Collective
13495fce210SBarry Smith 
1354165533cSJose E. Roman    Input Parameter:
13695fce210SBarry Smith .  sf - star forest
13795fce210SBarry Smith 
13895fce210SBarry Smith    Level: advanced
13995fce210SBarry Smith 
14095fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph(), PetscSFDestroy()
14195fce210SBarry Smith @*/
14295fce210SBarry Smith PetscErrorCode PetscSFReset(PetscSF sf)
14395fce210SBarry Smith {
14495fce210SBarry Smith   PetscErrorCode ierr;
14595fce210SBarry Smith 
14695fce210SBarry Smith   PetscFunctionBegin;
14795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
14879715d56SJed Brown   if (sf->ops->Reset) {ierr = (*sf->ops->Reset)(sf);CHKERRQ(ierr);}
14929046d53SLisandro Dalcin   sf->nroots   = -1;
15029046d53SLisandro Dalcin   sf->nleaves  = -1;
15129046d53SLisandro Dalcin   sf->minleaf  = PETSC_MAX_INT;
15229046d53SLisandro Dalcin   sf->maxleaf  = PETSC_MIN_INT;
15395fce210SBarry Smith   sf->mine     = NULL;
15495fce210SBarry Smith   sf->remote   = NULL;
15529046d53SLisandro Dalcin   sf->graphset = PETSC_FALSE;
15629046d53SLisandro Dalcin   ierr = PetscFree(sf->mine_alloc);CHKERRQ(ierr);
15795fce210SBarry Smith   ierr = PetscFree(sf->remote_alloc);CHKERRQ(ierr);
15821c688dcSJed Brown   sf->nranks = -1;
15929046d53SLisandro Dalcin   ierr = PetscFree4(sf->ranks,sf->roffset,sf->rmine,sf->rremote);CHKERRQ(ierr);
16029046d53SLisandro Dalcin   sf->degreeknown = PETSC_FALSE;
16195fce210SBarry Smith   ierr = PetscFree(sf->degree);CHKERRQ(ierr);
162ffc4695bSBarry Smith   if (sf->ingroup  != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->ingroup);CHKERRMPI(ierr);}
163ffc4695bSBarry Smith   if (sf->outgroup != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->outgroup);CHKERRMPI(ierr);}
164013b3241SStefano Zampini   if (sf->multi) sf->multi->multi = NULL;
16595fce210SBarry Smith   ierr = PetscSFDestroy(&sf->multi);CHKERRQ(ierr);
166dd5b3ca6SJunchao Zhang   ierr = PetscLayoutDestroy(&sf->map);CHKERRQ(ierr);
16771438e86SJunchao Zhang 
16871438e86SJunchao Zhang  #if defined(PETSC_HAVE_DEVICE)
16971438e86SJunchao Zhang   for (PetscInt i=0; i<2; i++) {ierr = PetscSFFree(sf,PETSC_MEMTYPE_DEVICE,sf->rmine_d[i]);CHKERRQ(ierr);}
17071438e86SJunchao Zhang  #endif
17171438e86SJunchao Zhang 
17295fce210SBarry Smith   sf->setupcalled = PETSC_FALSE;
17395fce210SBarry Smith   PetscFunctionReturn(0);
17495fce210SBarry Smith }
17595fce210SBarry Smith 
17695fce210SBarry Smith /*@C
17729046d53SLisandro Dalcin    PetscSFSetType - Set the PetscSF communication implementation
17895fce210SBarry Smith 
17995fce210SBarry Smith    Collective on PetscSF
18095fce210SBarry Smith 
18195fce210SBarry Smith    Input Parameters:
18295fce210SBarry Smith +  sf - the PetscSF context
18395fce210SBarry Smith -  type - a known method
18495fce210SBarry Smith 
18595fce210SBarry Smith    Options Database Key:
18695fce210SBarry Smith .  -sf_type <type> - Sets the method; use -help for a list
18770616304SStefano Zampini    of available methods (for instance, window, basic, neighbor)
18895fce210SBarry Smith 
18995fce210SBarry Smith    Notes:
19095fce210SBarry Smith    See "include/petscsf.h" for available methods (for instance)
19195fce210SBarry Smith +    PETSCSFWINDOW - MPI-2/3 one-sided
19295fce210SBarry Smith -    PETSCSFBASIC - basic implementation using MPI-1 two-sided
19395fce210SBarry Smith 
19495fce210SBarry Smith   Level: intermediate
19595fce210SBarry Smith 
19695fce210SBarry Smith .seealso: PetscSFType, PetscSFCreate()
19795fce210SBarry Smith @*/
19895fce210SBarry Smith PetscErrorCode PetscSFSetType(PetscSF sf,PetscSFType type)
19995fce210SBarry Smith {
20095fce210SBarry Smith   PetscErrorCode ierr,(*r)(PetscSF);
20195fce210SBarry Smith   PetscBool      match;
20295fce210SBarry Smith 
20395fce210SBarry Smith   PetscFunctionBegin;
20495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
20595fce210SBarry Smith   PetscValidCharPointer(type,2);
20695fce210SBarry Smith 
20795fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)sf,type,&match);CHKERRQ(ierr);
20895fce210SBarry Smith   if (match) PetscFunctionReturn(0);
20995fce210SBarry Smith 
210adc40e5bSBarry Smith   ierr = PetscFunctionListFind(PetscSFList,type,&r);CHKERRQ(ierr);
21195fce210SBarry Smith   if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested PetscSF type %s",type);
21229046d53SLisandro Dalcin   /* Destroy the previous PetscSF implementation context */
21329046d53SLisandro Dalcin   if (sf->ops->Destroy) {ierr = (*(sf)->ops->Destroy)(sf);CHKERRQ(ierr);}
21495fce210SBarry Smith   ierr = PetscMemzero(sf->ops,sizeof(*sf->ops));CHKERRQ(ierr);
21595fce210SBarry Smith   ierr = PetscObjectChangeTypeName((PetscObject)sf,type);CHKERRQ(ierr);
21695fce210SBarry Smith   ierr = (*r)(sf);CHKERRQ(ierr);
21795fce210SBarry Smith   PetscFunctionReturn(0);
21895fce210SBarry Smith }
21995fce210SBarry Smith 
22029046d53SLisandro Dalcin /*@C
22129046d53SLisandro Dalcin   PetscSFGetType - Get the PetscSF communication implementation
22229046d53SLisandro Dalcin 
22329046d53SLisandro Dalcin   Not Collective
22429046d53SLisandro Dalcin 
22529046d53SLisandro Dalcin   Input Parameter:
22629046d53SLisandro Dalcin . sf  - the PetscSF context
22729046d53SLisandro Dalcin 
22829046d53SLisandro Dalcin   Output Parameter:
22929046d53SLisandro Dalcin . type - the PetscSF type name
23029046d53SLisandro Dalcin 
23129046d53SLisandro Dalcin   Level: intermediate
23229046d53SLisandro Dalcin 
23329046d53SLisandro Dalcin .seealso: PetscSFSetType(), PetscSFCreate()
23429046d53SLisandro Dalcin @*/
23529046d53SLisandro Dalcin PetscErrorCode PetscSFGetType(PetscSF sf, PetscSFType *type)
23629046d53SLisandro Dalcin {
23729046d53SLisandro Dalcin   PetscFunctionBegin;
23829046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf, PETSCSF_CLASSID,1);
23929046d53SLisandro Dalcin   PetscValidPointer(type,2);
24029046d53SLisandro Dalcin   *type = ((PetscObject)sf)->type_name;
24129046d53SLisandro Dalcin   PetscFunctionReturn(0);
24229046d53SLisandro Dalcin }
24329046d53SLisandro Dalcin 
2441fb7b255SJunchao Zhang /*@C
24595fce210SBarry Smith    PetscSFDestroy - destroy star forest
24695fce210SBarry Smith 
24795fce210SBarry Smith    Collective
24895fce210SBarry Smith 
2494165533cSJose E. Roman    Input Parameter:
25095fce210SBarry Smith .  sf - address of star forest
25195fce210SBarry Smith 
25295fce210SBarry Smith    Level: intermediate
25395fce210SBarry Smith 
25495fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFReset()
25595fce210SBarry Smith @*/
25695fce210SBarry Smith PetscErrorCode PetscSFDestroy(PetscSF *sf)
25795fce210SBarry Smith {
25895fce210SBarry Smith   PetscErrorCode ierr;
25995fce210SBarry Smith 
26095fce210SBarry Smith   PetscFunctionBegin;
26195fce210SBarry Smith   if (!*sf) PetscFunctionReturn(0);
26295fce210SBarry Smith   PetscValidHeaderSpecific((*sf),PETSCSF_CLASSID,1);
26329046d53SLisandro Dalcin   if (--((PetscObject)(*sf))->refct > 0) {*sf = NULL; PetscFunctionReturn(0);}
26495fce210SBarry Smith   ierr = PetscSFReset(*sf);CHKERRQ(ierr);
26595fce210SBarry Smith   if ((*sf)->ops->Destroy) {ierr = (*(*sf)->ops->Destroy)(*sf);CHKERRQ(ierr);}
26697929ea7SJunchao Zhang   ierr = PetscSFDestroy(&(*sf)->vscat.lsf);CHKERRQ(ierr);
26755b25c41SPierre Jolivet   if ((*sf)->vscat.bs > 1) {ierr = MPI_Type_free(&(*sf)->vscat.unit);CHKERRMPI(ierr);}
26895fce210SBarry Smith   ierr = PetscHeaderDestroy(sf);CHKERRQ(ierr);
26995fce210SBarry Smith   PetscFunctionReturn(0);
27095fce210SBarry Smith }
27195fce210SBarry Smith 
272c4e6a40aSLawrence Mitchell static PetscErrorCode PetscSFCheckGraphValid_Private(PetscSF sf)
273c4e6a40aSLawrence Mitchell {
274c4e6a40aSLawrence Mitchell   PetscInt           i, nleaves;
275c4e6a40aSLawrence Mitchell   PetscMPIInt        size;
276c4e6a40aSLawrence Mitchell   const PetscInt    *ilocal;
277c4e6a40aSLawrence Mitchell   const PetscSFNode *iremote;
278c4e6a40aSLawrence Mitchell   PetscErrorCode     ierr;
279c4e6a40aSLawrence Mitchell 
280c4e6a40aSLawrence Mitchell   PetscFunctionBegin;
28176bd3646SJed Brown   if (!sf->graphset || !PetscDefined(USE_DEBUG)) PetscFunctionReturn(0);
282c4e6a40aSLawrence Mitchell   ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
283ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRMPI(ierr);
284c4e6a40aSLawrence Mitchell   for (i = 0; i < nleaves; i++) {
285c4e6a40aSLawrence Mitchell     const PetscInt rank = iremote[i].rank;
286c4e6a40aSLawrence Mitchell     const PetscInt remote = iremote[i].index;
287c4e6a40aSLawrence Mitchell     const PetscInt leaf = ilocal ? ilocal[i] : i;
288c4e6a40aSLawrence Mitchell     if (rank < 0 || rank >= size) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided rank (%D) for remote %D is invalid, should be in [0, %d)",rank,i,size);
289c4e6a40aSLawrence Mitchell     if (remote < 0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided index (%D) for remote %D is invalid, should be >= 0",remote,i);
290c4e6a40aSLawrence Mitchell     if (leaf < 0) SETERRQ2(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided location (%D) for leaf %D is invalid, should be >= 0",leaf,i);
291c4e6a40aSLawrence Mitchell   }
292c4e6a40aSLawrence Mitchell   PetscFunctionReturn(0);
293c4e6a40aSLawrence Mitchell }
294c4e6a40aSLawrence Mitchell 
29595fce210SBarry Smith /*@
29695fce210SBarry Smith    PetscSFSetUp - set up communication structures
29795fce210SBarry Smith 
29895fce210SBarry Smith    Collective
29995fce210SBarry Smith 
3004165533cSJose E. Roman    Input Parameter:
30195fce210SBarry Smith .  sf - star forest communication object
30295fce210SBarry Smith 
30395fce210SBarry Smith    Level: beginner
30495fce210SBarry Smith 
30595fce210SBarry Smith .seealso: PetscSFSetFromOptions(), PetscSFSetType()
30695fce210SBarry Smith @*/
30795fce210SBarry Smith PetscErrorCode PetscSFSetUp(PetscSF sf)
30895fce210SBarry Smith {
30995fce210SBarry Smith   PetscErrorCode ierr;
31095fce210SBarry Smith 
31195fce210SBarry Smith   PetscFunctionBegin;
31229046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
31329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
31495fce210SBarry Smith   if (sf->setupcalled) PetscFunctionReturn(0);
31529046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr);
31620c24465SJunchao Zhang   ierr = PetscSFCheckGraphValid_Private(sf);CHKERRQ(ierr);
31720c24465SJunchao Zhang   if (!((PetscObject)sf)->type_name) {ierr = PetscSFSetType(sf,PETSCSFBASIC);CHKERRQ(ierr);} /* Zero all sf->ops */
31895fce210SBarry Smith   if (sf->ops->SetUp) {ierr = (*sf->ops->SetUp)(sf);CHKERRQ(ierr);}
31920c24465SJunchao Zhang #if defined(PETSC_HAVE_CUDA)
32020c24465SJunchao Zhang   if (sf->backend == PETSCSF_BACKEND_CUDA) {
32171438e86SJunchao Zhang     sf->ops->Malloc = PetscSFMalloc_CUDA;
32271438e86SJunchao Zhang     sf->ops->Free   = PetscSFFree_CUDA;
32320c24465SJunchao Zhang   }
32420c24465SJunchao Zhang #endif
32559af0bd3SScott Kruger #if defined(PETSC_HAVE_HIP)
32659af0bd3SScott Kruger   if (sf->backend == PETSCSF_BACKEND_HIP) {
32759af0bd3SScott Kruger     sf->ops->Malloc = PetscSFMalloc_HIP;
32859af0bd3SScott Kruger     sf->ops->Free   = PetscSFFree_HIP;
32959af0bd3SScott Kruger   }
33059af0bd3SScott Kruger #endif
33120c24465SJunchao Zhang 
33259af0bd3SScott Kruger #
33320c24465SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS)
33420c24465SJunchao Zhang   if (sf->backend == PETSCSF_BACKEND_KOKKOS) {
33520c24465SJunchao Zhang     sf->ops->Malloc = PetscSFMalloc_Kokkos;
33620c24465SJunchao Zhang     sf->ops->Free   = PetscSFFree_Kokkos;
33720c24465SJunchao Zhang   }
33820c24465SJunchao Zhang #endif
33929046d53SLisandro Dalcin   ierr = PetscLogEventEnd(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr);
34095fce210SBarry Smith   sf->setupcalled = PETSC_TRUE;
34195fce210SBarry Smith   PetscFunctionReturn(0);
34295fce210SBarry Smith }
34395fce210SBarry Smith 
3448af6ec1cSBarry Smith /*@
34595fce210SBarry Smith    PetscSFSetFromOptions - set PetscSF options using the options database
34695fce210SBarry Smith 
34795fce210SBarry Smith    Logically Collective
34895fce210SBarry Smith 
3494165533cSJose E. Roman    Input Parameter:
35095fce210SBarry Smith .  sf - star forest
35195fce210SBarry Smith 
35295fce210SBarry Smith    Options Database Keys:
35360263706SJed Brown +  -sf_type               - implementation type, see PetscSFSetType()
35451ccb202SJunchao Zhang .  -sf_rank_order         - sort composite points for gathers and scatters in rank order, gathers are non-deterministic otherwise
355b85e67b7SJunchao Zhang .  -sf_use_default_stream - Assume callers of SF computed the input root/leafdata with the default cuda stream. SF will also
356c2a741eeSJunchao Zhang                             use the default stream to process data. Therefore, no stream synchronization is needed between SF and its caller (default: true).
357c06a8e02SRichard Tran Mills                             If true, this option only works with -use_gpu_aware_mpi 1.
35820c24465SJunchao Zhang .  -sf_use_stream_aware_mpi  - Assume the underlying MPI is cuda-stream aware and SF won't sync streams for send/recv buffers passed to MPI (default: false).
359c06a8e02SRichard Tran Mills                                If true, this option only works with -use_gpu_aware_mpi 1.
36095fce210SBarry Smith 
36159af0bd3SScott Kruger -  -sf_backend cuda | hip | kokkos -Select the device backend SF uses. Currently SF has these backends: cuda, hip and Kokkos.
36259af0bd3SScott Kruger                               On CUDA (HIP) devices, one can choose cuda (hip) or kokkos with the default being kokkos. On other devices,
36320c24465SJunchao Zhang                               the only available is kokkos.
36420c24465SJunchao Zhang 
36595fce210SBarry Smith    Level: intermediate
36695fce210SBarry Smith @*/
36795fce210SBarry Smith PetscErrorCode PetscSFSetFromOptions(PetscSF sf)
36895fce210SBarry Smith {
36995fce210SBarry Smith   PetscSFType    deft;
37095fce210SBarry Smith   char           type[256];
37195fce210SBarry Smith   PetscErrorCode ierr;
37295fce210SBarry Smith   PetscBool      flg;
37395fce210SBarry Smith 
37495fce210SBarry Smith   PetscFunctionBegin;
37595fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
37695fce210SBarry Smith   ierr = PetscObjectOptionsBegin((PetscObject)sf);CHKERRQ(ierr);
37795fce210SBarry Smith   deft = ((PetscObject)sf)->type_name ? ((PetscObject)sf)->type_name : PETSCSFBASIC;
37829046d53SLisandro Dalcin   ierr = PetscOptionsFList("-sf_type","PetscSF implementation type","PetscSFSetType",PetscSFList,deft,type,sizeof(type),&flg);CHKERRQ(ierr);
37995fce210SBarry Smith   ierr = PetscSFSetType(sf,flg ? type : deft);CHKERRQ(ierr);
38095fce210SBarry 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);
3817fd2d3dbSJunchao Zhang  #if defined(PETSC_HAVE_DEVICE)
38220c24465SJunchao Zhang   {
38320c24465SJunchao Zhang     char        backendstr[32] = {0};
38459af0bd3SScott Kruger     PetscBool   isCuda = PETSC_FALSE,isHip = PETSC_FALSE,isKokkos = PETSC_FALSE,set;
38520c24465SJunchao Zhang     /* Change the defaults set in PetscSFCreate() with command line options */
38671438e86SJunchao Zhang     ierr = PetscOptionsBool("-sf_unknown_input_stream","SF root/leafdata is computed on arbitary streams unknown to SF","PetscSFSetFromOptions",sf->unknown_input_stream,&sf->unknown_input_stream,NULL);CHKERRQ(ierr);
387b85e67b7SJunchao Zhang     ierr = PetscOptionsBool("-sf_use_stream_aware_mpi","Assume the underlying MPI is cuda-stream aware","PetscSFSetFromOptions",sf->use_stream_aware_mpi,&sf->use_stream_aware_mpi,NULL);CHKERRQ(ierr);
38820c24465SJunchao Zhang     ierr = PetscOptionsString("-sf_backend","Select the device backend SF uses","PetscSFSetFromOptions",NULL,backendstr,sizeof(backendstr),&set);CHKERRQ(ierr);
38920c24465SJunchao Zhang     ierr = PetscStrcasecmp("cuda",backendstr,&isCuda);CHKERRQ(ierr);
39020c24465SJunchao Zhang     ierr = PetscStrcasecmp("kokkos",backendstr,&isKokkos);CHKERRQ(ierr);
39159af0bd3SScott Kruger     ierr = PetscStrcasecmp("hip",backendstr,&isHip);CHKERRQ(ierr);
39259af0bd3SScott Kruger   #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP)
39320c24465SJunchao Zhang     if (isCuda) sf->backend = PETSCSF_BACKEND_CUDA;
39420c24465SJunchao Zhang     else if (isKokkos) sf->backend = PETSCSF_BACKEND_KOKKOS;
39559af0bd3SScott Kruger     else if (isHip) sf->backend = PETSCSF_BACKEND_HIP;
39659af0bd3SScott Kruger     else if (set) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"-sf_backend %s is not supported. You may choose cuda, hip or kokkos (if installed)", backendstr);
39720c24465SJunchao Zhang   #elif defined(PETSC_HAVE_KOKKOS)
39820c24465SJunchao Zhang     if (set && !isKokkos) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"-sf_backend %s is not supported. You can only choose kokkos", backendstr);
39920c24465SJunchao Zhang    #endif
40020c24465SJunchao Zhang   }
401c2a741eeSJunchao Zhang  #endif
402e55864a3SBarry Smith   if (sf->ops->SetFromOptions) {ierr = (*sf->ops->SetFromOptions)(PetscOptionsObject,sf);CHKERRQ(ierr);}
40395fce210SBarry Smith   ierr = PetscOptionsEnd();CHKERRQ(ierr);
40495fce210SBarry Smith   PetscFunctionReturn(0);
40595fce210SBarry Smith }
40695fce210SBarry Smith 
40729046d53SLisandro Dalcin /*@
40895fce210SBarry Smith    PetscSFSetRankOrder - sort multi-points for gathers and scatters by rank order
40995fce210SBarry Smith 
41095fce210SBarry Smith    Logically Collective
41195fce210SBarry Smith 
4124165533cSJose E. Roman    Input Parameters:
41395fce210SBarry Smith +  sf - star forest
41495fce210SBarry Smith -  flg - PETSC_TRUE to sort, PETSC_FALSE to skip sorting (lower setup cost, but non-deterministic)
41595fce210SBarry Smith 
41695fce210SBarry Smith    Level: advanced
41795fce210SBarry Smith 
41895fce210SBarry Smith .seealso: PetscSFGatherBegin(), PetscSFScatterBegin()
41995fce210SBarry Smith @*/
42095fce210SBarry Smith PetscErrorCode PetscSFSetRankOrder(PetscSF sf,PetscBool flg)
42195fce210SBarry Smith {
42295fce210SBarry Smith   PetscFunctionBegin;
42395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
42495fce210SBarry Smith   PetscValidLogicalCollectiveBool(sf,flg,2);
42595fce210SBarry Smith   if (sf->multi) SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_WRONGSTATE,"Rank ordering must be set before first call to PetscSFGatherBegin() or PetscSFScatterBegin()");
42695fce210SBarry Smith   sf->rankorder = flg;
42795fce210SBarry Smith   PetscFunctionReturn(0);
42895fce210SBarry Smith }
42995fce210SBarry Smith 
430*8dbb0df6SBarry Smith /*@C
43195fce210SBarry Smith    PetscSFSetGraph - Set a parallel star forest
43295fce210SBarry Smith 
43395fce210SBarry Smith    Collective
43495fce210SBarry Smith 
4354165533cSJose E. Roman    Input Parameters:
43695fce210SBarry Smith +  sf - star forest
43795fce210SBarry Smith .  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
43895fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
439c4e6a40aSLawrence Mitchell .  ilocal - locations of leaves in leafdata buffers, pass NULL for contiguous storage (locations must be >= 0, enforced
440c4e6a40aSLawrence Mitchell during setup in debug mode)
44195fce210SBarry Smith .  localmode - copy mode for ilocal
442c4e6a40aSLawrence Mitchell .  iremote - remote locations of root vertices for each leaf on the current process (locations must be >= 0, enforced
443c4e6a40aSLawrence Mitchell during setup in debug mode)
44495fce210SBarry Smith -  remotemode - copy mode for iremote
44595fce210SBarry Smith 
44695fce210SBarry Smith    Level: intermediate
44795fce210SBarry Smith 
44895452b02SPatrick Sanan    Notes:
44995452b02SPatrick Sanan     In Fortran you must use PETSC_COPY_VALUES for localmode and remotemode
45038ab3f8aSBarry Smith 
4512ad1e87fSLisandro Dalcin    Developers Note: Local indices which are the identity permutation in the range [0,nleaves) are discarded as they
4522ad1e87fSLisandro Dalcin    encode contiguous storage. In such case, if localmode is PETSC_OWN_POINTER, the memory is deallocated as it is not
4532ad1e87fSLisandro Dalcin    needed
4542ad1e87fSLisandro Dalcin 
455c4e6a40aSLawrence Mitchell    Developers Note: This object does not necessarily encode a true star forest in the graph theoretic sense, since leaf
456c4e6a40aSLawrence Mitchell    indices are not required to be unique. Some functions, however, rely on unique leaf indices (checked in debug mode).
457c4e6a40aSLawrence Mitchell 
45895fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFGetGraph()
45995fce210SBarry Smith @*/
46095fce210SBarry Smith PetscErrorCode PetscSFSetGraph(PetscSF sf,PetscInt nroots,PetscInt nleaves,const PetscInt *ilocal,PetscCopyMode localmode,const PetscSFNode *iremote,PetscCopyMode remotemode)
46195fce210SBarry Smith {
46295fce210SBarry Smith   PetscErrorCode ierr;
46395fce210SBarry Smith 
46495fce210SBarry Smith   PetscFunctionBegin;
46595fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
46629046d53SLisandro Dalcin   if (nleaves > 0 && ilocal) PetscValidIntPointer(ilocal,4);
46729046d53SLisandro Dalcin   if (nleaves > 0) PetscValidPointer(iremote,6);
46829046d53SLisandro Dalcin   if (nroots  < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nroots %D, cannot be negative",nroots);
46995fce210SBarry Smith   if (nleaves < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nleaves %D, cannot be negative",nleaves);
47029046d53SLisandro Dalcin 
4712a67d2daSStefano Zampini   if (sf->nroots >= 0) { /* Reset only if graph already set */
47295fce210SBarry Smith     ierr = PetscSFReset(sf);CHKERRQ(ierr);
4732a67d2daSStefano Zampini   }
4742a67d2daSStefano Zampini 
47529046d53SLisandro Dalcin   ierr = PetscLogEventBegin(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
47629046d53SLisandro Dalcin 
47795fce210SBarry Smith   sf->nroots  = nroots;
47895fce210SBarry Smith   sf->nleaves = nleaves;
47929046d53SLisandro Dalcin 
48029046d53SLisandro Dalcin   if (nleaves && ilocal) {
48121c688dcSJed Brown     PetscInt i;
48229046d53SLisandro Dalcin     PetscInt minleaf = PETSC_MAX_INT;
48329046d53SLisandro Dalcin     PetscInt maxleaf = PETSC_MIN_INT;
4842ad1e87fSLisandro Dalcin     int      contiguous = 1;
48529046d53SLisandro Dalcin     for (i=0; i<nleaves; i++) {
48629046d53SLisandro Dalcin       minleaf = PetscMin(minleaf,ilocal[i]);
48729046d53SLisandro Dalcin       maxleaf = PetscMax(maxleaf,ilocal[i]);
4882ad1e87fSLisandro Dalcin       contiguous &= (ilocal[i] == i);
48929046d53SLisandro Dalcin     }
49029046d53SLisandro Dalcin     sf->minleaf = minleaf;
49129046d53SLisandro Dalcin     sf->maxleaf = maxleaf;
4922ad1e87fSLisandro Dalcin     if (contiguous) {
4932ad1e87fSLisandro Dalcin       if (localmode == PETSC_OWN_POINTER) {
4942ad1e87fSLisandro Dalcin         ierr = PetscFree(ilocal);CHKERRQ(ierr);
4952ad1e87fSLisandro Dalcin       }
4962ad1e87fSLisandro Dalcin       ilocal = NULL;
4972ad1e87fSLisandro Dalcin     }
49829046d53SLisandro Dalcin   } else {
49929046d53SLisandro Dalcin     sf->minleaf = 0;
50029046d53SLisandro Dalcin     sf->maxleaf = nleaves - 1;
50129046d53SLisandro Dalcin   }
50229046d53SLisandro Dalcin 
50329046d53SLisandro Dalcin   if (ilocal) {
50495fce210SBarry Smith     switch (localmode) {
50595fce210SBarry Smith     case PETSC_COPY_VALUES:
506785e854fSJed Brown       ierr = PetscMalloc1(nleaves,&sf->mine_alloc);CHKERRQ(ierr);
507580bdb30SBarry Smith       ierr = PetscArraycpy(sf->mine_alloc,ilocal,nleaves);CHKERRQ(ierr);
50895fce210SBarry Smith       sf->mine = sf->mine_alloc;
50995fce210SBarry Smith       break;
51095fce210SBarry Smith     case PETSC_OWN_POINTER:
51195fce210SBarry Smith       sf->mine_alloc = (PetscInt*)ilocal;
51295fce210SBarry Smith       sf->mine       = sf->mine_alloc;
51395fce210SBarry Smith       break;
51495fce210SBarry Smith     case PETSC_USE_POINTER:
51529046d53SLisandro Dalcin       sf->mine_alloc = NULL;
51695fce210SBarry Smith       sf->mine       = (PetscInt*)ilocal;
51795fce210SBarry Smith       break;
51895fce210SBarry Smith     default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown localmode");
51995fce210SBarry Smith     }
52095fce210SBarry Smith   }
52129046d53SLisandro Dalcin 
52295fce210SBarry Smith   switch (remotemode) {
52395fce210SBarry Smith   case PETSC_COPY_VALUES:
524785e854fSJed Brown     ierr = PetscMalloc1(nleaves,&sf->remote_alloc);CHKERRQ(ierr);
525580bdb30SBarry Smith     ierr = PetscArraycpy(sf->remote_alloc,iremote,nleaves);CHKERRQ(ierr);
52695fce210SBarry Smith     sf->remote = sf->remote_alloc;
52795fce210SBarry Smith     break;
52895fce210SBarry Smith   case PETSC_OWN_POINTER:
52995fce210SBarry Smith     sf->remote_alloc = (PetscSFNode*)iremote;
53095fce210SBarry Smith     sf->remote       = sf->remote_alloc;
53195fce210SBarry Smith     break;
53295fce210SBarry Smith   case PETSC_USE_POINTER:
53329046d53SLisandro Dalcin     sf->remote_alloc = NULL;
53495fce210SBarry Smith     sf->remote       = (PetscSFNode*)iremote;
53595fce210SBarry Smith     break;
53695fce210SBarry Smith   default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown remotemode");
53795fce210SBarry Smith   }
53895fce210SBarry Smith 
539563ffbabSMatthew G. Knepley   ierr = PetscLogEventEnd(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr);
54029046d53SLisandro Dalcin   sf->graphset = PETSC_TRUE;
54195fce210SBarry Smith   PetscFunctionReturn(0);
54295fce210SBarry Smith }
54395fce210SBarry Smith 
54429046d53SLisandro Dalcin /*@
545dd5b3ca6SJunchao Zhang   PetscSFSetGraphWithPattern - Sets the graph of an SF with a specific pattern
546dd5b3ca6SJunchao Zhang 
547dd5b3ca6SJunchao Zhang   Collective
548dd5b3ca6SJunchao Zhang 
549dd5b3ca6SJunchao Zhang   Input Parameters:
550dd5b3ca6SJunchao Zhang + sf      - The PetscSF
551dd5b3ca6SJunchao Zhang . map     - Layout of roots over all processes (insignificant when pattern is PETSCSF_PATTERN_ALLTOALL)
552dd5b3ca6SJunchao Zhang - pattern - One of PETSCSF_PATTERN_ALLGATHER, PETSCSF_PATTERN_GATHER, PETSCSF_PATTERN_ALLTOALL
553dd5b3ca6SJunchao Zhang 
554dd5b3ca6SJunchao Zhang   Notes:
555dd5b3ca6SJunchao Zhang   It is easier to explain PetscSFPattern using vectors. Suppose we have an MPI vector x and its layout is map.
556dd5b3ca6SJunchao Zhang   n and N are local and global sizes of x respectively.
557dd5b3ca6SJunchao Zhang 
558dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_ALLGATHER, the routine creates a graph that if one does Bcast on it, it will copy x to
559dd5b3ca6SJunchao Zhang   sequential vectors y on all ranks.
560dd5b3ca6SJunchao Zhang 
561dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_GATHER, the routine creates a graph that if one does Bcast on it, it will copy x to a
562dd5b3ca6SJunchao Zhang   sequential vector y on rank 0.
563dd5b3ca6SJunchao Zhang 
564dd5b3ca6SJunchao Zhang   In above cases, entries of x are roots and entries of y are leaves.
565dd5b3ca6SJunchao Zhang 
566dd5b3ca6SJunchao Zhang   With PETSCSF_PATTERN_ALLTOALL, map is insignificant. Suppose NP is size of sf's communicator. The routine
567dd5b3ca6SJunchao Zhang   creates a graph that every rank has NP leaves and NP roots. On rank i, its leaf j is connected to root i
568dd5b3ca6SJunchao Zhang   of rank j. Here 0 <=i,j<NP. It is a kind of MPI_Alltoall with sendcount/recvcount being 1. Note that it does
569dd5b3ca6SJunchao Zhang   not mean one can not send multiple items. One just needs to create a new MPI datatype for the mulptiple data
570dd5b3ca6SJunchao Zhang   items with MPI_Type_contiguous() and use that as the <unit> argument in SF routines.
571dd5b3ca6SJunchao Zhang 
572dd5b3ca6SJunchao Zhang   In this case, roots and leaves are symmetric.
573dd5b3ca6SJunchao Zhang 
574dd5b3ca6SJunchao Zhang   Level: intermediate
575dd5b3ca6SJunchao Zhang  @*/
576dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFSetGraphWithPattern(PetscSF sf,PetscLayout map,PetscSFPattern pattern)
577dd5b3ca6SJunchao Zhang {
578dd5b3ca6SJunchao Zhang   MPI_Comm       comm;
579dd5b3ca6SJunchao Zhang   PetscInt       n,N,res[2];
580dd5b3ca6SJunchao Zhang   PetscMPIInt    rank,size;
581dd5b3ca6SJunchao Zhang   PetscSFType    type;
582dd5b3ca6SJunchao Zhang   PetscErrorCode ierr;
583dd5b3ca6SJunchao Zhang 
584dd5b3ca6SJunchao Zhang   PetscFunctionBegin;
585dd5b3ca6SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf, &comm);CHKERRQ(ierr);
586dd5b3ca6SJunchao Zhang   if (pattern < PETSCSF_PATTERN_ALLGATHER || pattern > PETSCSF_PATTERN_ALLTOALL) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unsupported PetscSFPattern %D\n",pattern);
587ffc4695bSBarry Smith   ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr);
588ffc4695bSBarry Smith   ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr);
589dd5b3ca6SJunchao Zhang 
590dd5b3ca6SJunchao Zhang   if (pattern == PETSCSF_PATTERN_ALLTOALL) {
591dd5b3ca6SJunchao Zhang     type = PETSCSFALLTOALL;
592dd5b3ca6SJunchao Zhang     ierr = PetscLayoutCreate(comm,&sf->map);CHKERRQ(ierr);
593dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetLocalSize(sf->map,size);CHKERRQ(ierr);
594dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetSize(sf->map,((PetscInt)size)*size);CHKERRQ(ierr);
595dd5b3ca6SJunchao Zhang     ierr = PetscLayoutSetUp(sf->map);CHKERRQ(ierr);
596dd5b3ca6SJunchao Zhang   } else {
597dd5b3ca6SJunchao Zhang     ierr   = PetscLayoutGetLocalSize(map,&n);CHKERRQ(ierr);
598dd5b3ca6SJunchao Zhang     ierr   = PetscLayoutGetSize(map,&N);CHKERRQ(ierr);
599dd5b3ca6SJunchao Zhang     res[0] = n;
600dd5b3ca6SJunchao Zhang     res[1] = -n;
601dd5b3ca6SJunchao Zhang     /* Check if n are same over all ranks so that we can optimize it */
602820f2d46SBarry Smith     ierr   = MPIU_Allreduce(MPI_IN_PLACE,res,2,MPIU_INT,MPI_MAX,comm);CHKERRMPI(ierr);
603dd5b3ca6SJunchao Zhang     if (res[0] == -res[1]) { /* same n */
604dd5b3ca6SJunchao Zhang       type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHER  : PETSCSFGATHER;
605dd5b3ca6SJunchao Zhang     } else {
606dd5b3ca6SJunchao Zhang       type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHERV : PETSCSFGATHERV;
607dd5b3ca6SJunchao Zhang     }
608dd5b3ca6SJunchao Zhang     ierr = PetscLayoutReference(map,&sf->map);CHKERRQ(ierr);
609dd5b3ca6SJunchao Zhang   }
610dd5b3ca6SJunchao Zhang   ierr = PetscSFSetType(sf,type);CHKERRQ(ierr);
611dd5b3ca6SJunchao Zhang 
612dd5b3ca6SJunchao Zhang   sf->pattern = pattern;
613dd5b3ca6SJunchao Zhang   sf->mine    = NULL; /* Contiguous */
614dd5b3ca6SJunchao Zhang 
615dd5b3ca6SJunchao Zhang   /* Set nleaves, nroots here in case user calls PetscSFGetGraph, which is legal to call even before PetscSFSetUp is called.
616dd5b3ca6SJunchao Zhang      Also set other easy stuff.
617dd5b3ca6SJunchao Zhang    */
618dd5b3ca6SJunchao Zhang   if (pattern == PETSCSF_PATTERN_ALLGATHER) {
619dd5b3ca6SJunchao Zhang     sf->nleaves      = N;
620dd5b3ca6SJunchao Zhang     sf->nroots       = n;
621dd5b3ca6SJunchao Zhang     sf->nranks       = size;
622dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
623dd5b3ca6SJunchao Zhang     sf->maxleaf      = N - 1;
624dd5b3ca6SJunchao Zhang   } else if (pattern == PETSCSF_PATTERN_GATHER) {
625dd5b3ca6SJunchao Zhang     sf->nleaves      = rank ? 0 : N;
626dd5b3ca6SJunchao Zhang     sf->nroots       = n;
627dd5b3ca6SJunchao Zhang     sf->nranks       = rank ? 0 : size;
628dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
629dd5b3ca6SJunchao Zhang     sf->maxleaf      = rank ? -1 : N - 1;
630dd5b3ca6SJunchao Zhang   } else if (pattern == PETSCSF_PATTERN_ALLTOALL) {
631dd5b3ca6SJunchao Zhang     sf->nleaves      = size;
632dd5b3ca6SJunchao Zhang     sf->nroots       = size;
633dd5b3ca6SJunchao Zhang     sf->nranks       = size;
634dd5b3ca6SJunchao Zhang     sf->minleaf      = 0;
635dd5b3ca6SJunchao Zhang     sf->maxleaf      = size - 1;
636dd5b3ca6SJunchao Zhang   }
637dd5b3ca6SJunchao Zhang   sf->ndranks  = 0; /* We do not need to separate out distinguished ranks for patterned graphs to improve communication performance */
638dd5b3ca6SJunchao Zhang   sf->graphset = PETSC_TRUE;
639dd5b3ca6SJunchao Zhang   PetscFunctionReturn(0);
640dd5b3ca6SJunchao Zhang }
641dd5b3ca6SJunchao Zhang 
642dd5b3ca6SJunchao Zhang /*@
64395fce210SBarry Smith    PetscSFCreateInverseSF - given a PetscSF in which all vertices have degree 1, creates the inverse map
64495fce210SBarry Smith 
64595fce210SBarry Smith    Collective
64695fce210SBarry Smith 
6474165533cSJose E. Roman    Input Parameter:
64895fce210SBarry Smith .  sf - star forest to invert
64995fce210SBarry Smith 
6504165533cSJose E. Roman    Output Parameter:
65195fce210SBarry Smith .  isf - inverse of sf
6524165533cSJose E. Roman 
65395fce210SBarry Smith    Level: advanced
65495fce210SBarry Smith 
65595fce210SBarry Smith    Notes:
65695fce210SBarry Smith    All roots must have degree 1.
65795fce210SBarry Smith 
65895fce210SBarry Smith    The local space may be a permutation, but cannot be sparse.
65995fce210SBarry Smith 
66095fce210SBarry Smith .seealso: PetscSFSetGraph()
66195fce210SBarry Smith @*/
66295fce210SBarry Smith PetscErrorCode PetscSFCreateInverseSF(PetscSF sf,PetscSF *isf)
66395fce210SBarry Smith {
66495fce210SBarry Smith   PetscErrorCode ierr;
66595fce210SBarry Smith   PetscMPIInt    rank;
66695fce210SBarry Smith   PetscInt       i,nroots,nleaves,maxlocal,count,*newilocal;
66795fce210SBarry Smith   const PetscInt *ilocal;
66895fce210SBarry Smith   PetscSFNode    *roots,*leaves;
66995fce210SBarry Smith 
67095fce210SBarry Smith   PetscFunctionBegin;
67129046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
67229046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
67329046d53SLisandro Dalcin   PetscValidPointer(isf,2);
67429046d53SLisandro Dalcin 
67595fce210SBarry Smith   ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
67629046d53SLisandro Dalcin   maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
67729046d53SLisandro Dalcin 
678ffc4695bSBarry Smith   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr);
679ae9aee6dSMatthew G. Knepley   ierr = PetscMalloc2(nroots,&roots,maxlocal,&leaves);CHKERRQ(ierr);
680ae9aee6dSMatthew G. Knepley   for (i=0; i<maxlocal; i++) {
68195fce210SBarry Smith     leaves[i].rank  = rank;
68295fce210SBarry Smith     leaves[i].index = i;
68395fce210SBarry Smith   }
68495fce210SBarry Smith   for (i=0; i <nroots; i++) {
68595fce210SBarry Smith     roots[i].rank  = -1;
68695fce210SBarry Smith     roots[i].index = -1;
68795fce210SBarry Smith   }
68883df288dSJunchao Zhang   ierr = PetscSFReduceBegin(sf,MPIU_2INT,leaves,roots,MPI_REPLACE);CHKERRQ(ierr);
68983df288dSJunchao Zhang   ierr = PetscSFReduceEnd(sf,MPIU_2INT,leaves,roots,MPI_REPLACE);CHKERRQ(ierr);
69095fce210SBarry Smith 
69195fce210SBarry Smith   /* Check whether our leaves are sparse */
69295fce210SBarry Smith   for (i=0,count=0; i<nroots; i++) if (roots[i].rank >= 0) count++;
69395fce210SBarry Smith   if (count == nroots) newilocal = NULL;
69495fce210SBarry Smith   else {                        /* Index for sparse leaves and compact "roots" array (which is to become our leaves). */
695785e854fSJed Brown     ierr = PetscMalloc1(count,&newilocal);CHKERRQ(ierr);
69695fce210SBarry Smith     for (i=0,count=0; i<nroots; i++) {
69795fce210SBarry Smith       if (roots[i].rank >= 0) {
69895fce210SBarry Smith         newilocal[count]   = i;
69995fce210SBarry Smith         roots[count].rank  = roots[i].rank;
70095fce210SBarry Smith         roots[count].index = roots[i].index;
70195fce210SBarry Smith         count++;
70295fce210SBarry Smith       }
70395fce210SBarry Smith     }
70495fce210SBarry Smith   }
70595fce210SBarry Smith 
70695fce210SBarry Smith   ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,isf);CHKERRQ(ierr);
70795fce210SBarry Smith   ierr = PetscSFSetGraph(*isf,maxlocal,count,newilocal,PETSC_OWN_POINTER,roots,PETSC_COPY_VALUES);CHKERRQ(ierr);
70895fce210SBarry Smith   ierr = PetscFree2(roots,leaves);CHKERRQ(ierr);
70995fce210SBarry Smith   PetscFunctionReturn(0);
71095fce210SBarry Smith }
71195fce210SBarry Smith 
71295fce210SBarry Smith /*@
71395fce210SBarry Smith    PetscSFDuplicate - duplicate a PetscSF, optionally preserving rank connectivity and graph
71495fce210SBarry Smith 
71595fce210SBarry Smith    Collective
71695fce210SBarry Smith 
7174165533cSJose E. Roman    Input Parameters:
71895fce210SBarry Smith +  sf - communication object to duplicate
71995fce210SBarry Smith -  opt - PETSCSF_DUPLICATE_CONFONLY, PETSCSF_DUPLICATE_RANKS, or PETSCSF_DUPLICATE_GRAPH (see PetscSFDuplicateOption)
72095fce210SBarry Smith 
7214165533cSJose E. Roman    Output Parameter:
72295fce210SBarry Smith .  newsf - new communication object
72395fce210SBarry Smith 
72495fce210SBarry Smith    Level: beginner
72595fce210SBarry Smith 
72695fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetType(), PetscSFSetGraph()
72795fce210SBarry Smith @*/
72895fce210SBarry Smith PetscErrorCode PetscSFDuplicate(PetscSF sf,PetscSFDuplicateOption opt,PetscSF *newsf)
72995fce210SBarry Smith {
73029046d53SLisandro Dalcin   PetscSFType    type;
73195fce210SBarry Smith   PetscErrorCode ierr;
73297929ea7SJunchao Zhang   MPI_Datatype   dtype=MPIU_SCALAR;
73395fce210SBarry Smith 
73495fce210SBarry Smith   PetscFunctionBegin;
73529046d53SLisandro Dalcin   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
73629046d53SLisandro Dalcin   PetscValidLogicalCollectiveEnum(sf,opt,2);
73729046d53SLisandro Dalcin   PetscValidPointer(newsf,3);
73895fce210SBarry Smith   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sf),newsf);CHKERRQ(ierr);
73929046d53SLisandro Dalcin   ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
74029046d53SLisandro Dalcin   if (type) {ierr = PetscSFSetType(*newsf,type);CHKERRQ(ierr);}
74195fce210SBarry Smith   if (opt == PETSCSF_DUPLICATE_GRAPH) {
742dd5b3ca6SJunchao Zhang     PetscSFCheckGraphSet(sf,1);
743dd5b3ca6SJunchao Zhang     if (sf->pattern == PETSCSF_PATTERN_GENERAL) {
74495fce210SBarry Smith       PetscInt          nroots,nleaves;
74595fce210SBarry Smith       const PetscInt    *ilocal;
74695fce210SBarry Smith       const PetscSFNode *iremote;
74795fce210SBarry Smith       ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
74895fce210SBarry Smith       ierr = PetscSFSetGraph(*newsf,nroots,nleaves,ilocal,PETSC_COPY_VALUES,iremote,PETSC_COPY_VALUES);CHKERRQ(ierr);
749dd5b3ca6SJunchao Zhang     } else {
750dd5b3ca6SJunchao Zhang       ierr = PetscSFSetGraphWithPattern(*newsf,sf->map,sf->pattern);CHKERRQ(ierr);
751dd5b3ca6SJunchao Zhang     }
75295fce210SBarry Smith   }
75397929ea7SJunchao Zhang   /* Since oldtype is committed, so is newtype, according to MPI */
75455b25c41SPierre Jolivet   if (sf->vscat.bs > 1) {ierr = MPI_Type_dup(sf->vscat.unit,&dtype);CHKERRMPI(ierr);}
75597929ea7SJunchao Zhang   (*newsf)->vscat.bs     = sf->vscat.bs;
75697929ea7SJunchao Zhang   (*newsf)->vscat.unit   = dtype;
75797929ea7SJunchao Zhang   (*newsf)->vscat.to_n   = sf->vscat.to_n;
75897929ea7SJunchao Zhang   (*newsf)->vscat.from_n = sf->vscat.from_n;
75997929ea7SJunchao Zhang   /* Do not copy lsf. Build it on demand since it is rarely used */
76097929ea7SJunchao Zhang 
76120c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE)
76220c24465SJunchao Zhang   (*newsf)->backend              = sf->backend;
76371438e86SJunchao Zhang   (*newsf)->unknown_input_stream= sf->unknown_input_stream;
76420c24465SJunchao Zhang   (*newsf)->use_gpu_aware_mpi    = sf->use_gpu_aware_mpi;
76520c24465SJunchao Zhang   (*newsf)->use_stream_aware_mpi = sf->use_stream_aware_mpi;
76620c24465SJunchao Zhang #endif
76729046d53SLisandro Dalcin   if (sf->ops->Duplicate) {ierr = (*sf->ops->Duplicate)(sf,opt,*newsf);CHKERRQ(ierr);}
76820c24465SJunchao Zhang   /* Don't do PetscSFSetUp() since the new sf's graph might have not been set. */
76995fce210SBarry Smith   PetscFunctionReturn(0);
77095fce210SBarry Smith }
77195fce210SBarry Smith 
77295fce210SBarry Smith /*@C
77395fce210SBarry Smith    PetscSFGetGraph - Get the graph specifying a parallel star forest
77495fce210SBarry Smith 
77595fce210SBarry Smith    Not Collective
77695fce210SBarry Smith 
7774165533cSJose E. Roman    Input Parameter:
77895fce210SBarry Smith .  sf - star forest
77995fce210SBarry Smith 
7804165533cSJose E. Roman    Output Parameters:
78195fce210SBarry Smith +  nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves)
78295fce210SBarry Smith .  nleaves - number of leaf vertices on the current process, each of these references a root on any process
783bc6585dcSJunchao Zhang .  ilocal - locations of leaves in leafdata buffers (if returned value is NULL, it means leaves are in contiguous storage)
78495fce210SBarry Smith -  iremote - remote locations of root vertices for each leaf on the current process
78595fce210SBarry Smith 
786373e0d91SLisandro Dalcin    Notes:
787373e0d91SLisandro Dalcin      We are not currently requiring that the graph is set, thus returning nroots=-1 if it has not been set yet
788373e0d91SLisandro Dalcin 
789*8dbb0df6SBarry Smith    Fortran Notes:
790*8dbb0df6SBarry Smith      The returned iremote array is a copy and must be deallocated after use. Consequently, if you
791*8dbb0df6SBarry Smith      want to update the graph, you must call PetscSFSetGraph() after modifying the iremote array.
792*8dbb0df6SBarry Smith 
793*8dbb0df6SBarry Smith      To check for a NULL ilocal use
794*8dbb0df6SBarry Smith $      if (loc(ilocal) == loc(PETSC_NULL_INTEGER)) then
795ca797d7aSLawrence Mitchell 
79695fce210SBarry Smith    Level: intermediate
79795fce210SBarry Smith 
79895fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph()
79995fce210SBarry Smith @*/
80095fce210SBarry Smith PetscErrorCode PetscSFGetGraph(PetscSF sf,PetscInt *nroots,PetscInt *nleaves,const PetscInt **ilocal,const PetscSFNode **iremote)
80195fce210SBarry Smith {
802b8dee149SJunchao Zhang   PetscErrorCode ierr;
80395fce210SBarry Smith 
80495fce210SBarry Smith   PetscFunctionBegin;
80595fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
806b8dee149SJunchao Zhang   if (sf->ops->GetGraph) {
807b8dee149SJunchao Zhang     ierr = (sf->ops->GetGraph)(sf,nroots,nleaves,ilocal,iremote);CHKERRQ(ierr);
808b8dee149SJunchao Zhang   } else {
80995fce210SBarry Smith     if (nroots) *nroots = sf->nroots;
81095fce210SBarry Smith     if (nleaves) *nleaves = sf->nleaves;
81195fce210SBarry Smith     if (ilocal) *ilocal = sf->mine;
81295fce210SBarry Smith     if (iremote) *iremote = sf->remote;
813b8dee149SJunchao Zhang   }
81495fce210SBarry Smith   PetscFunctionReturn(0);
81595fce210SBarry Smith }
81695fce210SBarry Smith 
81729046d53SLisandro Dalcin /*@
81895fce210SBarry Smith    PetscSFGetLeafRange - Get the active leaf ranges
81995fce210SBarry Smith 
82095fce210SBarry Smith    Not Collective
82195fce210SBarry Smith 
8224165533cSJose E. Roman    Input Parameter:
82395fce210SBarry Smith .  sf - star forest
82495fce210SBarry Smith 
8254165533cSJose E. Roman    Output Parameters:
826dd5b3ca6SJunchao Zhang +  minleaf - minimum active leaf on this process. Return 0 if there are no leaves.
827dd5b3ca6SJunchao Zhang -  maxleaf - maximum active leaf on this process. Return -1 if there are no leaves.
82895fce210SBarry Smith 
82995fce210SBarry Smith    Level: developer
83095fce210SBarry Smith 
83195fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph(), PetscSFGetGraph()
83295fce210SBarry Smith @*/
83395fce210SBarry Smith PetscErrorCode PetscSFGetLeafRange(PetscSF sf,PetscInt *minleaf,PetscInt *maxleaf)
83495fce210SBarry Smith {
83595fce210SBarry Smith   PetscFunctionBegin;
83695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
83729046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
83895fce210SBarry Smith   if (minleaf) *minleaf = sf->minleaf;
83995fce210SBarry Smith   if (maxleaf) *maxleaf = sf->maxleaf;
84095fce210SBarry Smith   PetscFunctionReturn(0);
84195fce210SBarry Smith }
84295fce210SBarry Smith 
84395fce210SBarry Smith /*@C
844fe2efc57SMark    PetscSFViewFromOptions - View from Options
845fe2efc57SMark 
846fe2efc57SMark    Collective on PetscSF
847fe2efc57SMark 
848fe2efc57SMark    Input Parameters:
849fe2efc57SMark +  A - the star forest
850736c3998SJose E. Roman .  obj - Optional object
851736c3998SJose E. Roman -  name - command line option
852fe2efc57SMark 
853fe2efc57SMark    Level: intermediate
854fe2efc57SMark .seealso:  PetscSF, PetscSFView, PetscObjectViewFromOptions(), PetscSFCreate()
855fe2efc57SMark @*/
856fe2efc57SMark PetscErrorCode  PetscSFViewFromOptions(PetscSF A,PetscObject obj,const char name[])
857fe2efc57SMark {
858fe2efc57SMark   PetscErrorCode ierr;
859fe2efc57SMark 
860fe2efc57SMark   PetscFunctionBegin;
861fe2efc57SMark   PetscValidHeaderSpecific(A,PETSCSF_CLASSID,1);
862fe2efc57SMark   ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr);
863fe2efc57SMark   PetscFunctionReturn(0);
864fe2efc57SMark }
865fe2efc57SMark 
866fe2efc57SMark /*@C
86795fce210SBarry Smith    PetscSFView - view a star forest
86895fce210SBarry Smith 
86995fce210SBarry Smith    Collective
87095fce210SBarry Smith 
8714165533cSJose E. Roman    Input Parameters:
87295fce210SBarry Smith +  sf - star forest
87395fce210SBarry Smith -  viewer - viewer to display graph, for example PETSC_VIEWER_STDOUT_WORLD
87495fce210SBarry Smith 
87595fce210SBarry Smith    Level: beginner
87695fce210SBarry Smith 
87795fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph()
87895fce210SBarry Smith @*/
87995fce210SBarry Smith PetscErrorCode PetscSFView(PetscSF sf,PetscViewer viewer)
88095fce210SBarry Smith {
88195fce210SBarry Smith   PetscErrorCode    ierr;
88295fce210SBarry Smith   PetscBool         iascii;
88395fce210SBarry Smith   PetscViewerFormat format;
88495fce210SBarry Smith 
88595fce210SBarry Smith   PetscFunctionBegin;
88695fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
88795fce210SBarry Smith   if (!viewer) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sf),&viewer);CHKERRQ(ierr);}
88895fce210SBarry Smith   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
88995fce210SBarry Smith   PetscCheckSameComm(sf,1,viewer,2);
89080153354SVaclav Hapla   if (sf->graphset) {ierr = PetscSFSetUp(sf);CHKERRQ(ierr);}
89195fce210SBarry Smith   ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr);
89295fce210SBarry Smith   if (iascii) {
89395fce210SBarry Smith     PetscMPIInt rank;
89481bfa7aaSJed Brown     PetscInt    ii,i,j;
89595fce210SBarry Smith 
896dae58748SBarry Smith     ierr = PetscObjectPrintClassNamePrefixType((PetscObject)sf,viewer);CHKERRQ(ierr);
89795fce210SBarry Smith     ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr);
898dd5b3ca6SJunchao Zhang     if (sf->pattern == PETSCSF_PATTERN_GENERAL) {
89980153354SVaclav Hapla       if (!sf->graphset) {
90080153354SVaclav Hapla         ierr = PetscViewerASCIIPrintf(viewer,"PetscSFSetGraph() has not been called yet\n");CHKERRQ(ierr);
90180153354SVaclav Hapla         ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
90280153354SVaclav Hapla         PetscFunctionReturn(0);
90380153354SVaclav Hapla       }
904ffc4695bSBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr);
9051575c14dSBarry Smith       ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr);
90695fce210SBarry Smith       ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Number of roots=%D, leaves=%D, remote ranks=%D\n",rank,sf->nroots,sf->nleaves,sf->nranks);CHKERRQ(ierr);
90795fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
90895fce210SBarry 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);
90995fce210SBarry Smith       }
91095fce210SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
91195fce210SBarry Smith       ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr);
91295fce210SBarry Smith       if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) {
91381bfa7aaSJed Brown         PetscMPIInt *tmpranks,*perm;
91481bfa7aaSJed Brown         ierr = PetscMalloc2(sf->nranks,&tmpranks,sf->nranks,&perm);CHKERRQ(ierr);
915580bdb30SBarry Smith         ierr = PetscArraycpy(tmpranks,sf->ranks,sf->nranks);CHKERRQ(ierr);
91681bfa7aaSJed Brown         for (i=0; i<sf->nranks; i++) perm[i] = i;
91781bfa7aaSJed Brown         ierr = PetscSortMPIIntWithArray(sf->nranks,tmpranks,perm);CHKERRQ(ierr);
91895fce210SBarry Smith         ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Roots referenced by my leaves, by rank\n",rank);CHKERRQ(ierr);
91981bfa7aaSJed Brown         for (ii=0; ii<sf->nranks; ii++) {
92081bfa7aaSJed Brown           i = perm[ii];
9217904a332SBarry Smith           ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %d: %D edges\n",rank,sf->ranks[i],sf->roffset[i+1]-sf->roffset[i]);CHKERRQ(ierr);
92295fce210SBarry Smith           for (j=sf->roffset[i]; j<sf->roffset[i+1]; j++) {
92395fce210SBarry Smith             ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d]    %D <- %D\n",rank,sf->rmine[j],sf->rremote[j]);CHKERRQ(ierr);
92495fce210SBarry Smith           }
92595fce210SBarry Smith         }
92681bfa7aaSJed Brown         ierr = PetscFree2(tmpranks,perm);CHKERRQ(ierr);
92795fce210SBarry Smith       }
92895fce210SBarry Smith       ierr = PetscViewerFlush(viewer);CHKERRQ(ierr);
9291575c14dSBarry Smith       ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr);
930dd5b3ca6SJunchao Zhang     }
93195fce210SBarry Smith     ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr);
93295fce210SBarry Smith   }
93362152dedSBarry Smith   if (sf->ops->View) {ierr = (*sf->ops->View)(sf,viewer);CHKERRQ(ierr);}
93495fce210SBarry Smith   PetscFunctionReturn(0);
93595fce210SBarry Smith }
93695fce210SBarry Smith 
93795fce210SBarry Smith /*@C
938dec1416fSJunchao Zhang    PetscSFGetRootRanks - Get root ranks and number of vertices referenced by leaves on this process
93995fce210SBarry Smith 
94095fce210SBarry Smith    Not Collective
94195fce210SBarry Smith 
9424165533cSJose E. Roman    Input Parameter:
94395fce210SBarry Smith .  sf - star forest
94495fce210SBarry Smith 
9454165533cSJose E. Roman    Output Parameters:
94695fce210SBarry Smith +  nranks - number of ranks referenced by local part
94795fce210SBarry Smith .  ranks - array of ranks
94895fce210SBarry Smith .  roffset - offset in rmine/rremote for each rank (length nranks+1)
94995fce210SBarry Smith .  rmine - concatenated array holding local indices referencing each remote rank
95095fce210SBarry Smith -  rremote - concatenated array holding remote indices referenced for each remote rank
95195fce210SBarry Smith 
95295fce210SBarry Smith    Level: developer
95395fce210SBarry Smith 
954dec1416fSJunchao Zhang .seealso: PetscSFGetLeafRanks()
95595fce210SBarry Smith @*/
956dec1416fSJunchao Zhang PetscErrorCode PetscSFGetRootRanks(PetscSF sf,PetscInt *nranks,const PetscMPIInt **ranks,const PetscInt **roffset,const PetscInt **rmine,const PetscInt **rremote)
95795fce210SBarry Smith {
958dec1416fSJunchao Zhang   PetscErrorCode ierr;
95995fce210SBarry Smith 
96095fce210SBarry Smith   PetscFunctionBegin;
96195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
96229046d53SLisandro Dalcin   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
963dec1416fSJunchao Zhang   if (sf->ops->GetRootRanks) {
964dec1416fSJunchao Zhang     ierr = (sf->ops->GetRootRanks)(sf,nranks,ranks,roffset,rmine,rremote);CHKERRQ(ierr);
965dec1416fSJunchao Zhang   } else {
966dec1416fSJunchao Zhang     /* The generic implementation */
96795fce210SBarry Smith     if (nranks)  *nranks  = sf->nranks;
96895fce210SBarry Smith     if (ranks)   *ranks   = sf->ranks;
96995fce210SBarry Smith     if (roffset) *roffset = sf->roffset;
97095fce210SBarry Smith     if (rmine)   *rmine   = sf->rmine;
97195fce210SBarry Smith     if (rremote) *rremote = sf->rremote;
972dec1416fSJunchao Zhang   }
97395fce210SBarry Smith   PetscFunctionReturn(0);
97495fce210SBarry Smith }
97595fce210SBarry Smith 
9768750ddebSJunchao Zhang /*@C
9778750ddebSJunchao Zhang    PetscSFGetLeafRanks - Get leaf ranks referencing roots on this process
9788750ddebSJunchao Zhang 
9798750ddebSJunchao Zhang    Not Collective
9808750ddebSJunchao Zhang 
9814165533cSJose E. Roman    Input Parameter:
9828750ddebSJunchao Zhang .  sf - star forest
9838750ddebSJunchao Zhang 
9844165533cSJose E. Roman    Output Parameters:
9858750ddebSJunchao Zhang +  niranks - number of leaf ranks referencing roots on this process
9868750ddebSJunchao Zhang .  iranks - array of ranks
9878750ddebSJunchao Zhang .  ioffset - offset in irootloc for each rank (length niranks+1)
9888750ddebSJunchao Zhang -  irootloc - concatenated array holding local indices of roots referenced by each leaf rank
9898750ddebSJunchao Zhang 
9908750ddebSJunchao Zhang    Level: developer
9918750ddebSJunchao Zhang 
992dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
9938750ddebSJunchao Zhang @*/
9948750ddebSJunchao Zhang PetscErrorCode PetscSFGetLeafRanks(PetscSF sf,PetscInt *niranks,const PetscMPIInt **iranks,const PetscInt **ioffset,const PetscInt **irootloc)
9958750ddebSJunchao Zhang {
9968750ddebSJunchao Zhang   PetscErrorCode ierr;
9978750ddebSJunchao Zhang 
9988750ddebSJunchao Zhang   PetscFunctionBegin;
9998750ddebSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
10008750ddebSJunchao Zhang   if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks");
10018750ddebSJunchao Zhang   if (sf->ops->GetLeafRanks) {
10028750ddebSJunchao Zhang     ierr = (sf->ops->GetLeafRanks)(sf,niranks,iranks,ioffset,irootloc);CHKERRQ(ierr);
10038750ddebSJunchao Zhang   } else {
10048750ddebSJunchao Zhang     PetscSFType type;
10058750ddebSJunchao Zhang     ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr);
10068750ddebSJunchao Zhang     SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFGetLeafRanks() is not supported on this StarForest type: %s", type);
10078750ddebSJunchao Zhang   }
10088750ddebSJunchao Zhang   PetscFunctionReturn(0);
10098750ddebSJunchao Zhang }
10108750ddebSJunchao Zhang 
1011b5a8e515SJed Brown static PetscBool InList(PetscMPIInt needle,PetscMPIInt n,const PetscMPIInt *list) {
1012b5a8e515SJed Brown   PetscInt i;
1013b5a8e515SJed Brown   for (i=0; i<n; i++) {
1014b5a8e515SJed Brown     if (needle == list[i]) return PETSC_TRUE;
1015b5a8e515SJed Brown   }
1016b5a8e515SJed Brown   return PETSC_FALSE;
1017b5a8e515SJed Brown }
1018b5a8e515SJed Brown 
101995fce210SBarry Smith /*@C
102021c688dcSJed Brown    PetscSFSetUpRanks - Set up data structures associated with ranks; this is for internal use by PetscSF implementations.
102121c688dcSJed Brown 
102221c688dcSJed Brown    Collective
102321c688dcSJed Brown 
10244165533cSJose E. Roman    Input Parameters:
1025b5a8e515SJed Brown +  sf - PetscSF to set up; PetscSFSetGraph() must have been called
1026b5a8e515SJed Brown -  dgroup - MPI_Group of ranks to be distinguished (e.g., for self or shared memory exchange)
102721c688dcSJed Brown 
102821c688dcSJed Brown    Level: developer
102921c688dcSJed Brown 
1030dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks()
103121c688dcSJed Brown @*/
1032b5a8e515SJed Brown PetscErrorCode PetscSFSetUpRanks(PetscSF sf,MPI_Group dgroup)
103321c688dcSJed Brown {
103421c688dcSJed Brown   PetscErrorCode     ierr;
103521c688dcSJed Brown   PetscTable         table;
103621c688dcSJed Brown   PetscTablePosition pos;
1037b5a8e515SJed Brown   PetscMPIInt        size,groupsize,*groupranks;
1038247e8311SStefano Zampini   PetscInt           *rcount,*ranks;
1039247e8311SStefano Zampini   PetscInt           i, irank = -1,orank = -1;
104021c688dcSJed Brown 
104121c688dcSJed Brown   PetscFunctionBegin;
104221c688dcSJed Brown   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
104329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1044ffc4695bSBarry Smith   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRMPI(ierr);
104521c688dcSJed Brown   ierr = PetscTableCreate(10,size,&table);CHKERRQ(ierr);
104621c688dcSJed Brown   for (i=0; i<sf->nleaves; i++) {
104721c688dcSJed Brown     /* Log 1-based rank */
104821c688dcSJed Brown     ierr = PetscTableAdd(table,sf->remote[i].rank+1,1,ADD_VALUES);CHKERRQ(ierr);
104921c688dcSJed Brown   }
105021c688dcSJed Brown   ierr = PetscTableGetCount(table,&sf->nranks);CHKERRQ(ierr);
105121c688dcSJed Brown   ierr = PetscMalloc4(sf->nranks,&sf->ranks,sf->nranks+1,&sf->roffset,sf->nleaves,&sf->rmine,sf->nleaves,&sf->rremote);CHKERRQ(ierr);
105221c688dcSJed Brown   ierr = PetscMalloc2(sf->nranks,&rcount,sf->nranks,&ranks);CHKERRQ(ierr);
105321c688dcSJed Brown   ierr = PetscTableGetHeadPosition(table,&pos);CHKERRQ(ierr);
105421c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
105521c688dcSJed Brown     ierr = PetscTableGetNext(table,&pos,&ranks[i],&rcount[i]);CHKERRQ(ierr);
105621c688dcSJed Brown     ranks[i]--;             /* Convert back to 0-based */
105721c688dcSJed Brown   }
105821c688dcSJed Brown   ierr = PetscTableDestroy(&table);CHKERRQ(ierr);
1059b5a8e515SJed Brown 
1060b5a8e515SJed Brown   /* We expect that dgroup is reliably "small" while nranks could be large */
1061b5a8e515SJed Brown   {
10627fb8a5e4SKarl Rupp     MPI_Group group = MPI_GROUP_NULL;
1063b5a8e515SJed Brown     PetscMPIInt *dgroupranks;
1064ffc4695bSBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRMPI(ierr);
1065ffc4695bSBarry Smith     ierr = MPI_Group_size(dgroup,&groupsize);CHKERRMPI(ierr);
1066b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&dgroupranks);CHKERRQ(ierr);
1067b5a8e515SJed Brown     ierr = PetscMalloc1(groupsize,&groupranks);CHKERRQ(ierr);
1068b5a8e515SJed Brown     for (i=0; i<groupsize; i++) dgroupranks[i] = i;
1069ffc4695bSBarry Smith     if (groupsize) {ierr = MPI_Group_translate_ranks(dgroup,groupsize,dgroupranks,group,groupranks);CHKERRMPI(ierr);}
1070ffc4695bSBarry Smith     ierr = MPI_Group_free(&group);CHKERRMPI(ierr);
1071b5a8e515SJed Brown     ierr = PetscFree(dgroupranks);CHKERRQ(ierr);
1072b5a8e515SJed Brown   }
1073b5a8e515SJed Brown 
1074b5a8e515SJed Brown   /* Partition ranks[] into distinguished (first sf->ndranks) followed by non-distinguished */
1075b5a8e515SJed Brown   for (sf->ndranks=0,i=sf->nranks; sf->ndranks<i;) {
1076b5a8e515SJed Brown     for (i--; sf->ndranks<i; i--) { /* Scan i backward looking for distinguished rank */
1077b5a8e515SJed Brown       if (InList(ranks[i],groupsize,groupranks)) break;
1078b5a8e515SJed Brown     }
1079b5a8e515SJed Brown     for (; sf->ndranks<=i; sf->ndranks++) { /* Scan sf->ndranks forward looking for non-distinguished rank */
1080b5a8e515SJed Brown       if (!InList(ranks[sf->ndranks],groupsize,groupranks)) break;
1081b5a8e515SJed Brown     }
1082b5a8e515SJed Brown     if (sf->ndranks < i) {                         /* Swap ranks[sf->ndranks] with ranks[i] */
1083b5a8e515SJed Brown       PetscInt tmprank,tmpcount;
1084247e8311SStefano Zampini 
1085b5a8e515SJed Brown       tmprank             = ranks[i];
1086b5a8e515SJed Brown       tmpcount            = rcount[i];
1087b5a8e515SJed Brown       ranks[i]            = ranks[sf->ndranks];
1088b5a8e515SJed Brown       rcount[i]           = rcount[sf->ndranks];
1089b5a8e515SJed Brown       ranks[sf->ndranks]  = tmprank;
1090b5a8e515SJed Brown       rcount[sf->ndranks] = tmpcount;
1091b5a8e515SJed Brown       sf->ndranks++;
1092b5a8e515SJed Brown     }
1093b5a8e515SJed Brown   }
1094b5a8e515SJed Brown   ierr = PetscFree(groupranks);CHKERRQ(ierr);
1095b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->ndranks,ranks,rcount);CHKERRQ(ierr);
1096b5a8e515SJed Brown   ierr = PetscSortIntWithArray(sf->nranks-sf->ndranks,ranks+sf->ndranks,rcount+sf->ndranks);CHKERRQ(ierr);
109721c688dcSJed Brown   sf->roffset[0] = 0;
109821c688dcSJed Brown   for (i=0; i<sf->nranks; i++) {
109921c688dcSJed Brown     ierr = PetscMPIIntCast(ranks[i],sf->ranks+i);CHKERRQ(ierr);
110021c688dcSJed Brown     sf->roffset[i+1] = sf->roffset[i] + rcount[i];
110121c688dcSJed Brown     rcount[i]        = 0;
110221c688dcSJed Brown   }
1103247e8311SStefano Zampini   for (i=0, irank = -1, orank = -1; i<sf->nleaves; i++) {
1104247e8311SStefano Zampini     /* short circuit */
1105247e8311SStefano Zampini     if (orank != sf->remote[i].rank) {
110621c688dcSJed Brown       /* Search for index of iremote[i].rank in sf->ranks */
1107b5a8e515SJed Brown       ierr = PetscFindMPIInt(sf->remote[i].rank,sf->ndranks,sf->ranks,&irank);CHKERRQ(ierr);
1108b5a8e515SJed Brown       if (irank < 0) {
1109b5a8e515SJed Brown         ierr = PetscFindMPIInt(sf->remote[i].rank,sf->nranks-sf->ndranks,sf->ranks+sf->ndranks,&irank);CHKERRQ(ierr);
1110b5a8e515SJed Brown         if (irank >= 0) irank += sf->ndranks;
111121c688dcSJed Brown       }
1112247e8311SStefano Zampini       orank = sf->remote[i].rank;
1113247e8311SStefano Zampini     }
1114b5a8e515SJed Brown     if (irank < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Could not find rank %D in array",sf->remote[i].rank);
111521c688dcSJed Brown     sf->rmine[sf->roffset[irank] + rcount[irank]]   = sf->mine ? sf->mine[i] : i;
111621c688dcSJed Brown     sf->rremote[sf->roffset[irank] + rcount[irank]] = sf->remote[i].index;
111721c688dcSJed Brown     rcount[irank]++;
111821c688dcSJed Brown   }
111921c688dcSJed Brown   ierr = PetscFree2(rcount,ranks);CHKERRQ(ierr);
112021c688dcSJed Brown   PetscFunctionReturn(0);
112121c688dcSJed Brown }
112221c688dcSJed Brown 
112321c688dcSJed Brown /*@C
112495fce210SBarry Smith    PetscSFGetGroups - gets incoming and outgoing process groups
112595fce210SBarry Smith 
112695fce210SBarry Smith    Collective
112795fce210SBarry Smith 
11284165533cSJose E. Roman    Input Parameter:
112995fce210SBarry Smith .  sf - star forest
113095fce210SBarry Smith 
11314165533cSJose E. Roman    Output Parameters:
113295fce210SBarry Smith +  incoming - group of origin processes for incoming edges (leaves that reference my roots)
113395fce210SBarry Smith -  outgoing - group of destination processes for outgoing edges (roots that I reference)
113495fce210SBarry Smith 
113595fce210SBarry Smith    Level: developer
113695fce210SBarry Smith 
113795fce210SBarry Smith .seealso: PetscSFGetWindow(), PetscSFRestoreWindow()
113895fce210SBarry Smith @*/
113995fce210SBarry Smith PetscErrorCode PetscSFGetGroups(PetscSF sf,MPI_Group *incoming,MPI_Group *outgoing)
114095fce210SBarry Smith {
114195fce210SBarry Smith   PetscErrorCode ierr;
11427fb8a5e4SKarl Rupp   MPI_Group      group = MPI_GROUP_NULL;
114395fce210SBarry Smith 
114495fce210SBarry Smith   PetscFunctionBegin;
114544ee17edSStefano Zampini   if (sf->nranks < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUpRanks() before obtaining groups");
114695fce210SBarry Smith   if (sf->ingroup == MPI_GROUP_NULL) {
114795fce210SBarry Smith     PetscInt       i;
114895fce210SBarry Smith     const PetscInt *indegree;
114995fce210SBarry Smith     PetscMPIInt    rank,*outranks,*inranks;
115095fce210SBarry Smith     PetscSFNode    *remote;
115195fce210SBarry Smith     PetscSF        bgcount;
115295fce210SBarry Smith 
115395fce210SBarry Smith     /* Compute the number of incoming ranks */
1154785e854fSJed Brown     ierr = PetscMalloc1(sf->nranks,&remote);CHKERRQ(ierr);
115595fce210SBarry Smith     for (i=0; i<sf->nranks; i++) {
115695fce210SBarry Smith       remote[i].rank  = sf->ranks[i];
115795fce210SBarry Smith       remote[i].index = 0;
115895fce210SBarry Smith     }
115995fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,&bgcount);CHKERRQ(ierr);
116095fce210SBarry Smith     ierr = PetscSFSetGraph(bgcount,1,sf->nranks,NULL,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
116195fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(bgcount,&indegree);CHKERRQ(ierr);
116295fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(bgcount,&indegree);CHKERRQ(ierr);
116395fce210SBarry Smith     /* Enumerate the incoming ranks */
1164dcca6d9dSJed Brown     ierr = PetscMalloc2(indegree[0],&inranks,sf->nranks,&outranks);CHKERRQ(ierr);
1165ffc4695bSBarry Smith     ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr);
116695fce210SBarry Smith     for (i=0; i<sf->nranks; i++) outranks[i] = rank;
116795fce210SBarry Smith     ierr = PetscSFGatherBegin(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
116895fce210SBarry Smith     ierr = PetscSFGatherEnd(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr);
1169ffc4695bSBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRMPI(ierr);
1170ffc4695bSBarry Smith     ierr = MPI_Group_incl(group,indegree[0],inranks,&sf->ingroup);CHKERRMPI(ierr);
1171ffc4695bSBarry Smith     ierr = MPI_Group_free(&group);CHKERRMPI(ierr);
117295fce210SBarry Smith     ierr = PetscFree2(inranks,outranks);CHKERRQ(ierr);
117395fce210SBarry Smith     ierr = PetscSFDestroy(&bgcount);CHKERRQ(ierr);
117495fce210SBarry Smith   }
117595fce210SBarry Smith   *incoming = sf->ingroup;
117695fce210SBarry Smith 
117795fce210SBarry Smith   if (sf->outgroup == MPI_GROUP_NULL) {
1178ffc4695bSBarry Smith     ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRMPI(ierr);
1179ffc4695bSBarry Smith     ierr = MPI_Group_incl(group,sf->nranks,sf->ranks,&sf->outgroup);CHKERRMPI(ierr);
1180ffc4695bSBarry Smith     ierr = MPI_Group_free(&group);CHKERRMPI(ierr);
118195fce210SBarry Smith   }
118295fce210SBarry Smith   *outgoing = sf->outgroup;
118395fce210SBarry Smith   PetscFunctionReturn(0);
118495fce210SBarry Smith }
118595fce210SBarry Smith 
118629046d53SLisandro Dalcin /*@
11873b8d980fSPierre Jolivet    PetscSFGetMultiSF - gets the inner SF implementing gathers and scatters
118895fce210SBarry Smith 
118995fce210SBarry Smith    Collective
119095fce210SBarry Smith 
11914165533cSJose E. Roman    Input Parameter:
119295fce210SBarry Smith .  sf - star forest that may contain roots with 0 or with more than 1 vertex
119395fce210SBarry Smith 
11944165533cSJose E. Roman    Output Parameter:
119595fce210SBarry Smith .  multi - star forest with split roots, such that each root has degree exactly 1
119695fce210SBarry Smith 
119795fce210SBarry Smith    Level: developer
119895fce210SBarry Smith 
119995fce210SBarry Smith    Notes:
120095fce210SBarry Smith 
120195fce210SBarry Smith    In most cases, users should use PetscSFGatherBegin() and PetscSFScatterBegin() instead of manipulating multi
120295fce210SBarry Smith    directly. Since multi satisfies the stronger condition that each entry in the global space has exactly one incoming
120395fce210SBarry Smith    edge, it is a candidate for future optimization that might involve its removal.
120495fce210SBarry Smith 
1205673100f5SVaclav Hapla .seealso: PetscSFSetGraph(), PetscSFGatherBegin(), PetscSFScatterBegin(), PetscSFComputeMultiRootOriginalNumbering()
120695fce210SBarry Smith @*/
120795fce210SBarry Smith PetscErrorCode PetscSFGetMultiSF(PetscSF sf,PetscSF *multi)
120895fce210SBarry Smith {
120995fce210SBarry Smith   PetscErrorCode ierr;
121095fce210SBarry Smith 
121195fce210SBarry Smith   PetscFunctionBegin;
121295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
121395fce210SBarry Smith   PetscValidPointer(multi,2);
121495fce210SBarry Smith   if (sf->nroots < 0) {         /* Graph has not been set yet; why do we need this? */
121595fce210SBarry Smith     ierr   = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
121695fce210SBarry Smith     *multi = sf->multi;
1217013b3241SStefano Zampini     sf->multi->multi = sf->multi;
121895fce210SBarry Smith     PetscFunctionReturn(0);
121995fce210SBarry Smith   }
122095fce210SBarry Smith   if (!sf->multi) {
122195fce210SBarry Smith     const PetscInt *indegree;
12229837ea96SMatthew G. Knepley     PetscInt       i,*inoffset,*outones,*outoffset,maxlocal;
122395fce210SBarry Smith     PetscSFNode    *remote;
122429046d53SLisandro Dalcin     maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */
122595fce210SBarry Smith     ierr = PetscSFComputeDegreeBegin(sf,&indegree);CHKERRQ(ierr);
122695fce210SBarry Smith     ierr = PetscSFComputeDegreeEnd(sf,&indegree);CHKERRQ(ierr);
12279837ea96SMatthew G. Knepley     ierr = PetscMalloc3(sf->nroots+1,&inoffset,maxlocal,&outones,maxlocal,&outoffset);CHKERRQ(ierr);
122895fce210SBarry Smith     inoffset[0] = 0;
122995fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i+1] = inoffset[i] + indegree[i];
12309837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) outones[i] = 1;
1231dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpBegin(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
1232dbd2ff41SBarry Smith     ierr = PetscSFFetchAndOpEnd(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr);
123395fce210SBarry Smith     for (i=0; i<sf->nroots; i++) inoffset[i] -= indegree[i]; /* Undo the increment */
123476bd3646SJed Brown     if (PetscDefined(USE_DEBUG)) { /* Check that the expected number of increments occurred */
123595fce210SBarry Smith       for (i=0; i<sf->nroots; i++) {
123695fce210SBarry Smith         if (inoffset[i] + indegree[i] != inoffset[i+1]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Incorrect result after PetscSFFetchAndOp");
123795fce210SBarry Smith       }
123876bd3646SJed Brown     }
1239785e854fSJed Brown     ierr = PetscMalloc1(sf->nleaves,&remote);CHKERRQ(ierr);
124095fce210SBarry Smith     for (i=0; i<sf->nleaves; i++) {
124195fce210SBarry Smith       remote[i].rank  = sf->remote[i].rank;
124238e7336fSToby Isaac       remote[i].index = outoffset[sf->mine ? sf->mine[i] : i];
124395fce210SBarry Smith     }
124495fce210SBarry Smith     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr);
1245013b3241SStefano Zampini     sf->multi->multi = sf->multi;
124601365b40SToby Isaac     ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr);
124795fce210SBarry Smith     if (sf->rankorder) {        /* Sort the ranks */
124895fce210SBarry Smith       PetscMPIInt rank;
124995fce210SBarry Smith       PetscInt    *inranks,*newoffset,*outranks,*newoutoffset,*tmpoffset,maxdegree;
125095fce210SBarry Smith       PetscSFNode *newremote;
1251ffc4695bSBarry Smith       ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr);
125295fce210SBarry Smith       for (i=0,maxdegree=0; i<sf->nroots; i++) maxdegree = PetscMax(maxdegree,indegree[i]);
12539837ea96SMatthew G. Knepley       ierr = PetscMalloc5(sf->multi->nroots,&inranks,sf->multi->nroots,&newoffset,maxlocal,&outranks,maxlocal,&newoutoffset,maxdegree,&tmpoffset);CHKERRQ(ierr);
12549837ea96SMatthew G. Knepley       for (i=0; i<maxlocal; i++) outranks[i] = rank;
125583df288dSJunchao Zhang       ierr = PetscSFReduceBegin(sf->multi,MPIU_INT,outranks,inranks,MPI_REPLACE);CHKERRQ(ierr);
125683df288dSJunchao Zhang       ierr = PetscSFReduceEnd(sf->multi,MPIU_INT,outranks,inranks,MPI_REPLACE);CHKERRQ(ierr);
125795fce210SBarry Smith       /* Sort the incoming ranks at each vertex, build the inverse map */
125895fce210SBarry Smith       for (i=0; i<sf->nroots; i++) {
125995fce210SBarry Smith         PetscInt j;
126095fce210SBarry Smith         for (j=0; j<indegree[i]; j++) tmpoffset[j] = j;
126195fce210SBarry Smith         ierr = PetscSortIntWithArray(indegree[i],inranks+inoffset[i],tmpoffset);CHKERRQ(ierr);
126295fce210SBarry Smith         for (j=0; j<indegree[i]; j++) newoffset[inoffset[i] + tmpoffset[j]] = inoffset[i] + j;
126395fce210SBarry Smith       }
1264ad227feaSJunchao Zhang       ierr = PetscSFBcastBegin(sf->multi,MPIU_INT,newoffset,newoutoffset,MPI_REPLACE);CHKERRQ(ierr);
1265ad227feaSJunchao Zhang       ierr = PetscSFBcastEnd(sf->multi,MPIU_INT,newoffset,newoutoffset,MPI_REPLACE);CHKERRQ(ierr);
1266785e854fSJed Brown       ierr = PetscMalloc1(sf->nleaves,&newremote);CHKERRQ(ierr);
126795fce210SBarry Smith       for (i=0; i<sf->nleaves; i++) {
126895fce210SBarry Smith         newremote[i].rank  = sf->remote[i].rank;
126901365b40SToby Isaac         newremote[i].index = newoutoffset[sf->mine ? sf->mine[i] : i];
127095fce210SBarry Smith       }
127101365b40SToby Isaac       ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,newremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
127295fce210SBarry Smith       ierr = PetscFree5(inranks,newoffset,outranks,newoutoffset,tmpoffset);CHKERRQ(ierr);
127395fce210SBarry Smith     }
127495fce210SBarry Smith     ierr = PetscFree3(inoffset,outones,outoffset);CHKERRQ(ierr);
127595fce210SBarry Smith   }
127695fce210SBarry Smith   *multi = sf->multi;
127795fce210SBarry Smith   PetscFunctionReturn(0);
127895fce210SBarry Smith }
127995fce210SBarry Smith 
128095fce210SBarry Smith /*@C
128172502a1fSJunchao Zhang    PetscSFCreateEmbeddedRootSF - removes edges from all but the selected roots, does not remap indices
128295fce210SBarry Smith 
128395fce210SBarry Smith    Collective
128495fce210SBarry Smith 
12854165533cSJose E. Roman    Input Parameters:
128695fce210SBarry Smith +  sf - original star forest
1287ba2a7774SJunchao Zhang .  nselected  - number of selected roots on this process
1288ba2a7774SJunchao Zhang -  selected   - indices of the selected roots on this process
128995fce210SBarry Smith 
12904165533cSJose E. Roman    Output Parameter:
1291cd620004SJunchao Zhang .  esf - new star forest
129295fce210SBarry Smith 
129395fce210SBarry Smith    Level: advanced
129495fce210SBarry Smith 
129595fce210SBarry Smith    Note:
129695fce210SBarry Smith    To use the new PetscSF, it may be necessary to know the indices of the leaves that are still participating. This can
129795fce210SBarry Smith    be done by calling PetscSFGetGraph().
129895fce210SBarry Smith 
129995fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFGetGraph()
130095fce210SBarry Smith @*/
130172502a1fSJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedRootSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *esf)
130295fce210SBarry Smith {
1303cd620004SJunchao Zhang   PetscInt          i,j,n,nroots,nleaves,esf_nleaves,*new_ilocal,minleaf,maxleaf,maxlocal;
1304cd620004SJunchao Zhang   const PetscInt    *ilocal;
1305cd620004SJunchao Zhang   signed char       *rootdata,*leafdata,*leafmem;
1306ba2a7774SJunchao Zhang   const PetscSFNode *iremote;
1307f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1308f659e5c7SJunchao Zhang   MPI_Comm          comm;
13090511a646SMatthew G. Knepley   PetscErrorCode    ierr;
131095fce210SBarry Smith 
131195fce210SBarry Smith   PetscFunctionBegin;
131295fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
131329046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1314ba2a7774SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
1315cd620004SJunchao Zhang   PetscValidPointer(esf,4);
13160511a646SMatthew G. Knepley 
1317f659e5c7SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1318140a1472SStefano Zampini   ierr = PetscLogEventBegin(PETSCSF_EmbedSF,sf,0,0,0);CHKERRQ(ierr);
1319f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1320cd620004SJunchao Zhang   ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
1321cd620004SJunchao Zhang 
132276bd3646SJed Brown   if (PetscDefined(USE_DEBUG)) {  /* Error out if selected[] has dups or  out of range indices */
1323cd620004SJunchao Zhang     PetscBool dups;
1324cd620004SJunchao Zhang     ierr = PetscCheckDupsInt(nselected,selected,&dups);CHKERRQ(ierr);
1325cd620004SJunchao Zhang     if (dups) SETERRQ(comm,PETSC_ERR_ARG_WRONG,"selected[] has dups");
1326cd620004SJunchao Zhang     for (i=0; i<nselected; i++)
1327cd620004SJunchao Zhang       if (selected[i] < 0 || selected[i] >= nroots) SETERRQ2(comm,PETSC_ERR_ARG_OUTOFRANGE,"selected root indice %D is out of [0,%D)",selected[i],nroots);
1328cd620004SJunchao Zhang   }
1329f659e5c7SJunchao Zhang 
133072502a1fSJunchao Zhang   if (sf->ops->CreateEmbeddedRootSF) {
133172502a1fSJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedRootSF)(sf,nselected,selected,esf);CHKERRQ(ierr);
1332f659e5c7SJunchao Zhang   } else {
1333cd620004SJunchao Zhang     /* A generic version of creating embedded sf */
1334cd620004SJunchao Zhang     ierr = PetscSFGetLeafRange(sf,&minleaf,&maxleaf);CHKERRQ(ierr);
1335cd620004SJunchao Zhang     maxlocal = maxleaf - minleaf + 1;
1336cd620004SJunchao Zhang     ierr = PetscCalloc2(nroots,&rootdata,maxlocal,&leafmem);CHKERRQ(ierr);
1337cd620004SJunchao Zhang     leafdata = leafmem - minleaf;
1338cd620004SJunchao Zhang     /* Tag selected roots and bcast to leaves */
1339cd620004SJunchao Zhang     for (i=0; i<nselected; i++) rootdata[selected[i]] = 1;
1340ad227feaSJunchao Zhang     ierr = PetscSFBcastBegin(sf,MPI_SIGNED_CHAR,rootdata,leafdata,MPI_REPLACE);CHKERRQ(ierr);
1341ad227feaSJunchao Zhang     ierr = PetscSFBcastEnd(sf,MPI_SIGNED_CHAR,rootdata,leafdata,MPI_REPLACE);CHKERRQ(ierr);
1342ba2a7774SJunchao Zhang 
1343cd620004SJunchao Zhang     /* Build esf with leaves that are still connected */
1344cd620004SJunchao Zhang     esf_nleaves = 0;
1345cd620004SJunchao Zhang     for (i=0; i<nleaves; i++) {
1346cd620004SJunchao Zhang       j = ilocal ? ilocal[i] : i;
1347cd620004SJunchao Zhang       /* esf_nleaves += leafdata[j] should work in theory, but failed with SFWindow bugs
1348cd620004SJunchao Zhang          with PetscSFBcast. See https://gitlab.com/petsc/petsc/issues/555
1349cd620004SJunchao Zhang       */
1350cd620004SJunchao Zhang       esf_nleaves += (leafdata[j] ? 1 : 0);
1351cd620004SJunchao Zhang     }
1352cd620004SJunchao Zhang     ierr = PetscMalloc1(esf_nleaves,&new_ilocal);CHKERRQ(ierr);
1353cd620004SJunchao Zhang     ierr = PetscMalloc1(esf_nleaves,&new_iremote);CHKERRQ(ierr);
1354cd620004SJunchao Zhang     for (i=n=0; i<nleaves; i++) {
1355cd620004SJunchao Zhang       j = ilocal ? ilocal[i] : i;
1356cd620004SJunchao Zhang       if (leafdata[j]) {
1357cd620004SJunchao Zhang         new_ilocal[n]        = j;
1358cd620004SJunchao Zhang         new_iremote[n].rank  = iremote[i].rank;
1359cd620004SJunchao Zhang         new_iremote[n].index = iremote[i].index;
1360fc1ede2bSMatthew G. Knepley         ++n;
136195fce210SBarry Smith       }
136295fce210SBarry Smith     }
1363cd620004SJunchao Zhang     ierr = PetscSFCreate(comm,esf);CHKERRQ(ierr);
1364cd620004SJunchao Zhang     ierr = PetscSFSetFromOptions(*esf);CHKERRQ(ierr);
1365cd620004SJunchao Zhang     ierr = PetscSFSetGraph(*esf,nroots,esf_nleaves,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
1366cd620004SJunchao Zhang     ierr = PetscFree2(rootdata,leafmem);CHKERRQ(ierr);
1367f659e5c7SJunchao Zhang   }
1368140a1472SStefano Zampini   ierr = PetscLogEventEnd(PETSCSF_EmbedSF,sf,0,0,0);CHKERRQ(ierr);
136995fce210SBarry Smith   PetscFunctionReturn(0);
137095fce210SBarry Smith }
137195fce210SBarry Smith 
13722f5fb4c2SMatthew G. Knepley /*@C
13732f5fb4c2SMatthew G. Knepley   PetscSFCreateEmbeddedLeafSF - removes edges from all but the selected leaves, does not remap indices
13742f5fb4c2SMatthew G. Knepley 
13752f5fb4c2SMatthew G. Knepley   Collective
13762f5fb4c2SMatthew G. Knepley 
13774165533cSJose E. Roman   Input Parameters:
13782f5fb4c2SMatthew G. Knepley + sf - original star forest
1379f659e5c7SJunchao Zhang . nselected  - number of selected leaves on this process
1380f659e5c7SJunchao Zhang - selected   - indices of the selected leaves on this process
13812f5fb4c2SMatthew G. Knepley 
13824165533cSJose E. Roman   Output Parameter:
13832f5fb4c2SMatthew G. Knepley .  newsf - new star forest
13842f5fb4c2SMatthew G. Knepley 
13852f5fb4c2SMatthew G. Knepley   Level: advanced
13862f5fb4c2SMatthew G. Knepley 
138772502a1fSJunchao Zhang .seealso: PetscSFCreateEmbeddedRootSF(), PetscSFSetGraph(), PetscSFGetGraph()
13882f5fb4c2SMatthew G. Knepley @*/
1389f659e5c7SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf)
13902f5fb4c2SMatthew G. Knepley {
1391f659e5c7SJunchao Zhang   const PetscSFNode *iremote;
1392f659e5c7SJunchao Zhang   PetscSFNode       *new_iremote;
1393f659e5c7SJunchao Zhang   const PetscInt    *ilocal;
1394f659e5c7SJunchao Zhang   PetscInt          i,nroots,*leaves,*new_ilocal;
1395f659e5c7SJunchao Zhang   MPI_Comm          comm;
13962f5fb4c2SMatthew G. Knepley   PetscErrorCode    ierr;
13972f5fb4c2SMatthew G. Knepley 
13982f5fb4c2SMatthew G. Knepley   PetscFunctionBegin;
13992f5fb4c2SMatthew G. Knepley   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
140029046d53SLisandro Dalcin   PetscSFCheckGraphSet(sf,1);
1401f659e5c7SJunchao Zhang   if (nselected) PetscValidPointer(selected,3);
14022f5fb4c2SMatthew G. Knepley   PetscValidPointer(newsf,4);
14032f5fb4c2SMatthew G. Knepley 
1404f659e5c7SJunchao Zhang   /* Uniq selected[] and put results in leaves[] */
1405f659e5c7SJunchao Zhang   ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
1406f659e5c7SJunchao Zhang   ierr = PetscMalloc1(nselected,&leaves);CHKERRQ(ierr);
1407dd5b3ca6SJunchao Zhang   ierr = PetscArraycpy(leaves,selected,nselected);CHKERRQ(ierr);
1408f659e5c7SJunchao Zhang   ierr = PetscSortedRemoveDupsInt(&nselected,leaves);CHKERRQ(ierr);
1409f659e5c7SJunchao 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);
1410f659e5c7SJunchao Zhang 
1411f659e5c7SJunchao Zhang   /* Optimize the routine only when sf is setup and hence we can reuse sf's communication pattern */
1412f659e5c7SJunchao Zhang   if (sf->setupcalled && sf->ops->CreateEmbeddedLeafSF) {
1413f659e5c7SJunchao Zhang     ierr = (*sf->ops->CreateEmbeddedLeafSF)(sf,nselected,leaves,newsf);CHKERRQ(ierr);
1414f659e5c7SJunchao Zhang   } else {
1415f659e5c7SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,NULL,&ilocal,&iremote);CHKERRQ(ierr);
1416f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_ilocal);CHKERRQ(ierr);
1417f659e5c7SJunchao Zhang     ierr = PetscMalloc1(nselected,&new_iremote);CHKERRQ(ierr);
1418f659e5c7SJunchao Zhang     for (i=0; i<nselected; ++i) {
1419f659e5c7SJunchao Zhang       const PetscInt l     = leaves[i];
1420f659e5c7SJunchao Zhang       new_ilocal[i]        = ilocal ? ilocal[l] : l;
1421f659e5c7SJunchao Zhang       new_iremote[i].rank  = iremote[l].rank;
1422f659e5c7SJunchao Zhang       new_iremote[i].index = iremote[l].index;
14232f5fb4c2SMatthew G. Knepley     }
14244cc19a0cSStefano Zampini     ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,newsf);CHKERRQ(ierr);
1425f659e5c7SJunchao Zhang     ierr = PetscSFSetGraph(*newsf,nroots,nselected,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
1426f659e5c7SJunchao Zhang   }
1427f659e5c7SJunchao Zhang   ierr = PetscFree(leaves);CHKERRQ(ierr);
14282f5fb4c2SMatthew G. Knepley   PetscFunctionReturn(0);
14292f5fb4c2SMatthew G. Knepley }
14302f5fb4c2SMatthew G. Knepley 
143195fce210SBarry Smith /*@C
1432ad227feaSJunchao Zhang    PetscSFBcastBegin - begin pointwise broadcast with root value being reduced to leaf value, to be concluded with call to PetscSFBcastEnd()
14333482bfa8SJunchao Zhang 
14343482bfa8SJunchao Zhang    Collective on PetscSF
14353482bfa8SJunchao Zhang 
14364165533cSJose E. Roman    Input Parameters:
14373482bfa8SJunchao Zhang +  sf - star forest on which to communicate
14383482bfa8SJunchao Zhang .  unit - data type associated with each node
14393482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
14403482bfa8SJunchao Zhang -  op - operation to use for reduction
14413482bfa8SJunchao Zhang 
14424165533cSJose E. Roman    Output Parameter:
14433482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
14443482bfa8SJunchao Zhang 
14453482bfa8SJunchao Zhang    Level: intermediate
14463482bfa8SJunchao Zhang 
1447d0295fc0SJunchao Zhang    Notes:
1448d0295fc0SJunchao Zhang     When petsc is configured with device support, it will use its own mechanism to figure out whether the given data pointers
1449d0295fc0SJunchao Zhang     are host pointers or device pointers, which may incur a noticable cost. If you already knew the info, you should
1450ad227feaSJunchao Zhang     use PetscSFBcastWithMemTypeBegin() instead.
1451ad227feaSJunchao Zhang .seealso: PetscSFBcastEnd(), PetscSFBcastWithMemTypeBegin()
14523482bfa8SJunchao Zhang @*/
1453ad227feaSJunchao Zhang PetscErrorCode PetscSFBcastBegin(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
14543482bfa8SJunchao Zhang {
14553482bfa8SJunchao Zhang   PetscErrorCode ierr;
1456eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
14573482bfa8SJunchao Zhang 
14583482bfa8SJunchao Zhang   PetscFunctionBegin;
14593482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
14603482bfa8SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1461ad227feaSJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_BcastBegin,sf,0,0,0);CHKERRQ(ierr);}
1462eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1463eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1464ad227feaSJunchao Zhang   ierr = (*sf->ops->BcastBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr);
1465ad227feaSJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_BcastBegin,sf,0,0,0);CHKERRQ(ierr);}
14663482bfa8SJunchao Zhang   PetscFunctionReturn(0);
14673482bfa8SJunchao Zhang }
14683482bfa8SJunchao Zhang 
14693482bfa8SJunchao Zhang /*@C
1470ad227feaSJunchao Zhang    PetscSFBcastWithMemTypeBegin - begin pointwise broadcast with root value being reduced to leaf value with explicit memory types, to be concluded with call to PetscSFBcastEnd()
1471d0295fc0SJunchao Zhang 
1472d0295fc0SJunchao Zhang    Collective on PetscSF
1473d0295fc0SJunchao Zhang 
14744165533cSJose E. Roman    Input Parameters:
1475d0295fc0SJunchao Zhang +  sf - star forest on which to communicate
1476d0295fc0SJunchao Zhang .  unit - data type associated with each node
1477d0295fc0SJunchao Zhang .  rootmtype - memory type of rootdata
1478d0295fc0SJunchao Zhang .  rootdata - buffer to broadcast
1479d0295fc0SJunchao Zhang .  leafmtype - memory type of leafdata
1480d0295fc0SJunchao Zhang -  op - operation to use for reduction
1481d0295fc0SJunchao Zhang 
14824165533cSJose E. Roman    Output Parameter:
1483d0295fc0SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
1484d0295fc0SJunchao Zhang 
1485d0295fc0SJunchao Zhang    Level: intermediate
1486d0295fc0SJunchao Zhang 
1487ad227feaSJunchao Zhang .seealso: PetscSFBcastEnd(), PetscSFBcastBegin()
1488d0295fc0SJunchao Zhang @*/
1489ad227feaSJunchao Zhang PetscErrorCode PetscSFBcastWithMemTypeBegin(PetscSF sf,MPI_Datatype unit,PetscMemType rootmtype,const void *rootdata,PetscMemType leafmtype,void *leafdata,MPI_Op op)
1490d0295fc0SJunchao Zhang {
1491d0295fc0SJunchao Zhang   PetscErrorCode ierr;
1492d0295fc0SJunchao Zhang 
1493d0295fc0SJunchao Zhang   PetscFunctionBegin;
1494d0295fc0SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1495d0295fc0SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1496ad227feaSJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_BcastBegin,sf,0,0,0);CHKERRQ(ierr);}
1497ad227feaSJunchao Zhang   ierr = (*sf->ops->BcastBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr);
1498ad227feaSJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_BcastBegin,sf,0,0,0);CHKERRQ(ierr);}
1499d0295fc0SJunchao Zhang   PetscFunctionReturn(0);
1500d0295fc0SJunchao Zhang }
1501d0295fc0SJunchao Zhang 
1502d0295fc0SJunchao Zhang /*@C
1503ad227feaSJunchao Zhang    PetscSFBcastEnd - end a broadcast & reduce operation started with PetscSFBcastBegin()
15043482bfa8SJunchao Zhang 
15053482bfa8SJunchao Zhang    Collective
15063482bfa8SJunchao Zhang 
15074165533cSJose E. Roman    Input Parameters:
15083482bfa8SJunchao Zhang +  sf - star forest
15093482bfa8SJunchao Zhang .  unit - data type
15103482bfa8SJunchao Zhang .  rootdata - buffer to broadcast
15113482bfa8SJunchao Zhang -  op - operation to use for reduction
15123482bfa8SJunchao Zhang 
15134165533cSJose E. Roman    Output Parameter:
15143482bfa8SJunchao Zhang .  leafdata - buffer to be reduced with values from each leaf's respective root
15153482bfa8SJunchao Zhang 
15163482bfa8SJunchao Zhang    Level: intermediate
15173482bfa8SJunchao Zhang 
15183482bfa8SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFReduceEnd()
15193482bfa8SJunchao Zhang @*/
1520ad227feaSJunchao Zhang PetscErrorCode PetscSFBcastEnd(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op)
15213482bfa8SJunchao Zhang {
15223482bfa8SJunchao Zhang   PetscErrorCode ierr;
15233482bfa8SJunchao Zhang 
15243482bfa8SJunchao Zhang   PetscFunctionBegin;
15253482bfa8SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1526ad227feaSJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_BcastEnd,sf,0,0,0);CHKERRQ(ierr);}
1527ad227feaSJunchao Zhang   ierr = (*sf->ops->BcastEnd)(sf,unit,rootdata,leafdata,op);CHKERRQ(ierr);
1528ad227feaSJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_BcastEnd,sf,0,0,0);CHKERRQ(ierr);}
15293482bfa8SJunchao Zhang   PetscFunctionReturn(0);
15303482bfa8SJunchao Zhang }
15313482bfa8SJunchao Zhang 
15323482bfa8SJunchao Zhang /*@C
153395fce210SBarry Smith    PetscSFReduceBegin - begin reduction of leafdata into rootdata, to be completed with call to PetscSFReduceEnd()
153495fce210SBarry Smith 
153595fce210SBarry Smith    Collective
153695fce210SBarry Smith 
15374165533cSJose E. Roman    Input Parameters:
153895fce210SBarry Smith +  sf - star forest
153995fce210SBarry Smith .  unit - data type
154095fce210SBarry Smith .  leafdata - values to reduce
154195fce210SBarry Smith -  op - reduction operation
154295fce210SBarry Smith 
15434165533cSJose E. Roman    Output Parameter:
154495fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
154595fce210SBarry Smith 
154695fce210SBarry Smith    Level: intermediate
154795fce210SBarry Smith 
1548d0295fc0SJunchao Zhang    Notes:
1549d0295fc0SJunchao Zhang     When petsc is configured with device support, it will use its own mechanism to figure out whether the given data pointers
1550d0295fc0SJunchao Zhang     are host pointers or device pointers, which may incur a noticable cost. If you already knew the info, you should
1551d0295fc0SJunchao Zhang     use PetscSFReduceWithMemTypeBegin() instead.
1552d0295fc0SJunchao Zhang 
1553d0295fc0SJunchao Zhang .seealso: PetscSFBcastBegin(), PetscSFReduceWithMemTypeBegin()
155495fce210SBarry Smith @*/
155595fce210SBarry Smith PetscErrorCode PetscSFReduceBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
155695fce210SBarry Smith {
155795fce210SBarry Smith   PetscErrorCode ierr;
1558eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype;
155995fce210SBarry Smith 
156095fce210SBarry Smith   PetscFunctionBegin;
156195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
156295fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
156397929ea7SJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);}
1564eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1565eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1566eb02082bSJunchao Zhang   ierr = (sf->ops->ReduceBegin)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr);
156797929ea7SJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);}
156895fce210SBarry Smith   PetscFunctionReturn(0);
156995fce210SBarry Smith }
157095fce210SBarry Smith 
157195fce210SBarry Smith /*@C
1572d0295fc0SJunchao Zhang    PetscSFReduceWithMemTypeBegin - begin reduction of leafdata into rootdata with explicit memory types, to be completed with call to PetscSFReduceEnd()
1573d0295fc0SJunchao Zhang 
1574d0295fc0SJunchao Zhang    Collective
1575d0295fc0SJunchao Zhang 
15764165533cSJose E. Roman    Input Parameters:
1577d0295fc0SJunchao Zhang +  sf - star forest
1578d0295fc0SJunchao Zhang .  unit - data type
1579d0295fc0SJunchao Zhang .  leafmtype - memory type of leafdata
1580d0295fc0SJunchao Zhang .  leafdata - values to reduce
1581d0295fc0SJunchao Zhang .  rootmtype - memory type of rootdata
1582d0295fc0SJunchao Zhang -  op - reduction operation
1583d0295fc0SJunchao Zhang 
15844165533cSJose E. Roman    Output Parameter:
1585d0295fc0SJunchao Zhang .  rootdata - result of reduction of values from all leaves of each root
1586d0295fc0SJunchao Zhang 
1587d0295fc0SJunchao Zhang    Level: intermediate
1588d0295fc0SJunchao Zhang 
1589d0295fc0SJunchao Zhang .seealso: PetscSFBcastBegin(), PetscSFReduceBegin()
1590d0295fc0SJunchao Zhang @*/
1591d0295fc0SJunchao Zhang PetscErrorCode PetscSFReduceWithMemTypeBegin(PetscSF sf,MPI_Datatype unit,PetscMemType leafmtype,const void *leafdata,PetscMemType rootmtype,void *rootdata,MPI_Op op)
1592d0295fc0SJunchao Zhang {
1593d0295fc0SJunchao Zhang   PetscErrorCode ierr;
1594d0295fc0SJunchao Zhang 
1595d0295fc0SJunchao Zhang   PetscFunctionBegin;
1596d0295fc0SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1597d0295fc0SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
159897929ea7SJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);}
1599d0295fc0SJunchao Zhang   ierr = (sf->ops->ReduceBegin)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr);
160097929ea7SJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);}
1601d0295fc0SJunchao Zhang   PetscFunctionReturn(0);
1602d0295fc0SJunchao Zhang }
1603d0295fc0SJunchao Zhang 
1604d0295fc0SJunchao Zhang /*@C
160595fce210SBarry Smith    PetscSFReduceEnd - end a reduction operation started with PetscSFReduceBegin()
160695fce210SBarry Smith 
160795fce210SBarry Smith    Collective
160895fce210SBarry Smith 
16094165533cSJose E. Roman    Input Parameters:
161095fce210SBarry Smith +  sf - star forest
161195fce210SBarry Smith .  unit - data type
161295fce210SBarry Smith .  leafdata - values to reduce
161395fce210SBarry Smith -  op - reduction operation
161495fce210SBarry Smith 
16154165533cSJose E. Roman    Output Parameter:
161695fce210SBarry Smith .  rootdata - result of reduction of values from all leaves of each root
161795fce210SBarry Smith 
161895fce210SBarry Smith    Level: intermediate
161995fce210SBarry Smith 
162095fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFBcastEnd()
162195fce210SBarry Smith @*/
162295fce210SBarry Smith PetscErrorCode PetscSFReduceEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op)
162395fce210SBarry Smith {
162495fce210SBarry Smith   PetscErrorCode ierr;
162595fce210SBarry Smith 
162695fce210SBarry Smith   PetscFunctionBegin;
162795fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
162897929ea7SJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);}
162900816365SJunchao Zhang   ierr = (*sf->ops->ReduceEnd)(sf,unit,leafdata,rootdata,op);CHKERRQ(ierr);
163097929ea7SJunchao Zhang   if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);}
163195fce210SBarry Smith   PetscFunctionReturn(0);
163295fce210SBarry Smith }
163395fce210SBarry Smith 
163495fce210SBarry Smith /*@C
1635a1729e3fSJunchao Zhang    PetscSFFetchAndOpBegin - begin operation that fetches values from root and updates atomically by applying operation using my leaf value, to be completed with PetscSFFetchAndOpEnd()
1636a1729e3fSJunchao Zhang 
1637a1729e3fSJunchao Zhang    Collective
1638a1729e3fSJunchao Zhang 
16394165533cSJose E. Roman    Input Parameters:
1640a1729e3fSJunchao Zhang +  sf - star forest
1641a1729e3fSJunchao Zhang .  unit - data type
1642a1729e3fSJunchao Zhang .  leafdata - leaf values to use in reduction
1643a1729e3fSJunchao Zhang -  op - operation to use for reduction
1644a1729e3fSJunchao Zhang 
16454165533cSJose E. Roman    Output Parameters:
1646a1729e3fSJunchao Zhang +  rootdata - root values to be updated, input state is seen by first process to perform an update
1647a1729e3fSJunchao Zhang -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
1648a1729e3fSJunchao Zhang 
1649a1729e3fSJunchao Zhang    Level: advanced
1650a1729e3fSJunchao Zhang 
1651a1729e3fSJunchao Zhang    Note:
1652a1729e3fSJunchao Zhang    The update is only atomic at the granularity provided by the hardware. Different roots referenced by the same process
1653a1729e3fSJunchao Zhang    might be updated in a different order. Furthermore, if a composite type is used for the unit datatype, atomicity is
1654a1729e3fSJunchao Zhang    not guaranteed across the whole vertex. Therefore, this function is mostly only used with primitive types such as
1655a1729e3fSJunchao Zhang    integers.
1656a1729e3fSJunchao Zhang 
1657a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeBegin(), PetscSFReduceBegin(), PetscSFSetGraph()
1658a1729e3fSJunchao Zhang @*/
1659a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpBegin(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
1660a1729e3fSJunchao Zhang {
1661a1729e3fSJunchao Zhang   PetscErrorCode ierr;
1662eb02082bSJunchao Zhang   PetscMemType   rootmtype,leafmtype,leafupdatemtype;
1663a1729e3fSJunchao Zhang 
1664a1729e3fSJunchao Zhang   PetscFunctionBegin;
1665a1729e3fSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1666a1729e3fSJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
1667a1729e3fSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1668eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
1669eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
1670eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafupdate,&leafupdatemtype);CHKERRQ(ierr);
1671eb02082bSJunchao Zhang   if (leafmtype != leafupdatemtype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for leafdata and leafupdate in different memory types");
1672eb02082bSJunchao Zhang   ierr = (*sf->ops->FetchAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,leafupdate,op);CHKERRQ(ierr);
1673a1729e3fSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr);
1674a1729e3fSJunchao Zhang   PetscFunctionReturn(0);
1675a1729e3fSJunchao Zhang }
1676a1729e3fSJunchao Zhang 
1677a1729e3fSJunchao Zhang /*@C
1678a1729e3fSJunchao Zhang    PetscSFFetchAndOpEnd - end operation started in matching call to PetscSFFetchAndOpBegin() to fetch values from roots and update atomically by applying operation using my leaf value
1679a1729e3fSJunchao Zhang 
1680a1729e3fSJunchao Zhang    Collective
1681a1729e3fSJunchao Zhang 
16824165533cSJose E. Roman    Input Parameters:
1683a1729e3fSJunchao Zhang +  sf - star forest
1684a1729e3fSJunchao Zhang .  unit - data type
1685a1729e3fSJunchao Zhang .  leafdata - leaf values to use in reduction
1686a1729e3fSJunchao Zhang -  op - operation to use for reduction
1687a1729e3fSJunchao Zhang 
16884165533cSJose E. Roman    Output Parameters:
1689a1729e3fSJunchao Zhang +  rootdata - root values to be updated, input state is seen by first process to perform an update
1690a1729e3fSJunchao Zhang -  leafupdate - state at each leaf's respective root immediately prior to my atomic update
1691a1729e3fSJunchao Zhang 
1692a1729e3fSJunchao Zhang    Level: advanced
1693a1729e3fSJunchao Zhang 
1694a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeEnd(), PetscSFReduceEnd(), PetscSFSetGraph()
1695a1729e3fSJunchao Zhang @*/
1696a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpEnd(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op)
1697a1729e3fSJunchao Zhang {
1698a1729e3fSJunchao Zhang   PetscErrorCode ierr;
1699a1729e3fSJunchao Zhang 
1700a1729e3fSJunchao Zhang   PetscFunctionBegin;
1701a1729e3fSJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1702a1729e3fSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
170300816365SJunchao Zhang   ierr = (*sf->ops->FetchAndOpEnd)(sf,unit,rootdata,leafdata,leafupdate,op);CHKERRQ(ierr);
1704a1729e3fSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr);
1705a1729e3fSJunchao Zhang   PetscFunctionReturn(0);
1706a1729e3fSJunchao Zhang }
1707a1729e3fSJunchao Zhang 
1708a1729e3fSJunchao Zhang /*@C
170995fce210SBarry Smith    PetscSFComputeDegreeBegin - begin computation of degree for each root vertex, to be completed with PetscSFComputeDegreeEnd()
171095fce210SBarry Smith 
171195fce210SBarry Smith    Collective
171295fce210SBarry Smith 
17134165533cSJose E. Roman    Input Parameter:
171495fce210SBarry Smith .  sf - star forest
171595fce210SBarry Smith 
17164165533cSJose E. Roman    Output Parameter:
171795fce210SBarry Smith .  degree - degree of each root vertex
171895fce210SBarry Smith 
171995fce210SBarry Smith    Level: advanced
172095fce210SBarry Smith 
1721ffe67aa5SVáclav Hapla    Notes:
1722ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1723ffe67aa5SVáclav Hapla 
172495fce210SBarry Smith .seealso: PetscSFGatherBegin()
172595fce210SBarry Smith @*/
172695fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeBegin(PetscSF sf,const PetscInt **degree)
172795fce210SBarry Smith {
172895fce210SBarry Smith   PetscErrorCode ierr;
172995fce210SBarry Smith 
173095fce210SBarry Smith   PetscFunctionBegin;
173195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
173295fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
173395fce210SBarry Smith   PetscValidPointer(degree,2);
1734803bd9e8SMatthew G. Knepley   if (!sf->degreeknown) {
17355b0d146aSStefano Zampini     PetscInt i, nroots = sf->nroots, maxlocal;
1736803bd9e8SMatthew G. Knepley     if (sf->degree) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Calls to PetscSFComputeDegreeBegin() cannot be nested.");
17375b0d146aSStefano Zampini     maxlocal = sf->maxleaf-sf->minleaf+1;
173829046d53SLisandro Dalcin     ierr = PetscMalloc1(nroots,&sf->degree);CHKERRQ(ierr);
173929046d53SLisandro Dalcin     ierr = PetscMalloc1(PetscMax(maxlocal,1),&sf->degreetmp);CHKERRQ(ierr); /* allocate at least one entry, see check in PetscSFComputeDegreeEnd() */
174029046d53SLisandro Dalcin     for (i=0; i<nroots; i++) sf->degree[i] = 0;
17419837ea96SMatthew G. Knepley     for (i=0; i<maxlocal; i++) sf->degreetmp[i] = 1;
17425b0d146aSStefano Zampini     ierr = PetscSFReduceBegin(sf,MPIU_INT,sf->degreetmp-sf->minleaf,sf->degree,MPI_SUM);CHKERRQ(ierr);
174395fce210SBarry Smith   }
174495fce210SBarry Smith   *degree = NULL;
174595fce210SBarry Smith   PetscFunctionReturn(0);
174695fce210SBarry Smith }
174795fce210SBarry Smith 
174895fce210SBarry Smith /*@C
174995fce210SBarry Smith    PetscSFComputeDegreeEnd - complete computation of degree for each root vertex, started with PetscSFComputeDegreeBegin()
175095fce210SBarry Smith 
175195fce210SBarry Smith    Collective
175295fce210SBarry Smith 
17534165533cSJose E. Roman    Input Parameter:
175495fce210SBarry Smith .  sf - star forest
175595fce210SBarry Smith 
17564165533cSJose E. Roman    Output Parameter:
175795fce210SBarry Smith .  degree - degree of each root vertex
175895fce210SBarry Smith 
175995fce210SBarry Smith    Level: developer
176095fce210SBarry Smith 
1761ffe67aa5SVáclav Hapla    Notes:
1762ffe67aa5SVáclav Hapla    The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it.
1763ffe67aa5SVáclav Hapla 
176495fce210SBarry Smith .seealso:
176595fce210SBarry Smith @*/
176695fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeEnd(PetscSF sf,const PetscInt **degree)
176795fce210SBarry Smith {
176895fce210SBarry Smith   PetscErrorCode ierr;
176995fce210SBarry Smith 
177095fce210SBarry Smith   PetscFunctionBegin;
177195fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
177295fce210SBarry Smith   PetscSFCheckGraphSet(sf,1);
177329046d53SLisandro Dalcin   PetscValidPointer(degree,2);
177495fce210SBarry Smith   if (!sf->degreeknown) {
177529046d53SLisandro Dalcin     if (!sf->degreetmp) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call PetscSFComputeDegreeBegin() before PetscSFComputeDegreeEnd()");
17765b0d146aSStefano Zampini     ierr = PetscSFReduceEnd(sf,MPIU_INT,sf->degreetmp-sf->minleaf,sf->degree,MPI_SUM);CHKERRQ(ierr);
177795fce210SBarry Smith     ierr = PetscFree(sf->degreetmp);CHKERRQ(ierr);
177895fce210SBarry Smith     sf->degreeknown = PETSC_TRUE;
177995fce210SBarry Smith   }
178095fce210SBarry Smith   *degree = sf->degree;
178195fce210SBarry Smith   PetscFunctionReturn(0);
178295fce210SBarry Smith }
178395fce210SBarry Smith 
1784673100f5SVaclav Hapla /*@C
178566dfcd1aSVaclav Hapla    PetscSFComputeMultiRootOriginalNumbering - Returns original numbering of multi-roots (roots of multi-SF returned by PetscSFGetMultiSF()).
178666dfcd1aSVaclav Hapla    Each multi-root is assigned index of the corresponding original root.
1787673100f5SVaclav Hapla 
1788673100f5SVaclav Hapla    Collective
1789673100f5SVaclav Hapla 
17904165533cSJose E. Roman    Input Parameters:
1791673100f5SVaclav Hapla +  sf - star forest
1792673100f5SVaclav Hapla -  degree - degree of each root vertex, computed with PetscSFComputeDegreeBegin()/PetscSFComputeDegreeEnd()
1793673100f5SVaclav Hapla 
17944165533cSJose E. Roman    Output Parameters:
179566dfcd1aSVaclav Hapla +  nMultiRoots - (optional) number of multi-roots (roots of multi-SF)
179666dfcd1aSVaclav Hapla -  multiRootsOrigNumbering - original indices of multi-roots; length of this array is nMultiRoots
1797673100f5SVaclav Hapla 
1798673100f5SVaclav Hapla    Level: developer
1799673100f5SVaclav Hapla 
1800ffe67aa5SVáclav Hapla    Notes:
1801ffe67aa5SVáclav Hapla    The returned array multiRootsOrigNumbering is newly allocated and should be destroyed with PetscFree() when no longer needed.
1802ffe67aa5SVáclav Hapla 
1803673100f5SVaclav Hapla .seealso: PetscSFComputeDegreeBegin(), PetscSFComputeDegreeEnd(), PetscSFGetMultiSF()
1804673100f5SVaclav Hapla @*/
180566dfcd1aSVaclav Hapla PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF sf, const PetscInt degree[], PetscInt *nMultiRoots, PetscInt *multiRootsOrigNumbering[])
1806673100f5SVaclav Hapla {
1807673100f5SVaclav Hapla   PetscSF             msf;
1808673100f5SVaclav Hapla   PetscInt            i, j, k, nroots, nmroots;
1809673100f5SVaclav Hapla   PetscErrorCode      ierr;
1810673100f5SVaclav Hapla 
1811673100f5SVaclav Hapla   PetscFunctionBegin;
1812673100f5SVaclav Hapla   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
1813673100f5SVaclav Hapla   ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr);
181429328920SVaclav Hapla   if (nroots) PetscValidIntPointer(degree,2);
181566dfcd1aSVaclav Hapla   if (nMultiRoots) PetscValidIntPointer(nMultiRoots,3);
181666dfcd1aSVaclav Hapla   PetscValidPointer(multiRootsOrigNumbering,4);
1817673100f5SVaclav Hapla   ierr = PetscSFGetMultiSF(sf,&msf);CHKERRQ(ierr);
1818673100f5SVaclav Hapla   ierr = PetscSFGetGraph(msf, &nmroots, NULL, NULL, NULL);CHKERRQ(ierr);
181966dfcd1aSVaclav Hapla   ierr = PetscMalloc1(nmroots, multiRootsOrigNumbering);CHKERRQ(ierr);
1820673100f5SVaclav Hapla   for (i=0,j=0,k=0; i<nroots; i++) {
1821673100f5SVaclav Hapla     if (!degree[i]) continue;
1822673100f5SVaclav Hapla     for (j=0; j<degree[i]; j++,k++) {
182366dfcd1aSVaclav Hapla       (*multiRootsOrigNumbering)[k] = i;
1824673100f5SVaclav Hapla     }
1825673100f5SVaclav Hapla   }
1826673100f5SVaclav Hapla   if (PetscUnlikely(k != nmroots)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"sanity check fail");
182766dfcd1aSVaclav Hapla   if (nMultiRoots) *nMultiRoots = nmroots;
1828673100f5SVaclav Hapla   PetscFunctionReturn(0);
1829673100f5SVaclav Hapla }
1830673100f5SVaclav Hapla 
183195fce210SBarry Smith /*@C
183295fce210SBarry Smith    PetscSFGatherBegin - begin pointwise gather of all leaves into multi-roots, to be completed with PetscSFGatherEnd()
183395fce210SBarry Smith 
183495fce210SBarry Smith    Collective
183595fce210SBarry Smith 
18364165533cSJose E. Roman    Input Parameters:
183795fce210SBarry Smith +  sf - star forest
183895fce210SBarry Smith .  unit - data type
183995fce210SBarry Smith -  leafdata - leaf data to gather to roots
184095fce210SBarry Smith 
18414165533cSJose E. Roman    Output Parameter:
184295fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
184395fce210SBarry Smith 
184495fce210SBarry Smith    Level: intermediate
184595fce210SBarry Smith 
184695fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
184795fce210SBarry Smith @*/
184895fce210SBarry Smith PetscErrorCode PetscSFGatherBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
184995fce210SBarry Smith {
185095fce210SBarry Smith   PetscErrorCode ierr;
1851a5526d50SJunchao Zhang   PetscSF        multi = NULL;
185295fce210SBarry Smith 
185395fce210SBarry Smith   PetscFunctionBegin;
185495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
185529046d53SLisandro Dalcin   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
185695fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
185783df288dSJunchao Zhang   ierr = PetscSFReduceBegin(multi,unit,leafdata,multirootdata,MPI_REPLACE);CHKERRQ(ierr);
185895fce210SBarry Smith   PetscFunctionReturn(0);
185995fce210SBarry Smith }
186095fce210SBarry Smith 
186195fce210SBarry Smith /*@C
186295fce210SBarry Smith    PetscSFGatherEnd - ends pointwise gather operation that was started with PetscSFGatherBegin()
186395fce210SBarry Smith 
186495fce210SBarry Smith    Collective
186595fce210SBarry Smith 
18664165533cSJose E. Roman    Input Parameters:
186795fce210SBarry Smith +  sf - star forest
186895fce210SBarry Smith .  unit - data type
186995fce210SBarry Smith -  leafdata - leaf data to gather to roots
187095fce210SBarry Smith 
18714165533cSJose E. Roman    Output Parameter:
187295fce210SBarry Smith .  multirootdata - root buffer to gather into, amount of space per root is equal to its degree
187395fce210SBarry Smith 
187495fce210SBarry Smith    Level: intermediate
187595fce210SBarry Smith 
187695fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
187795fce210SBarry Smith @*/
187895fce210SBarry Smith PetscErrorCode PetscSFGatherEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata)
187995fce210SBarry Smith {
188095fce210SBarry Smith   PetscErrorCode ierr;
1881a5526d50SJunchao Zhang   PetscSF        multi = NULL;
188295fce210SBarry Smith 
188395fce210SBarry Smith   PetscFunctionBegin;
188495fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
188595fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
188683df288dSJunchao Zhang   ierr = PetscSFReduceEnd(multi,unit,leafdata,multirootdata,MPI_REPLACE);CHKERRQ(ierr);
188795fce210SBarry Smith   PetscFunctionReturn(0);
188895fce210SBarry Smith }
188995fce210SBarry Smith 
189095fce210SBarry Smith /*@C
189195fce210SBarry Smith    PetscSFScatterBegin - begin pointwise scatter operation from multi-roots to leaves, to be completed with PetscSFScatterEnd()
189295fce210SBarry Smith 
189395fce210SBarry Smith    Collective
189495fce210SBarry Smith 
18954165533cSJose E. Roman    Input Parameters:
189695fce210SBarry Smith +  sf - star forest
189795fce210SBarry Smith .  unit - data type
189895fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
189995fce210SBarry Smith 
19004165533cSJose E. Roman    Output Parameter:
190195fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
190295fce210SBarry Smith 
190395fce210SBarry Smith    Level: intermediate
190495fce210SBarry Smith 
190595fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin()
190695fce210SBarry Smith @*/
190795fce210SBarry Smith PetscErrorCode PetscSFScatterBegin(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
190895fce210SBarry Smith {
190995fce210SBarry Smith   PetscErrorCode ierr;
1910a5526d50SJunchao Zhang   PetscSF        multi = NULL;
191195fce210SBarry Smith 
191295fce210SBarry Smith   PetscFunctionBegin;
191395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
191495fce210SBarry Smith   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
191595fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
1916ad227feaSJunchao Zhang   ierr = PetscSFBcastBegin(multi,unit,multirootdata,leafdata,MPI_REPLACE);CHKERRQ(ierr);
191795fce210SBarry Smith   PetscFunctionReturn(0);
191895fce210SBarry Smith }
191995fce210SBarry Smith 
192095fce210SBarry Smith /*@C
192195fce210SBarry Smith    PetscSFScatterEnd - ends pointwise scatter operation that was started with PetscSFScatterBegin()
192295fce210SBarry Smith 
192395fce210SBarry Smith    Collective
192495fce210SBarry Smith 
19254165533cSJose E. Roman    Input Parameters:
192695fce210SBarry Smith +  sf - star forest
192795fce210SBarry Smith .  unit - data type
192895fce210SBarry Smith -  multirootdata - root buffer to send to each leaf, one unit of data per leaf
192995fce210SBarry Smith 
19304165533cSJose E. Roman    Output Parameter:
193195fce210SBarry Smith .  leafdata - leaf data to be update with personal data from each respective root
193295fce210SBarry Smith 
193395fce210SBarry Smith    Level: intermediate
193495fce210SBarry Smith 
193595fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd()
193695fce210SBarry Smith @*/
193795fce210SBarry Smith PetscErrorCode PetscSFScatterEnd(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata)
193895fce210SBarry Smith {
193995fce210SBarry Smith   PetscErrorCode ierr;
1940a5526d50SJunchao Zhang   PetscSF        multi = NULL;
194195fce210SBarry Smith 
194295fce210SBarry Smith   PetscFunctionBegin;
194395fce210SBarry Smith   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
194495fce210SBarry Smith   ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr);
1945ad227feaSJunchao Zhang   ierr = PetscSFBcastEnd(multi,unit,multirootdata,leafdata,MPI_REPLACE);CHKERRQ(ierr);
194695fce210SBarry Smith   PetscFunctionReturn(0);
194795fce210SBarry Smith }
1948a7b3aa13SAta Mesgarnejad 
1949a072220fSLawrence Mitchell static PetscErrorCode PetscSFCheckLeavesUnique_Private(PetscSF sf)
1950a072220fSLawrence Mitchell {
1951a072220fSLawrence Mitchell   PetscInt        i, n, nleaves;
1952a072220fSLawrence Mitchell   const PetscInt *ilocal = NULL;
1953a072220fSLawrence Mitchell   PetscHSetI      seen;
1954a072220fSLawrence Mitchell   PetscErrorCode  ierr;
1955a072220fSLawrence Mitchell 
1956a072220fSLawrence Mitchell   PetscFunctionBegin;
1957b458e8f1SJose E. Roman   if (PetscDefined(USE_DEBUG)) {
1958a072220fSLawrence Mitchell     ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,NULL);CHKERRQ(ierr);
1959a072220fSLawrence Mitchell     ierr = PetscHSetICreate(&seen);CHKERRQ(ierr);
1960a072220fSLawrence Mitchell     for (i = 0; i < nleaves; i++) {
1961a072220fSLawrence Mitchell       const PetscInt leaf = ilocal ? ilocal[i] : i;
1962a072220fSLawrence Mitchell       ierr = PetscHSetIAdd(seen,leaf);CHKERRQ(ierr);
1963a072220fSLawrence Mitchell     }
1964a072220fSLawrence Mitchell     ierr = PetscHSetIGetSize(seen,&n);CHKERRQ(ierr);
1965a072220fSLawrence Mitchell     if (n != nleaves) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided leaves have repeated values: all leaves must be unique");
1966a072220fSLawrence Mitchell     ierr = PetscHSetIDestroy(&seen);CHKERRQ(ierr);
1967b458e8f1SJose E. Roman   }
1968a072220fSLawrence Mitchell   PetscFunctionReturn(0);
1969a072220fSLawrence Mitchell }
197054729392SStefano Zampini 
1971a7b3aa13SAta Mesgarnejad /*@
197204c0ada0SJunchao Zhang   PetscSFCompose - Compose a new PetscSF by putting the second SF under the first one in a top (roots) down (leaves) view
1973a7b3aa13SAta Mesgarnejad 
1974a7b3aa13SAta Mesgarnejad   Input Parameters:
197554729392SStefano Zampini + sfA - The first PetscSF
197654729392SStefano Zampini - sfB - The second PetscSF
1977a7b3aa13SAta Mesgarnejad 
1978a7b3aa13SAta Mesgarnejad   Output Parameters:
197954729392SStefano Zampini . sfBA - The composite SF
1980a7b3aa13SAta Mesgarnejad 
1981a7b3aa13SAta Mesgarnejad   Level: developer
1982a7b3aa13SAta Mesgarnejad 
1983a072220fSLawrence Mitchell   Notes:
198454729392SStefano Zampini   Currently, the two SFs must be defined on congruent communicators and they must be true star
198554729392SStefano Zampini   forests, i.e. the same leaf is not connected with different roots.
198654729392SStefano Zampini 
198754729392SStefano Zampini   sfA's leaf space and sfB's root space might be partially overlapped. The composition builds
198854729392SStefano Zampini   a graph with sfA's roots and sfB's leaves only when there is a path between them. Unconnected
198954729392SStefano Zampini   nodes (roots or leaves) are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a
199054729392SStefano Zampini   Bcast on sfA, then a Bcast on sfB, on connected nodes.
1991a072220fSLawrence Mitchell 
199204c0ada0SJunchao Zhang .seealso: PetscSF, PetscSFComposeInverse(), PetscSFGetGraph(), PetscSFSetGraph()
1993a7b3aa13SAta Mesgarnejad @*/
1994a7b3aa13SAta Mesgarnejad PetscErrorCode PetscSFCompose(PetscSF sfA,PetscSF sfB,PetscSF *sfBA)
1995a7b3aa13SAta Mesgarnejad {
199604c0ada0SJunchao Zhang   PetscErrorCode    ierr;
1997a7b3aa13SAta Mesgarnejad   const PetscSFNode *remotePointsA,*remotePointsB;
1998d41018fbSJunchao Zhang   PetscSFNode       *remotePointsBA=NULL,*reorderedRemotePointsA = NULL,*leafdataB;
199954729392SStefano Zampini   const PetscInt    *localPointsA,*localPointsB;
200054729392SStefano Zampini   PetscInt          *localPointsBA;
200154729392SStefano Zampini   PetscInt          i,numRootsA,numLeavesA,numRootsB,numLeavesB,minleaf,maxleaf,numLeavesBA;
200254729392SStefano Zampini   PetscBool         denseB;
2003a7b3aa13SAta Mesgarnejad 
2004a7b3aa13SAta Mesgarnejad   PetscFunctionBegin;
2005a7b3aa13SAta Mesgarnejad   PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1);
200629046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfA,1);
200729046d53SLisandro Dalcin   PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2);
200829046d53SLisandro Dalcin   PetscSFCheckGraphSet(sfB,2);
200954729392SStefano Zampini   PetscCheckSameComm(sfA,1,sfB,2);
201029046d53SLisandro Dalcin   PetscValidPointer(sfBA,3);
201154729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr);
201254729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr);
201354729392SStefano Zampini 
2014a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfA,&numRootsA,&numLeavesA,&localPointsA,&remotePointsA);CHKERRQ(ierr);
2015a7b3aa13SAta Mesgarnejad   ierr = PetscSFGetGraph(sfB,&numRootsB,&numLeavesB,&localPointsB,&remotePointsB);CHKERRQ(ierr);
2016d41018fbSJunchao Zhang   if (localPointsA) {
201754729392SStefano Zampini     ierr = PetscMalloc1(numRootsB,&reorderedRemotePointsA);CHKERRQ(ierr);
201854729392SStefano Zampini     for (i=0; i<numRootsB; i++) {
201954729392SStefano Zampini       reorderedRemotePointsA[i].rank = -1;
202054729392SStefano Zampini       reorderedRemotePointsA[i].index = -1;
202154729392SStefano Zampini     }
202254729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
202354729392SStefano Zampini       if (localPointsA[i] >= numRootsB) continue;
202454729392SStefano Zampini       reorderedRemotePointsA[localPointsA[i]] = remotePointsA[i];
202554729392SStefano Zampini     }
2026d41018fbSJunchao Zhang     remotePointsA = reorderedRemotePointsA;
2027d41018fbSJunchao Zhang   }
2028d41018fbSJunchao Zhang   ierr = PetscSFGetLeafRange(sfB,&minleaf,&maxleaf);CHKERRQ(ierr);
2029d41018fbSJunchao Zhang   ierr = PetscMalloc1(maxleaf-minleaf+1,&leafdataB);CHKERRQ(ierr);
2030ad227feaSJunchao Zhang   ierr = PetscSFBcastBegin(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf,MPI_REPLACE);CHKERRQ(ierr);
2031ad227feaSJunchao Zhang   ierr = PetscSFBcastEnd(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf,MPI_REPLACE);CHKERRQ(ierr);
2032d41018fbSJunchao Zhang   ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr);
2033d41018fbSJunchao Zhang 
203454729392SStefano Zampini   denseB = (PetscBool)!localPointsB;
203554729392SStefano Zampini   for (i=0,numLeavesBA=0; i<numLeavesB; i++) {
203654729392SStefano Zampini     if (leafdataB[localPointsB ? localPointsB[i]-minleaf : i].rank == -1) denseB = PETSC_FALSE;
203754729392SStefano Zampini     else numLeavesBA++;
203854729392SStefano Zampini   }
203954729392SStefano Zampini   if (denseB) {
2040d41018fbSJunchao Zhang     localPointsBA  = NULL;
2041d41018fbSJunchao Zhang     remotePointsBA = leafdataB;
2042d41018fbSJunchao Zhang   } else {
204354729392SStefano Zampini     ierr = PetscMalloc1(numLeavesBA,&localPointsBA);CHKERRQ(ierr);
204454729392SStefano Zampini     ierr = PetscMalloc1(numLeavesBA,&remotePointsBA);CHKERRQ(ierr);
204554729392SStefano Zampini     for (i=0,numLeavesBA=0; i<numLeavesB; i++) {
204654729392SStefano Zampini       const PetscInt l = localPointsB ? localPointsB[i] : i;
204754729392SStefano Zampini 
204854729392SStefano Zampini       if (leafdataB[l-minleaf].rank == -1) continue;
204954729392SStefano Zampini       remotePointsBA[numLeavesBA] = leafdataB[l-minleaf];
205054729392SStefano Zampini       localPointsBA[numLeavesBA] = l;
205154729392SStefano Zampini       numLeavesBA++;
205254729392SStefano Zampini     }
2053d41018fbSJunchao Zhang     ierr = PetscFree(leafdataB);CHKERRQ(ierr);
2054d41018fbSJunchao Zhang   }
205554729392SStefano Zampini   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr);
205620c24465SJunchao Zhang   ierr = PetscSFSetFromOptions(*sfBA);CHKERRQ(ierr);
205754729392SStefano Zampini   ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr);
2058a7b3aa13SAta Mesgarnejad   PetscFunctionReturn(0);
2059a7b3aa13SAta Mesgarnejad }
20601c6ba672SJunchao Zhang 
206104c0ada0SJunchao Zhang /*@
206254729392SStefano Zampini   PetscSFComposeInverse - Compose a new PetscSF by putting the inverse of the second SF under the first one
206304c0ada0SJunchao Zhang 
206404c0ada0SJunchao Zhang   Input Parameters:
206554729392SStefano Zampini + sfA - The first PetscSF
206654729392SStefano Zampini - sfB - The second PetscSF
206704c0ada0SJunchao Zhang 
206804c0ada0SJunchao Zhang   Output Parameters:
206954729392SStefano Zampini . sfBA - The composite SF.
207004c0ada0SJunchao Zhang 
207104c0ada0SJunchao Zhang   Level: developer
207204c0ada0SJunchao Zhang 
207354729392SStefano Zampini   Notes:
207454729392SStefano Zampini   Currently, the two SFs must be defined on congruent communicators and they must be true star
207554729392SStefano Zampini   forests, i.e. the same leaf is not connected with different roots. Even more, all roots of the
207654729392SStefano Zampini   second SF must have a degree of 1, i.e., no roots have more than one leaf connected.
207754729392SStefano Zampini 
207854729392SStefano Zampini   sfA's leaf space and sfB's leaf space might be partially overlapped. The composition builds
207954729392SStefano Zampini   a graph with sfA's roots and sfB's roots only when there is a path between them. Unconnected
208054729392SStefano Zampini   roots are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a Bcast on sfA, then
208154729392SStefano Zampini   a Reduce on sfB, on connected roots.
208254729392SStefano Zampini 
208354729392SStefano Zampini .seealso: PetscSF, PetscSFCompose(), PetscSFGetGraph(), PetscSFSetGraph(), PetscSFCreateInverseSF()
208404c0ada0SJunchao Zhang @*/
208504c0ada0SJunchao Zhang PetscErrorCode PetscSFComposeInverse(PetscSF sfA,PetscSF sfB,PetscSF *sfBA)
208604c0ada0SJunchao Zhang {
208704c0ada0SJunchao Zhang   PetscErrorCode    ierr;
208804c0ada0SJunchao Zhang   const PetscSFNode *remotePointsA,*remotePointsB;
208904c0ada0SJunchao Zhang   PetscSFNode       *remotePointsBA;
209004c0ada0SJunchao Zhang   const PetscInt    *localPointsA,*localPointsB;
209154729392SStefano Zampini   PetscSFNode       *reorderedRemotePointsA = NULL;
209254729392SStefano Zampini   PetscInt          i,numRootsA,numLeavesA,numLeavesBA,numRootsB,numLeavesB,minleaf,maxleaf,*localPointsBA;
20935b0d146aSStefano Zampini   MPI_Op            op;
20945b0d146aSStefano Zampini #if defined(PETSC_USE_64BIT_INDICES)
20955b0d146aSStefano Zampini   PetscBool         iswin;
20965b0d146aSStefano Zampini #endif
209704c0ada0SJunchao Zhang 
209804c0ada0SJunchao Zhang   PetscFunctionBegin;
209904c0ada0SJunchao Zhang   PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1);
210004c0ada0SJunchao Zhang   PetscSFCheckGraphSet(sfA,1);
210104c0ada0SJunchao Zhang   PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2);
210204c0ada0SJunchao Zhang   PetscSFCheckGraphSet(sfB,2);
210354729392SStefano Zampini   PetscCheckSameComm(sfA,1,sfB,2);
210404c0ada0SJunchao Zhang   PetscValidPointer(sfBA,3);
210554729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr);
210654729392SStefano Zampini   ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr);
210754729392SStefano Zampini 
210804c0ada0SJunchao Zhang   ierr = PetscSFGetGraph(sfA, &numRootsA, &numLeavesA, &localPointsA, &remotePointsA);CHKERRQ(ierr);
210904c0ada0SJunchao Zhang   ierr = PetscSFGetGraph(sfB, &numRootsB, &numLeavesB, &localPointsB, &remotePointsB);CHKERRQ(ierr);
21105b0d146aSStefano Zampini 
21115b0d146aSStefano Zampini   /* TODO: Check roots of sfB have degree of 1 */
21125b0d146aSStefano Zampini   /* Once we implement it, we can replace the MPI_MAXLOC
211383df288dSJunchao Zhang      with MPI_REPLACE. In that case, MPI_MAXLOC and MPI_REPLACE have the same effect.
21145b0d146aSStefano Zampini      We use MPI_MAXLOC only to have a deterministic output from this routine if
21155b0d146aSStefano Zampini      the root condition is not meet.
21165b0d146aSStefano Zampini    */
21175b0d146aSStefano Zampini   op = MPI_MAXLOC;
21185b0d146aSStefano Zampini #if defined(PETSC_USE_64BIT_INDICES)
21195b0d146aSStefano Zampini   /* we accept a non-deterministic output (if any) with PETSCSFWINDOW, since MPI_MAXLOC cannot operate on MPIU_2INT with MPI_Accumulate */
21205b0d146aSStefano Zampini   ierr = PetscObjectTypeCompare((PetscObject)sfB,PETSCSFWINDOW,&iswin);CHKERRQ(ierr);
212183df288dSJunchao Zhang   if (iswin) op = MPI_REPLACE;
21225b0d146aSStefano Zampini #endif
21235b0d146aSStefano Zampini 
212454729392SStefano Zampini   ierr = PetscSFGetLeafRange(sfB, &minleaf, &maxleaf);CHKERRQ(ierr);
212554729392SStefano Zampini   ierr = PetscMalloc1(maxleaf - minleaf + 1,&reorderedRemotePointsA);CHKERRQ(ierr);
212654729392SStefano Zampini   for (i=0; i<maxleaf - minleaf + 1; i++) {
212754729392SStefano Zampini     reorderedRemotePointsA[i].rank = -1;
212854729392SStefano Zampini     reorderedRemotePointsA[i].index = -1;
212954729392SStefano Zampini   }
213054729392SStefano Zampini   if (localPointsA) {
213154729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
213254729392SStefano Zampini       if (localPointsA[i] > maxleaf || localPointsA[i] < minleaf) continue;
213354729392SStefano Zampini       reorderedRemotePointsA[localPointsA[i] - minleaf] = remotePointsA[i];
213454729392SStefano Zampini     }
213554729392SStefano Zampini   } else {
213654729392SStefano Zampini     for (i=0; i<numLeavesA; i++) {
213754729392SStefano Zampini       if (i > maxleaf || i < minleaf) continue;
213854729392SStefano Zampini       reorderedRemotePointsA[i - minleaf] = remotePointsA[i];
213954729392SStefano Zampini     }
214054729392SStefano Zampini   }
214154729392SStefano Zampini 
214254729392SStefano Zampini   ierr = PetscMalloc1(numRootsB,&localPointsBA);CHKERRQ(ierr);
214304c0ada0SJunchao Zhang   ierr = PetscMalloc1(numRootsB,&remotePointsBA);CHKERRQ(ierr);
214454729392SStefano Zampini   for (i=0; i<numRootsB; i++) {
214554729392SStefano Zampini     remotePointsBA[i].rank = -1;
214654729392SStefano Zampini     remotePointsBA[i].index = -1;
214754729392SStefano Zampini   }
214854729392SStefano Zampini 
21495b0d146aSStefano Zampini   ierr = PetscSFReduceBegin(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,op);CHKERRQ(ierr);
21505b0d146aSStefano Zampini   ierr = PetscSFReduceEnd(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,op);CHKERRQ(ierr);
215154729392SStefano Zampini   ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr);
215254729392SStefano Zampini   for (i=0,numLeavesBA=0; i<numRootsB; i++) {
215354729392SStefano Zampini     if (remotePointsBA[i].rank == -1) continue;
215454729392SStefano Zampini     remotePointsBA[numLeavesBA].rank = remotePointsBA[i].rank;
215554729392SStefano Zampini     remotePointsBA[numLeavesBA].index = remotePointsBA[i].index;
215654729392SStefano Zampini     localPointsBA[numLeavesBA] = i;
215754729392SStefano Zampini     numLeavesBA++;
215854729392SStefano Zampini   }
215954729392SStefano Zampini   ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr);
216020c24465SJunchao Zhang   ierr = PetscSFSetFromOptions(*sfBA);CHKERRQ(ierr);
216154729392SStefano Zampini   ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr);
216204c0ada0SJunchao Zhang   PetscFunctionReturn(0);
216304c0ada0SJunchao Zhang }
216404c0ada0SJunchao Zhang 
21651c6ba672SJunchao Zhang /*
21661c6ba672SJunchao Zhang   PetscSFCreateLocalSF_Private - Creates a local PetscSF that only has intra-process edges of the global PetscSF
21671c6ba672SJunchao Zhang 
21681c6ba672SJunchao Zhang   Input Parameters:
21691c6ba672SJunchao Zhang . sf - The global PetscSF
21701c6ba672SJunchao Zhang 
21711c6ba672SJunchao Zhang   Output Parameters:
21721c6ba672SJunchao Zhang . out - The local PetscSF
21731c6ba672SJunchao Zhang  */
21741c6ba672SJunchao Zhang PetscErrorCode PetscSFCreateLocalSF_Private(PetscSF sf,PetscSF *out)
21751c6ba672SJunchao Zhang {
21761c6ba672SJunchao Zhang   MPI_Comm           comm;
21771c6ba672SJunchao Zhang   PetscMPIInt        myrank;
21781c6ba672SJunchao Zhang   const PetscInt     *ilocal;
21791c6ba672SJunchao Zhang   const PetscSFNode  *iremote;
21801c6ba672SJunchao Zhang   PetscInt           i,j,nroots,nleaves,lnleaves,*lilocal;
21811c6ba672SJunchao Zhang   PetscSFNode        *liremote;
21821c6ba672SJunchao Zhang   PetscSF            lsf;
21831c6ba672SJunchao Zhang   PetscErrorCode     ierr;
21841c6ba672SJunchao Zhang 
21851c6ba672SJunchao Zhang   PetscFunctionBegin;
21861c6ba672SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
21871c6ba672SJunchao Zhang   if (sf->ops->CreateLocalSF) {
21881c6ba672SJunchao Zhang     ierr = (*sf->ops->CreateLocalSF)(sf,out);CHKERRQ(ierr);
21891c6ba672SJunchao Zhang   } else {
21901c6ba672SJunchao Zhang     /* Could use PetscSFCreateEmbeddedLeafSF, but since we know the comm is PETSC_COMM_SELF, we can make it fast */
21911c6ba672SJunchao Zhang     ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr);
2192ffc4695bSBarry Smith     ierr = MPI_Comm_rank(comm,&myrank);CHKERRMPI(ierr);
21931c6ba672SJunchao Zhang 
21941c6ba672SJunchao Zhang     /* Find out local edges and build a local SF */
21951c6ba672SJunchao Zhang     ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr);
21961c6ba672SJunchao Zhang     for (i=lnleaves=0; i<nleaves; i++) {if (iremote[i].rank == (PetscInt)myrank) lnleaves++;}
21971c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&lilocal);CHKERRQ(ierr);
21981c6ba672SJunchao Zhang     ierr = PetscMalloc1(lnleaves,&liremote);CHKERRQ(ierr);
21991c6ba672SJunchao Zhang 
22001c6ba672SJunchao Zhang     for (i=j=0; i<nleaves; i++) {
22011c6ba672SJunchao Zhang       if (iremote[i].rank == (PetscInt)myrank) {
22021c6ba672SJunchao Zhang         lilocal[j]        = ilocal? ilocal[i] : i; /* ilocal=NULL for contiguous storage */
22031c6ba672SJunchao Zhang         liremote[j].rank  = 0; /* rank in PETSC_COMM_SELF */
22041c6ba672SJunchao Zhang         liremote[j].index = iremote[i].index;
22051c6ba672SJunchao Zhang         j++;
22061c6ba672SJunchao Zhang       }
22071c6ba672SJunchao Zhang     }
22081c6ba672SJunchao Zhang     ierr = PetscSFCreate(PETSC_COMM_SELF,&lsf);CHKERRQ(ierr);
220920c24465SJunchao Zhang     ierr = PetscSFSetFromOptions(lsf);CHKERRQ(ierr);
22101c6ba672SJunchao Zhang     ierr = PetscSFSetGraph(lsf,nroots,lnleaves,lilocal,PETSC_OWN_POINTER,liremote,PETSC_OWN_POINTER);CHKERRQ(ierr);
22111c6ba672SJunchao Zhang     ierr = PetscSFSetUp(lsf);CHKERRQ(ierr);
22121c6ba672SJunchao Zhang     *out = lsf;
22131c6ba672SJunchao Zhang   }
22141c6ba672SJunchao Zhang   PetscFunctionReturn(0);
22151c6ba672SJunchao Zhang }
2216dd5b3ca6SJunchao Zhang 
2217dd5b3ca6SJunchao Zhang /* Similar to PetscSFBcast, but only Bcast to leaves on rank 0 */
2218dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFBcastToZero_Private(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata)
2219dd5b3ca6SJunchao Zhang {
2220dd5b3ca6SJunchao Zhang   PetscErrorCode     ierr;
2221eb02082bSJunchao Zhang   PetscMemType       rootmtype,leafmtype;
2222dd5b3ca6SJunchao Zhang 
2223dd5b3ca6SJunchao Zhang   PetscFunctionBegin;
2224dd5b3ca6SJunchao Zhang   PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1);
2225dd5b3ca6SJunchao Zhang   ierr = PetscSFSetUp(sf);CHKERRQ(ierr);
2226ad227feaSJunchao Zhang   ierr = PetscLogEventBegin(PETSCSF_BcastBegin,sf,0,0,0);CHKERRQ(ierr);
2227eb02082bSJunchao Zhang   ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr);
2228eb02082bSJunchao Zhang   ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr);
2229dd5b3ca6SJunchao Zhang   if (sf->ops->BcastToZero) {
2230eb02082bSJunchao Zhang     ierr = (*sf->ops->BcastToZero)(sf,unit,rootmtype,rootdata,leafmtype,leafdata);CHKERRQ(ierr);
2231dd5b3ca6SJunchao Zhang   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFBcastToZero_Private is not supported on this SF type");
2232ad227feaSJunchao Zhang   ierr = PetscLogEventEnd(PETSCSF_BcastBegin,sf,0,0,0);CHKERRQ(ierr);
2233dd5b3ca6SJunchao Zhang   PetscFunctionReturn(0);
2234dd5b3ca6SJunchao Zhang }
2235dd5b3ca6SJunchao Zhang 
2236