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