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