1 #ifndef PETSCDMLABEL_H 2 #define PETSCDMLABEL_H 3 #include <petscis.h> 4 5 PETSC_EXTERN PetscClassId DMLABEL_CLASSID; 6 7 typedef const char *DMLabelType; 8 #define DMLABELCONCRETE "concrete" 9 #define DMLABELEPHEMERAL "ephemeral" 10 11 /* SUBMANSEC = DMLabel */ 12 13 /*S 14 DMLabel - Object which encapsulates a subset of the mesh from a `DM` 15 16 Level: developer 17 18 Note: 19 A label consists of a set of points on a `DM` 20 21 .seealso: `DM`, `DMPlexCreate()`, `DMLabelCreate()`, `DMLabelView()`, `DMLabelDestroy()`, `DMPlexCreateLabel()`, 22 `DMLabelGetDefaultValue()`, `DMLabelSetDefaultValue()`, `DMLabelDuplicate()`, `DMLabelGetValue()`, `DMLabelSetValue()`, 23 `DMLabelAddStratum()`, `DMLabelAddStrata()`, `DMLabelInsertIS()`, `DMLabelGetNumValues()`, `DMLabelGetValueIS()`, 24 `DMLabelGetStratumSize()`, `DMLabelComputeIndex()`, `DMLabelDestroyIndex()`, `DMLabelDistribute()`, `DMLabelConvertToSection()` 25 S*/ 26 typedef struct _p_DMLabel *DMLabel; 27 28 PETSC_EXTERN PetscFunctionList DMLabelList; 29 PETSC_EXTERN PetscErrorCode DMLabelCreate(MPI_Comm, const char[], DMLabel *); 30 PETSC_EXTERN PetscErrorCode DMLabelSetType(DMLabel, DMLabelType); 31 PETSC_EXTERN PetscErrorCode DMLabelGetType(DMLabel, DMLabelType *); 32 PETSC_EXTERN PetscErrorCode DMLabelRegister(const char[], PetscErrorCode (*)(DMLabel)); 33 PETSC_EXTERN PetscErrorCode DMLabelRegisterAll(void); 34 PETSC_EXTERN PetscErrorCode DMLabelRegisterDestroy(void); 35 PETSC_EXTERN PetscErrorCode DMLabelSetUp(DMLabel); 36 PETSC_EXTERN PetscErrorCode DMLabelSetFromOptions(DMLabel); 37 PETSC_EXTERN PetscErrorCode DMLabelView(DMLabel, PetscViewer); 38 PETSC_EXTERN PetscErrorCode DMLabelDuplicate(DMLabel, DMLabel *); 39 PETSC_EXTERN PetscErrorCode DMLabelReset(DMLabel); 40 PETSC_EXTERN PetscErrorCode DMLabelDestroy(DMLabel *); 41 42 PETSC_EXTERN PetscErrorCode DMLabelGetDefaultValue(DMLabel, PetscInt *); 43 PETSC_EXTERN PetscErrorCode DMLabelSetDefaultValue(DMLabel, PetscInt); 44 PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *); 45 PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt); 46 PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt); 47 PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt); 48 PETSC_EXTERN PetscErrorCode DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]); 49 PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS); 50 PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt); 51 PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *); 52 PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *); 53 PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *); 54 PETSC_EXTERN PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel, IS *); 55 PETSC_EXTERN PetscErrorCode DMLabelGetValueIndex(DMLabel, PetscInt, PetscInt *); 56 PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *); 57 PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *); 58 PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *); 59 PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *); 60 PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS); 61 PETSC_EXTERN PetscErrorCode DMLabelSetStratumBounds(DMLabel, PetscInt, PetscInt, PetscInt); 62 PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt); 63 PETSC_EXTERN PetscErrorCode DMLabelGetStratumPointIndex(DMLabel, PetscInt, PetscInt, PetscInt *); 64 65 PETSC_EXTERN PetscErrorCode DMLabelCompare(MPI_Comm, DMLabel, DMLabel, PetscBool *, char **message); 66 PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel); 67 PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt); 68 PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel); 69 PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *); 70 PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *); 71 PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *); 72 PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt); 73 PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *); 74 PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *); 75 PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *); 76 PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *); 77 78 PETSC_EXTERN PetscErrorCode DMLabelPropagateBegin(DMLabel, PetscSF); 79 PETSC_EXTERN PetscErrorCode DMLabelPropagatePush(DMLabel, PetscSF, PetscErrorCode (*)(DMLabel, PetscInt, PetscInt, void *), void *); 80 PETSC_EXTERN PetscErrorCode DMLabelPropagateEnd(DMLabel, PetscSF); 81 82 PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *); 83 84 #define PETSCSECTIONSYMLABEL "label" 85 PETSC_EXTERN PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm, DMLabel, PetscSectionSym *); 86 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym, DMLabel); 87 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym, PetscInt, PetscInt *, PetscInt *, PetscInt *, const PetscInt ***, const PetscScalar ***); 88 PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym, PetscInt, PetscInt, PetscInt, PetscInt, PetscCopyMode, const PetscInt **, const PetscScalar **); 89 90 #endif 91