1 #if !defined(DMSTAG_H_) 2 #define DMSTAG_H_ 3 4 #include <petscdm.h> 5 #include <petscdmproduct.h> 6 7 /* SUBMANSEC = DMStag */ 8 9 /*E 10 DMStagStencilLocation - enumerated type denoted 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 .seealso: `DMSTAG`, `DMStagStencil`, `DMStagGetLocationSlot()` 17 E*/ 18 19 /* The order of these entries is significant, as it corresponds to the canonical numbering 20 of DOFs, and the fact the the numbering starts at 0 may also be used by the implementation */ 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 Note: 61 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). 62 63 Level: beginner 64 65 .seealso: `DMSTAG`, `DMStagMatSetValuesStencil()`, `DMStagVecSetValuesStencil()`, `DMStagStencilLocation`, `DMStagSetStencilWidth()`, `DMStagSetStencilType()`, `DMStagVecGetValuesStencil()` 66 S*/ 67 typedef struct { 68 DMStagStencilLocation loc; 69 PetscInt i,j,k,c; 70 } DMStagStencil; 71 72 /*E 73 DMStagStencilType - Elementwise stencil type, determining which neighbors participate in communication 74 75 Level: beginner 76 77 .seealso: `DMSTAG`, `DMStagCreate1d()`, `DMStagCreate2d()`, `DMStagCreate3d()`, `DMStagStencil` 78 E*/ 79 80 typedef enum{DMSTAG_STENCIL_NONE=0,DMSTAG_STENCIL_STAR,DMSTAG_STENCIL_BOX} DMStagStencilType; 81 PETSC_EXTERN const char *const DMStagStencilTypes[]; /* Corresponding strings (see stagstencil.c) */ 82 83 PETSC_EXTERN PetscErrorCode DMCreate_Stag(DM); 84 PETSC_EXTERN PetscErrorCode DMStagCreate1d(MPI_Comm,DMBoundaryType,PetscInt,PetscInt,PetscInt,DMStagStencilType,PetscInt,const PetscInt[],DM*); 85 PETSC_EXTERN PetscErrorCode DMStagCreate2d(MPI_Comm,DMBoundaryType,DMBoundaryType,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,DMStagStencilType,PetscInt,const PetscInt[],const PetscInt[],DM*); 86 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*); 87 PETSC_EXTERN PetscErrorCode DMStagCreateCompatibleDMStag(DM,PetscInt,PetscInt,PetscInt,PetscInt,DM*); 88 PETSC_EXTERN PetscErrorCode DMStagCreateISFromStencils(DM,PetscInt,DMStagStencil*,IS*); 89 PETSC_EXTERN PetscErrorCode DMStagGetBoundaryTypes(DM,DMBoundaryType*,DMBoundaryType*,DMBoundaryType*); 90 PETSC_EXTERN PetscErrorCode DMStagGetCorners(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 91 PETSC_EXTERN PetscErrorCode DMStagGetDOF(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 92 PETSC_EXTERN PetscErrorCode DMStagGetEntries(DM,PetscInt*); 93 PETSC_EXTERN PetscErrorCode DMStagGetEntriesPerElement(DM,PetscInt*); 94 PETSC_EXTERN PetscErrorCode DMStagGetGhostCorners(DM,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*,PetscInt*); 95 PETSC_EXTERN PetscErrorCode DMStagGetGlobalSizes(DM,PetscInt*,PetscInt*,PetscInt*); 96 PETSC_EXTERN PetscErrorCode DMStagGetIsFirstRank(DM,PetscBool*,PetscBool*,PetscBool*); 97 PETSC_EXTERN PetscErrorCode DMStagGetIsLastRank(DM,PetscBool*,PetscBool*,PetscBool*); 98 PETSC_EXTERN PetscErrorCode DMStagGetLocalSizes(DM,PetscInt*,PetscInt*,PetscInt*); 99 PETSC_EXTERN PetscErrorCode DMStagGetLocationDOF(DM,DMStagStencilLocation,PetscInt*); 100 PETSC_EXTERN PetscErrorCode DMStagGetLocationSlot(DM,DMStagStencilLocation,PetscInt,PetscInt*); 101 PETSC_EXTERN PetscErrorCode DMStagGetNumRanks(DM,PetscInt*,PetscInt*,PetscInt*); 102 PETSC_EXTERN PetscErrorCode DMStagGetOwnershipRanges(DM,const PetscInt**,const PetscInt**,const PetscInt**); 103 PETSC_EXTERN PetscErrorCode DMStagGetProductCoordinateArrays(DM,void*,void*,void*); 104 PETSC_EXTERN PetscErrorCode DMStagGetProductCoordinateArraysRead(DM,void*,void*,void*); 105 PETSC_EXTERN PetscErrorCode DMStagGetProductCoordinateLocationSlot(DM,DMStagStencilLocation,PetscInt*); 106 PETSC_EXTERN PetscErrorCode DMStagGetStencilType(DM,DMStagStencilType*); 107 PETSC_EXTERN PetscErrorCode DMStagGetStencilWidth(DM,PetscInt*); 108 PETSC_EXTERN PetscErrorCode DMStagMatGetValuesStencil(DM,Mat,PetscInt,const DMStagStencil*,PetscInt,const DMStagStencil*,PetscScalar*); 109 PETSC_EXTERN PetscErrorCode DMStagMatSetValuesStencil(DM,Mat,PetscInt,const DMStagStencil*,PetscInt,const DMStagStencil*,const PetscScalar*,InsertMode); 110 PETSC_EXTERN PetscErrorCode DMStagMigrateVec(DM,Vec,DM,Vec); 111 PETSC_EXTERN PetscErrorCode DMStagPopulateLocalToGlobalInjective(DM); 112 PETSC_EXTERN PetscErrorCode DMStagRestoreProductCoordinateArrays(DM,void*,void*,void*); 113 PETSC_EXTERN PetscErrorCode DMStagRestoreProductCoordinateArraysRead(DM,void*,void*,void*); 114 PETSC_EXTERN PetscErrorCode DMStagSetBoundaryTypes(DM,DMBoundaryType,DMBoundaryType,DMBoundaryType); 115 PETSC_EXTERN PetscErrorCode DMStagSetCoordinateDMType(DM,DMType); 116 PETSC_EXTERN PetscErrorCode DMStagSetDOF(DM,PetscInt,PetscInt,PetscInt,PetscInt); 117 PETSC_EXTERN PetscErrorCode DMStagSetGlobalSizes(DM,PetscInt,PetscInt,PetscInt); 118 PETSC_EXTERN PetscErrorCode DMStagSetNumRanks(DM,PetscInt,PetscInt,PetscInt); 119 PETSC_EXTERN PetscErrorCode DMStagSetOwnershipRanges(DM,PetscInt const *,PetscInt const *,PetscInt const *); 120 PETSC_EXTERN PetscErrorCode DMStagSetStencilType(DM,DMStagStencilType); 121 PETSC_EXTERN PetscErrorCode DMStagSetStencilWidth(DM,PetscInt); 122 PETSC_EXTERN PetscErrorCode DMStagSetUniformCoordinates(DM,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 123 PETSC_EXTERN PetscErrorCode DMStagSetUniformCoordinatesExplicit(DM,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 124 PETSC_EXTERN PetscErrorCode DMStagSetUniformCoordinatesProduct(DM,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal); 125 PETSC_EXTERN PetscErrorCode DMStagStencilToIndexLocal(DM,PetscInt,PetscInt,const DMStagStencil*,PetscInt*); 126 PETSC_EXTERN PetscErrorCode DMStagVecGetArray(DM,Vec,void*); 127 PETSC_EXTERN PetscErrorCode DMStagVecGetArrayRead(DM,Vec,void*); 128 PETSC_EXTERN PetscErrorCode DMStagVecGetValuesStencil(DM,Vec,PetscInt,const DMStagStencil*,PetscScalar*); 129 PETSC_EXTERN PetscErrorCode DMStagVecRestoreArray(DM,Vec,void*); 130 PETSC_EXTERN PetscErrorCode DMStagVecRestoreArrayRead(DM,Vec,void*); 131 PETSC_EXTERN PetscErrorCode DMStagVecSetValuesStencil(DM,Vec,PetscInt,const DMStagStencil*,const PetscScalar*,InsertMode); 132 PETSC_EXTERN PetscErrorCode DMStagVecSplitToDMDA(DM,Vec,DMStagStencilLocation,PetscInt,DM*,Vec*); 133 134 PETSC_DEPRECATED_FUNCTION("Use DMStagGetProductCoordinateArraysRead() (since version 3.13") static inline PetscErrorCode DMStagGet1dCoordinateArraysDOFRead(DM dm,void *ax,void *ay,void *az) {return DMStagGetProductCoordinateArraysRead(dm,ax,ay,az);} 135 PETSC_DEPRECATED_FUNCTION("Use DMStagGetProductCoordinateLocationSlot() (since version 3.13") static inline PetscErrorCode DMStagGet1dCoordinateLocationSlot(DM dm,DMStagStencilLocation loc,PetscInt *s) {return DMStagGetProductCoordinateLocationSlot(dm,loc,s);} 136 PETSC_DEPRECATED_FUNCTION("Use DMStagGetStencilType() (since version 3.11)") static inline PetscErrorCode DMStagGetGhostType(DM dm,DMStagStencilType *s) {return DMStagGetStencilType(dm,s);} 137 PETSC_DEPRECATED_FUNCTION("Use DMStagRestoreProductCoordinateArraysRead() (since version 3.13") static inline PetscErrorCode DMStagRestore1dCoordinateArraysDOFRead(DM dm,void *ax,void *ay,void *az) {return DMStagRestoreProductCoordinateArraysRead(dm,ax,ay,az);} 138 PETSC_DEPRECATED_FUNCTION("Use DMStagSetStencilType() (since version 3.11)") static inline PetscErrorCode DMStagSetGhostType(DM dm,DMStagStencilType *s) {return DMStagGetStencilType(dm,s);} 139 PETSC_DEPRECATED_FUNCTION("Use DMStagVecGetArray() (since version 3.13") static inline PetscErrorCode DMStagVecGetArrayDOF(DM dm,Vec v,void *a) {return DMStagVecGetArray(dm,v,a);} 140 PETSC_DEPRECATED_FUNCTION("Use DMStagVecGetArrayRead() (since version 3.13") static inline PetscErrorCode DMStagVecGetArrayDOFRead(DM dm,Vec v,void *a) {return DMStagVecGetArrayRead(dm,v,a);} 141 PETSC_DEPRECATED_FUNCTION("Use DMStagVecRestoreArray() (since version 3.13") static inline PetscErrorCode DMStagVecRestoreArrayDOF(DM dm,Vec v,void *a) {return DMStagVecRestoreArray(dm,v,a);} 142 PETSC_DEPRECATED_FUNCTION("Use DMStagVecRestoreArrayRead() (since version 3.13") static inline PetscErrorCode DMStagVecRestoreArrayDOFRead(DM dm,Vec v,void *a) {return DMStagVecRestoreArrayRead(dm,v,a);} 143 144 #endif 145