xref: /petsc/include/petscdmlabel.h (revision 61c8d4ed94f37c13af459aa1b8bd670fce1ab5da)
1 #pragma once
2 #include <petscis.h>
3 
4 /* SUBMANSEC = DM */
5 
6 PETSC_EXTERN PetscClassId DMLABEL_CLASSID;
7 
8 #include <petscdmlabeltypes.h>
9 
10 PETSC_EXTERN PetscFunctionList DMLabelList;
11 PETSC_EXTERN PetscErrorCode    DMLabelCreate(MPI_Comm, const char[], DMLabel *);
12 PETSC_EXTERN PetscErrorCode    DMLabelSetType(DMLabel, DMLabelType);
13 PETSC_EXTERN PetscErrorCode    DMLabelGetType(DMLabel, DMLabelType *);
14 PETSC_EXTERN PetscErrorCode    DMLabelRegister(const char[], PetscErrorCode (*)(DMLabel));
15 PETSC_EXTERN PetscErrorCode    DMLabelRegisterAll(void);
16 PETSC_EXTERN PetscErrorCode    DMLabelRegisterDestroy(void);
17 PETSC_EXTERN PetscErrorCode    DMLabelSetUp(DMLabel);
18 PETSC_EXTERN PetscErrorCode    DMLabelSetFromOptions(DMLabel);
19 PETSC_EXTERN PetscErrorCode    DMLabelView(DMLabel, PetscViewer);
20 PETSC_EXTERN PetscErrorCode    DMLabelDuplicate(DMLabel, DMLabel *);
21 PETSC_EXTERN PetscErrorCode    DMLabelReset(DMLabel);
22 PETSC_EXTERN PetscErrorCode    DMLabelDestroy(DMLabel *);
23 
24 PETSC_EXTERN PetscErrorCode DMLabelGetDefaultValue(DMLabel, PetscInt *);
25 PETSC_EXTERN PetscErrorCode DMLabelSetDefaultValue(DMLabel, PetscInt);
26 PETSC_EXTERN PetscErrorCode DMLabelGetValue(DMLabel, PetscInt, PetscInt *);
27 PETSC_EXTERN PetscErrorCode DMLabelSetValue(DMLabel, PetscInt, PetscInt);
28 PETSC_EXTERN PetscErrorCode DMLabelClearValue(DMLabel, PetscInt, PetscInt);
29 PETSC_EXTERN PetscErrorCode DMLabelAddStratum(DMLabel, PetscInt);
30 PETSC_EXTERN PetscErrorCode DMLabelAddStrata(DMLabel, PetscInt, const PetscInt[]);
31 PETSC_EXTERN PetscErrorCode DMLabelAddStrataIS(DMLabel, IS);
32 PETSC_EXTERN PetscErrorCode DMLabelInsertIS(DMLabel, IS, PetscInt);
33 PETSC_EXTERN PetscErrorCode DMLabelGetNumValues(DMLabel, PetscInt *);
34 PETSC_EXTERN PetscErrorCode DMLabelGetStratumBounds(DMLabel, PetscInt, PetscInt *, PetscInt *);
35 PETSC_EXTERN PetscErrorCode DMLabelGetValueIS(DMLabel, IS *);
36 PETSC_EXTERN PetscErrorCode DMLabelGetNonEmptyStratumValuesIS(DMLabel, IS *);
37 PETSC_EXTERN PetscErrorCode DMLabelGetValueIndex(DMLabel, PetscInt, PetscInt *);
38 PETSC_EXTERN PetscErrorCode DMLabelStratumHasPoint(DMLabel, PetscInt, PetscInt, PetscBool *);
39 PETSC_EXTERN PetscErrorCode DMLabelHasStratum(DMLabel, PetscInt, PetscBool *);
40 PETSC_EXTERN PetscErrorCode DMLabelGetStratumSize(DMLabel, PetscInt, PetscInt *);
41 PETSC_EXTERN PetscErrorCode DMLabelGetStratumIS(DMLabel, PetscInt, IS *);
42 PETSC_EXTERN PetscErrorCode DMLabelSetStratumIS(DMLabel, PetscInt, IS);
43 PETSC_EXTERN PetscErrorCode DMLabelSetStratumBounds(DMLabel, PetscInt, PetscInt, PetscInt);
44 PETSC_EXTERN PetscErrorCode DMLabelClearStratum(DMLabel, PetscInt);
45 PETSC_EXTERN PetscErrorCode DMLabelGetStratumPointIndex(DMLabel, PetscInt, PetscInt, PetscInt *);
46 
47 PETSC_EXTERN PetscErrorCode DMLabelCompare(MPI_Comm, DMLabel, DMLabel, PetscBool *, char **message);
48 PETSC_EXTERN PetscErrorCode DMLabelComputeIndex(DMLabel);
49 PETSC_EXTERN PetscErrorCode DMLabelCreateIndex(DMLabel, PetscInt, PetscInt);
50 PETSC_EXTERN PetscErrorCode DMLabelDestroyIndex(DMLabel);
51 PETSC_EXTERN PetscErrorCode DMLabelHasValue(DMLabel, PetscInt, PetscBool *);
52 PETSC_EXTERN PetscErrorCode DMLabelHasPoint(DMLabel, PetscInt, PetscBool *);
53 PETSC_EXTERN PetscErrorCode DMLabelGetBounds(DMLabel, PetscInt *, PetscInt *);
54 PETSC_EXTERN PetscErrorCode DMLabelGetValueBounds(DMLabel, PetscInt *, PetscInt *);
55 PETSC_EXTERN PetscErrorCode DMLabelFilter(DMLabel, PetscInt, PetscInt);
56 PETSC_EXTERN PetscErrorCode DMLabelPermute(DMLabel, IS, DMLabel *);
57 PETSC_EXTERN PetscErrorCode DMLabelPermuteValues(DMLabel, IS);
58 PETSC_EXTERN PetscErrorCode DMLabelRewriteValues(DMLabel, IS);
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