1 /* $Id: vec.h,v 1.70 1998/03/12 23:25:24 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,int,Vec*); 26 extern int VecCreateShared(MPI_Comm,int,int,Vec*); 27 28 extern int VecDestroy(Vec); 29 30 extern int VecDot(Vec,Vec,Scalar*); 31 extern int VecTDot(Vec,Vec,Scalar*); 32 extern int VecMDot(int,Vec,Vec*,Scalar*); 33 extern int VecMTDot(int,Vec,Vec*,Scalar*); 34 35 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 36 #define NORM_MAX NORM_INFINITY 37 extern int VecNorm(Vec,NormType,double *); 38 extern int VecSum(Vec,Scalar*); 39 extern int VecMax(Vec,int*,double*); 40 extern int VecMin(Vec,int*,double*); 41 extern int VecScale(Scalar*,Vec); 42 extern int VecCopy(Vec,Vec); 43 extern int VecSetRandom(PetscRandom,Vec); 44 extern int VecSet(Scalar*,Vec); 45 extern int VecSwap(Vec,Vec); 46 extern int VecAXPY(Scalar*,Vec,Vec); 47 extern int VecAXPBY(Scalar*,Scalar *,Vec,Vec); 48 extern int VecMAXPY(int,Scalar*,Vec,Vec*); 49 extern int VecAYPX(Scalar*,Vec,Vec); 50 extern int VecWAXPY(Scalar*,Vec,Vec,Vec); 51 extern int VecPointwiseMult(Vec,Vec,Vec); 52 extern int VecPointwiseDivide(Vec,Vec,Vec); 53 extern int VecShift(Scalar*,Vec); 54 extern int VecReciprocal(Vec); 55 extern int VecAbs(Vec); 56 extern int VecDuplicate(Vec,Vec*); 57 extern int VecDuplicateVecs(Vec,int,Vec**); 58 extern int VecDestroyVecs(Vec*,int); 59 60 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES} InsertMode; 61 extern int VecSetValues(Vec,int,int*,Scalar*,InsertMode); 62 extern int VecAssemblyBegin(Vec); 63 extern int VecAssemblyEnd(Vec); 64 #define VecSetValue(v,i,va,mode) \ 65 {int _ierr,_row = i; Scalar _va = va; \ 66 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 67 } 68 extern int VecSetBlockSize(Vec,int); 69 extern int VecSetValuesBlocked(Vec,int,int*,Scalar*,InsertMode); 70 71 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 72 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 73 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 74 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 75 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 76 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 77 extern int VecScatterDestroy(VecScatter); 78 extern int VecScatterCopy(VecScatter,VecScatter *); 79 extern int VecScatterView(VecScatter,Viewer); 80 extern int VecScatterRemap(VecScatter,int *,int*); 81 82 extern int VecGetArray(Vec,Scalar**); 83 extern int VecRestoreArray(Vec,Scalar**); 84 extern int VecPlaceArray(Vec,Scalar*); 85 extern int VecGetArrays(Vec*,int,Scalar***); 86 extern int VecRestoreArrays(Vec*,int,Scalar***); 87 88 extern int VecValid(Vec,PetscTruth*); 89 extern int VecView(Vec,Viewer); 90 extern int VecEqual(Vec,Vec,PetscTruth*); 91 extern int VecLoad(Viewer,Vec*); 92 93 extern int VecGetSize(Vec,int*); 94 extern int VecGetType(Vec,VecType*,char**); 95 extern int VecGetLocalSize(Vec,int*); 96 extern int VecGetOwnershipRange(Vec,int*,int*); 97 98 extern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 99 extern int VecSetValuesLocal(Vec,int,int*,Scalar*,InsertMode); 100 extern int VecSetLocalToGlobalMappingBlocked(Vec, ISLocalToGlobalMapping); 101 extern int VecSetValuesBlockedLocal(Vec,int,int*,Scalar*,InsertMode); 102 103 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption; 104 extern int VecSetOption(Vec,VecOption); 105 106 extern int VecContourScale(Vec,double,double); 107 108 /* 109 Routines for dealing with ghosted vectors: 110 vectors with ghost elements at the end of the array. 111 */ 112 extern int VecCreateGhost(MPI_Comm,int,int,int,int*,Vec*); 113 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,int*,Scalar*,Vec*); 114 extern int VecGhostGetLocalRepresentation(Vec,Vec*); 115 extern int VecGhostRestoreLocalRepresentation(Vec,Vec*); 116 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 117 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 118 119 120 extern int DrawTensorContour(Draw,int,int,double *,double *,Vec); 121 122 #endif 123 124 125 126