petsc-master 2020-11-24
Report Typos and Errors

DMSetPeriodicity

Set the description of mesh periodicity

Synopsis

#include "petscdm.h"          
#include "petscdmlabel.h"     
#include "petscds.h"     
PetscErrorCode DMSetPeriodicity(DM dm, PetscBool per, const PetscReal maxCell[], const PetscReal L[], const DMBoundaryType bd[])

Input Parameters

dm - The DM object
per - Whether the DM is periodic or not.
maxCell - Over distances greater than this, we can assume a point has crossed over to another sheet, when trying to localize cell coordinates. Pass NULL to remove such information.
L - If we assume the mesh is a torus, this is the length of each coordinate
bd - This describes the type of periodicity in each topological dimension

Notes: If per is PETSC_TRUE and maxCell is not provided, coordinates need to be already localized, or must be localized by hand by the user.

See Also

DMGetPeriodicity()

Level

developer

Location

src/dm/interface/dm.c
Index of all DM routines
Table of Contents for all manual pages
Index of all manual pages