1 #if !defined(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) {return DMLocalToLocalBegin(dm,g,mode,l);} 60 PETSC_DEPRECATED_FUNCTION("Use DMLocalToLocalEnd() (since version 3.5)") static inline PetscErrorCode DMDALocalToLocalEnd(DM dm,Vec g,InsertMode mode,Vec l) {return DMLocalToLocalEnd(dm,g,mode,l);} 61 PETSC_EXTERN PetscErrorCode DMDACreateNaturalVector(DM,Vec *); 62 63 PETSC_EXTERN PetscErrorCode DMDAGetCorners(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 64 PETSC_EXTERN PetscErrorCode DMDAGetGhostCorners(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 65 PETSC_EXTERN PetscErrorCode DMDAGetInfo(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,DMBoundaryType*,DMBoundaryType*,DMBoundaryType*,DMDAStencilType*); 66 PETSC_EXTERN PetscErrorCode DMDAGetProcessorSubset(DM,DMDirection,PetscInt,MPI_Comm*); 67 PETSC_EXTERN PetscErrorCode DMDAGetProcessorSubsets(DM,DMDirection,MPI_Comm*); 68 PETSC_EXTERN PetscErrorCode DMDAGetRay(DM,DMDirection,PetscInt,Vec*,VecScatter*); 69 70 PETSC_EXTERN PetscErrorCode DMDAGlobalToNaturalAllCreate(DM,VecScatter*); 71 PETSC_EXTERN PetscErrorCode DMDANaturalAllToGlobalCreate(DM,VecScatter*); 72 73 PETSC_EXTERN PetscErrorCode DMDAGetScatter(DM,VecScatter*,VecScatter*); 74 PETSC_EXTERN PetscErrorCode DMDAGetNeighbors(DM,const PetscMPIInt**); 75 76 PETSC_EXTERN PetscErrorCode DMDASetAOType(DM,AOType); 77 PETSC_EXTERN PetscErrorCode DMDAGetAO(DM,AO*); 78 PETSC_EXTERN PetscErrorCode DMDASetUniformCoordinates(DM,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 79 PETSC_EXTERN PetscErrorCode DMDASetGLLCoordinates(DM,PetscInt,PetscReal*); 80 PETSC_EXTERN PetscErrorCode DMDAGetCoordinateArray(DM,void*); 81 PETSC_EXTERN PetscErrorCode DMDARestoreCoordinateArray(DM,void*); 82 PETSC_EXTERN PetscErrorCode DMDAGetLogicalCoordinate(DM,PetscScalar,PetscScalar,PetscScalar,PetscInt*,PetscInt*,PetscInt*,PetscScalar*,PetscScalar*,PetscScalar*); 83 /* function to wrap coordinates around boundary */ 84 PETSC_EXTERN PetscErrorCode DMDAMapCoordsToPeriodicDomain(DM,PetscScalar*,PetscScalar*); 85 86 PETSC_EXTERN PetscErrorCode DMDACreateCompatibleDMDA(DM,PetscInt,DM*); 87 PETSC_EXTERN PETSC_DEPRECATED_FUNCTION("Use DMDACreateCompatibleDMDA() (since version 3.10)") PetscErrorCode DMDAGetReducedDMDA(DM,PetscInt,DM*); 88 89 PETSC_EXTERN PetscErrorCode DMDASetFieldName(DM,PetscInt,const char[]); 90 PETSC_EXTERN PetscErrorCode DMDAGetFieldName(DM,PetscInt,const char**); 91 PETSC_EXTERN PetscErrorCode DMDASetFieldNames(DM,const char * const *); 92 PETSC_EXTERN PetscErrorCode DMDAGetFieldNames(DM,const char * const **); 93 PETSC_EXTERN PetscErrorCode DMDASetCoordinateName(DM,PetscInt,const char[]); 94 PETSC_EXTERN PetscErrorCode DMDAGetCoordinateName(DM,PetscInt,const char**); 95 96 PETSC_EXTERN PetscErrorCode DMDASetBoundaryType(DM,DMBoundaryType,DMBoundaryType,DMBoundaryType); 97 PETSC_EXTERN PetscErrorCode DMDASetDof(DM, PetscInt); 98 PETSC_EXTERN PetscErrorCode DMDAGetDof(DM, PetscInt*); 99 PETSC_EXTERN PetscErrorCode DMDASetOverlap(DM,PetscInt,PetscInt,PetscInt); 100 PETSC_EXTERN PetscErrorCode DMDAGetOverlap(DM,PetscInt*,PetscInt*,PetscInt*); 101 PETSC_EXTERN PetscErrorCode DMDASetNumLocalSubDomains(DM,PetscInt); 102 PETSC_EXTERN PetscErrorCode DMDAGetNumLocalSubDomains(DM,PetscInt*); 103 PETSC_EXTERN PetscErrorCode DMDAGetOffset(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 104 PETSC_EXTERN PetscErrorCode DMDASetOffset(DM,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt); 105 PETSC_EXTERN PetscErrorCode DMDAGetNonOverlappingRegion(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 106 PETSC_EXTERN PetscErrorCode DMDASetNonOverlappingRegion(DM,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt); 107 PETSC_EXTERN PetscErrorCode DMDASetStencilWidth(DM, PetscInt); 108 PETSC_EXTERN PetscErrorCode DMDAGetStencilWidth(DM, PetscInt*); 109 PETSC_EXTERN PetscErrorCode DMDAMapMatStencilToGlobal(DM,PetscInt,const MatStencil[],PetscInt[]); 110 PETSC_EXTERN PetscErrorCode DMDASetOwnershipRanges(DM,const PetscInt[],const PetscInt[],const PetscInt[]); 111 PETSC_EXTERN PetscErrorCode DMDAGetOwnershipRanges(DM,const PetscInt**,const PetscInt**,const PetscInt**); 112 PETSC_EXTERN PetscErrorCode DMDASetNumProcs(DM, PetscInt, PetscInt, PetscInt); 113 PETSC_EXTERN PetscErrorCode DMDASetStencilType(DM, DMDAStencilType); 114 PETSC_EXTERN PetscErrorCode DMDAGetStencilType(DM, DMDAStencilType*); 115 116 PETSC_EXTERN PetscErrorCode DMDAVecGetArray(DM,Vec,void *); 117 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArray(DM,Vec,void *); 118 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayWrite(DM,Vec,void *); 119 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayWrite(DM,Vec,void *); 120 121 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayDOF(DM,Vec,void *); 122 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayDOF(DM,Vec,void *); 123 124 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayRead(DM,Vec,void *); 125 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayRead(DM,Vec,void *); 126 127 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayDOFRead(DM,Vec,void *); 128 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayDOFRead(DM,Vec,void *); 129 130 PETSC_EXTERN PetscErrorCode DMDAVecGetArrayDOFWrite(DM,Vec,void *); 131 PETSC_EXTERN PetscErrorCode DMDAVecRestoreArrayDOFWrite(DM,Vec,void *); 132 133 PETSC_EXTERN PetscErrorCode DMDACreatePatchIS(DM,MatStencil*,MatStencil*,IS*,PetscBool); 134 135 /*MC 136 DMDACoor2d - Structure for holding 2d (x and y) coordinates. 137 138 Level: intermediate 139 140 Synopsis: 141 DMDACoor2d **coors; 142 Vec vcoors; 143 DM cda; 144 DMGetCoordinates(da,&vcoors); 145 DMGetCoordinateDM(da,&cda); 146 DMDAVecGetArray(cda,vcoors,&coors); 147 DMDAGetCorners(cda,&mstart,&nstart,0,&m,&n,0) 148 for (i=mstart; i<mstart+m; i++) { 149 for (j=nstart; j<nstart+n; j++) { 150 x = coors[j][i].x; 151 y = coors[j][i].y; 152 ...... 153 } 154 } 155 DMDAVecRestoreArray(dac,vcoors,&coors); 156 157 .seealso: `DMDACoor3d`, `DMGetCoordinateDM()`, `DMGetCoordinates()` 158 M*/ 159 typedef struct {PetscScalar x,y;} DMDACoor2d; 160 161 /*MC 162 DMDACoor3d - Structure for holding 3d (x, y and z) coordinates. 163 164 Level: intermediate 165 166 Synopsis: 167 DMDACoor3d ***coors; 168 Vec vcoors; 169 DM cda; 170 DMGetCoordinates(da,&vcoors); 171 DMGetCoordinateDM(da,&cda); 172 DMDAVecGetArray(cda,vcoors,&coors); 173 DMDAGetCorners(cda,&mstart,&nstart,&pstart,&m,&n,&p) 174 for (i=mstart; i<mstart+m; i++) { 175 for (j=nstart; j<nstart+n; j++) { 176 for (k=pstart; k<pstart+p; k++) { 177 x = coors[k][j][i].x; 178 y = coors[k][j][i].y; 179 z = coors[k][j][i].z; 180 ...... 181 } 182 } 183 DMDAVecRestoreArray(dac,vcoors,&coors); 184 185 .seealso: `DMDACoor2d`, `DMGetCoordinateDM()`, `DMGetCoordinates()` 186 M*/ 187 typedef struct {PetscScalar x,y,z;} DMDACoor3d; 188 189 PETSC_EXTERN PetscErrorCode DMDAGetLocalInfo(DM,DMDALocalInfo*); 190 191 PETSC_EXTERN PetscErrorCode MatRegisterDAAD(void); 192 PETSC_EXTERN PetscErrorCode MatCreateDAAD(DM,Mat*); 193 PETSC_EXTERN PetscErrorCode MatCreateSeqUSFFT(Vec,DM,Mat*); 194 195 PETSC_EXTERN PetscErrorCode DMDASetGetMatrix(DM,PetscErrorCode (*)(DM, Mat *)); 196 PETSC_EXTERN PetscErrorCode DMDASetBlockFills(DM,const PetscInt*,const PetscInt*); 197 PETSC_EXTERN PetscErrorCode DMDASetBlockFillsSparse(DM,const PetscInt*,const PetscInt*); 198 PETSC_EXTERN PetscErrorCode DMDASetRefinementFactor(DM,PetscInt,PetscInt,PetscInt); 199 PETSC_EXTERN PetscErrorCode DMDAGetRefinementFactor(DM,PetscInt*,PetscInt*,PetscInt*); 200 201 PETSC_EXTERN PetscErrorCode DMDAGetArray(DM,PetscBool ,void*); 202 PETSC_EXTERN PetscErrorCode DMDARestoreArray(DM,PetscBool ,void*); 203 204 PETSC_EXTERN PetscErrorCode DMDACreatePF(DM,PF*); 205 206 /* Emulation of DMPlex */ 207 PETSC_EXTERN PetscErrorCode DMDAGetNumCells(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 208 PETSC_EXTERN PetscErrorCode DMDAGetCellPoint(DM, PetscInt, PetscInt, PetscInt, PetscInt *); 209 PETSC_EXTERN PetscErrorCode DMDAGetNumVertices(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 210 PETSC_EXTERN PetscErrorCode DMDAGetNumFaces(DM, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *, PetscInt *); 211 PETSC_EXTERN PetscErrorCode DMDAGetHeightStratum(DM, PetscInt, PetscInt *, PetscInt *); 212 PETSC_EXTERN PetscErrorCode DMDAGetDepthStratum(DM, PetscInt, PetscInt *, PetscInt *); 213 PETSC_EXTERN PetscErrorCode DMDAComputeCellGeometryFEM(DM, PetscInt, PetscQuadrature, PetscReal [], PetscReal [], PetscReal [], PetscReal []); 214 PETSC_EXTERN PetscErrorCode DMDAGetTransitiveClosure(DM, PetscInt, PetscBool, PetscInt *, PetscInt **); 215 PETSC_EXTERN PetscErrorCode DMDARestoreTransitiveClosure(DM, PetscInt, PetscBool, PetscInt *, PetscInt **); 216 PETSC_EXTERN PetscErrorCode DMDAConvertToCell(DM, MatStencil, PetscInt *); 217 PETSC_EXTERN PetscErrorCode DMDASetVertexCoordinates(DM,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 218 PETSC_EXTERN PetscErrorCode DMDASetPreallocationCenterDimension(DM, PetscInt); 219 PETSC_EXTERN PetscErrorCode DMDAGetPreallocationCenterDimension(DM, PetscInt*); 220 221 #endif 222