Actual source code: petscvec.h
petsc-3.7.1 2016-05-15
Report Typos and Errors

      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 <petscviewer.h>

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

     15:    Level: beginner

     17:   Concepts: field variables, unknowns, arrays

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

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

     27:    Level: beginner

     29:   Concepts: scatter

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

     35: /*E
     36:   ScatterMode - Determines the direction of a scatter

     38:   Level: beginner

     40: .seealso: VecScatter, VecScatterBegin(), VecScatterEnd()
     41: E*/
     42: typedef enum {SCATTER_FORWARD=0, SCATTER_REVERSE=1, SCATTER_FORWARD_LOCAL=2, SCATTER_REVERSE_LOCAL=3, SCATTER_LOCAL=2} ScatterMode;

     44: /*MC
     45:     SCATTER_FORWARD - Scatters the values as dictated by the VecScatterCreate() call

     47:     Level: beginner

     49: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD_LOCAL,
     50:           SCATTER_REVERSE_LOCAL

     52: M*/

     54: /*MC
     55:     SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated in
     56:          in the VecScatterCreate()

     58:     Level: beginner

     60: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
     61:           SCATTER_REVERSE_LOCAL

     63: M*/

     65: /*MC
     66:     SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the VecScatterCreate() call except NO parallel communication
     67:        is done. Any variables that have be moved between processes are ignored

     69:     Level: developer

     71: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_REVERSE, SCATTER_FORWARD,
     72:           SCATTER_REVERSE_LOCAL

     74: M*/

     76: /*MC
     77:     SCATTER_REVERSE_LOCAL - Moves the values in the opposite direction then the directions indicated in
     78:          in the VecScatterCreate()  except NO parallel communication
     79:        is done. Any variables that have be moved between processes are ignored

     81:     Level: developer

     83: .seealso: VecScatter, ScatterMode, VecScatterCreate(), VecScatterBegin(), VecScatterEnd(), SCATTER_FORWARD, SCATTER_FORWARD_LOCAL,
     84:           SCATTER_REVERSE

     86: M*/

     88: /*J
     89:     VecType - String with the name of a PETSc vector

     91:    Level: beginner

     93: .seealso: VecSetType(), Vec, VecCreate(), VecDestroy()
     94: J*/
     95: typedef const char* VecType;
     96: #define VECSEQ         "seq"
     97: #define VECMPI         "mpi"
     98: #define VECSTANDARD    "standard"   /* seq on one process and mpi on several */
     99: #define VECSHARED      "shared"
    100: #define VECSEQCUSP     "seqcusp"
    101: #define VECMPICUSP     "mpicusp"
    102: #define VECCUSP        "cusp"       /* seqcusp on one process and mpicusp on several */
    103: #define VECSEQVIENNACL "seqviennacl"
    104: #define VECMPIVIENNACL "mpiviennacl"
    105: #define VECVIENNACL    "viennacl"   /* seqviennacl on one process and mpiviennacl on several */
    106: #define VECSEQCUDA     "seqcuda"
    107: #define VECMPICUDA     "mpicuda"
    108: #define VECCUDA        "cuda"       /* seqcuda on one process and mpicuda on several */
    109: #define VECNEST        "nest"

    112: /* Logging support */
    113: #define    VEC_FILE_CLASSID 1211214
    114: PETSC_EXTERN PetscClassId VEC_CLASSID;
    115: PETSC_EXTERN PetscClassId VEC_SCATTER_CLASSID;

    118: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
    119: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);

    121: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm,Vec*);
    122: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm,PetscInt,Vec*);
    123: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm,PetscInt,PetscInt,Vec*);
    124: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,const PetscScalar[],Vec*);
    125: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscScalar[],Vec*);
    126: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm,PetscInt,PetscInt,Vec*);
    127: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
    128: PETSC_STATIC_INLINE PetscErrorCode VecViewFromOptions(Vec A,PetscObject B,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,B,name);}

    130: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
    131: PETSC_EXTERN PetscErrorCode VecDestroy(Vec*);
    132: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
    133: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec,const char[]);
    134: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec,const char[]);
    135: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec,const char*[]);

    137: PETSC_EXTERN PetscErrorCode VecSetSizes(Vec,PetscInt,PetscInt);

    139: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec,Vec,PetscScalar*,PetscReal*);
    140: PETSC_EXTERN PetscErrorCode VecDot(Vec,Vec,PetscScalar*);
    141: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec,Vec,PetscReal*);
    142: PETSC_EXTERN PetscErrorCode VecTDot(Vec,Vec,PetscScalar*);
    143: PETSC_EXTERN PetscErrorCode VecMDot(Vec,PetscInt,const Vec[],PetscScalar[]);
    144: PETSC_EXTERN PetscErrorCode VecMTDot(Vec,PetscInt,const Vec[],PetscScalar[]);
    145: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec,IS,Vec*);
    146: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec,IS,Vec*);

    148: /*E
    149:     NormType - determines what type of norm to compute

    151:     Level: beginner

    153: .seealso: VecNorm(), VecNormBegin(), VecNormEnd(), MatNorm()
    154: E*/
    155: typedef enum {NORM_1=0,NORM_2=1,NORM_FROBENIUS=2,NORM_INFINITY=3,NORM_1_AND_2=4} NormType;
    156: PETSC_EXTERN const char *const NormTypes[];
    157: #define NORM_MAX NORM_INFINITY

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

    162:    Level: beginner

    164: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_2, NORM_FROBENIUS,
    165:            NORM_INFINITY, NORM_1_AND_2

    167: M*/

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

    172:    Level: beginner

    174: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_FROBENIUS,
    175:            NORM_INFINITY, NORM_1_AND_2

    177: M*/

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

    182:    Level: beginner

    184: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
    185:            NORM_INFINITY, NORM_1_AND_2

    187: M*/

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

    192:    Level: beginner

    194: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
    195:            NORM_FROBINIUS, NORM_1_AND_2

    197: M*/

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

    202:    Level: beginner

    204: .seealso:  NormType, MatNorm(), VecNorm(), VecNormBegin(), VecNormEnd(), NORM_1, NORM_2,
    205:            NORM_FROBINIUS, NORM_INFINITY

    207: M*/

    209: /*MC
    210:      NORM_MAX - see NORM_INFINITY

    212:    Level: beginner

    214: M*/

    216: PETSC_EXTERN PetscErrorCode VecNorm(Vec,NormType,PetscReal *);
    217: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec,NormType,PetscBool *,PetscReal *);
    218: PETSC_EXTERN PetscErrorCode VecNormalize(Vec,PetscReal *);
    219: PETSC_EXTERN PetscErrorCode VecSum(Vec,PetscScalar*);
    220: PETSC_EXTERN PetscErrorCode VecMax(Vec,PetscInt*,PetscReal *);
    221: PETSC_EXTERN PetscErrorCode VecMin(Vec,PetscInt*,PetscReal *);
    222: PETSC_EXTERN PetscErrorCode VecScale(Vec,PetscScalar);
    223: PETSC_EXTERN PetscErrorCode VecCopy(Vec,Vec);
    224: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec,PetscRandom);
    225: PETSC_EXTERN PetscErrorCode VecSet(Vec,PetscScalar);
    226: PETSC_EXTERN PetscErrorCode VecSetInf(Vec);
    227: PETSC_EXTERN PetscErrorCode VecSwap(Vec,Vec);
    228: PETSC_EXTERN PetscErrorCode VecAXPY(Vec,PetscScalar,Vec);
    229: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec,PetscScalar,PetscScalar,Vec);
    230: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec,PetscInt,const PetscScalar[],Vec[]);
    231: PETSC_EXTERN PetscErrorCode VecAYPX(Vec,PetscScalar,Vec);
    232: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec,PetscScalar,Vec,Vec);
    233: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec,PetscScalar,PetscScalar,PetscScalar,Vec,Vec);
    234: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec,Vec,Vec);
    235: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec,Vec,Vec);
    236: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec,Vec,Vec);
    237: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec,Vec,Vec);
    238: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec,Vec,Vec);
    239: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec,Vec,PetscReal*);
    240: PETSC_EXTERN PetscErrorCode VecShift(Vec,PetscScalar);
    241: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
    242: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool );
    243: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
    244: PETSC_EXTERN PetscErrorCode VecLog(Vec);
    245: PETSC_EXTERN PetscErrorCode VecExp(Vec);
    246: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
    247: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec,Vec*);
    248: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec,PetscInt,Vec*[]);
    249: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec*[]);
    250: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec,NormType,PetscReal[]);
    251: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec,PetscInt [],PetscReal []);
    252: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec,PetscInt [],PetscReal []);
    253: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec,const PetscScalar[]);
    254: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec,PetscInt*,PetscScalar**);

    256: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec,PetscInt,NormType,PetscReal*);
    257: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec,PetscInt,PetscInt *,PetscReal *);
    258: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec,PetscInt,PetscInt *,PetscReal *);
    259: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec,PetscInt,PetscScalar);
    260: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec,PetscInt,PetscScalar);

    263: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec,PetscInt,Vec,InsertMode);
    264: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec,PetscInt,Vec,InsertMode);
    265: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec,Vec[],InsertMode);
    266: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[],Vec,InsertMode);

    268: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);
    269: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec,PetscInt,const PetscInt[],const PetscInt[],Vec,InsertMode);

    271: PETSC_EXTERN PetscErrorCode VecSetValues(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    272: PETSC_EXTERN PetscErrorCode VecGetValues(Vec,PetscInt,const PetscInt[],PetscScalar[]);
    273: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
    274: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
    275: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec,PetscInt,PetscInt);
    276: PETSC_EXTERN PetscErrorCode VecStashView(Vec,PetscViewer);
    277: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec,PetscObject,const char[]);
    278: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec,PetscInt*,PetscInt*,PetscInt*,PetscInt*);

    280: /*MC
    281:    VecSetValue - Set a single entry into a vector.

    283:    Synopsis:
    284:    #include <petscvec.h>
    285:    PetscErrorCode VecSetValue(Vec v,PetscInt row,PetscScalar value, InsertMode mode);

    287:    Not Collective

    289:    Input Parameters:
    290: +  v - the vector
    291: .  row - the row location of the entry
    292: .  value - the value to insert
    293: -  mode - either INSERT_VALUES or ADD_VALUES

    295:    Notes:
    296:    For efficiency one should use VecSetValues() and set several or
    297:    many values simultaneously if possible.

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

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

    304:    Level: beginner

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

    311: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec,PetscInt);
    312: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec,PetscInt*);
    313: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

    315: /* Dynamic creation and loading functions */
    316: PETSC_EXTERN PetscFunctionList VecList;
    317: PETSC_EXTERN PetscErrorCode VecSetType(Vec, VecType);
    318: PETSC_EXTERN PetscErrorCode VecGetType(Vec, VecType *);
    319: PETSC_EXTERN PetscErrorCode VecRegister(const char[],PetscErrorCode (*)(Vec));

    321: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec,IS,Vec,IS,VecScatter *);
    322: PETSC_EXTERN PetscErrorCode VecScatterCreateEmpty(MPI_Comm,VecScatter *);
    323: PETSC_EXTERN PetscErrorCode VecScatterCreateLocal(VecScatter,PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt,const PetscInt[],const PetscInt[],const PetscInt[],PetscInt);
    324: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter,Vec,Vec,InsertMode,ScatterMode);
    325: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter,Vec,Vec,InsertMode,ScatterMode);
    326: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter*);
    327: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter,VecScatter *);
    328: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter,PetscViewer);
    329: PETSC_STATIC_INLINE PetscErrorCode VecScatterViewFromOptions(VecScatter A,PetscObject obj,const char name[]) {return PetscObjectViewFromOptions((PetscObject)A,obj,name);}
    330: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter,PetscInt *,PetscInt*);
    331: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter,PetscBool *);

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

    342: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
    343: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar****[]);
    344: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
    345: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar***[]);
    346: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
    347: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec,PetscInt,PetscInt,PetscInt,PetscInt,PetscScalar**[]);
    348: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec,PetscInt,PetscInt,PetscScalar *[]);
    349: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec,PetscInt,PetscInt,PetscScalar *[]);

    351: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec,const PetscScalar[]);
    352: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
    353: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec,const PetscScalar[]);
    354: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[],PetscInt,PetscScalar**[]);
    355: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[],PetscInt,PetscScalar**[]);

    357: PETSC_EXTERN PetscErrorCode VecView(Vec,PetscViewer);
    358: PETSC_EXTERN PetscErrorCode VecEqual(Vec,Vec,PetscBool *);
    359: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);

    361: PETSC_EXTERN PetscErrorCode VecGetSize(Vec,PetscInt*);
    362: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec,PetscInt*);
    363: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec,PetscInt*,PetscInt*);
    364: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec,const PetscInt *[]);

    366: PETSC_EXTERN PetscErrorCode VecSetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping);
    367: PETSC_EXTERN PetscErrorCode VecSetValuesLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);

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

    372:    Synopsis:
    373:    #include <petscvec.h>
    374:    PetscErrorCode VecSetValueLocal(Vec v,PetscInt row,PetscScalar value, InsertMode mode);

    376:    Not Collective

    378:    Input Parameters:
    379: +  v - the vector
    380: .  row - the row location of the entry
    381: .  value - the value to insert
    382: -  mode - either INSERT_VALUES or ADD_VALUES

    384:    Notes:
    385:    For efficiency one should use VecSetValues() and set several or
    386:    many values simultaneously if possible.

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

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

    393:    Level: beginner

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

    399: PETSC_EXTERN PetscErrorCode VecSetValuesBlockedLocal(Vec,PetscInt,const PetscInt[],const PetscScalar[],InsertMode);
    400: PETSC_EXTERN PetscErrorCode VecGetLocalToGlobalMapping(Vec,ISLocalToGlobalMapping*);

    402: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec,Vec,PetscScalar *);
    403: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec,Vec,PetscScalar *);
    404: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec,Vec,PetscScalar *);
    405: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec,Vec,PetscScalar *);
    406: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec,NormType,PetscReal *);
    407: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec,NormType,PetscReal *);

    409: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
    410: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
    411: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec,PetscInt,const Vec[],PetscScalar[]);
    412: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec,PetscInt,const Vec[],PetscScalar[]);
    413: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);

    416: typedef enum {VEC_IGNORE_OFF_PROC_ENTRIES,VEC_IGNORE_NEGATIVE_INDICES,VEC_SUBSET_OFF_PROC_ENTRIES} VecOption;
    417: PETSC_EXTERN PetscErrorCode VecSetOption(Vec,VecOption,PetscBool );

    419: PETSC_EXTERN PetscErrorCode VecGetArray(Vec,PetscScalar**);
    420: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec,const PetscScalar**);
    421: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec,PetscScalar**);
    422: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec,const PetscScalar**);
    423: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec,Vec);
    424: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec,Vec);
    425: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec,Vec);
    426: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec,Vec);
    427: /*
    428:    Accesses a pair of pointers for two vectors that may be common. When not common the first is read only
    429: */
    430: PETSC_STATIC_INLINE PetscErrorCode VecGetArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv)
    431: {

    435:   VecGetArray(y,yv);
    436:   if (x != y) {
    437:     VecGetArrayRead(x,(const PetscScalar **)xv);
    438:   } else {
    439:     *xv = *yv;
    440:   }
    441:   return(0);
    442: }
    443: PETSC_STATIC_INLINE PetscErrorCode VecRestoreArrayPair(Vec x,Vec y,PetscScalar **xv,PetscScalar **yv)
    444: {

    448:   VecRestoreArray(y,yv);
    449:   if (x != y) {
    450:     VecRestoreArrayRead(x,(const PetscScalar **)xv);
    451:   }
    452:   return(0);
    453: }

    455: #if defined(PETSC_USE_DEBUG)
    456: PETSC_EXTERN PetscErrorCode VecLockGet(Vec,PetscInt*);
    457: PETSC_EXTERN PetscErrorCode VecLockPush(Vec);
    458: PETSC_EXTERN PetscErrorCode VecLockPop(Vec);
    459: #define VecLocked(x,arg) do {PetscInt _st; PetscErrorCode __VecLockGet(x,&_st); CHKERRQ(__ierr); if (_st > 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_WRONGSTATE," Vec is locked read only, argument # %d",arg);} while (0)
    460: #else
    461: #define VecLockGet(x,arg)     *(arg) = 0
    462: #define VecLockPush(x)        0
    463: #define VecLockPop(x)         0
    464: #define VecLocked(x,arg)
    465: #endif

    467: PETSC_EXTERN PetscErrorCode VecValidValues(Vec,PetscInt,PetscBool);

    469: /*
    470:     These numbers need to match the entries in
    471:   the function table in vecimpl.h
    472: */
    473: typedef enum { VECOP_DUPLICATE = 0, VECOP_VIEW = 33, VECOP_LOAD = 41, VECOP_VIEWNATIVE = 68, VECOP_LOADNATIVE = 69 } VecOperation;
    474: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec,VecOperation,void(*)(void));

    476: /*
    477:      Routines for dealing with ghosted vectors:
    478:   vectors with ghost elements at the end of the array.
    479: */
    480: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec,PetscInt,const PetscInt[]);
    481: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
    482: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
    483: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],Vec*);
    484: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm,PetscInt,PetscInt,PetscInt,PetscInt,const PetscInt[],const PetscScalar[],Vec*);
    485: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec,Vec*);
    486: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec,Vec*);
    487: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec,Vec,PetscBool*);
    488: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec,InsertMode,ScatterMode);
    489: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec,InsertMode,ScatterMode);

    491: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);

    493: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec,VecScatter*,Vec*);
    494: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec,VecScatter*,Vec*);

    496: PETSC_EXTERN PetscErrorCode ISComplementVec(IS,Vec,IS*);
    497: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
    498: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
    499: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
    500: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
    501: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS * );
    502: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
    503: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
    504: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar,Vec);
    505: PETSC_EXTERN PetscErrorCode VecISSet(Vec,IS, PetscScalar);
    506: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
    507: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec,Vec,Vec,Vec,PetscReal*, PetscReal*,PetscReal*);
    508: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
    509: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec,Vec,Vec,Vec,PetscReal*);

    511: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
    512: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);

    514: /*S
    515:      Vecs - Collection of vectors where the data for the vectors is stored in
    516:             one contiguous memory

    518:    Level: advanced

    520:    Notes:
    521:     Temporary construct for handling multiply right hand side solves

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

    526:   Concepts: parallel decomposition

    528: S*/
    529:         struct _n_Vecs  {PetscInt n; Vec v;};
    530: typedef struct _n_Vecs* Vecs;
    531: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
    532: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm,PetscInt,PetscInt,Vecs*);
    533: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm,PetscInt,PetscInt,PetscScalar*,Vecs*);
    534: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs,Vecs*);

    536: #if defined(PETSC_HAVE_CUSP)
    537: typedef struct _p_PetscCUSPIndices* PetscCUSPIndices;
    538: typedef struct _p_VecScatterCUSPIndices_StoS* VecScatterCUSPIndices_StoS;
    539: typedef struct _p_VecScatterCUSPIndices_PtoP* VecScatterCUSPIndices_PtoP;
    540: PETSC_EXTERN PetscErrorCode VecCUSPCopyToGPUSome_Public(Vec,PetscCUSPIndices);
    541: PETSC_EXTERN PetscErrorCode VecCUSPCopyFromGPUSome_Public(Vec,PetscCUSPIndices);
    542: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode);
    543: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
    544: PETSC_EXTERN PetscErrorCode VecCreateSeqCUSP(MPI_Comm,PetscInt,Vec*);
    545: PETSC_EXTERN PetscErrorCode VecCreateMPICUSP(MPI_Comm,PetscInt,PetscInt,Vec*);
    546: #elif defined(PETSC_HAVE_VIENNACL)
    547: typedef struct _p_PetscViennaCLIndices* PetscViennaCLIndices;
    548: PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesCreate(PetscInt, PetscInt*,PetscInt, PetscInt*,PetscViennaCLIndices*);
    549: PETSC_EXTERN PetscErrorCode PetscViennaCLIndicesDestroy(PetscViennaCLIndices*);
    550: PETSC_EXTERN PetscErrorCode VecViennaCLCopyToGPUSome_Public(Vec,PetscViennaCLIndices);
    551: PETSC_EXTERN PetscErrorCode VecViennaCLCopyFromGPUSome_Public(Vec,PetscViennaCLIndices);
    552: PETSC_EXTERN PetscErrorCode VecCreateSeqViennaCL(MPI_Comm,PetscInt,Vec*);
    553: PETSC_EXTERN PetscErrorCode VecCreateMPIViennaCL(MPI_Comm,PetscInt,PetscInt,Vec*);
    554: #elif defined(PETSC_HAVE_VECCUDA)
    555: typedef struct _p_PetscCUDAIndices* PetscCUDAIndices;
    556: typedef struct _p_VecScatterCUDAIndices_StoS* VecScatterCUDAIndices_StoS;
    557: typedef struct _p_VecScatterCUDAIndices_PtoP* VecScatterCUDAIndices_PtoP;
    558: PETSC_EXTERN PetscErrorCode VecCUDACopyToGPUSome_Public(Vec,PetscCUDAIndices);
    559: PETSC_EXTERN PetscErrorCode VecCUDACopyFromGPUSome_Public(Vec,PetscCUDAIndices);
    560: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter,Vec,ScatterMode);
    561: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
    562: PETSC_EXTERN PetscErrorCode VecCreateSeqCUDA(MPI_Comm,PetscInt,Vec*);
    563: PETSC_EXTERN PetscErrorCode VecCreateMPICUDA(MPI_Comm,PetscInt,PetscInt,Vec*);
    564: #endif

    566: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec,PetscInt*,Vec**);
    567: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec,PetscInt,Vec*);
    568: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec,PetscInt,PetscInt*,Vec*);
    569: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec,PetscInt,Vec);
    570: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm,PetscInt,IS*,Vec*,Vec*);
    571: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec,PetscInt*);

    573: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions,const char[],const char[],Vec,PetscBool*);
    574: PETSC_EXTERN PetscErrorCode VecChop(Vec,PetscReal);

    576: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec,PetscLayout*);
    577: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec,PetscLayout);

    579: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
    580: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar **);
    581: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, PetscScalar [], InsertMode);
    582: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal []);

    584: PETSC_EXTERN PetscErrorCode PetscSFCreateFromZero(MPI_Comm,Vec,PetscSF*);

    586: #endif