xref: /petsc/include/petscdmlabel.h (revision 4fc747eaadbeca11629f314a99edccbc2ed7b3d3)
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 _n_DMLabel *DMLabel;
15 PETSC_EXTERN PetscErrorCode DMLabelCreate(const char [], DMLabel *);
16 PETSC_EXTERN PetscErrorCode DMLabelView(DMLabel, PetscViewer);
17 PETSC_EXTERN PetscErrorCode DMLabelDestroy(DMLabel *);
18 PETSC_EXTERN PetscErrorCode DMLabelGetState(DMLabel, PetscObjectState *);
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 DMLabelGetName(DMLabel, const char **);
23 PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *);
24 PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt);
25 PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt);
26 PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt);
27 PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt);
28 PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *);
29 PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *);
30 PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *);
31 PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *);
32 PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *);
33 PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *);
34 PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *);
35 PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt);
36 PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt);
37 PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel);
38 PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *);
39 PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *);
40 PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt);
41 PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *);
42 PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *);
43 PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *);
44 PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *);
45 
46 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *);
47 
48 #endif
49