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 a `DM` 9 10 Level: developer 11 12 Note: 13 A label consists of a set of points on a `DM` 14 15 .seealso: `DM`, `DMPlexCreate()`, `DMLabelCreate()`, `DMLabelView()`, `DMLabelDestroy()`, `DMPlexCreateLabel()`, 16 `DMLabelGetDefaultValue()`, `DMLabelSetDefaultValue()`, `DMLabelDuplicate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, 17 `DMLabelAddStratum()`, `DMLabelAddStrata()`, `DMLabelInsertIS()`, `DMLabelGetNumValues()`, `DMLabelGetValueIS()`, 18 `DMLabelGetStratumSize()`, `DMLabelComputeIndex()`, `DMLabelDestroyIndex()`, `DMLabelDistribute()`, `DMLabelConvertToSection()` 19 S*/ 20 typedef struct _p_DMLabel *DMLabel; 21 22 PETSC_EXTERN PetscErrorCode DMLabelCreate(MPI_Comm, const char[], DMLabel *); 23 PETSC_EXTERN PetscErrorCode DMLabelView(DMLabel, PetscViewer); 24 PETSC_EXTERN PetscErrorCode DMLabelReset(DMLabel); 25 PETSC_EXTERN PetscErrorCode DMLabelDestroy(DMLabel *); 26 PETSC_EXTERN PetscErrorCode DMLabelGetDefaultValue(DMLabel, PetscInt *); 27 PETSC_EXTERN PetscErrorCode DMLabelSetDefaultValue(DMLabel, PetscInt); 28 PETSC_EXTERN PetscErrorCode DMLabelDuplicate(DMLabel, DMLabel *); 29 PETSC_EXTERN PetscErrorCode DMLabelCompare(MPI_Comm, DMLabel, DMLabel, PetscBool *, char **message); 30 PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *); 31 PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt); 32 PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt); 33 PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt); 34 PETSC_EXTERN PetscErrorCode DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]); 35 PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS); 36 PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt); 37 PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *); 38 PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *); 39 PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *); 40 PETSC_EXTERN PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel, IS *); 41 PETSC_EXTERN PetscErrorCode DMLabelGetValueIndex(DMLabel, PetscInt, PetscInt *); 42 PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *); 43 PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *); 44 PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *); 45 PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *); 46 PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS); 47 PETSC_EXTERN PetscErrorCode DMLabelSetStratumBounds(DMLabel, PetscInt, PetscInt, PetscInt); 48 PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt); 49 PETSC_EXTERN PetscErrorCode DMLabelGetStratumPointIndex(DMLabel, PetscInt, PetscInt, PetscInt *); 50 51 PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel); 52 PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt); 53 PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel); 54 PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *); 55 PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *); 56 PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *); 57 PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt); 58 PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *); 59 PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *); 60 PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *); 61 PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *); 62 63 PETSC_EXTERN PetscErrorCode DMLabelPropagateBegin(DMLabel, PetscSF); 64 PETSC_EXTERN PetscErrorCode DMLabelPropagatePush(DMLabel, PetscSF, PetscErrorCode (*)(DMLabel, PetscInt, PetscInt, void *), void *); 65 PETSC_EXTERN PetscErrorCode DMLabelPropagateEnd(DMLabel, PetscSF); 66 67 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *); 68 69 #define PETSCSECTIONSYMLABEL "label" 70 PETSC_EXTERN PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm, DMLabel, PetscSectionSym *); 71 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym, DMLabel); 72 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym, PetscInt, PetscInt *, PetscInt *, PetscInt *, const PetscInt ***, const PetscScalar ***); 73 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym, PetscInt, PetscInt, PetscInt, PetscInt, PetscCopyMode, const PetscInt **, const PetscScalar **); 74 75 #endif 76