PetscSFCreateEmbeddedRootSF — PETSc 3.21.4 documentation

Skip to main content
`Ctrl`+`K`

# PetscSFCreateEmbeddedRootSF

removes edges from all but the selected roots of a `PetscSF`, does not remap indices

## Synopsis

    #include "petscsf.h"
    PetscErrorCode PetscSFCreateEmbeddedRootSF(PetscSF sf, PetscInt nselected, const PetscInt *selected, PetscSF *esf)

Collective

## Input Parameters

- sf - original star forest

- nselected - number of selected roots on this process

- selected - indices of the selected roots on this process

## Output Parameter

- esf - new star forest

## Note

To use the new `PetscSF`, it may be necessary to know the indices of the leaves that are still participating. This can be done by calling PetscSFGetGraph().

## See Also

`PetscSF`, `PetscSFSetGraph()`, `PetscSFGetGraph()`

## Level

advanced

## Location

src/vec/is/sf/interface/sf.c

## Examples

src/vec/is/sf/tutorials/ex1.c

## Implementations

PetscSFCreateEmbeddedRootSF_Alltoall() in src/vec/is/sf/impls/basic/alltoall/sfalltoall.c
PetscSFCreateEmbeddedRootSF_Basic() in src/vec/is/sf/impls/basic/sfbasic.c

Index of all PetscSF routines
Table of Contents for all manual pages
Index of all manual pages