1 #pragma once 2 3 #include <petscdm.h> 4 #include <petscdt.h> 5 6 typedef struct _p_DMSwarmDataField *DMSwarmDataField; 7 typedef struct _p_DMSwarmDataBucket *DMSwarmDataBucket; 8 typedef struct _p_DMSwarmSort *DMSwarmSort; 9 10 /* SUBMANSEC = DMSwarm */ 11 12 /*E 13 DMSwarmType - Defines the type of `DMSWARM` 14 15 Values: 16 + `DMSWARM_BASIC` - defines N entries of varied data-types which the user may register. 17 - `DMSWARM_PIC` - suitable for particle-in-cell methods. Configured as `DMSWARM_PIC`, the swarm will be aware of, another `DM` which serves as the background mesh. 18 19 Fields specific to particle-in-cell methods are registered by default. These include spatial coordinates, a unique identifier, a cell index and an index for 20 the owning rank. The background mesh will (by default) define the spatial decomposition of the points defined in the swarm. `DMSWARM_PIC` provides support 21 for particle-in-cell operations such as defining initial point coordinates, communicating particles between sub-domains, projecting particle data fields on to the mesh. 22 23 Level: beginner 24 25 .seealso: [](ch_dmbase), `DMSWARM`, `DMSwarmSetType()` 26 E*/ 27 typedef enum { 28 DMSWARM_BASIC = 0, 29 DMSWARM_PIC 30 } DMSwarmType; 31 PETSC_EXTERN const char *DMSwarmTypeNames[]; 32 33 typedef enum { 34 DMSWARM_MIGRATE_BASIC = 0, 35 DMSWARM_MIGRATE_DMCELLNSCATTER, 36 DMSWARM_MIGRATE_DMCELLEXACT, 37 DMSWARM_MIGRATE_USER 38 } DMSwarmMigrateType; 39 PETSC_EXTERN const char *DMSwarmMigrateTypeNames[]; 40 41 typedef enum { 42 DMSWARM_COLLECT_BASIC = 0, 43 DMSWARM_COLLECT_DMDABOUNDINGBOX, 44 DMSWARM_COLLECT_GENERAL, 45 DMSWARM_COLLECT_USER 46 } DMSwarmCollectType; 47 PETSC_EXTERN const char *DMSwarmCollectTypeNames[]; 48 49 typedef enum { 50 DMSWARM_REMAP_NONE = 0, 51 DMSWARM_REMAP_PFAK, 52 DMSWARM_REMAP_COLELLA 53 } DMSwarmRemapType; 54 PETSC_EXTERN const char *DMSwarmRemapTypeNames[]; 55 56 /*E 57 DMSwarmPICLayoutType - Defines the method used to define particle coordinates within each cell. The layouts are constructured using the reference cell geometry 58 59 Values: 60 + `DMSWARMPIC_LAYOUT_REGULAR` - defines points on a regular ijk mesh. In this case 61 the `fill_param` argument of `DMSwarmInsertPointsUsingCellDM()` defines the number of points in each spatial direction. 62 . `DMSWARMPIC_LAYOUT_GAUSS` - defines points using an npoint Gauss-Legendre tensor product quadrature rule. In this case 63 the `fill_param` argument of `DMSwarmInsertPointsUsingCellDM()` defines the number of quadrature points in each spatial direction. 64 - `DMSWARMPIC_LAYOUT_SUBDIVISION` - defines points on the centroid of a sub-divided reference cell. In this case 65 the `fill_param` argument of `DMSwarmInsertPointsUsingCellDM()` defines the number times the reference cell is sub-divided. 66 67 Level: beginner 68 69 .seealso: [](ch_dmbase), `DMSWARM`, `DM`, `DMSwarmInsertPointsUsingCellDM()` 70 E*/ 71 typedef enum { 72 DMSWARMPIC_LAYOUT_REGULAR = 0, 73 DMSWARMPIC_LAYOUT_GAUSS, 74 DMSWARMPIC_LAYOUT_SUBDIVISION 75 } DMSwarmPICLayoutType; 76 77 /*S 78 DMSwarmCellDM - PETSc object for defining a backgroudn DM for the DMSwarm particles 79 80 Level: intermediate 81 82 .seealso: [](ch_dmbase), `DM`, `DMSwarmAddCellDM()`, `DMSwarmCellDMCreate()` 83 S*/ 84 typedef struct _p_DMSwarmCellDM *DMSwarmCellDM; 85 PETSC_EXTERN PetscClassId DMSWARMCELLDM_CLASSID; 86 87 PETSC_EXTERN const char DMSwarmField_pid[]; 88 PETSC_EXTERN const char DMSwarmField_rank[]; 89 PETSC_EXTERN const char DMSwarmPICField_coor[]; 90 91 PETSC_EXTERN PetscErrorCode DMSwarmCreateGlobalVectorFromField(DM, const char[], Vec *); 92 PETSC_EXTERN PetscErrorCode DMSwarmDestroyGlobalVectorFromField(DM, const char[], Vec *); 93 PETSC_EXTERN PetscErrorCode DMSwarmCreateLocalVectorFromField(DM, const char[], Vec *); 94 PETSC_EXTERN PetscErrorCode DMSwarmDestroyLocalVectorFromField(DM, const char[], Vec *); 95 PETSC_EXTERN PetscErrorCode DMSwarmCreateGlobalVectorFromFields(DM, PetscInt, const char *[], Vec *); 96 PETSC_EXTERN PetscErrorCode DMSwarmDestroyGlobalVectorFromFields(DM, PetscInt, const char *[], Vec *); 97 PETSC_EXTERN PetscErrorCode DMSwarmCreateLocalVectorFromFields(DM, PetscInt, const char *[], Vec *); 98 PETSC_EXTERN PetscErrorCode DMSwarmDestroyLocalVectorFromFields(DM, PetscInt, const char *[], Vec *); 99 100 PETSC_EXTERN PetscErrorCode DMSwarmInitializeFieldRegister(DM); 101 PETSC_EXTERN PetscErrorCode DMSwarmFinalizeFieldRegister(DM); 102 PETSC_EXTERN PetscErrorCode DMSwarmSetLocalSizes(DM, PetscInt, PetscInt); 103 PETSC_EXTERN PetscErrorCode DMSwarmRegisterPetscDatatypeField(DM, const char[], PetscInt, PetscDataType); 104 PETSC_EXTERN PetscErrorCode DMSwarmRegisterUserStructField(DM, const char[], size_t); 105 PETSC_EXTERN PetscErrorCode DMSwarmRegisterUserDatatypeField(DM, const char[], size_t, PetscInt); 106 PETSC_EXTERN PetscErrorCode DMSwarmGetField(DM, const char[], PetscInt *, PetscDataType *, void **); 107 PETSC_EXTERN PetscErrorCode DMSwarmRestoreField(DM, const char[], PetscInt *, PetscDataType *, void **); 108 PETSC_EXTERN PetscErrorCode DMSwarmGetFieldInfo(DM, const char[], PetscInt *, PetscDataType *); 109 110 PETSC_EXTERN PetscErrorCode DMSwarmVectorDefineField(DM, const char[]); 111 PETSC_EXTERN PetscErrorCode DMSwarmVectorDefineFields(DM, PetscInt, const char *[]); 112 PETSC_EXTERN PetscErrorCode DMSwarmVectorGetField(DM, PetscInt *, const char **[]); 113 114 PETSC_EXTERN PetscErrorCode DMSwarmAddPoint(DM); 115 PETSC_EXTERN PetscErrorCode DMSwarmAddNPoints(DM, PetscInt); 116 PETSC_EXTERN PetscErrorCode DMSwarmRemovePoint(DM); 117 PETSC_EXTERN PetscErrorCode DMSwarmRemovePointAtIndex(DM, PetscInt); 118 PETSC_EXTERN PetscErrorCode DMSwarmCopyPoint(DM dm, PetscInt, PetscInt); 119 120 PETSC_EXTERN PetscErrorCode DMSwarmGetLocalSize(DM, PetscInt *); 121 PETSC_EXTERN PetscErrorCode DMSwarmGetSize(DM, PetscInt *); 122 PETSC_EXTERN PetscErrorCode DMSwarmGetMigrateType(DM, DMSwarmMigrateType *); 123 PETSC_EXTERN PetscErrorCode DMSwarmSetMigrateType(DM, DMSwarmMigrateType); 124 PETSC_EXTERN PetscErrorCode DMSwarmMigrate(DM, PetscBool); 125 126 PETSC_EXTERN PetscErrorCode DMSwarmCollectViewCreate(DM); 127 PETSC_EXTERN PetscErrorCode DMSwarmCollectViewDestroy(DM); 128 PETSC_EXTERN PetscErrorCode DMSwarmSetCellDM(DM, DM); 129 PETSC_EXTERN PetscErrorCode DMSwarmGetCellDM(DM, DM *); 130 PETSC_EXTERN PetscErrorCode DMSwarmGetCellDMByName(DM, const char[], DMSwarmCellDM *); 131 PETSC_EXTERN PetscErrorCode DMSwarmGetCellDMNames(DM, PetscInt *, const char **[]); 132 PETSC_EXTERN PetscErrorCode DMSwarmSetCellDMActive(DM, const char[]); 133 PETSC_EXTERN PetscErrorCode DMSwarmGetCellDMActive(DM, DMSwarmCellDM *); 134 PETSC_EXTERN PetscErrorCode DMSwarmAddCellDM(DM, DMSwarmCellDM); 135 136 PETSC_EXTERN PetscErrorCode DMSwarmGetType(DM, DMSwarmType *); 137 PETSC_EXTERN PetscErrorCode DMSwarmSetType(DM, DMSwarmType); 138 139 PETSC_EXTERN PetscErrorCode DMSwarmSetPointsUniformCoordinates(DM, PetscReal *, PetscReal *, PetscInt *, InsertMode); 140 PETSC_EXTERN PetscErrorCode DMSwarmSetPointCoordinates(DM, PetscInt, PetscReal *, PetscBool, InsertMode); 141 PETSC_EXTERN PetscErrorCode DMSwarmInsertPointsUsingCellDM(DM, DMSwarmPICLayoutType, PetscInt); 142 PETSC_EXTERN PetscErrorCode DMSwarmSetPointCoordinatesCellwise(DM, PetscInt, PetscReal *); 143 PETSC_EXTERN PetscErrorCode DMSwarmSetPointCoordinatesRandom(DM, PetscInt); 144 PETSC_EXTERN PetscErrorCode DMSwarmViewFieldsXDMF(DM, const char *, PetscInt, const char **); 145 PETSC_EXTERN PetscErrorCode DMSwarmViewXDMF(DM, const char *); 146 147 PETSC_EXTERN PetscErrorCode DMSwarmSortDestroy(DMSwarmSort *); 148 PETSC_EXTERN PetscErrorCode DMSwarmSortGetAccess(DM); 149 PETSC_EXTERN PetscErrorCode DMSwarmSortRestoreAccess(DM); 150 PETSC_EXTERN PetscErrorCode DMSwarmSortGetPointsPerCell(DM, PetscInt, PetscInt *, PetscInt **); 151 PETSC_EXTERN PetscErrorCode DMSwarmSortRestorePointsPerCell(DM, PetscInt, PetscInt *, PetscInt **); 152 PETSC_EXTERN PetscErrorCode DMSwarmSortGetNumberOfPointsPerCell(DM, PetscInt, PetscInt *); 153 PETSC_EXTERN PetscErrorCode DMSwarmSortGetIsValid(DM, PetscBool *); 154 PETSC_EXTERN PetscErrorCode DMSwarmSortGetSizes(DM, PetscInt *, PetscInt *); 155 156 PETSC_EXTERN PetscErrorCode DMSwarmCreateMassMatrixSquare(DM, DM, Mat *); 157 158 PETSC_EXTERN PetscErrorCode DMSwarmGetCellSwarm(DM, PetscInt, DM); 159 PETSC_EXTERN PetscErrorCode DMSwarmRestoreCellSwarm(DM, PetscInt, DM); 160 PETSC_EXTERN PetscErrorCode DMSwarmGetNumSpecies(DM, PetscInt *); 161 PETSC_EXTERN PetscErrorCode DMSwarmSetNumSpecies(DM, PetscInt); 162 PETSC_EXTERN PetscErrorCode DMSwarmGetCoordinateFunction(DM, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 163 PETSC_EXTERN PetscErrorCode DMSwarmSetCoordinateFunction(DM, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 164 PETSC_EXTERN PetscErrorCode DMSwarmGetVelocityFunction(DM, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 165 PETSC_EXTERN PetscErrorCode DMSwarmSetVelocityFunction(DM, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 166 PETSC_EXTERN PetscErrorCode DMSwarmComputeLocalSize(DM, PetscInt, PetscProbFunc); 167 PETSC_EXTERN PetscErrorCode DMSwarmComputeLocalSizeFromOptions(DM); 168 PETSC_EXTERN PetscErrorCode DMSwarmInitializeCoordinates(DM); 169 PETSC_EXTERN PetscErrorCode DMSwarmInitializeVelocities(DM, PetscProbFunc, const PetscReal[]); 170 PETSC_EXTERN PetscErrorCode DMSwarmInitializeVelocitiesFromOptions(DM, const PetscReal[]); 171 172 PETSC_EXTERN PetscErrorCode DMSwarmCreatePointPerCellCount(DM, PetscInt *, PetscInt **); 173 174 // Interface to internal storage 175 PETSC_EXTERN PetscErrorCode DMSwarmDataFieldGetEntries(const DMSwarmDataField, void **); 176 PETSC_EXTERN PetscErrorCode DMSwarmDataFieldRestoreEntries(const DMSwarmDataField, void **); 177 PETSC_EXTERN PetscErrorCode DMSwarmDataBucketGetDMSwarmDataFieldByName(DMSwarmDataBucket, const char[], DMSwarmDataField *); 178 PETSC_EXTERN PetscErrorCode DMSwarmDataBucketGetDMSwarmDataFieldIdByName(DMSwarmDataBucket, const char[], PetscInt *); 179 PETSC_EXTERN PetscErrorCode DMSwarmDataBucketQueryDMSwarmDataFieldByName(DMSwarmDataBucket, const char[], PetscBool *); 180 181 PETSC_EXTERN PetscErrorCode DMSwarmDuplicate(DM, DM *); 182 PETSC_EXTERN PetscErrorCode DMSwarmRemap(DM); 183 PETSC_EXTERN PetscErrorCode DMSwarmReplace(DM, DM *); 184 185 PETSC_EXTERN PetscErrorCode DMSwarmComputeMoments(DM, const char[], const char[], PetscReal[]); 186 187 PETSC_EXTERN PetscErrorCode DMSwarmCellDMCreate(DM, PetscInt, const char *[], PetscInt, const char *[], DMSwarmCellDM *); 188 PETSC_EXTERN PetscErrorCode DMSwarmCellDMDestroy(DMSwarmCellDM *); 189 PETSC_EXTERN PetscErrorCode DMSwarmCellDMView(DMSwarmCellDM, PetscViewer); 190 PETSC_EXTERN PetscErrorCode DMSwarmCellDMGetDM(DMSwarmCellDM, DM *); 191 PETSC_EXTERN PetscErrorCode DMSwarmCellDMGetFields(DMSwarmCellDM, PetscInt *, const char **[]); 192 PETSC_EXTERN PetscErrorCode DMSwarmCellDMGetCoordinateFields(DMSwarmCellDM, PetscInt *, const char **[]); 193 PETSC_EXTERN PetscErrorCode DMSwarmCellDMGetCellID(DMSwarmCellDM, const char *[]); 194 PETSC_EXTERN PetscErrorCode DMSwarmCellDMGetSort(DMSwarmCellDM, DMSwarmSort *); 195 PETSC_EXTERN PetscErrorCode DMSwarmCellDMSetSort(DMSwarmCellDM, DMSwarmSort); 196 PETSC_EXTERN PetscErrorCode DMSwarmCellDMGetBlockSize(DMSwarmCellDM, DM, PetscInt *); 197