xref: /petsc/src/dm/impls/swarm/swarm.c (revision 52c3ed93dd49c1bed250a17e4fa440cd34638ad7)
1 
2 #define PETSCDM_DLL
3 #include <petsc/private/dmswarmimpl.h>    /*I   "petscdmswarm.h"   I*/
4 #include "data_bucket.h"
5 
6 PetscErrorCode DMSwarmMigrate_Push_Basic(DM dm,PetscBool remove_sent_points);
7 
8 
9 //typedef PetscErrorCode (*swarm_project)(DM,DM,Vec) DMSwarmProjectMethod; /* swarm, geometry, result */
10 
11 //typedef enum { PROJECT_DMDA_AQ1=0, PROJECT_DMDA_P0 } DMSwarmDMDAProjectionType;
12 
13 #if 0
14 
15 /* Defines what the local space will be */
16 PetscErrorCode DMSwarmSetOverlap(void)
17 {
18 
19   PetscFunctionReturn(0);
20 }
21 
22 
23 /* coordinates */
24 /*
25 DMGetCoordinateDM returns self
26 DMGetCoordinates and DMGetCoordinatesLocal return same thing
27 Local view could be used to define overlapping information
28 */
29 
30 #endif
31 
32 #undef __FUNCT__
33 #define __FUNCT__ "DMSwarmVectorDefineField"
34 PETSC_EXTERN PetscErrorCode DMSwarmVectorDefineField(DM dm,const char fieldname[])
35 {
36   DM_Swarm *swarm = (DM_Swarm*)dm->data;
37   PetscErrorCode ierr;
38   PetscInt bs,n;
39   PetscScalar *array;
40   PetscDataType type;
41 
42   if (!swarm->issetup) { ierr = DMSetUp(dm);CHKERRQ(ierr); }
43   ierr = DataBucketGetSizes(swarm->db,&n,NULL,NULL);CHKERRQ(ierr);
44   ierr = DMSwarmGetField(dm,fieldname,&bs,&type,(void**)&array);CHKERRQ(ierr);
45 
46   /* Check all fields are of type PETSC_REAL or PETSC_SCALAR */
47   if (type != PETSC_REAL) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Only valid for PETSC_REAL");
48 
49   PetscSNPrintf(swarm->vec_field_name,PETSC_MAX_PATH_LEN-1,"%s",fieldname);
50   swarm->vec_field_set = PETSC_TRUE;
51   swarm->vec_field_bs = 1;//bs;
52   swarm->vec_field_nlocal = n;
53   ierr = DMSwarmRestoreField(dm,fieldname,&bs,&type,(void**)&array);CHKERRQ(ierr);
54 
55   PetscFunctionReturn(0);
56 }
57 
58 /* requires DMSwarmDefineFieldVector has been called */
59 #undef __FUNCT__
60 #define __FUNCT__ "DMCreateGlobalVector_Swarm"
61 PetscErrorCode DMCreateGlobalVector_Swarm(DM dm,Vec *vec)
62 {
63   DM_Swarm *swarm = (DM_Swarm*)dm->data;
64   PetscErrorCode ierr;
65   Vec x;
66   char name[PETSC_MAX_PATH_LEN];
67 
68   if (!swarm->issetup) { ierr = DMSetUp(dm);CHKERRQ(ierr); }
69   if (!swarm->vec_field_set) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Must call DMSwarmVectorDefineField first");
70   PetscSNPrintf(name,PETSC_MAX_PATH_LEN-1,"DMSwarmField_%s",swarm->vec_field_name);
71   ierr = VecCreate(PetscObjectComm((PetscObject)dm),&x);CHKERRQ(ierr);
72   ierr = PetscObjectSetName((PetscObject)x,name);CHKERRQ(ierr);
73   ierr = VecSetSizes(x,swarm->db->L,PETSC_DETERMINE);CHKERRQ(ierr);
74   ierr = VecSetBlockSize(x,swarm->vec_field_bs);CHKERRQ(ierr);
75   ierr = VecSetFromOptions(x);CHKERRQ(ierr);
76   *vec = x;
77 
78   PetscFunctionReturn(0);
79 }
80 
81 /* requires DMSwarmDefineFieldVector has been called */
82 #undef __FUNCT__
83 #define __FUNCT__ "DMCreateLocalVector_Swarm"
84 PetscErrorCode DMCreateLocalVector_Swarm(DM dm,Vec *vec)
85 {
86   DM_Swarm *swarm = (DM_Swarm*)dm->data;
87   PetscErrorCode ierr;
88   Vec x;
89   char name[PETSC_MAX_PATH_LEN];
90 
91   if (!swarm->issetup) { ierr = DMSetUp(dm);CHKERRQ(ierr); }
92   if (!swarm->vec_field_set) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Must call DMSwarmVectorDefineField first");
93   PetscSNPrintf(name,PETSC_MAX_PATH_LEN-1,"DMSwarmField_%s",swarm->vec_field_name);
94   ierr = VecCreate(PETSC_COMM_SELF,&x);CHKERRQ(ierr);
95   ierr = PetscObjectSetName((PetscObject)x,name);CHKERRQ(ierr);
96   ierr = VecSetSizes(x,swarm->db->L,swarm->db->L);CHKERRQ(ierr);
97   ierr = VecSetBlockSize(x,swarm->vec_field_bs);CHKERRQ(ierr);
98   ierr = VecSetFromOptions(x);CHKERRQ(ierr);
99   *vec = x;
100 
101   PetscFunctionReturn(0);
102 }
103 
104 #undef __FUNCT__
105 #define __FUNCT__ "DMSwarmCreateGlobalVectorFromField"
106 PETSC_EXTERN PetscErrorCode DMSwarmCreateGlobalVectorFromField(DM dm,const char fieldname[],Vec *vec)
107 {
108   DM_Swarm *swarm = (DM_Swarm*)dm->data;
109   PetscErrorCode ierr;
110   PetscInt bs,n;
111   PetscScalar *array;
112   Vec x;
113   PetscDataType type;
114   char name[PETSC_MAX_PATH_LEN];
115   PetscMPIInt commsize;
116 
117   if (!swarm->issetup) { ierr = DMSetUp(dm);CHKERRQ(ierr); }
118   ierr = DataBucketGetSizes(swarm->db,&n,NULL,NULL);CHKERRQ(ierr);
119   ierr = DMSwarmGetField(dm,fieldname,&bs,&type,(void**)&array);CHKERRQ(ierr);
120 
121   /* Check all fields are of type PETSC_REAL or PETSC_SCALAR */
122   if (type != PETSC_REAL) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Only valid for PETSC_REAL");
123 
124   ierr = MPI_Comm_size(PetscObjectComm((PetscObject)dm),&commsize);CHKERRQ(ierr);
125   if (commsize == 1) {
126     ierr = VecCreateSeqWithArray(PetscObjectComm((PetscObject)dm),1,n,array,&x);CHKERRQ(ierr);
127   } else {
128     ierr = VecCreateMPIWithArray(PetscObjectComm((PetscObject)dm),1,n,PETSC_DETERMINE,array,&x);CHKERRQ(ierr);
129   }
130   PetscSNPrintf(name,PETSC_MAX_PATH_LEN-1,"DMSwarmSharedField_%s",swarm->vec_field_name);
131   ierr = PetscObjectSetName((PetscObject)x,name);CHKERRQ(ierr);
132 
133   /* Set guard */
134   PetscSNPrintf(name,PETSC_MAX_PATH_LEN-1,"DMSwarm_VecFieldInPlace_%s",fieldname);
135   ierr = PetscObjectComposeFunction((PetscObject)x,name,DMSwarmDestroyGlobalVectorFromField);CHKERRQ(ierr);
136 
137   *vec = x;
138   PetscFunctionReturn(0);
139 }
140 
141 #undef __FUNCT__
142 #define __FUNCT__ "DMSwarmDestroyGlobalVectorFromField"
143 PETSC_EXTERN PetscErrorCode DMSwarmDestroyGlobalVectorFromField(DM dm,const char fieldname[],Vec *vec)
144 {
145   DM_Swarm *swarm = (DM_Swarm*)dm->data;
146   PetscErrorCode ierr;
147   DataField gfield;
148   char name[PETSC_MAX_PATH_LEN];
149   void (*fptr)(void);
150 
151   /* get data field */
152   ierr = DataBucketGetDataFieldByName(swarm->db,fieldname,&gfield);CHKERRQ(ierr);
153 
154   /* check vector is an inplace array */
155   PetscSNPrintf(name,PETSC_MAX_PATH_LEN-1,"DMSwarm_VecFieldInPlace_%s",fieldname);
156   ierr = PetscObjectQueryFunction((PetscObject)(*vec),name,&fptr);CHKERRQ(ierr);
157   if (!fptr) SETERRQ1(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Vector being destroyed was not created from DMSwarm field(%s)",fieldname);
158 
159   /* restore data field */
160   ierr = DataFieldRestoreAccess(gfield);CHKERRQ(ierr);
161 
162   ierr = VecDestroy(vec);CHKERRQ(ierr);
163 
164   PetscFunctionReturn(0);
165 }
166 
167 /*
168 PETSC_EXTERN PetscErrorCode DMSwarmCreateGlobalVectorFromFields(DM dm,const PetscInt nf,const char *fieldnames[],Vec *vec)
169 {
170   PetscFunctionReturn(0);
171 }
172 
173 PETSC_EXTERN PetscErrorCode DMSwarmRestoreGlobalVectorFromFields(DM dm,Vec *vec)
174 {
175   PetscFunctionReturn(0);
176 }
177 */
178 
179 #undef __FUNCT__
180 #define __FUNCT__ "DMSwarmInitializeFieldRegister"
181 PETSC_EXTERN PetscErrorCode DMSwarmInitializeFieldRegister(DM dm)
182 {
183   DM_Swarm *swarm = (DM_Swarm*)dm->data;
184   PetscErrorCode ierr;
185 
186   swarm->field_registration_initialized = PETSC_TRUE;
187 
188   ierr = DMSwarmRegisterPetscDatatypeField(dm,"DMSwarm_pid",1,PETSC_LONG);CHKERRQ(ierr); /* unique identifer */
189   ierr = DMSwarmRegisterPetscDatatypeField(dm,"DMSwarm_rank",1,PETSC_INT);CHKERRQ(ierr); /* used for communication */
190 
191   PetscFunctionReturn(0);
192 }
193 
194 #undef __FUNCT__
195 #define __FUNCT__ "DMSwarmFinalizeFieldRegister"
196 PETSC_EXTERN PetscErrorCode DMSwarmFinalizeFieldRegister(DM dm)
197 {
198   DM_Swarm *swarm = (DM_Swarm*)dm->data;
199   PetscErrorCode ierr;
200 
201   swarm->field_registration_finalized = PETSC_TRUE;
202   ierr = DataBucketFinalize(swarm->db);CHKERRQ(ierr);
203   PetscFunctionReturn(0);
204 }
205 
206 #undef __FUNCT__
207 #define __FUNCT__ "DMSwarmSetLocalSizes"
208 PETSC_EXTERN PetscErrorCode DMSwarmSetLocalSizes(DM dm,PetscInt nlocal,PetscInt buffer)
209 {
210   DM_Swarm *swarm = (DM_Swarm*)dm->data;
211   PetscErrorCode ierr;
212 
213   ierr = DataBucketSetSizes(swarm->db,nlocal,buffer);CHKERRQ(ierr);
214 
215   PetscFunctionReturn(0);
216 }
217 
218 #undef __FUNCT__
219 #define __FUNCT__ "DMSwarmGetLocalSize"
220 PETSC_EXTERN PetscErrorCode DMSwarmGetLocalSize(DM dm,PetscInt *nlocal)
221 {
222   DM_Swarm *swarm = (DM_Swarm*)dm->data;
223   PetscErrorCode ierr;
224 
225   if (nlocal) {
226     ierr = DataBucketGetSizes(swarm->db,nlocal,NULL,NULL);CHKERRQ(ierr);
227   }
228 
229   PetscFunctionReturn(0);
230 }
231 
232 #undef __FUNCT__
233 #define __FUNCT__ "DMSwarmGetSize"
234 PETSC_EXTERN PetscErrorCode DMSwarmGetSize(DM dm,PetscInt *n)
235 {
236   DM_Swarm *swarm = (DM_Swarm*)dm->data;
237   PetscErrorCode ierr;
238   PetscInt nlocal,ng;
239 
240   ierr = DataBucketGetSizes(swarm->db,&nlocal,NULL,NULL);CHKERRQ(ierr);
241   ierr = MPI_Allreduce(&nlocal,&ng,1,MPIU_INT,MPI_SUM,PetscObjectComm((PetscObject)dm));CHKERRQ(ierr);
242   if (n) { *n = ng; }
243   PetscFunctionReturn(0);
244 }
245 
246 #undef __FUNCT__
247 #define __FUNCT__ "DMSwarmRegisterPetscDatatypeField"
248 PETSC_EXTERN PetscErrorCode DMSwarmRegisterPetscDatatypeField(DM dm,const char fieldname[],PetscInt blocksize,PetscDataType type)
249 {
250   PetscErrorCode ierr;
251   DM_Swarm *swarm = (DM_Swarm*)dm->data;
252   size_t size;
253 
254   if (!swarm->field_registration_initialized) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Must call DMSwarmInitializeFieldRegister() first");
255   if (swarm->field_registration_finalized) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Cannot register additional fields after calling DMSwarmFinalizeFieldRegister() first");
256 
257   if (type == PETSC_OBJECT) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Valid for {char,short,int,long,float,double}");
258   if (type == PETSC_FUNCTION) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Valid for {char,short,int,long,float,double}");
259   if (type == PETSC_STRING) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Valid for {char,short,int,long,float,double}");
260   if (type == PETSC_STRUCT) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Valid for {char,short,int,long,float,double}");
261   if (type == PETSC_DATATYPE_UNKNOWN) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Valid for {char,short,int,long,float,double}");
262 
263   switch (type) {
264     case PETSC_CHAR:
265       size = sizeof(PetscChar);
266       break;
267     case PETSC_SHORT:
268       size = sizeof(PetscShort);
269       break;
270     case PETSC_INT:
271       size = sizeof(PetscInt);
272       break;
273     case PETSC_LONG:
274       size = sizeof(Petsc64bitInt);
275       break;
276     case PETSC_FLOAT:
277       size = sizeof(PetscFloat);
278       break;
279     case PETSC_DOUBLE:
280       size = sizeof(PetscReal);
281       break;
282 
283     default:
284       SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Valid for {char,short,int,long,float,double}");
285       break;
286   }
287 
288   /* Load a specific data type into data bucket, specifying textual name and its size in bytes */
289 	ierr = DataBucketRegisterField(swarm->db,"DMSwarmRegisterPetscDatatypeField",fieldname,blocksize*size,NULL);CHKERRQ(ierr);
290   {
291     DataField gfield;
292 
293     ierr = DataBucketGetDataFieldByName(swarm->db,fieldname,&gfield);CHKERRQ(ierr);
294     ierr = DataFieldSetBlockSize(gfield,blocksize);CHKERRQ(ierr);
295   }
296   swarm->db->field[swarm->db->nfields-1]->petsc_type = type;
297 
298   PetscFunctionReturn(0);
299 }
300 
301 #undef __FUNCT__
302 #define __FUNCT__ "DMSwarmRegisterUserStructField"
303 PETSC_EXTERN PetscErrorCode DMSwarmRegisterUserStructField(DM dm,const char fieldname[],size_t size)
304 {
305   PetscErrorCode ierr;
306   DM_Swarm *swarm = (DM_Swarm*)dm->data;
307 
308 	ierr = DataBucketRegisterField(swarm->db,"DMSwarmRegisterUserStructField",fieldname,size,NULL);CHKERRQ(ierr);
309   swarm->db->field[swarm->db->nfields-1]->petsc_type = PETSC_STRUCT ;
310 
311   PetscFunctionReturn(0);
312 }
313 
314 #undef __FUNCT__
315 #define __FUNCT__ "DMSwarmRegisterUserDatatypeField"
316 PETSC_EXTERN PetscErrorCode DMSwarmRegisterUserDatatypeField(DM dm,const char fieldname[],size_t size)
317 {
318   DM_Swarm *swarm = (DM_Swarm*)dm->data;
319   PetscErrorCode ierr;
320 
321 	ierr = DataBucketRegisterField(swarm->db,"DMSwarmRegisterUserDatatypeField",fieldname,size,NULL);CHKERRQ(ierr);
322   swarm->db->field[swarm->db->nfields-1]->petsc_type = PETSC_DATATYPE_UNKNOWN;
323 
324   PetscFunctionReturn(0);
325 }
326 
327 #undef __FUNCT__
328 #define __FUNCT__ "DMSwarmGetField"
329 PETSC_EXTERN PetscErrorCode DMSwarmGetField(DM dm,const char fieldname[],PetscInt *blocksize,PetscDataType *type,void **data)
330 {
331   DM_Swarm *swarm = (DM_Swarm*)dm->data;
332   DataField gfield;
333   PetscErrorCode ierr;
334 
335   if (!swarm->issetup) { ierr = DMSetUp(dm);CHKERRQ(ierr); }
336 
337   ierr = DataBucketGetDataFieldByName(swarm->db,fieldname,&gfield);CHKERRQ(ierr);
338   ierr = DataFieldGetAccess(gfield);CHKERRQ(ierr);
339   ierr = DataFieldGetEntries(gfield,data);CHKERRQ(ierr);
340   if (blocksize) {}
341   if (type) { *type = gfield->petsc_type; }
342 
343   PetscFunctionReturn(0);
344 }
345 
346 #undef __FUNCT__
347 #define __FUNCT__ "DMSwarmRestoreField"
348 PETSC_EXTERN PetscErrorCode DMSwarmRestoreField(DM dm,const char fieldname[],PetscInt *blocksize,PetscDataType *type,void **data)
349 {
350   DM_Swarm *swarm = (DM_Swarm*)dm->data;
351   DataField gfield;
352   PetscErrorCode ierr;
353 
354   ierr = DataBucketGetDataFieldByName(swarm->db,fieldname,&gfield);CHKERRQ(ierr);
355   ierr = DataFieldRestoreAccess(gfield);CHKERRQ(ierr);
356   if (data) *data = NULL;
357 
358   PetscFunctionReturn(0);
359 }
360 
361 #undef __FUNCT__
362 #define __FUNCT__ "DMSwarmAddPoint"
363 PETSC_EXTERN PetscErrorCode DMSwarmAddPoint(DM dm)
364 {
365   DM_Swarm *swarm = (DM_Swarm*)dm->data;
366   PetscErrorCode ierr;
367 
368   if (!swarm->issetup) { ierr = DMSetUp(dm);CHKERRQ(ierr); }
369   ierr = DataBucketAddPoint(swarm->db);CHKERRQ(ierr);
370   PetscFunctionReturn(0);
371 }
372 
373 #undef __FUNCT__
374 #define __FUNCT__ "DMSwarmAddNPoints"
375 PETSC_EXTERN PetscErrorCode DMSwarmAddNPoints(DM dm,PetscInt npoints)
376 {
377   DM_Swarm *swarm = (DM_Swarm*)dm->data;
378   PetscErrorCode ierr;
379   PetscInt nlocal;
380 
381   ierr = DataBucketGetSizes(swarm->db,&nlocal,NULL,NULL);CHKERRQ(ierr);
382   nlocal = nlocal + npoints;
383   ierr = DataBucketSetSizes(swarm->db,nlocal,-1);CHKERRQ(ierr);
384   PetscFunctionReturn(0);
385 }
386 
387 #undef __FUNCT__
388 #define __FUNCT__ "DMSwarmRemovePoint"
389 PETSC_EXTERN PetscErrorCode DMSwarmRemovePoint(DM dm)
390 {
391   DM_Swarm *swarm = (DM_Swarm*)dm->data;
392   PetscErrorCode ierr;
393 
394   ierr = DataBucketRemovePoint(swarm->db);CHKERRQ(ierr);
395   PetscFunctionReturn(0);
396 }
397 
398 #undef __FUNCT__
399 #define __FUNCT__ "DMSwarmRemovePointAtIndex"
400 PETSC_EXTERN PetscErrorCode DMSwarmRemovePointAtIndex(DM dm,PetscInt idx)
401 {
402   DM_Swarm *swarm = (DM_Swarm*)dm->data;
403   PetscErrorCode ierr;
404 
405   ierr = DataBucketRemovePointAtIndex(swarm->db,idx);CHKERRQ(ierr);
406   PetscFunctionReturn(0);
407 }
408 
409 #undef __FUNCT__
410 #define __FUNCT__ "DMSwarmMigrate_Basic"
411 PetscErrorCode DMSwarmMigrate_Basic(DM dm,PetscBool remove_sent_points)
412 {
413   PetscErrorCode ierr;
414   ierr = DMSwarmMigrate_Push_Basic(dm,remove_sent_points);CHKERRQ(ierr);
415   PetscFunctionReturn(0);
416 }
417 
418 #undef __FUNCT__
419 #define __FUNCT__ "DMSwarmMigrate"
420 PETSC_EXTERN PetscErrorCode DMSwarmMigrate(DM dm,PetscBool remove_sent_points)
421 {
422   PetscErrorCode ierr;
423   ierr = DMSwarmMigrate_Basic(dm,remove_sent_points);CHKERRQ(ierr);
424   PetscFunctionReturn(0);
425 }
426 
427 #undef __FUNCT__
428 #define __FUNCT__ "DMSwarmGlobalToLocalViewCreate"
429 PETSC_EXTERN PetscErrorCode DMSwarmGlobalToLocalViewCreate(DM dm,InsertMode mode)
430 {
431   PetscErrorCode ierr;
432   DM_Swarm *swarm = (DM_Swarm*)dm->data;
433   PetscInt ng;
434 
435   if (mode != INSERT_VALUES) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Only mode INSERT_VALUES is supported");
436 
437   ierr = DMSwarmMigrate_GlobalToLocal_Basic(dm,&ng);CHKERRQ(ierr);
438   swarm->view_ng = ng;
439 
440   PetscFunctionReturn(0);
441 }
442 
443 #undef __FUNCT__
444 #define __FUNCT__ "DMSwarmGlobalToLocalViewDestroy"
445 PETSC_EXTERN PetscErrorCode DMSwarmGlobalToLocalViewDestroy(DM dm,InsertMode mode)
446 {
447   PetscErrorCode ierr;
448   DM_Swarm *swarm = (DM_Swarm*)dm->data;
449 
450   if (mode != INSERT_VALUES) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"Only mode INSERT_VALUES is supported");
451 
452   ierr = DMSwarmSetLocalSizes(dm,swarm->view_ng,-1);CHKERRQ(ierr);
453 
454   PetscFunctionReturn(0);
455 }
456 
457 #undef __FUNCT__
458 #define __FUNCT__ "DMSetup_Swarm"
459 PetscErrorCode DMSetup_Swarm(DM dm)
460 {
461   DM_Swarm *swarm = (DM_Swarm*)dm->data;
462   PetscErrorCode ierr;
463   PetscMPIInt rank;
464   PetscInt p,npoints,*rankval;
465 
466   if (swarm->issetup) PetscFunctionReturn(0);
467 
468   PetscPrintf(PETSC_COMM_SELF,"Swarm setup \n");
469   swarm->issetup = PETSC_TRUE;
470 
471   /* check some fields were registered */
472   if (swarm->db->nfields <= 2) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"At least one field user must be registered via DMSwarmRegisterXXX()");
473 
474   /* check local sizes were set */
475   if (swarm->db->L == -1) SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_USER,"Local sizes must be set via DMSwarmSetLocalSizes()");
476 
477   /* initialize values in pid and rank placeholders */
478   /* TODO: [pid - use MPI_Scan] */
479 
480   ierr = MPI_Comm_rank(PetscObjectComm((PetscObject)dm),&rank);CHKERRQ(ierr);
481   ierr = DataBucketGetSizes(swarm->db,&npoints,NULL,NULL);CHKERRQ(ierr);
482   ierr = DMSwarmGetField(dm,"DMSwarm_rank",NULL,NULL,(void**)&rankval);CHKERRQ(ierr);
483   for (p=0; p<npoints; p++) {
484     rankval[p] = (PetscInt)rank;
485   }
486   ierr = DMSwarmRestoreField(dm,"DMSwarm_rank",NULL,NULL,(void**)&rankval);CHKERRQ(ierr);
487 
488   PetscFunctionReturn(0);
489 }
490 
491 #undef __FUNCT__
492 #define __FUNCT__ "DMDestroy_Swarm"
493 PetscErrorCode DMDestroy_Swarm(DM dm)
494 {
495   DM_Swarm *swarm = (DM_Swarm*)dm->data;
496   PetscErrorCode ierr;
497 
498   PetscFunctionBegin;
499   ierr = DataBucketDestroy(&swarm->db);CHKERRQ(ierr);
500   ierr = PetscFree(swarm);CHKERRQ(ierr);
501   PetscFunctionReturn(0);
502 }
503 
504 #undef __FUNCT__
505 #define __FUNCT__ "DMView_Swarm"
506 PetscErrorCode DMView_Swarm(DM dm, PetscViewer viewer)
507 {
508   DM_Swarm *swarm = (DM_Swarm*)dm->data;
509   PetscBool      iascii,ibinary,ishdf5,isvtk;
510   PetscErrorCode ierr;
511 
512   PetscFunctionBegin;
513   PetscValidHeaderSpecific(dm,DM_CLASSID,1);
514   PetscValidHeaderSpecific(viewer,PETSC_VIEWER_CLASSID,2);
515   ierr = PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERASCII, &iascii);CHKERRQ(ierr);
516   ierr = PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERBINARY,&ibinary);CHKERRQ(ierr);
517   ierr = PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERVTK,   &isvtk);CHKERRQ(ierr);
518   ierr = PetscObjectTypeCompare((PetscObject)viewer, PETSCVIEWERHDF5,  &ishdf5);CHKERRQ(ierr);
519   if (iascii) {
520     ierr = DataBucketView(PetscObjectComm((PetscObject)dm),swarm->db,NULL,DATABUCKET_VIEW_STDOUT);CHKERRQ(ierr);
521   } else if (ibinary) {
522     SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"NO VTK support");
523   } else if (ishdf5) {
524 #if defined(PETSC_HAVE_HDF5)
525     SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"NO HDF5 support");
526 #else
527     SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"HDF5 not supported. Please reconfigure using --download-hdf5");
528 #endif
529   } else if (isvtk) {
530     SETERRQ(PetscObjectComm((PetscObject)dm),PETSC_ERR_SUP,"NO VTK support");
531   }
532   PetscFunctionReturn(0);
533 }
534 
535 #undef __FUNCT__
536 #define __FUNCT__ "DMCreate_Swarm"
537 PETSC_EXTERN PetscErrorCode DMCreate_Swarm(DM dm)
538 {
539   DM_Swarm      *swarm;
540   PetscErrorCode ierr;
541 
542   PetscFunctionBegin;
543   PetscValidHeaderSpecific(dm, DM_CLASSID, 1);
544   ierr     = PetscNewLog(dm,&swarm);CHKERRQ(ierr);
545 
546   ierr = DataBucketCreate(&swarm->db);CHKERRQ(ierr);
547   swarm->vec_field_set = PETSC_FALSE;
548   swarm->issetup = PETSC_FALSE;
549 
550   dm->dim  = 0;
551   dm->data = swarm;
552 
553   dm->ops->view                            = DMView_Swarm;
554   dm->ops->load                            = NULL;
555   dm->ops->setfromoptions                  = NULL;
556   dm->ops->clone                           = NULL;
557   dm->ops->setup                           = DMSetup_Swarm;
558   dm->ops->createdefaultsection            = NULL;
559   dm->ops->createdefaultconstraints        = NULL;
560   dm->ops->createglobalvector              = DMCreateGlobalVector_Swarm;
561   dm->ops->createlocalvector               = DMCreateLocalVector_Swarm;
562   dm->ops->getlocaltoglobalmapping         = NULL;
563   dm->ops->createfieldis                   = NULL;
564   dm->ops->createcoordinatedm              = NULL;
565   dm->ops->getcoloring                     = NULL;
566   dm->ops->creatematrix                    = NULL;
567   dm->ops->createinterpolation             = NULL;
568   dm->ops->getaggregates                   = NULL;
569   dm->ops->getinjection                    = NULL;
570   dm->ops->refine                          = NULL;
571   dm->ops->coarsen                         = NULL;
572   dm->ops->refinehierarchy                 = NULL;
573   dm->ops->coarsenhierarchy                = NULL;
574   dm->ops->globaltolocalbegin              = NULL;
575   dm->ops->globaltolocalend                = NULL;
576   dm->ops->localtoglobalbegin              = NULL;
577   dm->ops->localtoglobalend                = NULL;
578   dm->ops->destroy                         = DMDestroy_Swarm;
579   dm->ops->createsubdm                     = NULL;
580   dm->ops->getdimpoints                    = NULL;
581   dm->ops->locatepoints                    = NULL;
582 
583   PetscFunctionReturn(0);
584 }