Actual source code: petscis.h
petsc-3.10.5 2019-03-28
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 ISEqualUnsorted(IS,IS,PetscBool *);
     68: PETSC_EXTERN PetscErrorCode ISSort(IS);
     69: PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
     70: PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool  *);
     71: PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*);
     72: PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*);
     73: PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*);
     74: PETSC_EXTERN PetscErrorCode ISIntersect(IS,IS,IS*);
     75: PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*);

     77: PETSC_EXTERN PetscErrorCode ISLocate(IS,PetscInt,PetscInt*);
     78: PETSC_EXTERN PetscErrorCode ISGetPointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
     79: PETSC_EXTERN PetscErrorCode ISRestorePointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
     80: PETSC_EXTERN PetscErrorCode ISGetPointSubrange(IS,PetscInt,PetscInt,const PetscInt*);

     82: PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt *[]);
     83: PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt *[]);
     84: PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt *);
     85: PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt *);
     86: PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*);
     87: PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt);

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

     91: PETSC_EXTERN PetscErrorCode ISToGeneral(IS);

     93: PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*);
     94: PETSC_EXTERN PetscErrorCode ISCopy(IS,IS);
     95: PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*);
     96: PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*);
     97: PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*);
     98: PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt, IS[],IS*,IS*);
     99: PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*, IS *[]);
    100: PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*);
    101: PETSC_EXTERN PetscErrorCode ISSortPermutation(IS,PetscBool,IS*);
    102: PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*);
    103: PETSC_EXTERN PetscErrorCode ISRenumber(IS,IS,PetscInt*,IS*);

    105: /* --------------------------------------------------------------------------*/
    106: PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;

    108: /*E
    109:     ISGlobalToLocalMappingMode - Indicates if missing global indices are

    111:    IS_GTOLM_MASK - missing global indices are replaced with -1
    112:    IS_GTOLM_DROP - missing global indices are dropped

    114:    Level: beginner

    116: .seealso: ISGlobalToLocalMappingApplyBlock(), ISGlobalToLocalMappingApply()

    118: E*/
    119: typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingMode;

    121: /*J
    122:     ISLocalToGlobalMappingType - String with the name of a mapping method

    124:    Level: beginner

    126: .seealso: ISLocalToGlobalMappingSetType(), ISLocalToGlobalSetFromOptions()
    127: J*/
    128: typedef const char* ISLocalToGlobalMappingType;
    129: #define ISLOCALTOGLOBALMAPPINGBASIC "basic"
    130: #define ISLOCALTOGLOBALMAPPINGHASH  "hash"

    132: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType);
    133: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegister(const char[],PetscErrorCode (*)(ISLocalToGlobalMapping));
    134: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegisterAll(void);
    135: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*);
    136: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
    137: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*);
    138: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetFromOptions(ISLocalToGlobalMapping);
    139: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetUp(ISLocalToGlobalMapping);
    140: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
    141: PETSC_STATIC_INLINE PetscErrorCode ISLocalToGlobalMappingViewFromOptions(ISLocalToGlobalMapping A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}

    143: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*);
    144: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
    145: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
    146: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
    147: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
    148: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
    149: PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,IS,IS*);
    150: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*);
    151: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
    152: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
    153: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    154: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    155: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    156: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
    157: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**);
    158: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**);
    159: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
    160: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
    161: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*);
    162: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping,PetscInt*);
    163: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetBlockSize(ISLocalToGlobalMapping,PetscInt);
    164: PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDuplicate(ISLocalToGlobalMapping,ISLocalToGlobalMapping*);

    167: /* --------------------------------------------------------------------------*/
    168: /*E
    169:     ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
    170:                      or for just the local ghosted portion

    172:     Level: beginner

    174: $   IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function
    175: $                        is called synchronously in parallel. This requires generating a "parallel coloring".
    176: $   IS_COLORING_LOCAL - includes colors for ghost points, this is used when the function can be called
    177: $                         separately on individual processes with the ghost points already filled in. Does not
    178: $                         require a "parallel coloring", rather each process colors its local + ghost part.
    179: $                         Using this can result in much less parallel communication. Currently only works
    180: $                         with DMDA and if you call MatFDColoringSetFunction() with the local function.

    182: .seealso: DMCreateColoring()
    183: E*/
    184: typedef enum {IS_COLORING_GLOBAL,IS_COLORING_LOCAL} ISColoringType;
    185: PETSC_EXTERN const char *const ISColoringTypes[];
    186: typedef unsigned PETSC_IS_COLOR_VALUE_TYPE ISColoringValue;
    187: PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]);

    189: PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],PetscCopyMode,ISColoring*);
    190: PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*);
    191: PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer);
    192: PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,PetscObject,const char[]);
    193: PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscInt*,IS*[]);
    194: PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,IS*[]);
    195: PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
    196: PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);

    199: /* --------------------------------------------------------------------------*/
    200: PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS,IS,IS*);
    201: PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
    202: PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);

    204: PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
    205: PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
    206: PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);

    209: struct _n_PetscLayout{
    210:   MPI_Comm               comm;
    211:   PetscInt               n,N;         /* local, global vector size */
    212:   PetscInt               rstart,rend; /* local start, local end + 1 */
    213:   PetscInt               *range;      /* the offset of each processor */
    214:   PetscInt               bs;          /* number of elements in each block (generally for multi-component
    215:                                        * problems). Defaults to -1 and can be arbitrarily lazy so always use
    216:                                        * PetscAbs(map->bs) when accessing directly and expecting result to be
    217:                                        * positive. Do NOT multiply above numbers by bs */
    218:   PetscInt               refcnt;      /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */
    219:   ISLocalToGlobalMapping mapping;     /* mapping used in Vec/MatSetValuesLocal() */
    220: };

    222: /*@C
    223:      PetscLayoutFindOwner - Find the owning rank for a global index

    225:     Not Collective

    227:    Input Parameters:
    228: +    map - the layout
    229: -    idx - global index to find the owner of

    231:    Output Parameter:
    232: .    owner - the owning rank

    234:    Level: developer

    236:     Fortran Notes:
    237:       Not available from Fortran

    239: @*/
    240: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscInt *owner)
    241: {
    243:   PetscMPIInt    lo = 0,hi,t;

    246:   *owner = -1;                  /* GCC erroneously issues warning about possibly uninitialized use when error condition */
    247:   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
    248:   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
    249:   MPI_Comm_size(map->comm,&hi);
    250:   while (hi - lo > 1) {
    251:     t = lo + (hi - lo) / 2;
    252:     if (idx < map->range[t]) hi = t;
    253:     else                     lo = t;
    254:   }
    255:   *owner = lo;
    256:   return(0);
    257: }

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

    262:     Not Collective

    264:    Input Parameters:
    265: +    map   - the layout
    266: -    idx   - global index to find the owner of

    268:    Output Parameter:
    269: +    owner - the owning rank
    270: -    lidx  - local index used by the owner for idx

    272:    Level: developer

    274:     Fortran Notes:
    275:       Not available from Fortran

    277: @*/
    278: PETSC_STATIC_INLINE PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscInt *owner, PetscInt *lidx)
    279: {
    281:   PetscMPIInt    lo = 0,hi,t;

    284:   if (!((map->n >= 0) && (map->N >= 0) && (map->range))) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
    285:   if (idx < 0 || idx > map->N) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %D is out of range",idx);
    286:   MPI_Comm_size(map->comm,&hi);
    287:   while (hi - lo > 1) {
    288:     t = lo + (hi - lo) / 2;
    289:     if (idx < map->range[t]) hi = t;
    290:     else                     lo = t;
    291:   }
    292:   if (owner) *owner = lo;
    293:   if (lidx) *lidx  = idx-map->range[lo];
    294:   return(0);
    295: }

    297: PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
    298: PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
    299: PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
    300: PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
    301: PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
    302: PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
    303: PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
    304: PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
    305: PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt *);
    306: PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
    307: PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
    308: PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt *,PetscInt *);
    309: PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt *[]);
    310: PETSC_EXTERN PetscErrorCode PetscLayoutCompare(PetscLayout,PetscLayout,PetscBool*);
    311: PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
    312: PETSC_EXTERN PetscErrorCode PetscSFSetGraphLayout(PetscSF,PetscLayout,PetscInt,const PetscInt*,PetscCopyMode,const PetscInt*);

    314: PETSC_EXTERN PetscClassId PETSC_SECTION_CLASSID;

    316: PETSC_EXTERN PetscErrorCode PetscSectionCreate(MPI_Comm,PetscSection*);
    317: PETSC_EXTERN PetscErrorCode PetscSectionClone(PetscSection, PetscSection*);
    318: PETSC_EXTERN PetscErrorCode PetscSectionCopy(PetscSection, PetscSection);
    319: PETSC_EXTERN PetscErrorCode PetscSectionCompare(PetscSection, PetscSection, PetscBool*);
    320: PETSC_EXTERN PetscErrorCode PetscSectionGetNumFields(PetscSection, PetscInt *);
    321: PETSC_EXTERN PetscErrorCode PetscSectionSetNumFields(PetscSection, PetscInt);
    322: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldName(PetscSection, PetscInt, const char *[]);
    323: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldName(PetscSection, PetscInt, const char []);
    324: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldComponents(PetscSection, PetscInt, PetscInt *);
    325: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldComponents(PetscSection, PetscInt, PetscInt);
    326: PETSC_EXTERN PetscErrorCode PetscSectionGetChart(PetscSection, PetscInt *, PetscInt *);
    327: PETSC_EXTERN PetscErrorCode PetscSectionSetChart(PetscSection, PetscInt, PetscInt);
    328: PETSC_EXTERN PetscErrorCode PetscSectionGetPermutation(PetscSection, IS *);
    329: PETSC_EXTERN PetscErrorCode PetscSectionSetPermutation(PetscSection, IS);
    330: PETSC_EXTERN PetscErrorCode PetscSectionGetDof(PetscSection, PetscInt, PetscInt*);
    331: PETSC_EXTERN PetscErrorCode PetscSectionSetDof(PetscSection, PetscInt, PetscInt);
    332: PETSC_EXTERN PetscErrorCode PetscSectionAddDof(PetscSection, PetscInt, PetscInt);
    333: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt*);
    334: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
    335: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldDof(PetscSection, PetscInt, PetscInt, PetscInt);
    336: PETSC_EXTERN PetscErrorCode PetscSectionHasConstraints(PetscSection, PetscBool *);
    337: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintDof(PetscSection, PetscInt, PetscInt*);
    338: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintDof(PetscSection, PetscInt, PetscInt);
    339: PETSC_EXTERN PetscErrorCode PetscSectionAddConstraintDof(PetscSection, PetscInt, PetscInt);
    340: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt*);
    341: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
    342: PETSC_EXTERN PetscErrorCode PetscSectionAddFieldConstraintDof(PetscSection, PetscInt, PetscInt, PetscInt);
    343: PETSC_EXTERN PetscErrorCode PetscSectionGetConstraintIndices(PetscSection, PetscInt, const PetscInt**);
    344: PETSC_EXTERN PetscErrorCode PetscSectionSetConstraintIndices(PetscSection, PetscInt, const PetscInt*);
    345: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt**);
    346: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldConstraintIndices(PetscSection, PetscInt, PetscInt, const PetscInt*);
    347: PETSC_EXTERN PetscErrorCode PetscSectionSetUpBC(PetscSection);
    348: PETSC_EXTERN PetscErrorCode PetscSectionSetUp(PetscSection);
    349: PETSC_EXTERN PetscErrorCode PetscSectionGetMaxDof(PetscSection, PetscInt*);
    350: PETSC_EXTERN PetscErrorCode PetscSectionGetStorageSize(PetscSection, PetscInt*);
    351: PETSC_EXTERN PetscErrorCode PetscSectionGetConstrainedStorageSize(PetscSection, PetscInt*);
    352: PETSC_EXTERN PetscErrorCode PetscSectionGetOffset(PetscSection, PetscInt, PetscInt*);
    353: PETSC_EXTERN PetscErrorCode PetscSectionSetOffset(PetscSection, PetscInt, PetscInt);
    354: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt*);
    355: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldOffset(PetscSection, PetscInt, PetscInt, PetscInt);
    356: PETSC_EXTERN PetscErrorCode PetscSectionGetOffsetRange(PetscSection, PetscInt *, PetscInt *);
    357: PETSC_EXTERN PetscErrorCode PetscSectionView(PetscSection, PetscViewer);
    358: PETSC_STATIC_INLINE PetscErrorCode PetscSectionViewFromOptions(PetscSection A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
    359: PETSC_EXTERN PetscErrorCode PetscSectionReset(PetscSection);
    360: PETSC_EXTERN PetscErrorCode PetscSectionDestroy(PetscSection*);
    361: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSection(PetscSection, PetscSF, PetscBool, PetscBool, PetscSection *);
    362: PETSC_EXTERN PetscErrorCode PetscSectionCreateGlobalSectionCensored(PetscSection, PetscSF, PetscBool, PetscInt, const PetscInt [], PetscSection *);
    363: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubsection(PetscSection, PetscInt, const PetscInt [], PetscSection *);
    364: PETSC_EXTERN PetscErrorCode PetscSectionCreateSupersection(PetscSection[], PetscInt, PetscSection *);
    365: PETSC_EXTERN PetscErrorCode PetscSectionCreateSubmeshSection(PetscSection, IS, PetscSection *);
    366: PETSC_EXTERN PetscErrorCode PetscSectionGetPointLayout(MPI_Comm, PetscSection, PetscLayout *);
    367: PETSC_EXTERN PetscErrorCode PetscSectionGetValueLayout(MPI_Comm, PetscSection, PetscLayout *);
    368: PETSC_EXTERN PetscErrorCode PetscSectionPermute(PetscSection, IS, PetscSection *);
    369: PETSC_EXTERN PetscErrorCode PetscSectionGetField(PetscSection, PetscInt, PetscSection *);
    370: PETSC_EXTERN PetscErrorCode PetscSectionSetUseFieldOffsets(PetscSection, PetscBool);
    371: PETSC_EXTERN PetscErrorCode PetscSectionGetUseFieldOffsets(PetscSection, PetscBool *);

    373: PETSC_EXTERN PetscErrorCode PetscSectionSetClosureIndex(PetscSection, PetscObject, PetscSection, IS);
    374: PETSC_EXTERN PetscErrorCode PetscSectionGetClosureIndex(PetscSection, PetscObject, PetscSection *, IS *);
    375: PETSC_EXTERN PetscErrorCode PetscSectionSetClosurePermutation(PetscSection, PetscObject, IS);
    376: PETSC_EXTERN PetscErrorCode PetscSectionGetClosurePermutation(PetscSection, PetscObject, IS *);
    377: PETSC_EXTERN PetscErrorCode PetscSectionGetClosureInversePermutation(PetscSection, PetscObject, IS *);

    379: PETSC_EXTERN PetscClassId PETSC_SECTION_SYM_CLASSID;

    381: /*J
    382:   PetscSectionSymType - String with the name of a PetscSectionSym type.

    384:   Level: developer

    386:   Notes:
    387:     PetscSectionSym has no default implementation, but is used by DM in PetscSectionSymCreateLabel().

    389: .seealso: PetscSectionSymSetType(), PetscSectionSym, PetscSectionSymCreate(), PetscSectionSymRegister()
    390: J*/
    391: typedef const char *PetscSectionSymType;

    393: PETSC_EXTERN PetscFunctionList PetscSectionSymList;
    394: PETSC_EXTERN PetscErrorCode PetscSectionSymSetType(PetscSectionSym, PetscSectionSymType);
    395: PETSC_EXTERN PetscErrorCode PetscSectionSymGetType(PetscSectionSym, PetscSectionSymType*);
    396: PETSC_EXTERN PetscErrorCode PetscSectionSymRegister(const char[],PetscErrorCode (*)(PetscSectionSym));

    398: PETSC_EXTERN PetscErrorCode PetscSectionSymCreate(MPI_Comm, PetscSectionSym*);
    399: PETSC_EXTERN PetscErrorCode PetscSectionSymDestroy(PetscSectionSym*);
    400: PETSC_EXTERN PetscErrorCode PetscSectionSymView(PetscSectionSym,PetscViewer);

    402: PETSC_EXTERN PetscErrorCode PetscSectionSetSym(PetscSection, PetscSectionSym);
    403: PETSC_EXTERN PetscErrorCode PetscSectionGetSym(PetscSection, PetscSectionSym*);
    404: PETSC_EXTERN PetscErrorCode PetscSectionSetFieldSym(PetscSection, PetscInt, PetscSectionSym);
    405: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldSym(PetscSection, PetscInt, PetscSectionSym*);

    407: PETSC_EXTERN PetscErrorCode PetscSectionGetPointSyms(PetscSection, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
    408: PETSC_EXTERN PetscErrorCode PetscSectionRestorePointSyms(PetscSection, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
    409: PETSC_EXTERN PetscErrorCode PetscSectionGetFieldPointSyms(PetscSection, PetscInt, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);
    410: PETSC_EXTERN PetscErrorCode PetscSectionRestoreFieldPointSyms(PetscSection, PetscInt, PetscInt, const PetscInt *, const PetscInt ***, const PetscScalar ***);

    413: /* PetscSF support */
    414: PETSC_EXTERN PetscErrorCode PetscSFConvertPartition(PetscSF, PetscSection, IS, ISLocalToGlobalMapping *, PetscSF *);
    415: PETSC_EXTERN PetscErrorCode PetscSFCreateRemoteOffsets(PetscSF, PetscSection, PetscSection, PetscInt **);
    416: PETSC_EXTERN PetscErrorCode PetscSFDistributeSection(PetscSF, PetscSection, PetscInt **, PetscSection);
    417: PETSC_EXTERN PetscErrorCode PetscSFCreateSectionSF(PetscSF, PetscSection, PetscInt [], PetscSection, PetscSF *);

    419: #endif