DMDAGetCorners#

Returns the global (x,y,z) indices of the lower left corner and size of the local region, excluding ghost points.

Synopsis#

#include "petscdmda.h"   
PetscErrorCode DMDAGetCorners(DM da, PetscInt *x, PetscInt *y, PetscInt *z, PetscInt *m, PetscInt *n, PetscInt *p)

Not Collective

Input Parameter#

  • da - the distributed array

Output Parameters#

  • x - the corner index for the first dimension

  • y - the corner index for the second dimension (only used in 2D and 3D problems)

  • z - the corner index for the third dimension (only used in 3D problems)

  • m - the width in the first dimension

  • n - the width in the second dimension (only used in 2D and 3D problems)

  • p - the width in the third dimension (only used in 3D problems)

Note#

The corner information is independent of the number of degrees of freedom per node set with the DMDACreateXX() routine. Thus the x, y, z, and m, n, p can be thought of as coordinates on a logical grid, where each grid point has (potentially) several degrees of freedom. Any of y, z, n, and p can be passed in as NULL if not needed.

See Also#

DMDA - Creating vectors for structured grids, DM, DMDA, DMDAGetGhostCorners(), DMDAGetOwnershipRanges(), DMStagGetCorners()

Level#

beginner

Location#

src/dm/impls/da/dacorn.c

Examples#

src/ksp/ksp/tutorials/ex28.c
src/dm/tutorials/ex10.c
src/dm/tutorials/swarm_ex3.c
src/dm/tutorials/swarm_ex1.c
src/ksp/ksp/tutorials/ex25.c
src/dm/tutorials/ex22.c
src/dm/tutorials/ex6.c
src/ksp/ksp/tutorials/ex29.c
src/dm/tutorials/ex3.c
src/dm/tutorials/ex15.c

Index of all DMDA routines
Table of Contents for all manual pages
Index of all manual pages