xref: /petsc/include/petscdmlabel.h (revision ebead697dbf761eb322f829370bbe90b3bd93fa3)
1 #if !defined(PETSCDMLABEL_H)
2 #define PETSCDMLABEL_H
3 #include <petscis.h>
4 
5 /* SUBMANSEC = DMLabel */
6 
7 /*S
8   DMLabel - Object which encapsulates a subset of the mesh from this DM
9 
10   Level: developer
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 DMLabelCompare(MPI_Comm, DMLabel, DMLabel, PetscBool *, char **message);
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 DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]);
28 PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS);
29 PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt);
30 PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *);
31 PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *);
32 PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *);
33 PETSC_EXTERN PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel, IS *);
34 PETSC_EXTERN PetscErrorCode DMLabelGetValueIndex(DMLabel, PetscInt, PetscInt *);
35 PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *);
36 PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *);
37 PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *);
38 PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *);
39 PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS);
40 PETSC_EXTERN PetscErrorCode DMLabelSetStratumBounds(DMLabel, PetscInt, PetscInt, PetscInt);
41 PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt);
42 PETSC_EXTERN PetscErrorCode DMLabelGetStratumPointIndex(DMLabel, PetscInt, PetscInt, PetscInt *);
43 
44 PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel);
45 PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt);
46 PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel);
47 PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *);
48 PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *);
49 PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *);
50 PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt);
51 PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *);
52 PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *);
53 PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *);
54 PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *);
55 
56 PETSC_EXTERN PetscErrorCode DMLabelPropagateBegin(DMLabel, PetscSF);
57 PETSC_EXTERN PetscErrorCode DMLabelPropagatePush(DMLabel, PetscSF, PetscErrorCode (*)(DMLabel, PetscInt, PetscInt, void *), void *);
58 PETSC_EXTERN PetscErrorCode DMLabelPropagateEnd(DMLabel, PetscSF);
59 
60 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *);
61 
62 #define PETSCSECTIONSYMLABEL "label"
63 PETSC_EXTERN PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm,DMLabel,PetscSectionSym *);
64 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym,DMLabel);
65 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym, PetscInt, PetscInt*, PetscInt*, PetscInt*, const PetscInt ***, const PetscScalar ***);
66 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym, PetscInt, PetscInt, PetscInt, PetscInt, PetscCopyMode, const PetscInt **, const PetscScalar **);
67 
68 #endif
69