xref: /petsc/include/petscdmlabel.h (revision 5dc64a9727a0cc1147601b21df2b9dcd374fa7c9)
1 #if !defined(__PETSCDMLABEL_H)
2 #define __PETSCDMLABEL_H
3 #include <petscis.h>
4 
5 /*S
6   DMLabel - Object which encapsulates a subset of the mesh from this DM
7 
8   Level: developer
9 
10   Concepts: grids, grid refinement
11 
12 .seealso:  DM, DMPlexCreate(), DMPlexCreateLabel()
13 S*/
14 typedef struct _p_DMLabel *DMLabel;
15 PETSC_EXTERN PetscErrorCode DMLabelCreate(MPI_Comm, const char [], DMLabel *);
16 PETSC_EXTERN PetscErrorCode DMLabelView(DMLabel, PetscViewer);
17 PETSC_EXTERN PetscErrorCode DMLabelReset(DMLabel);
18 PETSC_EXTERN PetscErrorCode DMLabelDestroy(DMLabel *);
19 PETSC_EXTERN PetscErrorCode DMLabelGetDefaultValue(DMLabel, PetscInt *);
20 PETSC_EXTERN PetscErrorCode DMLabelSetDefaultValue(DMLabel, PetscInt);
21 PETSC_EXTERN PetscErrorCode DMLabelDuplicate(DMLabel, DMLabel *);
22 PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *);
23 PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt);
24 PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt);
25 PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt);
26 PETSC_EXTERN PetscErrorCode DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]);
27 PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS);
28 PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt);
29 PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *);
30 PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *);
31 PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *);
32 PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *);
33 PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *);
34 PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *);
35 PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *);
36 PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS);
37 PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt);
38 
39 PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel);
40 PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt);
41 PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel);
42 PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *);
43 PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *);
44 PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *);
45 PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt);
46 PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *);
47 PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *);
48 PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *);
49 PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *);
50 
51 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *);
52 
53 #define PETSCSECTIONSYMLABEL "label"
54 PETSC_EXTERN PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm,DMLabel,PetscSectionSym *);
55 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym,DMLabel);
56 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym,PetscInt,PetscInt,PetscInt,PetscInt,PetscCopyMode,const PetscInt **,const PetscScalar **);
57 
58 #endif
59