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: */
      6: #pragma once

      8: #include <petscsys.h>
      9: #include <petscsftypes.h>
     10: #include <petscis.h>
     11: #include <petscdevicetypes.h>
     12: #include <petscviewer.h>

     14: /* SUBMANSEC = Vec */

     16: /*S
     17:    Vec - Abstract PETSc vector object. Used for holding solutions and right-hand sides for linear systems, nonlinear systems, and time integrators

     19:    Level: beginner

     21:    Note:
     22:    Internally the actual vector representation is generally a simple array but most PETSc code can work on other representations through this abstraction

     24: .seealso: [](doc_vector), [](ch_vectors), `VecCreate()`, `VecType`, `VecSetType()`
     25: S*/
     26: typedef struct _p_Vec *Vec;

     28: /*E
     29:   ScatterMode - Determines the direction of a scatter in `VecScatterBegin()` and `VecScatterEnd()`

     31:   Values:
     32: +  `SCATTER_FORWARD`       - Scatters the values as dictated by the `VecScatterCreate()` call
     33: .  `SCATTER_REVERSE`       - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
     34: .  `SCATTER_FORWARD_LOCAL` - Scatters the values as dictated by the `VecScatterCreate()` call except NO MPI communication is done
     35: -  `SCATTER_REVERSE_LOCAL` - Moves the values in the opposite direction than the directions indicated in the `VecScatterCreate()` call
     36:                              except NO MPI communication is done

     38:   Level: beginner

     40: .seealso: [](ch_vectors), `VecScatter`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`, `SCATTER_REVERSE_LOCAL`
     41: E*/
     42: typedef enum {
     43:   SCATTER_FORWARD       = 0,
     44:   SCATTER_REVERSE       = 1,
     45:   SCATTER_FORWARD_LOCAL = 2,
     46:   SCATTER_REVERSE_LOCAL = 3
     47: } ScatterMode;

     49: /*MC
     50:     SCATTER_FORWARD - Scatters the values as dictated by the `VecScatterCreate()` call during `VecScatterBegin()` and `VecScatterEnd()`

     52:     Level: beginner

     54: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD_LOCAL`,
     55:           `SCATTER_REVERSE_LOCAL`
     56: M*/

     58: /*MC
     59:     SCATTER_REVERSE - Moves the values in the opposite direction then the directions indicated
     60:                       in the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()`

     62:     Level: beginner

     64: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
     65:           `SCATTER_REVERSE_LOCAL`
     66: M*/

     68: /*MC
     69:     SCATTER_FORWARD_LOCAL - Scatters the values as dictated by the `VecScatterCreate()` during `VecScatterBegin()` and `VecScatterEnd()` call except NO parallel communication
     70:                             is done. Any variables that have be moved between processes are ignored

     72:     Level: developer

     74: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_REVERSE`, `SCATTER_FORWARD`,
     75:           `SCATTER_REVERSE_LOCAL`
     76: M*/

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

     83:     Level: developer

     85: .seealso: [](ch_vectors), `VecScatter`, `ScatterMode`, `VecScatterCreate()`, `VecScatterBegin()`, `VecScatterEnd()`, `SCATTER_FORWARD`, `SCATTER_FORWARD_LOCAL`,
     86:           `SCATTER_REVERSE`
     87: M*/

     89: /*J
     90:    VecType - String with the name of a PETSc vector, `Vec`, type

     92:    Level: beginner

     94: .seealso: [](doc_vector), [](ch_vectors), `VecSetType()`, `Vec`, `VecCreate()`, `VecDestroy()`
     95: J*/
     96: typedef const char *VecType;
     97: #define VECSEQ         "seq"
     98: #define VECMPI         "mpi"
     99: #define VECSTANDARD    "standard" /* seq on one process and mpi on multiple */
    100: #define VECSHARED      "shared"
    101: #define VECSEQVIENNACL "seqviennacl"
    102: #define VECMPIVIENNACL "mpiviennacl"
    103: #define VECVIENNACL    "viennacl" /* seqviennacl on one process and mpiviennacl on multiple */
    104: #define VECSEQCUDA     "seqcuda"
    105: #define VECMPICUDA     "mpicuda"
    106: #define VECCUDA        "cuda" /* seqcuda on one process and mpicuda on multiple */
    107: #define VECSEQHIP      "seqhip"
    108: #define VECMPIHIP      "mpihip"
    109: #define VECHIP         "hip" /* seqhip on one process and mpihip on multiple */
    110: #define VECNEST        "nest"
    111: #define VECSEQKOKKOS   "seqkokkos"
    112: #define VECMPIKOKKOS   "mpikokkos"
    113: #define VECKOKKOS      "kokkos" /* seqkokkos on one process and mpikokkos on multiple */

    115: /* Dynamic creation and loading functions */
    116: PETSC_EXTERN PetscErrorCode VecScatterSetType(VecScatter, VecScatterType);
    117: PETSC_EXTERN PetscErrorCode VecScatterGetType(VecScatter, VecScatterType *);
    118: PETSC_EXTERN PetscErrorCode VecScatterSetFromOptions(VecScatter);
    119: PETSC_EXTERN PetscErrorCode VecScatterRegister(const char[], PetscErrorCode (*)(VecScatter));
    120: PETSC_EXTERN PetscErrorCode VecScatterCreate(Vec, IS, Vec, IS, VecScatter *);

    122: /* Logging support */
    123: #define REAL_FILE_CLASSID 1211213
    124: #define VEC_FILE_CLASSID  1211214
    125: PETSC_EXTERN PetscClassId VEC_CLASSID;
    126: PETSC_EXTERN PetscClassId PETSCSF_CLASSID;

    128: PETSC_EXTERN PetscErrorCode VecInitializePackage(void);
    129: PETSC_EXTERN PetscErrorCode VecFinalizePackage(void);

    131: PETSC_EXTERN PetscErrorCode VecCreate(MPI_Comm, Vec *);
    132: PETSC_EXTERN PetscErrorCode VecCreateFromOptions(MPI_Comm, const char *, PetscInt, PetscInt, PetscInt, Vec *);
    133: PETSC_EXTERN PetscErrorCode VecCreateSeq(MPI_Comm, PetscInt, Vec *);
    134: PETSC_EXTERN PetscErrorCode VecCreateMPI(MPI_Comm, PetscInt, PetscInt, Vec *);
    135: PETSC_EXTERN PetscErrorCode VecCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar[], Vec *);
    136: PETSC_EXTERN PetscErrorCode VecCreateMPIWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar[], Vec *);
    137: PETSC_EXTERN PetscErrorCode VecCreateShared(MPI_Comm, PetscInt, PetscInt, Vec *);

    139: PETSC_EXTERN PetscErrorCode VecSetFromOptions(Vec);
    140: PETSC_EXTERN PetscErrorCode VecViewFromOptions(Vec, PetscObject, const char[]);

    142: PETSC_EXTERN PetscErrorCode VecSetUp(Vec);
    143: PETSC_EXTERN PetscErrorCode VecDestroy(Vec *);
    144: PETSC_EXTERN PetscErrorCode VecZeroEntries(Vec);
    145: PETSC_EXTERN PetscErrorCode VecSetOptionsPrefix(Vec, const char[]);
    146: PETSC_EXTERN PetscErrorCode VecAppendOptionsPrefix(Vec, const char[]);
    147: PETSC_EXTERN PetscErrorCode VecGetOptionsPrefix(Vec, const char *[]);
    148: PETSC_EXTERN PetscErrorCode VecGetState(Vec, PetscObjectState *);

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

    152: PETSC_EXTERN PetscErrorCode VecDotNorm2(Vec, Vec, PetscScalar *, PetscReal *);
    153: PETSC_EXTERN PetscErrorCode VecDot(Vec, Vec, PetscScalar *);
    154: PETSC_EXTERN PetscErrorCode VecDotRealPart(Vec, Vec, PetscReal *);
    155: PETSC_EXTERN PetscErrorCode VecTDot(Vec, Vec, PetscScalar *);
    156: PETSC_EXTERN PetscErrorCode VecMDot(Vec, PetscInt, const Vec[], PetscScalar[]);
    157: PETSC_EXTERN PetscErrorCode VecMTDot(Vec, PetscInt, const Vec[], PetscScalar[]);
    158: PETSC_EXTERN PetscErrorCode VecGetSubVector(Vec, IS, Vec *);
    159: PETSC_EXTERN PetscErrorCode VecRestoreSubVector(Vec, IS, Vec *);
    160: PETSC_EXTERN PetscErrorCode VecConcatenate(PetscInt, const Vec[], Vec *, IS *[]);

    162: /*E
    163:     NormType - determines what type of norm to compute with `VecNorm()`, `VecNormBegin()`/`VecNormEnd()` and `MatNorm()`.

    165:     Values:
    166: +    `NORM_1`         - the one norm, $||v|| = \sum_i | v_i |$. $||A|| = \max_j || A_{*j} ||$, maximum column sum
    167: .    `NORM_2`         - the two norm, $||v|| = sqrt(\sum_i |v_i|^2)$ (vectors only)
    168: .    `NORM_FROBENIUS` - $||A|| = sqrt(\sum_{ij} |A_{ij}|^2)$, same as `NORM_2` for vectors
    169: .    `NORM_INFINITY`  - $||v|| = \max_i |v_i|$. $||A|| = \max_i || A_{i*} ||_1$, maximum row sum
    170: -    `NORM_1_AND_2`   - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations

    172:     Level: beginner

    174:     Note:
    175:     The `v` above represents a `Vec` while the `A` represents a `Mat`

    177: .seealso: [](ch_vectors), `Vec`, `Mat`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `MatNorm()`, `NORM_1`,
    178:           `NORM_2`, `NORM_FROBENIUS`, `NORM_INFINITY`, `NORM_1_AND_2`, `ReductionType`
    179: E*/
    180: typedef enum {
    181:   NORM_1         = 0,
    182:   NORM_2         = 1,
    183:   NORM_FROBENIUS = 2,
    184:   NORM_INFINITY  = 3,
    185:   NORM_1_AND_2   = 4
    186: } NormType;
    187: PETSC_EXTERN const char *const NormTypes[];
    188: #define NORM_MAX NORM_INFINITY

    190: /*MC
    191:    NORM_1 - the one norm, $||v|| = \sum_i | v_i |$. $||A|| = \max_j || A_{*,j} ||$, maximum column sum

    193:    Level: beginner

    195: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_2`, `NORM_FROBENIUS`,
    196:           `NORM_INFINITY`, `NORM_1_AND_2`
    197: M*/

    199: /*MC
    200:    NORM_2 - the two norm, $||v|| = \sqrt{\sum_i |v_i|^2}$ (vectors only)

    202:    Level: beginner

    204: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_FROBENIUS`,
    205:           `NORM_INFINITY`, `NORM_1_AND_2`
    206: M*/

    208: /*MC
    209:    NORM_FROBENIUS - $||A|| = \sqrt{\sum_{i,j} |A_{i,j}|^2}$, same as `NORM_2` for vectors

    211:    Level: beginner

    213: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
    214:           `NORM_INFINITY`, `NORM_1_AND_2`
    215: M*/

    217: /*MC
    218:    NORM_INFINITY - $||v|| = \max_i |v_i|$. $||A|| = \max_i || A_{i,*} ||_1$, maximum row sum

    220:    Level: beginner

    222: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
    223:           `NORM_FROBENIUS`, `NORM_1_AND_2`
    224: M*/

    226: /*MC
    227:    NORM_1_AND_2 - computes both the 1 and 2 norm of a vector. The values are stored in two adjacent `PetscReal` memory locations

    229:    Level: beginner

    231: .seealso: [](ch_vectors), `NormType`, `MatNorm()`, `VecNorm()`, `VecNormBegin()`, `VecNormEnd()`, `NORM_1`, `NORM_2`,
    232:           `NORM_FROBENIUS`, `NORM_INFINITY`
    233: M*/

    235: /*MC
    236:    NORM_MAX - see `NORM_INFINITY`

    238:    Level: beginner
    239: M*/

    241: /*E
    242:     ReductionType - determines what type of column reduction (one that is not a type of norm defined in `NormType`) to obtain with `MatGetColumnReductions()`

    244:     Values:
    245: +  `REDUCTION_SUM_REALPART`       - sum of real part of each matrix column
    246: .  `REDUCTION_SUM_IMAGINARYPART`  - sum of imaginary part of each matrix column
    247: .  `REDUCTION_MEAN_REALPART`      - arithmetic mean of real part of each matrix column
    248: -  `REDUCTION_MEAN_IMAGINARYPART` - arithmetic mean of imaginary part of each matrix column

    250:     Level: beginner

    252:     Developer Note:
    253:     The constants defined in `ReductionType` MUST BE DISTINCT from those defined in `NormType`.
    254:     This is because `MatGetColumnReductions()` is used to compute both norms and other types of reductions,
    255:     and the constants defined in both `NormType` and `ReductionType` are used to designate the desired operation.

    257: .seealso: [](ch_vectors), `MatGetColumnReductions()`, `MatGetColumnNorms()`, `NormType`, `REDUCTION_SUM_REALPART`,
    258:           `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`
    259: E*/
    260: typedef enum {
    261:   REDUCTION_SUM_REALPART       = 10,
    262:   REDUCTION_MEAN_REALPART      = 11,
    263:   REDUCTION_SUM_IMAGINARYPART  = 12,
    264:   REDUCTION_MEAN_IMAGINARYPART = 13
    265: } ReductionType;

    267: /*E
    268:   VecSignMode - How `VecPointwiseSign()` should handle zero value

    270:   Values:
    271: + `VEC_SIGN_ZERO_TO_ZERO`        - `-0.0` and `0.0` map to `0.0`
    272: . `VEC_SIGN_ZERO_TO_SIGNED_ZERO` - `-0.0` maps to `-0.0` and `0.0` maps to `0.0`
    273: - `VEC_SIGN_ZERO_TO_SIGNED_UNIT` - `-0.0` maps to `-1.0` and `0.0` maps to `1.0`

    275:   Level: advanced

    277: .seealso: [](ch_vectors), `VecPointwiseSign()`
    278: E*/
    279: typedef enum {
    280:   VEC_SIGN_ZERO_TO_ZERO,
    281:   VEC_SIGN_ZERO_TO_SIGNED_ZERO,
    282:   VEC_SIGN_ZERO_TO_SIGNED_UNIT,
    283: } VecSignMode;

    285: /*MC
    286:    REDUCTION_SUM_REALPART - sum of real part of a matrix column to obtain with `MatGetColumnReductions()`

    288:    Level: beginner

    290: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_IMAGINARYPART`, `REDUCTION_MEAN_REALPART`
    291: M*/

    293: /*MC
    294:    REDUCTION_SUM_IMAGINARYPART - sum of imaginary part of matrix column to obtain with `MatGetColumnReductions()`

    296:    Level: beginner

    298: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_SUM_REALPART`, `REDUCTION_MEAN_IMAGINARYPART`
    299: M*/

    301: /*MC
    302:    REDUCTION_MEAN_REALPART - arithmetic mean of real part of matrix column to obtain with `MatGetColumnReductions()`

    304:    Level: beginner

    306: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_IMAGINARYPART`, `REDUCTION_SUM_REALPART`
    307: M*/

    309: /*MC
    310:    REDUCTION_MEAN_IMAGINARYPART - arithmetic mean of imaginary part of matrix column to obtain with `MatGetColumnReductions()`

    312:    Level: beginner

    314: .seealso: [](ch_vectors), `ReductionType`, `MatGetColumnReductions()`, `REDUCTION_MEAN_REALPART`, `REDUCTION_SUM_IMAGINARYPART`
    315: M*/

    317: PETSC_EXTERN PetscErrorCode VecNorm(Vec, NormType, PetscReal *);
    318: PETSC_EXTERN PetscErrorCode VecNormAvailable(Vec, NormType, PetscBool *, PetscReal *);
    319: PETSC_EXTERN PetscErrorCode VecFlag(Vec, PetscInt);
    320: PETSC_EXTERN PetscErrorCode VecNormalize(Vec, PetscReal *);
    321: PETSC_EXTERN PetscErrorCode VecSum(Vec, PetscScalar *);
    322: PETSC_EXTERN PetscErrorCode VecMean(Vec, PetscScalar *);
    323: PETSC_EXTERN PetscErrorCode VecMax(Vec, PetscInt *, PetscReal *);
    324: PETSC_EXTERN PetscErrorCode VecMin(Vec, PetscInt *, PetscReal *);
    325: PETSC_EXTERN PetscErrorCode VecScale(Vec, PetscScalar);
    326: PETSC_EXTERN PetscErrorCode VecCopy(Vec, Vec);
    327: PETSC_EXTERN PetscErrorCode VecSetRandom(Vec, PetscRandom);
    328: PETSC_EXTERN PetscErrorCode VecSetRandomGaussian(Vec, PetscRandom, PetscReal, PetscReal);
    329: PETSC_EXTERN PetscErrorCode VecSet(Vec, PetscScalar);
    330: PETSC_DEPRECATED_FUNCTION(3, 22, 0, "VecFlag()", ) PetscErrorCode VecSetInf(Vec);
    331: PETSC_EXTERN PetscErrorCode VecSwap(Vec, Vec);
    332: PETSC_EXTERN PetscErrorCode VecAXPY(Vec, PetscScalar, Vec);
    333: PETSC_EXTERN PetscErrorCode VecAXPBY(Vec, PetscScalar, PetscScalar, Vec);
    334: PETSC_EXTERN PetscErrorCode VecMAXPY(Vec, PetscInt, const PetscScalar[], Vec[]);
    335: PETSC_EXTERN PetscErrorCode VecMAXPBY(Vec, PetscInt, const PetscScalar[], PetscScalar, Vec[]);
    336: PETSC_EXTERN PetscErrorCode VecAYPX(Vec, PetscScalar, Vec);
    337: PETSC_EXTERN PetscErrorCode VecWAXPY(Vec, PetscScalar, Vec, Vec);
    338: PETSC_EXTERN PetscErrorCode VecAXPBYPCZ(Vec, PetscScalar, PetscScalar, PetscScalar, Vec, Vec);
    339: PETSC_EXTERN PetscErrorCode VecPointwiseMax(Vec, Vec, Vec);
    340: PETSC_EXTERN PetscErrorCode VecPointwiseMaxAbs(Vec, Vec, Vec);
    341: PETSC_EXTERN PetscErrorCode VecPointwiseMin(Vec, Vec, Vec);
    342: PETSC_EXTERN PetscErrorCode VecPointwiseMult(Vec, Vec, Vec);
    343: PETSC_EXTERN PetscErrorCode VecPointwiseDivide(Vec, Vec, Vec);
    344: PETSC_EXTERN PetscErrorCode VecPointwiseSign(Vec, Vec, VecSignMode);
    345: PETSC_EXTERN PetscErrorCode VecMaxPointwiseDivide(Vec, Vec, PetscReal *);
    346: PETSC_EXTERN PetscErrorCode VecShift(Vec, PetscScalar);
    347: PETSC_EXTERN PetscErrorCode VecReciprocal(Vec);
    348: PETSC_EXTERN PetscErrorCode VecPermute(Vec, IS, PetscBool);
    349: PETSC_EXTERN PetscErrorCode VecSqrtAbs(Vec);
    350: PETSC_EXTERN PetscErrorCode VecLog(Vec);
    351: PETSC_EXTERN PetscErrorCode VecExp(Vec);
    352: PETSC_EXTERN PetscErrorCode VecAbs(Vec);
    353: PETSC_EXTERN PetscErrorCode VecDuplicate(Vec, Vec *);
    354: PETSC_EXTERN PetscErrorCode VecDuplicateVecs(Vec, PetscInt, Vec *[]);
    355: PETSC_EXTERN PetscErrorCode VecDestroyVecs(PetscInt, Vec *[]);
    356: PETSC_EXTERN PetscErrorCode VecStrideNormAll(Vec, NormType, PetscReal[]);
    357: PETSC_EXTERN PetscErrorCode VecStrideMaxAll(Vec, PetscInt[], PetscReal[]);
    358: PETSC_EXTERN PetscErrorCode VecStrideMinAll(Vec, PetscInt[], PetscReal[]);
    359: PETSC_EXTERN PetscErrorCode VecStrideScaleAll(Vec, const PetscScalar[]);
    360: PETSC_EXTERN PetscErrorCode VecStrideSumAll(Vec, PetscScalar *);
    361: PETSC_EXTERN PetscErrorCode VecUniqueEntries(Vec, PetscInt *, PetscScalar *[]);

    363: PETSC_EXTERN PetscErrorCode VecStrideNorm(Vec, PetscInt, NormType, PetscReal *);
    364: PETSC_EXTERN PetscErrorCode VecStrideMax(Vec, PetscInt, PetscInt *, PetscReal *);
    365: PETSC_EXTERN PetscErrorCode VecStrideMin(Vec, PetscInt, PetscInt *, PetscReal *);
    366: PETSC_EXTERN PetscErrorCode VecStrideScale(Vec, PetscInt, PetscScalar);
    367: PETSC_EXTERN PetscErrorCode VecStrideSum(Vec, PetscInt, PetscScalar *);
    368: PETSC_EXTERN PetscErrorCode VecStrideSet(Vec, PetscInt, PetscScalar);

    370: PETSC_EXTERN PetscErrorCode VecStrideGather(Vec, PetscInt, Vec, InsertMode);
    371: PETSC_EXTERN PetscErrorCode VecStrideScatter(Vec, PetscInt, Vec, InsertMode);
    372: PETSC_EXTERN PetscErrorCode VecStrideGatherAll(Vec, Vec[], InsertMode);
    373: PETSC_EXTERN PetscErrorCode VecStrideScatterAll(Vec[], Vec, InsertMode);

    375: PETSC_EXTERN PetscErrorCode VecStrideSubSetScatter(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);
    376: PETSC_EXTERN PetscErrorCode VecStrideSubSetGather(Vec, PetscInt, const PetscInt[], const PetscInt[], Vec, InsertMode);

    378: PETSC_EXTERN PetscErrorCode VecSetValues(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);
    379: PETSC_EXTERN PetscErrorCode VecGetValues(Vec, PetscInt, const PetscInt[], PetscScalar[]);
    380: PETSC_EXTERN PetscErrorCode VecAssemblyBegin(Vec);
    381: PETSC_EXTERN PetscErrorCode VecAssemblyEnd(Vec);
    382: PETSC_EXTERN PetscErrorCode VecStashSetInitialSize(Vec, PetscInt, PetscInt);
    383: PETSC_EXTERN PetscErrorCode VecStashView(Vec, PetscViewer);
    384: PETSC_EXTERN PetscErrorCode VecStashViewFromOptions(Vec, PetscObject, const char[]);
    385: PETSC_EXTERN PetscErrorCode VecStashGetInfo(Vec, PetscInt *, PetscInt *, PetscInt *, PetscInt *);

    387: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOO(Vec, PetscCount, const PetscInt[]);
    388: PETSC_EXTERN PetscErrorCode VecSetPreallocationCOOLocal(Vec, PetscCount, PetscInt[]);
    389: PETSC_EXTERN PetscErrorCode VecSetValuesCOO(Vec, const PetscScalar[], InsertMode);

    391: /*@C
    392:    VecSetValue - Set a single entry into a PETSc vector, `Vec`.

    394:    Not Collective

    396:    Input Parameters:
    397: +  v     - the vector
    398: .  row   - the row location of the entry
    399: .  value - the value to insert
    400: -  mode  - either `INSERT_VALUES` or `ADD_VALUES`

    402:    Level: beginner

    404:    Notes:
    405:    For efficiency one should use `VecSetValues()` and set several or
    406:    many values simultaneously if possible.

    408:    These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
    409:    MUST be called after all calls to `VecSetValue()` have been completed.

    411:    `VecSetValue()` uses 0-based indices in Python, C, and Fortran

    413: .seealso: [](ch_vectors), `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValueLocal()`
    414: @*/
    415: static inline PetscErrorCode VecSetValue(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
    416: {
    417:   return VecSetValues(v, 1, &i, &va, mode);
    418: }

    420: PETSC_EXTERN PetscErrorCode VecSetBlockSize(Vec, PetscInt);
    421: PETSC_EXTERN PetscErrorCode VecGetBlockSize(Vec, PetscInt *);
    422: PETSC_EXTERN PetscErrorCode VecSetValuesBlocked(Vec, PetscInt, const PetscInt[], const PetscScalar[], InsertMode);

    424: /* Dynamic creation and loading functions */
    425: PETSC_EXTERN PetscFunctionList VecList;
    426: PETSC_EXTERN PetscErrorCode    VecSetType(Vec, VecType);
    427: PETSC_EXTERN PetscErrorCode    VecGetType(Vec, VecType *);
    428: PETSC_EXTERN PetscErrorCode    VecRegister(const char[], PetscErrorCode (*)(Vec));
    429: PETSC_EXTERN PetscErrorCode    VecRegisterAll(void);

    431: PETSC_EXTERN PetscErrorCode VecScatterBegin(VecScatter, Vec, Vec, InsertMode, ScatterMode);
    432: PETSC_EXTERN PetscErrorCode VecScatterEnd(VecScatter, Vec, Vec, InsertMode, ScatterMode);
    433: PETSC_EXTERN PetscErrorCode VecScatterDestroy(VecScatter *);
    434: PETSC_EXTERN PetscErrorCode VecScatterSetUp(VecScatter);
    435: PETSC_EXTERN PetscErrorCode VecScatterCopy(VecScatter, VecScatter *);
    436: PETSC_EXTERN PetscErrorCode VecScatterView(VecScatter, PetscViewer);
    437: PETSC_EXTERN PetscErrorCode VecScatterViewFromOptions(VecScatter, PetscObject, const char[]);
    438: PETSC_EXTERN PetscErrorCode VecScatterRemap(VecScatter, PetscInt[], PetscInt[]);
    439: PETSC_EXTERN PetscErrorCode VecScatterGetMerged(VecScatter, PetscBool *);

    441: PETSC_EXTERN PetscErrorCode VecGetArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    442: PETSC_EXTERN PetscErrorCode VecRestoreArray4d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    443: PETSC_EXTERN PetscErrorCode VecGetArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
    444: PETSC_EXTERN PetscErrorCode VecRestoreArray3d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
    445: PETSC_EXTERN PetscErrorCode VecGetArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
    446: PETSC_EXTERN PetscErrorCode VecRestoreArray2d(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
    447: PETSC_EXTERN PetscErrorCode VecGetArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);
    448: PETSC_EXTERN PetscErrorCode VecRestoreArray1d(Vec, PetscInt, PetscInt, PetscScalar *[]);

    450: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    451: PETSC_EXTERN PetscErrorCode VecGetArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    452: PETSC_EXTERN PetscErrorCode VecRestoreArray4dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    453: PETSC_EXTERN PetscErrorCode VecGetArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
    454: PETSC_EXTERN PetscErrorCode VecRestoreArray3dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
    455: PETSC_EXTERN PetscErrorCode VecGetArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
    456: PETSC_EXTERN PetscErrorCode VecRestoreArray2dWrite(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
    457: PETSC_EXTERN PetscErrorCode VecGetArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);
    458: PETSC_EXTERN PetscErrorCode VecRestoreArray1dWrite(Vec, PetscInt, PetscInt, PetscScalar *[]);

    460: PETSC_EXTERN PetscErrorCode VecGetArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    461: PETSC_EXTERN PetscErrorCode VecRestoreArray4dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ****[]);
    462: PETSC_EXTERN PetscErrorCode VecGetArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
    463: PETSC_EXTERN PetscErrorCode VecRestoreArray3dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar ***[]);
    464: PETSC_EXTERN PetscErrorCode VecGetArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
    465: PETSC_EXTERN PetscErrorCode VecRestoreArray2dRead(Vec, PetscInt, PetscInt, PetscInt, PetscInt, PetscScalar **[]);
    466: PETSC_EXTERN PetscErrorCode VecGetArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);
    467: PETSC_EXTERN PetscErrorCode VecRestoreArray1dRead(Vec, PetscInt, PetscInt, PetscScalar *[]);

    469: PETSC_EXTERN PetscErrorCode VecPlaceArray(Vec, const PetscScalar[]);
    470: PETSC_EXTERN PetscErrorCode VecResetArray(Vec);
    471: PETSC_EXTERN PetscErrorCode VecReplaceArray(Vec, const PetscScalar[]);

    473: PETSC_EXTERN PetscErrorCode VecGetArrays(const Vec[], PetscInt, PetscScalar **[]);
    474: PETSC_EXTERN PetscErrorCode VecRestoreArrays(const Vec[], PetscInt, PetscScalar **[]);

    476: PETSC_EXTERN PetscErrorCode VecView(Vec, PetscViewer);
    477: PETSC_EXTERN PetscErrorCode VecViewNative(Vec, PetscViewer);
    478: PETSC_EXTERN PetscErrorCode VecEqual(Vec, Vec, PetscBool *);
    479: PETSC_EXTERN PetscErrorCode VecLoad(Vec, PetscViewer);

    481: PETSC_EXTERN PetscErrorCode VecGetSize(Vec, PetscInt *);
    482: PETSC_EXTERN PetscErrorCode VecGetLocalSize(Vec, PetscInt *);
    483: PETSC_EXTERN PetscErrorCode VecGetOwnershipRange(Vec, PetscInt *, PetscInt *);
    484: PETSC_EXTERN PetscErrorCode VecGetOwnershipRanges(Vec, const PetscInt *[]);

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

    489: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLContext(Vec, PETSC_UINTPTR_T *);
    490: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLQueue(Vec, PETSC_UINTPTR_T *);
    491: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemRead(Vec, PETSC_UINTPTR_T *);
    492: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMemWrite(Vec, PETSC_UINTPTR_T *);
    493: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMemWrite(Vec);
    494: PETSC_EXTERN PetscErrorCode VecViennaCLGetCLMem(Vec, PETSC_UINTPTR_T *);
    495: PETSC_EXTERN PetscErrorCode VecViennaCLRestoreCLMem(Vec);

    497: /*@C
    498:    VecSetValueLocal - Set a single entry into a vector using the local numbering of the vector, see `VecSetValuesLocal()`

    500:    Not Collective

    502:    Input Parameters:
    503: +  v     - the vector
    504: .  row   - the local row location of the entry
    505: .  value - the value to insert
    506: -  mode  - either `INSERT_VALUES` or `ADD_VALUES`

    508:    Level: beginner

    510:    Notes:
    511:    For efficiency one should use `VecSetValuesLocal()` and set several or
    512:    many values simultaneously if possible.

    514:    These values may be cached, so `VecAssemblyBegin()` and `VecAssemblyEnd()`
    515:    MUST be called after all calls to `VecSetValueLocal()` have been completed.

    517:    See `VecSetLocalToGlobalMapping()` for how the local numbering is defined

    519:    `VecSetValueLocal()` uses 0-based indices in Fortran as well as in C.

    521: .seealso: [](ch_vectors), `VecSetValuesLocal()`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `VecSetValuesBlockedLocal()`, `VecSetValue()`,
    522:           `VecSetLocalToGlobalMapping()`
    523: @*/
    524: static inline PetscErrorCode VecSetValueLocal(Vec v, PetscInt i, PetscScalar va, InsertMode mode)
    525: {
    526:   return VecSetValuesLocal(v, 1, &i, &va, mode);
    527: }

    529: /*MC
    530:    VecCheckAssembled - checks if values have been changed in the vector, by `VecSetValues()` or related routines,  but it has not been assembled

    532:    Synopsis:
    533: #include <petscvec.h>
    534:    VecCheckAssembled(Vec v);

    536:    Not Collective

    538:    Input Parameter:
    539: .  v - the vector to check

    541:    Level: developer

    543:    Note:
    544:    After calls to `VecSetValues()` and related routines one must call `VecAssemblyBegin()` and `VecAssemblyEnd()` before using the vector

    546: .seealso: [](ch_vectors), `Vec`, `VecSetValues()`, `VecAssemblyBegin()`, `VecAssemblyEnd()`, `MatAssemblyBegin()`, `MatAssemblyEnd()`
    547: M*/
    548: #define VecCheckAssembled(v) PetscCheck(v->stash.insertmode == NOT_SET_VALUES, PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Not for unassembled vector, did you call VecAssemblyBegin()/VecAssemblyEnd()?")

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

    553: PETSC_EXTERN PetscErrorCode VecDotBegin(Vec, Vec, PetscScalar *);
    554: PETSC_EXTERN PetscErrorCode VecDotEnd(Vec, Vec, PetscScalar *);
    555: PETSC_EXTERN PetscErrorCode VecTDotBegin(Vec, Vec, PetscScalar *);
    556: PETSC_EXTERN PetscErrorCode VecTDotEnd(Vec, Vec, PetscScalar *);
    557: PETSC_EXTERN PetscErrorCode VecNormBegin(Vec, NormType, PetscReal *);
    558: PETSC_EXTERN PetscErrorCode VecNormEnd(Vec, NormType, PetscReal *);
    559: PETSC_EXTERN PetscErrorCode VecErrorWeightedNorms(Vec, Vec, Vec, NormType, PetscReal, Vec, PetscReal, Vec, PetscReal, PetscReal *, PetscInt *, PetscReal *, PetscInt *, PetscReal *, PetscInt *);

    561: PETSC_EXTERN PetscErrorCode VecMDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
    562: PETSC_EXTERN PetscErrorCode VecMDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
    563: PETSC_EXTERN PetscErrorCode VecMTDotBegin(Vec, PetscInt, const Vec[], PetscScalar[]);
    564: PETSC_EXTERN PetscErrorCode VecMTDotEnd(Vec, PetscInt, const Vec[], PetscScalar[]);
    565: PETSC_EXTERN PetscErrorCode PetscCommSplitReductionBegin(MPI_Comm);

    567: PETSC_EXTERN PetscErrorCode VecBindToCPU(Vec, PetscBool);
    568: PETSC_DEPRECATED_FUNCTION(3, 13, 0, "VecBindToCPU()", ) static inline PetscErrorCode VecPinToCPU(Vec v, PetscBool flg)
    569: {
    570:   return VecBindToCPU(v, flg);
    571: }
    572: PETSC_EXTERN PetscErrorCode VecBoundToCPU(Vec, PetscBool *);
    573: PETSC_EXTERN PetscErrorCode VecSetBindingPropagates(Vec, PetscBool);
    574: PETSC_EXTERN PetscErrorCode VecGetBindingPropagates(Vec, PetscBool *);
    575: PETSC_EXTERN PetscErrorCode VecSetPinnedMemoryMin(Vec, size_t);
    576: PETSC_EXTERN PetscErrorCode VecGetPinnedMemoryMin(Vec, size_t *);

    578: PETSC_EXTERN PetscErrorCode VecGetOffloadMask(Vec, PetscOffloadMask *);

    580: typedef enum {
    581:   VEC_IGNORE_OFF_PROC_ENTRIES,
    582:   VEC_IGNORE_NEGATIVE_INDICES,
    583:   VEC_SUBSET_OFF_PROC_ENTRIES
    584: } VecOption;
    585: PETSC_EXTERN PetscErrorCode VecSetOption(Vec, VecOption, PetscBool);

    587: PETSC_EXTERN PetscErrorCode VecGetArray(Vec, PetscScalar *[]);
    588: PETSC_EXTERN PetscErrorCode VecGetArrayWrite(Vec, PetscScalar *[]);
    589: PETSC_EXTERN PetscErrorCode VecGetArrayRead(Vec, const PetscScalar *[]);
    590: PETSC_EXTERN PetscErrorCode VecRestoreArray(Vec, PetscScalar *[]);
    591: PETSC_EXTERN PetscErrorCode VecRestoreArrayWrite(Vec, PetscScalar *[]);
    592: PETSC_EXTERN PetscErrorCode VecRestoreArrayRead(Vec, const PetscScalar *[]);
    593: PETSC_EXTERN PetscErrorCode VecCreateLocalVector(Vec, Vec *);
    594: PETSC_EXTERN PetscErrorCode VecGetLocalVector(Vec, Vec);
    595: PETSC_EXTERN PetscErrorCode VecRestoreLocalVector(Vec, Vec);
    596: PETSC_EXTERN PetscErrorCode VecGetLocalVectorRead(Vec, Vec);
    597: PETSC_EXTERN PetscErrorCode VecRestoreLocalVectorRead(Vec, Vec);
    598: PETSC_EXTERN PetscErrorCode VecGetArrayAndMemType(Vec, PetscScalar *[], PetscMemType *);
    599: PETSC_EXTERN PetscErrorCode VecRestoreArrayAndMemType(Vec, PetscScalar *[]);
    600: PETSC_EXTERN PetscErrorCode VecGetArrayReadAndMemType(Vec, const PetscScalar *[], PetscMemType *);
    601: PETSC_EXTERN PetscErrorCode VecRestoreArrayReadAndMemType(Vec, const PetscScalar *[]);
    602: PETSC_EXTERN PetscErrorCode VecGetArrayWriteAndMemType(Vec, PetscScalar *[], PetscMemType *);
    603: PETSC_EXTERN PetscErrorCode VecRestoreArrayWriteAndMemType(Vec, PetscScalar *[]);

    605: /*@C
    606:    VecGetArrayPair - Accesses a pair of pointers for two vectors that may be common. When the vectors are not the same the first pointer is read only

    608:    Logically Collective; No Fortran Support

    610:    Input Parameters:
    611: +  x - the vector
    612: -  y - the second vector

    614:    Output Parameters:
    615: +  xv - location to put pointer to the first array
    616: -  yv - location to put pointer to the second array

    618:    Level: developer

    620: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecRestoreArrayPair()`
    621: @*/
    622: static inline PetscErrorCode VecGetArrayPair(Vec x, Vec y, PetscScalar *xv[], PetscScalar *yv[])
    623: {
    624:   PetscFunctionBegin;
    625:   PetscCall(VecGetArray(y, yv));
    626:   if (x == y) *xv = *yv;
    627:   else PetscCall(VecGetArrayRead(x, (const PetscScalar **)xv));
    628:   PetscFunctionReturn(PETSC_SUCCESS);
    629: }

    631: /*@C
    632:    VecRestoreArrayPair - Returns a pair of pointers for two vectors that may be common obtained with `VecGetArrayPair()`

    634:    Logically Collective; No Fortran Support

    636:    Input Parameters:
    637: +  x  - the vector
    638: .  y  - the second vector
    639: .  xv - location to put pointer to the first array
    640: -  yv - location to put pointer to the second array

    642:    Level: developer

    644: .seealso: [](ch_vectors), `VecGetArray()`, `VecGetArrayRead()`, `VecGetArrayPair()`
    645: @*/
    646: static inline PetscErrorCode VecRestoreArrayPair(Vec x, Vec y, PetscScalar *xv[], PetscScalar *yv[])
    647: {
    648:   PetscFunctionBegin;
    649:   PetscCall(VecRestoreArray(y, yv));
    650:   if (x != y) PetscCall(VecRestoreArrayRead(x, (const PetscScalar **)xv));
    651:   PetscFunctionReturn(PETSC_SUCCESS);
    652: }

    654: PETSC_EXTERN PetscErrorCode VecLockReadPush(Vec);
    655: PETSC_EXTERN PetscErrorCode VecLockReadPop(Vec);
    656: PETSC_EXTERN PetscErrorCode VecLockWriteSet(Vec, PetscBool);
    657: PETSC_EXTERN PetscErrorCode VecLockGet(Vec, PetscInt *);
    658: PETSC_EXTERN PetscErrorCode VecLockGetLocation(Vec, const char *[], const char *[], int *);

    660: static inline PetscErrorCode VecSetErrorIfLocked(Vec x, PetscInt arg)
    661: {
    662:   PetscInt state;

    664:   PetscFunctionBegin;
    665:   PetscCall(VecLockGet(x, &state));
    666:   if (PetscUnlikely(state != 0)) {
    667:     const char *file, *func, *name;
    668:     int         line;

    670:     PetscCall(VecLockGetLocation(x, &file, &func, &line));
    671:     PetscCall(PetscObjectGetName((PetscObject)x, &name));
    672:     SETERRQ(PETSC_COMM_SELF, PETSC_ERR_ARG_WRONGSTATE, "Vector '%s' (argument #%" PetscInt_FMT ") was locked for %s access in %s() at %s:%d (line numbers only accurate to function begin)", name, arg, state > 0 ? "read-only" : "write-only", func ? func : "unknown_function", file ? file : "unknown file", line);
    673:   }
    674:   PetscFunctionReturn(PETSC_SUCCESS);
    675: }

    677: /* The three are deprecated */
    678: PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPush()", ) static inline PetscErrorCode VecLockPush(Vec v)
    679: {
    680:   return VecLockReadPush(v);
    681: }

    683: PETSC_DEPRECATED_FUNCTION(3, 11, 0, "VecLockReadPop()", ) static inline PetscErrorCode VecLockPop(Vec v)
    684: {
    685:   return VecLockReadPop(v);
    686: }

    688: #define VecLocked(x, arg) VecSetErrorIfLocked(x, arg) PETSC_DEPRECATED_MACRO(3, 11, 0, "VecSetErrorIfLocked()", )

    690: /*E
    691:   VecOperation - Enumeration of overide-able methods in the `Vec` implementation function-table.

    693:   Values:
    694: + `VECOP_DUPLICATE`  - `VecDuplicate()`
    695: . `VECOP_SET`        - `VecSet()`
    696: . `VECOP_VIEW`       - `VecView()`
    697: . `VECOP_LOAD`       - `VecLoad()`
    698: . `VECOP_VIEWNATIVE` - `VecViewNative()`
    699: - `VECOP_LOADNATIVE` - `VecLoadNative()`

    701:   Level: advanced

    703:   Notes:
    704:   Some operations may serve as the implementation for other routines not listed above. For
    705:   example `VECOP_SET` can be used to simultaneously overriding the implementation used in
    706:   `VecSet()`, `VecSetInf()`, and `VecZeroEntries()`.

    708:   Entries to `VecOperation` are added as needed so if you do not see the operation listed which
    709:   you'd like to replace, please send mail to `petsc-maint@mcs.anl.gov`!

    711: .seealso: [](ch_vectors), `Vec`, `VecSetOperation()`
    712: E*/
    713: typedef enum {
    714:   VECOP_DUPLICATE  = 0,
    715:   VECOP_SET        = 10,
    716:   VECOP_VIEW       = 33,
    717:   VECOP_LOAD       = 41,
    718:   VECOP_VIEWNATIVE = 68,
    719:   VECOP_LOADNATIVE = 69
    720: } VecOperation;
    721: PETSC_EXTERN PetscErrorCode VecSetOperation(Vec, VecOperation, PetscErrorCodeFn *);

    723: /*
    724:      Routines for dealing with ghosted vectors:
    725:   vectors with ghost elements at the end of the array.
    726: */
    727: PETSC_EXTERN PetscErrorCode VecMPISetGhost(Vec, PetscInt, const PetscInt[]);
    728: PETSC_EXTERN PetscErrorCode VecCreateGhost(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
    729: PETSC_EXTERN PetscErrorCode VecCreateGhostWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
    730: PETSC_EXTERN PetscErrorCode VecCreateGhostBlock(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], Vec *);
    731: PETSC_EXTERN PetscErrorCode VecCreateGhostBlockWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, PetscInt, const PetscInt[], const PetscScalar[], Vec *);
    732: PETSC_EXTERN PetscErrorCode VecGhostGetGhostIS(Vec, IS *);
    733: PETSC_EXTERN PetscErrorCode VecGhostGetLocalForm(Vec, Vec *);
    734: PETSC_EXTERN PetscErrorCode VecGhostRestoreLocalForm(Vec, Vec *);
    735: PETSC_EXTERN PetscErrorCode VecGhostIsLocalForm(Vec, Vec, PetscBool *);
    736: PETSC_EXTERN PetscErrorCode VecGhostUpdateBegin(Vec, InsertMode, ScatterMode);
    737: PETSC_EXTERN PetscErrorCode VecGhostUpdateEnd(Vec, InsertMode, ScatterMode);

    739: PETSC_EXTERN PetscErrorCode VecConjugate(Vec);
    740: PETSC_EXTERN PetscErrorCode VecImaginaryPart(Vec);
    741: PETSC_EXTERN PetscErrorCode VecRealPart(Vec);

    743: PETSC_EXTERN PetscErrorCode VecScatterCreateToAll(Vec, VecScatter *, Vec *);
    744: PETSC_EXTERN PetscErrorCode VecScatterCreateToZero(Vec, VecScatter *, Vec *);

    746: /* These vector calls were included from TAO. They miss vtable entries and GPU implementation */
    747: PETSC_EXTERN PetscErrorCode ISComplementVec(IS, Vec, IS *);
    748: PETSC_EXTERN PetscErrorCode VecPow(Vec, PetscScalar);
    749: PETSC_EXTERN PetscErrorCode VecMedian(Vec, Vec, Vec, Vec);
    750: PETSC_EXTERN PetscErrorCode VecWhichInactive(Vec, Vec, Vec, Vec, PetscBool, IS *);
    751: PETSC_EXTERN PetscErrorCode VecWhichBetween(Vec, Vec, Vec, IS *);
    752: PETSC_EXTERN PetscErrorCode VecWhichBetweenOrEqual(Vec, Vec, Vec, IS *);
    753: PETSC_EXTERN PetscErrorCode VecWhichGreaterThan(Vec, Vec, IS *);
    754: PETSC_EXTERN PetscErrorCode VecWhichLessThan(Vec, Vec, IS *);
    755: PETSC_EXTERN PetscErrorCode VecWhichEqual(Vec, Vec, IS *);
    756: PETSC_EXTERN PetscErrorCode VecISAXPY(Vec, IS, PetscScalar, Vec);
    757: PETSC_EXTERN PetscErrorCode VecISCopy(Vec, IS, ScatterMode, Vec);
    758: PETSC_EXTERN PetscErrorCode VecISSet(Vec, IS, PetscScalar);
    759: PETSC_EXTERN PetscErrorCode VecISShift(Vec, IS, PetscScalar);
    760: PETSC_EXTERN PetscErrorCode VecBoundGradientProjection(Vec, Vec, Vec, Vec, Vec);
    761: PETSC_EXTERN PetscErrorCode VecStepBoundInfo(Vec, Vec, Vec, Vec, PetscReal *, PetscReal *, PetscReal *);
    762: PETSC_EXTERN PetscErrorCode VecStepMax(Vec, Vec, PetscReal *);
    763: PETSC_EXTERN PetscErrorCode VecStepMaxBounded(Vec, Vec, Vec, Vec, PetscReal *);

    765: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);
    766: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaPutVector(PetscViewer, Vec);

    768: /*S
    769:    Vecs - Collection of vectors where the data for the vectors is stored in
    770:           one contiguous memory

    772:    Level: advanced

    774:    Notes:
    775:    Temporary construct for handling multiply right-hand side solves

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

    780: S*/
    781: struct _n_Vecs {
    782:   PetscInt n;
    783:   Vec      v;
    784: };
    785: typedef struct _n_Vecs     *Vecs;
    786: PETSC_EXTERN PetscErrorCode VecsDestroy(Vecs);
    787: PETSC_EXTERN PetscErrorCode VecsCreateSeq(MPI_Comm, PetscInt, PetscInt, Vecs *);
    788: PETSC_EXTERN PetscErrorCode VecsCreateSeqWithArray(MPI_Comm, PetscInt, PetscInt, PetscScalar *, Vecs *);
    789: PETSC_EXTERN PetscErrorCode VecsDuplicate(Vecs, Vecs *);

    791: #if PetscDefined(HAVE_VIENNACL)
    792: typedef struct _p_PetscViennaCLIndices *PetscViennaCLIndices;
    793: PETSC_EXTERN PetscErrorCode             VecViennaCLCopyToGPUSome_Public(Vec, PetscViennaCLIndices);
    794: PETSC_EXTERN PetscErrorCode             VecViennaCLCopyFromGPUSome_Public(Vec, PetscViennaCLIndices);
    795: PETSC_EXTERN PetscErrorCode             VecCreateSeqViennaCL(MPI_Comm, PetscInt, Vec *);
    796: PETSC_EXTERN PetscErrorCode             VecCreateMPIViennaCL(MPI_Comm, PetscInt, PetscInt, Vec *);
    797: #endif
    798: #if PetscDefined(HAVE_CUDA) || PetscDefined(HAVE_HIP)
    799: PETSC_EXTERN PetscErrorCode VecScatterInitializeForGPU(VecScatter, Vec);
    800: PETSC_EXTERN PetscErrorCode VecScatterFinalizeForGPU(VecScatter);
    801: #endif
    802: #if PetscDefined(HAVE_KOKKOS_KERNELS)
    803: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkos(MPI_Comm, PetscInt, Vec *);
    804: PETSC_EXTERN PetscErrorCode VecCreateSeqKokkosWithArray(MPI_Comm, PetscInt, PetscInt, const PetscScalar *, Vec *);
    805: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkos(MPI_Comm, PetscInt, PetscInt, Vec *);
    806: PETSC_EXTERN PetscErrorCode VecCreateMPIKokkosWithArray(MPI_Comm, PetscInt, PetscInt, PetscInt, const PetscScalar *, Vec *);
    807: PETSC_EXTERN PetscErrorCode VecKokkosPlaceArray(Vec, PetscScalar *);
    808: PETSC_EXTERN PetscErrorCode VecKokkosResetArray(Vec);
    809: #endif

    811: PETSC_EXTERN PetscErrorCode VecNestGetSubVecs(Vec, PetscInt *, Vec *[]);
    812: PETSC_EXTERN PetscErrorCode VecNestGetSubVecsRead(Vec, PetscInt *, Vec *[]);
    813: PETSC_EXTERN PetscErrorCode VecNestRestoreSubVecsRead(Vec, PetscInt *, Vec *[]);
    814: PETSC_EXTERN PetscErrorCode VecNestGetSubVec(Vec, PetscInt, Vec *);
    815: PETSC_EXTERN PetscErrorCode VecNestSetSubVecs(Vec, PetscInt, PetscInt *, Vec *);
    816: PETSC_EXTERN PetscErrorCode VecNestSetSubVec(Vec, PetscInt, Vec);
    817: PETSC_EXTERN PetscErrorCode VecCreateNest(MPI_Comm, PetscInt, IS *, Vec *, Vec *);
    818: PETSC_EXTERN PetscErrorCode VecNestGetSize(Vec, PetscInt *);

    820: PETSC_EXTERN PetscErrorCode PetscOptionsGetVec(PetscOptions, const char[], const char[], Vec, PetscBool *);
    821: PETSC_EXTERN PetscErrorCode VecFilter(Vec, PetscReal);
    822: PETSC_DEPRECATED_FUNCTION(3, 20, 0, "VecFilter()", ) static inline PetscErrorCode VecChop(Vec v, PetscReal tol)
    823: {
    824:   return VecFilter(v, tol);
    825: }

    827: PETSC_EXTERN PetscErrorCode VecGetLayout(Vec, PetscLayout *);
    828: PETSC_EXTERN PetscErrorCode VecSetLayout(Vec, PetscLayout);

    830: PETSC_EXTERN PetscErrorCode PetscSectionVecView(PetscSection, Vec, PetscViewer);
    831: PETSC_EXTERN PetscErrorCode VecGetValuesSection(Vec, PetscSection, PetscInt, PetscScalar *[]);
    832: PETSC_EXTERN PetscErrorCode VecSetValuesSection(Vec, PetscSection, PetscInt, const PetscScalar[], InsertMode);
    833: PETSC_EXTERN PetscErrorCode PetscSectionVecNorm(PetscSection, PetscSection, Vec, NormType, PetscReal[]);

    835: /*S
    836:   VecTagger - Object used to manage the tagging of a subset of indices based on the values of a vector.  The
    837:               motivating application is the selection of cells for refinement or coarsening based on vector containing
    838:               the values in an error indicator metric.

    840:   Values:
    841: +  `VECTAGGERABSOLUTE` - "absolute" values are in a interval (box for complex values) of explicitly defined values
    842: .  `VECTAGGERRELATIVE` - "relative" values are in a interval (box for complex values) of values relative to the set of all values in the vector
    843: .  `VECTAGGERCDF`      - "cdf" values are in a relative range of the *cumulative distribution* of values in the vector
    844: .  `VECTAGGEROR`       - "or" values are in the union of other tags
    845: -  `VECTAGGERAND`      - "and" values are in the intersection of other tags

    847:   Level: advanced

    849:   Developer Note:
    850:   Why not use a `DMLabel` or similar object

    852: .seealso: [](ch_vectors), `Vec`, `VecTaggerType`, `VecTaggerCreate()`
    853: S*/
    854: typedef struct _p_VecTagger *VecTagger;

    856: /*J
    857:   VecTaggerType - String with the name of a `VecTagger` type

    859:   Level: advanced

    861: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerCreate()`
    862: J*/
    863: typedef const char *VecTaggerType;
    864: #define VECTAGGERABSOLUTE "absolute"
    865: #define VECTAGGERRELATIVE "relative"
    866: #define VECTAGGERCDF      "cdf"
    867: #define VECTAGGEROR       "or"
    868: #define VECTAGGERAND      "and"

    870: PETSC_EXTERN PetscClassId      VEC_TAGGER_CLASSID;
    871: PETSC_EXTERN PetscFunctionList VecTaggerList;
    872: PETSC_EXTERN PetscErrorCode    VecTaggerRegister(const char[], PetscErrorCode (*)(VecTagger));
    873: PETSC_EXTERN PetscErrorCode    VecTaggerRegisterAll(void);

    875: PETSC_EXTERN PetscErrorCode VecTaggerCreate(MPI_Comm, VecTagger *);
    876: PETSC_EXTERN PetscErrorCode VecTaggerSetBlockSize(VecTagger, PetscInt);
    877: PETSC_EXTERN PetscErrorCode VecTaggerGetBlockSize(VecTagger, PetscInt *);
    878: PETSC_EXTERN PetscErrorCode VecTaggerSetType(VecTagger, VecTaggerType);
    879: PETSC_EXTERN PetscErrorCode VecTaggerGetType(VecTagger, VecTaggerType *);
    880: PETSC_EXTERN PetscErrorCode VecTaggerSetInvert(VecTagger, PetscBool);
    881: PETSC_EXTERN PetscErrorCode VecTaggerGetInvert(VecTagger, PetscBool *);
    882: PETSC_EXTERN PetscErrorCode VecTaggerSetFromOptions(VecTagger);
    883: PETSC_EXTERN PetscErrorCode VecTaggerSetUp(VecTagger);
    884: PETSC_EXTERN PetscErrorCode VecTaggerView(VecTagger, PetscViewer);
    885: PETSC_EXTERN PetscErrorCode VecTaggerComputeIS(VecTagger, Vec, IS *, PetscBool *);
    886: PETSC_EXTERN PetscErrorCode VecTaggerDestroy(VecTagger *);

    888: /*S
    889:    VecTaggerBox - A interval (box for complex numbers) range used to tag values.  For real scalars, this is just a closed interval; for complex scalars,
    890:    the box is the closed region in the complex plane such that real(min) <= real(z) <= real(max) and imag(min) <= imag(z) <= imag(max).  `INF` is an acceptable endpoint.

    892:    Level: beginner

    894: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerComputeIntervals()`
    895: S*/
    896: typedef struct {
    897:   PetscScalar min;
    898:   PetscScalar max;
    899: } VecTaggerBox;
    900: PETSC_EXTERN PetscErrorCode VecTaggerComputeBoxes(VecTagger, Vec, PetscInt *, VecTaggerBox *[], PetscBool *);

    902: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteSetBox(VecTagger, VecTaggerBox *);
    903: PETSC_EXTERN PetscErrorCode VecTaggerAbsoluteGetBox(VecTagger, const VecTaggerBox *[]);

    905: PETSC_EXTERN PetscErrorCode VecTaggerRelativeSetBox(VecTagger, VecTaggerBox *);
    906: PETSC_EXTERN PetscErrorCode VecTaggerRelativeGetBox(VecTagger, const VecTaggerBox *[]);

    908: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetBox(VecTagger, VecTaggerBox *);
    909: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetBox(VecTagger, const VecTaggerBox *[]);

    911: /*E
    912:   VecTaggerCDFMethod - Determines what method is used to compute absolute values from cumulative distribution values (e.g., what value is the preimage of .95 in the cdf).

    914:    Values:
    915: +  `VECTAGGER_CDF_GATHER`    - gather the data to MPI rank 0, perform the computation and broadcast the result
    916: -  `VECTAGGER_CDF_ITERATIVE` - compute the results on all ranks iteratively using `MPI_Allreduce()`

    918:   Level: advanced

    920:   Note:
    921:   Relevant only in parallel: in serial it is directly computed.

    923:   Developer Note:
    924:   In PETSc enums of this type are refered to with the term type, not method.

    926: .seealso: [](ch_vectors), `Vec`, `VecTagger`, `VecTaggerType`, `VecTaggerCreate()`, `VecTaggerCDFSetMethod()`
    927: E*/
    928: typedef enum {
    929:   VECTAGGER_CDF_GATHER,
    930:   VECTAGGER_CDF_ITERATIVE,
    931:   VECTAGGER_CDF_NUM_METHODS
    932: } VecTaggerCDFMethod;
    933: PETSC_EXTERN const char *const VecTaggerCDFMethods[];

    935: PETSC_EXTERN PetscErrorCode VecTaggerCDFSetMethod(VecTagger, VecTaggerCDFMethod);
    936: PETSC_EXTERN PetscErrorCode VecTaggerCDFGetMethod(VecTagger, VecTaggerCDFMethod *);
    937: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeSetTolerances(VecTagger, PetscInt, PetscReal, PetscReal);
    938: PETSC_EXTERN PetscErrorCode VecTaggerCDFIterativeGetTolerances(VecTagger, PetscInt *, PetscReal *, PetscReal *);

    940: PETSC_EXTERN PetscErrorCode VecTaggerOrSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
    941: PETSC_EXTERN PetscErrorCode VecTaggerOrGetSubs(VecTagger, PetscInt *, VecTagger *[]);

    943: PETSC_EXTERN PetscErrorCode VecTaggerAndSetSubs(VecTagger, PetscInt, VecTagger *, PetscCopyMode);
    944: PETSC_EXTERN PetscErrorCode VecTaggerAndGetSubs(VecTagger, PetscInt *, VecTagger *[]);

    946: PETSC_EXTERN PetscErrorCode VecTaggerInitializePackage(void);
    947: PETSC_EXTERN PetscErrorCode VecTaggerFinalizePackage(void);

    949: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaSetVector(PetscViewer, Vec);
    950: PETSC_EXTERN PetscErrorCode PetscViewerMathematicaGetVector(PetscViewer, Vec);

    952: PETSC_EXTERN PetscErrorCode VecFischer(Vec, Vec, Vec, Vec, Vec);
    953: PETSC_EXTERN PetscErrorCode VecSFischer(Vec, Vec, Vec, Vec, PetscReal, Vec);

    955: #if PetscDefined(USE_DEBUG)
    956: /* This is an internal debug-only routine that should not be used by users */
    957: PETSC_SINGLE_LIBRARY_INTERN PetscErrorCode VecValidValues_Internal(Vec, PetscInt, PetscBool);
    958: #else
    959:   #define VecValidValues_Internal(...) PETSC_SUCCESS
    960: #endif /* PETSC_USE_DEBUG */

    962: #define VEC_CUPM_NOT_CONFIGURED(impl) SETERRQ(PETSC_COMM_SELF, PETSC_ERR_SUP_SYS, "Must configure PETSc with " PetscStringize(impl) " support to use %s", PETSC_FUNCTION_NAME)

    964: #if PetscDefined(HAVE_CUDA)
    965:   #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
    966: #else
    967:   #define VEC_CUDA_DECL_OR_STUB(__decl__, ...) \
    968:     static inline __decl__ \
    969:     { \
    970:       __VA_ARGS__; \
    971:       VEC_CUPM_NOT_CONFIGURED(cuda); \
    972:     }
    973: #endif /* PETSC_HAVE_CUDA */

    975: /* extra underscore here to make it line up with the cuda versions */
    976: #if PetscDefined(HAVE_HIP)
    977:   #define VEC_HIP__DECL_OR_STUB(__decl__, ...) PETSC_EXTERN __decl__;
    978: #else
    979:   #define VEC_HIP__DECL_OR_STUB(__decl__, ...) \
    980:     static inline __decl__ \
    981:     { \
    982:       __VA_ARGS__; \
    983:       VEC_CUPM_NOT_CONFIGURED(hip); \
    984:     }
    985: #endif /* PETSC_HAVE_HIP */

    987: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDA(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)
    988: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIP(MPI_Comm a, PetscInt b, Vec *c), (void)a, (void)b, (void)c)

    990: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDAWithArray(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, Vec *e), (void)a, (void)b, (void)c, (void)d, (void)e)
    991: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIPWithArray(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, Vec *e), (void)a, (void)b, (void)c, (void)d, (void)e)

    993: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateSeqCUDAWithArrays(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)
    994: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateSeqHIPWithArrays(MPI_Comm a, PetscInt b, PetscInt c, const PetscScalar *d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)

    996: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDA(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)
    997: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIP(MPI_Comm a, PetscInt b, PetscInt c, Vec *d), (void)a, (void)b, (void)c, (void)d)

    999: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDAWithArray(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)
    1000: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIPWithArray(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, Vec *f), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f)

    1002: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCreateMPICUDAWithArrays(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, const PetscScalar *f, Vec *g), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f, (void)g)
    1003: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecCreateMPIHIPWithArrays(MPI_Comm a, PetscInt b, PetscInt c, PetscInt d, const PetscScalar *e, const PetscScalar *f, Vec *g), (void)a, (void)b, (void)c, (void)d, (void)e, (void)f, (void)g)

    1005: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArray(Vec a, PetscScalar **b), (void)a, (void)b)
    1006: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArray(Vec a, PetscScalar **b), (void)a, (void)b)

    1008: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArray(Vec a, PetscScalar **b), (void)a, (void)b)
    1009: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArray(Vec a, PetscScalar **b), (void)a, (void)b)

    1011: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)
    1012: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)

    1014: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)
    1015: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayRead(Vec a, const PetscScalar **b), (void)a, (void)b)

    1017: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)
    1018: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPGetArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)

    1020: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDARestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)
    1021: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPRestoreArrayWrite(Vec a, PetscScalar **b), (void)a, (void)b)

    1023: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
    1024: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPPlaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)

    1026: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)
    1027: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPReplaceArray(Vec a, const PetscScalar b[]), (void)a, (void)b)

    1029: VEC_CUDA_DECL_OR_STUB(PetscErrorCode VecCUDAResetArray(Vec a), (void)a)
    1030: VEC_HIP__DECL_OR_STUB(PetscErrorCode VecHIPResetArray(Vec a), (void)a)

    1032: #undef VEC_CUPM_NOT_CONFIGURED
    1033: #undef VEC_CUDA_DECL_OR_STUB
    1034: #undef VEC_HIP__DECL_OR_STUB