petsc/include/petscvec.h

2eac72dbSBarry Smith/*
2eac72dbSBarry Smith   This defines the abstract vector component. These are patterned
2eac72dbSBarry Smith   after the Level-1 Blas, but with some additions that have proved
2eac72dbSBarry Smith   useful. These include routines to allocate and free vectors.
2eac72dbSBarry Smith
2eac72dbSBarry Smith   Note that the routines that are normally thought of as returning a
2eac72dbSBarry Smith   value (e.g., dot, norm) return their value through an argument.
2eac72dbSBarry Smith   This allows these routines to be used with other datatype, such
2eac72dbSBarry Smith   as float and dcomplex.
2eac72dbSBarry Smith
2eac72dbSBarry Smith   All vectors should be declared as a Vec. All vector routines begin
2eac72dbSBarry Smith   with Vec.
2eac72dbSBarry Smith
2eac72dbSBarry Smith
2eac72dbSBarry Smith */
2eac72dbSBarry Smith
2eac72dbSBarry Smith#ifndef __VEC_PACKAGE
2eac72dbSBarry Smith#define __VEC_PACKAGE
2eac72dbSBarry Smith#include "is.h"
2eac72dbSBarry Smith
*9e25ed09SBarry Smith#define VEC_COOKIE         PETSC_COOKIE+3
*9e25ed09SBarry Smith#define VEC_SCATTER_COOKIE PETSC_COOKIE+4
*9e25ed09SBarry Smith
f0479e8cSBarry Smith
2eac72dbSBarry Smithtypedef struct _Vec*            Vec;
20563c6bSBarry Smithtypedef struct _VecScatterCtx*  VecScatterCtx;
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int VecCreateSequential(int,Vec *);
8ed539a5SBarry Smithextern int VecCreateSequentialBLAS(int,Vec *);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int VecCreateMPI(MPI_Comm,int,int,Vec *);
8ed539a5SBarry Smithextern int VecCreateMPIBLAS(MPI_Comm,int,int,Vec *);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int VecCreateInitialVector(int,Vec *);
2eac72dbSBarry Smith
8ed539a5SBarry Smithextern int VecDot(Vec, Vec, Scalar*);
8ed539a5SBarry Smithextern int VecTDot(Vec, Vec, Scalar*);
8ed539a5SBarry Smithextern int VecMDot(int,      Vec ,Vec*,Scalar*);
8ed539a5SBarry Smithextern int VecMTDot(int,      Vec ,Vec*,Scalar*);
8ed539a5SBarry Smithextern int VecNorm(Vec, double*);
20563c6bSBarry Smithextern int VecASum(Vec, double*);
8ed539a5SBarry Smithextern int VecMax(Vec, int *,    Scalar*);
8ed539a5SBarry Smithextern int VecScale(Scalar*, Vec);
8ed539a5SBarry Smithextern int VecCopy(Vec, Vec);
8ed539a5SBarry Smithextern int VecSet(Scalar*, Vec);
8ed539a5SBarry Smithextern int VecSwap(Vec, Vec);
8ed539a5SBarry Smithextern int VecAXPY(Scalar*, Vec, Vec);
8ed539a5SBarry Smithextern int VecMAXPY(int,      Scalar*, Vec ,Vec*);
8ed539a5SBarry Smithextern int VecAYPX(Scalar*, Vec, Vec);
8ed539a5SBarry Smithextern int VecWAXPY(Scalar*, Vec, Vec, Vec);
8ed539a5SBarry Smithextern int VecPMult(Vec, Vec, Vec);
8ed539a5SBarry Smithextern int VecPDiv(Vec, Vec, Vec);
8ed539a5SBarry Smithextern int VecCreate(Vec,Vec *);
8ed539a5SBarry Smithextern int VecDestroy(Vec);
8ed539a5SBarry Smithextern int VecGetVecs(Vec, int,Vec **);
8ed539a5SBarry Smithextern int VecFreeVecs(Vec*,int);
2eac72dbSBarry Smith
20563c6bSBarry Smithtypedef enum {NotSetValues, InsertValues, AddValues} InsertMode;
20563c6bSBarry Smith
20563c6bSBarry Smithextern int VecSetValues(Vec, int, int *,Scalar*,InsertMode);
8ed539a5SBarry Smithextern int VecBeginAssembly(Vec);
8ed539a5SBarry Smithextern int VecEndAssembly(Vec);
8ed539a5SBarry Smith
da3a660dSBarry Smith#define ScatterReverse 1
da3a660dSBarry Smith#define ScatterDown    2
da3a660dSBarry Smith#define ScatterUp      4
da3a660dSBarry Smith#define ScatterAll     8
d6dfbf8fSBarry Smithextern int VecScatterBegin(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx);
d6dfbf8fSBarry Smithextern int VecScatterEnd(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx);
20563c6bSBarry Smithextern int VecScatterCtxCreate(Vec,IS,Vec,IS,VecScatterCtx *);
20563c6bSBarry Smithextern int VecScatterCtxDestroy(VecScatterCtx);
d6dfbf8fSBarry Smithextern int VecScatterCtxCopy(VecScatterCtx,VecScatterCtx *);
d6dfbf8fSBarry Smith
d6dfbf8fSBarry Smith#define PipelineDown 0
d6dfbf8fSBarry Smith#define PipelineUp   1
d6dfbf8fSBarry Smithextern int VecPipelineBegin(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx);
d6dfbf8fSBarry Smithextern int VecPipelineEnd(Vec,IS,Vec,IS,InsertMode,int,VecScatterCtx);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int VecGetArray(Vec,Scalar**);
8ed539a5SBarry Smithextern int VecValidVector(Vec);
8ed539a5SBarry Smithextern int VecView(Vec, Viewer);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int VecGetSize(Vec,int *);
8ed539a5SBarry Smithextern int VecGetLocalSize(Vec,int *);
d6dfbf8fSBarry Smithextern int VecGetOwnershipRange(Vec,int*,int*);
8ed539a5SBarry Smith
8ed539a5SBarry Smith/* utility routines */
8ed539a5SBarry Smithextern int VecReciprocal(Vec);
2eac72dbSBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith