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 "petscsys.h" 8 #include "petscsf.h" 9 PETSC_EXTERN_CXX_BEGIN 10 11 #define IS_FILE_CLASSID 1211218 12 extern PetscClassId IS_CLASSID; 13 14 extern PetscErrorCode ISInitializePackage(const char[]); 15 16 /*S 17 IS - Abstract PETSc object that allows indexing. 18 19 Level: beginner 20 21 Concepts: indexing, stride 22 23 .seealso: ISCreateGeneral(), ISCreateBlock(), ISCreateStride(), ISGetIndices(), ISDestroy() 24 S*/ 25 typedef struct _p_IS* IS; 26 27 /*J 28 ISType - String with the name of a PETSc vector or the creation function 29 with an optional dynamic library name, for example 30 http://www.mcs.anl.gov/petsc/lib.a:myveccreate() 31 32 Level: beginner 33 34 .seealso: ISSetType(), IS 35 J*/ 36 #define ISType char* 37 #define ISGENERAL "general" 38 #define ISSTRIDE "stride" 39 #define ISBLOCK "block" 40 41 /* Dynamic creation and loading functions */ 42 extern PetscFList ISList; 43 extern PetscBool ISRegisterAllCalled; 44 extern PetscErrorCode ISSetType(IS, const ISType); 45 extern PetscErrorCode ISGetType(IS, const ISType *); 46 extern PetscErrorCode ISRegister(const char[],const char[],const char[],PetscErrorCode (*)(IS)); 47 extern PetscErrorCode ISRegisterAll(const char []); 48 extern PetscErrorCode ISRegisterDestroy(void); 49 extern PetscErrorCode ISCreate(MPI_Comm,IS*); 50 51 /*MC 52 ISRegisterDynamic - Adds a new vector component implementation 53 54 Synopsis: 55 PetscErrorCode ISRegisterDynamic(const char *name, const char *path, const char *func_name, PetscErrorCode (*create_func)(IS)) 56 57 Not Collective 58 59 Input Parameters: 60 + name - The name of a new user-defined creation routine 61 . path - The path (either absolute or relative) of the library containing this routine 62 . func_name - The name of routine to create method context 63 - create_func - The creation routine itself 64 65 Notes: 66 ISRegisterDynamic() may be called multiple times to add several user-defined vectors 67 68 If dynamic libraries are used, then the fourth input argument (routine_create) is ignored. 69 70 Sample usage: 71 .vb 72 ISRegisterDynamic("my_is","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyIStorCreate", MyIStorCreate); 73 .ve 74 75 Then, your vector type can be chosen with the procedural interface via 76 .vb 77 ISCreate(MPI_Comm, IS *); 78 ISSetType(IS,"my_vector_name"); 79 .ve 80 or at runtime via the option 81 .vb 82 -vec_type my_vector_name 83 .ve 84 85 Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values. 86 If your function is not being put into a shared library then use ISRegister() instead 87 88 Level: advanced 89 90 .keywords: IS, register 91 .seealso: ISRegisterAll(), ISRegisterDestroy(), ISRegister() 92 M*/ 93 #if defined(PETSC_USE_DYNAMIC_LIBRARIES) 94 #define ISRegisterDynamic(a,b,c,d) ISRegister(a,b,c,0) 95 #else 96 #define ISRegisterDynamic(a,b,c,d) ISRegister(a,b,c,d) 97 #endif 98 99 /* 100 Default index set data structures that PETSc provides. 101 */ 102 extern PetscErrorCode ISCreateGeneral(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,IS *); 103 extern PetscErrorCode ISGeneralSetIndices(IS,PetscInt,const PetscInt[],PetscCopyMode); 104 extern PetscErrorCode ISCreateBlock(MPI_Comm,PetscInt,PetscInt,const PetscInt[],PetscCopyMode,IS *); 105 extern PetscErrorCode ISBlockSetIndices(IS,PetscInt,PetscInt,const PetscInt[],PetscCopyMode); 106 extern PetscErrorCode ISCreateStride(MPI_Comm,PetscInt,PetscInt,PetscInt,IS *); 107 extern PetscErrorCode ISStrideSetStride(IS,PetscInt,PetscInt,PetscInt); 108 109 extern PetscErrorCode ISDestroy(IS*); 110 extern PetscErrorCode ISSetPermutation(IS); 111 extern PetscErrorCode ISPermutation(IS,PetscBool *); 112 extern PetscErrorCode ISSetIdentity(IS); 113 extern PetscErrorCode ISIdentity(IS,PetscBool *); 114 extern PetscErrorCode ISContiguousLocal(IS,PetscInt,PetscInt,PetscInt*,PetscBool*); 115 116 extern PetscErrorCode ISGetIndices(IS,const PetscInt *[]); 117 extern PetscErrorCode ISRestoreIndices(IS,const PetscInt *[]); 118 extern PetscErrorCode ISGetTotalIndices(IS,const PetscInt *[]); 119 extern PetscErrorCode ISRestoreTotalIndices(IS,const PetscInt *[]); 120 extern PetscErrorCode ISGetNonlocalIndices(IS,const PetscInt *[]); 121 extern PetscErrorCode ISRestoreNonlocalIndices(IS,const PetscInt *[]); 122 extern PetscErrorCode ISGetNonlocalIS(IS, IS *is); 123 extern PetscErrorCode ISRestoreNonlocalIS(IS, IS *is); 124 extern PetscErrorCode ISGetSize(IS,PetscInt *); 125 extern PetscErrorCode ISGetLocalSize(IS,PetscInt *); 126 extern PetscErrorCode ISInvertPermutation(IS,PetscInt,IS*); 127 extern PetscErrorCode ISView(IS,PetscViewer); 128 extern PetscErrorCode ISEqual(IS,IS,PetscBool *); 129 extern PetscErrorCode ISSort(IS); 130 extern PetscErrorCode ISSorted(IS,PetscBool *); 131 extern PetscErrorCode ISDifference(IS,IS,IS*); 132 extern PetscErrorCode ISSum(IS,IS,IS*); 133 extern PetscErrorCode ISExpand(IS,IS,IS*); 134 135 extern PetscErrorCode ISBlockGetIndices(IS,const PetscInt *[]); 136 extern PetscErrorCode ISBlockRestoreIndices(IS,const PetscInt *[]); 137 extern PetscErrorCode ISBlockGetLocalSize(IS,PetscInt *); 138 extern PetscErrorCode ISBlockGetSize(IS,PetscInt *); 139 extern PetscErrorCode ISGetBlockSize(IS,PetscInt*); 140 extern PetscErrorCode ISSetBlockSize(IS,PetscInt); 141 142 extern PetscErrorCode ISStrideGetInfo(IS,PetscInt *,PetscInt*); 143 144 extern PetscErrorCode ISToGeneral(IS); 145 146 extern PetscErrorCode ISDuplicate(IS,IS*); 147 extern PetscErrorCode ISCopy(IS,IS); 148 extern PetscErrorCode ISAllGather(IS,IS*); 149 extern PetscErrorCode ISComplement(IS,PetscInt,PetscInt,IS*); 150 extern PetscErrorCode ISConcatenate(MPI_Comm,PetscInt,const IS[],IS*); 151 extern PetscErrorCode ISListToColoring(MPI_Comm,PetscInt, IS[],IS*,IS*); 152 extern PetscErrorCode ISColoringToList(IS, IS, PetscInt*, IS *[]); 153 extern PetscErrorCode ISOnComm(IS,MPI_Comm,PetscCopyMode,IS*); 154 155 /* --------------------------------------------------------------------------*/ 156 extern PetscClassId IS_LTOGM_CLASSID; 157 158 /*S 159 ISLocalToGlobalMapping - mappings from an arbitrary 160 local ordering from 0 to n-1 to a global PETSc ordering 161 used by a vector or matrix. 162 163 Level: intermediate 164 165 Note: mapping from Local to Global is scalable; but Global 166 to Local may not be if the range of global values represented locally 167 is very large. 168 169 Note: the ISLocalToGlobalMapping is actually a private object; it is included 170 here for the inline function ISLocalToGlobalMappingApply() to allow it to be inlined since 171 it is used so often. 172 173 .seealso: ISLocalToGlobalMappingCreate() 174 S*/ 175 struct _p_ISLocalToGlobalMapping{ 176 PETSCHEADER(int); 177 PetscInt n; /* number of local indices */ 178 PetscInt *indices; /* global index of each local index */ 179 PetscInt globalstart; /* first global referenced in indices */ 180 PetscInt globalend; /* last + 1 global referenced in indices */ 181 PetscInt *globals; /* local index for each global index between start and end */ 182 }; 183 typedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping; 184 185 /*E 186 ISGlobalToLocalMappingType - Indicates if missing global indices are 187 188 IS_GTOLM_MASK - missing global indices are replaced with -1 189 IS_GTOLM_DROP - missing global indices are dropped 190 191 Level: beginner 192 193 .seealso: ISGlobalToLocalMappingApply() 194 195 E*/ 196 typedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType; 197 198 extern PetscErrorCode ISLocalToGlobalMappingCreate(MPI_Comm,PetscInt,const PetscInt[],PetscCopyMode,ISLocalToGlobalMapping*); 199 extern PetscErrorCode ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *); 200 extern PetscErrorCode ISLocalToGlobalMappingCreateSF(PetscSF,PetscInt,ISLocalToGlobalMapping*); 201 extern PetscErrorCode ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer); 202 extern PetscErrorCode ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping*); 203 extern PetscErrorCode ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*); 204 extern PetscErrorCode ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,PetscInt,const PetscInt[],PetscInt*,PetscInt[]); 205 extern PetscErrorCode ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,PetscInt*); 206 extern PetscErrorCode ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 207 extern PetscErrorCode ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,PetscInt*,PetscInt*[],PetscInt*[],PetscInt**[]); 208 extern PetscErrorCode ISLocalToGlobalMappingGetIndices(ISLocalToGlobalMapping,const PetscInt**); 209 extern PetscErrorCode ISLocalToGlobalMappingRestoreIndices(ISLocalToGlobalMapping,const PetscInt**); 210 extern PetscErrorCode ISLocalToGlobalMappingBlock(ISLocalToGlobalMapping,PetscInt,ISLocalToGlobalMapping*); 211 extern PetscErrorCode ISLocalToGlobalMappingUnBlock(ISLocalToGlobalMapping,PetscInt,ISLocalToGlobalMapping*); 212 extern PetscErrorCode ISLocalToGlobalMappingConcatenate(MPI_Comm,PetscInt,const ISLocalToGlobalMapping[],ISLocalToGlobalMapping*); 213 214 #undef __FUNCT__ 215 #define __FUNCT__ "ISLocalToGlobalMappingApply" 216 PETSC_STATIC_INLINE PetscErrorCode ISLocalToGlobalMappingApply(ISLocalToGlobalMapping mapping,PetscInt N,const PetscInt in[],PetscInt out[]) 217 { 218 PetscInt i,Nmax = mapping->n; 219 const PetscInt *idx = mapping->indices; 220 PetscFunctionBegin; 221 for (i=0; i<N; i++) { 222 if (in[i] < 0) {out[i] = in[i]; continue;} 223 if (in[i] >= Nmax) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Local index %D too large %D (max) at %D",in[i],Nmax,i); 224 out[i] = idx[in[i]]; 225 } 226 PetscFunctionReturn(0); 227 } 228 229 /* --------------------------------------------------------------------------*/ 230 /*E 231 ISColoringType - determines if the coloring is for the entire parallel grid/graph/matrix 232 or for just the local ghosted portion 233 234 Level: beginner 235 236 $ IS_COLORING_GLOBAL - does not include the colors for ghost points, this is used when the function 237 $ is called synchronously in parallel. This requires generating a "parallel coloring". 238 $ IS_COLORING_GHOSTED - includes colors for ghost points, this is used when the function can be called 239 $ seperately on individual processes with the ghost points already filled in. Does not 240 $ require a "parallel coloring", rather each process colors its local + ghost part. 241 $ Using this can result in much less parallel communication. In the paradigm of 242 $ DMGetLocalVector() and DMGetGlobalVector() this could be called IS_COLORING_LOCAL 243 244 .seealso: DMCreateColoring() 245 E*/ 246 typedef enum {IS_COLORING_GLOBAL,IS_COLORING_GHOSTED} ISColoringType; 247 extern const char *ISColoringTypes[]; 248 typedef unsigned PETSC_IS_COLOR_VALUE_TYPE ISColoringValue; 249 extern PetscErrorCode ISAllGatherColors(MPI_Comm,PetscInt,ISColoringValue*,PetscInt*,ISColoringValue*[]); 250 251 /*S 252 ISColoring - sets of IS's that define a coloring 253 of the underlying indices 254 255 Level: intermediate 256 257 Notes: 258 One should not access the *is records below directly because they may not yet 259 have been created. One should use ISColoringGetIS() to make sure they are 260 created when needed. 261 262 .seealso: ISColoringCreate(), ISColoringGetIS(), ISColoringView(), ISColoringGetIS() 263 S*/ 264 struct _n_ISColoring { 265 PetscInt refct; 266 PetscInt n; /* number of colors */ 267 IS *is; /* for each color indicates columns */ 268 MPI_Comm comm; 269 ISColoringValue *colors; /* for each column indicates color */ 270 PetscInt N; /* number of columns */ 271 ISColoringType ctype; 272 }; 273 typedef struct _n_ISColoring* ISColoring; 274 275 extern PetscErrorCode ISColoringCreate(MPI_Comm,PetscInt,PetscInt,const ISColoringValue[],ISColoring*); 276 extern PetscErrorCode ISColoringDestroy(ISColoring*); 277 extern PetscErrorCode ISColoringView(ISColoring,PetscViewer); 278 extern PetscErrorCode ISColoringGetIS(ISColoring,PetscInt*,IS*[]); 279 extern PetscErrorCode ISColoringRestoreIS(ISColoring,IS*[]); 280 #define ISColoringReference(coloring) ((coloring)->refct++,0) 281 #define ISColoringSetType(coloring,type) ((coloring)->ctype = type,0) 282 283 /* --------------------------------------------------------------------------*/ 284 285 extern PetscErrorCode ISPartitioningToNumbering(IS,IS*); 286 extern PetscErrorCode ISPartitioningCount(IS,PetscInt,PetscInt[]); 287 288 extern PetscErrorCode ISCompressIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]); 289 extern PetscErrorCode ISCompressIndicesSorted(PetscInt,PetscInt,PetscInt,const IS[],IS[]); 290 extern PetscErrorCode ISExpandIndicesGeneral(PetscInt,PetscInt,PetscInt,PetscInt,const IS[],IS[]); 291 292 PETSC_EXTERN_CXX_END 293 294 /* Reset __FUNCT__ in case the user does not define it themselves */ 295 #undef __FUNCT__ 296 #define __FUNCT__ "User provided function" 297 298 #endif 299