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