1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
<center><a href="https://gitlab.com/petsc/petsc/-/blob/966382dc56242773704ef5f5cee7aa2db3ebc577/include/petscsftypes.h">Actual source code: petscsftypes.h</a></center><br>
<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.6">
<meta name="date" content="2025-04-30T18:14:50+00:00">
</head>
<body bgcolor="#FFFFFF">
<pre width=80>
<a name="line1"> 1: </a><font color="#A020F0">#pragma once</font>
<a name="line3"> 3: </a><font color="#B22222">/* MANSEC = <a href="../manualpages/Vec/Vec.html">Vec</a> */</font>
<a name="line4"> 4: </a><font color="#B22222">/* SUBMANSEC = <a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a> */</font>
<a name="line6"> 6: </a><font color="#B22222">/*S</font>
<a name="line7"> 7: </a><font color="#B22222"> <a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a> - PETSc object for setting up and managing the communication of certain entries of arrays and `<a href="../manualpages/Vec/Vec.html">Vec</a>` between MPI ranks.</font>
<a name="line9"> 9: </a><font color="#B22222"> Level: intermediate</font>
<a name="line11"> 11: </a><font color="#B22222"> `<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>` uses the concept of star forests to indicate and determine the communication patterns concisely and efficiently.</font>
<a name="line12"> 12: </a><font color="#B22222"> A star <https://en.wikipedia.org/wiki/Star_(graph_theory)> forest is simply a collection of trees of height 1. The leave nodes represent</font>
<a name="line13"> 13: </a><font color="#B22222"> "ghost locations" for the root nodes.</font>
<a name="line15"> 15: </a><font color="#B22222">.seealso: `<a href="../manualpages/PetscSF/PetscSFCreate.html">PetscSFCreate</a>()`, `<a href="../manualpages/PetscSF/VecScatter.html">VecScatter</a>`, `<a href="../manualpages/Vec/VecScatterCreate.html">VecScatterCreate</a>()`</font>
<a name="line16"> 16: </a><font color="#B22222">S*/</font>
<a name="line17"> 17: </a><font color="#4169E1">typedef struct _p_PetscSF *<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>;</font>
<a name="line19"> 19: </a><font color="#B22222">/*J</font>
<a name="line20"> 20: </a><font color="#B22222"> <a href="../manualpages/PetscSF/PetscSFType.html">PetscSFType</a> - String with the name of a `<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>` type</font>
<a name="line22"> 22: </a><font color="#B22222"> Level: beginner</font>
<a name="line24"> 24: </a><font color="#B22222">.seealso: `<a href="../manualpages/PetscSF/PetscSFSetType.html">PetscSFSetType</a>()`, `<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>`</font>
<a name="line25"> 25: </a><font color="#B22222">J*/</font>
<a name="line26"> 26: </a><font color="#4169E1">typedef const char *<a href="../manualpages/PetscSF/PetscSFType.html">PetscSFType</a>;</font>
<a name="line27"> 27: </a><strong><font color="#228B22">#define PETSCSFBASIC </font><font color="#666666">"basic"</font><font color="#228B22"></font></strong>
<a name="line28"> 28: </a><strong><font color="#228B22">#define PETSCSFNEIGHBOR </font><font color="#666666">"neighbor"</font><font color="#228B22"></font></strong>
<a name="line29"> 29: </a><strong><font color="#228B22">#define PETSCSFALLGATHERV </font><font color="#666666">"allgatherv"</font><font color="#228B22"></font></strong>
<a name="line30"> 30: </a><strong><font color="#228B22">#define PETSCSFALLGATHER </font><font color="#666666">"allgather"</font><font color="#228B22"></font></strong>
<a name="line31"> 31: </a><strong><font color="#228B22">#define PETSCSFGATHERV </font><font color="#666666">"gatherv"</font><font color="#228B22"></font></strong>
<a name="line32"> 32: </a><strong><font color="#228B22">#define PETSCSFGATHER </font><font color="#666666">"gather"</font><font color="#228B22"></font></strong>
<a name="line33"> 33: </a><strong><font color="#228B22">#define PETSCSFALLTOALL </font><font color="#666666">"alltoall"</font><font color="#228B22"></font></strong>
<a name="line34"> 34: </a><strong><font color="#228B22">#define PETSCSFWINDOW </font><font color="#666666">"window"</font><font color="#228B22"></font></strong>
<a name="line36"> 36: </a><font color="#B22222">/*S</font>
<a name="line37"> 37: </a><font color="#B22222"> <a href="../manualpages/PetscSF/PetscSFNode.html">PetscSFNode</a> - specifier of owner and index</font>
<a name="line39"> 39: </a><font color="#B22222"> Level: beginner</font>
<a name="line41"> 41: </a><font color="#B22222"> Sample Usage:</font>
<a name="line42"> 42: </a><font color="#B22222">.vb</font>
<a name="line43"> 43: </a><font color="#B22222"> <a href="../manualpages/PetscSF/PetscSFNode.html">PetscSFNode</a> *remote;</font>
<a name="line44"> 44: </a><font color="#B22222"> <a href="../manualpages/Sys/PetscCall.html">PetscCall</a>(<a href="../manualpages/Sys/PetscMalloc1.html">PetscMalloc1</a>(nleaves,&remote));</font>
<a name="line45"> 45: </a><font color="#B22222"> for (i=0; i<size; i++) {</font>
<a name="line46"> 46: </a><font color="#B22222"> remote[i].rank = i;</font>
<a name="line47"> 47: </a><font color="#B22222"> remote[i].index = rank;</font>
<a name="line48"> 48: </a><font color="#B22222"> }</font>
<a name="line49"> 49: </a><font color="#B22222">.ve</font>
<a name="line51"> 51: </a><font color="#B22222"> Sample Fortran Usage:</font>
<a name="line52"> 52: </a><font color="#B22222">.vb</font>
<a name="line53"> 53: </a><font color="#B22222"> type(<a href="../manualpages/PetscSF/PetscSFNode.html">PetscSFNode</a>) remote(6)</font>
<a name="line54"> 54: </a><font color="#B22222"> remote(1)%rank = modulo(rank+size-1,size)</font>
<a name="line55"> 55: </a><font color="#B22222"> remote(1)%index = 1 * stride</font>
<a name="line56"> 56: </a><font color="#B22222">.ve</font>
<a name="line58"> 58: </a><font color="#B22222"> Notes:</font>
<a name="line59"> 59: </a><font color="#B22222"> Use `MPIU_SF_NODE` when performing MPI operations on arrays of `<a href="../manualpages/PetscSF/PetscSFNode.html">PetscSFNode</a>`</font>
<a name="line61"> 61: </a><font color="#B22222"> Generally the values of `rank` should be in $[ 0,size)$ and the value of `index` greater than or equal to 0, but there are some situations that violate this.</font>
<a name="line63"> 63: </a><font color="#B22222">.seealso: `<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>`, `<a href="../manualpages/PetscSF/PetscSFSetGraph.html">PetscSFSetGraph</a>()`</font>
<a name="line64"> 64: </a><font color="#B22222">S*/</font>
<a name="line65"> 65: </a><font color="#4169E1">typedef</font> <font color="#4169E1">struct</font> {
<a name="line66"> 66: </a> <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> rank; <font color="#B22222">/* Rank of owner */</font>
<a name="line67"> 67: </a> <a href="../manualpages/Sys/PetscInt.html">PetscInt</a> index; <font color="#B22222">/* Index of node on rank */</font>
<a name="line68"> 68: </a>} <a href="../manualpages/PetscSF/PetscSFNode.html">PetscSFNode</a>;
<a name="line70"> 70: </a><strong><font color="#228B22">#define MPIU_SF_NODE MPIU_2INT</font></strong>
<a name="line72"> 72: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line73"> 73: </a> PETSCSF_ROOT2LEAF = 0,
<a name="line74"> 74: </a> PETSCSF_LEAF2ROOT = 1
<a name="line75"> 75: </a>} PetscSFDirection;
<a name="line76"> 76: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line77"> 77: </a> PETSCSF_BCAST = 0,
<a name="line78"> 78: </a> PETSCSF_REDUCE = 1,
<a name="line79"> 79: </a> PETSCSF_FETCH = 2
<a name="line80"> 80: </a>} PetscSFOperation;
<a name="line81"> 81: </a><font color="#B22222">/* When doing device-aware MPI, a backend refers to the SF/device interface */</font>
<a name="line82"> 82: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line83"> 83: </a> PETSCSF_BACKEND_INVALID = 0,
<a name="line84"> 84: </a> PETSCSF_BACKEND_CUDA = 1,
<a name="line85"> 85: </a> PETSCSF_BACKEND_HIP = 2,
<a name="line86"> 86: </a> PETSCSF_BACKEND_KOKKOS = 3
<a name="line87"> 87: </a>} PetscSFBackend;
<a name="line88"> 88: </a><font color="#4169E1">typedef struct _n_PetscSFLink *PetscSFLink;</font>
<a name="line90"> 90: </a><font color="#B22222">/*S</font>
<a name="line91"> 91: </a><font color="#B22222"> <a href="../manualpages/PetscSF/VecScatter.html">VecScatter</a> - Object used to manage communication of data</font>
<a name="line92"> 92: </a><font color="#B22222"> between vectors in parallel or between parallel and sequential vectors. Manages both scatters and gathers</font>
<a name="line94"> 94: </a><font color="#B22222"> Level: beginner</font>
<a name="line96"> 96: </a><font color="#B22222"> Note:</font>
<a name="line97"> 97: </a><font color="#B22222"> This is an alias for `<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>`</font>
<a name="line99"> 99: </a><font color="#B22222">.seealso: `<a href="../manualpages/Vec/Vec.html">Vec</a>`, `<a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a>`, `<a href="../manualpages/Vec/VecScatterCreate.html">VecScatterCreate</a>()`, `<a href="../manualpages/Vec/VecScatterBegin.html">VecScatterBegin</a>()`, `<a href="../manualpages/Vec/VecScatterEnd.html">VecScatterEnd</a>()`</font>
<a name="line100">100: </a><font color="#B22222">S*/</font>
<a name="line101">101: </a><font color="#4169E1">typedef <a href="../manualpages/PetscSF/PetscSF.html">PetscSF</a> <a href="../manualpages/PetscSF/VecScatter.html">VecScatter</a>;</font>
<a name="line103">103: </a><font color="#B22222">/*J</font>
<a name="line104">104: </a><font color="#B22222"> <a href="../manualpages/PetscSF/VecScatterType.html">VecScatterType</a> - String with the name of a PETSc vector scatter type</font>
<a name="line106">106: </a><font color="#B22222"> Level: beginner</font>
<a name="line108">108: </a><font color="#B22222"> Note:</font>
<a name="line109">109: </a><font color="#B22222"> This is an alias for `<a href="../manualpages/PetscSF/PetscSFType.html">PetscSFType</a>`</font>
<a name="line111">111: </a><font color="#B22222">.seealso: `<a href="../manualpages/PetscSF/PetscSFType.html">PetscSFType</a>`, `<a href="../manualpages/Vec/VecScatterSetType.html">VecScatterSetType</a>()`, `<a href="../manualpages/PetscSF/VecScatter.html">VecScatter</a>`, `<a href="../manualpages/Vec/VecScatterCreate.html">VecScatterCreate</a>()`, `<a href="../manualpages/Vec/VecScatterDestroy.html">VecScatterDestroy</a>()`</font>
<a name="line112">112: </a><font color="#B22222">J*/</font>
<a name="line113">113: </a><font color="#4169E1">typedef <a href="../manualpages/PetscSF/PetscSFType.html">PetscSFType</a> <a href="../manualpages/PetscSF/VecScatterType.html">VecScatterType</a>;</font>
</pre>
</body>
</html>
|
