PETSc version 3.16.6
Fix/Edit manual page

VecCreateSeqHIPWithArrays

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

Synopsis

#include <petscvec.h> 
PetscErrorCode  VecCreateSeqHIPWithArrays(MPI_Comm comm,PetscInt bs,PetscInt n,const PetscScalar cpuarray[],const PetscScalar gpuarray[],Vec *V)
Collective

Input Parameters

comm - the communicator, should be PETSC_COMM_SELF
bs - the block size
n - the vector length
cpuarray - CPU memory where the vector elements are to be stored.
gpuarray - GPU memory where the vector elements are to be stored.

Output Parameter

V - the vector

Notes

If both cpuarray and gpuarray are provided, the caller must ensure that the provided arrays have identical values.

PETSc does NOT free the provided arrays when the vector is destroyed via VecDestroy(). The user should not free the array until the vector is destroyed.

See Also

VecCreateMPIHIPWithArrays(), VecCreate(), VecCreateSeqWithArray(),
VecHIPPlaceArray(), VecCreateSeqHIPWithArray(), VecHIPAllocateCheckHost()

Level

intermediate

Location

src/vec/vec/impls/seq/seqhip/vechip.hip.cpp
Index of all Vec routines
Table of Contents for all manual pages
Index of all manual pages