petsc/include/petscis.h

*323b833fSBarry Smith/* $Id: petscis.h,v 1.58 2001/01/15 21:44:24 bsmith Exp bsmith $ */
2eac72dbSBarry Smith
2eac72dbSBarry Smith/*
f8256253SLois Curfman McInnes   An index set is a generalization of a subset of integers.  Index sets
f8256253SLois Curfman McInnes   are used for defining scatters and gathers.
2eac72dbSBarry Smith*/
0a835dfdSSatish Balay#if !defined(__PETSCIS_H)
0a835dfdSSatish Balay#define __PETSCIS_H
2eac72dbSBarry Smith#include "petsc.h"
2eac72dbSBarry Smith
9e25ed09SBarry Smith#define IS_COOKIE PETSC_COOKIE+2
f0479e8cSBarry Smith
f09e8eb9SSatish Balaytypedef struct _p_IS* IS;
2eac72dbSBarry Smith
639f9d9dSBarry Smith/*
639f9d9dSBarry Smith    Default index set data structures that PETSc provides.
639f9d9dSBarry Smith*/
639f9d9dSBarry Smithtypedef enum {IS_GENERAL=0,IS_STRIDE=1,IS_BLOCK = 2} ISType;
ca44d042SBarry SmithEXTERN int   ISCreateGeneral(MPI_Comm,int,const int[],IS *);
ca44d042SBarry SmithEXTERN int   ISCreateBlock(MPI_Comm,int,int,const int[],IS *);
ca44d042SBarry SmithEXTERN int   ISCreateStride(MPI_Comm,int,int,int,IS *);
4b0e389bSBarry Smith
ca44d042SBarry SmithEXTERN int   ISDestroy(IS);
4b0e389bSBarry Smith
ca44d042SBarry SmithEXTERN int   ISSetPermutation(IS);
ca44d042SBarry SmithEXTERN int   ISPermutation(IS,PetscTruth*);
ca44d042SBarry SmithEXTERN int   ISSetIdentity(IS);
ca44d042SBarry SmithEXTERN int   ISIdentity(IS,PetscTruth*);
08480c60SBarry Smith
ca44d042SBarry SmithEXTERN int   ISGetIndices(IS,int *[]);
ca44d042SBarry SmithEXTERN int   ISRestoreIndices(IS,int *[]);
ca44d042SBarry SmithEXTERN int   ISGetSize(IS,int *);
05e11b22SBarry SmithEXTERN int   ISGetLocalSize(IS,int *);
ca44d042SBarry SmithEXTERN int   ISInvertPermutation(IS,int,IS*);
b0a32e0cSBarry SmithEXTERN int   ISView(IS,PetscViewer);
ca44d042SBarry SmithEXTERN int   ISEqual(IS,IS,PetscTruth *);
ca44d042SBarry SmithEXTERN int   ISSort(IS);
ca44d042SBarry SmithEXTERN int   ISSorted(IS,PetscTruth *);
ca44d042SBarry SmithEXTERN int   ISDifference(IS,IS,IS*);
ca44d042SBarry SmithEXTERN int   ISSum(IS,IS,IS*);
612dd529SBarry Smith
ca44d042SBarry SmithEXTERN int   ISBlock(IS,PetscTruth*);
ca44d042SBarry SmithEXTERN int   ISBlockGetIndices(IS,int *[]);
ca44d042SBarry SmithEXTERN int   ISBlockRestoreIndices(IS,int *[]);
ca44d042SBarry SmithEXTERN int   ISBlockGetSize(IS,int *);
ca44d042SBarry SmithEXTERN int   ISBlockGetBlockSize(IS,int *);
c16cb8f2SBarry Smith
ca44d042SBarry SmithEXTERN int   ISStride(IS,PetscTruth*);
ca44d042SBarry SmithEXTERN int   ISStrideGetInfo(IS,int *,int*);
c16cb8f2SBarry Smith
ca44d042SBarry SmithEXTERN int   ISStrideToGeneral(IS);
38f40f24SLois Curfman McInnes
ca44d042SBarry SmithEXTERN int   ISDuplicate(IS,IS*);
ca44d042SBarry SmithEXTERN int   ISAllGather(IS,IS*);
d64ed03dSBarry Smith
56cd22aeSBarry Smith/* --------------------------------------------------------------------------*/
56cd22aeSBarry Smith
639f9d9dSBarry Smith/*
90f02eecSBarry Smith   ISLocalToGlobalMappings are mappings from an arbitrary
90f02eecSBarry Smith  local ordering from 0 to n-1 to a global PETSc ordering
d4bb536fSBarry Smith  used by a vector or matrix.
d4bb536fSBarry Smith
d4bb536fSBarry Smith   Note: mapping from Local to Global is scalable; but Global
eec0b4cfSBarry Smith  to Local may not be if the range of global values represented locally
d4bb536fSBarry Smith  is very large.
74637425SBarry Smith
74637425SBarry Smith   Note: the ISLocalToGlobalMapping is actually a private object; it is included
74637425SBarry Smith  here for the MACRO ISLocalToGlobalMappingApply() to allow it to be inlined since
74637425SBarry Smith  it is used so often.
90f02eecSBarry Smith*/
d4bb536fSBarry Smith#define IS_LTOGM_COOKIE PETSC_COOKIE+12
74637425SBarry Smith
74637425SBarry Smithstruct _p_ISLocalToGlobalMapping{
74637425SBarry Smith  PETSCHEADER(int)
74637425SBarry Smith  int n;                  /* number of local indices */
74637425SBarry Smith  int *indices;           /* global index of each local index */
74637425SBarry Smith  int globalstart;        /* first global referenced in indices */
74637425SBarry Smith  int globalend;          /* last + 1 global referenced in indices */
74637425SBarry Smith  int *globals;           /* local index for each global index between start and end */
74637425SBarry Smith};
f09e8eb9SSatish Balaytypedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping;
987e4450SSatish Balaytypedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType;
90f02eecSBarry Smith
ca44d042SBarry SmithEXTERN int ISLocalToGlobalMappingCreate(MPI_Comm,int,const int[],ISLocalToGlobalMapping*);
ca44d042SBarry SmithEXTERN int ISLocalToGlobalMappingCreateIS(IS,ISLocalToGlobalMapping *);
b0a32e0cSBarry SmithEXTERN int ISLocalToGlobalMappingView(ISLocalToGlobalMapping,PetscViewer);
ca44d042SBarry SmithEXTERN int ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping);
ca44d042SBarry SmithEXTERN int ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
74637425SBarry SmithEXTERN int ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,int,const int[],int*,int[]);
74637425SBarry SmithEXTERN int ISLocalToGlobalMappingGetSize(ISLocalToGlobalMapping,int*);
74637425SBarry SmithEXTERN int ISLocalToGlobalMappingGetInfo(ISLocalToGlobalMapping,int*,int**,int**,int***);
74637425SBarry SmithEXTERN int ISLocalToGlobalMappingRestoreInfo(ISLocalToGlobalMapping,int*,int**,int**,int***);
*323b833fSBarry SmithEXTERN int ISLocalToGlobalMappingBlock(ISLocalToGlobalMapping,int,ISLocalToGlobalMapping*);
74637425SBarry Smith
74637425SBarry Smith#define ISLocalToGlobalMappingApply(mapping,N,in,out) 0;\
74637425SBarry Smith{\
74637425SBarry Smith  int _i,*_idx = (mapping)->indices,_Nmax = (mapping)->n;\
74637425SBarry Smith  for (_i=0; _i<N; _i++) {\
74637425SBarry Smith    if ((in)[_i] < 0) {(out)[_i] = (in)[_i]; continue;}\
29bbc08cSBarry Smith    if ((in)[_i] >= _Nmax) SETERRQ3(PETSC_ERR_ARG_OUTOFRANGE,"Local index %d too large %d (max) at %d",(in)[_i],_Nmax,_i);\
74637425SBarry Smith    (out)[_i] = _idx[(in)[_i]];\
74637425SBarry Smith  }\
74637425SBarry Smith}
90f02eecSBarry Smith
56cd22aeSBarry Smith/* --------------------------------------------------------------------------*/
56cd22aeSBarry Smith
90f02eecSBarry Smith/*
639f9d9dSBarry Smith     ISColorings are sets of IS's that define a coloring
639f9d9dSBarry Smith   of the underlying indices
639f9d9dSBarry Smith*/
f09e8eb9SSatish Balaystruct _p_ISColoring {
639f9d9dSBarry Smith  int      n;
639f9d9dSBarry Smith  IS       *is;
639f9d9dSBarry Smith  MPI_Comm comm;
639f9d9dSBarry Smith};
f09e8eb9SSatish Balaytypedef struct _p_ISColoring* ISColoring;
639f9d9dSBarry Smith
ca44d042SBarry SmithEXTERN int ISColoringCreate(MPI_Comm,int,const int[],ISColoring*);
ca44d042SBarry SmithEXTERN int ISColoringDestroy(ISColoring);
b0a32e0cSBarry SmithEXTERN int ISColoringView(ISColoring,PetscViewer);
ca44d042SBarry SmithEXTERN int ISColoringGetIS(ISColoring,int*,IS*[]);
22327b12SSatish BalayEXTERN int ISColoringRestoreIS(ISColoring,IS*[]);
639f9d9dSBarry Smith
dbef8a1cSBarry Smith/* --------------------------------------------------------------------------*/
dbef8a1cSBarry Smith
ca44d042SBarry SmithEXTERN int ISPartitioningToNumbering(IS,IS*);
ca44d042SBarry SmithEXTERN int ISPartitioningCount(IS,int[]);
dbef8a1cSBarry Smith
a2ce50c7SBarry Smith#endif
7588ac45SBarry Smith
7588ac45SBarry Smith
639f9d9dSBarry Smith
639f9d9dSBarry Smith