VecCreateMPIWithArray#

Creates a parallel, array-style vector, where the user provides the array space to store the vector values.

Synopsis#

#include "petscvec.h"   
PetscErrorCode VecCreateMPIWithArray(MPI_Comm comm, PetscInt bs, PetscInt n, PetscInt N, const PetscScalar array[], Vec *vv)

Collective

Input Parameters#

  • comm - the MPI communicator to use

  • bs - block size, same meaning as VecSetBlockSize()

  • n - local vector length, cannot be PETSC_DECIDE

  • N - global vector length (or PETSC_DETERMINE to have calculated)

  • array - the user provided array to store the vector values

Output Parameter#

  • vv - the vector

Notes#

Use VecDuplicate() or VecDuplicateVecs() to form additional vectors of the same type as an existing vector.

If the user-provided array is NULL, then VecPlaceArray() can be used at a later stage to SET the array for storing the vector values.

PETSc does NOT free array when the vector is destroyed via VecDestroy().

The user should not free array until the vector is destroyed.

See Also#

Vectors and Parallel Data, Vec, VecType, VecCreateSeqWithArray(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateMPI(), VecCreateGhostWithArray(), VecPlaceArray()

Level#

intermediate

Location#

src/vec/vec/impls/mpi/pbvec.c

Examples#

src/dm/tutorials/ex22.c

Edit on GitLab

Index of all Vec routines
Table of Contents for all manual pages
Index of all manual pages