petsc-3.13.6 2020-09-29
Report Typos and Errors

DMDAVecGetArrayDOFRead

Returns a multiple dimension array that shares data with the underlying vector and is indexed using the global dimensions.

Synopsis

#include "petscdmda.h"   
PetscErrorCode  DMDAVecGetArrayDOFRead(DM da,Vec vec,void *array)
Not Collective

Input Parameter

da - the distributed array
vec - the vector, either a vector the same size as one obtained with DMCreateGlobalVector() or DMCreateLocalVector()

Output Parameter

array -the array

Notes

Call DMDAVecRestoreArrayDOFRead() once you have finished accessing the vector entries.

In C, the indexing is "backwards" from what expects: array[k][j][i][DOF] NOT array[i][j][k][DOF]!

In Fortran 90 you do not need a version of DMDAVecRestoreArrayDOF() just use DMDAVecRestoreArrayReadF90() and declare your array with one higher dimension, see src/dm/tutorials/ex11f90.F

See Also

DMDAGetGhostCorners(), DMDAGetCorners(), VecGetArray(), VecRestoreArray(), DMDAVecRestoreArray(), DMDAVecGetArray(), DMDAVecGetArrayDOF(),
DMDAVecGetArrayWrite(), DMDAVecRestoreArrayWrite(), DMDAVecGetArrayRead(), DMDAVecRestoreArrayRead(), DMStagVecGetArrayDOFRead()

Level

intermediate

Location

src/dm/impls/da/dagetarray.c
Index of all DMDA routines
Table of Contents for all manual pages
Index of all manual pages