1 /* 2 An index set is a generalization of a subset of integers. Index sets 3 are used for defining scatters and gathers. 4 */ 5 #if !defined(__PETSCIS_H) 6 #define __PETSCIS_H 7 #include "petsc.h" 8 PETSC_EXTERN_CXX_BEGIN 9 10 extern PETSCVEC_DLLEXPORT PetscCookie IS_COOKIE; 11 12 /*S 13 IS - Abstract PETSc object that indexing. 14 15 Level: beginner 16 17 Concepts: indexing, stride 18 19 .seealso: ISCreateGeneral(), ISCreateBlock(), ISCreateStride(), ISGetIndices(), ISDestroy() 20 S*/ 21 typedef struct _p_IS* IS; 22 23 /* 24 Default index set data structures that PETSc provides. 25 */ 26 typedef enum {IS_GENERAL=0,IS_STRIDE=1,IS_BLOCK = 2} ISType; 27 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],IS *); 28 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCreateGeneralNC(MPI_Comm,PetscInt,const PetscInt[],IS *); 29 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCreateGeneralWithArray(MPI_Comm,PetscInt,PetscInt[],IS *); 30 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],IS *); 31 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *); 32 33 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISDestroy(IS); 34 35 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISSetPermutation(IS); 36 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISPermutation(IS,PetscTruth*); 37 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISSetIdentity(IS); 38 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISIdentity(IS,PetscTruth*); 39 40 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISGetIndices(IS,PetscInt *[]); 41 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISRestoreIndices(IS,PetscInt *[]); 42 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISGetSize(IS,PetscInt *); 43 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISGetLocalSize(IS,PetscInt *); 44 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISInvertPermutation(IS,PetscInt,IS*); 45 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISView(IS,PetscViewer); 46 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISEqual(IS,IS,PetscTruth *); 47 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISSort(IS); 48 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISSorted(IS,PetscTruth *); 49 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISDifference(IS,IS,IS*); 50 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISSum(IS,IS,IS*); 51 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISExpand(IS,IS,IS*); 52 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCopy(IS,IS*); 53 54 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISBlock(IS,PetscTruth*); 55 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISBlockGetIndices(IS,PetscInt *[]); 56 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISBlockRestoreIndices(IS,PetscInt *[]); 57 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISBlockGetSize(IS,PetscInt *); 58 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISBlockGetBlockSize(IS,PetscInt *); 59 60 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISStride(IS,PetscTruth*); 61 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISStrideGetInfo(IS,PetscInt *,PetscInt*); 62 63 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISStrideToGeneral(IS); 64 65 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISDuplicate(IS,IS*); 66 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISAllGather(IS,IS*); 67 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISAllGatherIndices(MPI_Comm,PetscInt,const PetscInt[],PetscInt*,PetscInt*[]); 68 69 /* --------------------------------------------------------------------------*/ 70 extern PETSCVEC_DLLEXPORT PetscCookie IS_LTOGM_COOKIE; 71 72 /*S 73 ISLocalToGlobalMapping - mappings from an arbitrary 74 local ordering from 0 to n-1 to a global PETSc ordering 75 used by a vector or matrix. 76 77 Level: intermediate 78 79 Note: mapping from Local to Global is scalable; but Global 80 to Local may not be if the range of global values represented locally 81 is very large. 82 83 Note: the ISLocalToGlobalMapping is actually a private object; it is included 84 here for the MACRO ISLocalToGlobalMappingApply() to allow it to be inlined since 85 it is used so often. 86 87 .seealso: ISLocalToGlobalMappingCreate() 88 S*/ 89 struct _p_ISLocalToGlobalMapping{ 90 PETSCHEADER(int); 91 PetscInt n; /* number of local indices */ 92 PetscInt *indices; /* global index of each local index */ 93 PetscInt globalstart; /* first global referenced in indices */ 94 PetscInt globalend; /* last + 1 global referenced in indices */ 95 PetscInt *globals; /* local index for each global index between start and end */ 96 }; 97 typedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping; 98 99 /*E 100 ISGlobalToLocalMappingType - Indicates if missing global indices are 101 102 IS_GTOLM_MASK - missing global indices are replaced with -1 103 IS_GTOLM_DROP - missing global indices are dropped 104 105 Level: beginner 106 107 .seealso: ISGlobalToLocalMappingApply() 108 109 E*/ 110 typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType; 111 112 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,const PetscInt[],ISLocalToGlobalMapping*); 113 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingCreateNC(MPI_Comm,PetscInt,const PetscInt[],ISLocalToGlobalMapping*); 114 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *); 115 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer); 116 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping); 117 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*); 118 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,PetscInt,const PetscInt[],PetscInt*,PetscInt[]); 119 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*); 120 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 121 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 122 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISLocalToGlobalMappingBlock(ISLocalToGlobalMapping,PetscInt,ISLocalToGlobalMapping*); 123 124 #define ISLocalToGlobalMappingApply(mapping,N,in,out) 0;\ 125 {\ 126 PetscInt _i,*_idx = (mapping)->indices,_Nmax = (mapping)->n;\ 127 for (_i=0; _i<N; _i++) {\ 128 if ((in)[_i] < 0) {(out)[_i] = (in)[_i]; continue;}\ 129 if ((in)[_i] >= _Nmax) SETERRQ3(PETSC_ERR_ARG_OUTOFRANGE,"Local index %D too large %D (max) at %D",(in)[_i],_Nmax,_i);\ 130 (out)[_i] = _idx[(in)[_i]];\ 131 }\ 132 } 133 134 /* --------------------------------------------------------------------------*/ 135 /*E 136 ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix 137 or for just the local ghosted portion 138 139 Level: beginner 140 141 $ IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function 142 $ is called synchronously in parallel. This requires generating a "parallel coloring". 143 $ IS_COLORING_GHOSTED - includes colors for ghost points, this is used when the function can be called 144 $ seperately on individual processes with the ghost points already filled in. Does not 145 $ require a "parallel coloring", rather each process colors its local + ghost part. 146 $ Using this can result in much less parallel communication. In the paradigm of 147 $ DAGetLocalVector() and DAGetGlobalVector() this could be called IS_COLORING_LOCAL 148 149 .seealso: DAGetColoring() 150 E*/ 151 typedef enum {IS_COLORING_GLOBAL,IS_COLORING_GHOSTED} ISColoringType; 152 extern const char *ISColoringTypes[]; 153 typedef unsigned PETSC_IS_COLOR_VALUE_TYPE ISColoringValue; 154 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]); 155 156 /*S 157 ISColoring - sets of IS's that define a coloring 158 of the underlying indices 159 160 Level: intermediate 161 162 Notes: 163 One should not access the *is records below directly because they may not yet 164 have been created. One should use ISColoringGetIS() to make sure they are 165 created when needed. 166 167 .seealso: ISColoringCreate(), ISColoringGetIS(), ISColoringView(), ISColoringGetIS() 168 S*/ 169 struct _n_ISColoring { 170 PetscInt refct; 171 PetscInt n; /* number of colors */ 172 IS *is; /* for each color indicates columns */ 173 MPI_Comm comm; 174 ISColoringValue *colors; /* for each column indicates color */ 175 PetscInt N; /* number of columns */ 176 ISColoringType ctype; 177 }; 178 typedef struct _n_ISColoring* ISColoring; 179 180 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],ISColoring*); 181 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISColoringDestroy(ISColoring); 182 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISColoringView(ISColoring,PetscViewer); 183 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISColoringGetIS(ISColoring,PetscInt*,IS*[]); 184 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISColoringRestoreIS(ISColoring,IS*[]); 185 #define ISColoringReference(coloring) ((coloring)->refct++,0) 186 #define ISColoringSetType(coloring,type) ((coloring)->ctype = type,0) 187 188 /* --------------------------------------------------------------------------*/ 189 190 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISPartitioningToNumbering(IS,IS*); 191 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISPartitioningCount(IS,PetscInt[]); 192 193 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,const IS[],IS[]); 194 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]); 195 EXTERN PetscErrorCode PETSCVEC_DLLEXPORT ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,const IS[],IS[]); 196 197 PETSC_EXTERN_CXX_END 198 #endif 199