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