Actual source code: petscvec.h

      1: /*
      2:     Defines the vector component of PETSc. Vectors generally represent
      3:   degrees of freedom for finite element/finite difference functions
      4:   on a grid. They have more mathematical structure then simple arrays.
      5: */

      7: #ifndef __PETSCVEC_H
     9:  #include petscis.h
     10:  #include petscsys.h

     13: /*S
     14:      Vec - Abstract PETSc vector object

     16:    Level: beginner

     18:   Concepts: field variables, unknowns, arrays

     20: .seealso:  VecCreate(), VecType, VecSetType()
     21: S*/
     22: typedef struct _p_Vec*         Vec;

     24: /*S
     25:      VecScatter - Object used to manage communication of data
     26:        between vectors in parallel. Manages both scatters and gathers

     28:    Level: beginner

     30:   Concepts: scatter

     32: .seealso:  VecScatterCreate(), VecScatterBegin(), VecScatterEnd()
     33: S*/
     34: typedef struct _p_VecScatter*  VecScatter;

     36: /*E
     37:     VecType - String with the name of a PETSc vector or the creation function
     38:        with an optional dynamic library name, for example
     39:        http://www.mcs.anl.gov/petsc/lib.a:myveccreate()

     41:    Level: beginner

     43: .seealso: VecSetType(), Vec
     44: E*/
     45: #define VecType const char*
     46: #define VECSEQ         "seq"
     47: #define VECMPI         "mpi"
     48: #define VECFETI        "feti"
     49: #define VECSHARED      "shared"
     50: #define VECSIEVE       "sieve"

     52: /* Logging support */
     53: #define    VEC_FILE_COOKIE 1211214

     57: EXTERN PetscErrorCode  VecInitializePackage(const char[]);

     59: EXTERN PetscErrorCode  VecCreate(MPI_Comm,Vec*);
     60: PetscPolymorphicSubroutine(VecCreate,(Vec *x),(PETSC_COMM_SELF,x))
     61: EXTERN PetscErrorCode  VecCreateSeq(MPI_Comm,PetscInt,Vec*);
     62: PetscPolymorphicSubroutine(VecCreateSeq,(PetscInt n,Vec *x),(PETSC_COMM_SELF,n,x))
     63: EXTERN PetscErrorCode  VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*);
     64: PetscPolymorphicSubroutine(VecCreateMPI,(PetscInt n,PetscInt N,Vec *x),(PETSC_COMM_WORLD,n,N,x))
     65: EXTERN PetscErrorCode  VecCreateSeqWithArray(MPI_Comm,PetscInt,const PetscScalar[],Vec*);
     66: PetscPolymorphicSubroutine(VecCreateSeqWithArray,(PetscInt n,PetscScalar s[],Vec *x),(PETSC_COMM_SELF,n,s,x))
     67: EXTERN PetscErrorCode  VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*);
     68: PetscPolymorphicSubroutine(VecCreateMPIWithArray,(PetscInt n,PetscInt N,PetscScalar s[],Vec *x),(PETSC_COMM_WORLD,n,N,s,x))
     69: EXTERN PetscErrorCode  VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*);
     70: EXTERN PetscErrorCode  VecSetFromOptions(Vec);
     71: EXTERN PetscErrorCode  VecSetUp(Vec);
     72: EXTERN PetscErrorCode  VecDestroy(Vec);
     73: EXTERN PetscErrorCode  VecZeroEntries(Vec);
     74: EXTERN PetscErrorCode  VecSetOptionsPrefix(Vec,const char[]);
     75: EXTERN PetscErrorCode  VecAppendOptionsPrefix(Vec,const char[]);
     76: EXTERN PetscErrorCode  VecGetOptionsPrefix(Vec,const char*[]);

     78: EXTERN PetscErrorCode  VecSetSizes(Vec,PetscInt,PetscInt);

     80: EXTERN PetscErrorCode  VecDot(Vec,Vec,PetscScalar*);
     81: PetscPolymorphicFunction(VecDot,(Vec x,Vec y),(x,y,&s),PetscScalar,s)
     82: EXTERN PetscErrorCode  VecTDot(Vec,Vec,PetscScalar*);
     83: PetscPolymorphicFunction(VecTDot,(Vec x,Vec y),(x,y,&s),PetscScalar,s)
     84: EXTERN PetscErrorCode  VecMDot(Vec,PetscInt,const Vec[],PetscScalar*);
     85: EXTERN PetscErrorCode  VecMTDot(Vec,PetscInt,const Vec[],PetscScalar*);

     87: /*E
     88:     NormType - determines what type of norm to compute

     90:     Level: beginner

     92: .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm()
     93: E*/
     94: typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType;
     96: #define NORM_MAX NORM_INFINITY

     98: /*MC
     99:      NORM_1 - the one norm, ||v|| = sum_i | v_i |. ||A|| = max_j || v_*j ||, maximum column sum

    101:    Level: beginner

    103: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS,
    104:            NORM_INFINITY, NORM_1_AND_2

    106: M*/

    108: /*MC
    109:      NORM_2 - the two norm, ||v|| = sqrt(sum_i (v_i)^2) (vectors only)

    111:    Level: beginner

    113: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS,
    114:            NORM_INFINITY, NORM_1_AND_2

    116: M*/

    118: /*MC
    119:      NORM_FROBENIUS - ||A|| = sqrt(sum_ij (A_ij)^2), same as NORM_2 for vectors

    121:    Level: beginner

    123: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
    124:            NORM_INFINITY, NORM_1_AND_2

    126: M*/

    128: /*MC
    129:      NORM_INFINITY - ||v|| = max_i |v_i|. ||A|| = max_i || v_i* ||, maximum row sum

    131:    Level: beginner

    133: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
    134:            NORM_FROBINIUS, NORM_1_AND_2

    136: M*/

    138: /*MC
    139:      NORM_1_AND_2 - computes both the 1 and 2 norm of a vector

    141:    Level: beginner

    143: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
    144:            NORM_FROBINIUS, NORM_INFINITY

    146: M*/

    148: /*MC
    149:      NORM_MAX - see NORM_INFINITY

    151:    Level: beginner

    153: M*/

    155: EXTERN PetscErrorCode  VecNorm(Vec,NormType,PetscReal *);
    156: PetscPolymorphicSubroutine(VecNorm,(Vec x,PetscReal *r),(x,NORM_2,r))
    157: PetscPolymorphicFunction(VecNorm,(Vec x,NormType t),(x,t,&r),PetscReal,r)
    158: PetscPolymorphicFunction(VecNorm,(Vec x),(x,NORM_2,&r),PetscReal,r)
    159: EXTERN PetscErrorCode  VecNormalize(Vec,PetscReal *);
    160: EXTERN PetscErrorCode  VecSum(Vec,PetscScalar*);
    161: EXTERN PetscErrorCode  VecMax(Vec,PetscInt*,PetscReal *);
    162: PetscPolymorphicSubroutine(VecMax,(Vec x,PetscReal *r),(x,PETSC_NULL,r))
    163: EXTERN PetscErrorCode  VecMin(Vec,PetscInt*,PetscReal *);
    164: PetscPolymorphicSubroutine(VecMin,(Vec x,PetscReal *r),(x,PETSC_NULL,r))
    165: EXTERN PetscErrorCode  VecScale(Vec,PetscScalar);
    166: EXTERN PetscErrorCode  VecCopy(Vec,Vec);
    167: EXTERN PetscErrorCode  VecSetRandom(Vec,PetscRandom);
    168: EXTERN PetscErrorCode  VecSet(Vec,PetscScalar);
    169: EXTERN PetscErrorCode  VecSwap(Vec,Vec);
    170: EXTERN PetscErrorCode  VecAXPY(Vec,PetscScalar,Vec);
    171: EXTERN PetscErrorCode  VecAXPBY(Vec,PetscScalar,PetscScalar,Vec);
    172: EXTERN PetscErrorCode  VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec*);
    173: EXTERN PetscErrorCode  VecAYPX(Vec,PetscScalar,Vec);
    174: EXTERN PetscErrorCode  VecWAXPY(Vec,PetscScalar,Vec,Vec);
    175: EXTERN PetscErrorCode  VecPointwiseMax(Vec,Vec,Vec);
    176: PetscPolymorphicSubroutine(VecPointwiseMax,(Vec x,Vec y),(x,y,y))
    177: EXTERN PetscErrorCode  VecPointwiseMaxAbs(Vec,Vec,Vec);
    178: PetscPolymorphicSubroutine(VecPointwiseMaxAbs,(Vec x,Vec y),(x,y,y))
    179: EXTERN PetscErrorCode  VecPointwiseMin(Vec,Vec,Vec);
    180: PetscPolymorphicSubroutine(VecPointwiseMin,(Vec x,Vec y),(x,y,y))
    181: EXTERN PetscErrorCode  VecPointwiseMult(Vec,Vec,Vec);
    182: PetscPolymorphicSubroutine(VecPointwiseMult,(Vec x,Vec y),(x,y,y))
    183: EXTERN PetscErrorCode  VecPointwiseDivide(Vec,Vec,Vec);
    184: PetscPolymorphicSubroutine(VecPointwiseDivide,(Vec x,Vec y),(x,y,y))
    185: EXTERN PetscErrorCode  VecMaxPointwiseDivide(Vec,Vec,PetscReal*);
    186: EXTERN PetscErrorCode  VecShift(Vec,PetscScalar);
    187: EXTERN PetscErrorCode  VecReciprocal(Vec);
    188: EXTERN PetscErrorCode  VecPermute(Vec, IS, PetscTruth);
    189: EXTERN PetscErrorCode  VecSqrt(Vec);
    190: EXTERN PetscErrorCode  VecAbs(Vec);
    191: EXTERN PetscErrorCode  VecDuplicate(Vec,Vec*);
    192: EXTERN PetscErrorCode  VecDuplicateVecs(Vec,PetscInt,Vec*[]);
    193: EXTERN PetscErrorCode  VecDestroyVecs(Vec[],PetscInt);
    194: EXTERN PetscErrorCode  VecStrideNormAll(Vec,NormType,PetscReal*);
    195: EXTERN PetscErrorCode  VecStrideMaxAll(Vec,PetscInt *,PetscReal *);
    196: EXTERN PetscErrorCode  VecStrideMinAll(Vec,PetscInt *,PetscReal *);
    197: EXTERN PetscErrorCode  VecStrideScaleAll(Vec,PetscScalar*);

    199: EXTERN PetscErrorCode  VecStrideNorm(Vec,PetscInt,NormType,PetscReal*);
    200: PetscPolymorphicFunction(VecStrideNorm,(Vec x,PetscInt i),(x,i,NORM_2,&r),PetscReal,r)
    201: PetscPolymorphicFunction(VecStrideNorm,(Vec x,PetscInt i,NormType t),(x,i,t,&r),PetscReal,r)
    202: EXTERN PetscErrorCode  VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *);
    203: PetscPolymorphicFunction(VecStrideMax,(Vec x,PetscInt i),(x,i,PETSC_NULL,&r),PetscReal,r)
    204: EXTERN PetscErrorCode  VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *);
    205: PetscPolymorphicFunction(VecStrideMin,(Vec x,PetscInt i),(x,i,PETSC_NULL,&r),PetscReal,r)
    206: EXTERN PetscErrorCode  VecStrideScale(Vec,PetscInt,PetscScalar);

    209: EXTERN PetscErrorCode  VecStrideGather(Vec,PetscInt,Vec,InsertMode);
    210: EXTERN PetscErrorCode  VecStrideScatter(Vec,PetscInt,Vec,InsertMode);
    211: EXTERN PetscErrorCode  VecStrideGatherAll(Vec,Vec*,InsertMode);
    212: EXTERN PetscErrorCode  VecStrideScatterAll(Vec*,Vec,InsertMode);

    214: EXTERN PetscErrorCode  VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    215: EXTERN PetscErrorCode  VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]);
    216: EXTERN PetscErrorCode  VecAssemblyBegin(Vec);
    217: EXTERN PetscErrorCode  VecAssemblyEnd(Vec);
    218: EXTERN PetscErrorCode  VecStashSetInitialSize(Vec,PetscInt,PetscInt);
    219: EXTERN PetscErrorCode  VecStashView(Vec,PetscViewer);
    220: EXTERN PetscErrorCode  VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

    222: /*MC
    223:    VecSetValue - Set a single entry into a vector.

    225:    Synopsis:
    226:    PetscErrorCode VecSetValue(Vec v,int row,PetscScalar value, InsertMode mode);

    228:    Not Collective

    230:    Input Parameters:
    231: +  v - the vector
    232: .  row - the row location of the entry
    233: .  value - the value to insert
    234: -  mode - either INSERT_VALUES or ADD_VALUES

    236:    Notes:
    237:    For efficiency one should use VecSetValues() and set several or
    238:    many values simultaneously if possible.

    240:    These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd()
    241:    MUST be called after all calls to VecSetValues() have been completed.

    243:    VecSetValues() uses 0-based indices in Fortran as well as in C.

    245:    Level: beginner

    247: .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValueLocal()
    248: M*/
    249: PETSC_STATIC_INLINE PetscErrorCode VecSetValue(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValues(v,1,&i,&va,mode);}

    252: EXTERN PetscErrorCode  VecSetBlockSize(Vec,PetscInt);
    253: EXTERN PetscErrorCode  VecGetBlockSize(Vec,PetscInt*);
    254: PetscPolymorphicFunction(VecGetBlockSize,(Vec x),(x,&i),PetscInt,i)
    255: EXTERN PetscErrorCode  VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

    257: /* Dynamic creation and loading functions */
    260: EXTERN PetscErrorCode  VecSetType(Vec, VecType);
    261: EXTERN PetscErrorCode  VecGetType(Vec, VecType *);
    262: EXTERN PetscErrorCode  VecRegister(const char[],const char[],const char[],PetscErrorCode (*)(Vec));
    263: EXTERN PetscErrorCode  VecRegisterAll(const char []);
    264: EXTERN PetscErrorCode  VecRegisterDestroy(void);

    266: /*MC
    267:   VecRegisterDynamic - Adds a new vector component implementation

    269:   Synopsis:
    270:   PetscErrorCode VecRegisterDynamic(char *name, char *path, char *func_name, PetscErrorCode (*create_func)(Vec))

    272:   Not Collective

    274:   Input Parameters:
    275: + name        - The name of a new user-defined creation routine
    276: . path        - The path (either absolute or relative) of the library containing this routine
    277: . func_name   - The name of routine to create method context
    278: - create_func - The creation routine itself

    280:   Notes:
    281:   VecRegisterDynamic() may be called multiple times to add several user-defined vectors

    283:   If dynamic libraries are used, then the fourth input argument (routine_create) is ignored.

    285:   Sample usage:
    286: .vb
    287:     VecRegisterDynamic("my_vec","/home/username/my_lib/lib/libO/solaris/libmy.a", "MyVectorCreate", MyVectorCreate);
    288: .ve

    290:   Then, your vector type can be chosen with the procedural interface via
    291: .vb
    292:     VecCreate(MPI_Comm, Vec *);
    293:     VecSetType(Vec,"my_vector_name");
    294: .ve
    295:    or at runtime via the option
    296: .vb
    297:     -vec_type my_vector_name
    298: .ve

    300:   Notes: $PETSC_ARCH occuring in pathname will be replaced with appropriate values.
    301:          If your function is not being put into a shared library then use VecRegister() instead
    302:
    303:   Level: advanced

    305: .keywords: Vec, register
    306: .seealso: VecRegisterAll(), VecRegisterDestroy(), VecRegister()
    307: M*/
    308: #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
    309: #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,0)
    310: #else
    311: #define VecRegisterDynamic(a,b,c,d) VecRegister(a,b,c,d)
    312: #endif

    315: EXTERN PetscErrorCode  VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
    316: PetscPolymorphicFunction(VecScatterCreate,(Vec x,IS is1,Vec y,IS is2),(x,is1,y,is2,&s),VecScatter,s)
    317: PetscPolymorphicSubroutine(VecScatterCreate,(Vec x,IS is,Vec y,VecScatter *s),(x,is,y,PETSC_NULL,s))
    318: PetscPolymorphicFunction(VecScatterCreate,(Vec x,IS is,Vec y),(x,is,y,PETSC_NULL,&s),VecScatter,s)
    319: PetscPolymorphicSubroutine(VecScatterCreate,(Vec x,Vec y,IS is,VecScatter *s),(x,PETSC_NULL,y,is,s))
    320: PetscPolymorphicFunction(VecScatterCreate,(Vec x,Vec y,IS is),(x,PETSC_NULL,y,is,&s),VecScatter,s)
    321: EXTERN PetscErrorCode  VecScatterCreateEmpty(MPI_Comm,VecScatter *);
    322: EXTERN PetscErrorCode  VecScatterCreateLocal_PtoS(PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,VecScatter);
    323: EXTERN PetscErrorCode  VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode);
    324: EXTERN PetscErrorCode  VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode);
    325: EXTERN PetscErrorCode  VecScatterDestroy(VecScatter);
    326: EXTERN PetscErrorCode  VecScatterCopy(VecScatter,VecScatter *);
    327: EXTERN PetscErrorCode  VecScatterView(VecScatter,PetscViewer);
    328: EXTERN PetscErrorCode  VecScatterRemap(VecScatter,PetscInt *,PetscInt*);
    329: EXTERN PetscErrorCode  VecScatterGetMerged(VecScatter,PetscTruth*);

    331: EXTERN PetscErrorCode  VecGetArray_Private(Vec,PetscScalar*[]);
    332: EXTERN PetscErrorCode  VecRestoreArray_Private(Vec,PetscScalar*[]);
    333: EXTERN PetscErrorCode  VecGetArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
    334: EXTERN PetscErrorCode  VecRestoreArray4d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
    335: EXTERN PetscErrorCode  VecGetArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
    336: EXTERN PetscErrorCode  VecRestoreArray3d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
    337: EXTERN PetscErrorCode  VecGetArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
    338: EXTERN PetscErrorCode  VecRestoreArray2d(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
    339: EXTERN PetscErrorCode  VecGetArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]);
    340: EXTERN PetscErrorCode  VecRestoreArray1d(Vec,PetscInt,PetscInt,PetscScalar *[]);

    342: EXTERN PetscErrorCode  VecPlaceArray(Vec,const PetscScalar[]);
    343: EXTERN PetscErrorCode  VecResetArray(Vec);
    344: EXTERN PetscErrorCode  VecReplaceArray(Vec,const PetscScalar[]);
    345: EXTERN PetscErrorCode  VecGetArrays(const Vec[],PetscInt,PetscScalar**[]);
    346: EXTERN PetscErrorCode  VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]);

    348: EXTERN PetscErrorCode  VecValid(Vec,PetscTruth*);
    349: EXTERN PetscErrorCode  VecView(Vec,PetscViewer);
    350: EXTERN PetscErrorCode  VecViewFromOptions(Vec, char *);
    351: EXTERN PetscErrorCode  VecEqual(Vec,Vec,PetscTruth*);
    352: PetscPolymorphicFunction(VecEqual,(Vec x,Vec y),(x,y,&s),PetscTruth,s)
    353: EXTERN PetscErrorCode  VecLoad(PetscViewer,VecType,Vec*);
    354: EXTERN PetscErrorCode  VecLoadIntoVector(PetscViewer,Vec);

    356: EXTERN PetscErrorCode  VecGetSize(Vec,PetscInt*);
    357: PetscPolymorphicFunction(VecGetSize,(Vec x),(x,&s),PetscInt,s)
    358: EXTERN PetscErrorCode  VecGetLocalSize(Vec,PetscInt*);
    359: PetscPolymorphicFunction(VecGetLocalSize,(Vec x),(x,&s),PetscInt,s)
    360: EXTERN PetscErrorCode  VecGetOwnershipRange(Vec,PetscInt*,PetscInt*);

    362: EXTERN PetscErrorCode  VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping);
    363: EXTERN PetscErrorCode  VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

    365: /*MC
    366:    VecSetValueLocal - Set a single entry into a vector using the local numbering

    368:    Synopsis:
    369:    PetscErrorCode VecSetValueLocal(Vec v,int row,PetscScalar value, InsertMode mode);

    371:    Not Collective

    373:    Input Parameters:
    374: +  v - the vector
    375: .  row - the row location of the entry
    376: .  value - the value to insert
    377: -  mode - either INSERT_VALUES or ADD_VALUES

    379:    Notes:
    380:    For efficiency one should use VecSetValues() and set several or
    381:    many values simultaneously if possible.

    383:    These values may be cached, so VecAssemblyBegin() and VecAssemblyEnd()
    384:    MUST be called after all calls to VecSetValues() have been completed.

    386:    VecSetValues() uses 0-based indices in Fortran as well as in C.

    388:    Level: beginner

    390: .seealso: VecSetValues(), VecAssemblyBegin(), VecAssemblyEnd(), VecSetValuesBlockedLocal(), VecSetValue()
    391: M*/
    392: PETSC_STATIC_INLINE PetscErrorCode VecSetValueLocal(Vec v,PetscInt i,PetscScalar va,InsertMode mode) {return VecSetValuesLocal(v,1,&i,&va,mode);}

    394: EXTERN PetscErrorCode  VecSetLocalToGlobalMappingBlock(Vec,ISLocalToGlobalMapping);
    395: EXTERN PetscErrorCode  VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

    397: EXTERN PetscErrorCode  VecDotBegin(Vec,Vec,PetscScalar *);
    398: PetscPolymorphicSubroutine(VecDotBegin,(Vec x,Vec y),(x,y,PETSC_NULL))
    399: EXTERN PetscErrorCode  VecDotEnd(Vec,Vec,PetscScalar *);
    400: PetscPolymorphicFunction(VecDotEnd,(Vec x,Vec y),(x,y,&s),PetscScalar,s)
    401: EXTERN PetscErrorCode  VecTDotBegin(Vec,Vec,PetscScalar *);
    402: PetscPolymorphicSubroutine(VecTDotBegin,(Vec x,Vec y),(x,y,PETSC_NULL))
    403: EXTERN PetscErrorCode  VecTDotEnd(Vec,Vec,PetscScalar *);
    404: PetscPolymorphicFunction(VecTDotEnd,(Vec x,Vec y),(x,y,&s),PetscScalar,s)
    405: EXTERN PetscErrorCode  VecNormBegin(Vec,NormType,PetscReal *);
    406: PetscPolymorphicSubroutine(VecNormBegin,(Vec x,NormType t),(x,t,PETSC_NULL))
    407: PetscPolymorphicSubroutine(VecNormBegin,(Vec x),(x,NORM_2,PETSC_NULL))
    408: EXTERN PetscErrorCode  VecNormEnd(Vec,NormType,PetscReal *);
    409: PetscPolymorphicFunction(VecNormEnd,(Vec x,NormType t),(x,t,&s),PetscReal,s)
    410: PetscPolymorphicFunction(VecNormEnd,(Vec x),(x,NORM_2,&s),PetscReal,s)

    412: EXTERN PetscErrorCode  VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar *);
    413: EXTERN PetscErrorCode  VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar *);
    414: EXTERN PetscErrorCode  VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar *);
    415: EXTERN PetscErrorCode  VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar *);

    418: typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_TREAT_OFF_PROC_ENTRIES, \
    419:               VEC_IGNORE_NEGATIVE_INDICES, VEC_TREAT_NEGATIVE_INDICES} VecOption;
    420: EXTERN PetscErrorCode  VecSetOption(Vec,VecOption);

    422: /*
    423:    Expose VecGetArray()/VecRestoreArray() to users. Allows this to work without any function
    424:    call overhead on any 'native' Vecs.
    425: */

    427:  #include private/vecimpl.h

    429: EXTERN PetscErrorCode  VecContourScale(Vec,PetscReal,PetscReal);

    431: /*
    432:     These numbers need to match the entries in
    433:   the function table in vecimpl.h
    434: */
    435: typedef enum { VECOP_VIEW = 32, VECOP_LOADINTOVECTOR = 40} VecOperation;
    436: EXTERN PetscErrorCode  VecSetOperation(Vec,VecOperation,void(*)(void));

    438: /*
    439:      Routines for dealing with ghosted vectors:
    440:   vectors with ghost elements at the end of the array.
    441: */
    442: EXTERN PetscErrorCode  VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
    443: EXTERN PetscErrorCode  VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
    444: EXTERN PetscErrorCode  VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
    445: EXTERN PetscErrorCode  VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
    446: EXTERN PetscErrorCode  VecGhostGetLocalForm(Vec,Vec*);
    447: PetscPolymorphicFunction(VecGhostGetLocalForm,(Vec x),(x,&s),Vec,s)
    448: EXTERN PetscErrorCode  VecGhostRestoreLocalForm(Vec,Vec*);
    449: EXTERN PetscErrorCode  VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
    450: EXTERN PetscErrorCode  VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);

    452: EXTERN PetscErrorCode  VecConjugate(Vec);

    454: EXTERN PetscErrorCode  VecScatterCreateToAll(Vec,VecScatter*,Vec*);
    455: EXTERN PetscErrorCode  VecScatterCreateToZero(Vec,VecScatter*,Vec*);

    457: EXTERN PetscErrorCode  PetscViewerMathematicaGetVector(PetscViewer, Vec);
    458: EXTERN PetscErrorCode  PetscViewerMathematicaPutVector(PetscViewer, Vec);

    460: /*S
    461:      Vecs - Collection of vectors where the data for the vectors is stored in
    462:             one continquous memory

    464:    Level: advanced

    466:    Notes:
    467:     Temporary construct for handling multiply right hand side solves

    469:     This is faked by storing a single vector that has enough array space for
    470:     n vectors

    472:   Concepts: parallel decomposition

    474: S*/
    475:         struct _n_Vecs  {PetscInt n; Vec v;};
    476: typedef struct _n_Vecs* Vecs;
    477: #define VecsDestroy(x)            (VecDestroy((x)->v)         || PetscFree(x))
    478: #define VecsCreateSeq(comm,p,m,x) (PetscNew(struct _n_Vecs,x) || VecCreateSeq(comm,p*m,&(*(x))->v) || (-1 == ((*(x))->n = (m))))
    479: #define VecsCreateSeqWithArray(comm,p,m,a,x) (PetscNew(struct _n_Vecs,x) || VecCreateSeqWithArray(comm,p*m,a,&(*(x))->v) || (-1 == ((*(x))->n = (m))))
    480: #define VecsDuplicate(x,y)        (PetscNew(struct _n_Vecs,y) || VecDuplicate(x->v,&(*(y))->v) || (-1 == ((*(y))->n = (x)->n)))

    484: #endif