DMSwarmCollectType — PETSc 3.25.4 documentation

Skip to main content
`Ctrl`+`K`

# DMSwarmCollectType

Selects the algorithm used by `DMSwarmCollectViewCreate()` to gather particles from neighboring subdomains into a temporary view

## Synopsis

    typedef enum {
      DMSWARM_COLLECT_BASIC,
      DMSWARM_COLLECT_DMDABOUNDINGBOX,
      DMSWARM_COLLECT_GENERAL,
      DMSWARM_COLLECT_USER
    } DMSwarmCollectType;

## Values

- `DMSWARM_COLLECT_BASIC` - simply concatenate every particle from every other process (used mainly for testing)

- `DMSWARM_COLLECT_DMDABOUNDINGBOX` - collect particles that lie inside the local subdomain bounding box of an attached `DMDA`

- `DMSWARM_COLLECT_GENERAL` - collect particles that lie inside a user-specified region of space

- `DMSWARM_COLLECT_USER` - call a user-supplied collection function

## See Also

DM Basics, `DM`, `DMSWARM`, `DMSwarmCollectViewCreate()`, `DMSwarmMigrate()`

## Level

intermediate

## Location

include/petscdmswarm.h

Index of all DMSwarm routines
Table of Contents for all manual pages
Index of all manual pages