xref: /petsc/include/petscdmlabel.h (revision d9126033840fa4b9e125cadad06c85976e6bf099)
1a4963045SJacob Faibussowitsch #pragma once
2c58f1c22SToby Isaac #include <petscis.h>
3c58f1c22SToby Isaac 
4ce78bad3SBarry Smith /* SUBMANSEC = DM */
5ce78bad3SBarry Smith 
69f6c5813SMatthew G. Knepley PETSC_EXTERN PetscClassId DMLABEL_CLASSID;
79f6c5813SMatthew G. Knepley 
8ce78bad3SBarry Smith #include <petscdmlabeltypes.h>
9a1cc8097SBarry Smith 
109f6c5813SMatthew G. Knepley PETSC_EXTERN PetscFunctionList DMLabelList;
114b793533SStefano Zampini 
12d67d17b1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCreate(MPI_Comm, const char[], DMLabel *);
139f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelSetType(DMLabel, DMLabelType);
149f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetType(DMLabel, DMLabelType *);
159f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelRegister(const char[], PetscErrorCode (*)(DMLabel));
169f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelRegisterAll(void);
179f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelRegisterDestroy(void);
189f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelSetUp(DMLabel);
199f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelSetFromOptions(DMLabel);
20c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelView(DMLabel, PetscViewer);
214b793533SStefano Zampini PETSC_EXTERN PetscErrorCode DMLabelViewFromOptions(DMLabel, PetscObject, const char[]);
229f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelDuplicate(DMLabel, DMLabel *);
23d67d17b1SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelReset(DMLabel);
24c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelDestroy(DMLabel *);
259f6c5813SMatthew G. Knepley 
265aa44df4SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetDefaultValue(DMLabel, PetscInt *);
275aa44df4SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelSetDefaultValue(DMLabel, PetscInt);
28c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *);
29c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt);
30c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt);
31c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt);
32b9907514SLisandro Dalcin PETSC_EXTERN PetscErrorCode DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]);
33b9907514SLisandro Dalcin PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS);
34c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt);
35c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *);
36c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *);
37c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *);
38*f59a9984SJames Wright PETSC_EXTERN PetscErrorCode DMLabelGetValueISGlobal(MPI_Comm, DMLabel, PetscBool, IS *);
391d04cbbeSVaclav Hapla PETSC_EXTERN PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel, IS *);
40d123abd9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetValueIndex(DMLabel, PetscInt, PetscInt *);
41c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *);
42fada774cSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *);
43c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *);
44c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *);
454de306b1SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS);
46412e9a14SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelSetStratumBounds(DMLabel, PetscInt, PetscInt, PetscInt);
47c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt);
48d123abd9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetStratumPointIndex(DMLabel, PetscInt, PetscInt, PetscInt *);
49b9907514SLisandro Dalcin 
509f6c5813SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelCompare(MPI_Comm, DMLabel, DMLabel, PetscBool *, char **message);
51c6a43d28SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel);
52c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt);
53c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel);
54c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *);
55c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *);
56c6a43d28SMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *);
578696263dSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelGetValueBounds(DMLabel, PetscInt *, PetscInt *);
58c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt);
59c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *);
605552b385SBrandon PETSC_EXTERN PetscErrorCode DMLabelPermuteValues(DMLabel, IS);
615552b385SBrandon PETSC_EXTERN PetscErrorCode DMLabelRewriteValues(DMLabel, IS);
62c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelDistribute(DMLabel, PetscSF, DMLabel *);
637937d9ceSMichael Lange PETSC_EXTERN PetscErrorCode DMLabelGather(DMLabel, PetscSF, DMLabel *);
64c58f1c22SToby Isaac PETSC_EXTERN PetscErrorCode DMLabelConvertToSection(DMLabel, PetscSection *, IS *);
65c58f1c22SToby Isaac 
66d42890abSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelPropagateBegin(DMLabel, PetscSF);
67d42890abSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelPropagatePush(DMLabel, PetscSF, PetscErrorCode (*)(DMLabel, PetscInt, PetscInt, void *), void *);
68d42890abSMatthew G. Knepley PETSC_EXTERN PetscErrorCode DMLabelPropagateEnd(DMLabel, PetscSF);
69d42890abSMatthew G. Knepley 
703dec45f3SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionLabel(PetscSection, PetscSF, PetscBool, DMLabel, PetscInt, PetscSection *);
713dec45f3SMatthew G. Knepley 
725fdea053SToby Isaac #define PETSCSECTIONSYMLABEL "label"
735fdea053SToby Isaac PETSC_EXTERN PetscErrorCode PetscSectionSymCreateLabel(MPI_Comm, DMLabel, PetscSectionSym *);
745fdea053SToby Isaac PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetLabel(PetscSectionSym, DMLabel);
75b004864fSMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscSectionSymLabelGetStratum(PetscSectionSym, PetscInt, PetscInt *, PetscInt *, PetscInt *, const PetscInt ***, const PetscScalar ***);
765fdea053SToby Isaac PETSC_EXTERN PetscErrorCode PetscSectionSymLabelSetStratum(PetscSectionSym, PetscInt, PetscInt, PetscInt, PetscInt, PetscCopyMode, const PetscInt **, const PetscScalar **);
77