xref: /petsc/include/petscis.h (revision 4e1d6e842c3d3ab5ca8f150f103947d8f9e4cedd)
12eac72dbSBarry Smith /*
2f8256253SLois Curfman McInnes    An index set is a generalization of a subset of integers.  Index sets
3f8256253SLois Curfman McInnes    are used for defining scatters and gathers.
42eac72dbSBarry Smith */
526bd1501SBarry Smith #if !defined(PETSCIS_H)
626bd1501SBarry Smith #define PETSCIS_H
72c8e378dSBarry Smith #include <petscsys.h>
80c312b8eSJed Brown #include <petscsftypes.h>
9ea844a1aSMatthew Knepley #include <petscsectiontypes.h>
104914ba2bSBarry Smith #include <petscistypes.h>    /*I  "petscis.h" I*/
112eac72dbSBarry Smith 
1297b48c8fSBarry Smith #define IS_FILE_CLASSID 1211218
13014dd563SJed Brown PETSC_EXTERN PetscClassId IS_CLASSID;
14f0479e8cSBarry Smith 
15607a6623SBarry Smith PETSC_EXTERN PetscErrorCode ISInitializePackage(void);
162b6de112SBarry Smith 
1776bdecfbSBarry Smith /*J
188f6c3df8SBarry Smith     ISType - String with the name of a PETSc index set type
1927bdab1eSBarry Smith 
2027bdab1eSBarry Smith    Level: beginner
2127bdab1eSBarry Smith 
228f6c3df8SBarry Smith .seealso: ISSetType(), IS, ISCreate(), ISRegister()
2376bdecfbSBarry Smith J*/
2419fd82e9SBarry Smith typedef const char* ISType;
2527bdab1eSBarry Smith #define ISGENERAL      "general"
2627bdab1eSBarry Smith #define ISSTRIDE       "stride"
2727bdab1eSBarry Smith #define ISBLOCK        "block"
2827bdab1eSBarry Smith 
2927bdab1eSBarry Smith /* Dynamic creation and loading functions */
30140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList ISList;
3119fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode ISSetType(IS, ISType);
3219fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode ISGetType(IS, ISType *);
33bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode ISRegister(const char[],PetscErrorCode (*)(IS));
34014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm,IS*);
3527bdab1eSBarry Smith 
36014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISDestroy(IS*);
37014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSetPermutation(IS);
38014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool *);
39014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSetIdentity(IS);
40014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool *);
41014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*);
4208480c60SBarry Smith 
432a1da528SToby Isaac /*E
442a1da528SToby Isaac     ISInfo - Info that may either be computed or set as known for an index set
452a1da528SToby Isaac 
462a1da528SToby Isaac     Level: beginner
472a1da528SToby Isaac 
482a1da528SToby Isaac    Any additions/changes here MUST also be made in include/petsc/finclude/petscis.h
492a1da528SToby Isaac    Any additions/changes here must also be made in src/vec/vec/interface/dlregisvec.c in ISInfos[]
502a1da528SToby Isaac 
512a1da528SToby Isaac    Developer Notes:
522a1da528SToby Isaac     Entries that are negative need not be called collectively by all processes.
532a1da528SToby Isaac 
542a1da528SToby Isaac .seealso: ISSetInfo()
552a1da528SToby Isaac E*/
562a1da528SToby Isaac typedef enum {IS_INFO_MIN = -1,
572a1da528SToby Isaac               IS_SORTED = 0,
582a1da528SToby Isaac               IS_UNIQUE = 1,
592a1da528SToby Isaac               IS_PERMUTATION = 2,
602a1da528SToby Isaac               IS_INTERVAL = 3,
612a1da528SToby Isaac               IS_IDENTITY = 4,
622a1da528SToby Isaac               IS_INFO_MAX = 5} ISInfo;
632a1da528SToby Isaac 
642a1da528SToby Isaac typedef enum {IS_LOCAL, IS_GLOBAL} ISInfoType;
652a1da528SToby Isaac 
662a1da528SToby Isaac PETSC_EXTERN PetscErrorCode ISSetInfo(IS,ISInfo,ISInfoType,PetscBool,PetscBool);
67657dc977SToby Isaac PETSC_EXTERN PetscErrorCode ISGetInfo(IS,ISInfo,ISInfoType,PetscBool,PetscBool*);
682a1da528SToby Isaac PETSC_EXTERN PetscErrorCode ISClearInfoCache(IS,PetscBool);
69014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt *[]);
70014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt *[]);
71014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt *[]);
72014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt *[]);
73014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt *[]);
74014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt *[]);
75014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS, IS *is);
76014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS, IS *is);
77014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt *);
78014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt *);
79014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*);
80014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer);
81fe2efc57SMark PETSC_EXTERN PetscErrorCode ISViewFromOptions(IS,PetscObject,const char[]);
82235f7792SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISLoad(IS,PetscViewer);
83014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool  *);
84e8386968SVaclav Hapla PETSC_EXTERN PetscErrorCode ISEqualUnsorted(IS,IS,PetscBool *);
85014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSort(IS);
86b080c0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS);
87014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool  *);
88014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*);
89014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*);
90014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*);
913daafeecSToby Isaac PETSC_EXTERN PetscErrorCode ISIntersect(IS,IS,IS*);
92132da990SBarry Smith PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*);
93612dd529SBarry Smith 
94c3c3c9f4SToby Isaac PETSC_EXTERN PetscErrorCode ISLocate(IS,PetscInt,PetscInt*);
959305a4c7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISGetPointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
969305a4c7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISRestorePointRange(IS,PetscInt*,PetscInt*,const PetscInt**);
979305a4c7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISGetPointSubrange(IS,PetscInt,PetscInt,const PetscInt*);
98c3c3c9f4SToby Isaac 
99014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*);
100014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt);
101c16cb8f2SBarry Smith 
102014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISToGeneral(IS);
10338f40f24SLois Curfman McInnes 
104014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*);
105014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCopy(IS,IS);
106014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*);
107014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*);
108014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*);
109bb74729cSDmitry Karpeev PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt, IS[],IS*,IS*);
110bb74729cSDmitry Karpeev PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*, IS *[]);
111bb74729cSDmitry Karpeev PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*);
1125ea6c424SDmitry Karpeev PETSC_EXTERN PetscErrorCode ISSortPermutation(IS,PetscBool,IS*);
113014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*);
1146583bcc1SStefano Zampini PETSC_EXTERN PetscErrorCode ISRenumber(IS,IS,PetscInt*,IS*);
1156c04a3c5SFande Kong PETSC_EXTERN PetscErrorCode ISCreateSubIS(IS,IS,IS*);
116d64ed03dSBarry Smith 
11784933e40SVaclav Hapla /* ISGENERAL specific */
11884933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS *);
11984933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode);
1209bc6f2f1SVaclav Hapla PETSC_EXTERN PetscErrorCode ISGeneralSetIndicesFromMask(IS,PetscInt,PetscInt,const PetscBool[]);
12153bb9c4cSVaclav Hapla PETSC_EXTERN PetscErrorCode ISGeneralFilter(IS,PetscInt,PetscInt);
12253bb9c4cSVaclav Hapla 
12384933e40SVaclav Hapla /* ISBLOCK specific */
12484933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS *);
12584933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode);
12684933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt *[]);
12784933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt *[]);
12884933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt *);
12984933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt *);
13084933e40SVaclav Hapla 
13184933e40SVaclav Hapla /* ISSTRIDE specific */
13284933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *);
13384933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt);
13484933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt *,PetscInt*);
13584933e40SVaclav Hapla 
13656cd22aeSBarry Smith /* --------------------------------------------------------------------------*/
137014dd563SJed Brown PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID;
13856cd22aeSBarry Smith 
1395c20da3cSBarry Smith /*E
1400040bde1SJunchao Zhang     ISGlobalToLocalMappingMode - Indicates mapping behavior if global indices are missing
1415c20da3cSBarry Smith 
1420040bde1SJunchao Zhang    IS_GTOLM_MASK - missing global indices are masked by mapping them to a local index of -1
1435c20da3cSBarry Smith    IS_GTOLM_DROP - missing global indices are dropped
1445c20da3cSBarry Smith 
1455c20da3cSBarry Smith    Level: beginner
1465c20da3cSBarry Smith 
147413f72f0SBarry Smith .seealso: ISGlobalToLocalMappingApplyBlock(), ISGlobalToLocalMappingApply()
1485c20da3cSBarry Smith 
1495c20da3cSBarry Smith E*/
150413f72f0SBarry Smith typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingMode;
15190f02eecSBarry Smith 
152413f72f0SBarry Smith /*J
153413f72f0SBarry Smith     ISLocalToGlobalMappingType - String with the name of a mapping method
154413f72f0SBarry Smith 
155413f72f0SBarry Smith    Level: beginner
156413f72f0SBarry Smith 
157413f72f0SBarry Smith .seealso: ISLocalToGlobalMappingSetType(), ISLocalToGlobalSetFromOptions()
158413f72f0SBarry Smith J*/
159413f72f0SBarry Smith typedef const char* ISLocalToGlobalMappingType;
160413f72f0SBarry Smith #define ISLOCALTOGLOBALMAPPINGBASIC "basic"
161413f72f0SBarry Smith #define ISLOCALTOGLOBALMAPPINGHASH  "hash"
162413f72f0SBarry Smith 
163413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType);
1641d36bdfdSBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegister(const char[],PetscErrorCode (*)(ISLocalToGlobalMapping));
165413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegisterAll(void);
166f0413b6fSBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*);
167014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
168014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*);
1697e99dc12SLawrence Mitchell PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetFromOptions(ISLocalToGlobalMapping);
170413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetUp(ISLocalToGlobalMapping);
171014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
172fe2efc57SMark PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingViewFromOptions(ISLocalToGlobalMapping,PetscObject,const char[]);
173662df134SStefano Zampini 
174014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*);
17504a59952SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
17645b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]);
177014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
178413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
179413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]);
180413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,IS,IS*);
181014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*);
1821bd0b88eSStefano Zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
1831bd0b88eSStefano Zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]);
184014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
185014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
1866a818285SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
1876a818285SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]);
188014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**);
189014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**);
19045b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
19145b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping,const PetscInt**);
192014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*);
19345b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping,PetscInt*);
19463fa5c83Sstefano_zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetBlockSize(ISLocalToGlobalMapping,PetscInt);
1956658fb44Sstefano_zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDuplicate(ISLocalToGlobalMapping,ISLocalToGlobalMapping*);
19645b6f7e9SBarry Smith 
19756cd22aeSBarry Smith /* --------------------------------------------------------------------------*/
198b9617806SBarry Smith /*E
199b9617806SBarry Smith     ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix
200b9617806SBarry Smith                      or for just the local ghosted portion
201b9617806SBarry Smith 
202b9617806SBarry Smith     Level: beginner
203b9617806SBarry Smith 
2048ee2e534SBarry Smith $   IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function
2058ee2e534SBarry Smith $                        is called synchronously in parallel. This requires generating a "parallel coloring".
2065bdb020cSBarry Smith $   IS_COLORING_LOCAL - includes colors for ghost points, this is used when the function can be called
207bebe2cf6SSatish Balay $                         separately on individual processes with the ghost points already filled in. Does not
2088ee2e534SBarry Smith $                         require a "parallel coloring", rather each process colors its local + ghost part.
2095bdb020cSBarry Smith $                         Using this can result in much less parallel communication. Currently only works
2105bdb020cSBarry Smith $                         with DMDA and if you call MatFDColoringSetFunction() with the local function.
21173d7d85fSBarry Smith 
212e727c939SJed Brown .seealso: DMCreateColoring()
213b9617806SBarry Smith E*/
2145bdb020cSBarry Smith typedef enum {IS_COLORING_GLOBAL,IS_COLORING_LOCAL} ISColoringType;
2156a6fc655SJed Brown PETSC_EXTERN const char *const ISColoringTypes[];
216569ea7c4SPierre Jolivet typedef unsigned PETSC_IS_COLORING_VALUE_TYPE ISColoringValue;
217569ea7c4SPierre Jolivet #define IS_COLORING_MAX PETSC_IS_COLORING_MAX
218569ea7c4SPierre Jolivet #define MPIU_COLORING_VALUE PETSC_MPIU_IS_COLORING_VALUE_TYPE
219014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]);
220dde82324SBarry Smith 
221aaf3ff59SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],PetscCopyMode,ISColoring*);
222014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*);
223014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer);
2248aec7d55SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,PetscObject,const char[]);
225071fcb05SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscCopyMode,PetscInt*,IS*[]);
226071fcb05SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,PetscCopyMode,IS*[]);
22749b734d2SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring);
22849b734d2SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType);
229bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode ISColoringGetType(ISColoring,ISColoringType*);
230bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode ISColoringGetColors(ISColoring,PetscInt*,PetscInt*,const ISColoringValue**);
2313a7fca6bSBarry Smith 
232dbef8a1cSBarry Smith /* --------------------------------------------------------------------------*/
23394f0491fSFande Kong PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS,IS,IS*);
234014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*);
235014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]);
236dbef8a1cSBarry Smith 
237014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
238014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]);
239014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]);
240d9489beaSHong Zhang 
24169ce434fSBarry Smith struct _n_PetscLayout{
24269ce434fSBarry Smith   MPI_Comm               comm;
24338a25198SStefano Zampini   PetscMPIInt            size;
24469ce434fSBarry Smith   PetscInt               n,N;         /* local, global vector size */
24569ce434fSBarry Smith   PetscInt               rstart,rend; /* local start, local end + 1 */
24669ce434fSBarry Smith   PetscInt               *range;      /* the offset of each processor */
2479621ec18SVaclav Hapla   PetscBool              range_alloc; /* should range be freed in Destroy? */
24833d57670SJed Brown   PetscInt               bs;          /* number of elements in each block (generally for multi-component
24933d57670SJed Brown                                        * problems). Defaults to -1 and can be arbitrarily lazy so always use
25033d57670SJed Brown                                        * PetscAbs(map->bs) when accessing directly and expecting result to be
25133d57670SJed Brown                                        * positive. Do NOT multiply above numbers by bs */
2522a7a6963SBarry Smith   PetscInt               refcnt;      /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */
25369ce434fSBarry Smith   ISLocalToGlobalMapping mapping;     /* mapping used in Vec/MatSetValuesLocal() */
254ca5434daSLawrence Mitchell   PetscBool              setupcalled; /* Forbid setup more than once */
255ca5434daSLawrence Mitchell   PetscInt               oldn,oldN;   /* Checking if setup is allowed */
256ca5434daSLawrence Mitchell   PetscInt               oldbs;       /* And again */
25769ce434fSBarry Smith };
25869ce434fSBarry Smith 
2597e3c27c9SBarry Smith /*@C
26069ce434fSBarry Smith      PetscLayoutFindOwner - Find the owning rank for a global index
26169ce434fSBarry Smith 
26269ce434fSBarry Smith     Not Collective
26369ce434fSBarry Smith 
26469ce434fSBarry Smith    Input Parameters:
26569ce434fSBarry Smith +    map - the layout
26669ce434fSBarry Smith -    idx - global index to find the owner of
26769ce434fSBarry Smith 
26869ce434fSBarry Smith    Output Parameter:
26969ce434fSBarry Smith .    owner - the owning rank
27069ce434fSBarry Smith 
27169ce434fSBarry Smith    Level: developer
27269ce434fSBarry Smith 
27369ce434fSBarry Smith     Fortran Notes:
27469ce434fSBarry Smith       Not available from Fortran
27569ce434fSBarry Smith 
27669ce434fSBarry Smith @*/
2779fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscMPIInt *owner)
27869ce434fSBarry Smith {
27969ce434fSBarry Smith   PetscMPIInt lo = 0,hi,t;
28069ce434fSBarry Smith 
28169ce434fSBarry Smith   PetscFunctionBegin;
28269ce434fSBarry Smith   *owner = -1;                  /* GCC erroneously issues warning about possibly uninitialized use when error condition */
28338a25198SStefano Zampini #if defined(PETSC_USE_DEBUG)
2842c71b3e2SJacob Faibussowitsch   PetscCheck((map->n >= 0) && (map->N >= 0) && (map->range),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
2852c71b3e2SJacob Faibussowitsch   PetscCheck(idx >= 0 && idx <= map->N,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %" PetscInt_FMT " is out of range",idx);
28638a25198SStefano Zampini #endif
28738a25198SStefano Zampini   hi = map->size;
28869ce434fSBarry Smith   while (hi - lo > 1) {
28969ce434fSBarry Smith     t = lo + (hi - lo) / 2;
29069ce434fSBarry Smith     if (idx < map->range[t]) hi = t;
29169ce434fSBarry Smith     else                     lo = t;
29269ce434fSBarry Smith   }
29369ce434fSBarry Smith   *owner = lo;
29469ce434fSBarry Smith   PetscFunctionReturn(0);
29569ce434fSBarry Smith }
29669ce434fSBarry Smith 
29769ce434fSBarry Smith /*@C
29869ce434fSBarry Smith      PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index
29969ce434fSBarry Smith 
30069ce434fSBarry Smith     Not Collective
30169ce434fSBarry Smith 
30269ce434fSBarry Smith    Input Parameters:
30369ce434fSBarry Smith +    map   - the layout
30469ce434fSBarry Smith -    idx   - global index to find the owner of
30569ce434fSBarry Smith 
306d8d19677SJose E. Roman    Output Parameters:
30769ce434fSBarry Smith +    owner - the owning rank
30869ce434fSBarry Smith -    lidx  - local index used by the owner for idx
30969ce434fSBarry Smith 
31069ce434fSBarry Smith    Level: developer
31169ce434fSBarry Smith 
31269ce434fSBarry Smith     Fortran Notes:
31369ce434fSBarry Smith       Not available from Fortran
31469ce434fSBarry Smith 
31569ce434fSBarry Smith @*/
3169fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscMPIInt *owner,PetscInt *lidx)
31769ce434fSBarry Smith {
31869ce434fSBarry Smith   PetscMPIInt lo = 0,hi,t;
31969ce434fSBarry Smith 
32069ce434fSBarry Smith   PetscFunctionBegin;
32138a25198SStefano Zampini #if defined(PETSC_USE_DEBUG)
3222c71b3e2SJacob Faibussowitsch   PetscCheck((map->n >= 0) && (map->N >= 0) && (map->range),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first");
3232c71b3e2SJacob Faibussowitsch   PetscCheck(idx >= 0 && idx <= map->N,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %" PetscInt_FMT " is out of range",idx);
32438a25198SStefano Zampini #endif
32538a25198SStefano Zampini   hi = map->size;
32669ce434fSBarry Smith   while (hi - lo > 1) {
32769ce434fSBarry Smith     t = lo + (hi - lo) / 2;
32869ce434fSBarry Smith     if (idx < map->range[t]) hi = t;
32969ce434fSBarry Smith     else                     lo = t;
33069ce434fSBarry Smith   }
33104799504SMark Adams   if (owner) *owner = lo;
33204799504SMark Adams   if (lidx) *lidx  = idx - map->range[lo];
33369ce434fSBarry Smith   PetscFunctionReturn(0);
33469ce434fSBarry Smith }
3359e03d832SJed Brown 
33601e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*);
3379621ec18SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromSizes(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscLayout*);
3389621ec18SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromRanges(MPI_Comm,const PetscInt[],PetscCopyMode,PetscInt,PetscLayout*);
33901e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout);
34001e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*);
34101e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*);
34201e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*);
34301e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt);
34401e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *);
34501e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt);
34601e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt *);
34701e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt);
34801e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*);
34901e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt *,PetscInt *);
35001e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt *[]);
351f92d6284SStefano Zampini PETSC_EXTERN PetscErrorCode PetscLayoutCompare(PetscLayout,PetscLayout,PetscBool*);
35201e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping);
35307acc2aeSBarry Smith PETSC_EXTERN PetscErrorCode PetscLayoutMapLocal(PetscLayout,PetscInt,const PetscInt[],PetscInt*,PetscInt**,PetscInt**);
35401e13f73SMatthew G. Knepley 
355ce605777SToby Isaac PETSC_EXTERN PetscErrorCode PetscParallelSortInt(PetscLayout, PetscLayout, PetscInt*, PetscInt*);
356ce605777SToby Isaac 
357ce605777SToby Isaac PETSC_EXTERN PetscErrorCode ISGetLayout(IS,PetscLayout*);
358*4e1d6e84SVaclav Hapla PETSC_EXTERN PetscErrorCode ISSetLayout(IS,PetscLayout);
359ce605777SToby Isaac 
360a2ce50c7SBarry Smith #endif
361