xref: /petsc/include/petscsftypes.h (revision 0c312b8e6c5493a795e997bb0b5f8ef7b1287755)
1*0c312b8eSJed Brown #if !defined(_PETSCSFTYPES_H)
2*0c312b8eSJed Brown #define _PETSCSFTYPES_H
3*0c312b8eSJed Brown 
4*0c312b8eSJed Brown /*S
5*0c312b8eSJed Brown    PetscSF - PETSc object for setting up and managing the communication of certain entries of arrays and Vecs between MPI processes.
6*0c312b8eSJed Brown 
7*0c312b8eSJed Brown    Level: intermediate
8*0c312b8eSJed Brown 
9*0c312b8eSJed Brown   Concepts: star forest
10*0c312b8eSJed Brown 
11*0c312b8eSJed Brown        PetscSF uses the concept of star forests to indicate and determine the communication patterns concisely and efficiently.
12*0c312b8eSJed Brown   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*0c312b8eSJed Brown   "ghost locations" for the root nodes.
14*0c312b8eSJed Brown 
15*0c312b8eSJed Brown .seealso: PetscSFCreate(), VecScatter, VecScatterCreate()
16*0c312b8eSJed Brown S*/
17*0c312b8eSJed Brown typedef struct _p_PetscSF* PetscSF;
18*0c312b8eSJed Brown 
19*0c312b8eSJed Brown #endif
20