4   DMDAVecGetArray - Returns a multiple dimension array that shares data with
14 . array - the array
21   In C, the indexing is "backwards" from what expects: array[k][j][i] NOT array[i][j][k]!
27 …The accessible indices are `array[zs:zs+zm-1][ys:ys+ym-1][xs:xs+xm-1]` where the values are obtain…
31 …Use `DMDAVecGetArray()` and pass for the array type `PetscScalar`,pointer :: array(:,...,:) of the…
35   The order of the indices is `array(xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` (when dof is 1) otherwise
36   `array(0:dof-1,xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` where the values are obtained from
43 PetscErrorCode DMDAVecGetArray(DM da, Vec vec, void *array)  in DMDAVecGetArray()  argument
50   PetscAssertPointer(array, 3);  in DMDAVecGetArray()
67     PetscCall(VecGetArray1d(vec, gxm * dof, gxs * dof, (PetscScalar **)array));  in DMDAVecGetArray()
69     PetscCall(VecGetArray2d(vec, gym, gxm * dof, gys, gxs * dof, (PetscScalar ***)array));  in DMDAVecGetArray()
71 …  PetscCall(VecGetArray3d(vec, gzm, gym, gxm * dof, gzs, gys, gxs * dof, (PetscScalar ****)array));  in DMDAVecGetArray()
77   DMDAVecRestoreArray - Restores a multiple dimension array obtained with `DMDAVecGetArray()`
84 - array - the `array` pointer
92 PetscErrorCode DMDAVecRestoreArray(DM da, Vec vec, void *array)  in DMDAVecRestoreArray()  argument
99   PetscAssertPointer(array, 3);  in DMDAVecRestoreArray()
116     PetscCall(VecRestoreArray1d(vec, gxm * dof, gxs * dof, (PetscScalar **)array));  in DMDAVecRestoreArray()
118     PetscCall(VecRestoreArray2d(vec, gym, gxm * dof, gys, gxs * dof, (PetscScalar ***)array));  in DMDAVecRestoreArray()
120 …tscCall(VecRestoreArray3d(vec, gzm, gym, gxm * dof, gzs, gys, gxs * dof, (PetscScalar ****)array));  in DMDAVecRestoreArray()
126   DMDAVecGetArrayWrite - Returns a multiple dimension array that shares data with
136 . array - the array
143   In C, the indexing is "backwards" from what expects: array[k][j][i] NOT array[i][j][k]!
149 …The accessible indices are `array[zs:zs+zm-1][ys:ys+ym-1][xs:xs+xm-1]` where the values are obtain…
153 …Use `DMDAVecGetArrayWrite()` and pass for the array type PetscScalar,pointer :: array(:,...,:) of …
157   The order of the indices is `array(xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` (when dof is 1) otherwise
158   `array(0:dof-1,xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` where the values are obtained from
167 PetscErrorCode DMDAVecGetArrayWrite(DM da, Vec vec, void *array)  in DMDAVecGetArrayWrite()  argument
174   PetscAssertPointer(array, 3);  in DMDAVecGetArrayWrite()
176     PetscCall(VecGetArrayWrite(vec, (PetscScalar **)array));  in DMDAVecGetArrayWrite()
195     PetscCall(VecGetArray1dWrite(vec, gxm * dof, gxs * dof, (PetscScalar **)array));  in DMDAVecGetArrayWrite()
197     PetscCall(VecGetArray2dWrite(vec, gym, gxm * dof, gys, gxs * dof, (PetscScalar ***)array));  in DMDAVecGetArrayWrite()
199 …scCall(VecGetArray3dWrite(vec, gzm, gym, gxm * dof, gzs, gys, gxs * dof, (PetscScalar ****)array));  in DMDAVecGetArrayWrite()
205 …DMDAVecRestoreArrayWrite - Restores a multiple dimension array obtained with `DMDAVecGetArrayWrite…
212 - array - the `array` pointer
219 PetscErrorCode DMDAVecRestoreArrayWrite(DM da, Vec vec, void *array)  in DMDAVecRestoreArrayWrite()  argument
226   PetscAssertPointer(array, 3);  in DMDAVecRestoreArrayWrite()
228     PetscCall(VecRestoreArray(vec, (PetscScalar **)array));  in DMDAVecRestoreArrayWrite()
247     PetscCall(VecRestoreArray1dWrite(vec, gxm * dof, gxs * dof, (PetscScalar **)array));  in DMDAVecRestoreArrayWrite()
249     PetscCall(VecRestoreArray2dWrite(vec, gym, gxm * dof, gys, gxs * dof, (PetscScalar ***)array));  in DMDAVecRestoreArrayWrite()
251 …ll(VecRestoreArray3dWrite(vec, gzm, gym, gxm * dof, gzs, gys, gxs * dof, (PetscScalar ****)array));  in DMDAVecRestoreArrayWrite()
257   DMDAVecGetArrayDOF - Returns a multiple dimension array that shares data with
267 . array - the `array` pointer
274   In C, the indexing is "backwards" from what expects: array[k][j][i][DOF] NOT array[i][j][k][DOF]
276 …The accessible indices are `array[zs:zs+zm-1][ys:ys+ym-1][xs:xs+xm-1][0:ndof-1]` where the values …
280 …Use `DMDAVecGetArray()` and pass for the array type PetscScalar,pointer :: array(:,...,:) of the a…
284   The order of the indices is `array(xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` (when ndof is 1) otherwise
285   `array(0:dof-1,xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` where the values are obtained from
291 PetscErrorCode DMDAVecGetArrayDOF(DM da, Vec vec, void *array)  in DMDAVecGetArrayDOF()  argument
312     PetscCall(VecGetArray2d(vec, gxm, dof, gxs, 0, (PetscScalar ***)array));  in DMDAVecGetArrayDOF()
314     PetscCall(VecGetArray3d(vec, gym, gxm, dof, gys, gxs, 0, (PetscScalar ****)array));  in DMDAVecGetArrayDOF()
316     PetscCall(VecGetArray4d(vec, gzm, gym, gxm, dof, gzs, gys, gxs, 0, (PetscScalar *****)array));  in DMDAVecGetArrayDOF()
322   DMDAVecRestoreArrayDOF - Restores a multiple dimension array obtained with `DMDAVecGetArrayDOF()`
329 - array - the `array` point
336 PetscErrorCode DMDAVecRestoreArrayDOF(DM da, Vec vec, void *array)  in DMDAVecRestoreArrayDOF()  argument
357     PetscCall(VecRestoreArray2d(vec, gxm, dof, gxs, 0, (PetscScalar ***)array));  in DMDAVecRestoreArrayDOF()
359     PetscCall(VecRestoreArray3d(vec, gym, gxm, dof, gys, gxs, 0, (PetscScalar ****)array));  in DMDAVecRestoreArrayDOF()
361 … PetscCall(VecRestoreArray4d(vec, gzm, gym, gxm, dof, gzs, gys, gxs, 0, (PetscScalar *****)array));  in DMDAVecRestoreArrayDOF()
367   DMDAVecGetArrayRead - Returns a multiple dimension array that shares data with
377 . array - the array
384   In C, the indexing is "backwards" from what expects: array[k][j][i] NOT array[i][j][k]!
390 …The accessible indices are `array[zs:zs+zm-1][ys:ys+ym-1][xs:xs+xm-1]` where the values are obtain…
394 …Use `DMDAVecGetArrayRead()` and pass for the array type `PetscScalar`,pointer :: array(:,...,:) of…
398   The order of the indices is `array(xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` (when dof is 1) otherwise
399   `array(0:dof-1,xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` where the values are obtained from
407 PetscErrorCode DMDAVecGetArrayRead(DM da, Vec vec, void *array)  in DMDAVecGetArrayRead()  argument
414   PetscAssertPointer(array, 3);  in DMDAVecGetArrayRead()
431     PetscCall(VecGetArray1dRead(vec, gxm * dof, gxs * dof, (PetscScalar **)array));  in DMDAVecGetArrayRead()
433     PetscCall(VecGetArray2dRead(vec, gym, gxm * dof, gys, gxs * dof, (PetscScalar ***)array));  in DMDAVecGetArrayRead()
435 …tscCall(VecGetArray3dRead(vec, gzm, gym, gxm * dof, gzs, gys, gxs * dof, (PetscScalar ****)array));  in DMDAVecGetArrayRead()
441 …DMDAVecRestoreArrayRead - Restores a multiple dimension array obtained with `DMDAVecGetArrayRead()`
448 - array - the `array` pointer
456 PetscErrorCode DMDAVecRestoreArrayRead(DM da, Vec vec, void *array)  in DMDAVecRestoreArrayRead()  argument
463   PetscAssertPointer(array, 3);  in DMDAVecRestoreArrayRead()
480     PetscCall(VecRestoreArray1dRead(vec, gxm * dof, gxs * dof, (PetscScalar **)array));  in DMDAVecRestoreArrayRead()
482     PetscCall(VecRestoreArray2dRead(vec, gym, gxm * dof, gys, gxs * dof, (PetscScalar ***)array));  in DMDAVecRestoreArrayRead()
484 …all(VecRestoreArray3dRead(vec, gzm, gym, gxm * dof, gzs, gys, gxs * dof, (PetscScalar ****)array));  in DMDAVecRestoreArrayRead()
490   DMDAVecGetArrayDOFRead - Returns a multiple dimension array that shares data with
500 . array - the array
507   In C, the indexing is "backwards" from what expects: array[k][j][i][DOF] NOT array[i][j][k][DOF]!
509 …The accessible indices are `array[zs:zs+zm-1][ys:ys+ym-1][xs:xs+xm-1]` where the values are obtain…
513 …Use  `DMDAVecGetArrayRead()` and pass for the array type PetscScalar,pointer :: array(:,...,:) of …
517   The order of the indices is `array(xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` (when dof is 1) otherwise
518   `array(0:dof-1,xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` where the values are obtained from
524 PetscErrorCode DMDAVecGetArrayDOFRead(DM da, Vec vec, void *array)  in DMDAVecGetArrayDOFRead()  argument
545     PetscCall(VecGetArray2dRead(vec, gxm, dof, gxs, 0, (PetscScalar ***)array));  in DMDAVecGetArrayDOFRead()
547     PetscCall(VecGetArray3dRead(vec, gym, gxm, dof, gys, gxs, 0, (PetscScalar ****)array));  in DMDAVecGetArrayDOFRead()
549 … PetscCall(VecGetArray4dRead(vec, gzm, gym, gxm, dof, gzs, gys, gxs, 0, (PetscScalar *****)array));  in DMDAVecGetArrayDOFRead()
555 …DMDAVecRestoreArrayDOFRead - Restores a multiple dimension array obtained with `DMDAVecGetArrayDOF…
562 - array - the `array` pointer
569 PetscErrorCode DMDAVecRestoreArrayDOFRead(DM da, Vec vec, void *array)  in DMDAVecRestoreArrayDOFRead()  argument
590     PetscCall(VecRestoreArray2dRead(vec, gxm, dof, gxs, 0, (PetscScalar ***)array));  in DMDAVecRestoreArrayDOFRead()
592     PetscCall(VecRestoreArray3dRead(vec, gym, gxm, dof, gys, gxs, 0, (PetscScalar ****)array));  in DMDAVecRestoreArrayDOFRead()
594 …scCall(VecRestoreArray4dRead(vec, gzm, gym, gxm, dof, gzs, gys, gxs, 0, (PetscScalar *****)array));  in DMDAVecRestoreArrayDOFRead()
600   DMDAVecGetArrayDOFWrite - Returns a multiple dimension array that shares data with
610 . array - the array
617   In C, the indexing is "backwards" from what expects: array[k][j][i][DOF] NOT array[i][j][k][DOF]!
619 …The accessible indices are `array[zs:zs+zm-1][ys:ys+ym-1][xs:xs+xm-1][0:dof-1]` where the values a…
623 …Use  `DMDAVecGetArrayWrite()` and pass for the array type PetscScalar,pointer :: array(:,...,:) of…
627   The order of the indices is `array(xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` (when dof is 1) otherwise
628   `array(0:dof-1,xs:xs+xm-1,ys:ys+ym-1,zs:zs+zm-1)` where the values are obtained from
634 PetscErrorCode DMDAVecGetArrayDOFWrite(DM da, Vec vec, void *array)  in DMDAVecGetArrayDOFWrite()  argument
655     PetscCall(VecGetArray2dWrite(vec, gxm, dof, gxs, 0, (PetscScalar ***)array));  in DMDAVecGetArrayDOFWrite()
657     PetscCall(VecGetArray3dWrite(vec, gym, gxm, dof, gys, gxs, 0, (PetscScalar ****)array));  in DMDAVecGetArrayDOFWrite()
659 …PetscCall(VecGetArray4dWrite(vec, gzm, gym, gxm, dof, gzs, gys, gxs, 0, (PetscScalar *****)array));  in DMDAVecGetArrayDOFWrite()
665 …DMDAVecRestoreArrayDOFWrite - Restores a multiple dimension array obtained with `DMDAVecGetArrayDO…
672 - array - the `array` pointer
679 PetscErrorCode DMDAVecRestoreArrayDOFWrite(DM da, Vec vec, void *array)  in DMDAVecRestoreArrayDOFWrite()  argument
700     PetscCall(VecRestoreArray2dWrite(vec, gxm, dof, gxs, 0, (PetscScalar ***)array));  in DMDAVecRestoreArrayDOFWrite()
702     PetscCall(VecRestoreArray3dWrite(vec, gym, gxm, dof, gys, gxs, 0, (PetscScalar ****)array));  in DMDAVecRestoreArrayDOFWrite()
704 …cCall(VecRestoreArray4dWrite(vec, gzm, gym, gxm, dof, gzs, gys, gxs, 0, (PetscScalar *****)array));  in DMDAVecRestoreArrayDOFWrite()