xref: /petsc/include/petscdmdatypes.h (revision 6d8694c4fbab79f9439f1ad13c0386ba7ee1ca4b)
1a4963045SJacob Faibussowitsch #pragma once
21e25c274SJed Brown 
31e25c274SJed Brown #include <petscdmtypes.h>
41e25c274SJed Brown 
5*ce78bad3SBarry Smith /* MANSEC = DM */
6ac09b921SBarry Smith /* SUBMANSEC = DMDA */
7ac09b921SBarry Smith 
81e25c274SJed Brown /*E
91e25c274SJed Brown     DMDAStencilType - Determines if the stencil extends only along the coordinate directions, or also
101e25c274SJed Brown                       to the northeast, northwest etc
111e25c274SJed Brown 
121e25c274SJed Brown    Level: beginner
131e25c274SJed Brown 
14af27ebaaSBarry Smith .seealso: [](ch_dmbase), `DMDA`, `DMDA_STENCIL_BOX`, `DMDA_STENCIL_STAR`,`DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMDACreate()`, `DMDASetStencilType()`
151e25c274SJed Brown E*/
169371c9d4SSatish Balay typedef enum {
179371c9d4SSatish Balay   DMDA_STENCIL_STAR,
189371c9d4SSatish Balay   DMDA_STENCIL_BOX
199371c9d4SSatish Balay } DMDAStencilType;
201e25c274SJed Brown 
211e25c274SJed Brown /*E
221e25c274SJed Brown     DMDAInterpolationType - Defines the type of interpolation that will be returned by
2387497f52SBarry Smith                             `DMCreateInterpolation()`.
241e25c274SJed Brown 
251e25c274SJed Brown    Level: beginner
261e25c274SJed Brown 
27af27ebaaSBarry Smith .seealso: [](ch_dmbase), `DMDA`, `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMCreateInterpolation()`, `DMDASetInterpolationType()`, `DMDACreate()`
281e25c274SJed Brown E*/
299371c9d4SSatish Balay typedef enum {
309371c9d4SSatish Balay   DMDA_Q0,
319371c9d4SSatish Balay   DMDA_Q1
329371c9d4SSatish Balay } DMDAInterpolationType;
331e25c274SJed Brown 
341e25c274SJed Brown /*E
351e25c274SJed Brown    DMDAElementType - Defines the type of elements that will be returned by
3687497f52SBarry Smith                      `DMDAGetElements()`
371e25c274SJed Brown 
381e25c274SJed Brown    Level: beginner
391e25c274SJed Brown 
40af27ebaaSBarry Smith .seealso: [](ch_dmbase), `DMDA`, `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMCreateInterpolation()`, `DMDASetInterpolationType()`,
41db781477SPatrick Sanan           `DMDASetElementType()`, `DMDAGetElements()`, `DMDARestoreElements()`, `DMDACreate()`
421e25c274SJed Brown E*/
439371c9d4SSatish Balay typedef enum {
449371c9d4SSatish Balay   DMDA_ELEMENT_P1,
459371c9d4SSatish Balay   DMDA_ELEMENT_Q1
469371c9d4SSatish Balay } DMDAElementType;
471e25c274SJed Brown 
481e25c274SJed Brown /*S
49*ce78bad3SBarry Smith   DMDALocalInfo - C struct that contains information about a structured grid and a processes logical location in it.
501e25c274SJed Brown 
511e25c274SJed Brown   Level: beginner
521e25c274SJed Brown 
5316a05f60SBarry Smith   Fortran Note:
54*ce78bad3SBarry Smith   This is a derived type whose entries can be directly accessed
551e25c274SJed Brown 
56af27ebaaSBarry Smith .seealso: [](ch_dmbase), `DMDA`, `DMDACreate1d()`, `DMDACreate2d()`, `DMDACreate3d()`, `DMDestroy()`, `DM`, `DMDAGetLocalInfo()`, `DMDAGetInfo()`
571e25c274SJed Brown S*/
581e25c274SJed Brown typedef struct {
59*ce78bad3SBarry Smith   DM              da;
601e25c274SJed Brown   PetscInt        dim, dof, sw;
611e25c274SJed Brown   PetscInt        mx, my, mz;    /* global number of grid points in each direction */
621e25c274SJed Brown   PetscInt        xs, ys, zs;    /* starting point of this processor, excluding ghosts */
631e25c274SJed Brown   PetscInt        xm, ym, zm;    /* number of grid points on this processor, excluding ghosts */
641e25c274SJed Brown   PetscInt        gxs, gys, gzs; /* starting point of this processor including ghosts */
651e25c274SJed Brown   PetscInt        gxm, gym, gzm; /* number of grid points on this processor including ghosts */
66bff4a2f0SMatthew G. Knepley   DMBoundaryType  bx, by, bz;    /* type of ghost nodes at boundary */
671e25c274SJed Brown   DMDAStencilType st;
681e25c274SJed Brown } DMDALocalInfo;
69