Actual source code: petscis.h
petsc-3.7.7 2017-09-25
Report Typos and Errors

      1: /*
      2:    An index set is a generalization of a subset of integers.  Index sets
      3:    are used for defining scatters and gathers.
      4: */
      7: #include <petscsys.h>
      8: #include <petscsftypes.h>
      9: #include <petscistypes.h>

     11: #define IS_FILE_CLASSID 1211218
     12: PETSC_EXTERN PetscClassId IS_CLASSID;

     14: PETSC_EXTERN PetscErrorCode ISInitializePackage(void);

     16: /*J
     17:     ISType - String with the name of a PETSc index set type

     19:    Level: beginner

     21: .seealso: ISSetType(), IS, ISCreate(), ISRegister()
     22: J*/
     23: typedef const char* ISType;
     24: #define ISGENERAL      "general"
     25: #define ISSTRIDE       "stride"
     26: #define ISBLOCK        "block"

     28: /* Dynamic creation and loading functions */
     29: PETSC_EXTERN PetscFunctionList ISList;
     30: PETSC_EXTERN PetscErrorCode ISSetType(IS, ISType);
     31: PETSC_EXTERN PetscErrorCode ISGetType(IS, ISType *);
     32: PETSC_EXTERN PetscErrorCode ISRegister(const char[],PetscErrorCode (*)(IS));
     33: PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm,IS*);

     35: /*
     36:     Default index set data structures that PETSc provides.
     37: */
     38: PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS *);
     39: PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode);
     40: PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS *);
     41: PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode);
     42: PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *);
     43: PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt);

     45: PETSC_EXTERN PetscErrorCode ISDestroy(IS*);
     46: PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
     47: PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool *);
     48: PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
     49: PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool *);
     50: PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*);

     52: PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt *[]);
     53: PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt *[]);
     54: PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt *[]);
     55: PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt *[]);
     56: PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt *[]);
     57: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt *[]);
     58: PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS, IS *is);
     59: PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS, IS *is);
     60: PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt *);
     61: PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt *);
     62: PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*);
     63: PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer);
     64: PETSC_STATIC_INLINE PetscErrorCode ISViewFromOptions(IS A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
     65: PETSC_EXTERN PetscErrorCode ISLoad(IS,PetscViewer);
     66: PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool  *);
     67: PETSC_EXTERN PetscErrorCode ISSort(IS);
     68: PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
     69: PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool  *);
     70: PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*);
     71: PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*);
     72: PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*);
     73: PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*);

     75: PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt *[]);
     76: PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt *[]);
     77: PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt *);
     78: PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt *);
     79: PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*);
     80: PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt);

     82: PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt *,PetscInt*);

     84: PETSC_EXTERN PetscErrorCode ISToGeneral(IS);

     86: PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*);
     87: PETSC_EXTERN PetscErrorCode ISCopy(IS,IS);
     88: PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*);
     89: PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*);
     90: PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*);
     91: PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt, IS[],IS*,IS*);
     92: PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*, IS *[]);
     93: PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*);
     94: PETSC_EXTERN PetscErrorCode ISSortPermutation(IS,PetscBool,IS*);
     95: PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*);

     97: /* --------------------------------------------------------------------------*/
     98: PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;

    100: /*E
    101:     ISGlobalToLocalMappingType - Indicates if missing global indices are

    103:    IS_GTOLM_MASK - missing global indices are replaced with -1
    104:    IS_GTOLM_DROP - missing global indices are dropped

    106:    Level: beginner

    108: .seealso: ISGlobalToLocalMappingApplyBlock()

    110: E*/
    111: typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType;

    113: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*);
    114: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
    115: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*);
    116: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
    117: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*);
    118: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
    119: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
    120: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
    121: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
    122: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
    123: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,IS,IS*);
    124: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*);
    125: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    126: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    127: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    128: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    129: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**);
    130: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**);
    131: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
    132: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
    133: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*);
    134: PETSC_EXTERN PetscErrorCode ISG2LMapApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
    135: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping,PetscInt*);

    138: /* --------------------------------------------------------------------------*/
    139: /*E
    140:     ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
    141:                      or for just the local ghosted portion

    143:     Level: beginner

    145: $   IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function
    146: $                        is called synchronously in parallel. This requires generating a "parallel coloring".
    147: $   IS_COLORING_GHOSTED - includes colors for ghost points, this is used when the function can be called
    148: $                         separately on individual processes with the ghost points already filled in. Does not
    149: $                         require a "parallel coloring", rather each process colors its local + ghost part.
    150: $                         Using this can result in much less parallel communication. In the paradigm of
    151: $                         DMGetLocalVector() and DMGetGlobalVector() this could be called IS_COLORING_LOCAL

    153: .seealso: DMCreateColoring()
    154: E*/
    155: typedef enum {IS_COLORING_GLOBAL,IS_COLORING_GHOSTED} ISColoringType;
    156: PETSC_EXTERN const char *const ISColoringTypes[];
    157: typedef unsigned PETSC_IS_COLOR_VALUE_TYPE ISColoringValue;
    158: PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]);

    160: PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],PetscCopyMode,ISColoring*);
    161: PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*);
    162: PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer);
    163: PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,PetscObject,const char[]);
    164: PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscInt*,IS*[]);
    165: PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,IS*[]);
    166: PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
    167: PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);

    170: /* --------------------------------------------------------------------------*/
    171: PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS,IS,IS*);
    172: PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
    173: PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);

    175: PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
    176: PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
    177: PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);

    180: struct _n_PetscLayout{
    181:   MPI_Comm               comm;
    182:   PetscInt               n,N;         /* local, global vector size */
    183:   PetscInt               rstart,rend; /* local start, local end + 1 */
    184:   PetscInt               *range;      /* the offset of each processor */
    185:   PetscInt               bs;          /* number of elements in each block (generally for multi-component
    186:                                        * problems). Defaults to -1 and can be arbitrarily lazy so always use
    187:                                        * PetscAbs(map->bs) when accessing directly and expecting result to be
    188:                                        * positive. Do NOT multiply above numbers by bs */
    189:   PetscInt               refcnt;      /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */
    190:   ISLocalToGlobalMapping mapping;     /* mapping used in Vec/MatSetValuesLocal() */
    191: };

    195: /*@C
    196:      PetscLayoutFindOwner - Find the owning rank for a global index

    198:     Not Collective

    200:    Input Parameters:
    201: +    map - the layout
    202: -    idx - global index to find the owner of

    204:    Output Parameter:
    205: .    owner - the owning rank

    207:    Level: developer

    209:     Fortran Notes:
    210:       Not available from Fortran

    212: @*/
    213: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscInt *owner)
    214: {
    216:   PetscMPIInt    lo = 0,hi,t;

    219:   *owner = -1;                  /* GCC erroneously issues warning about possibly uninitialized use when error condition */
    220:   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
    221:   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
    222:   MPI_Comm_size(map->comm,&hi);
    223:   while (hi - lo > 1) {
    224:     t = lo + (hi - lo) / 2;
    225:     if (idx < map->range[t]) hi = t;
    226:     else                     lo = t;
    227:   }
    228:   *owner = lo;
    229:   return(0);
    230: }

    234: /*@C
    235:      PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index

    237:     Not Collective

    239:    Input Parameters:
    240: +    map   - the layout
    241: -    idx   - global index to find the owner of

    243:    Output Parameter:
    244: +    owner - the owning rank
    245: -    lidx  - local index used by the owner for idx

    247:    Level: developer

    249:     Fortran Notes:
    250:       Not available from Fortran

    252: @*/
    253: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscInt *owner, PetscInt *lidx)
    254: {
    256:   PetscMPIInt    lo = 0,hi,t;

    259:   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
    260:   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
    261:   MPI_Comm_size(map->comm,&hi);
    262:   while (hi - lo > 1) {
    263:     t = lo + (hi - lo) / 2;
    264:     if (idx < map->range[t]) hi = t;
    265:     else                     lo = t;
    266:   }
    267:   if (owner) *owner = lo;
    268:   if (lidx) *lidx  = idx-map->range[lo];
    269:   return(0);
    270: }

    272: PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
    273: PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
    274: PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
    275: PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
    276: PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
    277: PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
    278: PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
    279: PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
    280: PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt *);
    281: PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
    282: PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
    283: PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt *,PetscInt *);
    284: PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt *[]);
    285: PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
    286: PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF,PetscLayout,PetscInt,const PetscInt*,PetscCopyMode,const PetscInt*);

    288: PETSC_EXTERN PetscClassId PETSC_SECTION_CLASSID;

    290: PETSC_EXTERN PetscErrorCode PetscSectionCreate(MPI_Comm,PetscSection*);
    291: PETSC_EXTERN PetscErrorCode PetscSectionClone(PetscSection, PetscSection*);
    292: PETSC_EXTERN PetscErrorCode PetscSectionCopy(PetscSection, PetscSection);
    293: PETSC_EXTERN PetscErrorCode PetscSectionGetNumFields(PetscSection, PetscInt *);
    294: PETSC_EXTERN PetscErrorCode PetscSectionSetNumFields(PetscSection, PetscInt);
    295: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldName(PetscSection, PetscInt, const char *[]);
    296: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldName(PetscSection, PetscInt, const char []);
    297: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldComponents(PetscSection, PetscInt, PetscInt *);
    298: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldComponents(PetscSection, PetscInt, PetscInt);
    299: PETSC_EXTERN PetscErrorCode PetscSectionGetChart(PetscSection, PetscInt *, PetscInt *);
    300: PETSC_EXTERN PetscErrorCode PetscSectionSetChart(PetscSection, PetscInt, PetscInt);
    301: PETSC_EXTERN PetscErrorCode PetscSectionGetPermutation(PetscSection, IS *);
    302: PETSC_EXTERN PetscErrorCode PetscSectionSetPermutation(PetscSection, IS);
    303: PETSC_EXTERN PetscErrorCode PetscSectionGetDof(PetscSection, PetscInt, PetscInt*);
    304: PETSC_EXTERN PetscErrorCode PetscSectionSetDof(PetscSection, PetscInt, PetscInt);
    305: PETSC_EXTERN PetscErrorCode PetscSectionAddDof(PetscSection, PetscInt, PetscInt);
    306: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt*);
    307: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
    308: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
    309: PETSC_EXTERN PetscErrorCode PetscSectionHasConstraints(PetscSection, PetscBool *);
    310: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintDof(PetscSection, PetscInt, PetscInt*);
    311: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintDof(PetscSection, PetscInt, PetscInt);
    312: PETSC_EXTERN PetscErrorCode PetscSectionAddConstraintDof(PetscSection, PetscInt, PetscInt);
    313: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt*);
    314: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
    315: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
    316: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintIndices(PetscSection, PetscInt, const PetscInt**);
    317: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintIndices(PetscSection, PetscInt, const PetscInt*);
    318: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt**);
    319: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt*);
    320: PETSC_EXTERN PetscErrorCode PetscSectionSetUpBC(PetscSection);
    321: PETSC_EXTERN PetscErrorCode PetscSectionSetUp(PetscSection);
    322: PETSC_EXTERN PetscErrorCode PetscSectionGetMaxDof(PetscSection, PetscInt*);
    323: PETSC_EXTERN PetscErrorCode PetscSectionGetStorageSize(PetscSection, PetscInt*);
    324: PETSC_EXTERN PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection, PetscInt*);
    325: PETSC_EXTERN PetscErrorCode PetscSectionGetOffset(PetscSection, PetscInt, PetscInt*);
    326: PETSC_EXTERN PetscErrorCode PetscSectionSetOffset(PetscSection, PetscInt, PetscInt);
    327: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt*);
    328: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt);
    329: PETSC_EXTERN PetscErrorCode PetscSectionGetOffsetRange(PetscSection, PetscInt *, PetscInt *);
    330: PETSC_EXTERN PetscErrorCode PetscSectionView(PetscSection, PetscViewer);
    331: PETSC_STATIC_INLINE PetscErrorCode PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
    332: PETSC_EXTERN PetscErrorCode PetscSectionReset(PetscSection);
    333: PETSC_EXTERN PetscErrorCode PetscSectionDestroy(PetscSection*);
    334: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSection(PetscSection, PetscSF, PetscBool, PetscBool, PetscSection *);
    335: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection, PetscSF, PetscBool, PetscInt, const PetscInt [], PetscSection *);
    336: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubsection(PetscSection, PetscInt, PetscInt [], PetscSection *);
    337: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection, IS, PetscSection *);
    338: PETSC_EXTERN PetscErrorCode PetscSectionGetPointLayout(MPI_Comm, PetscSection, PetscLayout *);
    339: PETSC_EXTERN PetscErrorCode PetscSectionGetValueLayout(MPI_Comm, PetscSection, PetscLayout *);
    340: PETSC_EXTERN PetscErrorCode PetscSectionPermute(PetscSection, IS, PetscSection *);
    341: PETSC_EXTERN PetscErrorCode PetscSectionGetField(PetscSection, PetscInt, PetscSection *);

    343: PETSC_EXTERN PetscErrorCode PetscSectionSetClosureIndex(PetscSection, PetscObject, PetscSection, IS);
    344: PETSC_EXTERN PetscErrorCode PetscSectionGetClosureIndex(PetscSection, PetscObject, PetscSection *, IS *);

    346: /* PetscSF support */
    347: PETSC_EXTERN PetscErrorCode PetscSFConvertPartition(PetscSF, PetscSection, IS, ISLocalToGlobalMapping *, PetscSF *);
    348: PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **);
    349: PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection);
    350: PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt [], PetscSection, PetscSF *);

    354: /* Reset __FUNCT__ in case the user does not define it themselves */

    358: #endif