xref: /petsc/include/petscsftypes.h (revision 3e1910f1ab6113d8365e15c6b8c907ccce7ce4ea)
1 #if !defined(_PETSCSFTYPES_H)
2 #define _PETSCSFTYPES_H
3 
4 /*S
5    PetscSF - PETSc object for setting up and managing the communication of certain entries of arrays and Vecs between MPI processes.
6 
7    Level: intermediate
8 
9   Concepts: star forest
10 
11        PetscSF uses the concept of star forests to indicate and determine the communication patterns concisely and efficiently.
12   A star  http://en.wikipedia.org/wiki/Star_(graph_theory) forest is simply a collection of trees of height 1. The leave nodes represent
13   "ghost locations" for the root nodes.
14 
15 .seealso: PetscSFCreate(), VecScatter, VecScatterCreate()
16 S*/
17 typedef struct _p_PetscSF* PetscSF;
18 
19 #endif
20