plexpoint.c (cfd92c66bdae16b66d27a6336fb90fa54c459cc4) plexpoint.c (a4e35b1925eceef64945ea472b84f2bf06a67b5e)
1#include <petsc/private/dmpleximpl.h> /*I "petscdmplex.h" I*/
2
3/*@
4 DMPlexGetPointLocal - get location of point data in local `Vec`
5
6 Not Collective
7
8 Input Parameters:

--- 36 unchanged lines hidden (view full) ---

45- array - array to index into
46
47 Output Parameter:
48. ptr - address of read reference to point data, type generic so user can place in structure
49
50 Level: intermediate
51
52 Note:
1#include <petsc/private/dmpleximpl.h> /*I "petscdmplex.h" I*/
2
3/*@
4 DMPlexGetPointLocal - get location of point data in local `Vec`
5
6 Not Collective
7
8 Input Parameters:

--- 36 unchanged lines hidden (view full) ---

45- array - array to index into
46
47 Output Parameter:
48. ptr - address of read reference to point data, type generic so user can place in structure
49
50 Level: intermediate
51
52 Note:
53
54 A common usage when data sizes are known statically:
53 A common usage when data sizes are known statically\:
55.vb
56 const struct { PetscScalar foo,bar,baz; } *ptr;
57 DMPlexPointLocalRead(dm,point,array,&ptr);
58 x = 2*ptr->foo + 3*ptr->bar + 5*ptr->baz;
59.ve
60
61.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointLocal()`, `DMPlexPointGlobalRead()`
62@*/

--- 21 unchanged lines hidden (view full) ---

84- array - array to index into
85
86 Output Parameter:
87. ptr - address of reference to point data, type generic so user can place in structure
88
89 Level: intermediate
90
91 Note:
54.vb
55 const struct { PetscScalar foo,bar,baz; } *ptr;
56 DMPlexPointLocalRead(dm,point,array,&ptr);
57 x = 2*ptr->foo + 3*ptr->bar + 5*ptr->baz;
58.ve
59
60.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointLocal()`, `DMPlexPointGlobalRead()`
61@*/

--- 21 unchanged lines hidden (view full) ---

83- array - array to index into
84
85 Output Parameter:
86. ptr - address of reference to point data, type generic so user can place in structure
87
88 Level: intermediate
89
90 Note:
92
93 A common usage when data sizes are known statically:
91 A common usage when data sizes are known statically\:
94.vb
95 struct { PetscScalar foo,bar,baz; } *ptr;
96 DMPlexPointLocalRef(dm,point,array,&ptr);
97 ptr->foo = 2; ptr->bar = 3; ptr->baz = 5;
98.ve
99
100.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointLocal()`, `DMPlexPointGlobalRef()`
101@*/

--- 152 unchanged lines hidden (view full) ---

254- array - array to index into
255
256 Output Parameter:
257. ptr - address of read reference to point data, type generic so user can place in structure; returns NULL if global point is not owned
258
259 Level: intermediate
260
261 Note:
92.vb
93 struct { PetscScalar foo,bar,baz; } *ptr;
94 DMPlexPointLocalRef(dm,point,array,&ptr);
95 ptr->foo = 2; ptr->bar = 3; ptr->baz = 5;
96.ve
97
98.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointLocal()`, `DMPlexPointGlobalRef()`
99@*/

--- 152 unchanged lines hidden (view full) ---

252- array - array to index into
253
254 Output Parameter:
255. ptr - address of read reference to point data, type generic so user can place in structure; returns NULL if global point is not owned
256
257 Level: intermediate
258
259 Note:
262
263 A common usage when data sizes are known statically:
260 A common usage when data sizes are known statically\:
264.vb
265 const struct { PetscScalar foo,bar,baz; } *ptr;
266 DMPlexPointGlobalRead(dm,point,array,&ptr);
267 x = 2*ptr->foo + 3*ptr->bar + 5*ptr->baz;
268.ve
269
270.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointGlobal()`, `DMPlexPointLocalRead()`, `DMPlexPointGlobalRef()`
271@*/

--- 21 unchanged lines hidden (view full) ---

293- array - array to index into
294
295 Output Parameter:
296. ptr - address of reference to point data, type generic so user can place in structure; returns NULL if global point is not owned
297
298 Level: intermediate
299
300 Note:
261.vb
262 const struct { PetscScalar foo,bar,baz; } *ptr;
263 DMPlexPointGlobalRead(dm,point,array,&ptr);
264 x = 2*ptr->foo + 3*ptr->bar + 5*ptr->baz;
265.ve
266
267.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointGlobal()`, `DMPlexPointLocalRead()`, `DMPlexPointGlobalRef()`
268@*/

--- 21 unchanged lines hidden (view full) ---

290- array - array to index into
291
292 Output Parameter:
293. ptr - address of reference to point data, type generic so user can place in structure; returns NULL if global point is not owned
294
295 Level: intermediate
296
297 Note:
301
302 A common usage when data sizes are known statically:
298 A common usage when data sizes are known statically\:
303.vb
304 struct { PetscScalar foo,bar,baz; } *ptr;
305 DMPlexPointGlobalRef(dm,point,array,&ptr);
306 ptr->foo = 2; ptr->bar = 3; ptr->baz = 5;
307.ve
308
309.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointGlobal()`, `DMPlexPointLocalRef()`, `DMPlexPointGlobalRead()`
310@*/

--- 109 unchanged lines hidden ---
299.vb
300 struct { PetscScalar foo,bar,baz; } *ptr;
301 DMPlexPointGlobalRef(dm,point,array,&ptr);
302 ptr->foo = 2; ptr->bar = 3; ptr->baz = 5;
303.ve
304
305.seealso: [](ch_unstructured), `DM`, `DMPLEX`, `DMGetLocalSection()`, `PetscSectionGetOffset()`, `PetscSectionGetDof()`, `DMPlexGetPointGlobal()`, `DMPlexPointLocalRef()`, `DMPlexPointGlobalRead()`
306@*/

--- 109 unchanged lines hidden ---