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