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 7*ac09b921SBarry Smith 82c8e378dSBarry Smith #include <petscsys.h> 90c312b8eSJed Brown #include <petscsftypes.h> 10ea844a1aSMatthew Knepley #include <petscsectiontypes.h> 114914ba2bSBarry Smith #include <petscistypes.h> /*I "petscis.h" I*/ 122eac72dbSBarry Smith 13*ac09b921SBarry Smith /* SUBMANSEC = IS */ 14*ac09b921SBarry Smith 1597b48c8fSBarry Smith #define IS_FILE_CLASSID 1211218 16014dd563SJed Brown PETSC_EXTERN PetscClassId IS_CLASSID; 17f0479e8cSBarry Smith 18607a6623SBarry Smith PETSC_EXTERN PetscErrorCode ISInitializePackage(void); 192b6de112SBarry Smith 2076bdecfbSBarry Smith /*J 218f6c3df8SBarry Smith ISType - String with the name of a PETSc index set type 2227bdab1eSBarry Smith 2327bdab1eSBarry Smith Level: beginner 2427bdab1eSBarry Smith 25db781477SPatrick Sanan .seealso: `ISSetType()`, `IS`, `ISCreate()`, `ISRegister()` 2676bdecfbSBarry Smith J*/ 2719fd82e9SBarry Smith typedef const char* ISType; 2827bdab1eSBarry Smith #define ISGENERAL "general" 2927bdab1eSBarry Smith #define ISSTRIDE "stride" 3027bdab1eSBarry Smith #define ISBLOCK "block" 3127bdab1eSBarry Smith 3227bdab1eSBarry Smith /* Dynamic creation and loading functions */ 33140e18c1SBarry Smith PETSC_EXTERN PetscFunctionList ISList; 3419fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode ISSetType(IS,ISType); 3519fd82e9SBarry Smith PETSC_EXTERN PetscErrorCode ISGetType(IS,ISType*); 36bdf89e91SBarry Smith PETSC_EXTERN PetscErrorCode ISRegister(const char[],PetscErrorCode (*)(IS)); 37014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCreate(MPI_Comm,IS*); 3827bdab1eSBarry Smith 39014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISDestroy(IS*); 40014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSetPermutation(IS); 41014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISPermutation(IS,PetscBool*); 42014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSetIdentity(IS); 43014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISIdentity(IS,PetscBool*); 44014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*); 4508480c60SBarry Smith 462a1da528SToby Isaac /*E 472a1da528SToby Isaac ISInfo - Info that may either be computed or set as known for an index set 482a1da528SToby Isaac 492a1da528SToby Isaac Level: beginner 502a1da528SToby Isaac 512a1da528SToby Isaac Any additions/changes here MUST also be made in include/petsc/finclude/petscis.h 522a1da528SToby Isaac Any additions/changes here must also be made in src/vec/vec/interface/dlregisvec.c in ISInfos[] 532a1da528SToby Isaac 542a1da528SToby Isaac Developer Notes: 552a1da528SToby Isaac Entries that are negative need not be called collectively by all processes. 562a1da528SToby Isaac 57db781477SPatrick Sanan .seealso: `ISSetInfo()` 582a1da528SToby Isaac E*/ 592a1da528SToby Isaac typedef enum {IS_INFO_MIN = -1, 602a1da528SToby Isaac IS_SORTED = 0, 612a1da528SToby Isaac IS_UNIQUE = 1, 622a1da528SToby Isaac IS_PERMUTATION = 2, 632a1da528SToby Isaac IS_INTERVAL = 3, 642a1da528SToby Isaac IS_IDENTITY = 4, 652a1da528SToby Isaac IS_INFO_MAX = 5} ISInfo; 662a1da528SToby Isaac 672a1da528SToby Isaac typedef enum {IS_LOCAL, IS_GLOBAL} ISInfoType; 682a1da528SToby Isaac 692a1da528SToby Isaac PETSC_EXTERN PetscErrorCode ISSetInfo(IS,ISInfo,ISInfoType,PetscBool,PetscBool); 70657dc977SToby Isaac PETSC_EXTERN PetscErrorCode ISGetInfo(IS,ISInfo,ISInfoType,PetscBool,PetscBool*); 712a1da528SToby Isaac PETSC_EXTERN PetscErrorCode ISClearInfoCache(IS,PetscBool); 72014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetIndices(IS,const PetscInt*[]); 73014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreIndices(IS,const PetscInt*[]); 74014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetTotalIndices(IS,const PetscInt*[]); 75014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt*[]); 76014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt*[]); 77014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt*[]); 78d60670a5SStefano Zampini PETSC_EXTERN PetscErrorCode ISGetNonlocalIS(IS,IS*); 79d60670a5SStefano Zampini PETSC_EXTERN PetscErrorCode ISRestoreNonlocalIS(IS,IS*); 80014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetSize(IS,PetscInt*); 81014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetLocalSize(IS,PetscInt*); 82014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*); 83014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISView(IS,PetscViewer); 84fe2efc57SMark PETSC_EXTERN PetscErrorCode ISViewFromOptions(IS,PetscObject,const char[]); 85235f7792SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISLoad(IS,PetscViewer); 86014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISEqual(IS,IS,PetscBool*); 87e8386968SVaclav Hapla PETSC_EXTERN PetscErrorCode ISEqualUnsorted(IS,IS,PetscBool *); 88014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSort(IS); 89b080c0f9SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISSortRemoveDups(IS); 90014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSorted(IS,PetscBool*); 91014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISDifference(IS,IS,IS*); 92014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSum(IS,IS,IS*); 93014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISExpand(IS,IS,IS*); 943daafeecSToby Isaac PETSC_EXTERN PetscErrorCode ISIntersect(IS,IS,IS*); 95132da990SBarry Smith PETSC_EXTERN PetscErrorCode ISGetMinMax(IS,PetscInt*,PetscInt*); 96612dd529SBarry Smith 97c3c3c9f4SToby Isaac PETSC_EXTERN PetscErrorCode ISLocate(IS,PetscInt,PetscInt*); 989305a4c7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISGetPointRange(IS,PetscInt*,PetscInt*,const PetscInt**); 999305a4c7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISRestorePointRange(IS,PetscInt*,PetscInt*,const PetscInt**); 1009305a4c7SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISGetPointSubrange(IS,PetscInt,PetscInt,const PetscInt*); 101c3c3c9f4SToby Isaac 102014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISGetBlockSize(IS,PetscInt*); 103014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISSetBlockSize(IS,PetscInt); 104c16cb8f2SBarry Smith 105014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISToGeneral(IS); 10638f40f24SLois Curfman McInnes 107014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISDuplicate(IS,IS*); 108014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCopy(IS,IS); 1099fdaf958SVaclav Hapla PETSC_EXTERN PetscErrorCode ISShift(IS,PetscInt,IS); 110014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISAllGather(IS,IS*); 111014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*); 112014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*); 113bb74729cSDmitry Karpeev PETSC_EXTERN PetscErrorCode ISListToPair(MPI_Comm,PetscInt,IS[],IS*,IS*); 114bb74729cSDmitry Karpeev PETSC_EXTERN PetscErrorCode ISPairToList(IS,IS,PetscInt*,IS*[]); 115bb74729cSDmitry Karpeev PETSC_EXTERN PetscErrorCode ISEmbed(IS,IS,PetscBool,IS*); 1165ea6c424SDmitry Karpeev PETSC_EXTERN PetscErrorCode ISSortPermutation(IS,PetscBool,IS*); 117014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*); 1186583bcc1SStefano Zampini PETSC_EXTERN PetscErrorCode ISRenumber(IS,IS,PetscInt*,IS*); 1196c04a3c5SFande Kong PETSC_EXTERN PetscErrorCode ISCreateSubIS(IS,IS,IS*); 120d64ed03dSBarry Smith 12184933e40SVaclav Hapla /* ISGENERAL specific */ 12284933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS*); 12384933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode); 1249bc6f2f1SVaclav Hapla PETSC_EXTERN PetscErrorCode ISGeneralSetIndicesFromMask(IS,PetscInt,PetscInt,const PetscBool[]); 12553bb9c4cSVaclav Hapla PETSC_EXTERN PetscErrorCode ISGeneralFilter(IS,PetscInt,PetscInt); 12653bb9c4cSVaclav Hapla 12784933e40SVaclav Hapla /* ISBLOCK specific */ 12884933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS*); 12984933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode); 13084933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockGetIndices(IS,const PetscInt*[]); 13184933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt*[]); 13284933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockGetLocalSize(IS,PetscInt*); 13384933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISBlockGetSize(IS,PetscInt*); 13484933e40SVaclav Hapla 13584933e40SVaclav Hapla /* ISSTRIDE specific */ 13684933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS*); 13784933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt); 13884933e40SVaclav Hapla PETSC_EXTERN PetscErrorCode ISStrideGetInfo(IS,PetscInt*,PetscInt*); 13984933e40SVaclav Hapla 14056cd22aeSBarry Smith /* --------------------------------------------------------------------------*/ 141014dd563SJed Brown PETSC_EXTERN PetscClassId IS_LTOGM_CLASSID; 14256cd22aeSBarry Smith 1435c20da3cSBarry Smith /*E 1440040bde1SJunchao Zhang ISGlobalToLocalMappingMode - Indicates mapping behavior if global indices are missing 1455c20da3cSBarry Smith 1460040bde1SJunchao Zhang IS_GTOLM_MASK - missing global indices are masked by mapping them to a local index of -1 1475c20da3cSBarry Smith IS_GTOLM_DROP - missing global indices are dropped 1485c20da3cSBarry Smith 1495c20da3cSBarry Smith Level: beginner 1505c20da3cSBarry Smith 151db781477SPatrick Sanan .seealso: `ISGlobalToLocalMappingApplyBlock()`, `ISGlobalToLocalMappingApply()` 1525c20da3cSBarry Smith 1535c20da3cSBarry Smith E*/ 154413f72f0SBarry Smith typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingMode; 15590f02eecSBarry Smith 156413f72f0SBarry Smith /*J 157413f72f0SBarry Smith ISLocalToGlobalMappingType - String with the name of a mapping method 158413f72f0SBarry Smith 159413f72f0SBarry Smith Level: beginner 160413f72f0SBarry Smith 161db781477SPatrick Sanan .seealso: `ISLocalToGlobalMappingSetType()`, `ISLocalToGlobalSetFromOptions()` 162413f72f0SBarry Smith J*/ 163413f72f0SBarry Smith typedef const char* ISLocalToGlobalMappingType; 164413f72f0SBarry Smith #define ISLOCALTOGLOBALMAPPINGBASIC "basic" 165413f72f0SBarry Smith #define ISLOCALTOGLOBALMAPPINGHASH "hash" 166413f72f0SBarry Smith 167413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType); 168a0d79125SStefano Zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetType(ISLocalToGlobalMapping,ISLocalToGlobalMappingType*); 1691d36bdfdSBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegister(const char[],PetscErrorCode (*)(ISLocalToGlobalMapping)); 170413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRegisterAll(void); 171f0413b6fSBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*); 172014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *); 173014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*); 1747e99dc12SLawrence Mitchell PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetFromOptions(ISLocalToGlobalMapping); 175413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetUp(ISLocalToGlobalMapping); 176014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer); 177fe2efc57SMark PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingViewFromOptions(ISLocalToGlobalMapping,PetscObject,const char[]); 178662df134SStefano Zampini 179014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*); 18004a59952SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]); 18145b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyBlock(ISLocalToGlobalMapping,PetscInt,const PetscInt[],PetscInt[]); 182014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*); 183413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]); 184413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyBlock(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,PetscInt,const PetscInt[],PetscInt*,PetscInt[]); 185413f72f0SBarry Smith PETSC_EXTERN PetscErrorCode ISGlobalToLocalMappingApplyIS(ISLocalToGlobalMapping,ISGlobalToLocalMappingMode,IS,IS*); 186014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*); 1871bd0b88eSStefano Zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]); 1881bd0b88eSStefano Zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreNodeInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt**[]); 189014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 190014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 1916a818285SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 1926a818285SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 193014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**); 194014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**); 19545b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockIndices(ISLocalToGlobalMapping,const PetscInt**); 19645b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingRestoreBlockIndices(ISLocalToGlobalMapping,const PetscInt**); 197014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*); 19845b6f7e9SBarry Smith PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingGetBlockSize(ISLocalToGlobalMapping,PetscInt*); 19963fa5c83Sstefano_zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingSetBlockSize(ISLocalToGlobalMapping,PetscInt); 2006658fb44Sstefano_zampini PETSC_EXTERN PetscErrorCode ISLocalToGlobalMappingDuplicate(ISLocalToGlobalMapping,ISLocalToGlobalMapping*); 20145b6f7e9SBarry Smith 20256cd22aeSBarry Smith /* --------------------------------------------------------------------------*/ 203b9617806SBarry Smith /*E 204b9617806SBarry Smith ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix 205b9617806SBarry Smith or for just the local ghosted portion 206b9617806SBarry Smith 207b9617806SBarry Smith Level: beginner 208b9617806SBarry Smith 2098ee2e534SBarry Smith $ IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function 2108ee2e534SBarry Smith $ is called synchronously in parallel. This requires generating a "parallel coloring". 2115bdb020cSBarry Smith $ IS_COLORING_LOCAL - includes colors for ghost points, this is used when the function can be called 212bebe2cf6SSatish Balay $ separately on individual processes with the ghost points already filled in. Does not 2138ee2e534SBarry Smith $ require a "parallel coloring", rather each process colors its local + ghost part. 2145bdb020cSBarry Smith $ Using this can result in much less parallel communication. Currently only works 2155bdb020cSBarry Smith $ with DMDA and if you call MatFDColoringSetFunction() with the local function. 21673d7d85fSBarry Smith 217db781477SPatrick Sanan .seealso: `DMCreateColoring()` 218b9617806SBarry Smith E*/ 2195bdb020cSBarry Smith typedef enum {IS_COLORING_GLOBAL,IS_COLORING_LOCAL} ISColoringType; 2206a6fc655SJed Brown PETSC_EXTERN const char *const ISColoringTypes[]; 221569ea7c4SPierre Jolivet typedef unsigned PETSC_IS_COLORING_VALUE_TYPE ISColoringValue; 222569ea7c4SPierre Jolivet #define IS_COLORING_MAX PETSC_IS_COLORING_MAX 223569ea7c4SPierre Jolivet #define MPIU_COLORING_VALUE PETSC_MPIU_IS_COLORING_VALUE_TYPE 224014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]); 225dde82324SBarry Smith 226aaf3ff59SMatthew G. Knepley PETSC_EXTERN PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],PetscCopyMode,ISColoring*); 227014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISColoringDestroy(ISColoring*); 228014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISColoringView(ISColoring,PetscViewer); 2298aec7d55SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringViewFromOptions(ISColoring,PetscObject,const char[]); 230071fcb05SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringGetIS(ISColoring,PetscCopyMode,PetscInt*,IS*[]); 231071fcb05SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringRestoreIS(ISColoring,PetscCopyMode,IS*[]); 23249b734d2SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringReference(ISColoring); 23349b734d2SBarry Smith PETSC_EXTERN PetscErrorCode ISColoringSetType(ISColoring,ISColoringType); 234bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode ISColoringGetType(ISColoring,ISColoringType*); 235bdaf1daeSBarry Smith PETSC_EXTERN PetscErrorCode ISColoringGetColors(ISColoring,PetscInt*,PetscInt*,const ISColoringValue**); 2363a7fca6bSBarry Smith 237dbef8a1cSBarry Smith /* --------------------------------------------------------------------------*/ 23894f0491fSFande Kong PETSC_EXTERN PetscErrorCode ISBuildTwoSided(IS,IS,IS*); 239014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISPartitioningToNumbering(IS,IS*); 240014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]); 241dbef8a1cSBarry Smith 242014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]); 243014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]); 244014dd563SJed Brown PETSC_EXTERN PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]); 245d9489beaSHong Zhang 24669ce434fSBarry Smith struct _n_PetscLayout{ 24769ce434fSBarry Smith MPI_Comm comm; 24838a25198SStefano Zampini PetscMPIInt size; 24969ce434fSBarry Smith PetscInt n,N; /* local, global vector size */ 25069ce434fSBarry Smith PetscInt rstart,rend; /* local start, local end + 1 */ 25169ce434fSBarry Smith PetscInt *range; /* the offset of each processor */ 2529621ec18SVaclav Hapla PetscBool range_alloc; /* should range be freed in Destroy? */ 25333d57670SJed Brown PetscInt bs; /* number of elements in each block (generally for multi-component 25433d57670SJed Brown * problems). Defaults to -1 and can be arbitrarily lazy so always use 25533d57670SJed Brown * PetscAbs(map->bs) when accessing directly and expecting result to be 25633d57670SJed Brown * positive. Do NOT multiply above numbers by bs */ 2572a7a6963SBarry Smith PetscInt refcnt; /* MPI Vecs obtained with VecDuplicate() and from MatCreateVecs() reuse map of input object */ 25869ce434fSBarry Smith ISLocalToGlobalMapping mapping; /* mapping used in Vec/MatSetValuesLocal() */ 259ca5434daSLawrence Mitchell PetscBool setupcalled; /* Forbid setup more than once */ 260ca5434daSLawrence Mitchell PetscInt oldn,oldN; /* Checking if setup is allowed */ 261ca5434daSLawrence Mitchell PetscInt oldbs; /* And again */ 26269ce434fSBarry Smith }; 26369ce434fSBarry Smith 2647e3c27c9SBarry Smith /*@C 26569ce434fSBarry Smith PetscLayoutFindOwner - Find the owning rank for a global index 26669ce434fSBarry Smith 26769ce434fSBarry Smith Not Collective 26869ce434fSBarry Smith 26969ce434fSBarry Smith Input Parameters: 27069ce434fSBarry Smith + map - the layout 27169ce434fSBarry Smith - idx - global index to find the owner of 27269ce434fSBarry Smith 27369ce434fSBarry Smith Output Parameter: 27469ce434fSBarry Smith . owner - the owning rank 27569ce434fSBarry Smith 27669ce434fSBarry Smith Level: developer 27769ce434fSBarry Smith 27869ce434fSBarry Smith Fortran Notes: 27969ce434fSBarry Smith Not available from Fortran 28069ce434fSBarry Smith 28169ce434fSBarry Smith @*/ 2829fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscLayoutFindOwner(PetscLayout map,PetscInt idx,PetscMPIInt *owner) 28369ce434fSBarry Smith { 28469ce434fSBarry Smith PetscMPIInt lo = 0,hi,t; 28569ce434fSBarry Smith 28669ce434fSBarry Smith PetscFunctionBegin; 28769ce434fSBarry Smith *owner = -1; /* GCC erroneously issues warning about possibly uninitialized use when error condition */ 28838a25198SStefano Zampini #if defined(PETSC_USE_DEBUG) 2892c71b3e2SJacob Faibussowitsch PetscCheck((map->n >= 0) && (map->N >= 0) && (map->range),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first"); 2902c71b3e2SJacob Faibussowitsch PetscCheck(idx >= 0 && idx <= map->N,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %" PetscInt_FMT " is out of range",idx); 29138a25198SStefano Zampini #endif 29238a25198SStefano Zampini hi = map->size; 29369ce434fSBarry Smith while (hi - lo > 1) { 29469ce434fSBarry Smith t = lo + (hi - lo) / 2; 29569ce434fSBarry Smith if (idx < map->range[t]) hi = t; 29669ce434fSBarry Smith else lo = t; 29769ce434fSBarry Smith } 29869ce434fSBarry Smith *owner = lo; 29969ce434fSBarry Smith PetscFunctionReturn(0); 30069ce434fSBarry Smith } 30169ce434fSBarry Smith 30269ce434fSBarry Smith /*@C 30369ce434fSBarry Smith PetscLayoutFindOwnerIndex - Find the owning rank and the local index for a global index 30469ce434fSBarry Smith 30569ce434fSBarry Smith Not Collective 30669ce434fSBarry Smith 30769ce434fSBarry Smith Input Parameters: 30869ce434fSBarry Smith + map - the layout 30969ce434fSBarry Smith - idx - global index to find the owner of 31069ce434fSBarry Smith 311d8d19677SJose E. Roman Output Parameters: 31269ce434fSBarry Smith + owner - the owning rank 31369ce434fSBarry Smith - lidx - local index used by the owner for idx 31469ce434fSBarry Smith 31569ce434fSBarry Smith Level: developer 31669ce434fSBarry Smith 31769ce434fSBarry Smith Fortran Notes: 31869ce434fSBarry Smith Not available from Fortran 31969ce434fSBarry Smith 32069ce434fSBarry Smith @*/ 3219fbee547SJacob Faibussowitsch static inline PetscErrorCode PetscLayoutFindOwnerIndex(PetscLayout map,PetscInt idx,PetscMPIInt *owner,PetscInt *lidx) 32269ce434fSBarry Smith { 32369ce434fSBarry Smith PetscMPIInt lo = 0,hi,t; 32469ce434fSBarry Smith 32569ce434fSBarry Smith PetscFunctionBegin; 32638a25198SStefano Zampini #if defined(PETSC_USE_DEBUG) 3272c71b3e2SJacob Faibussowitsch PetscCheck((map->n >= 0) && (map->N >= 0) && (map->range),PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE,"PetscLayoutSetUp() must be called first"); 3282c71b3e2SJacob Faibussowitsch PetscCheck(idx >= 0 && idx <= map->N,PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Index %" PetscInt_FMT " is out of range",idx); 32938a25198SStefano Zampini #endif 33038a25198SStefano Zampini hi = map->size; 33169ce434fSBarry Smith while (hi - lo > 1) { 33269ce434fSBarry Smith t = lo + (hi - lo) / 2; 33369ce434fSBarry Smith if (idx < map->range[t]) hi = t; 33469ce434fSBarry Smith else lo = t; 33569ce434fSBarry Smith } 33604799504SMark Adams if (owner) *owner = lo; 33704799504SMark Adams if (lidx) *lidx = idx - map->range[lo]; 33869ce434fSBarry Smith PetscFunctionReturn(0); 33969ce434fSBarry Smith } 3409e03d832SJed Brown 34101e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutCreate(MPI_Comm,PetscLayout*); 3429621ec18SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromSizes(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscLayout*); 3439621ec18SVaclav Hapla PETSC_EXTERN PetscErrorCode PetscLayoutCreateFromRanges(MPI_Comm,const PetscInt[],PetscCopyMode,PetscInt,PetscLayout*); 34401e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetUp(PetscLayout); 34501e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutDestroy(PetscLayout*); 34601e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutDuplicate(PetscLayout,PetscLayout*); 34701e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutReference(PetscLayout,PetscLayout*); 34801e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetLocalSize(PetscLayout,PetscInt); 34901e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetLocalSize(PetscLayout,PetscInt *); 35001e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetSize(PetscLayout,PetscInt); 35101e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetSize(PetscLayout,PetscInt*); 35201e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetBlockSize(PetscLayout,PetscInt); 35301e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetBlockSize(PetscLayout,PetscInt*); 35401e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetRange(PetscLayout,PetscInt*,PetscInt*); 35501e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutGetRanges(PetscLayout,const PetscInt*[]); 356f92d6284SStefano Zampini PETSC_EXTERN PetscErrorCode PetscLayoutCompare(PetscLayout,PetscLayout,PetscBool*); 35701e13f73SMatthew G. Knepley PETSC_EXTERN PetscErrorCode PetscLayoutSetISLocalToGlobalMapping(PetscLayout,ISLocalToGlobalMapping); 35807acc2aeSBarry Smith PETSC_EXTERN PetscErrorCode PetscLayoutMapLocal(PetscLayout,PetscInt,const PetscInt[],PetscInt*,PetscInt**,PetscInt**); 35901e13f73SMatthew G. Knepley 360ce605777SToby Isaac PETSC_EXTERN PetscErrorCode PetscParallelSortInt(PetscLayout, PetscLayout, PetscInt*, PetscInt*); 361ce605777SToby Isaac 362ce605777SToby Isaac PETSC_EXTERN PetscErrorCode ISGetLayout(IS,PetscLayout*); 3634e1d6e84SVaclav Hapla PETSC_EXTERN PetscErrorCode ISSetLayout(IS,PetscLayout); 364ce605777SToby Isaac 365a2ce50c7SBarry Smith #endif 366