1 /* $Id: vec.h,v 1.81 1999/01/27 21:20:10 balay 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_H 9 #define __VEC_H 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 struct _p_Map* Map; 18 typedef struct _p_Vec* Vec; 19 typedef struct _p_VecScatter* VecScatter; 20 #define VEC_SEQ "seq" 21 #define VEC_MPI "mpi" 22 #define VEC_SHARED "shared" 23 typedef char* VecType; 24 25 extern int VecCreateSeq(MPI_Comm,int,Vec*); 26 extern int MapCreateMPI(MPI_Comm,int,int,Map*); 27 extern int VecCreateMPI(MPI_Comm,int,int,Vec*); 28 extern int VecCreateSeqWithArray(MPI_Comm,int,const Scalar[],Vec*); 29 extern int VecCreateMPIWithArray(MPI_Comm,int,int,const Scalar[],Vec*); 30 extern int VecCreateShared(MPI_Comm,int,int,Vec*); 31 extern int VecCreate(MPI_Comm,int,int,Vec*); 32 extern int VecSetType(Vec,VecType); 33 extern int VecSetFromOptions(Vec); 34 35 extern int VecDestroy(Vec); 36 37 extern int MapDestroy(Map); 38 extern int MapGetLocalSize(Map,int *); 39 extern int MapGetSize(Map,int *); 40 extern int MapGetLocalRange(Map,int *,int *); 41 extern int MapGetGlobalRange(Map,int *[]); 42 43 extern int VecDot(Vec,Vec,Scalar*); 44 extern int VecTDot(Vec,Vec,Scalar*); 45 extern int VecMDot(int,Vec,const Vec[],Scalar*); 46 extern int VecMTDot(int,Vec,const Vec[],Scalar*); 47 48 typedef enum {NORM_1=1,NORM_2=2,NORM_FROBENIUS=3,NORM_INFINITY=4,NORM_1_AND_2=5} NormType; 49 #define NORM_MAX NORM_INFINITY 50 extern int VecNorm(Vec,NormType,double *); 51 extern int VecSum(Vec,Scalar*); 52 extern int VecMax(Vec,int*,double*); 53 extern int VecMin(Vec,int*,double*); 54 extern int VecScale(const Scalar*,Vec); 55 extern int VecCopy(Vec,Vec); 56 extern int VecSetRandom(PetscRandom,Vec); 57 extern int VecSet(const Scalar*,Vec); 58 extern int VecSwap(Vec,Vec); 59 extern int VecAXPY(const Scalar*,Vec,Vec); 60 extern int VecAXPBY(const Scalar*,const Scalar *,Vec,Vec); 61 extern int VecMAXPY(int,const Scalar*,Vec,Vec*); 62 extern int VecAYPX(const Scalar*,Vec,Vec); 63 extern int VecWAXPY(const Scalar*,Vec,Vec,Vec); 64 extern int VecPointwiseMult(Vec,Vec,Vec); 65 extern int VecPointwiseDivide(Vec,Vec,Vec); 66 extern int VecShift(const Scalar*,Vec); 67 extern int VecReciprocal(Vec); 68 extern int VecAbs(Vec); 69 extern int VecDuplicate(Vec,Vec*); 70 extern int VecDuplicateVecs(Vec,int,Vec*[]); 71 extern int VecDestroyVecs(const Vec[],int); 72 extern int VecGetMap(Vec,Map*); 73 74 typedef enum {NOT_SET_VALUES, INSERT_VALUES, ADD_VALUES, MAX_VALUES} InsertMode; 75 extern int VecStrideNorm(Vec,int,NormType,double*); 76 extern int VecStrideGather(Vec,int,Vec,InsertMode); 77 extern int VecStrideScatter(Vec,int,Vec,InsertMode); 78 79 extern int VecSetValues(Vec,int,const int[],const Scalar[],InsertMode); 80 extern int VecAssemblyBegin(Vec); 81 extern int VecAssemblyEnd(Vec); 82 83 #define VecSetValue(v,i,va,mode) \ 84 {int _ierr,_row = i; Scalar _va = va; \ 85 _ierr = VecSetValues(v,1,&_row,&_va,mode);CHKERRQ(_ierr); \ 86 } 87 extern int VecSetBlockSize(Vec,int); 88 extern int VecSetValuesBlocked(Vec,int,const int[],const Scalar[],InsertMode); 89 90 extern int VecRegisterAllCalled; 91 extern int VecRegisterAll(const char []); 92 extern int VecRegister_Private(const char[],const char[],const char[],int(*)(Vec)); 93 #if defined(USE_DYNAMIC_LIBRARIES) 94 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,0) 95 #else 96 #define VecRegister(a,b,c,d) VecRegister_Private(a,b,c,d) 97 #endif 98 99 typedef enum {SCATTER_FORWARD=0,SCATTER_REVERSE=1,SCATTER_FORWARD_LOCAL=2, 100 SCATTER_REVERSE_LOCAL=3,SCATTER_LOCAL=2} ScatterMode; 101 extern int VecScatterCreate(Vec,IS,Vec,IS,VecScatter *); 102 extern int VecScatterPostRecvs(Vec,Vec,InsertMode,ScatterMode,VecScatter); 103 extern int VecScatterBegin(Vec,Vec,InsertMode,ScatterMode,VecScatter); 104 extern int VecScatterEnd(Vec,Vec,InsertMode,ScatterMode,VecScatter); 105 extern int VecScatterDestroy(VecScatter); 106 extern int VecScatterCopy(VecScatter,VecScatter *); 107 extern int VecScatterView(VecScatter,Viewer); 108 extern int VecScatterRemap(VecScatter,int *,int*); 109 110 typedef enum {PIPELINE_DOWN=0,PIPELINE_UP=1} PipelineDirection; 111 typedef enum {PIPELINE_NONE=1, PIPELINE_SEQUENTIAL=2, 112 PIPELINE_REDBLACK=3, PIPELINE_MULTICOLOUR=4} PipelineType; 113 114 typedef struct _p_VecPipeline* VecPipeline; 115 116 extern int VecPipelineCreate(MPI_Comm comm,Vec xin,IS ix,Vec yin,IS iy,VecPipeline *newctx); 117 extern int VecPipelineSetType(VecPipeline ctx,PipelineType typ,PetscObject x); 118 extern int VecPipelineSetup(VecPipeline ctx); 119 extern int VecPipelineBegin(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 120 extern int VecPipelineEnd(Vec,Vec,InsertMode,ScatterMode,PipelineDirection,VecPipeline); 121 extern int VecPipelineView(VecPipeline pipe,Viewer viewer); 122 extern int VecPipelineDestroy(VecPipeline ctx); 123 124 extern int VecGetArray(Vec,Scalar*[]); 125 extern int VecRestoreArray(Vec,Scalar*[]); 126 extern int VecPlaceArray(Vec,const Scalar[]); 127 extern int VecGetArrays(const Vec[],int,Scalar**[]); 128 extern int VecRestoreArrays(const Vec[],int,Scalar**[]); 129 130 extern int VecValid(Vec,PetscTruth*); 131 extern int VecView(Vec,Viewer); 132 extern int VecEqual(Vec,Vec,PetscTruth*); 133 extern int VecLoad(Viewer,Vec*); 134 135 extern int VecGetSize(Vec,int*); 136 extern int VecGetType(Vec,VecType*); 137 extern int VecGetLocalSize(Vec,int*); 138 extern int VecGetOwnershipRange(Vec,int*,int*); 139 140 extern int VecSetLocalToGlobalMapping(Vec, ISLocalToGlobalMapping); 141 extern int VecSetValuesLocal(Vec,int,const int[],const Scalar[],InsertMode); 142 extern int VecSetLocalToGlobalMappingBlocked(Vec, ISLocalToGlobalMapping); 143 extern int VecSetValuesBlockedLocal(Vec,int,const int[],const Scalar[],InsertMode); 144 145 typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES} VecOption; 146 extern int VecSetOption(Vec,VecOption); 147 148 extern int VecContourScale(Vec,double,double); 149 150 /* 151 Routines for dealing with ghosted vectors: 152 vectors with ghost elements at the end of the array. 153 */ 154 extern int VecCreateGhost(MPI_Comm,int,int,int,const int[],Vec*); 155 extern int VecCreateGhostWithArray(MPI_Comm,int,int,int,const int[],const Scalar[],Vec*); 156 extern int VecGhostGetLocalForm(Vec,Vec*); 157 extern int VecGhostRestoreLocalForm(Vec,Vec*); 158 extern int VecGhostUpdateBegin(Vec,InsertMode,ScatterMode); 159 extern int VecGhostUpdateEnd(Vec,InsertMode,ScatterMode); 160 161 162 extern int DrawTensorContour(Draw,int,int,const double[],const double[],Vec); 163 164 #endif 165 166 167 168