Skip to main content
Ctrl+K
PETSc 3.23.2 documentation - Home
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • PetscSF

PetscSF#

PETSc object for setting up and managing the communication of certain entries of arrays and Vec between MPI ranks.

Synopsis#

typedef struct _p_PetscSF *PetscSF;

PetscSF uses the concept of star forests to indicate and determine the communication patterns concisely and efficiently. A star https://en.wikipedia.org/wiki/Star_(graph_theory) forest is simply a collection of trees of height 1. The leave nodes represent “ghost locations” for the root nodes.

See Also#

PetscSFCreate(), VecScatter, VecScatterCreate()

Level#

intermediate

Location#

include/petscsftypes.h

Examples#

src/ts/tutorials/ex11_sa.c
src/dm/impls/plex/tutorials/ex14.c
src/dm/tutorials/swarm_ex3.c
src/vec/is/sf/tutorials/ex3.c
src/ts/tutorials/ex30.c
src/vec/is/sf/tutorials/ex1.c
src/dm/impls/plex/tutorials/ex15.c
src/ts/tutorials/ex11.c
src/dm/tutorials/ex25.c
src/vec/is/sf/tutorials/ex1f.F90

Implementations#

_p_PetscSF in include/petsc/private/sfimpl.h
PetscSF_Allgatherv in src/vec/is/sf/impls/basic/allgatherv/sfallgatherv.h
PetscSF_Neighbor in src/vec/is/sf/impls/basic/neighbor/sfneighbor.c
PetscSF_Basic in src/vec/is/sf/impls/basic/sfbasic.h
PetscSF_Window in src/vec/is/sf/impls/window/sfwindow.c


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

On this page
  • Synopsis
  • See Also
  • Level
  • Location
  • Examples
  • Implementations
Edit on GitLab
Show Source

© Copyright 1991-2025, UChicago Argonne, LLC and the PETSc Development Team.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.1.

Last updated on 2025-05-22T09:06:30-0500 (v3.23.2-41-gb677dd453eaf).