DMStagGetProductCoordinateArrays#
extract local product coordinate arrays, one per dimension
Synopsis#
#include "petscdmstag.h"
#include "petscdmproduct.h"
PetscErrorCode DMStagGetProductCoordinateArrays(DM dm, void *arrX, void *arrY, void *arrZ)
Logically Collective
Input Parameter#
dm - the
DMSTAGobject
Output Parameters#
arrX - local 1D coordinate arrays for x direction
arrY - local 1D coordinate arrays for y direction, not set for one dimensional problems
arrZ - local 1D coordinate arrays for z direction, not set for one and two dimensional problems
Notes#
A high-level helper function to quickly extract local coordinate arrays.
Note that 2-dimensional arrays are returned. See
DMStagVecGetArray(), which is called internally to produce these arrays
representing coordinates on elements and vertices (element boundaries)
for a 1-dimensional DMSTAG in each coordinate direction.
One should use DMStagGetProductCoordinateLocationSlot() to determine appropriate
indices for the second dimension in these returned arrays. This function
checks that the coordinate array is a suitable product of 1-dimensional
DMSTAG objects.
See Also#
DMSTAG: Staggered, Structured Grid, DMSTAG, DMPRODUCT, DMStagGetProductCoordinateArraysRead(), DMStagSetUniformCoordinates(), DMStagSetUniformCoordinatesProduct(), DMStagGetProductCoordinateLocationSlot()
Level#
intermediate
Location#
Examples#
src/dm/impls/stag/tutorials/ex6.c
Index of all DMStag routines
Table of Contents for all manual pages
Index of all manual pages