xref: /petsc/include/petscdmlabel.h (revision ce78bad369055609e946c9d2c25ea67a45873e27)
1a4963045SJacob Faibussowitsch #pragma once
2c58f1c22SToby Isaac #include <petscis.h>
3c58f1c22SToby Isaac 
4*ce78bad3SBarry Smith /* SUBMANSEC = DM */
5*ce78bad3SBarry Smith 
69f6c5813SMatthew G. Knepley PETSC_EXTERN PetscClassId DMLABEL_CLASSID;
79f6c5813SMatthew G. Knepley 
8*ce78bad3SBarry Smith #include <petscdmlabeltypes.h>
9a1cc8097SBarry Smith 
109f6c5813SMatthew G. Knepley PETSC_EXTERN PetscFunctionList DMLabelList;
11d67d17b1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelCreate(MPI_Comm, const char[], DMLabel *);
129f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelSetType(DMLabel, DMLabelType);
139f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelGetType(DMLabel, DMLabelType *);
149f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelRegister(const char[], PetscErrorCode (*)(DMLabel));
159f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelRegisterAll(void);
169f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelRegisterDestroy(void);
179f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelSetUp(DMLabel);
189f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelSetFromOptions(DMLabel);
19c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode    DMLabelView(DMLabel, PetscViewer);
209f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelDuplicate(DMLabel, DMLabel *);
21d67d17b1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode    DMLabelReset(DMLabel);
22c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode    DMLabelDestroy(DMLabel *);
239f6c5813SMatthew G. Knepley 
245aa44df4SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetDefaultValue(DMLabel, PetscInt *);
255aa44df4SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelSetDefaultValue(DMLabel, PetscInt);
26c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *);
27c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt);
28c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt);
29c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt);
30b9907514SLisandro Dalcin PETSC_EXTERN PetscErrorCode DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]);
31b9907514SLisandro Dalcin PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS);
32c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt);
33c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *);
34c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *);
35c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *);
361d04cbbeSVaclav Hapla PETSC_EXTERN PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel, IS *);
37d123abd9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetValueIndex(DMLabel, PetscInt, PetscInt *);
38c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *);
39fada774cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *);
40c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *);
41c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *);
424de306b1SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS);
43412e9a14SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelSetStratumBounds(DMLabel, PetscInt, PetscInt, PetscInt);
44c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt);
45d123abd9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetStratumPointIndex(DMLabel, PetscInt, PetscInt, PetscInt *);
46b9907514SLisandro Dalcin 
479f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCompare(MPI_Comm, DMLabel, DMLabel, PetscBool *, char **message);
48c6a43d28SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel);
49c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt);
50c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel);
51c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *);
52c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *);
53c6a43d28SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *);
548696263dSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetValueBounds(DMLabel, PetscInt *, PetscInt *);
55c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt);
56c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *);
575552b385SBrandon PETSC_EXTERN PetscErrorCode DMLabelPermuteValues(DMLabel, IS);
585552b385SBrandon PETSC_EXTERN PetscErrorCode DMLabelRewriteValues(DMLabel, IS);
59c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *);
607937d9ceSMichael Lange PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *);
61c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *);
62c58f1c22SToby Isaac 
63d42890abSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelPropagateBegin(DMLabel, PetscSF);
64d42890abSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelPropagatePush(DMLabel, PetscSF, PetscErrorCode (*)(DMLabel, PetscInt, PetscInt, void *), void *);
65d42890abSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelPropagateEnd(DMLabel, PetscSF);
66d42890abSMatthew G. Knepley 
673dec45f3SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *);
683dec45f3SMatthew G. Knepley 
695fdea053SToby Isaac #define PETSCSECTIONSYMLABEL "label"
705fdea053SToby Isaac PETSC_EXTERN PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm, DMLabel, PetscSectionSym *);
715fdea053SToby Isaac PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym, DMLabel);
72b004864fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym, PetscInt, PetscInt *, PetscInt *, PetscInt *, const PetscInt ***, const PetscScalar ***);
735fdea053SToby Isaac PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym, PetscInt, PetscInt, PetscInt, PetscInt, PetscCopyMode, const PetscInt **, const PetscScalar **);
74