Skip to main content
Ctrl+K
PETSc v3.25.5-968-g5b51e5f1332b documentation - Home
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • DMSwarmMigrate

DMSwarmMigrate#

Relocates points defined in the DMSWARM to other MPI-ranks

Synopsis#

#include "petscdmswarm.h"   
PetscErrorCode DMSwarmMigrate(DM dm, PetscBool remove_sent_points)

Collective

Input Parameters#

  • dm - the DMSWARM

  • remove_sent_points - flag indicating if sent points should be removed from the current MPI-rank

Notes#

The DM will be modified to accommodate received points. If remove_sent_points is PETSC_TRUE, any points that were sent will be removed from the DM. Different styles of migration are supported. See DMSwarmSetMigrateType().

See Also#

DM, DMSWARM, DMSwarmSetMigrateType()

Level#

advanced

Location#

src/dm/impls/swarm/swarm.c

Examples#

src/dm/impls/swarm/tutorials/ex1.c
src/dm/impls/swarm/tutorials/ex1f90.F90
src/dm/tutorials/ex20.c
src/dm/tutorials/ex21.c
src/dm/tutorials/swarm_ex1.c
src/dm/tutorials/swarm_ex3.c
src/dm/impls/da/tests/ex1.c
src/dm/impls/swarm/tests/ex1.c
src/dm/impls/swarm/tests/ex12.c
src/dm/impls/swarm/tests/ex2.c

Implementations#

DMSwarmMigrate_Basic() in src/dm/impls/swarm/swarm.c
DMSwarmMigrate_DMNeighborScatter() in src/dm/impls/swarm/swarm_migrate.c
DMSwarmMigrate_CellDMScatter() in src/dm/impls/swarm/swarm_migrate.c
DMSwarmMigrate_CellDMExact() in src/dm/impls/swarm/swarm_migrate.c


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

On this page
  • Synopsis
  • Input Parameters
  • Notes
  • See Also
  • Level
  • Location
  • Examples
  • Implementations
Edit on GitLab
Show Source

© Copyright 1991-2026, UChicago Argonne, LLC and the PETSc Development Team.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.1.

Last updated on 2026-09-19T03:38:49-0500 (v3.25.5-968-g5b51e5f1332b).