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