1 #ifndef PETSCDMDA_H 2 #define PETSCDMDA_H 3 4 #include <petscdm.h> 5 #include <petscdmdatypes.h> 6 #include <petscpf.h> 7 #include <petscao.h> 8 #include <petscfe.h> 9 10 /* SUBMANSEC = DMDA */ 11 12 /*MC 13 DMDA_STENCIL_STAR - "Star"-type stencil. In logical grid coordinates, only (i,j,k), (i+s,j,k), (i,j+s,k), 14 (i,j,k+s) are in the stencil NOT, for example, (i+s,j+s,k) 15 16 Level: beginner 17 18 Determines what ghost point values are brought over to each process; in this case the "corner" values are not 19 brought over and hence should not be accessed locally 20 21 .seealso: `DMDA_STENCIL_BOX`, `DMDAStencilType`, `DMDASetStencilType()` 22 M*/ 23 24 /*MC 25 DMDA_STENCIL_BOX - "Box"-type stencil. In logical grid coordinates, any of (i,j,k), (i+s,j+r,k+t) may 26 be in the stencil. 27 28 Level: beginner 29 30 .seealso: `DMDA_STENCIL_STAR`, `DMDAStencilType`, `DMDASetStencilType()` 31 M*/ 32 33 PETSC_EXTERN PetscErrorCode DMDASetInterpolationType(DM, DMDAInterpolationType); 34 PETSC_EXTERN PetscErrorCode DMDAGetInterpolationType(DM, DMDAInterpolationType *); 35 PETSC_EXTERN PetscErrorCode DMDACreateAggregates(DM, DM, Mat *); 36 37 /* FEM */ 38 PETSC_EXTERN PetscErrorCode DMDASetElementType(DM, DMDAElementType); 39 PETSC_EXTERN PetscErrorCode DMDAGetElementType(DM, DMDAElementType *); 40 PETSC_EXTERN PetscErrorCode DMDAGetElements(DM, PetscInt *, PetscInt *, const PetscInt *[]); 41 PETSC_EXTERN PetscErrorCode DMDARestoreElements(DM, PetscInt *, PetscInt *, const PetscInt *[]); 42 PETSC_EXTERN PetscErrorCode DMDAGetElementsSizes(DM, PetscInt *, PetscInt *, PetscInt *); 43 PETSC_EXTERN PetscErrorCode DMDAGetElementsCorners(DM, PetscInt *, PetscInt *, PetscInt *); 44 PETSC_EXTERN PetscErrorCode DMDAGetSubdomainCornersIS(DM, IS *); 45 PETSC_EXTERN PetscErrorCode DMDARestoreSubdomainCornersIS(DM, IS *); 46 47 #define MATSEQUSFFT "sequsfft" 48 49 PETSC_EXTERN PetscErrorCode DMDACreate(MPI_Comm, DM *); 50 PETSC_EXTERN PetscErrorCode DMDASetSizes(DM, PetscInt, PetscInt, PetscInt); 51 PETSC_EXTERN PetscErrorCode DMDACreate1d(MPI_Comm, DMBoundaryType, PetscInt, PetscInt, PetscInt, const PetscInt[], DM *); 52 PETSC_EXTERN PetscErrorCode DMDACreate2d(MPI_Comm, DMBoundaryType, DMBoundaryType, DMDAStencilType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], DM *); 53 PETSC_EXTERN PetscErrorCode DMDACreate3d(MPI_Comm, DMBoundaryType, DMBoundaryType, DMBoundaryType, DMDAStencilType, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscInt[], const PetscInt[], DM *); 54 55 PETSC_EXTERN PetscErrorCode DMDAGlobalToNaturalBegin(DM, Vec, InsertMode, Vec); 56 PETSC_EXTERN PetscErrorCode DMDAGlobalToNaturalEnd(DM, Vec, InsertMode, Vec); 57 PETSC_EXTERN PetscErrorCode DMDANaturalToGlobalBegin(DM, Vec, InsertMode, Vec); 58 PETSC_EXTERN PetscErrorCode DMDANaturalToGlobalEnd(DM, Vec, InsertMode, Vec); 59 PETSC_DEPRECATED_FUNCTION("Use DMLocalToLocalBegin() (since version 3.5)") static inline PetscErrorCode DMDALocalToLocalBegin(DM dm, Vec g, InsertMode mode, Vec l) 60 { 61 return DMLocalToLocalBegin(dm, g, mode, l); 62 } 63 PETSC_DEPRECATED_FUNCTION("Use DMLocalToLocalEnd() (since version 3.5)") static inline PetscErrorCode DMDALocalToLocalEnd(DM dm, Vec g, InsertMode mode, Vec l) 64 { 65 return DMLocalToLocalEnd(dm, g, mode, l); 66 } 67 PETSC_EXTERN PetscErrorCode DMDACreateNaturalVector(DM, Vec *); 68 69 PETSC_EXTERN PetscErrorCode DMDAGetCorners(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 70 PETSC_EXTERN PetscErrorCode DMDAGetGhostCorners(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 71 PETSC_EXTERN PetscErrorCode DMDAGetInfo(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, DMBoundaryType *, DMBoundaryType *, DMBoundaryType *, DMDAStencilType *); 72 PETSC_EXTERN PetscErrorCode DMDAGetProcessorSubset(DM, DMDirection, PetscInt, MPI_Comm *); 73 PETSC_EXTERN PetscErrorCode DMDAGetProcessorSubsets(DM, DMDirection, MPI_Comm *); 74 PETSC_EXTERN PetscErrorCode DMDAGetRay(DM, DMDirection, PetscInt, Vec *, VecScatter *); 75 76 PETSC_EXTERN PetscErrorCode DMDAGlobalToNaturalAllCreate(DM, VecScatter *); 77 PETSC_EXTERN PetscErrorCode DMDANaturalAllToGlobalCreate(DM, VecScatter *); 78 79 PETSC_EXTERN PetscErrorCode DMDAGetScatter(DM, VecScatter *, VecScatter *); 80 PETSC_EXTERN PetscErrorCode DMDAGetNeighbors(DM, const PetscMPIInt **); 81 82 PETSC_EXTERN PetscErrorCode DMDASetAOType(DM, AOType); 83 PETSC_EXTERN PetscErrorCode DMDAGetAO(DM, AO *); 84 PETSC_EXTERN PetscErrorCode DMDASetUniformCoordinates(DM, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal); 85 PETSC_EXTERN PetscErrorCode DMDASetGLLCoordinates(DM, PetscInt, PetscReal *); 86 PETSC_EXTERN PetscErrorCode DMDAGetCoordinateArray(DM, void *); 87 PETSC_EXTERN PetscErrorCode DMDARestoreCoordinateArray(DM, void *); 88 PETSC_EXTERN PetscErrorCode DMDAGetLogicalCoordinate(DM, PetscScalar, PetscScalar, PetscScalar, PetscInt *, PetscInt *, PetscInt *, PetscScalar *, PetscScalar *, PetscScalar *); 89 /* function to wrap coordinates around boundary */ 90 PETSC_EXTERN PetscErrorCode DMDAMapCoordsToPeriodicDomain(DM, PetscScalar *, PetscScalar *); 91 92 PETSC_EXTERN PetscErrorCode DMDACreateCompatibleDMDA(DM, PetscInt, DM *); 93 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use DMDACreateCompatibleDMDA() (since version 3.10)") PetscErrorCode DMDAGetReducedDMDA(DM, PetscInt, DM *); 94 95 PETSC_EXTERN PetscErrorCode DMDASetFieldName(DM, PetscInt, const char[]); 96 PETSC_EXTERN PetscErrorCode DMDAGetFieldName(DM, PetscInt, const char **); 97 PETSC_EXTERN PetscErrorCode DMDASetFieldNames(DM, const char *const *); 98 PETSC_EXTERN PetscErrorCode DMDAGetFieldNames(DM, const char *const **); 99 PETSC_EXTERN PetscErrorCode DMDASetCoordinateName(DM, PetscInt, const char[]); 100 PETSC_EXTERN PetscErrorCode DMDAGetCoordinateName(DM, PetscInt, const char **); 101 102 PETSC_EXTERN PetscErrorCode DMDASetBoundaryType(DM, DMBoundaryType, DMBoundaryType, DMBoundaryType); 103 PETSC_EXTERN PetscErrorCode DMDASetDof(DM, PetscInt); 104 PETSC_EXTERN PetscErrorCode DMDAGetDof(DM, PetscInt *); 105 PETSC_EXTERN PetscErrorCode DMDASetOverlap(DM, PetscInt, PetscInt, PetscInt); 106 PETSC_EXTERN PetscErrorCode DMDAGetOverlap(DM, PetscInt *, PetscInt *, PetscInt *); 107 PETSC_EXTERN PetscErrorCode DMDASetNumLocalSubDomains(DM, PetscInt); 108 PETSC_EXTERN PetscErrorCode DMDAGetNumLocalSubDomains(DM, PetscInt *); 109 PETSC_EXTERN PetscErrorCode DMDAGetOffset(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 110 PETSC_EXTERN PetscErrorCode DMDASetOffset(DM, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt); 111 PETSC_EXTERN PetscErrorCode DMDAGetNonOverlappingRegion(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 112 PETSC_EXTERN PetscErrorCode DMDASetNonOverlappingRegion(DM, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt); 113 PETSC_EXTERN PetscErrorCode DMDASetStencilWidth(DM, PetscInt); 114 PETSC_EXTERN PetscErrorCode DMDAGetStencilWidth(DM, PetscInt *); 115 PETSC_EXTERN PetscErrorCode DMDAMapMatStencilToGlobal(DM, PetscInt, const MatStencil[], PetscInt[]); 116 PETSC_EXTERN PetscErrorCode DMDASetOwnershipRanges(DM, const PetscInt[], const PetscInt[], const PetscInt[]); 117 PETSC_EXTERN PetscErrorCode DMDAGetOwnershipRanges(DM, const PetscInt **, const PetscInt **, const PetscInt **); 118 PETSC_EXTERN PetscErrorCode DMDASetNumProcs(DM, PetscInt, PetscInt, PetscInt); 119 PETSC_EXTERN PetscErrorCode DMDASetStencilType(DM, DMDAStencilType); 120 PETSC_EXTERN PetscErrorCode DMDAGetStencilType(DM, DMDAStencilType *); 121 122 PETSC_EXTERN PetscErrorCode DMDAVecGetArray(DM, Vec, void *); 123 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArray(DM, Vec, void *); 124 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayWrite(DM, Vec, void *); 125 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayWrite(DM, Vec, void *); 126 127 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayDOF(DM, Vec, void *); 128 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayDOF(DM, Vec, void *); 129 130 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayRead(DM, Vec, void *); 131 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayRead(DM, Vec, void *); 132 133 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayDOFRead(DM, Vec, void *); 134 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayDOFRead(DM, Vec, void *); 135 136 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayDOFWrite(DM, Vec, void *); 137 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayDOFWrite(DM, Vec, void *); 138 139 PETSC_EXTERN PetscErrorCode DMDACreatePatchIS(DM, MatStencil *, MatStencil *, IS *, PetscBool); 140 141 /*MC 142 DMDACoor2d - Structure for holding 2d (x and y) coordinates when working with `DMDA` 143 144 Level: intermediate 145 146 Synopsis: 147 .vb 148 DMDACoor2d **coors; 149 Vec vcoors; 150 DM cda; 151 DMGetCoordinates(da,&vcoors); 152 DMGetCoordinateDM(da,&cda); 153 DMDAVecGetArray(cda,vcoors,&coors); 154 DMDAGetCorners(cda,&mstart,&nstart,0,&m,&n,0) 155 for (i=mstart; i<mstart+m; i++) { 156 for (j=nstart; j<nstart+n; j++) { 157 x = coors[j][i].x; 158 y = coors[j][i].y; 159 ...... 160 } 161 } 162 DMDAVecRestoreArray(dac,vcoors,&coors); 163 .ve 164 165 .seealso: `DMDACoor3d`, `DMDAVecRestoreArray()`, `DMDAVecGetArray()`, `DMGetCoordinateDM()`, `DMGetCoordinates()` 166 M*/ 167 typedef struct { 168 PetscScalar x, y; 169 } DMDACoor2d; 170 171 /*MC 172 DMDACoor3d - Structure for holding 3d (x, y and z) coordinates coordinates when working with `DMDA` 173 174 Level: intermediate 175 176 Synopsis: 177 .vb 178 DMDACoor3d ***coors; 179 Vec vcoors; 180 DM cda; 181 DMGetCoordinates(da,&vcoors); 182 DMGetCoordinateDM(da,&cda); 183 DMDAVecGetArray(cda,vcoors,&coors); 184 DMDAGetCorners(cda,&mstart,&nstart,&pstart,&m,&n,&p) 185 for (i=mstart; i<mstart+m; i++) { 186 for (j=nstart; j<nstart+n; j++) { 187 for (k=pstart; k<pstart+p; k++) { 188 x = coors[k][j][i].x; 189 y = coors[k][j][i].y; 190 z = coors[k][j][i].z; 191 ...... 192 } 193 } 194 DMDAVecRestoreArray(dac,vcoors,&coors); 195 .ve 196 197 .seealso: `DMDACoor2d`, `DMDAVecRestoreArray()`, `DMDAVecGetArray()`, `DMGetCoordinateDM()`, `DMGetCoordinates()` 198 M*/ 199 typedef struct { 200 PetscScalar x, y, z; 201 } DMDACoor3d; 202 203 PETSC_EXTERN PetscErrorCode DMDAGetLocalInfo(DM, DMDALocalInfo *); 204 205 PETSC_EXTERN PetscErrorCode MatRegisterDAAD(void); 206 PETSC_EXTERN PetscErrorCode MatCreateDAAD(DM, Mat *); 207 PETSC_EXTERN PetscErrorCode MatCreateSeqUSFFT(Vec, DM, Mat *); 208 209 PETSC_EXTERN PetscErrorCode DMDASetGetMatrix(DM, PetscErrorCode (*)(DM, Mat *)); 210 PETSC_EXTERN PetscErrorCode DMDASetBlockFills(DM, const PetscInt *, const PetscInt *); 211 PETSC_EXTERN PetscErrorCode DMDASetBlockFillsSparse(DM, const PetscInt *, const PetscInt *); 212 PETSC_EXTERN PetscErrorCode DMDASetRefinementFactor(DM, PetscInt, PetscInt, PetscInt); 213 PETSC_EXTERN PetscErrorCode DMDAGetRefinementFactor(DM, PetscInt *, PetscInt *, PetscInt *); 214 215 PETSC_EXTERN PetscErrorCode DMDAGetArray(DM, PetscBool, void *); 216 PETSC_EXTERN PetscErrorCode DMDARestoreArray(DM, PetscBool, void *); 217 218 PETSC_EXTERN PetscErrorCode DMDACreatePF(DM, PF *); 219 220 /* Emulation of DMPlex */ 221 PETSC_EXTERN PetscErrorCode DMDAGetNumCells(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 222 PETSC_EXTERN PetscErrorCode DMDAGetCellPoint(DM, PetscInt, PetscInt, PetscInt, PetscInt *); 223 PETSC_EXTERN PetscErrorCode DMDAGetNumVertices(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 224 PETSC_EXTERN PetscErrorCode DMDAGetNumFaces(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 225 PETSC_EXTERN PetscErrorCode DMDAGetHeightStratum(DM, PetscInt, PetscInt *, PetscInt *); 226 PETSC_EXTERN PetscErrorCode DMDAGetDepthStratum(DM, PetscInt, PetscInt *, PetscInt *); 227 PETSC_EXTERN PetscErrorCode DMDAComputeCellGeometryFEM(DM, PetscInt, PetscQuadrature, PetscReal[], PetscReal[], PetscReal[], PetscReal[]); 228 PETSC_EXTERN PetscErrorCode DMDAGetTransitiveClosure(DM, PetscInt, PetscBool, PetscInt *, PetscInt **); 229 PETSC_EXTERN PetscErrorCode DMDARestoreTransitiveClosure(DM, PetscInt, PetscBool, PetscInt *, PetscInt **); 230 PETSC_EXTERN PetscErrorCode DMDAConvertToCell(DM, MatStencil, PetscInt *); 231 PETSC_EXTERN PetscErrorCode DMDASetVertexCoordinates(DM, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal, PetscReal); 232 PETSC_EXTERN PetscErrorCode DMDASetPreallocationCenterDimension(DM, PetscInt); 233 PETSC_EXTERN PetscErrorCode DMDAGetPreallocationCenterDimension(DM, PetscInt *); 234 235 #endif 236