petsc/include/petscvec.h

*afc8d9b6SBarry Smith/* $Id: vec.h,v 1.37 1995/11/01 19:12:32 bsmith Exp bsmith $ */
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
b56ba379SLois Curfman McInnestypedef enum { VECSAME=-1, VECSEQ, VECMPI } VecType;
f0479e8cSBarry Smith
2eac72dbSBarry Smithtypedef struct _Vec*         Vec;
08480c60SBarry Smithtypedef struct _VecScatter*  VecScatter;
2eac72dbSBarry Smith
de7da479SBarry Smithextern int VecCreateSeq(MPI_Comm,int,Vec *);
8ed539a5SBarry Smithextern int VecCreateMPI(MPI_Comm,int,int,Vec *);
6469c4f9SBarry Smithextern int VecCreate(MPI_Comm,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*);
cddf8d76SBarry Smith
cddf8d76SBarry Smithtypedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4} NormType;
cddf8d76SBarry Smith#define NORM_MAX NORM_INFINITY
cddf8d76SBarry Smithextern int VecNorm(Vec,NormType,double *);
ee50ffe9SBarry Smithextern int VecSum(Vec,Scalar*);
7c16e1c9SBarry Smithextern int VecMax(Vec, int *,    double*);
7c16e1c9SBarry Smithextern int VecMin(Vec, int *,    double*);
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);
6469c4f9SBarry Smithextern int VecDuplicate(Vec,Vec *);
8ed539a5SBarry Smithextern int VecDestroy(Vec);
*afc8d9b6SBarry Smithextern int VecDuplicateVecs(Vec, int,Vec **);
8ed539a5SBarry Smithextern int VecFreeVecs(Vec*,int);
2eac72dbSBarry Smith
64119d58SLois Curfman McInnestypedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES} InsertMode;
20563c6bSBarry Smith
20563c6bSBarry Smithextern int VecSetValues(Vec, int, int *,Scalar*,InsertMode);
ee50ffe9SBarry Smithextern int VecAssemblyBegin(Vec);
ee50ffe9SBarry Smithextern int VecAssemblyEnd(Vec);
8ed539a5SBarry Smith
64119d58SLois Curfman McInnestypedef enum {SCATTER_REVERSE=1,SCATTER_DOWN=2,SCATTER_UP=4,SCATTER_ALL=8,
64119d58SLois Curfman McInnes              SCATTER_ALL_REVERSE=9} ScatterMode;
ee50ffe9SBarry Smith
08480c60SBarry Smithextern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter);
08480c60SBarry Smithextern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter);
08480c60SBarry Smithextern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
08480c60SBarry Smithextern int VecScatterDestroy(VecScatter);
08480c60SBarry Smithextern int VecScatterCopy(VecScatter,VecScatter *);
08480c60SBarry Smithextern int VecScatterView(VecScatter,Viewer);
d6dfbf8fSBarry Smith
64119d58SLois Curfman McInnestypedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineMode;
ee50ffe9SBarry Smith
08480c60SBarry Smithextern int VecPipelineBegin(Vec,Vec,InsertMode,PipelineMode,VecScatter);
08480c60SBarry Smithextern int VecPipelineEnd(Vec,Vec,InsertMode,PipelineMode,VecScatter);
8ed539a5SBarry Smith
c01c455dSBarry Smithextern int VecShift(Scalar *,Vec);
8ed539a5SBarry Smithextern int VecGetArray(Vec,Scalar**);
6b5873e3SBarry Smithextern int VecRestoreArray(Vec,Scalar**);
*afc8d9b6SBarry Smithextern int VecPlaceArray(Vec,Scalar*);
707f76d8SBarry Smithextern int VecGetArrays(Vec*,int,Scalar***);
707f76d8SBarry Smithextern int VecRestoreArrays(Vec*,int,Scalar***);
8ed539a5SBarry Smithextern int VecValidVector(Vec);
8ed539a5SBarry Smithextern int VecView(Vec,Viewer);
5f52d6abSBarry Smithextern int VecLoad(Viewer,Vec*);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int VecGetSize(Vec,int *);
8ed539a5SBarry Smithextern int VecGetLocalSize(Vec,int *);
d6dfbf8fSBarry Smithextern int VecGetOwnershipRange(Vec,int*,int*);
8ed539a5SBarry Smith
*afc8d9b6SBarry Smith
8ed539a5SBarry Smith/* utility routines */
8ed539a5SBarry Smithextern int VecReciprocal(Vec);
bfe6c5c8SBarry Smithextern int VecAbs(Vec);
2eac72dbSBarry Smith
34233285SBarry Smith#if defined(__DRAW_PACKAGE)
34233285SBarry Smithextern int DrawTensorContour(DrawCtx,int,int,double *,double *,Vec);
34233285SBarry Smith#endif
34233285SBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith