1 /* $Id: vec.h,v 1.66 1997/08/22 15:20:23 bsmith Exp bsmith $ */ 2 /* 3 Defines the vector component of PETSc. Vectors generally represent 4 degrees of freedom for finite element/finite difference functions 5 on a grid. They have more mathematical structure then simple arrays. 6 */ 7 8 #ifndef __VEC_PACKAGE 9 #define __VEC_PACKAGE 10 #include "is.h" 11 #include "sys.h" 12 13 #define VEC_COOKIE PETSC_COOKIE+3 14 #define VEC_SCATTER_COOKIE PETSC_COOKIE+4 15 16 typedef enum {VECSAME=-1, VECSEQ, VECMPI} VecType; 17 18 typedef struct _p_Vec* Vec; 19 typedef struct _p_VecScatter* VecScatter; 20 21 extern int VecCreateSeq(MPI_Comm,int,Vec*); 22 extern int VecCreateMPI(MPI_Comm,int,int,Vec*); 23 extern int VecCreateSeqWithArray(MPI_Comm,int,Scalar*,Vec*); 24 extern int VecCreateMPIWithArray(MPI_Comm,int,int,Scalar*,Vec*); 25 extern int VecCreate(MPI_Comm,int,Vec*); 26 27 extern int VecDestroy(Vec); 28 29 extern int VecDot(Vec,Vec,Scalar*); 30 extern int VecTDot(Vec,Vec,Scalar*); 31 extern int VecMDot(int,Vec,Vec*,Scalar*); 32 extern int VecMTDot(int,Vec,Vec*,Scalar*); 33 34 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 35 #define NORM_MAX NORM_INFINITY 36 extern int VecNorm(Vec,NormType,double *); 37 extern int VecSum(Vec,Scalar*); 38 extern int VecMax(Vec,int*,double*); 39 extern int VecMin(Vec,int*,double*); 40 extern int VecScale(Scalar*,Vec); 41 extern int VecCopy(Vec,Vec); 42 extern int VecSetRandom(PetscRandom,Vec); 43 extern int VecSet(Scalar*,Vec); 44 extern int VecSwap(Vec,Vec); 45 extern int VecAXPY(Scalar*,Vec,Vec); 46 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 47 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 48 extern int VecAYPX(Scalar*,Vec,Vec); 49 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 50 extern int VecPointwiseMult(Vec,Vec,Vec); 51 extern int VecPointwiseDivide(Vec,Vec,Vec); 52 extern int VecShift(Scalar*,Vec); 53 extern int VecReciprocal(Vec); 54 extern int VecAbs(Vec); 55 extern int VecDuplicate(Vec,Vec*); 56 extern int VecDuplicateVecs(Vec,int,Vec**); 57 extern int VecDestroyVecs(Vec*,int); 58 59 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES} InsertMode; 60 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 61 extern int VecAssemblyBegin(Vec); 62 extern int VecAssemblyEnd(Vec); 63 #define VecSetValue(v,i,va,mode) \ 64 {int _ierr,_row = i; Scalar _va = va; \ 65 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 66 } 67 68 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 69 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 70 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 71 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 72 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 73 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 74 extern int VecScatterDestroy(VecScatter); 75 extern int VecScatterCopy(VecScatter,VecScatter *); 76 extern int VecScatterView(VecScatter,Viewer); 77 extern int VecScatterRemap(VecScatter,int *,int*); 78 79 extern int VecGetArray(Vec,Scalar**); 80 extern int VecRestoreArray(Vec,Scalar**); 81 extern int VecPlaceArray(Vec,Scalar*); 82 extern int VecGetArrays(Vec*,int,Scalar***); 83 extern int VecRestoreArrays(Vec*,int,Scalar***); 84 85 extern int VecValid(Vec,PetscTruth*); 86 extern int VecView(Vec,Viewer); 87 extern int VecEqual(Vec,Vec,PetscTruth*); 88 extern int VecLoad(Viewer,Vec*); 89 90 extern int VecGetSize(Vec,int*); 91 extern int VecGetType(Vec,VecType*,char**); 92 extern int VecGetLocalSize(Vec,int*); 93 extern int VecGetOwnershipRange(Vec,int*,int*); 94 95 extern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 96 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 97 98 typedef enum {VEC_IGNORE_OFF_PROCESSOR_ENTRIES} VecOption; 99 extern int VecSetOption(Vec,VecOption); 100 101 /* 102 Routines for dealing with ghosted vectors: 103 vectors with ghost elements at the end of the array. 104 */ 105 extern int VecCreateGhost(MPI_Comm,int,int,int,int*,Vec*); 106 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,int*,Scalar*,Vec*); 107 extern int VecGhostGetLocalRepresentation(Vec,Vec*); 108 extern int VecGhostRestoreLocalRepresentation(Vec,Vec*); 109 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 110 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 111 112 113 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 114 115 #endif 116 117 118 119