xref: /petsc/include/petscdmdatypes.h (revision db7814771ca77b190574494e87b584e981451db0)
126bd1501SBarry Smith #if !defined(PETSCDMDATYPES_H)
226bd1501SBarry Smith #define PETSCDMDATYPES_H
31e25c274SJed Brown 
41e25c274SJed Brown #include <petscdmtypes.h>
51e25c274SJed Brown 
61e25c274SJed Brown /*E
71e25c274SJed Brown     DMDAStencilType - Determines if the stencil extends only along the coordinate directions, or also
81e25c274SJed Brown       to the northeast, northwest etc
91e25c274SJed Brown 
101e25c274SJed Brown    Level: beginner
111e25c274SJed Brown 
12*db781477SPatrick Sanan .seealso: `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMDACreate()`, `DMDASetStencilType()`
131e25c274SJed Brown E*/
141e25c274SJed Brown typedef enum { DMDA_STENCIL_STAR,DMDA_STENCIL_BOX } DMDAStencilType;
151e25c274SJed Brown 
161e25c274SJed Brown /*E
171e25c274SJed Brown     DMDAInterpolationType - Defines the type of interpolation that will be returned by
181e25c274SJed Brown        DMCreateInterpolation.
191e25c274SJed Brown 
201e25c274SJed Brown    Level: beginner
211e25c274SJed Brown 
22*db781477SPatrick Sanan .seealso: `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMCreateInterpolation()`, `DMDASetInterpolationType()`, `DMDACreate()`
231e25c274SJed Brown E*/
241e25c274SJed Brown typedef enum { DMDA_Q0, DMDA_Q1 } DMDAInterpolationType;
251e25c274SJed Brown 
261e25c274SJed Brown /*E
271e25c274SJed Brown     DMDAElementType - Defines the type of elements that will be returned by
281e25c274SJed Brown        DMDAGetElements()
291e25c274SJed Brown 
301e25c274SJed Brown    Level: beginner
311e25c274SJed Brown 
32*db781477SPatrick Sanan .seealso: `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMCreateInterpolation()`, `DMDASetInterpolationType()`,
33*db781477SPatrick Sanan           `DMDASetElementType()`, `DMDAGetElements()`, `DMDARestoreElements()`, `DMDACreate()`
341e25c274SJed Brown E*/
351e25c274SJed Brown typedef enum { DMDA_ELEMENT_P1, DMDA_ELEMENT_Q1 } DMDAElementType;
361e25c274SJed Brown 
371e25c274SJed Brown /*S
381e25c274SJed Brown      DMDALocalInfo - C struct that contains information about a structured grid and a processors logical
391e25c274SJed Brown               location in it.
401e25c274SJed Brown 
411e25c274SJed Brown    Level: beginner
421e25c274SJed Brown 
43d3187782SBarry Smith   Fortran Notes - This should be declared as
44d3187782SBarry Smith $    DMDALocalInfo :: info(DMDA_LOCAL_INFO_SIZE)
45d3187782SBarry Smith      and the entries accessed via
4657a8e1ddSBarry Smith $    info(DMDA_LOCAL_INFO_DIM)
4757a8e1ddSBarry Smith $    info(DMDA_LOCAL_INFO_DOF) etc.
48d3187782SBarry Smith    The entries bx,by,bz, st, and da are not accessible from Fortran.
491e25c274SJed Brown 
50*db781477SPatrick Sanan .seealso: `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMDestroy()`, `DM`, `DMDAGetLocalInfo()`, `DMDAGetInfo()`
511e25c274SJed Brown S*/
521e25c274SJed Brown typedef struct {
531e25c274SJed Brown   PetscInt         dim,dof,sw;
541e25c274SJed Brown   PetscInt         mx,my,mz;    /* global number of grid points in each direction */
551e25c274SJed Brown   PetscInt         xs,ys,zs;    /* starting point of this processor, excluding ghosts */
561e25c274SJed Brown   PetscInt         xm,ym,zm;    /* number of grid points on this processor, excluding ghosts */
571e25c274SJed Brown   PetscInt         gxs,gys,gzs;    /* starting point of this processor including ghosts */
581e25c274SJed Brown   PetscInt         gxm,gym,gzm;    /* number of grid points on this processor including ghosts */
59bff4a2f0SMatthew G. Knepley   DMBoundaryType   bx,by,bz; /* type of ghost nodes at boundary */
601e25c274SJed Brown   DMDAStencilType  st;
611e25c274SJed Brown   DM               da;
621e25c274SJed Brown } DMDALocalInfo;
631e25c274SJed Brown 
641e25c274SJed Brown #endif
65