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 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 19 the owning rank. The background mesh will (by default) define the spatial decomposition of the points defined in the swarm. `DMSWARM_PIC` provides support 20 for particle-in-cell operations such as defining initial point coordinates, communicating particles between sub-domains, projecting particle data fields on to the mesh. 21 22 Level: beginner 23 24 .seealso: `DMSWARM`, `DMSwarmSetType()` 25 E*/ 26 typedef enum { 27 DMSWARM_BASIC = 0, 28 DMSWARM_PIC 29 } DMSwarmType; 30 31 typedef enum { 32 DMSWARM_MIGRATE_BASIC = 0, 33 DMSWARM_MIGRATE_DMCELLNSCATTER, 34 DMSWARM_MIGRATE_DMCELLEXACT, 35 DMSWARM_MIGRATE_USER 36 } DMSwarmMigrateType; 37 38 typedef enum { 39 DMSWARM_COLLECT_BASIC = 0, 40 DMSWARM_COLLECT_DMDABOUNDINGBOX, 41 DMSWARM_COLLECT_GENERAL, 42 DMSWARM_COLLECT_USER 43 } DMSwarmCollectType; 44 45 /*E 46 DMSwarmPICLayoutType - Defines the method used to define particle coordinates within each cell. The layouts are constructured using the reference cell geometry 47 48 Values: 49 + `DMSWARMPIC_LAYOUT_REGULAR` - defines points on a regular ijk mesh. When using `DMSWARMPIC_LAYOUT_REGULAR`, the fill_param defines the number of points in each spatial direction. 50 . `DMSWARMPIC_LAYOUT_GAUSS` - defines points using an npoint Gauss-Legendre tensor product quadrature rule. 51 When using `DMSWARMPIC_LAYOUT_GAUSS`, the fill_param defines the number of quadrature points in each spatial direction. 52 53 - `DMSWARMPIC_LAYOUT_SUBDIVISION` - defines points on the centroid of a sub-divided reference cell. 54 When using `DMSWARMPIC_LAYOUT_SUBDIVISION`, the fill_param defines the number times the reference cell is sub-divided. 55 56 Level: beginner 57 58 .seealso: `DMSWARM`, `DM`, `DMSwarmInsertPointsUsingCellDM()` 59 E*/ 60 typedef enum { 61 DMSWARMPIC_LAYOUT_REGULAR = 0, 62 DMSWARMPIC_LAYOUT_GAUSS, 63 DMSWARMPIC_LAYOUT_SUBDIVISION 64 } DMSwarmPICLayoutType; 65 66 PETSC_EXTERN const char *DMSwarmTypeNames[]; 67 PETSC_EXTERN const char *DMSwarmMigrateTypeNames[]; 68 PETSC_EXTERN const char *DMSwarmCollectTypeNames[]; 69 70 PETSC_EXTERN const char DMSwarmField_pid[]; 71 PETSC_EXTERN const char DMSwarmField_rank[]; 72 PETSC_EXTERN const char DMSwarmPICField_coor[]; 73 PETSC_EXTERN const char DMSwarmPICField_cellid[]; 74 75 PETSC_EXTERN PetscErrorCode DMSwarmCreateGlobalVectorFromField(DM, const char[], Vec *); 76 PETSC_EXTERN PetscErrorCode DMSwarmDestroyGlobalVectorFromField(DM, const char[], Vec *); 77 PETSC_EXTERN PetscErrorCode DMSwarmCreateLocalVectorFromField(DM, const char[], Vec *); 78 PETSC_EXTERN PetscErrorCode DMSwarmDestroyLocalVectorFromField(DM, const char[], Vec *); 79 80 PETSC_EXTERN PetscErrorCode DMSwarmInitializeFieldRegister(DM); 81 PETSC_EXTERN PetscErrorCode DMSwarmFinalizeFieldRegister(DM); 82 PETSC_EXTERN PetscErrorCode DMSwarmSetLocalSizes(DM, PetscInt, PetscInt); 83 PETSC_EXTERN PetscErrorCode DMSwarmRegisterPetscDatatypeField(DM, const char[], PetscInt, PetscDataType); 84 PETSC_EXTERN PetscErrorCode DMSwarmRegisterUserStructField(DM, const char[], size_t); 85 PETSC_EXTERN PetscErrorCode DMSwarmRegisterUserDatatypeField(DM, const char[], size_t, PetscInt); 86 PETSC_EXTERN PetscErrorCode DMSwarmGetField(DM, const char[], PetscInt *, PetscDataType *, void **); 87 PETSC_EXTERN PetscErrorCode DMSwarmRestoreField(DM, const char[], PetscInt *, PetscDataType *, void **); 88 89 PETSC_EXTERN PetscErrorCode DMSwarmVectorDefineField(DM, const char[]); 90 91 PETSC_EXTERN PetscErrorCode DMSwarmAddPoint(DM); 92 PETSC_EXTERN PetscErrorCode DMSwarmAddNPoints(DM, PetscInt); 93 PETSC_EXTERN PetscErrorCode DMSwarmRemovePoint(DM); 94 PETSC_EXTERN PetscErrorCode DMSwarmRemovePointAtIndex(DM, PetscInt); 95 PETSC_EXTERN PetscErrorCode DMSwarmCopyPoint(DM dm, PetscInt, PetscInt); 96 97 PETSC_EXTERN PetscErrorCode DMSwarmGetLocalSize(DM, PetscInt *); 98 PETSC_EXTERN PetscErrorCode DMSwarmGetSize(DM, PetscInt *); 99 PETSC_EXTERN PetscErrorCode DMSwarmGetMigrateType(DM, DMSwarmMigrateType *); 100 PETSC_EXTERN PetscErrorCode DMSwarmSetMigrateType(DM, DMSwarmMigrateType); 101 PETSC_EXTERN PetscErrorCode DMSwarmMigrate(DM, PetscBool); 102 103 PETSC_EXTERN PetscErrorCode DMSwarmCollectViewCreate(DM); 104 PETSC_EXTERN PetscErrorCode DMSwarmCollectViewDestroy(DM); 105 PETSC_EXTERN PetscErrorCode DMSwarmSetCellDM(DM, DM); 106 PETSC_EXTERN PetscErrorCode DMSwarmGetCellDM(DM, DM *); 107 108 PETSC_EXTERN PetscErrorCode DMSwarmSetType(DM, DMSwarmType); 109 110 PETSC_EXTERN PetscErrorCode DMSwarmSetPointsUniformCoordinates(DM, PetscReal *, PetscReal *, PetscInt *, InsertMode); 111 PETSC_EXTERN PetscErrorCode DMSwarmSetPointCoordinates(DM, PetscInt, PetscReal *, PetscBool, InsertMode); 112 PETSC_EXTERN PetscErrorCode DMSwarmInsertPointsUsingCellDM(DM, DMSwarmPICLayoutType, PetscInt); 113 PETSC_EXTERN PetscErrorCode DMSwarmSetPointCoordinatesCellwise(DM, PetscInt, PetscReal *); 114 PETSC_EXTERN PetscErrorCode DMSwarmSetPointCoordinatesRandom(DM, PetscInt); 115 PETSC_EXTERN PetscErrorCode DMSwarmViewFieldsXDMF(DM, const char *, PetscInt, const char **); 116 PETSC_EXTERN PetscErrorCode DMSwarmViewXDMF(DM, const char *); 117 118 PETSC_EXTERN PetscErrorCode DMSwarmSortGetAccess(DM); 119 PETSC_EXTERN PetscErrorCode DMSwarmSortRestoreAccess(DM); 120 PETSC_EXTERN PetscErrorCode DMSwarmSortGetPointsPerCell(DM, PetscInt, PetscInt *, PetscInt **); 121 PETSC_EXTERN PetscErrorCode DMSwarmSortGetNumberOfPointsPerCell(DM, PetscInt, PetscInt *); 122 PETSC_EXTERN PetscErrorCode DMSwarmSortGetIsValid(DM, PetscBool *); 123 PETSC_EXTERN PetscErrorCode DMSwarmSortGetSizes(DM, PetscInt *, PetscInt *); 124 125 PETSC_EXTERN PetscErrorCode DMSwarmCreateMassMatrixSquare(DM, DM, Mat *); 126 127 PETSC_EXTERN PetscErrorCode DMSwarmGetCellSwarm(DM, PetscInt, DM); 128 PETSC_EXTERN PetscErrorCode DMSwarmRestoreCellSwarm(DM, PetscInt, DM); 129 PETSC_EXTERN PetscErrorCode DMSwarmGetNumSpecies(DM, PetscInt *); 130 PETSC_EXTERN PetscErrorCode DMSwarmSetNumSpecies(DM, PetscInt); 131 PETSC_EXTERN PetscErrorCode DMSwarmGetCoordinateFunction(DM, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 132 PETSC_EXTERN PetscErrorCode DMSwarmSetCoordinateFunction(DM, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 133 PETSC_EXTERN PetscErrorCode DMSwarmGetVelocityFunction(DM, PetscErrorCode (**)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 134 PETSC_EXTERN PetscErrorCode DMSwarmSetVelocityFunction(DM, PetscErrorCode (*)(PetscInt, PetscReal, const PetscReal[], PetscInt, PetscScalar[], void *)); 135 PETSC_EXTERN PetscErrorCode DMSwarmComputeLocalSize(DM, PetscInt, PetscProbFunc); 136 PETSC_EXTERN PetscErrorCode DMSwarmComputeLocalSizeFromOptions(DM); 137 PETSC_EXTERN PetscErrorCode DMSwarmInitializeCoordinates(DM); 138 PETSC_EXTERN PetscErrorCode DMSwarmInitializeVelocities(DM, PetscProbFunc, const PetscReal[]); 139 PETSC_EXTERN PetscErrorCode DMSwarmInitializeVelocitiesFromOptions(DM, const PetscReal[]); 140 141 // Interface to internal storage 142 PETSC_EXTERN PetscErrorCode DMSwarmDataFieldGetEntries(const DMSwarmDataField, void **); 143 PETSC_EXTERN PetscErrorCode DMSwarmDataFieldRestoreEntries(const DMSwarmDataField, void **); 144 PETSC_EXTERN PetscErrorCode DMSwarmDataBucketGetDMSwarmDataFieldByName(DMSwarmDataBucket, const char[], DMSwarmDataField *); 145 PETSC_EXTERN PetscErrorCode DMSwarmDataBucketGetDMSwarmDataFieldIdByName(DMSwarmDataBucket, const char[], PetscInt *); 146 PETSC_EXTERN PetscErrorCode DMSwarmDataBucketQueryDMSwarmDataFieldByName(DMSwarmDataBucket, const char[], PetscBool *); 147