petsc-main 2021-04-20
Report Typos and Errors

PetscDSGetBoundary

Gets a boundary condition to the model

Synopsis

#include "petscds.h" 
PetscErrorCode PetscDSGetBoundary(PetscDS ds, PetscInt bd, PetscWeakForm *wf, DMBoundaryConditionType *type, const char *name[], DMLabel *label, PetscInt *Nv, const PetscInt *values[], PetscInt *field, PetscInt *Nc, const PetscInt *comps[], void (**func)(void), void (**func_t)(void), void **ctx)

Input Parameters

ds - The PetscDS object
bd - The BC number

Output Parameters

wf - The PetscWeakForm holding the pointwise functions
type - The type of condition, e.g. DM_BC_ESSENTIAL/DM_BC_ESSENTIAL_FIELD (Dirichlet), or DM_BC_NATURAL (Neumann)
name - The BC name
label - The label defining constrained points
Nv - The number of DMLabel ids for constrained points
values - An array of ids for constrained points
field - The field to constrain
Nc - The number of constrained field components
comps - An array of constrained component numbers
bcFunc - A pointwise function giving boundary values
bcFunc_t - A pointwise function giving the time derviative of the boundary values
ctx - An optional user context for bcFunc

Options Database Keys

-bc_<boundary name> <num> - Overrides the boundary ids
-bc_<boundary name>_comp <num> - Overrides the boundary components

See Also

PetscDSAddBoundary()

Level

developer

Location

src/dm/dt/interface/dtds.c

Examples

src/snes/tutorials/ex12.c.html
src/snes/tutorials/ex17.c.html
src/snes/tutorials/ex56.c.html
src/snes/tutorials/ex77.c.html

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