1 #pragma once
2
3 #include <petscdm.h>
4 #include <petscdmproduct.h>
5
6 /* MANSEC = DM */
7 /* SUBMANSEC = DMStag */
8
9 /*E
10 DMStagStencilLocation - enumerated type denoting a location relative to an element in a `DMSTAG` grid
11
12 The interpretation of these values is dimension-dependent.
13
14 Level: beginner
15
16 Developer Note:
17 The order of the enum entries is significant, as it corresponds to the canonical numbering
18 of DOFs, and the fact that the numbering starts at 0 may also be used by the implementation.
19
20 .seealso: [](ch_stag), `DMSTAG`, `DMDA`, `DMStagStencil`, `DMStagGetLocationSlot()`, `DMStagStencilType`
21 E*/
22 typedef enum {
23 DMSTAG_NULL_LOCATION,
24 DMSTAG_BACK_DOWN_LEFT,
25 DMSTAG_BACK_DOWN,
26 DMSTAG_BACK_DOWN_RIGHT,
27 DMSTAG_BACK_LEFT,
28 DMSTAG_BACK,
29 DMSTAG_BACK_RIGHT,
30 DMSTAG_BACK_UP_LEFT,
31 DMSTAG_BACK_UP,
32 DMSTAG_BACK_UP_RIGHT,
33 DMSTAG_DOWN_LEFT,
34 DMSTAG_DOWN,
35 DMSTAG_DOWN_RIGHT,
36 DMSTAG_LEFT,
37 DMSTAG_ELEMENT,
38 DMSTAG_RIGHT,
39 DMSTAG_UP_LEFT,
40 DMSTAG_UP,
41 DMSTAG_UP_RIGHT,
42 DMSTAG_FRONT_DOWN_LEFT,
43 DMSTAG_FRONT_DOWN,
44 DMSTAG_FRONT_DOWN_RIGHT,
45 DMSTAG_FRONT_LEFT,
46 DMSTAG_FRONT,
47 DMSTAG_FRONT_RIGHT,
48 DMSTAG_FRONT_UP_LEFT,
49 DMSTAG_FRONT_UP,
50 DMSTAG_FRONT_UP_RIGHT
51 } DMStagStencilLocation;
52 PETSC_EXTERN const char *const DMStagStencilLocations[]; /* Corresponding strings (see stagstencil.c) */
53
54 /*S
55 DMStagStencil - data structure representing a degree of freedom on a `DMSTAG` grid
56
57 Data structure (C struct), analogous to describing a degree of freedom associated with a `DMSTAG` object,
58 in terms of a global element index in each of up to three directions, a "location" as defined by `DMStagStencilLocation`,
59 and a component number. Primarily for use with `DMStagMatSetValuesStencil()` (compare with use of `MatStencil` with `MatSetValuesStencil()`).
60
61 Level: beginner
62
63 Notes:
64 The component (c) field must always be set, even if there is a single component at a given location (in which case c should be set to 0).
65
66 This is a struct, not a `PetscObject`.
67
68 .seealso: [](ch_stag), `DMSTAG`, `DMDA`, `DMStagMatSetValuesStencil()`, `DMStagVecSetValuesStencil()`, `DMStagStencilLocation`, `DMStagSetStencilWidth()`,
69 `DMStagSetStencilType()`, `DMStagVecGetValuesStencil()`, `DMStagStencilLocation`
70 S*/
71 typedef struct {
72 DMStagStencilLocation loc;
73 PetscInt i, j, k, c;
74 } DMStagStencil;
75
76 /*E
77 DMStagStencilType - Elementwise stencil type, determining which neighbors participate in communication
78
79 Level: beginner
80
81 .seealso: [](ch_stag), `DMSTAG`, `DMDA`, `DMStagCreate1d()`, `DMStagCreate2d()`, `DMStagCreate3d()`, `DMStagStencil`, `DMDAStencilType`, `DMStagStencilLocation`,
82 `DMDAStencilType`
83 E*/
84
85 typedef enum {
86 DMSTAG_STENCIL_NONE,
87 DMSTAG_STENCIL_STAR,
88 DMSTAG_STENCIL_BOX
89 } DMStagStencilType;
90 PETSC_EXTERN const char *const DMStagStencilTypes[]; /* Corresponding strings (see stagstencil.c) */
91
92 PETSC_EXTERN PetscErrorCode DMCreate_Stag(DM);
93 PETSC_EXTERN PetscErrorCode DMStagCreate1d(MPI_Comm, DMBoundaryType, PetscInt, PetscInt, PetscInt, DMStagStencilType, PetscInt, const PetscInt[], DM *);
94 PETSC_EXTERN PetscErrorCode DMStagCreate2d(MPI_Comm, DMBoundaryType, DMBoundaryType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, DMStagStencilType, PetscInt, const PetscInt[], const PetscInt[], DM *);
95 PETSC_EXTERN PetscErrorCode DMStagCreate3d(MPI_Comm, DMBoundaryType, DMBoundaryType, DMBoundaryType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, DMStagStencilType, PetscInt, const PetscInt[], const PetscInt[], const PetscInt[], DM *);
96 PETSC_EXTERN PetscErrorCode DMStagCreateCompatibleDMStag(DM, PetscInt, PetscInt, PetscInt, PetscInt, DM *);
97 PETSC_EXTERN PetscErrorCode DMStagCreateISFromStencils(DM, PetscInt, DMStagStencil *, IS *);
98 PETSC_EXTERN PetscErrorCode DMStagGetBoundaryTypes(DM, DMBoundaryType *, DMBoundaryType *, DMBoundaryType *);
99 PETSC_EXTERN PetscErrorCode DMStagGetCorners(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
100 PETSC_EXTERN PetscErrorCode DMStagGetDOF(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
101 PETSC_EXTERN PetscErrorCode DMStagGetEntries(DM, PetscInt *);
102 PETSC_EXTERN PetscErrorCode DMStagGetEntriesLocal(DM, PetscInt *);
103 PETSC_EXTERN PetscErrorCode DMStagGetEntriesPerElement(DM, PetscInt *);
104 PETSC_EXTERN PetscErrorCode DMStagGetGhostCorners(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *);
105 PETSC_EXTERN PetscErrorCode DMStagGetGlobalSizes(DM, PetscInt *, PetscInt *, PetscInt *);
106 PETSC_EXTERN PetscErrorCode DMStagGetIsFirstRank(DM, PetscBool *, PetscBool *, PetscBool *);
107 PETSC_EXTERN PetscErrorCode DMStagGetIsLastRank(DM, PetscBool *, PetscBool *, PetscBool *);
108 PETSC_EXTERN PetscErrorCode DMStagGetLocalSizes(DM, PetscInt *, PetscInt *, PetscInt *);
109 PETSC_EXTERN PetscErrorCode DMStagGetLocationDOF(DM, DMStagStencilLocation, PetscInt *);
110 PETSC_EXTERN PetscErrorCode DMStagGetLocationSlot(DM, DMStagStencilLocation, PetscInt, PetscInt *);
111 PETSC_EXTERN PetscErrorCode DMStagGetNumRanks(DM, PetscInt *, PetscInt *, PetscInt *);
112 PETSC_EXTERN PetscErrorCode DMStagGetOwnershipRanges(DM, const PetscInt **, const PetscInt **, const PetscInt **);
113 PETSC_EXTERN PetscErrorCode DMStagGetProductCoordinateArrays(DM, void *, void *, void *);
114 PETSC_EXTERN PetscErrorCode DMStagGetProductCoordinateArraysRead(DM, void *, void *, void *);
115 PETSC_EXTERN PetscErrorCode DMStagGetProductCoordinateLocationSlot(DM, DMStagStencilLocation, PetscInt *);
116 PETSC_EXTERN PetscErrorCode DMStagGetStencilType(DM, DMStagStencilType *);
117 PETSC_EXTERN PetscErrorCode DMStagGetStencilWidth(DM, PetscInt *);
118 PETSC_EXTERN PetscErrorCode DMStagGetRefinementFactor(DM, PetscInt *, PetscInt *, PetscInt *);
119 PETSC_EXTERN PetscErrorCode DMStagMatGetValuesStencil(DM, Mat, PetscInt, const DMStagStencil *, PetscInt, const DMStagStencil *, PetscScalar *);
120 PETSC_EXTERN PetscErrorCode DMStagMatSetValuesStencil(DM, Mat, PetscInt, const DMStagStencil *, PetscInt, const DMStagStencil *, const PetscScalar *, InsertMode);
121 PETSC_EXTERN PetscErrorCode DMStagMigrateVec(DM, Vec, DM, Vec);
122 PETSC_EXTERN PetscErrorCode DMStagPopulateLocalToGlobalInjective(DM);
123 PETSC_EXTERN PetscErrorCode DMStagRestoreProductCoordinateArrays(DM, void *, void *, void *);
124 PETSC_EXTERN PetscErrorCode DMStagRestoreProductCoordinateArraysRead(DM, void *, void *, void *);
125 PETSC_EXTERN PetscErrorCode DMStagRestrictSimple(DM, Vec, DM, Vec);
126 PETSC_EXTERN PetscErrorCode DMStagSetBoundaryTypes(DM, DMBoundaryType, DMBoundaryType, DMBoundaryType);
127 PETSC_EXTERN PetscErrorCode DMStagSetCoordinateDMType(DM, DMType);
128 PETSC_EXTERN PetscErrorCode DMStagSetDOF(DM, PetscInt, PetscInt, PetscInt, PetscInt);
129 PETSC_EXTERN PetscErrorCode DMStagSetGlobalSizes(DM, PetscInt, PetscInt, PetscInt);
130 PETSC_EXTERN PetscErrorCode DMStagSetNumRanks(DM, PetscInt, PetscInt, PetscInt);
131 PETSC_EXTERN PetscErrorCode DMStagSetOwnershipRanges(DM, PetscInt const *, PetscInt const *, PetscInt const *);
132 PETSC_EXTERN PetscErrorCode DMStagSetStencilType(DM, DMStagStencilType);
133 PETSC_EXTERN PetscErrorCode DMStagSetStencilWidth(DM, PetscInt);
134 PETSC_EXTERN PetscErrorCode DMStagSetRefinementFactor(DM, PetscInt, PetscInt, PetscInt);
135 PETSC_EXTERN PetscErrorCode DMStagSetUniformCoordinates(DM, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal);
136 PETSC_EXTERN PetscErrorCode DMStagSetUniformCoordinatesExplicit(DM, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal);
137 PETSC_EXTERN PetscErrorCode DMStagSetUniformCoordinatesProduct(DM, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal);
138 PETSC_EXTERN PetscErrorCode DMStagStencilToIndexLocal(DM, PetscInt, PetscInt, const DMStagStencil *, PetscInt *);
139 PETSC_EXTERN PetscErrorCode DMStagVecGetArray(DM, Vec, void *);
140 PETSC_EXTERN PetscErrorCode DMStagVecGetArrayRead(DM, Vec, void *);
141 PETSC_EXTERN PetscErrorCode DMStagVecGetValuesStencil(DM, Vec, PetscInt, const DMStagStencil *, PetscScalar *);
142 PETSC_EXTERN PetscErrorCode DMStagVecRestoreArray(DM, Vec, void *);
143 PETSC_EXTERN PetscErrorCode DMStagVecRestoreArrayRead(DM, Vec, void *);
144 PETSC_EXTERN PetscErrorCode DMStagVecSetValuesStencil(DM, Vec, PetscInt, const DMStagStencil *, const PetscScalar *, InsertMode);
145 PETSC_EXTERN PetscErrorCode DMStagVecSplitToDMDA(DM, Vec, DMStagStencilLocation, PetscInt, DM *, Vec *);
146
DMStagGet1dCoordinateArraysDOFRead(DM dm,void * ax,void * ay,void * az)147 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagGetProductCoordinateArraysRead()", ) static inline PetscErrorCode DMStagGet1dCoordinateArraysDOFRead(DM dm, void *ax, void *ay, void *az)
148 {
149 return DMStagGetProductCoordinateArraysRead(dm, ax, ay, az);
150 }
DMStagGet1dCoordinateLocationSlot(DM dm,DMStagStencilLocation loc,PetscInt * s)151 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagGetProductCoordinateLocationSlot()", ) static inline PetscErrorCode DMStagGet1dCoordinateLocationSlot(DM dm, DMStagStencilLocation loc, PetscInt *s)
152 {
153 return DMStagGetProductCoordinateLocationSlot(dm, loc, s);
154 }
DMStagGetGhostType(DM dm,DMStagStencilType * s)155 PETSC_DEPRECATED_FUNCTION(3, 11, 0, "DMStagGetStencilType()", ) static inline PetscErrorCode DMStagGetGhostType(DM dm, DMStagStencilType *s)
156 {
157 return DMStagGetStencilType(dm, s);
158 }
DMStagRestore1dCoordinateArraysDOFRead(DM dm,void * ax,void * ay,void * az)159 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagRestoreProductCoordinateArraysRead()", ) static inline PetscErrorCode DMStagRestore1dCoordinateArraysDOFRead(DM dm, void *ax, void *ay, void *az)
160 {
161 return DMStagRestoreProductCoordinateArraysRead(dm, ax, ay, az);
162 }
DMStagSetGhostType(DM dm,DMStagStencilType * s)163 PETSC_DEPRECATED_FUNCTION(3, 11, 0, "DMStagSetStencilType()", ) static inline PetscErrorCode DMStagSetGhostType(DM dm, DMStagStencilType *s)
164 {
165 return DMStagGetStencilType(dm, s);
166 }
DMStagVecGetArrayDOF(DM dm,Vec v,void * a)167 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagVecGetArray()", ) static inline PetscErrorCode DMStagVecGetArrayDOF(DM dm, Vec v, void *a)
168 {
169 return DMStagVecGetArray(dm, v, a);
170 }
DMStagVecGetArrayDOFRead(DM dm,Vec v,void * a)171 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagVecGetArrayRead()", ) static inline PetscErrorCode DMStagVecGetArrayDOFRead(DM dm, Vec v, void *a)
172 {
173 return DMStagVecGetArrayRead(dm, v, a);
174 }
DMStagVecRestoreArrayDOF(DM dm,Vec v,void * a)175 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagVecRestoreArray()", ) static inline PetscErrorCode DMStagVecRestoreArrayDOF(DM dm, Vec v, void *a)
176 {
177 return DMStagVecRestoreArray(dm, v, a);
178 }
DMStagVecRestoreArrayDOFRead(DM dm,Vec v,void * a)179 PETSC_DEPRECATED_FUNCTION(3, 13, 0, "DMStagVecRestoreArrayRead()", ) static inline PetscErrorCode DMStagVecRestoreArrayDOFRead(DM dm, Vec v, void *a)
180 {
181 return DMStagVecRestoreArrayRead(dm, v, a);
182 }
183