petsc/include/petscis.h

*dbef8a1cSBarry Smith/* $Id: is.h,v 1.36 1997/08/22 15:20:23 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*/
2eac72dbSBarry Smith#if !defined(__IS_PACKAGE)
2eac72dbSBarry Smith#define __IS_PACKAGE
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;
537820f0SBarry Smithextern int   ISCreateGeneral(MPI_Comm,int,int *,IS *);
537820f0SBarry Smithextern int   ISCreateBlock(MPI_Comm,int,int,int *,IS *);
537820f0SBarry Smithextern int   ISCreateStride(MPI_Comm,int,int,int,IS *);
4b0e389bSBarry Smith
4b0e389bSBarry Smithextern int   ISDestroy(IS);
4b0e389bSBarry Smith
aabeff55SBarry Smithextern int   ISSetPermutation(IS);
77c4ece6SBarry Smithextern int   ISPermutation(IS,PetscTruth*);
08480c60SBarry Smithextern int   ISSetIdentity(IS);
77c4ece6SBarry Smithextern int   ISIdentity(IS,PetscTruth*);
08480c60SBarry Smith
aabeff55SBarry Smithextern int   ISGetIndices(IS,int **);
aabeff55SBarry Smithextern int   ISRestoreIndices(IS,int **);
aabeff55SBarry Smithextern int   ISGetSize(IS,int *);
aabeff55SBarry Smithextern int   ISInvertPermutation(IS,IS*);
aabeff55SBarry Smithextern int   ISView(IS,Viewer);
77c4ece6SBarry Smithextern int   ISEqual(IS, IS, PetscTruth *);
0f453280SSatish Balayextern int   ISSort(IS);
77c4ece6SBarry Smithextern int   ISSorted(IS, PetscTruth *);
612dd529SBarry Smith
537820f0SBarry Smithextern int   ISBlock(IS,PetscTruth*);
c16cb8f2SBarry Smithextern int   ISBlockGetIndices(IS,int **);
c16cb8f2SBarry Smithextern int   ISBlockRestoreIndices(IS,int **);
537820f0SBarry Smithextern int   ISBlockGetSize(IS,int *);
537820f0SBarry Smithextern int   ISBlockGetBlockSize(IS,int *);
c16cb8f2SBarry Smith
537820f0SBarry Smithextern int   ISStride(IS,PetscTruth*);
c16cb8f2SBarry Smithextern int   ISStrideGetInfo(IS,int *,int*);
c16cb8f2SBarry Smith
d4bb536fSBarry Smithextern int   ISDuplicate(IS, IS *);
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
d4bb536fSBarry Smith  to local may not be if the range of global values represented locally
d4bb536fSBarry Smith  is very large.
90f02eecSBarry Smith*/
d4bb536fSBarry Smith#define IS_LTOGM_COOKIE PETSC_COOKIE+12
f09e8eb9SSatish Balaytypedef struct _p_ISLocalToGlobalMapping* ISLocalToGlobalMapping;
90f02eecSBarry Smith
d4bb536fSBarry Smithextern int ISLocalToGlobalMappingCreate(MPI_Comm,int, int*, ISLocalToGlobalMapping*);
90f02eecSBarry Smithextern int ISLocalToGlobalMappingDestroy(ISLocalToGlobalMapping);
d4bb536fSBarry Smithextern int ISLocalToGlobalMappingApply(ISLocalToGlobalMapping,int,int*,int *);
90f02eecSBarry Smithextern int ISLocalToGlobalMappingApplyIS(ISLocalToGlobalMapping,IS,IS*);
d4bb536fSBarry Smithtypedef enum {IS_GTOLM_MASK,IS_GTOLM_DROP} ISGlobalToLocalMappingType;
d4bb536fSBarry Smithextern int ISGlobalToLocalMappingApply(ISLocalToGlobalMapping,ISGlobalToLocalMappingType,
d4bb536fSBarry Smith                                       int,int *,int*,int *);
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
639f9d9dSBarry Smithextern int ISColoringDestroy(ISColoring);
639f9d9dSBarry Smithextern int ISColoringView(ISColoring,Viewer);
639f9d9dSBarry Smithextern int ISColoringCreate(MPI_Comm,int,int*,ISColoring*);
639f9d9dSBarry Smith
*dbef8a1cSBarry Smith/* --------------------------------------------------------------------------*/
*dbef8a1cSBarry Smith
*dbef8a1cSBarry Smith/*
*dbef8a1cSBarry Smith     ISPartitioning are sets of IS's that define a partioning
*dbef8a1cSBarry Smith   of the underlying indices. This is the same as a ISColoring.
*dbef8a1cSBarry Smith*/
*dbef8a1cSBarry Smith#define ISPartitioning ISColoring
*dbef8a1cSBarry Smith
*dbef8a1cSBarry Smith
*dbef8a1cSBarry Smith
a2ce50c7SBarry Smith#endif
7588ac45SBarry Smith
7588ac45SBarry Smith
639f9d9dSBarry Smith
639f9d9dSBarry Smith