petsc/include/petscvec.h

*e1311b90SBarry Smith/* $Id: vec.h,v 1.70 1998/03/12 23:25:24 bsmith Exp bsmith $ */
2eac72dbSBarry Smith/*
37f753daSBarry Smith    Defines the vector component of PETSc. Vectors generally represent
37f753daSBarry Smith  degrees of freedom for finite element/finite difference functions
84cb2905SBarry Smith  on a grid. They have more mathematical structure then simple arrays.
2eac72dbSBarry Smith*/
2eac72dbSBarry Smith
2eac72dbSBarry Smith#ifndef __VEC_PACKAGE
2eac72dbSBarry Smith#define __VEC_PACKAGE
2eac72dbSBarry Smith#include "is.h"
bf5bf444SLois Curfman McInnes#include "sys.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
f09e8eb9SSatish Balaytypedef struct _p_Vec*         Vec;
f09e8eb9SSatish Balaytypedef struct _p_VecScatter*  VecScatter;
2eac72dbSBarry Smith
de7da479SBarry Smithextern int VecCreateSeq(MPI_Comm,int,Vec*);
8ed539a5SBarry Smithextern int VecCreateMPI(MPI_Comm,int,int,Vec*);
3369ce9aSBarry Smithextern int VecCreateSeqWithArray(MPI_Comm,int,Scalar*,Vec*);
e182c471SBarry Smithextern int VecCreateMPIWithArray(MPI_Comm,int,int,Scalar*,Vec*);
522c5e43SBarry Smithextern int VecCreate(MPI_Comm,int,int,Vec*);
522c5e43SBarry Smithextern int VecCreateShared(MPI_Comm,int,int,Vec*);
2eac72dbSBarry Smith
4b0e389bSBarry Smithextern int VecDestroy(Vec);
4b0e389bSBarry 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
93c39befSBarry Smithtypedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} 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);
77c4ece6SBarry Smithextern int VecSetRandom(PetscRandom,Vec);
8ed539a5SBarry Smithextern int VecSet(Scalar*,Vec);
8ed539a5SBarry Smithextern int VecSwap(Vec,Vec);
8ed539a5SBarry Smithextern int VecAXPY(Scalar*,Vec,Vec);
77c4ece6SBarry Smithextern int VecAXPBY(Scalar*,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);
77c4ece6SBarry Smithextern int VecPointwiseMult(Vec,Vec,Vec);
77c4ece6SBarry Smithextern int VecPointwiseDivide(Vec,Vec,Vec);
4b0e389bSBarry Smithextern int VecShift(Scalar*,Vec);
4b0e389bSBarry Smithextern int VecReciprocal(Vec);
4b0e389bSBarry Smithextern int VecAbs(Vec);
6469c4f9SBarry Smithextern int VecDuplicate(Vec,Vec*);
afc8d9b6SBarry Smithextern int VecDuplicateVecs(Vec,int,Vec**);
4b0e389bSBarry Smithextern int VecDestroyVecs(Vec*,int);
2eac72dbSBarry Smith
*e1311b90SBarry Smithtypedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES} InsertMode;
20563c6bSBarry Smithextern int VecSetValues(Vec,int,int*,Scalar*,InsertMode);
ee50ffe9SBarry Smithextern int VecAssemblyBegin(Vec);
ee50ffe9SBarry Smithextern int VecAssemblyEnd(Vec);
b951964fSBarry Smith#define VecSetValue(v,i,va,mode) \
b951964fSBarry Smith{int _ierr,_row = i; Scalar _va = va; \
b951964fSBarry Smith  _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \
b951964fSBarry Smith}
35c17c5bSBarry Smithextern int VecSetBlockSize(Vec,int);
35c17c5bSBarry Smithextern int VecSetValuesBlocked(Vec,int,int*,Scalar*,InsertMode);
8ed539a5SBarry Smith
d252947aSBarry Smithtypedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2,
d252947aSBarry Smith              SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode;
84cb2905SBarry Smithextern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
90f02eecSBarry Smithextern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter);
08480c60SBarry Smithextern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter);
08480c60SBarry Smithextern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter);
08480c60SBarry Smithextern int VecScatterDestroy(VecScatter);
08480c60SBarry Smithextern int VecScatterCopy(VecScatter,VecScatter *);
08480c60SBarry Smithextern int VecScatterView(VecScatter,Viewer);
2195c698SBarry Smithextern int VecScatterRemap(VecScatter,int *,int*);
2195c698SBarry Smith
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***);
84cb2905SBarry Smith
77c4ece6SBarry Smithextern int VecValid(Vec,PetscTruth*);
8ed539a5SBarry Smithextern int VecView(Vec,Viewer);
13054869SSatish Balayextern int VecEqual(Vec,Vec,PetscTruth*);
84cb2905SBarry Smithextern int VecLoad(Viewer,Vec*);
8ed539a5SBarry Smith
8ed539a5SBarry Smithextern int VecGetSize(Vec,int*);
1dd0cb96SLois Curfman McInnesextern int VecGetType(Vec,VecType*,char**);
8ed539a5SBarry Smithextern int VecGetLocalSize(Vec,int*);
d6dfbf8fSBarry Smithextern int VecGetOwnershipRange(Vec,int*,int*);
8ed539a5SBarry Smith
d4bb536fSBarry Smithextern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping);
90f02eecSBarry Smithextern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode);
35c17c5bSBarry Smithextern int VecSetLocalToGlobalMappingBlocked(Vec, ISLocalToGlobalMapping);
35c17c5bSBarry Smithextern int VecSetValuesBlockedLocal(Vec,int,int*,Scalar*,InsertMode);
90f02eecSBarry Smith
f830108cSBarry Smithtypedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption;
90f02eecSBarry Smithextern int VecSetOption(Vec,VecOption);
90f02eecSBarry Smith
522c5e43SBarry Smithextern int VecContourScale(Vec,double,double);
522c5e43SBarry Smith
e182c471SBarry Smith/*
e182c471SBarry Smith     Routines for dealing with ghosted vectors:
e182c471SBarry Smith  vectors with ghost elements at the end of the array.
e182c471SBarry Smith*/
e182c471SBarry Smithextern int VecCreateGhost(MPI_Comm,int,int,int,int*,Vec*);
e182c471SBarry Smithextern int VecCreateGhostWithArray(MPI_Comm,int,int,int,int*,Scalar*,Vec*);
e182c471SBarry Smithextern int VecGhostGetLocalRepresentation(Vec,Vec*);
e182c471SBarry Smithextern int VecGhostRestoreLocalRepresentation(Vec,Vec*);
e182c471SBarry Smithextern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
e182c471SBarry Smithextern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);
e182c471SBarry Smith
e182c471SBarry Smith
3369ce9aSBarry Smithextern int DrawTensorContour(Draw,int,int,double *,double *,Vec);
34233285SBarry Smith
2eac72dbSBarry Smith#endif
2eac72dbSBarry Smith
2eac72dbSBarry Smith
7588ac45SBarry Smith