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