xref: /petsc/include/petscis.h (revision 56cd22ae330b334c2f3e3e29533369e7780beb71)
1*56cd22aeSBarry Smith /* $Id: is.h,v 1.34 1997/05/23 18:39:08 balay Exp bsmith $ */
22eac72dbSBarry Smith 
32eac72dbSBarry Smith /*
4f8256253SLois Curfman McInnes    An index set is a generalization of a subset of integers.  Index sets
5f8256253SLois Curfman McInnes    are used for defining scatters and gathers.
62eac72dbSBarry Smith */
72eac72dbSBarry Smith #if !defined(__IS_PACKAGE)
82eac72dbSBarry Smith #define __IS_PACKAGE
92eac72dbSBarry Smith #include "petsc.h"
102eac72dbSBarry Smith 
119e25ed09SBarry Smith #define IS_COOKIE PETSC_COOKIE+2
12f0479e8cSBarry Smith 
13f09e8eb9SSatish Balay typedef struct _p_IS* IS;
142eac72dbSBarry Smith 
15639f9d9dSBarry Smith /*
16639f9d9dSBarry Smith     Default index set data structures that PETSc provides.
17639f9d9dSBarry Smith */
18639f9d9dSBarry Smith typedef enum {IS_GENERAL=0, IS_STRIDE=1, IS_BLOCK = 2} ISType;
19537820f0SBarry Smith extern int   ISCreateGeneral(MPI_Comm,int,int *,IS *);
20537820f0SBarry Smith extern int   ISCreateBlock(MPI_Comm,int,int,int *,IS *);
21537820f0SBarry Smith extern int   ISCreateStride(MPI_Comm,int,int,int,IS *);
224b0e389bSBarry Smith 
234b0e389bSBarry Smith extern int   ISDestroy(IS);
244b0e389bSBarry Smith 
25aabeff55SBarry Smith extern int   ISSetPermutation(IS);
2677c4ece6SBarry Smith extern int   ISPermutation(IS,PetscTruth*);
2708480c60SBarry Smith extern int   ISSetIdentity(IS);
2877c4ece6SBarry Smith extern int   ISIdentity(IS,PetscTruth*);
2908480c60SBarry Smith 
30aabeff55SBarry Smith extern int   ISGetIndices(IS,int **);
31aabeff55SBarry Smith extern int   ISRestoreIndices(IS,int **);
32aabeff55SBarry Smith extern int   ISGetSize(IS,int *);
33aabeff55SBarry Smith extern int   ISInvertPermutation(IS,IS*);
34aabeff55SBarry Smith extern int   ISView(IS,Viewer);
3577c4ece6SBarry Smith extern int   ISEqual(IS, IS, PetscTruth *);
360f453280SSatish Balay extern int   ISSort(IS);
3777c4ece6SBarry Smith extern int   ISSorted(IS, PetscTruth *);
38612dd529SBarry Smith 
39537820f0SBarry Smith extern int   ISBlock(IS,PetscTruth*);
40c16cb8f2SBarry Smith extern int   ISBlockGetIndices(IS,int **);
41c16cb8f2SBarry Smith extern int   ISBlockRestoreIndices(IS,int **);
42537820f0SBarry Smith extern int   ISBlockGetSize(IS,int *);
43537820f0SBarry Smith extern int   ISBlockGetBlockSize(IS,int *);
44c16cb8f2SBarry Smith 
45537820f0SBarry Smith extern int   ISStride(IS,PetscTruth*);
46c16cb8f2SBarry Smith extern int   ISStrideGetInfo(IS,int *,int*);
47c16cb8f2SBarry Smith 
48*56cd22aeSBarry Smith /* --------------------------------------------------------------------------*/
49*56cd22aeSBarry Smith 
50639f9d9dSBarry Smith /*
5190f02eecSBarry Smith    ISLocalToGlobalMappings are mappings from an arbitrary
5290f02eecSBarry Smith   local ordering from 0 to n-1 to a global PETSc ordering
5390f02eecSBarry Smith   used by a vector or matrix
5490f02eecSBarry Smith */
55f09e8eb9SSatish Balay struct _p_ISLocalToGlobalMapping{
5690f02eecSBarry Smith   int n;
5790f02eecSBarry Smith   int *indices;
5890f02eecSBarry Smith   int refcnt;
5990f02eecSBarry Smith };
60f09e8eb9SSatish Balay typedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping;
6190f02eecSBarry Smith 
6290f02eecSBarry Smith extern int ISLocalToGlobalMappingCreate(int, int*, ISLocalToGlobalMapping*);
6390f02eecSBarry Smith extern int ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping);
6490f02eecSBarry Smith #define ISLocalToGlobalMappingApply(mp,N,in,out) \
6590f02eecSBarry Smith   {\
6690f02eecSBarry Smith    int _i,*_idx = mp->indices; \
6790f02eecSBarry Smith    for ( _i=0; _i<N; _i++ ) { \
6890f02eecSBarry Smith      out[_i] = _idx[in[_i]]; \
6990f02eecSBarry Smith    }\
7090f02eecSBarry Smith   }
7190f02eecSBarry Smith #define ISLocalToGlobalMappingReference(mp) mp->refcnt++;
7290f02eecSBarry Smith extern int ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
7390f02eecSBarry Smith 
74*56cd22aeSBarry Smith /* --------------------------------------------------------------------------*/
75*56cd22aeSBarry Smith 
7690f02eecSBarry Smith /*
77639f9d9dSBarry Smith      ISColorings are sets of IS's that define a coloring
78639f9d9dSBarry Smith    of the underlying indices
79639f9d9dSBarry Smith */
80f09e8eb9SSatish Balay struct _p_ISColoring {
81639f9d9dSBarry Smith   int      n;
82639f9d9dSBarry Smith   IS       *is;
83639f9d9dSBarry Smith   MPI_Comm comm;
84639f9d9dSBarry Smith };
85f09e8eb9SSatish Balay typedef struct _p_ISColoring* ISColoring;
86639f9d9dSBarry Smith 
87639f9d9dSBarry Smith extern int ISColoringDestroy(ISColoring);
88639f9d9dSBarry Smith extern int ISColoringView(ISColoring,Viewer);
89639f9d9dSBarry Smith extern int ISColoringCreate(MPI_Comm,int,int*,ISColoring*);
90639f9d9dSBarry Smith 
91a2ce50c7SBarry Smith #endif
927588ac45SBarry Smith 
937588ac45SBarry Smith 
94639f9d9dSBarry Smith 
95639f9d9dSBarry Smith 
96