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 6495fce210SBarry Smith Input Arguments: 6595fce210SBarry Smith . comm - communicator on which the star forest will operate 6695fce210SBarry Smith 6795fce210SBarry Smith Output Arguments: 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; 10720c24465SJunchao Zhang b->use_default_stream = PETSC_TRUE; /* The assumption is true for PETSc internal use of SF */ 10859af0bd3SScott Kruger /* Set the default */ 10927f636e8SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS) /* Prefer kokkos over cuda*/ 11020c24465SJunchao Zhang b->backend = PETSCSF_BACKEND_KOKKOS; 11127f636e8SJunchao Zhang #elif defined(PETSC_HAVE_CUDA) 11227f636e8SJunchao Zhang b->backend = PETSCSF_BACKEND_CUDA; 11359af0bd3SScott Kruger #elif defined(PETSC_HAVE_HIP) 11459af0bd3SScott Kruger b->backend = PETSCSF_BACKEND_HIP; 11520c24465SJunchao Zhang #endif 11620c24465SJunchao Zhang #endif 11760c22052SBarry Smith b->vscat.from_n = -1; 11860c22052SBarry Smith b->vscat.to_n = -1; 11960c22052SBarry Smith b->vscat.unit = MPIU_SCALAR; 12095fce210SBarry Smith *sf = b; 12195fce210SBarry Smith PetscFunctionReturn(0); 12295fce210SBarry Smith } 12395fce210SBarry Smith 12429046d53SLisandro Dalcin /*@ 12595fce210SBarry Smith PetscSFReset - Reset a star forest so that different sizes or neighbors can be used 12695fce210SBarry Smith 12795fce210SBarry Smith Collective 12895fce210SBarry Smith 12995fce210SBarry Smith Input Arguments: 13095fce210SBarry Smith . sf - star forest 13195fce210SBarry Smith 13295fce210SBarry Smith Level: advanced 13395fce210SBarry Smith 13495fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph(), PetscSFDestroy() 13595fce210SBarry Smith @*/ 13695fce210SBarry Smith PetscErrorCode PetscSFReset(PetscSF sf) 13795fce210SBarry Smith { 13895fce210SBarry Smith PetscErrorCode ierr; 13995fce210SBarry Smith 14095fce210SBarry Smith PetscFunctionBegin; 14195fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 14279715d56SJed Brown if (sf->ops->Reset) {ierr = (*sf->ops->Reset)(sf);CHKERRQ(ierr);} 14329046d53SLisandro Dalcin sf->nroots = -1; 14429046d53SLisandro Dalcin sf->nleaves = -1; 14529046d53SLisandro Dalcin sf->minleaf = PETSC_MAX_INT; 14629046d53SLisandro Dalcin sf->maxleaf = PETSC_MIN_INT; 14795fce210SBarry Smith sf->mine = NULL; 14895fce210SBarry Smith sf->remote = NULL; 14929046d53SLisandro Dalcin sf->graphset = PETSC_FALSE; 15029046d53SLisandro Dalcin ierr = PetscFree(sf->mine_alloc);CHKERRQ(ierr); 15195fce210SBarry Smith ierr = PetscFree(sf->remote_alloc);CHKERRQ(ierr); 15221c688dcSJed Brown sf->nranks = -1; 15329046d53SLisandro Dalcin ierr = PetscFree4(sf->ranks,sf->roffset,sf->rmine,sf->rremote);CHKERRQ(ierr); 1547fd2d3dbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 15520c24465SJunchao Zhang for (PetscInt i=0; i<2; i++) {ierr = PetscSFFree(sf,PETSC_MEMTYPE_DEVICE,sf->rmine_d[i]);CHKERRQ(ierr);} 156eb02082bSJunchao Zhang #endif 15729046d53SLisandro Dalcin sf->degreeknown = PETSC_FALSE; 15895fce210SBarry Smith ierr = PetscFree(sf->degree);CHKERRQ(ierr); 159ffc4695bSBarry Smith if (sf->ingroup != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->ingroup);CHKERRMPI(ierr);} 160ffc4695bSBarry Smith if (sf->outgroup != MPI_GROUP_NULL) {ierr = MPI_Group_free(&sf->outgroup);CHKERRMPI(ierr);} 161*013b3241SStefano Zampini if (sf->multi) sf->multi->multi = NULL; 16295fce210SBarry Smith ierr = PetscSFDestroy(&sf->multi);CHKERRQ(ierr); 163dd5b3ca6SJunchao Zhang ierr = PetscLayoutDestroy(&sf->map);CHKERRQ(ierr); 16495fce210SBarry Smith sf->setupcalled = PETSC_FALSE; 16595fce210SBarry Smith PetscFunctionReturn(0); 16695fce210SBarry Smith } 16795fce210SBarry Smith 16895fce210SBarry Smith /*@C 16929046d53SLisandro Dalcin PetscSFSetType - Set the PetscSF communication implementation 17095fce210SBarry Smith 17195fce210SBarry Smith Collective on PetscSF 17295fce210SBarry Smith 17395fce210SBarry Smith Input Parameters: 17495fce210SBarry Smith + sf - the PetscSF context 17595fce210SBarry Smith - type - a known method 17695fce210SBarry Smith 17795fce210SBarry Smith Options Database Key: 17895fce210SBarry Smith . -sf_type <type> - Sets the method; use -help for a list 17970616304SStefano Zampini of available methods (for instance, window, basic, neighbor) 18095fce210SBarry Smith 18195fce210SBarry Smith Notes: 18295fce210SBarry Smith See "include/petscsf.h" for available methods (for instance) 18395fce210SBarry Smith + PETSCSFWINDOW - MPI-2/3 one-sided 18495fce210SBarry Smith - PETSCSFBASIC - basic implementation using MPI-1 two-sided 18595fce210SBarry Smith 18695fce210SBarry Smith Level: intermediate 18795fce210SBarry Smith 18895fce210SBarry Smith .seealso: PetscSFType, PetscSFCreate() 18995fce210SBarry Smith @*/ 19095fce210SBarry Smith PetscErrorCode PetscSFSetType(PetscSF sf,PetscSFType type) 19195fce210SBarry Smith { 19295fce210SBarry Smith PetscErrorCode ierr,(*r)(PetscSF); 19395fce210SBarry Smith PetscBool match; 19495fce210SBarry Smith 19595fce210SBarry Smith PetscFunctionBegin; 19695fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 19795fce210SBarry Smith PetscValidCharPointer(type,2); 19895fce210SBarry Smith 19995fce210SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)sf,type,&match);CHKERRQ(ierr); 20095fce210SBarry Smith if (match) PetscFunctionReturn(0); 20195fce210SBarry Smith 202adc40e5bSBarry Smith ierr = PetscFunctionListFind(PetscSFList,type,&r);CHKERRQ(ierr); 20395fce210SBarry Smith if (!r) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_UNKNOWN_TYPE,"Unable to find requested PetscSF type %s",type); 20429046d53SLisandro Dalcin /* Destroy the previous PetscSF implementation context */ 20529046d53SLisandro Dalcin if (sf->ops->Destroy) {ierr = (*(sf)->ops->Destroy)(sf);CHKERRQ(ierr);} 20695fce210SBarry Smith ierr = PetscMemzero(sf->ops,sizeof(*sf->ops));CHKERRQ(ierr); 20795fce210SBarry Smith ierr = PetscObjectChangeTypeName((PetscObject)sf,type);CHKERRQ(ierr); 20895fce210SBarry Smith ierr = (*r)(sf);CHKERRQ(ierr); 20995fce210SBarry Smith PetscFunctionReturn(0); 21095fce210SBarry Smith } 21195fce210SBarry Smith 21229046d53SLisandro Dalcin /*@C 21329046d53SLisandro Dalcin PetscSFGetType - Get the PetscSF communication implementation 21429046d53SLisandro Dalcin 21529046d53SLisandro Dalcin Not Collective 21629046d53SLisandro Dalcin 21729046d53SLisandro Dalcin Input Parameter: 21829046d53SLisandro Dalcin . sf - the PetscSF context 21929046d53SLisandro Dalcin 22029046d53SLisandro Dalcin Output Parameter: 22129046d53SLisandro Dalcin . type - the PetscSF type name 22229046d53SLisandro Dalcin 22329046d53SLisandro Dalcin Level: intermediate 22429046d53SLisandro Dalcin 22529046d53SLisandro Dalcin .seealso: PetscSFSetType(), PetscSFCreate() 22629046d53SLisandro Dalcin @*/ 22729046d53SLisandro Dalcin PetscErrorCode PetscSFGetType(PetscSF sf, PetscSFType *type) 22829046d53SLisandro Dalcin { 22929046d53SLisandro Dalcin PetscFunctionBegin; 23029046d53SLisandro Dalcin PetscValidHeaderSpecific(sf, PETSCSF_CLASSID,1); 23129046d53SLisandro Dalcin PetscValidPointer(type,2); 23229046d53SLisandro Dalcin *type = ((PetscObject)sf)->type_name; 23329046d53SLisandro Dalcin PetscFunctionReturn(0); 23429046d53SLisandro Dalcin } 23529046d53SLisandro Dalcin 236d36d33e4SMatthew G. Knepley /*@ 23795fce210SBarry Smith PetscSFDestroy - destroy star forest 23895fce210SBarry Smith 23995fce210SBarry Smith Collective 24095fce210SBarry Smith 24195fce210SBarry Smith Input Arguments: 24295fce210SBarry Smith . sf - address of star forest 24395fce210SBarry Smith 24495fce210SBarry Smith Level: intermediate 24595fce210SBarry Smith 24695fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFReset() 24795fce210SBarry Smith @*/ 24895fce210SBarry Smith PetscErrorCode PetscSFDestroy(PetscSF *sf) 24995fce210SBarry Smith { 25095fce210SBarry Smith PetscErrorCode ierr; 25195fce210SBarry Smith 25295fce210SBarry Smith PetscFunctionBegin; 25395fce210SBarry Smith if (!*sf) PetscFunctionReturn(0); 25495fce210SBarry Smith PetscValidHeaderSpecific((*sf),PETSCSF_CLASSID,1); 25529046d53SLisandro Dalcin if (--((PetscObject)(*sf))->refct > 0) {*sf = NULL; PetscFunctionReturn(0);} 25695fce210SBarry Smith ierr = PetscSFReset(*sf);CHKERRQ(ierr); 25795fce210SBarry Smith if ((*sf)->ops->Destroy) {ierr = (*(*sf)->ops->Destroy)(*sf);CHKERRQ(ierr);} 25897929ea7SJunchao Zhang ierr = PetscSFDestroy(&(*sf)->vscat.lsf);CHKERRQ(ierr); 25997929ea7SJunchao Zhang if ((*sf)->vscat.bs > 1) {ierr = MPI_Type_free(&(*sf)->vscat.unit);CHKERRQ(ierr);} 26095fce210SBarry Smith ierr = PetscHeaderDestroy(sf);CHKERRQ(ierr); 26195fce210SBarry Smith PetscFunctionReturn(0); 26295fce210SBarry Smith } 26395fce210SBarry Smith 264c4e6a40aSLawrence Mitchell static PetscErrorCode PetscSFCheckGraphValid_Private(PetscSF sf) 265c4e6a40aSLawrence Mitchell { 266c4e6a40aSLawrence Mitchell PetscInt i, nleaves; 267c4e6a40aSLawrence Mitchell PetscMPIInt size; 268c4e6a40aSLawrence Mitchell const PetscInt *ilocal; 269c4e6a40aSLawrence Mitchell const PetscSFNode *iremote; 270c4e6a40aSLawrence Mitchell PetscErrorCode ierr; 271c4e6a40aSLawrence Mitchell 272c4e6a40aSLawrence Mitchell PetscFunctionBegin; 27376bd3646SJed Brown if (!sf->graphset || !PetscDefined(USE_DEBUG)) PetscFunctionReturn(0); 274c4e6a40aSLawrence Mitchell ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,&iremote);CHKERRQ(ierr); 275ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRMPI(ierr); 276c4e6a40aSLawrence Mitchell for (i = 0; i < nleaves; i++) { 277c4e6a40aSLawrence Mitchell const PetscInt rank = iremote[i].rank; 278c4e6a40aSLawrence Mitchell const PetscInt remote = iremote[i].index; 279c4e6a40aSLawrence Mitchell const PetscInt leaf = ilocal ? ilocal[i] : i; 280c4e6a40aSLawrence 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); 281c4e6a40aSLawrence 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); 282c4e6a40aSLawrence 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); 283c4e6a40aSLawrence Mitchell } 284c4e6a40aSLawrence Mitchell PetscFunctionReturn(0); 285c4e6a40aSLawrence Mitchell } 286c4e6a40aSLawrence Mitchell 28720c24465SJunchao Zhang 28820c24465SJunchao Zhang 28920c24465SJunchao Zhang 29095fce210SBarry Smith /*@ 29195fce210SBarry Smith PetscSFSetUp - set up communication structures 29295fce210SBarry Smith 29395fce210SBarry Smith Collective 29495fce210SBarry Smith 29595fce210SBarry Smith Input Arguments: 29695fce210SBarry Smith . sf - star forest communication object 29795fce210SBarry Smith 29895fce210SBarry Smith Level: beginner 29995fce210SBarry Smith 30095fce210SBarry Smith .seealso: PetscSFSetFromOptions(), PetscSFSetType() 30195fce210SBarry Smith @*/ 30295fce210SBarry Smith PetscErrorCode PetscSFSetUp(PetscSF sf) 30395fce210SBarry Smith { 30495fce210SBarry Smith PetscErrorCode ierr; 30595fce210SBarry Smith 30695fce210SBarry Smith PetscFunctionBegin; 30729046d53SLisandro Dalcin PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 30829046d53SLisandro Dalcin PetscSFCheckGraphSet(sf,1); 30995fce210SBarry Smith if (sf->setupcalled) PetscFunctionReturn(0); 31029046d53SLisandro Dalcin ierr = PetscLogEventBegin(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr); 31120c24465SJunchao Zhang ierr = PetscSFCheckGraphValid_Private(sf);CHKERRQ(ierr); 31220c24465SJunchao Zhang if (!((PetscObject)sf)->type_name) {ierr = PetscSFSetType(sf,PETSCSFBASIC);CHKERRQ(ierr);} /* Zero all sf->ops */ 31395fce210SBarry Smith if (sf->ops->SetUp) {ierr = (*sf->ops->SetUp)(sf);CHKERRQ(ierr);} 31420c24465SJunchao Zhang #if defined(PETSC_HAVE_CUDA) 31520c24465SJunchao Zhang if (sf->backend == PETSCSF_BACKEND_CUDA) { 31620c24465SJunchao Zhang sf->ops->Malloc = PetscSFMalloc_Cuda; 31720c24465SJunchao Zhang sf->ops->Free = PetscSFFree_Cuda; 31820c24465SJunchao Zhang } 31920c24465SJunchao Zhang #endif 32059af0bd3SScott Kruger #if defined(PETSC_HAVE_HIP) 32159af0bd3SScott Kruger if (sf->backend == PETSCSF_BACKEND_HIP) { 32259af0bd3SScott Kruger sf->ops->Malloc = PetscSFMalloc_HIP; 32359af0bd3SScott Kruger sf->ops->Free = PetscSFFree_HIP; 32459af0bd3SScott Kruger } 32559af0bd3SScott Kruger #endif 32620c24465SJunchao Zhang 32759af0bd3SScott Kruger # 32820c24465SJunchao Zhang #if defined(PETSC_HAVE_KOKKOS) 32920c24465SJunchao Zhang if (sf->backend == PETSCSF_BACKEND_KOKKOS) { 33020c24465SJunchao Zhang sf->ops->Malloc = PetscSFMalloc_Kokkos; 33120c24465SJunchao Zhang sf->ops->Free = PetscSFFree_Kokkos; 33220c24465SJunchao Zhang } 33320c24465SJunchao Zhang #endif 33429046d53SLisandro Dalcin ierr = PetscLogEventEnd(PETSCSF_SetUp,sf,0,0,0);CHKERRQ(ierr); 33595fce210SBarry Smith sf->setupcalled = PETSC_TRUE; 33695fce210SBarry Smith PetscFunctionReturn(0); 33795fce210SBarry Smith } 33895fce210SBarry Smith 3398af6ec1cSBarry Smith /*@ 34095fce210SBarry Smith PetscSFSetFromOptions - set PetscSF options using the options database 34195fce210SBarry Smith 34295fce210SBarry Smith Logically Collective 34395fce210SBarry Smith 34495fce210SBarry Smith Input Arguments: 34595fce210SBarry Smith . sf - star forest 34695fce210SBarry Smith 34795fce210SBarry Smith Options Database Keys: 34860263706SJed Brown + -sf_type - implementation type, see PetscSFSetType() 34951ccb202SJunchao Zhang . -sf_rank_order - sort composite points for gathers and scatters in rank order, gathers are non-deterministic otherwise 350b85e67b7SJunchao Zhang . -sf_use_default_stream - Assume callers of SF computed the input root/leafdata with the default cuda stream. SF will also 351c2a741eeSJunchao Zhang use the default stream to process data. Therefore, no stream synchronization is needed between SF and its caller (default: true). 352c06a8e02SRichard Tran Mills If true, this option only works with -use_gpu_aware_mpi 1. 35320c24465SJunchao 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). 354c06a8e02SRichard Tran Mills If true, this option only works with -use_gpu_aware_mpi 1. 35595fce210SBarry Smith 35659af0bd3SScott Kruger - -sf_backend cuda | hip | kokkos -Select the device backend SF uses. Currently SF has these backends: cuda, hip and Kokkos. 35759af0bd3SScott Kruger On CUDA (HIP) devices, one can choose cuda (hip) or kokkos with the default being kokkos. On other devices, 35820c24465SJunchao Zhang the only available is kokkos. 35920c24465SJunchao Zhang 36095fce210SBarry Smith Level: intermediate 36195fce210SBarry Smith @*/ 36295fce210SBarry Smith PetscErrorCode PetscSFSetFromOptions(PetscSF sf) 36395fce210SBarry Smith { 36495fce210SBarry Smith PetscSFType deft; 36595fce210SBarry Smith char type[256]; 36695fce210SBarry Smith PetscErrorCode ierr; 36795fce210SBarry Smith PetscBool flg; 36895fce210SBarry Smith 36995fce210SBarry Smith PetscFunctionBegin; 37095fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 37195fce210SBarry Smith ierr = PetscObjectOptionsBegin((PetscObject)sf);CHKERRQ(ierr); 37295fce210SBarry Smith deft = ((PetscObject)sf)->type_name ? ((PetscObject)sf)->type_name : PETSCSFBASIC; 37329046d53SLisandro Dalcin ierr = PetscOptionsFList("-sf_type","PetscSF implementation type","PetscSFSetType",PetscSFList,deft,type,sizeof(type),&flg);CHKERRQ(ierr); 37495fce210SBarry Smith ierr = PetscSFSetType(sf,flg ? type : deft);CHKERRQ(ierr); 37595fce210SBarry 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); 3767fd2d3dbSJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 37720c24465SJunchao Zhang { 37820c24465SJunchao Zhang char backendstr[32] = {0}; 37959af0bd3SScott Kruger PetscBool isCuda = PETSC_FALSE,isHip = PETSC_FALSE,isKokkos = PETSC_FALSE,set; 38020c24465SJunchao Zhang /* Change the defaults set in PetscSFCreate() with command line options */ 381cd620004SJunchao Zhang ierr = PetscOptionsBool("-sf_use_default_stream","Assume SF's input and output root/leafdata is computed on the default stream","PetscSFSetFromOptions",sf->use_default_stream,&sf->use_default_stream,NULL);CHKERRQ(ierr); 382b85e67b7SJunchao 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); 38320c24465SJunchao Zhang ierr = PetscOptionsString("-sf_backend","Select the device backend SF uses","PetscSFSetFromOptions",NULL,backendstr,sizeof(backendstr),&set);CHKERRQ(ierr); 38420c24465SJunchao Zhang ierr = PetscStrcasecmp("cuda",backendstr,&isCuda);CHKERRQ(ierr); 38520c24465SJunchao Zhang ierr = PetscStrcasecmp("kokkos",backendstr,&isKokkos);CHKERRQ(ierr); 38659af0bd3SScott Kruger ierr = PetscStrcasecmp("hip",backendstr,&isHip);CHKERRQ(ierr); 38759af0bd3SScott Kruger #if defined(PETSC_HAVE_CUDA) || defined(PETSC_HAVE_HIP) 38820c24465SJunchao Zhang if (isCuda) sf->backend = PETSCSF_BACKEND_CUDA; 38920c24465SJunchao Zhang else if (isKokkos) sf->backend = PETSCSF_BACKEND_KOKKOS; 39059af0bd3SScott Kruger else if (isHip) sf->backend = PETSCSF_BACKEND_HIP; 39159af0bd3SScott 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); 39220c24465SJunchao Zhang #elif defined(PETSC_HAVE_KOKKOS) 39320c24465SJunchao Zhang if (set && !isKokkos) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONG,"-sf_backend %s is not supported. You can only choose kokkos", backendstr); 39420c24465SJunchao Zhang #endif 39520c24465SJunchao Zhang } 396c2a741eeSJunchao Zhang #endif 397e55864a3SBarry Smith if (sf->ops->SetFromOptions) {ierr = (*sf->ops->SetFromOptions)(PetscOptionsObject,sf);CHKERRQ(ierr);} 39895fce210SBarry Smith ierr = PetscOptionsEnd();CHKERRQ(ierr); 39995fce210SBarry Smith PetscFunctionReturn(0); 40095fce210SBarry Smith } 40195fce210SBarry Smith 40229046d53SLisandro Dalcin /*@ 40395fce210SBarry Smith PetscSFSetRankOrder - sort multi-points for gathers and scatters by rank order 40495fce210SBarry Smith 40595fce210SBarry Smith Logically Collective 40695fce210SBarry Smith 40795fce210SBarry Smith Input Arguments: 40895fce210SBarry Smith + sf - star forest 40995fce210SBarry Smith - flg - PETSC_TRUE to sort, PETSC_FALSE to skip sorting (lower setup cost, but non-deterministic) 41095fce210SBarry Smith 41195fce210SBarry Smith Level: advanced 41295fce210SBarry Smith 41395fce210SBarry Smith .seealso: PetscSFGatherBegin(), PetscSFScatterBegin() 41495fce210SBarry Smith @*/ 41595fce210SBarry Smith PetscErrorCode PetscSFSetRankOrder(PetscSF sf,PetscBool flg) 41695fce210SBarry Smith { 41795fce210SBarry Smith PetscFunctionBegin; 41895fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 41995fce210SBarry Smith PetscValidLogicalCollectiveBool(sf,flg,2); 42095fce210SBarry Smith if (sf->multi) SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_WRONGSTATE,"Rank ordering must be set before first call to PetscSFGatherBegin() or PetscSFScatterBegin()"); 42195fce210SBarry Smith sf->rankorder = flg; 42295fce210SBarry Smith PetscFunctionReturn(0); 42395fce210SBarry Smith } 42495fce210SBarry Smith 4258af6ec1cSBarry Smith /*@ 42695fce210SBarry Smith PetscSFSetGraph - Set a parallel star forest 42795fce210SBarry Smith 42895fce210SBarry Smith Collective 42995fce210SBarry Smith 43095fce210SBarry Smith Input Arguments: 43195fce210SBarry Smith + sf - star forest 43295fce210SBarry Smith . nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves) 43395fce210SBarry Smith . nleaves - number of leaf vertices on the current process, each of these references a root on any process 434c4e6a40aSLawrence Mitchell . ilocal - locations of leaves in leafdata buffers, pass NULL for contiguous storage (locations must be >= 0, enforced 435c4e6a40aSLawrence Mitchell during setup in debug mode) 43695fce210SBarry Smith . localmode - copy mode for ilocal 437c4e6a40aSLawrence Mitchell . iremote - remote locations of root vertices for each leaf on the current process (locations must be >= 0, enforced 438c4e6a40aSLawrence Mitchell during setup in debug mode) 43995fce210SBarry Smith - remotemode - copy mode for iremote 44095fce210SBarry Smith 44195fce210SBarry Smith Level: intermediate 44295fce210SBarry Smith 44395452b02SPatrick Sanan Notes: 44495452b02SPatrick Sanan In Fortran you must use PETSC_COPY_VALUES for localmode and remotemode 44538ab3f8aSBarry Smith 4462ad1e87fSLisandro Dalcin Developers Note: Local indices which are the identity permutation in the range [0,nleaves) are discarded as they 4472ad1e87fSLisandro Dalcin encode contiguous storage. In such case, if localmode is PETSC_OWN_POINTER, the memory is deallocated as it is not 4482ad1e87fSLisandro Dalcin needed 4492ad1e87fSLisandro Dalcin 450c4e6a40aSLawrence Mitchell Developers Note: This object does not necessarily encode a true star forest in the graph theoretic sense, since leaf 451c4e6a40aSLawrence Mitchell indices are not required to be unique. Some functions, however, rely on unique leaf indices (checked in debug mode). 452c4e6a40aSLawrence Mitchell 45395fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFGetGraph() 45495fce210SBarry Smith @*/ 45595fce210SBarry Smith PetscErrorCode PetscSFSetGraph(PetscSF sf,PetscInt nroots,PetscInt nleaves,const PetscInt *ilocal,PetscCopyMode localmode,const PetscSFNode *iremote,PetscCopyMode remotemode) 45695fce210SBarry Smith { 45795fce210SBarry Smith PetscErrorCode ierr; 45895fce210SBarry Smith 45995fce210SBarry Smith PetscFunctionBegin; 46095fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 46129046d53SLisandro Dalcin if (nleaves > 0 && ilocal) PetscValidIntPointer(ilocal,4); 46229046d53SLisandro Dalcin if (nleaves > 0) PetscValidPointer(iremote,6); 46329046d53SLisandro Dalcin if (nroots < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nroots %D, cannot be negative",nroots); 46495fce210SBarry Smith if (nleaves < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"nleaves %D, cannot be negative",nleaves); 46529046d53SLisandro Dalcin 4662a67d2daSStefano Zampini if (sf->nroots >= 0) { /* Reset only if graph already set */ 46795fce210SBarry Smith ierr = PetscSFReset(sf);CHKERRQ(ierr); 4682a67d2daSStefano Zampini } 4692a67d2daSStefano Zampini 47029046d53SLisandro Dalcin ierr = PetscLogEventBegin(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr); 47129046d53SLisandro Dalcin 47295fce210SBarry Smith sf->nroots = nroots; 47395fce210SBarry Smith sf->nleaves = nleaves; 47429046d53SLisandro Dalcin 47529046d53SLisandro Dalcin if (nleaves && ilocal) { 47621c688dcSJed Brown PetscInt i; 47729046d53SLisandro Dalcin PetscInt minleaf = PETSC_MAX_INT; 47829046d53SLisandro Dalcin PetscInt maxleaf = PETSC_MIN_INT; 4792ad1e87fSLisandro Dalcin int contiguous = 1; 48029046d53SLisandro Dalcin for (i=0; i<nleaves; i++) { 48129046d53SLisandro Dalcin minleaf = PetscMin(minleaf,ilocal[i]); 48229046d53SLisandro Dalcin maxleaf = PetscMax(maxleaf,ilocal[i]); 4832ad1e87fSLisandro Dalcin contiguous &= (ilocal[i] == i); 48429046d53SLisandro Dalcin } 48529046d53SLisandro Dalcin sf->minleaf = minleaf; 48629046d53SLisandro Dalcin sf->maxleaf = maxleaf; 4872ad1e87fSLisandro Dalcin if (contiguous) { 4882ad1e87fSLisandro Dalcin if (localmode == PETSC_OWN_POINTER) { 4892ad1e87fSLisandro Dalcin ierr = PetscFree(ilocal);CHKERRQ(ierr); 4902ad1e87fSLisandro Dalcin } 4912ad1e87fSLisandro Dalcin ilocal = NULL; 4922ad1e87fSLisandro Dalcin } 49329046d53SLisandro Dalcin } else { 49429046d53SLisandro Dalcin sf->minleaf = 0; 49529046d53SLisandro Dalcin sf->maxleaf = nleaves - 1; 49629046d53SLisandro Dalcin } 49729046d53SLisandro Dalcin 49829046d53SLisandro Dalcin if (ilocal) { 49995fce210SBarry Smith switch (localmode) { 50095fce210SBarry Smith case PETSC_COPY_VALUES: 501785e854fSJed Brown ierr = PetscMalloc1(nleaves,&sf->mine_alloc);CHKERRQ(ierr); 502580bdb30SBarry Smith ierr = PetscArraycpy(sf->mine_alloc,ilocal,nleaves);CHKERRQ(ierr); 50395fce210SBarry Smith sf->mine = sf->mine_alloc; 50495fce210SBarry Smith break; 50595fce210SBarry Smith case PETSC_OWN_POINTER: 50695fce210SBarry Smith sf->mine_alloc = (PetscInt*)ilocal; 50795fce210SBarry Smith sf->mine = sf->mine_alloc; 50895fce210SBarry Smith break; 50995fce210SBarry Smith case PETSC_USE_POINTER: 51029046d53SLisandro Dalcin sf->mine_alloc = NULL; 51195fce210SBarry Smith sf->mine = (PetscInt*)ilocal; 51295fce210SBarry Smith break; 51395fce210SBarry Smith default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown localmode"); 51495fce210SBarry Smith } 51595fce210SBarry Smith } 51629046d53SLisandro Dalcin 51795fce210SBarry Smith switch (remotemode) { 51895fce210SBarry Smith case PETSC_COPY_VALUES: 519785e854fSJed Brown ierr = PetscMalloc1(nleaves,&sf->remote_alloc);CHKERRQ(ierr); 520580bdb30SBarry Smith ierr = PetscArraycpy(sf->remote_alloc,iremote,nleaves);CHKERRQ(ierr); 52195fce210SBarry Smith sf->remote = sf->remote_alloc; 52295fce210SBarry Smith break; 52395fce210SBarry Smith case PETSC_OWN_POINTER: 52495fce210SBarry Smith sf->remote_alloc = (PetscSFNode*)iremote; 52595fce210SBarry Smith sf->remote = sf->remote_alloc; 52695fce210SBarry Smith break; 52795fce210SBarry Smith case PETSC_USE_POINTER: 52829046d53SLisandro Dalcin sf->remote_alloc = NULL; 52995fce210SBarry Smith sf->remote = (PetscSFNode*)iremote; 53095fce210SBarry Smith break; 53195fce210SBarry Smith default: SETERRQ(PetscObjectComm((PetscObject)sf),PETSC_ERR_ARG_OUTOFRANGE,"Unknown remotemode"); 53295fce210SBarry Smith } 53395fce210SBarry Smith 534563ffbabSMatthew G. Knepley ierr = PetscLogEventEnd(PETSCSF_SetGraph,sf,0,0,0);CHKERRQ(ierr); 53529046d53SLisandro Dalcin sf->graphset = PETSC_TRUE; 53695fce210SBarry Smith PetscFunctionReturn(0); 53795fce210SBarry Smith } 53895fce210SBarry Smith 53929046d53SLisandro Dalcin /*@ 540dd5b3ca6SJunchao Zhang PetscSFSetGraphWithPattern - Sets the graph of an SF with a specific pattern 541dd5b3ca6SJunchao Zhang 542dd5b3ca6SJunchao Zhang Collective 543dd5b3ca6SJunchao Zhang 544dd5b3ca6SJunchao Zhang Input Parameters: 545dd5b3ca6SJunchao Zhang + sf - The PetscSF 546dd5b3ca6SJunchao Zhang . map - Layout of roots over all processes (insignificant when pattern is PETSCSF_PATTERN_ALLTOALL) 547dd5b3ca6SJunchao Zhang - pattern - One of PETSCSF_PATTERN_ALLGATHER, PETSCSF_PATTERN_GATHER, PETSCSF_PATTERN_ALLTOALL 548dd5b3ca6SJunchao Zhang 549dd5b3ca6SJunchao Zhang Notes: 550dd5b3ca6SJunchao Zhang It is easier to explain PetscSFPattern using vectors. Suppose we have an MPI vector x and its layout is map. 551dd5b3ca6SJunchao Zhang n and N are local and global sizes of x respectively. 552dd5b3ca6SJunchao Zhang 553dd5b3ca6SJunchao Zhang With PETSCSF_PATTERN_ALLGATHER, the routine creates a graph that if one does Bcast on it, it will copy x to 554dd5b3ca6SJunchao Zhang sequential vectors y on all ranks. 555dd5b3ca6SJunchao Zhang 556dd5b3ca6SJunchao Zhang With PETSCSF_PATTERN_GATHER, the routine creates a graph that if one does Bcast on it, it will copy x to a 557dd5b3ca6SJunchao Zhang sequential vector y on rank 0. 558dd5b3ca6SJunchao Zhang 559dd5b3ca6SJunchao Zhang In above cases, entries of x are roots and entries of y are leaves. 560dd5b3ca6SJunchao Zhang 561dd5b3ca6SJunchao Zhang With PETSCSF_PATTERN_ALLTOALL, map is insignificant. Suppose NP is size of sf's communicator. The routine 562dd5b3ca6SJunchao Zhang creates a graph that every rank has NP leaves and NP roots. On rank i, its leaf j is connected to root i 563dd5b3ca6SJunchao 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 564dd5b3ca6SJunchao Zhang not mean one can not send multiple items. One just needs to create a new MPI datatype for the mulptiple data 565dd5b3ca6SJunchao Zhang items with MPI_Type_contiguous() and use that as the <unit> argument in SF routines. 566dd5b3ca6SJunchao Zhang 567dd5b3ca6SJunchao Zhang In this case, roots and leaves are symmetric. 568dd5b3ca6SJunchao Zhang 569dd5b3ca6SJunchao Zhang Level: intermediate 570dd5b3ca6SJunchao Zhang @*/ 571dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFSetGraphWithPattern(PetscSF sf,PetscLayout map,PetscSFPattern pattern) 572dd5b3ca6SJunchao Zhang { 573dd5b3ca6SJunchao Zhang MPI_Comm comm; 574dd5b3ca6SJunchao Zhang PetscInt n,N,res[2]; 575dd5b3ca6SJunchao Zhang PetscMPIInt rank,size; 576dd5b3ca6SJunchao Zhang PetscSFType type; 577dd5b3ca6SJunchao Zhang PetscErrorCode ierr; 578dd5b3ca6SJunchao Zhang 579dd5b3ca6SJunchao Zhang PetscFunctionBegin; 580dd5b3ca6SJunchao Zhang ierr = PetscObjectGetComm((PetscObject)sf, &comm);CHKERRQ(ierr); 581dd5b3ca6SJunchao Zhang if (pattern < PETSCSF_PATTERN_ALLGATHER || pattern > PETSCSF_PATTERN_ALLTOALL) SETERRQ1(comm,PETSC_ERR_ARG_OUTOFRANGE,"Unsupported PetscSFPattern %D\n",pattern); 582ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm,&rank);CHKERRMPI(ierr); 583ffc4695bSBarry Smith ierr = MPI_Comm_size(comm,&size);CHKERRMPI(ierr); 584dd5b3ca6SJunchao Zhang 585dd5b3ca6SJunchao Zhang if (pattern == PETSCSF_PATTERN_ALLTOALL) { 586dd5b3ca6SJunchao Zhang type = PETSCSFALLTOALL; 587dd5b3ca6SJunchao Zhang ierr = PetscLayoutCreate(comm,&sf->map);CHKERRQ(ierr); 588dd5b3ca6SJunchao Zhang ierr = PetscLayoutSetLocalSize(sf->map,size);CHKERRQ(ierr); 589dd5b3ca6SJunchao Zhang ierr = PetscLayoutSetSize(sf->map,((PetscInt)size)*size);CHKERRQ(ierr); 590dd5b3ca6SJunchao Zhang ierr = PetscLayoutSetUp(sf->map);CHKERRQ(ierr); 591dd5b3ca6SJunchao Zhang } else { 592dd5b3ca6SJunchao Zhang ierr = PetscLayoutGetLocalSize(map,&n);CHKERRQ(ierr); 593dd5b3ca6SJunchao Zhang ierr = PetscLayoutGetSize(map,&N);CHKERRQ(ierr); 594dd5b3ca6SJunchao Zhang res[0] = n; 595dd5b3ca6SJunchao Zhang res[1] = -n; 596dd5b3ca6SJunchao Zhang /* Check if n are same over all ranks so that we can optimize it */ 597dd5b3ca6SJunchao Zhang ierr = MPIU_Allreduce(MPI_IN_PLACE,res,2,MPIU_INT,MPI_MAX,comm);CHKERRQ(ierr); 598dd5b3ca6SJunchao Zhang if (res[0] == -res[1]) { /* same n */ 599dd5b3ca6SJunchao Zhang type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHER : PETSCSFGATHER; 600dd5b3ca6SJunchao Zhang } else { 601dd5b3ca6SJunchao Zhang type = (pattern == PETSCSF_PATTERN_ALLGATHER) ? PETSCSFALLGATHERV : PETSCSFGATHERV; 602dd5b3ca6SJunchao Zhang } 603dd5b3ca6SJunchao Zhang ierr = PetscLayoutReference(map,&sf->map);CHKERRQ(ierr); 604dd5b3ca6SJunchao Zhang } 605dd5b3ca6SJunchao Zhang ierr = PetscSFSetType(sf,type);CHKERRQ(ierr); 606dd5b3ca6SJunchao Zhang 607dd5b3ca6SJunchao Zhang sf->pattern = pattern; 608dd5b3ca6SJunchao Zhang sf->mine = NULL; /* Contiguous */ 609dd5b3ca6SJunchao Zhang 610dd5b3ca6SJunchao Zhang /* Set nleaves, nroots here in case user calls PetscSFGetGraph, which is legal to call even before PetscSFSetUp is called. 611dd5b3ca6SJunchao Zhang Also set other easy stuff. 612dd5b3ca6SJunchao Zhang */ 613dd5b3ca6SJunchao Zhang if (pattern == PETSCSF_PATTERN_ALLGATHER) { 614dd5b3ca6SJunchao Zhang sf->nleaves = N; 615dd5b3ca6SJunchao Zhang sf->nroots = n; 616dd5b3ca6SJunchao Zhang sf->nranks = size; 617dd5b3ca6SJunchao Zhang sf->minleaf = 0; 618dd5b3ca6SJunchao Zhang sf->maxleaf = N - 1; 619dd5b3ca6SJunchao Zhang } else if (pattern == PETSCSF_PATTERN_GATHER) { 620dd5b3ca6SJunchao Zhang sf->nleaves = rank ? 0 : N; 621dd5b3ca6SJunchao Zhang sf->nroots = n; 622dd5b3ca6SJunchao Zhang sf->nranks = rank ? 0 : size; 623dd5b3ca6SJunchao Zhang sf->minleaf = 0; 624dd5b3ca6SJunchao Zhang sf->maxleaf = rank ? -1 : N - 1; 625dd5b3ca6SJunchao Zhang } else if (pattern == PETSCSF_PATTERN_ALLTOALL) { 626dd5b3ca6SJunchao Zhang sf->nleaves = size; 627dd5b3ca6SJunchao Zhang sf->nroots = size; 628dd5b3ca6SJunchao Zhang sf->nranks = size; 629dd5b3ca6SJunchao Zhang sf->minleaf = 0; 630dd5b3ca6SJunchao Zhang sf->maxleaf = size - 1; 631dd5b3ca6SJunchao Zhang } 632dd5b3ca6SJunchao Zhang sf->ndranks = 0; /* We do not need to separate out distinguished ranks for patterned graphs to improve communication performance */ 633dd5b3ca6SJunchao Zhang sf->graphset = PETSC_TRUE; 634dd5b3ca6SJunchao Zhang PetscFunctionReturn(0); 635dd5b3ca6SJunchao Zhang } 636dd5b3ca6SJunchao Zhang 637dd5b3ca6SJunchao Zhang /*@ 63895fce210SBarry Smith PetscSFCreateInverseSF - given a PetscSF in which all vertices have degree 1, creates the inverse map 63995fce210SBarry Smith 64095fce210SBarry Smith Collective 64195fce210SBarry Smith 64295fce210SBarry Smith Input Arguments: 643dd5b3ca6SJunchao Zhang 64495fce210SBarry Smith . sf - star forest to invert 64595fce210SBarry Smith 64695fce210SBarry Smith Output Arguments: 64795fce210SBarry Smith . isf - inverse of sf 64895fce210SBarry Smith Level: advanced 64995fce210SBarry Smith 65095fce210SBarry Smith Notes: 65195fce210SBarry Smith All roots must have degree 1. 65295fce210SBarry Smith 65395fce210SBarry Smith The local space may be a permutation, but cannot be sparse. 65495fce210SBarry Smith 65595fce210SBarry Smith .seealso: PetscSFSetGraph() 65695fce210SBarry Smith @*/ 65795fce210SBarry Smith PetscErrorCode PetscSFCreateInverseSF(PetscSF sf,PetscSF *isf) 65895fce210SBarry Smith { 65995fce210SBarry Smith PetscErrorCode ierr; 66095fce210SBarry Smith PetscMPIInt rank; 66195fce210SBarry Smith PetscInt i,nroots,nleaves,maxlocal,count,*newilocal; 66295fce210SBarry Smith const PetscInt *ilocal; 66395fce210SBarry Smith PetscSFNode *roots,*leaves; 66495fce210SBarry Smith 66595fce210SBarry Smith PetscFunctionBegin; 66629046d53SLisandro Dalcin PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 66729046d53SLisandro Dalcin PetscSFCheckGraphSet(sf,1); 66829046d53SLisandro Dalcin PetscValidPointer(isf,2); 66929046d53SLisandro Dalcin 67095fce210SBarry Smith ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,NULL);CHKERRQ(ierr); 67129046d53SLisandro Dalcin maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */ 67229046d53SLisandro Dalcin 673ffc4695bSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr); 674ae9aee6dSMatthew G. Knepley ierr = PetscMalloc2(nroots,&roots,maxlocal,&leaves);CHKERRQ(ierr); 675ae9aee6dSMatthew G. Knepley for (i=0; i<maxlocal; i++) { 67695fce210SBarry Smith leaves[i].rank = rank; 67795fce210SBarry Smith leaves[i].index = i; 67895fce210SBarry Smith } 67995fce210SBarry Smith for (i=0; i <nroots; i++) { 68095fce210SBarry Smith roots[i].rank = -1; 68195fce210SBarry Smith roots[i].index = -1; 68295fce210SBarry Smith } 6838bfbc91cSJed Brown ierr = PetscSFReduceBegin(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr); 6848bfbc91cSJed Brown ierr = PetscSFReduceEnd(sf,MPIU_2INT,leaves,roots,MPIU_REPLACE);CHKERRQ(ierr); 68595fce210SBarry Smith 68695fce210SBarry Smith /* Check whether our leaves are sparse */ 68795fce210SBarry Smith for (i=0,count=0; i<nroots; i++) if (roots[i].rank >= 0) count++; 68895fce210SBarry Smith if (count == nroots) newilocal = NULL; 68995fce210SBarry Smith else { /* Index for sparse leaves and compact "roots" array (which is to become our leaves). */ 690785e854fSJed Brown ierr = PetscMalloc1(count,&newilocal);CHKERRQ(ierr); 69195fce210SBarry Smith for (i=0,count=0; i<nroots; i++) { 69295fce210SBarry Smith if (roots[i].rank >= 0) { 69395fce210SBarry Smith newilocal[count] = i; 69495fce210SBarry Smith roots[count].rank = roots[i].rank; 69595fce210SBarry Smith roots[count].index = roots[i].index; 69695fce210SBarry Smith count++; 69795fce210SBarry Smith } 69895fce210SBarry Smith } 69995fce210SBarry Smith } 70095fce210SBarry Smith 70195fce210SBarry Smith ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,isf);CHKERRQ(ierr); 70295fce210SBarry Smith ierr = PetscSFSetGraph(*isf,maxlocal,count,newilocal,PETSC_OWN_POINTER,roots,PETSC_COPY_VALUES);CHKERRQ(ierr); 70395fce210SBarry Smith ierr = PetscFree2(roots,leaves);CHKERRQ(ierr); 70495fce210SBarry Smith PetscFunctionReturn(0); 70595fce210SBarry Smith } 70695fce210SBarry Smith 70795fce210SBarry Smith /*@ 70895fce210SBarry Smith PetscSFDuplicate - duplicate a PetscSF, optionally preserving rank connectivity and graph 70995fce210SBarry Smith 71095fce210SBarry Smith Collective 71195fce210SBarry Smith 71295fce210SBarry Smith Input Arguments: 71395fce210SBarry Smith + sf - communication object to duplicate 71495fce210SBarry Smith - opt - PETSCSF_DUPLICATE_CONFONLY, PETSCSF_DUPLICATE_RANKS, or PETSCSF_DUPLICATE_GRAPH (see PetscSFDuplicateOption) 71595fce210SBarry Smith 71695fce210SBarry Smith Output Arguments: 71795fce210SBarry Smith . newsf - new communication object 71895fce210SBarry Smith 71995fce210SBarry Smith Level: beginner 72095fce210SBarry Smith 72195fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetType(), PetscSFSetGraph() 72295fce210SBarry Smith @*/ 72395fce210SBarry Smith PetscErrorCode PetscSFDuplicate(PetscSF sf,PetscSFDuplicateOption opt,PetscSF *newsf) 72495fce210SBarry Smith { 72529046d53SLisandro Dalcin PetscSFType type; 72695fce210SBarry Smith PetscErrorCode ierr; 72797929ea7SJunchao Zhang MPI_Datatype dtype=MPIU_SCALAR; 72895fce210SBarry Smith 72995fce210SBarry Smith PetscFunctionBegin; 73029046d53SLisandro Dalcin PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 73129046d53SLisandro Dalcin PetscValidLogicalCollectiveEnum(sf,opt,2); 73229046d53SLisandro Dalcin PetscValidPointer(newsf,3); 73395fce210SBarry Smith ierr = PetscSFCreate(PetscObjectComm((PetscObject)sf),newsf);CHKERRQ(ierr); 73429046d53SLisandro Dalcin ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr); 73529046d53SLisandro Dalcin if (type) {ierr = PetscSFSetType(*newsf,type);CHKERRQ(ierr);} 73695fce210SBarry Smith if (opt == PETSCSF_DUPLICATE_GRAPH) { 737dd5b3ca6SJunchao Zhang PetscSFCheckGraphSet(sf,1); 738dd5b3ca6SJunchao Zhang if (sf->pattern == PETSCSF_PATTERN_GENERAL) { 73995fce210SBarry Smith PetscInt nroots,nleaves; 74095fce210SBarry Smith const PetscInt *ilocal; 74195fce210SBarry Smith const PetscSFNode *iremote; 74295fce210SBarry Smith ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr); 74395fce210SBarry Smith ierr = PetscSFSetGraph(*newsf,nroots,nleaves,ilocal,PETSC_COPY_VALUES,iremote,PETSC_COPY_VALUES);CHKERRQ(ierr); 744dd5b3ca6SJunchao Zhang } else { 745dd5b3ca6SJunchao Zhang ierr = PetscSFSetGraphWithPattern(*newsf,sf->map,sf->pattern);CHKERRQ(ierr); 746dd5b3ca6SJunchao Zhang } 74795fce210SBarry Smith } 74897929ea7SJunchao Zhang /* Since oldtype is committed, so is newtype, according to MPI */ 74997929ea7SJunchao Zhang if (sf->vscat.bs > 1) {ierr = MPI_Type_dup(sf->vscat.unit,&dtype);CHKERRQ(ierr);} 75097929ea7SJunchao Zhang (*newsf)->vscat.bs = sf->vscat.bs; 75197929ea7SJunchao Zhang (*newsf)->vscat.unit = dtype; 75297929ea7SJunchao Zhang (*newsf)->vscat.to_n = sf->vscat.to_n; 75397929ea7SJunchao Zhang (*newsf)->vscat.from_n = sf->vscat.from_n; 75497929ea7SJunchao Zhang /* Do not copy lsf. Build it on demand since it is rarely used */ 75597929ea7SJunchao Zhang 75620c24465SJunchao Zhang #if defined(PETSC_HAVE_DEVICE) 75720c24465SJunchao Zhang (*newsf)->backend = sf->backend; 75820c24465SJunchao Zhang (*newsf)->use_default_stream = sf->use_default_stream; 75920c24465SJunchao Zhang (*newsf)->use_gpu_aware_mpi = sf->use_gpu_aware_mpi; 76020c24465SJunchao Zhang (*newsf)->use_stream_aware_mpi = sf->use_stream_aware_mpi; 76120c24465SJunchao Zhang #endif 76229046d53SLisandro Dalcin if (sf->ops->Duplicate) {ierr = (*sf->ops->Duplicate)(sf,opt,*newsf);CHKERRQ(ierr);} 76320c24465SJunchao Zhang /* Don't do PetscSFSetUp() since the new sf's graph might have not been set. */ 76495fce210SBarry Smith PetscFunctionReturn(0); 76595fce210SBarry Smith } 76695fce210SBarry Smith 76795fce210SBarry Smith /*@C 76895fce210SBarry Smith PetscSFGetGraph - Get the graph specifying a parallel star forest 76995fce210SBarry Smith 77095fce210SBarry Smith Not Collective 77195fce210SBarry Smith 77295fce210SBarry Smith Input Arguments: 77395fce210SBarry Smith . sf - star forest 77495fce210SBarry Smith 77595fce210SBarry Smith Output Arguments: 77695fce210SBarry Smith + nroots - number of root vertices on the current process (these are possible targets for other process to attach leaves) 77795fce210SBarry Smith . nleaves - number of leaf vertices on the current process, each of these references a root on any process 77895fce210SBarry Smith . ilocal - locations of leaves in leafdata buffers 77995fce210SBarry Smith - iremote - remote locations of root vertices for each leaf on the current process 78095fce210SBarry Smith 781373e0d91SLisandro Dalcin Notes: 782373e0d91SLisandro Dalcin We are not currently requiring that the graph is set, thus returning nroots=-1 if it has not been set yet 783373e0d91SLisandro Dalcin 784245d9833Sprj- When called from Fortran, the returned iremote array is a copy and must be deallocated after use. Consequently, if you 785ca797d7aSLawrence Mitchell want to update the graph, you must call PetscSFSetGraph after modifying the iremote array. 786ca797d7aSLawrence Mitchell 78795fce210SBarry Smith Level: intermediate 78895fce210SBarry Smith 78995fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph() 79095fce210SBarry Smith @*/ 79195fce210SBarry Smith PetscErrorCode PetscSFGetGraph(PetscSF sf,PetscInt *nroots,PetscInt *nleaves,const PetscInt **ilocal,const PetscSFNode **iremote) 79295fce210SBarry Smith { 793b8dee149SJunchao Zhang PetscErrorCode ierr; 79495fce210SBarry Smith 79595fce210SBarry Smith PetscFunctionBegin; 79695fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 797b8dee149SJunchao Zhang if (sf->ops->GetGraph) { 798b8dee149SJunchao Zhang ierr = (sf->ops->GetGraph)(sf,nroots,nleaves,ilocal,iremote);CHKERRQ(ierr); 799b8dee149SJunchao Zhang } else { 80095fce210SBarry Smith if (nroots) *nroots = sf->nroots; 80195fce210SBarry Smith if (nleaves) *nleaves = sf->nleaves; 80295fce210SBarry Smith if (ilocal) *ilocal = sf->mine; 80395fce210SBarry Smith if (iremote) *iremote = sf->remote; 804b8dee149SJunchao Zhang } 80595fce210SBarry Smith PetscFunctionReturn(0); 80695fce210SBarry Smith } 80795fce210SBarry Smith 80829046d53SLisandro Dalcin /*@ 80995fce210SBarry Smith PetscSFGetLeafRange - Get the active leaf ranges 81095fce210SBarry Smith 81195fce210SBarry Smith Not Collective 81295fce210SBarry Smith 81395fce210SBarry Smith Input Arguments: 81495fce210SBarry Smith . sf - star forest 81595fce210SBarry Smith 81695fce210SBarry Smith Output Arguments: 817dd5b3ca6SJunchao Zhang + minleaf - minimum active leaf on this process. Return 0 if there are no leaves. 818dd5b3ca6SJunchao Zhang - maxleaf - maximum active leaf on this process. Return -1 if there are no leaves. 81995fce210SBarry Smith 82095fce210SBarry Smith Level: developer 82195fce210SBarry Smith 82295fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFView(), PetscSFSetGraph(), PetscSFGetGraph() 82395fce210SBarry Smith @*/ 82495fce210SBarry Smith PetscErrorCode PetscSFGetLeafRange(PetscSF sf,PetscInt *minleaf,PetscInt *maxleaf) 82595fce210SBarry Smith { 82695fce210SBarry Smith PetscFunctionBegin; 82795fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 82829046d53SLisandro Dalcin PetscSFCheckGraphSet(sf,1); 82995fce210SBarry Smith if (minleaf) *minleaf = sf->minleaf; 83095fce210SBarry Smith if (maxleaf) *maxleaf = sf->maxleaf; 83195fce210SBarry Smith PetscFunctionReturn(0); 83295fce210SBarry Smith } 83395fce210SBarry Smith 83495fce210SBarry Smith /*@C 835fe2efc57SMark PetscSFViewFromOptions - View from Options 836fe2efc57SMark 837fe2efc57SMark Collective on PetscSF 838fe2efc57SMark 839fe2efc57SMark Input Parameters: 840fe2efc57SMark + A - the star forest 841736c3998SJose E. Roman . obj - Optional object 842736c3998SJose E. Roman - name - command line option 843fe2efc57SMark 844fe2efc57SMark Level: intermediate 845fe2efc57SMark .seealso: PetscSF, PetscSFView, PetscObjectViewFromOptions(), PetscSFCreate() 846fe2efc57SMark @*/ 847fe2efc57SMark PetscErrorCode PetscSFViewFromOptions(PetscSF A,PetscObject obj,const char name[]) 848fe2efc57SMark { 849fe2efc57SMark PetscErrorCode ierr; 850fe2efc57SMark 851fe2efc57SMark PetscFunctionBegin; 852fe2efc57SMark PetscValidHeaderSpecific(A,PETSCSF_CLASSID,1); 853fe2efc57SMark ierr = PetscObjectViewFromOptions((PetscObject)A,obj,name);CHKERRQ(ierr); 854fe2efc57SMark PetscFunctionReturn(0); 855fe2efc57SMark } 856fe2efc57SMark 857fe2efc57SMark /*@C 85895fce210SBarry Smith PetscSFView - view a star forest 85995fce210SBarry Smith 86095fce210SBarry Smith Collective 86195fce210SBarry Smith 86295fce210SBarry Smith Input Arguments: 86395fce210SBarry Smith + sf - star forest 86495fce210SBarry Smith - viewer - viewer to display graph, for example PETSC_VIEWER_STDOUT_WORLD 86595fce210SBarry Smith 86695fce210SBarry Smith Level: beginner 86795fce210SBarry Smith 86895fce210SBarry Smith .seealso: PetscSFCreate(), PetscSFSetGraph() 86995fce210SBarry Smith @*/ 87095fce210SBarry Smith PetscErrorCode PetscSFView(PetscSF sf,PetscViewer viewer) 87195fce210SBarry Smith { 87295fce210SBarry Smith PetscErrorCode ierr; 87395fce210SBarry Smith PetscBool iascii; 87495fce210SBarry Smith PetscViewerFormat format; 87595fce210SBarry Smith 87695fce210SBarry Smith PetscFunctionBegin; 87795fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 87895fce210SBarry Smith if (!viewer) {ierr = PetscViewerASCIIGetStdout(PetscObjectComm((PetscObject)sf),&viewer);CHKERRQ(ierr);} 87995fce210SBarry Smith PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2); 88095fce210SBarry Smith PetscCheckSameComm(sf,1,viewer,2); 88180153354SVaclav Hapla if (sf->graphset) {ierr = PetscSFSetUp(sf);CHKERRQ(ierr);} 88295fce210SBarry Smith ierr = PetscObjectTypeCompare((PetscObject)viewer,PETSCVIEWERASCII,&iascii);CHKERRQ(ierr); 88395fce210SBarry Smith if (iascii) { 88495fce210SBarry Smith PetscMPIInt rank; 88581bfa7aaSJed Brown PetscInt ii,i,j; 88695fce210SBarry Smith 887dae58748SBarry Smith ierr = PetscObjectPrintClassNamePrefixType((PetscObject)sf,viewer);CHKERRQ(ierr); 88895fce210SBarry Smith ierr = PetscViewerASCIIPushTab(viewer);CHKERRQ(ierr); 88995fce210SBarry Smith if (sf->ops->View) {ierr = (*sf->ops->View)(sf,viewer);CHKERRQ(ierr);} 890dd5b3ca6SJunchao Zhang if (sf->pattern == PETSCSF_PATTERN_GENERAL) { 89180153354SVaclav Hapla if (!sf->graphset) { 89280153354SVaclav Hapla ierr = PetscViewerASCIIPrintf(viewer,"PetscSFSetGraph() has not been called yet\n");CHKERRQ(ierr); 89380153354SVaclav Hapla ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 89480153354SVaclav Hapla PetscFunctionReturn(0); 89580153354SVaclav Hapla } 896ffc4695bSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr); 8971575c14dSBarry Smith ierr = PetscViewerASCIIPushSynchronized(viewer);CHKERRQ(ierr); 89895fce210SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Number of roots=%D, leaves=%D, remote ranks=%D\n",rank,sf->nroots,sf->nleaves,sf->nranks);CHKERRQ(ierr); 89995fce210SBarry Smith for (i=0; i<sf->nleaves; i++) { 90095fce210SBarry 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); 90195fce210SBarry Smith } 90295fce210SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 90395fce210SBarry Smith ierr = PetscViewerGetFormat(viewer,&format);CHKERRQ(ierr); 90495fce210SBarry Smith if (format == PETSC_VIEWER_ASCII_INFO_DETAIL) { 90581bfa7aaSJed Brown PetscMPIInt *tmpranks,*perm; 90681bfa7aaSJed Brown ierr = PetscMalloc2(sf->nranks,&tmpranks,sf->nranks,&perm);CHKERRQ(ierr); 907580bdb30SBarry Smith ierr = PetscArraycpy(tmpranks,sf->ranks,sf->nranks);CHKERRQ(ierr); 90881bfa7aaSJed Brown for (i=0; i<sf->nranks; i++) perm[i] = i; 90981bfa7aaSJed Brown ierr = PetscSortMPIIntWithArray(sf->nranks,tmpranks,perm);CHKERRQ(ierr); 91095fce210SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] Roots referenced by my leaves, by rank\n",rank);CHKERRQ(ierr); 91181bfa7aaSJed Brown for (ii=0; ii<sf->nranks; ii++) { 91281bfa7aaSJed Brown i = perm[ii]; 9137904a332SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %d: %D edges\n",rank,sf->ranks[i],sf->roffset[i+1]-sf->roffset[i]);CHKERRQ(ierr); 91495fce210SBarry Smith for (j=sf->roffset[i]; j<sf->roffset[i+1]; j++) { 91595fce210SBarry Smith ierr = PetscViewerASCIISynchronizedPrintf(viewer,"[%d] %D <- %D\n",rank,sf->rmine[j],sf->rremote[j]);CHKERRQ(ierr); 91695fce210SBarry Smith } 91795fce210SBarry Smith } 91881bfa7aaSJed Brown ierr = PetscFree2(tmpranks,perm);CHKERRQ(ierr); 91995fce210SBarry Smith } 92095fce210SBarry Smith ierr = PetscViewerFlush(viewer);CHKERRQ(ierr); 9211575c14dSBarry Smith ierr = PetscViewerASCIIPopSynchronized(viewer);CHKERRQ(ierr); 922dd5b3ca6SJunchao Zhang } 92395fce210SBarry Smith ierr = PetscViewerASCIIPopTab(viewer);CHKERRQ(ierr); 92495fce210SBarry Smith } 92595fce210SBarry Smith PetscFunctionReturn(0); 92695fce210SBarry Smith } 92795fce210SBarry Smith 92895fce210SBarry Smith /*@C 929dec1416fSJunchao Zhang PetscSFGetRootRanks - Get root ranks and number of vertices referenced by leaves on this process 93095fce210SBarry Smith 93195fce210SBarry Smith Not Collective 93295fce210SBarry Smith 93395fce210SBarry Smith Input Arguments: 93495fce210SBarry Smith . sf - star forest 93595fce210SBarry Smith 93695fce210SBarry Smith Output Arguments: 93795fce210SBarry Smith + nranks - number of ranks referenced by local part 93895fce210SBarry Smith . ranks - array of ranks 93995fce210SBarry Smith . roffset - offset in rmine/rremote for each rank (length nranks+1) 94095fce210SBarry Smith . rmine - concatenated array holding local indices referencing each remote rank 94195fce210SBarry Smith - rremote - concatenated array holding remote indices referenced for each remote rank 94295fce210SBarry Smith 94395fce210SBarry Smith Level: developer 94495fce210SBarry Smith 945dec1416fSJunchao Zhang .seealso: PetscSFGetLeafRanks() 94695fce210SBarry Smith @*/ 947dec1416fSJunchao Zhang PetscErrorCode PetscSFGetRootRanks(PetscSF sf,PetscInt *nranks,const PetscMPIInt **ranks,const PetscInt **roffset,const PetscInt **rmine,const PetscInt **rremote) 94895fce210SBarry Smith { 949dec1416fSJunchao Zhang PetscErrorCode ierr; 95095fce210SBarry Smith 95195fce210SBarry Smith PetscFunctionBegin; 95295fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 95329046d53SLisandro Dalcin if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks"); 954dec1416fSJunchao Zhang if (sf->ops->GetRootRanks) { 955dec1416fSJunchao Zhang ierr = (sf->ops->GetRootRanks)(sf,nranks,ranks,roffset,rmine,rremote);CHKERRQ(ierr); 956dec1416fSJunchao Zhang } else { 957dec1416fSJunchao Zhang /* The generic implementation */ 95895fce210SBarry Smith if (nranks) *nranks = sf->nranks; 95995fce210SBarry Smith if (ranks) *ranks = sf->ranks; 96095fce210SBarry Smith if (roffset) *roffset = sf->roffset; 96195fce210SBarry Smith if (rmine) *rmine = sf->rmine; 96295fce210SBarry Smith if (rremote) *rremote = sf->rremote; 963dec1416fSJunchao Zhang } 96495fce210SBarry Smith PetscFunctionReturn(0); 96595fce210SBarry Smith } 96695fce210SBarry Smith 9678750ddebSJunchao Zhang /*@C 9688750ddebSJunchao Zhang PetscSFGetLeafRanks - Get leaf ranks referencing roots on this process 9698750ddebSJunchao Zhang 9708750ddebSJunchao Zhang Not Collective 9718750ddebSJunchao Zhang 9728750ddebSJunchao Zhang Input Arguments: 9738750ddebSJunchao Zhang . sf - star forest 9748750ddebSJunchao Zhang 9758750ddebSJunchao Zhang Output Arguments: 9768750ddebSJunchao Zhang + niranks - number of leaf ranks referencing roots on this process 9778750ddebSJunchao Zhang . iranks - array of ranks 9788750ddebSJunchao Zhang . ioffset - offset in irootloc for each rank (length niranks+1) 9798750ddebSJunchao Zhang - irootloc - concatenated array holding local indices of roots referenced by each leaf rank 9808750ddebSJunchao Zhang 9818750ddebSJunchao Zhang Level: developer 9828750ddebSJunchao Zhang 983dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks() 9848750ddebSJunchao Zhang @*/ 9858750ddebSJunchao Zhang PetscErrorCode PetscSFGetLeafRanks(PetscSF sf,PetscInt *niranks,const PetscMPIInt **iranks,const PetscInt **ioffset,const PetscInt **irootloc) 9868750ddebSJunchao Zhang { 9878750ddebSJunchao Zhang PetscErrorCode ierr; 9888750ddebSJunchao Zhang 9898750ddebSJunchao Zhang PetscFunctionBegin; 9908750ddebSJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 9918750ddebSJunchao Zhang if (!sf->setupcalled) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUp() before obtaining ranks"); 9928750ddebSJunchao Zhang if (sf->ops->GetLeafRanks) { 9938750ddebSJunchao Zhang ierr = (sf->ops->GetLeafRanks)(sf,niranks,iranks,ioffset,irootloc);CHKERRQ(ierr); 9948750ddebSJunchao Zhang } else { 9958750ddebSJunchao Zhang PetscSFType type; 9968750ddebSJunchao Zhang ierr = PetscSFGetType(sf,&type);CHKERRQ(ierr); 9978750ddebSJunchao Zhang SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFGetLeafRanks() is not supported on this StarForest type: %s", type); 9988750ddebSJunchao Zhang } 9998750ddebSJunchao Zhang PetscFunctionReturn(0); 10008750ddebSJunchao Zhang } 10018750ddebSJunchao Zhang 1002b5a8e515SJed Brown static PetscBool InList(PetscMPIInt needle,PetscMPIInt n,const PetscMPIInt *list) { 1003b5a8e515SJed Brown PetscInt i; 1004b5a8e515SJed Brown for (i=0; i<n; i++) { 1005b5a8e515SJed Brown if (needle == list[i]) return PETSC_TRUE; 1006b5a8e515SJed Brown } 1007b5a8e515SJed Brown return PETSC_FALSE; 1008b5a8e515SJed Brown } 1009b5a8e515SJed Brown 101095fce210SBarry Smith /*@C 101121c688dcSJed Brown PetscSFSetUpRanks - Set up data structures associated with ranks; this is for internal use by PetscSF implementations. 101221c688dcSJed Brown 101321c688dcSJed Brown Collective 101421c688dcSJed Brown 101521c688dcSJed Brown Input Arguments: 1016b5a8e515SJed Brown + sf - PetscSF to set up; PetscSFSetGraph() must have been called 1017b5a8e515SJed Brown - dgroup - MPI_Group of ranks to be distinguished (e.g., for self or shared memory exchange) 101821c688dcSJed Brown 101921c688dcSJed Brown Level: developer 102021c688dcSJed Brown 1021dec1416fSJunchao Zhang .seealso: PetscSFGetRootRanks() 102221c688dcSJed Brown @*/ 1023b5a8e515SJed Brown PetscErrorCode PetscSFSetUpRanks(PetscSF sf,MPI_Group dgroup) 102421c688dcSJed Brown { 102521c688dcSJed Brown PetscErrorCode ierr; 102621c688dcSJed Brown PetscTable table; 102721c688dcSJed Brown PetscTablePosition pos; 1028b5a8e515SJed Brown PetscMPIInt size,groupsize,*groupranks; 1029247e8311SStefano Zampini PetscInt *rcount,*ranks; 1030247e8311SStefano Zampini PetscInt i, irank = -1,orank = -1; 103121c688dcSJed Brown 103221c688dcSJed Brown PetscFunctionBegin; 103321c688dcSJed Brown PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 103429046d53SLisandro Dalcin PetscSFCheckGraphSet(sf,1); 1035ffc4695bSBarry Smith ierr = MPI_Comm_size(PetscObjectComm((PetscObject)sf),&size);CHKERRMPI(ierr); 103621c688dcSJed Brown ierr = PetscTableCreate(10,size,&table);CHKERRQ(ierr); 103721c688dcSJed Brown for (i=0; i<sf->nleaves; i++) { 103821c688dcSJed Brown /* Log 1-based rank */ 103921c688dcSJed Brown ierr = PetscTableAdd(table,sf->remote[i].rank+1,1,ADD_VALUES);CHKERRQ(ierr); 104021c688dcSJed Brown } 104121c688dcSJed Brown ierr = PetscTableGetCount(table,&sf->nranks);CHKERRQ(ierr); 104221c688dcSJed Brown ierr = PetscMalloc4(sf->nranks,&sf->ranks,sf->nranks+1,&sf->roffset,sf->nleaves,&sf->rmine,sf->nleaves,&sf->rremote);CHKERRQ(ierr); 104321c688dcSJed Brown ierr = PetscMalloc2(sf->nranks,&rcount,sf->nranks,&ranks);CHKERRQ(ierr); 104421c688dcSJed Brown ierr = PetscTableGetHeadPosition(table,&pos);CHKERRQ(ierr); 104521c688dcSJed Brown for (i=0; i<sf->nranks; i++) { 104621c688dcSJed Brown ierr = PetscTableGetNext(table,&pos,&ranks[i],&rcount[i]);CHKERRQ(ierr); 104721c688dcSJed Brown ranks[i]--; /* Convert back to 0-based */ 104821c688dcSJed Brown } 104921c688dcSJed Brown ierr = PetscTableDestroy(&table);CHKERRQ(ierr); 1050b5a8e515SJed Brown 1051b5a8e515SJed Brown /* We expect that dgroup is reliably "small" while nranks could be large */ 1052b5a8e515SJed Brown { 10537fb8a5e4SKarl Rupp MPI_Group group = MPI_GROUP_NULL; 1054b5a8e515SJed Brown PetscMPIInt *dgroupranks; 1055ffc4695bSBarry Smith ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRMPI(ierr); 1056ffc4695bSBarry Smith ierr = MPI_Group_size(dgroup,&groupsize);CHKERRMPI(ierr); 1057b5a8e515SJed Brown ierr = PetscMalloc1(groupsize,&dgroupranks);CHKERRQ(ierr); 1058b5a8e515SJed Brown ierr = PetscMalloc1(groupsize,&groupranks);CHKERRQ(ierr); 1059b5a8e515SJed Brown for (i=0; i<groupsize; i++) dgroupranks[i] = i; 1060ffc4695bSBarry Smith if (groupsize) {ierr = MPI_Group_translate_ranks(dgroup,groupsize,dgroupranks,group,groupranks);CHKERRMPI(ierr);} 1061ffc4695bSBarry Smith ierr = MPI_Group_free(&group);CHKERRMPI(ierr); 1062b5a8e515SJed Brown ierr = PetscFree(dgroupranks);CHKERRQ(ierr); 1063b5a8e515SJed Brown } 1064b5a8e515SJed Brown 1065b5a8e515SJed Brown /* Partition ranks[] into distinguished (first sf->ndranks) followed by non-distinguished */ 1066b5a8e515SJed Brown for (sf->ndranks=0,i=sf->nranks; sf->ndranks<i;) { 1067b5a8e515SJed Brown for (i--; sf->ndranks<i; i--) { /* Scan i backward looking for distinguished rank */ 1068b5a8e515SJed Brown if (InList(ranks[i],groupsize,groupranks)) break; 1069b5a8e515SJed Brown } 1070b5a8e515SJed Brown for (; sf->ndranks<=i; sf->ndranks++) { /* Scan sf->ndranks forward looking for non-distinguished rank */ 1071b5a8e515SJed Brown if (!InList(ranks[sf->ndranks],groupsize,groupranks)) break; 1072b5a8e515SJed Brown } 1073b5a8e515SJed Brown if (sf->ndranks < i) { /* Swap ranks[sf->ndranks] with ranks[i] */ 1074b5a8e515SJed Brown PetscInt tmprank,tmpcount; 1075247e8311SStefano Zampini 1076b5a8e515SJed Brown tmprank = ranks[i]; 1077b5a8e515SJed Brown tmpcount = rcount[i]; 1078b5a8e515SJed Brown ranks[i] = ranks[sf->ndranks]; 1079b5a8e515SJed Brown rcount[i] = rcount[sf->ndranks]; 1080b5a8e515SJed Brown ranks[sf->ndranks] = tmprank; 1081b5a8e515SJed Brown rcount[sf->ndranks] = tmpcount; 1082b5a8e515SJed Brown sf->ndranks++; 1083b5a8e515SJed Brown } 1084b5a8e515SJed Brown } 1085b5a8e515SJed Brown ierr = PetscFree(groupranks);CHKERRQ(ierr); 1086b5a8e515SJed Brown ierr = PetscSortIntWithArray(sf->ndranks,ranks,rcount);CHKERRQ(ierr); 1087b5a8e515SJed Brown ierr = PetscSortIntWithArray(sf->nranks-sf->ndranks,ranks+sf->ndranks,rcount+sf->ndranks);CHKERRQ(ierr); 108821c688dcSJed Brown sf->roffset[0] = 0; 108921c688dcSJed Brown for (i=0; i<sf->nranks; i++) { 109021c688dcSJed Brown ierr = PetscMPIIntCast(ranks[i],sf->ranks+i);CHKERRQ(ierr); 109121c688dcSJed Brown sf->roffset[i+1] = sf->roffset[i] + rcount[i]; 109221c688dcSJed Brown rcount[i] = 0; 109321c688dcSJed Brown } 1094247e8311SStefano Zampini for (i=0, irank = -1, orank = -1; i<sf->nleaves; i++) { 1095247e8311SStefano Zampini /* short circuit */ 1096247e8311SStefano Zampini if (orank != sf->remote[i].rank) { 109721c688dcSJed Brown /* Search for index of iremote[i].rank in sf->ranks */ 1098b5a8e515SJed Brown ierr = PetscFindMPIInt(sf->remote[i].rank,sf->ndranks,sf->ranks,&irank);CHKERRQ(ierr); 1099b5a8e515SJed Brown if (irank < 0) { 1100b5a8e515SJed Brown ierr = PetscFindMPIInt(sf->remote[i].rank,sf->nranks-sf->ndranks,sf->ranks+sf->ndranks,&irank);CHKERRQ(ierr); 1101b5a8e515SJed Brown if (irank >= 0) irank += sf->ndranks; 110221c688dcSJed Brown } 1103247e8311SStefano Zampini orank = sf->remote[i].rank; 1104247e8311SStefano Zampini } 1105b5a8e515SJed Brown if (irank < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Could not find rank %D in array",sf->remote[i].rank); 110621c688dcSJed Brown sf->rmine[sf->roffset[irank] + rcount[irank]] = sf->mine ? sf->mine[i] : i; 110721c688dcSJed Brown sf->rremote[sf->roffset[irank] + rcount[irank]] = sf->remote[i].index; 110821c688dcSJed Brown rcount[irank]++; 110921c688dcSJed Brown } 111021c688dcSJed Brown ierr = PetscFree2(rcount,ranks);CHKERRQ(ierr); 111121c688dcSJed Brown PetscFunctionReturn(0); 111221c688dcSJed Brown } 111321c688dcSJed Brown 111421c688dcSJed Brown /*@C 111595fce210SBarry Smith PetscSFGetGroups - gets incoming and outgoing process groups 111695fce210SBarry Smith 111795fce210SBarry Smith Collective 111895fce210SBarry Smith 111995fce210SBarry Smith Input Argument: 112095fce210SBarry Smith . sf - star forest 112195fce210SBarry Smith 112295fce210SBarry Smith Output Arguments: 112395fce210SBarry Smith + incoming - group of origin processes for incoming edges (leaves that reference my roots) 112495fce210SBarry Smith - outgoing - group of destination processes for outgoing edges (roots that I reference) 112595fce210SBarry Smith 112695fce210SBarry Smith Level: developer 112795fce210SBarry Smith 112895fce210SBarry Smith .seealso: PetscSFGetWindow(), PetscSFRestoreWindow() 112995fce210SBarry Smith @*/ 113095fce210SBarry Smith PetscErrorCode PetscSFGetGroups(PetscSF sf,MPI_Group *incoming,MPI_Group *outgoing) 113195fce210SBarry Smith { 113295fce210SBarry Smith PetscErrorCode ierr; 11337fb8a5e4SKarl Rupp MPI_Group group = MPI_GROUP_NULL; 113495fce210SBarry Smith 113595fce210SBarry Smith PetscFunctionBegin; 113644ee17edSStefano Zampini if (sf->nranks < 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"Must call PetscSFSetUpRanks() before obtaining groups"); 113795fce210SBarry Smith if (sf->ingroup == MPI_GROUP_NULL) { 113895fce210SBarry Smith PetscInt i; 113995fce210SBarry Smith const PetscInt *indegree; 114095fce210SBarry Smith PetscMPIInt rank,*outranks,*inranks; 114195fce210SBarry Smith PetscSFNode *remote; 114295fce210SBarry Smith PetscSF bgcount; 114395fce210SBarry Smith 114495fce210SBarry Smith /* Compute the number of incoming ranks */ 1145785e854fSJed Brown ierr = PetscMalloc1(sf->nranks,&remote);CHKERRQ(ierr); 114695fce210SBarry Smith for (i=0; i<sf->nranks; i++) { 114795fce210SBarry Smith remote[i].rank = sf->ranks[i]; 114895fce210SBarry Smith remote[i].index = 0; 114995fce210SBarry Smith } 115095fce210SBarry Smith ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,&bgcount);CHKERRQ(ierr); 115195fce210SBarry Smith ierr = PetscSFSetGraph(bgcount,1,sf->nranks,NULL,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr); 115295fce210SBarry Smith ierr = PetscSFComputeDegreeBegin(bgcount,&indegree);CHKERRQ(ierr); 115395fce210SBarry Smith ierr = PetscSFComputeDegreeEnd(bgcount,&indegree);CHKERRQ(ierr); 115495fce210SBarry Smith /* Enumerate the incoming ranks */ 1155dcca6d9dSJed Brown ierr = PetscMalloc2(indegree[0],&inranks,sf->nranks,&outranks);CHKERRQ(ierr); 1156ffc4695bSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr); 115795fce210SBarry Smith for (i=0; i<sf->nranks; i++) outranks[i] = rank; 115895fce210SBarry Smith ierr = PetscSFGatherBegin(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr); 115995fce210SBarry Smith ierr = PetscSFGatherEnd(bgcount,MPI_INT,outranks,inranks);CHKERRQ(ierr); 1160ffc4695bSBarry Smith ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRMPI(ierr); 1161ffc4695bSBarry Smith ierr = MPI_Group_incl(group,indegree[0],inranks,&sf->ingroup);CHKERRMPI(ierr); 1162ffc4695bSBarry Smith ierr = MPI_Group_free(&group);CHKERRMPI(ierr); 116395fce210SBarry Smith ierr = PetscFree2(inranks,outranks);CHKERRQ(ierr); 116495fce210SBarry Smith ierr = PetscSFDestroy(&bgcount);CHKERRQ(ierr); 116595fce210SBarry Smith } 116695fce210SBarry Smith *incoming = sf->ingroup; 116795fce210SBarry Smith 116895fce210SBarry Smith if (sf->outgroup == MPI_GROUP_NULL) { 1169ffc4695bSBarry Smith ierr = MPI_Comm_group(PetscObjectComm((PetscObject)sf),&group);CHKERRMPI(ierr); 1170ffc4695bSBarry Smith ierr = MPI_Group_incl(group,sf->nranks,sf->ranks,&sf->outgroup);CHKERRMPI(ierr); 1171ffc4695bSBarry Smith ierr = MPI_Group_free(&group);CHKERRMPI(ierr); 117295fce210SBarry Smith } 117395fce210SBarry Smith *outgoing = sf->outgroup; 117495fce210SBarry Smith PetscFunctionReturn(0); 117595fce210SBarry Smith } 117695fce210SBarry Smith 117729046d53SLisandro Dalcin /*@ 117895fce210SBarry Smith PetscSFGetMultiSF - gets the inner SF implemeting gathers and scatters 117995fce210SBarry Smith 118095fce210SBarry Smith Collective 118195fce210SBarry Smith 118295fce210SBarry Smith Input Argument: 118395fce210SBarry Smith . sf - star forest that may contain roots with 0 or with more than 1 vertex 118495fce210SBarry Smith 118595fce210SBarry Smith Output Arguments: 118695fce210SBarry Smith . multi - star forest with split roots, such that each root has degree exactly 1 118795fce210SBarry Smith 118895fce210SBarry Smith Level: developer 118995fce210SBarry Smith 119095fce210SBarry Smith Notes: 119195fce210SBarry Smith 119295fce210SBarry Smith In most cases, users should use PetscSFGatherBegin() and PetscSFScatterBegin() instead of manipulating multi 119395fce210SBarry Smith directly. Since multi satisfies the stronger condition that each entry in the global space has exactly one incoming 119495fce210SBarry Smith edge, it is a candidate for future optimization that might involve its removal. 119595fce210SBarry Smith 1196673100f5SVaclav Hapla .seealso: PetscSFSetGraph(), PetscSFGatherBegin(), PetscSFScatterBegin(), PetscSFComputeMultiRootOriginalNumbering() 119795fce210SBarry Smith @*/ 119895fce210SBarry Smith PetscErrorCode PetscSFGetMultiSF(PetscSF sf,PetscSF *multi) 119995fce210SBarry Smith { 120095fce210SBarry Smith PetscErrorCode ierr; 120195fce210SBarry Smith 120295fce210SBarry Smith PetscFunctionBegin; 120395fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 120495fce210SBarry Smith PetscValidPointer(multi,2); 120595fce210SBarry Smith if (sf->nroots < 0) { /* Graph has not been set yet; why do we need this? */ 120695fce210SBarry Smith ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr); 120795fce210SBarry Smith *multi = sf->multi; 1208*013b3241SStefano Zampini sf->multi->multi = sf->multi; 120995fce210SBarry Smith PetscFunctionReturn(0); 121095fce210SBarry Smith } 121195fce210SBarry Smith if (!sf->multi) { 121295fce210SBarry Smith const PetscInt *indegree; 12139837ea96SMatthew G. Knepley PetscInt i,*inoffset,*outones,*outoffset,maxlocal; 121495fce210SBarry Smith PetscSFNode *remote; 121529046d53SLisandro Dalcin maxlocal = sf->maxleaf+1; /* TODO: We should use PetscSFGetLeafRange() */ 121695fce210SBarry Smith ierr = PetscSFComputeDegreeBegin(sf,&indegree);CHKERRQ(ierr); 121795fce210SBarry Smith ierr = PetscSFComputeDegreeEnd(sf,&indegree);CHKERRQ(ierr); 12189837ea96SMatthew G. Knepley ierr = PetscMalloc3(sf->nroots+1,&inoffset,maxlocal,&outones,maxlocal,&outoffset);CHKERRQ(ierr); 121995fce210SBarry Smith inoffset[0] = 0; 122095fce210SBarry Smith for (i=0; i<sf->nroots; i++) inoffset[i+1] = inoffset[i] + indegree[i]; 12219837ea96SMatthew G. Knepley for (i=0; i<maxlocal; i++) outones[i] = 1; 1222dbd2ff41SBarry Smith ierr = PetscSFFetchAndOpBegin(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr); 1223dbd2ff41SBarry Smith ierr = PetscSFFetchAndOpEnd(sf,MPIU_INT,inoffset,outones,outoffset,MPI_SUM);CHKERRQ(ierr); 122495fce210SBarry Smith for (i=0; i<sf->nroots; i++) inoffset[i] -= indegree[i]; /* Undo the increment */ 122576bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { /* Check that the expected number of increments occurred */ 122695fce210SBarry Smith for (i=0; i<sf->nroots; i++) { 122795fce210SBarry Smith if (inoffset[i] + indegree[i] != inoffset[i+1]) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"Incorrect result after PetscSFFetchAndOp"); 122895fce210SBarry Smith } 122976bd3646SJed Brown } 1230785e854fSJed Brown ierr = PetscMalloc1(sf->nleaves,&remote);CHKERRQ(ierr); 123195fce210SBarry Smith for (i=0; i<sf->nleaves; i++) { 123295fce210SBarry Smith remote[i].rank = sf->remote[i].rank; 123338e7336fSToby Isaac remote[i].index = outoffset[sf->mine ? sf->mine[i] : i]; 123495fce210SBarry Smith } 123595fce210SBarry Smith ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_RANKS,&sf->multi);CHKERRQ(ierr); 1236*013b3241SStefano Zampini sf->multi->multi = sf->multi; 123701365b40SToby Isaac ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,remote,PETSC_OWN_POINTER);CHKERRQ(ierr); 123895fce210SBarry Smith if (sf->rankorder) { /* Sort the ranks */ 123995fce210SBarry Smith PetscMPIInt rank; 124095fce210SBarry Smith PetscInt *inranks,*newoffset,*outranks,*newoutoffset,*tmpoffset,maxdegree; 124195fce210SBarry Smith PetscSFNode *newremote; 1242ffc4695bSBarry Smith ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)sf),&rank);CHKERRMPI(ierr); 124395fce210SBarry Smith for (i=0,maxdegree=0; i<sf->nroots; i++) maxdegree = PetscMax(maxdegree,indegree[i]); 12449837ea96SMatthew G. Knepley ierr = PetscMalloc5(sf->multi->nroots,&inranks,sf->multi->nroots,&newoffset,maxlocal,&outranks,maxlocal,&newoutoffset,maxdegree,&tmpoffset);CHKERRQ(ierr); 12459837ea96SMatthew G. Knepley for (i=0; i<maxlocal; i++) outranks[i] = rank; 12468bfbc91cSJed Brown ierr = PetscSFReduceBegin(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr); 12478bfbc91cSJed Brown ierr = PetscSFReduceEnd(sf->multi,MPIU_INT,outranks,inranks,MPIU_REPLACE);CHKERRQ(ierr); 124895fce210SBarry Smith /* Sort the incoming ranks at each vertex, build the inverse map */ 124995fce210SBarry Smith for (i=0; i<sf->nroots; i++) { 125095fce210SBarry Smith PetscInt j; 125195fce210SBarry Smith for (j=0; j<indegree[i]; j++) tmpoffset[j] = j; 125295fce210SBarry Smith ierr = PetscSortIntWithArray(indegree[i],inranks+inoffset[i],tmpoffset);CHKERRQ(ierr); 125395fce210SBarry Smith for (j=0; j<indegree[i]; j++) newoffset[inoffset[i] + tmpoffset[j]] = inoffset[i] + j; 125495fce210SBarry Smith } 125595fce210SBarry Smith ierr = PetscSFBcastBegin(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr); 125695fce210SBarry Smith ierr = PetscSFBcastEnd(sf->multi,MPIU_INT,newoffset,newoutoffset);CHKERRQ(ierr); 1257785e854fSJed Brown ierr = PetscMalloc1(sf->nleaves,&newremote);CHKERRQ(ierr); 125895fce210SBarry Smith for (i=0; i<sf->nleaves; i++) { 125995fce210SBarry Smith newremote[i].rank = sf->remote[i].rank; 126001365b40SToby Isaac newremote[i].index = newoutoffset[sf->mine ? sf->mine[i] : i]; 126195fce210SBarry Smith } 126201365b40SToby Isaac ierr = PetscSFSetGraph(sf->multi,inoffset[sf->nroots],sf->nleaves,sf->mine,PETSC_COPY_VALUES,newremote,PETSC_OWN_POINTER);CHKERRQ(ierr); 126395fce210SBarry Smith ierr = PetscFree5(inranks,newoffset,outranks,newoutoffset,tmpoffset);CHKERRQ(ierr); 126495fce210SBarry Smith } 126595fce210SBarry Smith ierr = PetscFree3(inoffset,outones,outoffset);CHKERRQ(ierr); 126695fce210SBarry Smith } 126795fce210SBarry Smith *multi = sf->multi; 126895fce210SBarry Smith PetscFunctionReturn(0); 126995fce210SBarry Smith } 127095fce210SBarry Smith 127195fce210SBarry Smith /*@C 127295fce210SBarry Smith PetscSFCreateEmbeddedSF - removes edges from all but the selected roots, does not remap indices 127395fce210SBarry Smith 127495fce210SBarry Smith Collective 127595fce210SBarry Smith 127695fce210SBarry Smith Input Arguments: 127795fce210SBarry Smith + sf - original star forest 1278ba2a7774SJunchao Zhang . nselected - number of selected roots on this process 1279ba2a7774SJunchao Zhang - selected - indices of the selected roots on this process 128095fce210SBarry Smith 128195fce210SBarry Smith Output Arguments: 1282cd620004SJunchao Zhang . esf - new star forest 128395fce210SBarry Smith 128495fce210SBarry Smith Level: advanced 128595fce210SBarry Smith 128695fce210SBarry Smith Note: 128795fce210SBarry Smith To use the new PetscSF, it may be necessary to know the indices of the leaves that are still participating. This can 128895fce210SBarry Smith be done by calling PetscSFGetGraph(). 128995fce210SBarry Smith 129095fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFGetGraph() 129195fce210SBarry Smith @*/ 1292cd620004SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *esf) 129395fce210SBarry Smith { 1294cd620004SJunchao Zhang PetscInt i,j,n,nroots,nleaves,esf_nleaves,*new_ilocal,minleaf,maxleaf,maxlocal; 1295cd620004SJunchao Zhang const PetscInt *ilocal; 1296cd620004SJunchao Zhang signed char *rootdata,*leafdata,*leafmem; 1297ba2a7774SJunchao Zhang const PetscSFNode *iremote; 1298f659e5c7SJunchao Zhang PetscSFNode *new_iremote; 1299f659e5c7SJunchao Zhang MPI_Comm comm; 13000511a646SMatthew G. Knepley PetscErrorCode ierr; 130195fce210SBarry Smith 130295fce210SBarry Smith PetscFunctionBegin; 130395fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 130429046d53SLisandro Dalcin PetscSFCheckGraphSet(sf,1); 1305ba2a7774SJunchao Zhang if (nselected) PetscValidPointer(selected,3); 1306cd620004SJunchao Zhang PetscValidPointer(esf,4); 13070511a646SMatthew G. Knepley 1308f659e5c7SJunchao Zhang ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 1309140a1472SStefano Zampini ierr = PetscLogEventBegin(PETSCSF_EmbedSF,sf,0,0,0);CHKERRQ(ierr); 1310f659e5c7SJunchao Zhang ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr); 1311cd620004SJunchao Zhang ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr); 1312cd620004SJunchao Zhang 131376bd3646SJed Brown if (PetscDefined(USE_DEBUG)) { /* Error out if selected[] has dups or out of range indices */ 1314cd620004SJunchao Zhang PetscBool dups; 1315cd620004SJunchao Zhang ierr = PetscCheckDupsInt(nselected,selected,&dups);CHKERRQ(ierr); 1316cd620004SJunchao Zhang if (dups) SETERRQ(comm,PETSC_ERR_ARG_WRONG,"selected[] has dups"); 1317cd620004SJunchao Zhang for (i=0; i<nselected; i++) 1318cd620004SJunchao 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); 1319cd620004SJunchao Zhang } 1320f659e5c7SJunchao Zhang 1321f659e5c7SJunchao Zhang if (sf->ops->CreateEmbeddedSF) { 1322cd620004SJunchao Zhang ierr = (*sf->ops->CreateEmbeddedSF)(sf,nselected,selected,esf);CHKERRQ(ierr); 1323f659e5c7SJunchao Zhang } else { 1324cd620004SJunchao Zhang /* A generic version of creating embedded sf */ 1325cd620004SJunchao Zhang ierr = PetscSFGetLeafRange(sf,&minleaf,&maxleaf);CHKERRQ(ierr); 1326cd620004SJunchao Zhang maxlocal = maxleaf - minleaf + 1; 1327cd620004SJunchao Zhang ierr = PetscCalloc2(nroots,&rootdata,maxlocal,&leafmem);CHKERRQ(ierr); 1328cd620004SJunchao Zhang leafdata = leafmem - minleaf; 1329cd620004SJunchao Zhang /* Tag selected roots and bcast to leaves */ 1330cd620004SJunchao Zhang for (i=0; i<nselected; i++) rootdata[selected[i]] = 1; 1331cd620004SJunchao Zhang ierr = PetscSFBcastBegin(sf,MPI_SIGNED_CHAR,rootdata,leafdata);CHKERRQ(ierr); 1332cd620004SJunchao Zhang ierr = PetscSFBcastEnd(sf,MPI_SIGNED_CHAR,rootdata,leafdata);CHKERRQ(ierr); 1333ba2a7774SJunchao Zhang 1334cd620004SJunchao Zhang /* Build esf with leaves that are still connected */ 1335cd620004SJunchao Zhang esf_nleaves = 0; 1336cd620004SJunchao Zhang for (i=0; i<nleaves; i++) { 1337cd620004SJunchao Zhang j = ilocal ? ilocal[i] : i; 1338cd620004SJunchao Zhang /* esf_nleaves += leafdata[j] should work in theory, but failed with SFWindow bugs 1339cd620004SJunchao Zhang with PetscSFBcast. See https://gitlab.com/petsc/petsc/issues/555 1340cd620004SJunchao Zhang */ 1341cd620004SJunchao Zhang esf_nleaves += (leafdata[j] ? 1 : 0); 1342cd620004SJunchao Zhang } 1343cd620004SJunchao Zhang ierr = PetscMalloc1(esf_nleaves,&new_ilocal);CHKERRQ(ierr); 1344cd620004SJunchao Zhang ierr = PetscMalloc1(esf_nleaves,&new_iremote);CHKERRQ(ierr); 1345cd620004SJunchao Zhang for (i=n=0; i<nleaves; i++) { 1346cd620004SJunchao Zhang j = ilocal ? ilocal[i] : i; 1347cd620004SJunchao Zhang if (leafdata[j]) { 1348cd620004SJunchao Zhang new_ilocal[n] = j; 1349cd620004SJunchao Zhang new_iremote[n].rank = iremote[i].rank; 1350cd620004SJunchao Zhang new_iremote[n].index = iremote[i].index; 1351fc1ede2bSMatthew G. Knepley ++n; 135295fce210SBarry Smith } 135395fce210SBarry Smith } 1354cd620004SJunchao Zhang ierr = PetscSFCreate(comm,esf);CHKERRQ(ierr); 1355cd620004SJunchao Zhang ierr = PetscSFSetFromOptions(*esf);CHKERRQ(ierr); 1356cd620004SJunchao Zhang ierr = PetscSFSetGraph(*esf,nroots,esf_nleaves,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr); 1357cd620004SJunchao Zhang ierr = PetscFree2(rootdata,leafmem);CHKERRQ(ierr); 1358f659e5c7SJunchao Zhang } 1359140a1472SStefano Zampini ierr = PetscLogEventEnd(PETSCSF_EmbedSF,sf,0,0,0);CHKERRQ(ierr); 136095fce210SBarry Smith PetscFunctionReturn(0); 136195fce210SBarry Smith } 136295fce210SBarry Smith 13632f5fb4c2SMatthew G. Knepley /*@C 13642f5fb4c2SMatthew G. Knepley PetscSFCreateEmbeddedLeafSF - removes edges from all but the selected leaves, does not remap indices 13652f5fb4c2SMatthew G. Knepley 13662f5fb4c2SMatthew G. Knepley Collective 13672f5fb4c2SMatthew G. Knepley 13682f5fb4c2SMatthew G. Knepley Input Arguments: 13692f5fb4c2SMatthew G. Knepley + sf - original star forest 1370f659e5c7SJunchao Zhang . nselected - number of selected leaves on this process 1371f659e5c7SJunchao Zhang - selected - indices of the selected leaves on this process 13722f5fb4c2SMatthew G. Knepley 13732f5fb4c2SMatthew G. Knepley Output Arguments: 13742f5fb4c2SMatthew G. Knepley . newsf - new star forest 13752f5fb4c2SMatthew G. Knepley 13762f5fb4c2SMatthew G. Knepley Level: advanced 13772f5fb4c2SMatthew G. Knepley 13782f5fb4c2SMatthew G. Knepley .seealso: PetscSFCreateEmbeddedSF(), PetscSFSetGraph(), PetscSFGetGraph() 13792f5fb4c2SMatthew G. Knepley @*/ 1380f659e5c7SJunchao Zhang PetscErrorCode PetscSFCreateEmbeddedLeafSF(PetscSF sf,PetscInt nselected,const PetscInt *selected,PetscSF *newsf) 13812f5fb4c2SMatthew G. Knepley { 1382f659e5c7SJunchao Zhang const PetscSFNode *iremote; 1383f659e5c7SJunchao Zhang PetscSFNode *new_iremote; 1384f659e5c7SJunchao Zhang const PetscInt *ilocal; 1385f659e5c7SJunchao Zhang PetscInt i,nroots,*leaves,*new_ilocal; 1386f659e5c7SJunchao Zhang MPI_Comm comm; 13872f5fb4c2SMatthew G. Knepley PetscErrorCode ierr; 13882f5fb4c2SMatthew G. Knepley 13892f5fb4c2SMatthew G. Knepley PetscFunctionBegin; 13902f5fb4c2SMatthew G. Knepley PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 139129046d53SLisandro Dalcin PetscSFCheckGraphSet(sf,1); 1392f659e5c7SJunchao Zhang if (nselected) PetscValidPointer(selected,3); 13932f5fb4c2SMatthew G. Knepley PetscValidPointer(newsf,4); 13942f5fb4c2SMatthew G. Knepley 1395f659e5c7SJunchao Zhang /* Uniq selected[] and put results in leaves[] */ 1396f659e5c7SJunchao Zhang ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr); 1397f659e5c7SJunchao Zhang ierr = PetscMalloc1(nselected,&leaves);CHKERRQ(ierr); 1398dd5b3ca6SJunchao Zhang ierr = PetscArraycpy(leaves,selected,nselected);CHKERRQ(ierr); 1399f659e5c7SJunchao Zhang ierr = PetscSortedRemoveDupsInt(&nselected,leaves);CHKERRQ(ierr); 1400f659e5c7SJunchao 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); 1401f659e5c7SJunchao Zhang 1402f659e5c7SJunchao Zhang /* Optimize the routine only when sf is setup and hence we can reuse sf's communication pattern */ 1403f659e5c7SJunchao Zhang if (sf->setupcalled && sf->ops->CreateEmbeddedLeafSF) { 1404f659e5c7SJunchao Zhang ierr = (*sf->ops->CreateEmbeddedLeafSF)(sf,nselected,leaves,newsf);CHKERRQ(ierr); 1405f659e5c7SJunchao Zhang } else { 1406f659e5c7SJunchao Zhang ierr = PetscSFGetGraph(sf,&nroots,NULL,&ilocal,&iremote);CHKERRQ(ierr); 1407f659e5c7SJunchao Zhang ierr = PetscMalloc1(nselected,&new_ilocal);CHKERRQ(ierr); 1408f659e5c7SJunchao Zhang ierr = PetscMalloc1(nselected,&new_iremote);CHKERRQ(ierr); 1409f659e5c7SJunchao Zhang for (i=0; i<nselected; ++i) { 1410f659e5c7SJunchao Zhang const PetscInt l = leaves[i]; 1411f659e5c7SJunchao Zhang new_ilocal[i] = ilocal ? ilocal[l] : l; 1412f659e5c7SJunchao Zhang new_iremote[i].rank = iremote[l].rank; 1413f659e5c7SJunchao Zhang new_iremote[i].index = iremote[l].index; 14142f5fb4c2SMatthew G. Knepley } 14154cc19a0cSStefano Zampini ierr = PetscSFDuplicate(sf,PETSCSF_DUPLICATE_CONFONLY,newsf);CHKERRQ(ierr); 1416f659e5c7SJunchao Zhang ierr = PetscSFSetGraph(*newsf,nroots,nselected,new_ilocal,PETSC_OWN_POINTER,new_iremote,PETSC_OWN_POINTER);CHKERRQ(ierr); 1417f659e5c7SJunchao Zhang } 1418f659e5c7SJunchao Zhang ierr = PetscFree(leaves);CHKERRQ(ierr); 14192f5fb4c2SMatthew G. Knepley PetscFunctionReturn(0); 14202f5fb4c2SMatthew G. Knepley } 14212f5fb4c2SMatthew G. Knepley 142295fce210SBarry Smith /*@C 14233482bfa8SJunchao Zhang PetscSFBcastAndOpBegin - begin pointwise broadcast with root value being reduced to leaf value, to be concluded with call to PetscSFBcastAndOpEnd() 14243482bfa8SJunchao Zhang 14253482bfa8SJunchao Zhang Collective on PetscSF 14263482bfa8SJunchao Zhang 14273482bfa8SJunchao Zhang Input Arguments: 14283482bfa8SJunchao Zhang + sf - star forest on which to communicate 14293482bfa8SJunchao Zhang . unit - data type associated with each node 14303482bfa8SJunchao Zhang . rootdata - buffer to broadcast 14313482bfa8SJunchao Zhang - op - operation to use for reduction 14323482bfa8SJunchao Zhang 14333482bfa8SJunchao Zhang Output Arguments: 14343482bfa8SJunchao Zhang . leafdata - buffer to be reduced with values from each leaf's respective root 14353482bfa8SJunchao Zhang 14363482bfa8SJunchao Zhang Level: intermediate 14373482bfa8SJunchao Zhang 1438d0295fc0SJunchao Zhang Notes: 1439d0295fc0SJunchao Zhang When petsc is configured with device support, it will use its own mechanism to figure out whether the given data pointers 1440d0295fc0SJunchao Zhang are host pointers or device pointers, which may incur a noticable cost. If you already knew the info, you should 1441d0295fc0SJunchao Zhang use PetscSFBcastAndOpWithMemTypeBegin() instead. 1442d0295fc0SJunchao Zhang .seealso: PetscSFBcastAndOpEnd(), PetscSFBcastBegin(), PetscSFBcastEnd(), PetscSFBcastAndOpWithMemTypeBegin() 14433482bfa8SJunchao Zhang @*/ 14443482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpBegin(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op) 14453482bfa8SJunchao Zhang { 14463482bfa8SJunchao Zhang PetscErrorCode ierr; 1447eb02082bSJunchao Zhang PetscMemType rootmtype,leafmtype; 14483482bfa8SJunchao Zhang 14493482bfa8SJunchao Zhang PetscFunctionBegin; 14503482bfa8SJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 14513482bfa8SJunchao Zhang ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 145297929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);} 1453eb02082bSJunchao Zhang ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr); 1454eb02082bSJunchao Zhang ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr); 1455eb02082bSJunchao Zhang ierr = (*sf->ops->BcastAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr); 145697929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);} 14573482bfa8SJunchao Zhang PetscFunctionReturn(0); 14583482bfa8SJunchao Zhang } 14593482bfa8SJunchao Zhang 14603482bfa8SJunchao Zhang /*@C 1461d0295fc0SJunchao Zhang PetscSFBcastAndOpWithMemTypeBegin - begin pointwise broadcast with root value being reduced to leaf value with explicit memory types, to be concluded with call to PetscSFBcastAndOpEnd() 1462d0295fc0SJunchao Zhang 1463d0295fc0SJunchao Zhang Collective on PetscSF 1464d0295fc0SJunchao Zhang 1465d0295fc0SJunchao Zhang Input Arguments: 1466d0295fc0SJunchao Zhang + sf - star forest on which to communicate 1467d0295fc0SJunchao Zhang . unit - data type associated with each node 1468d0295fc0SJunchao Zhang . rootmtype - memory type of rootdata 1469d0295fc0SJunchao Zhang . rootdata - buffer to broadcast 1470d0295fc0SJunchao Zhang . leafmtype - memory type of leafdata 1471d0295fc0SJunchao Zhang - op - operation to use for reduction 1472d0295fc0SJunchao Zhang 1473d0295fc0SJunchao Zhang Output Arguments: 1474d0295fc0SJunchao Zhang . leafdata - buffer to be reduced with values from each leaf's respective root 1475d0295fc0SJunchao Zhang 1476d0295fc0SJunchao Zhang Level: intermediate 1477d0295fc0SJunchao Zhang 1478d0295fc0SJunchao Zhang .seealso: PetscSFBcastAndOpEnd(), PetscSFBcastBegin(), PetscSFBcastEnd(),PetscSFBcastAndOpBegin() 1479d0295fc0SJunchao Zhang @*/ 1480d0295fc0SJunchao Zhang PetscErrorCode PetscSFBcastAndOpWithMemTypeBegin(PetscSF sf,MPI_Datatype unit,PetscMemType rootmtype,const void *rootdata,PetscMemType leafmtype,void *leafdata,MPI_Op op) 1481d0295fc0SJunchao Zhang { 1482d0295fc0SJunchao Zhang PetscErrorCode ierr; 1483d0295fc0SJunchao Zhang 1484d0295fc0SJunchao Zhang PetscFunctionBegin; 1485d0295fc0SJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 1486d0295fc0SJunchao Zhang ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 148797929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);} 1488d0295fc0SJunchao Zhang ierr = (*sf->ops->BcastAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,op);CHKERRQ(ierr); 148997929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr);} 1490d0295fc0SJunchao Zhang PetscFunctionReturn(0); 1491d0295fc0SJunchao Zhang } 1492d0295fc0SJunchao Zhang 1493d0295fc0SJunchao Zhang /*@C 14943482bfa8SJunchao Zhang PetscSFBcastAndOpEnd - end a broadcast & reduce operation started with PetscSFBcastAndOpBegin() 14953482bfa8SJunchao Zhang 14963482bfa8SJunchao Zhang Collective 14973482bfa8SJunchao Zhang 14983482bfa8SJunchao Zhang Input Arguments: 14993482bfa8SJunchao Zhang + sf - star forest 15003482bfa8SJunchao Zhang . unit - data type 15013482bfa8SJunchao Zhang . rootdata - buffer to broadcast 15023482bfa8SJunchao Zhang - op - operation to use for reduction 15033482bfa8SJunchao Zhang 15043482bfa8SJunchao Zhang Output Arguments: 15053482bfa8SJunchao Zhang . leafdata - buffer to be reduced with values from each leaf's respective root 15063482bfa8SJunchao Zhang 15073482bfa8SJunchao Zhang Level: intermediate 15083482bfa8SJunchao Zhang 15093482bfa8SJunchao Zhang .seealso: PetscSFSetGraph(), PetscSFReduceEnd() 15103482bfa8SJunchao Zhang @*/ 15113482bfa8SJunchao Zhang PetscErrorCode PetscSFBcastAndOpEnd(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata,MPI_Op op) 15123482bfa8SJunchao Zhang { 15133482bfa8SJunchao Zhang PetscErrorCode ierr; 15143482bfa8SJunchao Zhang 15153482bfa8SJunchao Zhang PetscFunctionBegin; 15163482bfa8SJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 151797929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);} 151800816365SJunchao Zhang ierr = (*sf->ops->BcastAndOpEnd)(sf,unit,rootdata,leafdata,op);CHKERRQ(ierr); 151997929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_BcastAndOpEnd,sf,0,0,0);CHKERRQ(ierr);} 15203482bfa8SJunchao Zhang PetscFunctionReturn(0); 15213482bfa8SJunchao Zhang } 15223482bfa8SJunchao Zhang 15233482bfa8SJunchao Zhang /*@C 152495fce210SBarry Smith PetscSFReduceBegin - begin reduction of leafdata into rootdata, to be completed with call to PetscSFReduceEnd() 152595fce210SBarry Smith 152695fce210SBarry Smith Collective 152795fce210SBarry Smith 152895fce210SBarry Smith Input Arguments: 152995fce210SBarry Smith + sf - star forest 153095fce210SBarry Smith . unit - data type 153195fce210SBarry Smith . leafdata - values to reduce 153295fce210SBarry Smith - op - reduction operation 153395fce210SBarry Smith 153495fce210SBarry Smith Output Arguments: 153595fce210SBarry Smith . rootdata - result of reduction of values from all leaves of each root 153695fce210SBarry Smith 153795fce210SBarry Smith Level: intermediate 153895fce210SBarry Smith 1539d0295fc0SJunchao Zhang Notes: 1540d0295fc0SJunchao Zhang When petsc is configured with device support, it will use its own mechanism to figure out whether the given data pointers 1541d0295fc0SJunchao Zhang are host pointers or device pointers, which may incur a noticable cost. If you already knew the info, you should 1542d0295fc0SJunchao Zhang use PetscSFReduceWithMemTypeBegin() instead. 1543d0295fc0SJunchao Zhang 1544d0295fc0SJunchao Zhang .seealso: PetscSFBcastBegin(), PetscSFReduceWithMemTypeBegin() 154595fce210SBarry Smith @*/ 154695fce210SBarry Smith PetscErrorCode PetscSFReduceBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op) 154795fce210SBarry Smith { 154895fce210SBarry Smith PetscErrorCode ierr; 1549eb02082bSJunchao Zhang PetscMemType rootmtype,leafmtype; 155095fce210SBarry Smith 155195fce210SBarry Smith PetscFunctionBegin; 155295fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 155395fce210SBarry Smith ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 155497929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);} 1555eb02082bSJunchao Zhang ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr); 1556eb02082bSJunchao Zhang ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr); 1557eb02082bSJunchao Zhang ierr = (sf->ops->ReduceBegin)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr); 155897929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);} 155995fce210SBarry Smith PetscFunctionReturn(0); 156095fce210SBarry Smith } 156195fce210SBarry Smith 156295fce210SBarry Smith /*@C 1563d0295fc0SJunchao Zhang PetscSFReduceWithMemTypeBegin - begin reduction of leafdata into rootdata with explicit memory types, to be completed with call to PetscSFReduceEnd() 1564d0295fc0SJunchao Zhang 1565d0295fc0SJunchao Zhang Collective 1566d0295fc0SJunchao Zhang 1567d0295fc0SJunchao Zhang Input Arguments: 1568d0295fc0SJunchao Zhang + sf - star forest 1569d0295fc0SJunchao Zhang . unit - data type 1570d0295fc0SJunchao Zhang . leafmtype - memory type of leafdata 1571d0295fc0SJunchao Zhang . leafdata - values to reduce 1572d0295fc0SJunchao Zhang . rootmtype - memory type of rootdata 1573d0295fc0SJunchao Zhang - op - reduction operation 1574d0295fc0SJunchao Zhang 1575d0295fc0SJunchao Zhang Output Arguments: 1576d0295fc0SJunchao Zhang . rootdata - result of reduction of values from all leaves of each root 1577d0295fc0SJunchao Zhang 1578d0295fc0SJunchao Zhang Level: intermediate 1579d0295fc0SJunchao Zhang 1580d0295fc0SJunchao Zhang .seealso: PetscSFBcastBegin(), PetscSFReduceBegin() 1581d0295fc0SJunchao Zhang @*/ 1582d0295fc0SJunchao Zhang PetscErrorCode PetscSFReduceWithMemTypeBegin(PetscSF sf,MPI_Datatype unit,PetscMemType leafmtype,const void *leafdata,PetscMemType rootmtype,void *rootdata,MPI_Op op) 1583d0295fc0SJunchao Zhang { 1584d0295fc0SJunchao Zhang PetscErrorCode ierr; 1585d0295fc0SJunchao Zhang 1586d0295fc0SJunchao Zhang PetscFunctionBegin; 1587d0295fc0SJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 1588d0295fc0SJunchao Zhang ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 158997929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);} 1590d0295fc0SJunchao Zhang ierr = (sf->ops->ReduceBegin)(sf,unit,leafmtype,leafdata,rootmtype,rootdata,op);CHKERRQ(ierr); 159197929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_ReduceBegin,sf,0,0,0);CHKERRQ(ierr);} 1592d0295fc0SJunchao Zhang PetscFunctionReturn(0); 1593d0295fc0SJunchao Zhang } 1594d0295fc0SJunchao Zhang 1595d0295fc0SJunchao Zhang /*@C 159695fce210SBarry Smith PetscSFReduceEnd - end a reduction operation started with PetscSFReduceBegin() 159795fce210SBarry Smith 159895fce210SBarry Smith Collective 159995fce210SBarry Smith 160095fce210SBarry Smith Input Arguments: 160195fce210SBarry Smith + sf - star forest 160295fce210SBarry Smith . unit - data type 160395fce210SBarry Smith . leafdata - values to reduce 160495fce210SBarry Smith - op - reduction operation 160595fce210SBarry Smith 160695fce210SBarry Smith Output Arguments: 160795fce210SBarry Smith . rootdata - result of reduction of values from all leaves of each root 160895fce210SBarry Smith 160995fce210SBarry Smith Level: intermediate 161095fce210SBarry Smith 161195fce210SBarry Smith .seealso: PetscSFSetGraph(), PetscSFBcastEnd() 161295fce210SBarry Smith @*/ 161395fce210SBarry Smith PetscErrorCode PetscSFReduceEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *rootdata,MPI_Op op) 161495fce210SBarry Smith { 161595fce210SBarry Smith PetscErrorCode ierr; 161695fce210SBarry Smith 161795fce210SBarry Smith PetscFunctionBegin; 161895fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 161997929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventBegin(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);} 162000816365SJunchao Zhang ierr = (*sf->ops->ReduceEnd)(sf,unit,leafdata,rootdata,op);CHKERRQ(ierr); 162197929ea7SJunchao Zhang if (!sf->vscat.logging) {ierr = PetscLogEventEnd(PETSCSF_ReduceEnd,sf,0,0,0);CHKERRQ(ierr);} 162295fce210SBarry Smith PetscFunctionReturn(0); 162395fce210SBarry Smith } 162495fce210SBarry Smith 162595fce210SBarry Smith /*@C 1626a1729e3fSJunchao Zhang PetscSFFetchAndOpBegin - begin operation that fetches values from root and updates atomically by applying operation using my leaf value, to be completed with PetscSFFetchAndOpEnd() 1627a1729e3fSJunchao Zhang 1628a1729e3fSJunchao Zhang Collective 1629a1729e3fSJunchao Zhang 1630a1729e3fSJunchao Zhang Input Arguments: 1631a1729e3fSJunchao Zhang + sf - star forest 1632a1729e3fSJunchao Zhang . unit - data type 1633a1729e3fSJunchao Zhang . leafdata - leaf values to use in reduction 1634a1729e3fSJunchao Zhang - op - operation to use for reduction 1635a1729e3fSJunchao Zhang 1636a1729e3fSJunchao Zhang Output Arguments: 1637a1729e3fSJunchao Zhang + rootdata - root values to be updated, input state is seen by first process to perform an update 1638a1729e3fSJunchao Zhang - leafupdate - state at each leaf's respective root immediately prior to my atomic update 1639a1729e3fSJunchao Zhang 1640a1729e3fSJunchao Zhang Level: advanced 1641a1729e3fSJunchao Zhang 1642a1729e3fSJunchao Zhang Note: 1643a1729e3fSJunchao Zhang The update is only atomic at the granularity provided by the hardware. Different roots referenced by the same process 1644a1729e3fSJunchao Zhang might be updated in a different order. Furthermore, if a composite type is used for the unit datatype, atomicity is 1645a1729e3fSJunchao Zhang not guaranteed across the whole vertex. Therefore, this function is mostly only used with primitive types such as 1646a1729e3fSJunchao Zhang integers. 1647a1729e3fSJunchao Zhang 1648a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeBegin(), PetscSFReduceBegin(), PetscSFSetGraph() 1649a1729e3fSJunchao Zhang @*/ 1650a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpBegin(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op) 1651a1729e3fSJunchao Zhang { 1652a1729e3fSJunchao Zhang PetscErrorCode ierr; 1653eb02082bSJunchao Zhang PetscMemType rootmtype,leafmtype,leafupdatemtype; 1654a1729e3fSJunchao Zhang 1655a1729e3fSJunchao Zhang PetscFunctionBegin; 1656a1729e3fSJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 1657a1729e3fSJunchao Zhang ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 1658a1729e3fSJunchao Zhang ierr = PetscLogEventBegin(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr); 1659eb02082bSJunchao Zhang ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr); 1660eb02082bSJunchao Zhang ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr); 1661eb02082bSJunchao Zhang ierr = PetscGetMemType(leafupdate,&leafupdatemtype);CHKERRQ(ierr); 1662eb02082bSJunchao Zhang if (leafmtype != leafupdatemtype) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"No support for leafdata and leafupdate in different memory types"); 1663eb02082bSJunchao Zhang ierr = (*sf->ops->FetchAndOpBegin)(sf,unit,rootmtype,rootdata,leafmtype,leafdata,leafupdate,op);CHKERRQ(ierr); 1664a1729e3fSJunchao Zhang ierr = PetscLogEventEnd(PETSCSF_FetchAndOpBegin,sf,0,0,0);CHKERRQ(ierr); 1665a1729e3fSJunchao Zhang PetscFunctionReturn(0); 1666a1729e3fSJunchao Zhang } 1667a1729e3fSJunchao Zhang 1668a1729e3fSJunchao Zhang /*@C 1669a1729e3fSJunchao 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 1670a1729e3fSJunchao Zhang 1671a1729e3fSJunchao Zhang Collective 1672a1729e3fSJunchao Zhang 1673a1729e3fSJunchao Zhang Input Arguments: 1674a1729e3fSJunchao Zhang + sf - star forest 1675a1729e3fSJunchao Zhang . unit - data type 1676a1729e3fSJunchao Zhang . leafdata - leaf values to use in reduction 1677a1729e3fSJunchao Zhang - op - operation to use for reduction 1678a1729e3fSJunchao Zhang 1679a1729e3fSJunchao Zhang Output Arguments: 1680a1729e3fSJunchao Zhang + rootdata - root values to be updated, input state is seen by first process to perform an update 1681a1729e3fSJunchao Zhang - leafupdate - state at each leaf's respective root immediately prior to my atomic update 1682a1729e3fSJunchao Zhang 1683a1729e3fSJunchao Zhang Level: advanced 1684a1729e3fSJunchao Zhang 1685a1729e3fSJunchao Zhang .seealso: PetscSFComputeDegreeEnd(), PetscSFReduceEnd(), PetscSFSetGraph() 1686a1729e3fSJunchao Zhang @*/ 1687a1729e3fSJunchao Zhang PetscErrorCode PetscSFFetchAndOpEnd(PetscSF sf,MPI_Datatype unit,void *rootdata,const void *leafdata,void *leafupdate,MPI_Op op) 1688a1729e3fSJunchao Zhang { 1689a1729e3fSJunchao Zhang PetscErrorCode ierr; 1690a1729e3fSJunchao Zhang 1691a1729e3fSJunchao Zhang PetscFunctionBegin; 1692a1729e3fSJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 1693a1729e3fSJunchao Zhang ierr = PetscLogEventBegin(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr); 169400816365SJunchao Zhang ierr = (*sf->ops->FetchAndOpEnd)(sf,unit,rootdata,leafdata,leafupdate,op);CHKERRQ(ierr); 1695a1729e3fSJunchao Zhang ierr = PetscLogEventEnd(PETSCSF_FetchAndOpEnd,sf,0,0,0);CHKERRQ(ierr); 1696a1729e3fSJunchao Zhang PetscFunctionReturn(0); 1697a1729e3fSJunchao Zhang } 1698a1729e3fSJunchao Zhang 1699a1729e3fSJunchao Zhang /*@C 170095fce210SBarry Smith PetscSFComputeDegreeBegin - begin computation of degree for each root vertex, to be completed with PetscSFComputeDegreeEnd() 170195fce210SBarry Smith 170295fce210SBarry Smith Collective 170395fce210SBarry Smith 170495fce210SBarry Smith Input Arguments: 170595fce210SBarry Smith . sf - star forest 170695fce210SBarry Smith 170795fce210SBarry Smith Output Arguments: 170895fce210SBarry Smith . degree - degree of each root vertex 170995fce210SBarry Smith 171095fce210SBarry Smith Level: advanced 171195fce210SBarry Smith 1712ffe67aa5SVáclav Hapla Notes: 1713ffe67aa5SVáclav Hapla The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it. 1714ffe67aa5SVáclav Hapla 171595fce210SBarry Smith .seealso: PetscSFGatherBegin() 171695fce210SBarry Smith @*/ 171795fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeBegin(PetscSF sf,const PetscInt **degree) 171895fce210SBarry Smith { 171995fce210SBarry Smith PetscErrorCode ierr; 172095fce210SBarry Smith 172195fce210SBarry Smith PetscFunctionBegin; 172295fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 172395fce210SBarry Smith PetscSFCheckGraphSet(sf,1); 172495fce210SBarry Smith PetscValidPointer(degree,2); 1725803bd9e8SMatthew G. Knepley if (!sf->degreeknown) { 17265b0d146aSStefano Zampini PetscInt i, nroots = sf->nroots, maxlocal; 1727803bd9e8SMatthew G. Knepley if (sf->degree) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Calls to PetscSFComputeDegreeBegin() cannot be nested."); 17285b0d146aSStefano Zampini maxlocal = sf->maxleaf-sf->minleaf+1; 172929046d53SLisandro Dalcin ierr = PetscMalloc1(nroots,&sf->degree);CHKERRQ(ierr); 173029046d53SLisandro Dalcin ierr = PetscMalloc1(PetscMax(maxlocal,1),&sf->degreetmp);CHKERRQ(ierr); /* allocate at least one entry, see check in PetscSFComputeDegreeEnd() */ 173129046d53SLisandro Dalcin for (i=0; i<nroots; i++) sf->degree[i] = 0; 17329837ea96SMatthew G. Knepley for (i=0; i<maxlocal; i++) sf->degreetmp[i] = 1; 17335b0d146aSStefano Zampini ierr = PetscSFReduceBegin(sf,MPIU_INT,sf->degreetmp-sf->minleaf,sf->degree,MPI_SUM);CHKERRQ(ierr); 173495fce210SBarry Smith } 173595fce210SBarry Smith *degree = NULL; 173695fce210SBarry Smith PetscFunctionReturn(0); 173795fce210SBarry Smith } 173895fce210SBarry Smith 173995fce210SBarry Smith /*@C 174095fce210SBarry Smith PetscSFComputeDegreeEnd - complete computation of degree for each root vertex, started with PetscSFComputeDegreeBegin() 174195fce210SBarry Smith 174295fce210SBarry Smith Collective 174395fce210SBarry Smith 174495fce210SBarry Smith Input Arguments: 174595fce210SBarry Smith . sf - star forest 174695fce210SBarry Smith 174795fce210SBarry Smith Output Arguments: 174895fce210SBarry Smith . degree - degree of each root vertex 174995fce210SBarry Smith 175095fce210SBarry Smith Level: developer 175195fce210SBarry Smith 1752ffe67aa5SVáclav Hapla Notes: 1753ffe67aa5SVáclav Hapla The returned array is owned by PetscSF and automatically freed by PetscSFDestroy(). Hence no need to call PetscFree() on it. 1754ffe67aa5SVáclav Hapla 175595fce210SBarry Smith .seealso: 175695fce210SBarry Smith @*/ 175795fce210SBarry Smith PetscErrorCode PetscSFComputeDegreeEnd(PetscSF sf,const PetscInt **degree) 175895fce210SBarry Smith { 175995fce210SBarry Smith PetscErrorCode ierr; 176095fce210SBarry Smith 176195fce210SBarry Smith PetscFunctionBegin; 176295fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 176395fce210SBarry Smith PetscSFCheckGraphSet(sf,1); 176429046d53SLisandro Dalcin PetscValidPointer(degree,2); 176595fce210SBarry Smith if (!sf->degreeknown) { 176629046d53SLisandro Dalcin if (!sf->degreetmp) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Must call PetscSFComputeDegreeBegin() before PetscSFComputeDegreeEnd()"); 17675b0d146aSStefano Zampini ierr = PetscSFReduceEnd(sf,MPIU_INT,sf->degreetmp-sf->minleaf,sf->degree,MPI_SUM);CHKERRQ(ierr); 176895fce210SBarry Smith ierr = PetscFree(sf->degreetmp);CHKERRQ(ierr); 176995fce210SBarry Smith sf->degreeknown = PETSC_TRUE; 177095fce210SBarry Smith } 177195fce210SBarry Smith *degree = sf->degree; 177295fce210SBarry Smith PetscFunctionReturn(0); 177395fce210SBarry Smith } 177495fce210SBarry Smith 1775673100f5SVaclav Hapla 1776673100f5SVaclav Hapla /*@C 177766dfcd1aSVaclav Hapla PetscSFComputeMultiRootOriginalNumbering - Returns original numbering of multi-roots (roots of multi-SF returned by PetscSFGetMultiSF()). 177866dfcd1aSVaclav Hapla Each multi-root is assigned index of the corresponding original root. 1779673100f5SVaclav Hapla 1780673100f5SVaclav Hapla Collective 1781673100f5SVaclav Hapla 1782673100f5SVaclav Hapla Input Arguments: 1783673100f5SVaclav Hapla + sf - star forest 1784673100f5SVaclav Hapla - degree - degree of each root vertex, computed with PetscSFComputeDegreeBegin()/PetscSFComputeDegreeEnd() 1785673100f5SVaclav Hapla 1786673100f5SVaclav Hapla Output Arguments: 178766dfcd1aSVaclav Hapla + nMultiRoots - (optional) number of multi-roots (roots of multi-SF) 178866dfcd1aSVaclav Hapla - multiRootsOrigNumbering - original indices of multi-roots; length of this array is nMultiRoots 1789673100f5SVaclav Hapla 1790673100f5SVaclav Hapla Level: developer 1791673100f5SVaclav Hapla 1792ffe67aa5SVáclav Hapla Notes: 1793ffe67aa5SVáclav Hapla The returned array multiRootsOrigNumbering is newly allocated and should be destroyed with PetscFree() when no longer needed. 1794ffe67aa5SVáclav Hapla 1795673100f5SVaclav Hapla .seealso: PetscSFComputeDegreeBegin(), PetscSFComputeDegreeEnd(), PetscSFGetMultiSF() 1796673100f5SVaclav Hapla @*/ 179766dfcd1aSVaclav Hapla PetscErrorCode PetscSFComputeMultiRootOriginalNumbering(PetscSF sf, const PetscInt degree[], PetscInt *nMultiRoots, PetscInt *multiRootsOrigNumbering[]) 1798673100f5SVaclav Hapla { 1799673100f5SVaclav Hapla PetscSF msf; 1800673100f5SVaclav Hapla PetscInt i, j, k, nroots, nmroots; 1801673100f5SVaclav Hapla PetscErrorCode ierr; 1802673100f5SVaclav Hapla 1803673100f5SVaclav Hapla PetscFunctionBegin; 1804673100f5SVaclav Hapla PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 1805673100f5SVaclav Hapla ierr = PetscSFGetGraph(sf, &nroots, NULL, NULL, NULL);CHKERRQ(ierr); 180629328920SVaclav Hapla if (nroots) PetscValidIntPointer(degree,2); 180766dfcd1aSVaclav Hapla if (nMultiRoots) PetscValidIntPointer(nMultiRoots,3); 180866dfcd1aSVaclav Hapla PetscValidPointer(multiRootsOrigNumbering,4); 1809673100f5SVaclav Hapla ierr = PetscSFGetMultiSF(sf,&msf);CHKERRQ(ierr); 1810673100f5SVaclav Hapla ierr = PetscSFGetGraph(msf, &nmroots, NULL, NULL, NULL);CHKERRQ(ierr); 181166dfcd1aSVaclav Hapla ierr = PetscMalloc1(nmroots, multiRootsOrigNumbering);CHKERRQ(ierr); 1812673100f5SVaclav Hapla for (i=0,j=0,k=0; i<nroots; i++) { 1813673100f5SVaclav Hapla if (!degree[i]) continue; 1814673100f5SVaclav Hapla for (j=0; j<degree[i]; j++,k++) { 181566dfcd1aSVaclav Hapla (*multiRootsOrigNumbering)[k] = i; 1816673100f5SVaclav Hapla } 1817673100f5SVaclav Hapla } 1818673100f5SVaclav Hapla if (PetscUnlikely(k != nmroots)) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_PLIB,"sanity check fail"); 181966dfcd1aSVaclav Hapla if (nMultiRoots) *nMultiRoots = nmroots; 1820673100f5SVaclav Hapla PetscFunctionReturn(0); 1821673100f5SVaclav Hapla } 1822673100f5SVaclav Hapla 182395fce210SBarry Smith /*@C 182495fce210SBarry Smith PetscSFGatherBegin - begin pointwise gather of all leaves into multi-roots, to be completed with PetscSFGatherEnd() 182595fce210SBarry Smith 182695fce210SBarry Smith Collective 182795fce210SBarry Smith 182895fce210SBarry Smith Input Arguments: 182995fce210SBarry Smith + sf - star forest 183095fce210SBarry Smith . unit - data type 183195fce210SBarry Smith - leafdata - leaf data to gather to roots 183295fce210SBarry Smith 183395fce210SBarry Smith Output Argument: 183495fce210SBarry Smith . multirootdata - root buffer to gather into, amount of space per root is equal to its degree 183595fce210SBarry Smith 183695fce210SBarry Smith Level: intermediate 183795fce210SBarry Smith 183895fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin() 183995fce210SBarry Smith @*/ 184095fce210SBarry Smith PetscErrorCode PetscSFGatherBegin(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata) 184195fce210SBarry Smith { 184295fce210SBarry Smith PetscErrorCode ierr; 1843a5526d50SJunchao Zhang PetscSF multi = NULL; 184495fce210SBarry Smith 184595fce210SBarry Smith PetscFunctionBegin; 184695fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 184729046d53SLisandro Dalcin ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 184895fce210SBarry Smith ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr); 18498bfbc91cSJed Brown ierr = PetscSFReduceBegin(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr); 185095fce210SBarry Smith PetscFunctionReturn(0); 185195fce210SBarry Smith } 185295fce210SBarry Smith 185395fce210SBarry Smith /*@C 185495fce210SBarry Smith PetscSFGatherEnd - ends pointwise gather operation that was started with PetscSFGatherBegin() 185595fce210SBarry Smith 185695fce210SBarry Smith Collective 185795fce210SBarry Smith 185895fce210SBarry Smith Input Arguments: 185995fce210SBarry Smith + sf - star forest 186095fce210SBarry Smith . unit - data type 186195fce210SBarry Smith - leafdata - leaf data to gather to roots 186295fce210SBarry Smith 186395fce210SBarry Smith Output Argument: 186495fce210SBarry Smith . multirootdata - root buffer to gather into, amount of space per root is equal to its degree 186595fce210SBarry Smith 186695fce210SBarry Smith Level: intermediate 186795fce210SBarry Smith 186895fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd() 186995fce210SBarry Smith @*/ 187095fce210SBarry Smith PetscErrorCode PetscSFGatherEnd(PetscSF sf,MPI_Datatype unit,const void *leafdata,void *multirootdata) 187195fce210SBarry Smith { 187295fce210SBarry Smith PetscErrorCode ierr; 1873a5526d50SJunchao Zhang PetscSF multi = NULL; 187495fce210SBarry Smith 187595fce210SBarry Smith PetscFunctionBegin; 187695fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 187795fce210SBarry Smith ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr); 18788bfbc91cSJed Brown ierr = PetscSFReduceEnd(multi,unit,leafdata,multirootdata,MPIU_REPLACE);CHKERRQ(ierr); 187995fce210SBarry Smith PetscFunctionReturn(0); 188095fce210SBarry Smith } 188195fce210SBarry Smith 188295fce210SBarry Smith /*@C 188395fce210SBarry Smith PetscSFScatterBegin - begin pointwise scatter operation from multi-roots to leaves, to be completed with PetscSFScatterEnd() 188495fce210SBarry Smith 188595fce210SBarry Smith Collective 188695fce210SBarry Smith 188795fce210SBarry Smith Input Arguments: 188895fce210SBarry Smith + sf - star forest 188995fce210SBarry Smith . unit - data type 189095fce210SBarry Smith - multirootdata - root buffer to send to each leaf, one unit of data per leaf 189195fce210SBarry Smith 189295fce210SBarry Smith Output Argument: 189395fce210SBarry Smith . leafdata - leaf data to be update with personal data from each respective root 189495fce210SBarry Smith 189595fce210SBarry Smith Level: intermediate 189695fce210SBarry Smith 189795fce210SBarry Smith .seealso: PetscSFComputeDegreeBegin(), PetscSFScatterBegin() 189895fce210SBarry Smith @*/ 189995fce210SBarry Smith PetscErrorCode PetscSFScatterBegin(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata) 190095fce210SBarry Smith { 190195fce210SBarry Smith PetscErrorCode ierr; 1902a5526d50SJunchao Zhang PetscSF multi = NULL; 190395fce210SBarry Smith 190495fce210SBarry Smith PetscFunctionBegin; 190595fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 190695fce210SBarry Smith ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 190795fce210SBarry Smith ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr); 190895fce210SBarry Smith ierr = PetscSFBcastBegin(multi,unit,multirootdata,leafdata);CHKERRQ(ierr); 190995fce210SBarry Smith PetscFunctionReturn(0); 191095fce210SBarry Smith } 191195fce210SBarry Smith 191295fce210SBarry Smith /*@C 191395fce210SBarry Smith PetscSFScatterEnd - ends pointwise scatter operation that was started with PetscSFScatterBegin() 191495fce210SBarry Smith 191595fce210SBarry Smith Collective 191695fce210SBarry Smith 191795fce210SBarry Smith Input Arguments: 191895fce210SBarry Smith + sf - star forest 191995fce210SBarry Smith . unit - data type 192095fce210SBarry Smith - multirootdata - root buffer to send to each leaf, one unit of data per leaf 192195fce210SBarry Smith 192295fce210SBarry Smith Output Argument: 192395fce210SBarry Smith . leafdata - leaf data to be update with personal data from each respective root 192495fce210SBarry Smith 192595fce210SBarry Smith Level: intermediate 192695fce210SBarry Smith 192795fce210SBarry Smith .seealso: PetscSFComputeDegreeEnd(), PetscSFScatterEnd() 192895fce210SBarry Smith @*/ 192995fce210SBarry Smith PetscErrorCode PetscSFScatterEnd(PetscSF sf,MPI_Datatype unit,const void *multirootdata,void *leafdata) 193095fce210SBarry Smith { 193195fce210SBarry Smith PetscErrorCode ierr; 1932a5526d50SJunchao Zhang PetscSF multi = NULL; 193395fce210SBarry Smith 193495fce210SBarry Smith PetscFunctionBegin; 193595fce210SBarry Smith PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 193695fce210SBarry Smith ierr = PetscSFGetMultiSF(sf,&multi);CHKERRQ(ierr); 193795fce210SBarry Smith ierr = PetscSFBcastEnd(multi,unit,multirootdata,leafdata);CHKERRQ(ierr); 193895fce210SBarry Smith PetscFunctionReturn(0); 193995fce210SBarry Smith } 1940a7b3aa13SAta Mesgarnejad 1941a072220fSLawrence Mitchell static PetscErrorCode PetscSFCheckLeavesUnique_Private(PetscSF sf) 1942a072220fSLawrence Mitchell { 1943a072220fSLawrence Mitchell PetscInt i, n, nleaves; 1944a072220fSLawrence Mitchell const PetscInt *ilocal = NULL; 1945a072220fSLawrence Mitchell PetscHSetI seen; 1946a072220fSLawrence Mitchell PetscErrorCode ierr; 1947a072220fSLawrence Mitchell 1948a072220fSLawrence Mitchell PetscFunctionBegin; 1949b458e8f1SJose E. Roman if (PetscDefined(USE_DEBUG)) { 1950a072220fSLawrence Mitchell ierr = PetscSFGetGraph(sf,NULL,&nleaves,&ilocal,NULL);CHKERRQ(ierr); 1951a072220fSLawrence Mitchell ierr = PetscHSetICreate(&seen);CHKERRQ(ierr); 1952a072220fSLawrence Mitchell for (i = 0; i < nleaves; i++) { 1953a072220fSLawrence Mitchell const PetscInt leaf = ilocal ? ilocal[i] : i; 1954a072220fSLawrence Mitchell ierr = PetscHSetIAdd(seen,leaf);CHKERRQ(ierr); 1955a072220fSLawrence Mitchell } 1956a072220fSLawrence Mitchell ierr = PetscHSetIGetSize(seen,&n);CHKERRQ(ierr); 1957a072220fSLawrence Mitchell if (n != nleaves) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Provided leaves have repeated values: all leaves must be unique"); 1958a072220fSLawrence Mitchell ierr = PetscHSetIDestroy(&seen);CHKERRQ(ierr); 1959b458e8f1SJose E. Roman } 1960a072220fSLawrence Mitchell PetscFunctionReturn(0); 1961a072220fSLawrence Mitchell } 196254729392SStefano Zampini 1963a7b3aa13SAta Mesgarnejad /*@ 196404c0ada0SJunchao Zhang PetscSFCompose - Compose a new PetscSF by putting the second SF under the first one in a top (roots) down (leaves) view 1965a7b3aa13SAta Mesgarnejad 1966a7b3aa13SAta Mesgarnejad Input Parameters: 196754729392SStefano Zampini + sfA - The first PetscSF 196854729392SStefano Zampini - sfB - The second PetscSF 1969a7b3aa13SAta Mesgarnejad 1970a7b3aa13SAta Mesgarnejad Output Parameters: 197154729392SStefano Zampini . sfBA - The composite SF 1972a7b3aa13SAta Mesgarnejad 1973a7b3aa13SAta Mesgarnejad Level: developer 1974a7b3aa13SAta Mesgarnejad 1975a072220fSLawrence Mitchell Notes: 197654729392SStefano Zampini Currently, the two SFs must be defined on congruent communicators and they must be true star 197754729392SStefano Zampini forests, i.e. the same leaf is not connected with different roots. 197854729392SStefano Zampini 197954729392SStefano Zampini sfA's leaf space and sfB's root space might be partially overlapped. The composition builds 198054729392SStefano Zampini a graph with sfA's roots and sfB's leaves only when there is a path between them. Unconnected 198154729392SStefano Zampini nodes (roots or leaves) are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a 198254729392SStefano Zampini Bcast on sfA, then a Bcast on sfB, on connected nodes. 1983a072220fSLawrence Mitchell 198404c0ada0SJunchao Zhang .seealso: PetscSF, PetscSFComposeInverse(), PetscSFGetGraph(), PetscSFSetGraph() 1985a7b3aa13SAta Mesgarnejad @*/ 1986a7b3aa13SAta Mesgarnejad PetscErrorCode PetscSFCompose(PetscSF sfA,PetscSF sfB,PetscSF *sfBA) 1987a7b3aa13SAta Mesgarnejad { 198804c0ada0SJunchao Zhang PetscErrorCode ierr; 1989a7b3aa13SAta Mesgarnejad const PetscSFNode *remotePointsA,*remotePointsB; 1990d41018fbSJunchao Zhang PetscSFNode *remotePointsBA=NULL,*reorderedRemotePointsA = NULL,*leafdataB; 199154729392SStefano Zampini const PetscInt *localPointsA,*localPointsB; 199254729392SStefano Zampini PetscInt *localPointsBA; 199354729392SStefano Zampini PetscInt i,numRootsA,numLeavesA,numRootsB,numLeavesB,minleaf,maxleaf,numLeavesBA; 199454729392SStefano Zampini PetscBool denseB; 1995a7b3aa13SAta Mesgarnejad 1996a7b3aa13SAta Mesgarnejad PetscFunctionBegin; 1997a7b3aa13SAta Mesgarnejad PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1); 199829046d53SLisandro Dalcin PetscSFCheckGraphSet(sfA,1); 199929046d53SLisandro Dalcin PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2); 200029046d53SLisandro Dalcin PetscSFCheckGraphSet(sfB,2); 200154729392SStefano Zampini PetscCheckSameComm(sfA,1,sfB,2); 200229046d53SLisandro Dalcin PetscValidPointer(sfBA,3); 200354729392SStefano Zampini ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr); 200454729392SStefano Zampini ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr); 200554729392SStefano Zampini 2006a7b3aa13SAta Mesgarnejad ierr = PetscSFGetGraph(sfA,&numRootsA,&numLeavesA,&localPointsA,&remotePointsA);CHKERRQ(ierr); 2007a7b3aa13SAta Mesgarnejad ierr = PetscSFGetGraph(sfB,&numRootsB,&numLeavesB,&localPointsB,&remotePointsB);CHKERRQ(ierr); 2008d41018fbSJunchao Zhang if (localPointsA) { 200954729392SStefano Zampini ierr = PetscMalloc1(numRootsB,&reorderedRemotePointsA);CHKERRQ(ierr); 201054729392SStefano Zampini for (i=0; i<numRootsB; i++) { 201154729392SStefano Zampini reorderedRemotePointsA[i].rank = -1; 201254729392SStefano Zampini reorderedRemotePointsA[i].index = -1; 201354729392SStefano Zampini } 201454729392SStefano Zampini for (i=0; i<numLeavesA; i++) { 201554729392SStefano Zampini if (localPointsA[i] >= numRootsB) continue; 201654729392SStefano Zampini reorderedRemotePointsA[localPointsA[i]] = remotePointsA[i]; 201754729392SStefano Zampini } 2018d41018fbSJunchao Zhang remotePointsA = reorderedRemotePointsA; 2019d41018fbSJunchao Zhang } 2020d41018fbSJunchao Zhang ierr = PetscSFGetLeafRange(sfB,&minleaf,&maxleaf);CHKERRQ(ierr); 2021d41018fbSJunchao Zhang ierr = PetscMalloc1(maxleaf-minleaf+1,&leafdataB);CHKERRQ(ierr); 2022d41018fbSJunchao Zhang ierr = PetscSFBcastBegin(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf);CHKERRQ(ierr); 2023d41018fbSJunchao Zhang ierr = PetscSFBcastEnd(sfB,MPIU_2INT,remotePointsA,leafdataB-minleaf);CHKERRQ(ierr); 2024d41018fbSJunchao Zhang ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr); 2025d41018fbSJunchao Zhang 202654729392SStefano Zampini denseB = (PetscBool)!localPointsB; 202754729392SStefano Zampini for (i=0,numLeavesBA=0; i<numLeavesB; i++) { 202854729392SStefano Zampini if (leafdataB[localPointsB ? localPointsB[i]-minleaf : i].rank == -1) denseB = PETSC_FALSE; 202954729392SStefano Zampini else numLeavesBA++; 203054729392SStefano Zampini } 203154729392SStefano Zampini if (denseB) { 2032d41018fbSJunchao Zhang localPointsBA = NULL; 2033d41018fbSJunchao Zhang remotePointsBA = leafdataB; 2034d41018fbSJunchao Zhang } else { 203554729392SStefano Zampini ierr = PetscMalloc1(numLeavesBA,&localPointsBA);CHKERRQ(ierr); 203654729392SStefano Zampini ierr = PetscMalloc1(numLeavesBA,&remotePointsBA);CHKERRQ(ierr); 203754729392SStefano Zampini for (i=0,numLeavesBA=0; i<numLeavesB; i++) { 203854729392SStefano Zampini const PetscInt l = localPointsB ? localPointsB[i] : i; 203954729392SStefano Zampini 204054729392SStefano Zampini if (leafdataB[l-minleaf].rank == -1) continue; 204154729392SStefano Zampini remotePointsBA[numLeavesBA] = leafdataB[l-minleaf]; 204254729392SStefano Zampini localPointsBA[numLeavesBA] = l; 204354729392SStefano Zampini numLeavesBA++; 204454729392SStefano Zampini } 2045d41018fbSJunchao Zhang ierr = PetscFree(leafdataB);CHKERRQ(ierr); 2046d41018fbSJunchao Zhang } 204754729392SStefano Zampini ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr); 204820c24465SJunchao Zhang ierr = PetscSFSetFromOptions(*sfBA);CHKERRQ(ierr); 204954729392SStefano Zampini ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr); 2050a7b3aa13SAta Mesgarnejad PetscFunctionReturn(0); 2051a7b3aa13SAta Mesgarnejad } 20521c6ba672SJunchao Zhang 205304c0ada0SJunchao Zhang /*@ 205454729392SStefano Zampini PetscSFComposeInverse - Compose a new PetscSF by putting the inverse of the second SF under the first one 205504c0ada0SJunchao Zhang 205604c0ada0SJunchao Zhang Input Parameters: 205754729392SStefano Zampini + sfA - The first PetscSF 205854729392SStefano Zampini - sfB - The second PetscSF 205904c0ada0SJunchao Zhang 206004c0ada0SJunchao Zhang Output Parameters: 206154729392SStefano Zampini . sfBA - The composite SF. 206204c0ada0SJunchao Zhang 206304c0ada0SJunchao Zhang Level: developer 206404c0ada0SJunchao Zhang 206554729392SStefano Zampini Notes: 206654729392SStefano Zampini Currently, the two SFs must be defined on congruent communicators and they must be true star 206754729392SStefano Zampini forests, i.e. the same leaf is not connected with different roots. Even more, all roots of the 206854729392SStefano Zampini second SF must have a degree of 1, i.e., no roots have more than one leaf connected. 206954729392SStefano Zampini 207054729392SStefano Zampini sfA's leaf space and sfB's leaf space might be partially overlapped. The composition builds 207154729392SStefano Zampini a graph with sfA's roots and sfB's roots only when there is a path between them. Unconnected 207254729392SStefano Zampini roots are not in sfBA. Doing a Bcast on the new SF is equivalent to doing a Bcast on sfA, then 207354729392SStefano Zampini a Reduce on sfB, on connected roots. 207454729392SStefano Zampini 207554729392SStefano Zampini .seealso: PetscSF, PetscSFCompose(), PetscSFGetGraph(), PetscSFSetGraph(), PetscSFCreateInverseSF() 207604c0ada0SJunchao Zhang @*/ 207704c0ada0SJunchao Zhang PetscErrorCode PetscSFComposeInverse(PetscSF sfA,PetscSF sfB,PetscSF *sfBA) 207804c0ada0SJunchao Zhang { 207904c0ada0SJunchao Zhang PetscErrorCode ierr; 208004c0ada0SJunchao Zhang const PetscSFNode *remotePointsA,*remotePointsB; 208104c0ada0SJunchao Zhang PetscSFNode *remotePointsBA; 208204c0ada0SJunchao Zhang const PetscInt *localPointsA,*localPointsB; 208354729392SStefano Zampini PetscSFNode *reorderedRemotePointsA = NULL; 208454729392SStefano Zampini PetscInt i,numRootsA,numLeavesA,numLeavesBA,numRootsB,numLeavesB,minleaf,maxleaf,*localPointsBA; 20855b0d146aSStefano Zampini MPI_Op op; 20865b0d146aSStefano Zampini #if defined(PETSC_USE_64BIT_INDICES) 20875b0d146aSStefano Zampini PetscBool iswin; 20885b0d146aSStefano Zampini #endif 208904c0ada0SJunchao Zhang 209004c0ada0SJunchao Zhang PetscFunctionBegin; 209104c0ada0SJunchao Zhang PetscValidHeaderSpecific(sfA,PETSCSF_CLASSID,1); 209204c0ada0SJunchao Zhang PetscSFCheckGraphSet(sfA,1); 209304c0ada0SJunchao Zhang PetscValidHeaderSpecific(sfB,PETSCSF_CLASSID,2); 209404c0ada0SJunchao Zhang PetscSFCheckGraphSet(sfB,2); 209554729392SStefano Zampini PetscCheckSameComm(sfA,1,sfB,2); 209604c0ada0SJunchao Zhang PetscValidPointer(sfBA,3); 209754729392SStefano Zampini ierr = PetscSFCheckLeavesUnique_Private(sfA);CHKERRQ(ierr); 209854729392SStefano Zampini ierr = PetscSFCheckLeavesUnique_Private(sfB);CHKERRQ(ierr); 209954729392SStefano Zampini 210004c0ada0SJunchao Zhang ierr = PetscSFGetGraph(sfA, &numRootsA, &numLeavesA, &localPointsA, &remotePointsA);CHKERRQ(ierr); 210104c0ada0SJunchao Zhang ierr = PetscSFGetGraph(sfB, &numRootsB, &numLeavesB, &localPointsB, &remotePointsB);CHKERRQ(ierr); 21025b0d146aSStefano Zampini 21035b0d146aSStefano Zampini /* TODO: Check roots of sfB have degree of 1 */ 21045b0d146aSStefano Zampini /* Once we implement it, we can replace the MPI_MAXLOC 21055b0d146aSStefano Zampini with MPIU_REPLACE. In that case, MPI_MAXLOC and MPIU_REPLACE have the same effect. 21065b0d146aSStefano Zampini We use MPI_MAXLOC only to have a deterministic output from this routine if 21075b0d146aSStefano Zampini the root condition is not meet. 21085b0d146aSStefano Zampini */ 21095b0d146aSStefano Zampini op = MPI_MAXLOC; 21105b0d146aSStefano Zampini #if defined(PETSC_USE_64BIT_INDICES) 21115b0d146aSStefano Zampini /* we accept a non-deterministic output (if any) with PETSCSFWINDOW, since MPI_MAXLOC cannot operate on MPIU_2INT with MPI_Accumulate */ 21125b0d146aSStefano Zampini ierr = PetscObjectTypeCompare((PetscObject)sfB,PETSCSFWINDOW,&iswin);CHKERRQ(ierr); 21135b0d146aSStefano Zampini if (iswin) op = MPIU_REPLACE; 21145b0d146aSStefano Zampini #endif 21155b0d146aSStefano Zampini 211654729392SStefano Zampini ierr = PetscSFGetLeafRange(sfB, &minleaf, &maxleaf);CHKERRQ(ierr); 211754729392SStefano Zampini ierr = PetscMalloc1(maxleaf - minleaf + 1,&reorderedRemotePointsA);CHKERRQ(ierr); 211854729392SStefano Zampini for (i=0; i<maxleaf - minleaf + 1; i++) { 211954729392SStefano Zampini reorderedRemotePointsA[i].rank = -1; 212054729392SStefano Zampini reorderedRemotePointsA[i].index = -1; 212154729392SStefano Zampini } 212254729392SStefano Zampini if (localPointsA) { 212354729392SStefano Zampini for (i=0; i<numLeavesA; i++) { 212454729392SStefano Zampini if (localPointsA[i] > maxleaf || localPointsA[i] < minleaf) continue; 212554729392SStefano Zampini reorderedRemotePointsA[localPointsA[i] - minleaf] = remotePointsA[i]; 212654729392SStefano Zampini } 212754729392SStefano Zampini } else { 212854729392SStefano Zampini for (i=0; i<numLeavesA; i++) { 212954729392SStefano Zampini if (i > maxleaf || i < minleaf) continue; 213054729392SStefano Zampini reorderedRemotePointsA[i - minleaf] = remotePointsA[i]; 213154729392SStefano Zampini } 213254729392SStefano Zampini } 213354729392SStefano Zampini 213454729392SStefano Zampini ierr = PetscMalloc1(numRootsB,&localPointsBA);CHKERRQ(ierr); 213504c0ada0SJunchao Zhang ierr = PetscMalloc1(numRootsB,&remotePointsBA);CHKERRQ(ierr); 213654729392SStefano Zampini for (i=0; i<numRootsB; i++) { 213754729392SStefano Zampini remotePointsBA[i].rank = -1; 213854729392SStefano Zampini remotePointsBA[i].index = -1; 213954729392SStefano Zampini } 214054729392SStefano Zampini 21415b0d146aSStefano Zampini ierr = PetscSFReduceBegin(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,op);CHKERRQ(ierr); 21425b0d146aSStefano Zampini ierr = PetscSFReduceEnd(sfB,MPIU_2INT,reorderedRemotePointsA-minleaf,remotePointsBA,op);CHKERRQ(ierr); 214354729392SStefano Zampini ierr = PetscFree(reorderedRemotePointsA);CHKERRQ(ierr); 214454729392SStefano Zampini for (i=0,numLeavesBA=0; i<numRootsB; i++) { 214554729392SStefano Zampini if (remotePointsBA[i].rank == -1) continue; 214654729392SStefano Zampini remotePointsBA[numLeavesBA].rank = remotePointsBA[i].rank; 214754729392SStefano Zampini remotePointsBA[numLeavesBA].index = remotePointsBA[i].index; 214854729392SStefano Zampini localPointsBA[numLeavesBA] = i; 214954729392SStefano Zampini numLeavesBA++; 215054729392SStefano Zampini } 215154729392SStefano Zampini ierr = PetscSFCreate(PetscObjectComm((PetscObject)sfA),sfBA);CHKERRQ(ierr); 215220c24465SJunchao Zhang ierr = PetscSFSetFromOptions(*sfBA);CHKERRQ(ierr); 215354729392SStefano Zampini ierr = PetscSFSetGraph(*sfBA,numRootsA,numLeavesBA,localPointsBA,PETSC_OWN_POINTER,remotePointsBA,PETSC_OWN_POINTER);CHKERRQ(ierr); 215404c0ada0SJunchao Zhang PetscFunctionReturn(0); 215504c0ada0SJunchao Zhang } 215604c0ada0SJunchao Zhang 21571c6ba672SJunchao Zhang /* 21581c6ba672SJunchao Zhang PetscSFCreateLocalSF_Private - Creates a local PetscSF that only has intra-process edges of the global PetscSF 21591c6ba672SJunchao Zhang 21601c6ba672SJunchao Zhang Input Parameters: 21611c6ba672SJunchao Zhang . sf - The global PetscSF 21621c6ba672SJunchao Zhang 21631c6ba672SJunchao Zhang Output Parameters: 21641c6ba672SJunchao Zhang . out - The local PetscSF 21651c6ba672SJunchao Zhang */ 21661c6ba672SJunchao Zhang PetscErrorCode PetscSFCreateLocalSF_Private(PetscSF sf,PetscSF *out) 21671c6ba672SJunchao Zhang { 21681c6ba672SJunchao Zhang MPI_Comm comm; 21691c6ba672SJunchao Zhang PetscMPIInt myrank; 21701c6ba672SJunchao Zhang const PetscInt *ilocal; 21711c6ba672SJunchao Zhang const PetscSFNode *iremote; 21721c6ba672SJunchao Zhang PetscInt i,j,nroots,nleaves,lnleaves,*lilocal; 21731c6ba672SJunchao Zhang PetscSFNode *liremote; 21741c6ba672SJunchao Zhang PetscSF lsf; 21751c6ba672SJunchao Zhang PetscErrorCode ierr; 21761c6ba672SJunchao Zhang 21771c6ba672SJunchao Zhang PetscFunctionBegin; 21781c6ba672SJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 21791c6ba672SJunchao Zhang if (sf->ops->CreateLocalSF) { 21801c6ba672SJunchao Zhang ierr = (*sf->ops->CreateLocalSF)(sf,out);CHKERRQ(ierr); 21811c6ba672SJunchao Zhang } else { 21821c6ba672SJunchao Zhang /* Could use PetscSFCreateEmbeddedLeafSF, but since we know the comm is PETSC_COMM_SELF, we can make it fast */ 21831c6ba672SJunchao Zhang ierr = PetscObjectGetComm((PetscObject)sf,&comm);CHKERRQ(ierr); 2184ffc4695bSBarry Smith ierr = MPI_Comm_rank(comm,&myrank);CHKERRMPI(ierr); 21851c6ba672SJunchao Zhang 21861c6ba672SJunchao Zhang /* Find out local edges and build a local SF */ 21871c6ba672SJunchao Zhang ierr = PetscSFGetGraph(sf,&nroots,&nleaves,&ilocal,&iremote);CHKERRQ(ierr); 21881c6ba672SJunchao Zhang for (i=lnleaves=0; i<nleaves; i++) {if (iremote[i].rank == (PetscInt)myrank) lnleaves++;} 21891c6ba672SJunchao Zhang ierr = PetscMalloc1(lnleaves,&lilocal);CHKERRQ(ierr); 21901c6ba672SJunchao Zhang ierr = PetscMalloc1(lnleaves,&liremote);CHKERRQ(ierr); 21911c6ba672SJunchao Zhang 21921c6ba672SJunchao Zhang for (i=j=0; i<nleaves; i++) { 21931c6ba672SJunchao Zhang if (iremote[i].rank == (PetscInt)myrank) { 21941c6ba672SJunchao Zhang lilocal[j] = ilocal? ilocal[i] : i; /* ilocal=NULL for contiguous storage */ 21951c6ba672SJunchao Zhang liremote[j].rank = 0; /* rank in PETSC_COMM_SELF */ 21961c6ba672SJunchao Zhang liremote[j].index = iremote[i].index; 21971c6ba672SJunchao Zhang j++; 21981c6ba672SJunchao Zhang } 21991c6ba672SJunchao Zhang } 22001c6ba672SJunchao Zhang ierr = PetscSFCreate(PETSC_COMM_SELF,&lsf);CHKERRQ(ierr); 220120c24465SJunchao Zhang ierr = PetscSFSetFromOptions(lsf);CHKERRQ(ierr); 22021c6ba672SJunchao Zhang ierr = PetscSFSetGraph(lsf,nroots,lnleaves,lilocal,PETSC_OWN_POINTER,liremote,PETSC_OWN_POINTER);CHKERRQ(ierr); 22031c6ba672SJunchao Zhang ierr = PetscSFSetUp(lsf);CHKERRQ(ierr); 22041c6ba672SJunchao Zhang *out = lsf; 22051c6ba672SJunchao Zhang } 22061c6ba672SJunchao Zhang PetscFunctionReturn(0); 22071c6ba672SJunchao Zhang } 2208dd5b3ca6SJunchao Zhang 2209dd5b3ca6SJunchao Zhang /* Similar to PetscSFBcast, but only Bcast to leaves on rank 0 */ 2210dd5b3ca6SJunchao Zhang PetscErrorCode PetscSFBcastToZero_Private(PetscSF sf,MPI_Datatype unit,const void *rootdata,void *leafdata) 2211dd5b3ca6SJunchao Zhang { 2212dd5b3ca6SJunchao Zhang PetscErrorCode ierr; 2213eb02082bSJunchao Zhang PetscMemType rootmtype,leafmtype; 2214dd5b3ca6SJunchao Zhang 2215dd5b3ca6SJunchao Zhang PetscFunctionBegin; 2216dd5b3ca6SJunchao Zhang PetscValidHeaderSpecific(sf,PETSCSF_CLASSID,1); 2217dd5b3ca6SJunchao Zhang ierr = PetscSFSetUp(sf);CHKERRQ(ierr); 2218dd5b3ca6SJunchao Zhang ierr = PetscLogEventBegin(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr); 2219eb02082bSJunchao Zhang ierr = PetscGetMemType(rootdata,&rootmtype);CHKERRQ(ierr); 2220eb02082bSJunchao Zhang ierr = PetscGetMemType(leafdata,&leafmtype);CHKERRQ(ierr); 2221dd5b3ca6SJunchao Zhang if (sf->ops->BcastToZero) { 2222eb02082bSJunchao Zhang ierr = (*sf->ops->BcastToZero)(sf,unit,rootmtype,rootdata,leafmtype,leafdata);CHKERRQ(ierr); 2223dd5b3ca6SJunchao Zhang } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"PetscSFBcastToZero_Private is not supported on this SF type"); 2224dd5b3ca6SJunchao Zhang ierr = PetscLogEventEnd(PETSCSF_BcastAndOpBegin,sf,0,0,0);CHKERRQ(ierr); 2225dd5b3ca6SJunchao Zhang PetscFunctionReturn(0); 2226dd5b3ca6SJunchao Zhang } 2227dd5b3ca6SJunchao Zhang 2228