Vec - Low-level Interface

VecAXPBY(petsclib::PetscLibType,y::PetscVec, alpha::PetscScalar, beta::PetscScalar, x::PetscVec)

Computes y = alpha x + beta y.

Logically Collective

Input Parameters:

• alpha - first scalar
• beta - second scalar
• x - the first scaled vector
• y - the second scaled vector

Output Parameter:

• y - output vector

Level: intermediate

-seealso: , Vec, VecAYPX(), VecMAXPY(), VecWAXPY(), VecAXPY(), VecAXPBYPCZ()

External Links

• PETSc Manual: Vec/VecAXPBY

VecAXPBYPCZ(petsclib::PetscLibType,z::PetscVec, alpha::PetscScalar, beta::PetscScalar, gamma::PetscScalar, x::PetscVec, y::PetscVec)

Computes z = alpha x + beta y + gamma z

Logically Collective

Input Parameters:

• alpha - first scalar
• beta - second scalar
• gamma - third scalar
• x - first vector
• y - second vector
• z - third vector

Output Parameter:

• z - output vector

Level: intermediate

-seealso: , Vec, VecAYPX(), VecMAXPY(), VecWAXPY(), VecAXPY(), VecAXPBY()

External Links

• PETSc Manual: Vec/VecAXPBYPCZ

VecAXPY(petsclib::PetscLibType,y::PetscVec, alpha::PetscScalar, x::PetscVec)

Computes y = alpha x + y.

Logically Collective

Input Parameters:

• alpha - the scalar
• x - vector scale by alpha
• y - vector accumulated into

Output Parameter:

• y - output vector

Level: intermediate

-seealso: , Vec, VecAYPX(), VecMAXPY(), VecWAXPY(), VecAXPBYPCZ(), VecAXPBY()

External Links

• PETSc Manual: Vec/VecAXPY

VecAYPX(petsclib::PetscLibType,y::PetscVec, beta::PetscScalar, x::PetscVec)

Computes y = x + beta y.

Logically Collective

Input Parameters:

• beta - the scalar
• x - the unscaled vector
• y - the vector to be scaled

Output Parameter:

• y - output vector

Level: intermediate

-seealso: , Vec, VecMAXPY(), VecWAXPY(), VecAXPY(), VecAXPBYPCZ(), VecAXPBY()

External Links

• PETSc Manual: Vec/VecAYPX

VecAbs(petsclib::PetscLibType,v::PetscVec)

Replaces every element in a vector with its absolute value.

Logically Collective

Input Parameter:

• v - the vector

Level: intermediate

-seealso: Vec, VecExp(), VecSqrtAbs(), VecReciprocal(), VecLog()

External Links

• PETSc Manual: Vec/VecAbs

VecAppendOptionsPrefix(petsclib::PetscLibType,v::PetscVec, prefix::Vector{Cchar})

Appends to the prefix used for searching for all Vec options in the database.

Logically Collective

Input Parameters:

• v - the Vec context
• prefix - the prefix to prepend to all option names

Level: advanced

-seealso: , Vec, VecGetOptionsPrefix()

External Links

• PETSc Manual: Vec/VecAppendOptionsPrefix

VecAssemblyBegin(petsclib::PetscLibType,vec::PetscVec)

Begins assembling the vector; that is ensuring all the vector's entries are stored on the correct MPI process. This routine should be called after completing all calls to VecSetValues().

Collective

Input Parameter:

• vec - the vector

Level: beginner

-seealso: , Vec, VecAssemblyEnd(), VecSetValues()

External Links

• PETSc Manual: Vec/VecAssemblyBegin

VecAssemblyEnd(petsclib::PetscLibType,vec::PetscVec)

Completes assembling the vector. This routine should be called after VecAssemblyBegin().

Collective

Input Parameter:

• vec - the vector

Options Database Keys:

• -vec_view - Prints vector in PETSC_VIEWER_DEFAULT format
• -vec_view ::ascii_matlab - Prints vector in PETSC_VIEWER_ASCII_MATLAB format to stdout
• -vec_view matlab:filename - Prints vector in MATLAB .mat file to filename (requires PETSc configured with –with-matlab)
• -vec_view draw - Activates vector viewing using drawing tools
• -display <name> - Sets display name (default is host)
• -draw_pause <sec> - Sets number of seconds to pause after display
• -vec_view socket - Activates vector viewing using a socket

Level: beginner

-seealso: , Vec, VecAssemblyBegin(), VecSetValues()

External Links

• PETSc Manual: Vec/VecAssemblyEnd

VecBindToCPU(petsclib::PetscLibType,v::PetscVec, flg::PetscBool)

marks a vector to temporarily stay on the CPU and perform computations on the CPU

Logically collective

Input Parameters:

• v - the vector
• flg - bind to the CPU if value of PETSC_TRUE

Level: intermediate

-seealso: , Vec, VecBoundToCPU()

External Links

• PETSc Manual: Vec/VecBindToCPU

VecBoundGradientProjection(petsclib::PetscLibType,G::PetscVec, X::PetscVec, XL::PetscVec, XU::PetscVec, GP::PetscVec)

Projects vector according to this definition. If XL[i] < X[i] < XU[i], then GP[i] = G[i]; If X[i] <= XL[i], then GP[i] = min(G[i],0); If X[i] >= XU[i], then GP[i] = max(G[i],0);

Input Parameters:

• G - current gradient vector
• X - current solution vector with XL[i] <= X[i] <= XU[i]
• XL - lower bounds
• XU - upper bounds

Output Parameter:

• GP - gradient projection vector

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecBoundGradientProjection

flg::PetscBool = VecBoundToCPU(petsclib::PetscLibType,v::PetscVec)

query if a vector is bound to the CPU

Not collective

Input Parameter:

• v - the vector

Output Parameter:

• flg - the logical flag

Level: intermediate

-seealso: , Vec, VecBindToCPU()

External Links

• PETSc Manual: Vec/VecBoundToCPU

VecConcatenate(petsclib::PetscLibType,nx::PetscInt, X::Vector{PetscVec}, Y::PetscVec, x_is::Vector{IS})

Creates a new vector that is a vertical concatenation of all the given array of vectors in the order they appear in the array. The concatenated vector resides on the same communicator and is the same type as the source vectors.

Collective

Input Parameters:

• nx - number of vectors to be concatenated
• X - array containing the vectors to be concatenated in the order of concatenation

Output Parameters:

• Y - concatenated vector
• x_is - array of index sets corresponding to the concatenated components of Y (pass NULL if not needed)

Level: advanced

-seealso: , Vec, VECNEST, VECSCATTER, VecScatterCreate()

External Links

• PETSc Manual: Vec/VecConcatenate

VecConjugate(petsclib::PetscLibType,x::PetscVec)

Conjugates a vector. That is, replace every entry in a vector with its complex conjugate

Logically Collective

Input Parameter:

• x - the vector

Level: intermediate

-seealso: , Vec, VecSet()

External Links

• PETSc Manual: Vec/VecConjugate

VecCopy(petsclib::PetscLibType,x::PetscVec, y::PetscVec)

Copies a vector y = x

Logically Collective

Input Parameter:

• x - the vector

Output Parameter:

• y - the copy

Level: beginner

-seealso: , Vec, VecDuplicate()

External Links

• PETSc Manual: Vec/VecCopy

vec::PetscVec = VecCreate(petsclib::PetscLibType,comm::MPI_Comm)

Creates an empty vector object. The type can then be set with VecSetType(), or VecSetFromOptions().

Collective

Input Parameter:

• comm - The communicator for the vector object

Output Parameter:

• vec - The vector object

Level: beginner

-seealso: , Vec, VecSetType(), VecSetSizes(), VecCreateMPIWithArray(), VecCreateMPI(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateSeq(), VecPlaceArray()

External Links

• PETSc Manual: Vec/VecCreate

vec::PetscVec = VecCreateFromOptions(petsclib::PetscLibType,comm::MPI_Comm, prefix::Vector{Cchar}, bs::PetscInt, m::PetscInt, n::PetscInt)

Creates a vector whose type is set from the options database

Collective

Input Parameters:

• comm - The communicator for the vector object
• prefix - [optional] prefix for the options database
• bs - the block size (commonly 1)
• m - the local size (or PETSC_DECIDE)
• n - the global size (or PETSC_DETERMINE)

Output Parameter:

• vec - The vector object

Options Database Keys:

• -vec_type - see VecType, for example seq, mpi, cuda, defaults to mpi

Level: beginner

-seealso: , Vec, VecSetType(), VecSetSizes(), VecCreateMPIWithArray(), VecCreateMPI(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateSeq(), VecPlaceArray(), VecCreate(), VecType

External Links

• PETSc Manual: Vec/VecCreateFromOptions

vv::PetscVec = VecCreateGhost(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt, N::PetscInt, nghost::PetscInt, ghosts::Vector{PetscInt})

Creates a parallel vector with ghost padding on each processor.

Collective

Input Parameters:

• comm - the MPI communicator to use
• n - local vector length
• N - global vector length (or PETSC_DETERMINE to have calculated if n is given)
• nghost - number of local ghost points
• ghosts - global indices of ghost points, these do not need to be in increasing order (sorted)

Output Parameter:

• vv - the global vector representation (without ghost points as part of vector)

Level: advanced

-seealso: , Vec, VecType, VecCreateSeq(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateMPI(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecGhostUpdateBegin(), VecCreateGhostWithArray(), VecCreateMPIWithArray(), VecGhostUpdateEnd(), VecCreateGhostBlock(), VecCreateGhostBlockWithArray(), VecMPISetGhost()

External Links

• PETSc Manual: Vec/VecCreateGhost

vv::PetscVec = VecCreateGhostBlock(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, N::PetscInt, nghost::PetscInt, ghosts::Vector{PetscInt})

Creates a parallel vector with ghost padding on each processor. The indicing of the ghost points is done with blocks.

Collective

Input Parameters:

• comm - the MPI communicator to use
• bs - the block size
• n - local vector length
• N - global vector length (or PETSC_DETERMINE to have calculated if n is given)
• nghost - number of local ghost blocks
• ghosts - global indices of ghost blocks, counts are by block, not by individual index, these do not need to be in increasing order (sorted)

Output Parameter:

• vv - the global vector representation (without ghost points as part of vector)

Level: advanced

-seealso: , Vec, VecType, VecCreateSeq(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateMPI(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecGhostUpdateBegin(), VecGhostUpdateEnd() VecCreateGhostWithArray(), VecCreateMPIWithArray(), VecCreateGhostBlockWithArray()

External Links

• PETSc Manual: Vec/VecCreateGhostBlock

vv::PetscVec = VecCreateGhostBlockWithArray(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, N::PetscInt, nghost::PetscInt, ghosts::Vector{PetscInt}, array::Vector{PetscScalar})

Creates a parallel vector with ghost padding on each processor; the caller allocates the array space. Indices in the ghost region are based on blocks.

Collective

Input Parameters:

• comm - the MPI communicator to use
• bs - block size
• n - local vector length
• N - global vector length (or PETSC_DETERMINE to have calculated if n is given)
• nghost - number of local ghost blocks
• ghosts - global indices of ghost blocks (or NULL if not needed), counts are by block not by index, these do not need to be in increasing order (sorted)
• array - the space to store the vector values (as long as n + nghost*bs)

Output Parameter:

• vv - the global vector representation (without ghost points as part of vector)

Level: advanced

-seealso: , Vec, VecType, VecCreate(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecCreateGhost(), VecCreateSeqWithArray(), VecCreateMPIWithArray(), VecCreateGhostWithArray(), VecCreateGhostBlock(), VecGhostUpdateBegin(), VecGhostUpdateEnd()

External Links

• PETSc Manual: Vec/VecCreateGhostBlockWithArray

vv::PetscVec = VecCreateGhostWithArray(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt, N::PetscInt, nghost::PetscInt, ghosts::Vector{PetscInt}, array::Vector{PetscScalar})

Creates a parallel vector with ghost padding on each processor; the caller allocates the array space.

Collective

Input Parameters:

• comm - the MPI communicator to use
• n - local vector length
• N - global vector length (or PETSC_DETERMINE to have calculated if n is given)
• nghost - number of local ghost points
• ghosts - global indices of ghost points (or NULL if not needed), these do not need to be in increasing order (sorted)
• array - the space to store the vector values (as long as n + nghost)

Output Parameter:

• vv - the global vector representation (without ghost points as part of vector)

Level: advanced

-seealso: , Vec, VecType, VecCreate(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecCreateGhost(), VecCreateSeqWithArray(), VecCreateMPIWithArray(), VecCreateGhostBlock(), VecCreateGhostBlockWithArray(), VecMPISetGhost(), VecGhostUpdateBegin(), VecGhostUpdateEnd()

External Links

• PETSc Manual: Vec/VecCreateGhostWithArray

w::PetscVec = VecCreateLocalVector(petsclib::PetscLibType,v::PetscVec)

Creates a vector object suitable for use with VecGetLocalVector() and friends. You must call VecDestroy() when the vector is no longer needed.

Not Collective.

Input Parameter:

• v - The vector for which the local vector is desired.

Output Parameter:

• w - Upon exit this contains the local vector.

Level: beginner

-seealso: , Vec, VecGetLocalVectorRead(), VecRestoreLocalVectorRead(), VecGetLocalVector(), VecRestoreLocalVector()

External Links

• PETSc Manual: Vec/VecCreateLocalVector

v::PetscVec = VecCreateMPI(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt, N::PetscInt)

Creates a parallel vector.

Collective

Input Parameters:

• comm - the MPI communicator to use
• n - local vector length (or PETSC_DECIDE to have calculated if N is given)
• N - global vector length (or PETSC_DETERMINE to have calculated if n is given)

Output Parameter:

• v - the vector

Level: intermediate

-seealso: , Vec, VecType, VecCreateSeq(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateMPIWithArray(), VecCreateGhostWithArray(), VecMPISetGhost(), PetscLayout, VecGetOwnershipRange(), VecGetOwnershipRanges()

External Links

• PETSc Manual: Vec/VecCreateMPI

v::PetscVec = VecCreateMPIKokkosWithArray(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, N::PetscInt, darray::Vector{PetscScalar})

External Links

• PETSc Manual: Vec/VecCreateMPIKokkosWithArray

array::ViennaCLVector,vv::PetscVec = VecCreateMPIViennaCLWithArray(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, N::PetscInt)

External Links

• PETSc Manual: Vec/VecCreateMPIViennaCLWithArray

viennaclvec::ViennaCLVector,vv::PetscVec = VecCreateMPIViennaCLWithArrays(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, N::PetscInt, cpuarray::Vector{PetscScalar})

External Links

• PETSc Manual: Vec/VecCreateMPIViennaCLWithArrays

vv::PetscVec = VecCreateMPIWithArray(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, N::PetscInt, array::Vector{PetscScalar})

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

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

Level: intermediate

-seealso: , Vec, VecType, VecCreateSeqWithArray(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateMPI(), VecCreateGhostWithArray(), VecPlaceArray()

External Links

• PETSc Manual: Vec/VecCreateMPIWithArray

Y::PetscVec = VecCreateNest(petsclib::PetscLibType,comm::MPI_Comm, nb::PetscInt, is::Vector{IS}, x::Vector{PetscVec})

Creates a new vector containing several nested subvectors, each stored separately

Collective

Input Parameters:

• comm - Communicator for the new Vec
• nb - number of nested blocks
• is - array of nb index sets describing each nested block, or NULL to pack subvectors contiguously
• x - array of nb sub-vectors

Output Parameter:

• Y - new vector

Level: advanced

-seealso: VECNEST, , Vec, VecType, VecCreate(), MatCreateNest(), DMSetVecType()

External Links

• PETSc Manual: Vec/VecCreateNest

v::PetscVec = VecCreateSeq(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt)

Creates a standard, sequential array

Collective

Input Parameters:

• comm - the communicator, should be PETSC_COMM_SELF
• n - the vector length

Output Parameter:

• v - the vector

Level: intermediate

-seealso: , Vec, VecType, VecCreateMPI(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost()

External Links

• PETSc Manual: Vec/VecCreateSeq

v::PetscVec = VecCreateSeqKokkos(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt)

External Links

• PETSc Manual: Vec/VecCreateSeqKokkos

v::PetscVec = VecCreateSeqKokkosWithArray(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, darray::Vector{PetscScalar})

External Links

• PETSc Manual: Vec/VecCreateSeqKokkosWithArray

v::PetscVec = VecCreateSeqViennaCL(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt)

External Links

• PETSc Manual: Vec/VecCreateSeqViennaCL

viennaclvec::ViennaCLVector,V::PetscVec = VecCreateSeqViennaCLWithArrays(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, cpuarray::Vector{PetscScalar})

External Links

• PETSc Manual: Vec/VecCreateSeqViennaCLWithArrays

V::PetscVec = VecCreateSeqWithArray(petsclib::PetscLibType,comm::MPI_Comm, bs::PetscInt, n::PetscInt, array::Vector{PetscScalar})

Creates a standard,sequential array where the user provides the array space to store the vector values.

Collective

Input Parameters:

• comm - the communicator, should be PETSC_COMM_SELF
• bs - the block size
• n - the vector length
• array - memory where the vector elements are to be stored.

Output Parameter:

• V - the vector

Level: intermediate

-seealso: VecCreateMPIWithArray(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateSeq(), VecPlaceArray()

External Links

• PETSc Manual: Vec/VecCreateSeqWithArray

v::PetscVec = VecCreateShared(petsclib::PetscLibType,comm::MPI_Comm, n::PetscInt, N::PetscInt)

Creates a parallel vector that uses shared memory.

Collective

Input Parameters:

• comm - the MPI communicator to use
• n - local vector length (or PETSC_DECIDE to have calculated if N is given)
• N - global vector length (or PETSC_DECIDE to have calculated if n is given)

Output Parameter:

• v - the vector

Level: advanced

-seealso: , Vec, VecType, VecCreateSeq(), VecCreate(), VecCreateMPI(), VecDuplicate(), VecDuplicateVecs(), VecCreateGhost(), VecCreateMPIWithArray(), VecCreateGhostWithArray()

External Links

• PETSc Manual: Vec/VecCreateShared

VecDestroy(petsclib::PetscLibType,v::PetscVec)

Destroys a vector.

Collective

Input Parameter:

• v - the vector

Level: beginner

-seealso: , Vec, VecCreate(), VecDuplicate(), VecDestroyVecs()

External Links

• PETSc Manual: Vec/VecDestroy

VecDestroyVecs(petsclib::PetscLibType,m::PetscInt, vv::Vector{PetscVec})

Frees a block of vectors obtained with VecDuplicateVecs().

Collective

Input Parameters:

• m - the number of vectors previously obtained, if zero no vectors are destroyed
• vv - pointer to pointer to array of vector pointers, if NULL no vectors are destroyed

Level: intermediate

-seealso: , Vec, , VecDuplicateVecs(), VecDestroyVecsf90()

External Links

• PETSc Manual: Vec/VecDestroyVecs

val::PetscScalar = VecDot(petsclib::PetscLibType,x::PetscVec, y::PetscVec)

Computes the vector dot product.

Collective

Input Parameters:

• x - first vector
• y - second vector

Output Parameter:

• val - the dot product

Level: intermediate

Notes for Users of Complex Numbers: For complex vectors, VecDot() computes -seealso: , Vec, VecMDot(), VecTDot(), VecNorm(), VecDotBegin(), VecDotEnd(), VecDotRealPart()

External Links

• PETSc Manual: Vec/VecDot

VecDotBegin(petsclib::PetscLibType,x::PetscVec, y::PetscVec, result::PetscScalar)

Starts a split phase dot product computation.

Input Parameters:

• x - the first vector
• y - the second vector
• result - where the result will go (can be NULL)

Level: advanced

-seealso: VecDotEnd(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecTDotBegin(), VecTDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecDotBegin

VecDotEnd(petsclib::PetscLibType,x::PetscVec, y::PetscVec, result::PetscScalar)

Ends a split phase dot product computation.

Input Parameters:

• x - the first vector (can be NULL)
• y - the second vector (can be NULL)
• result - where the result will go

Level: advanced

-seealso: VecDotBegin(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecTDotBegin(), VecTDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecDotEnd

dp::PetscScalar,nm::PetscReal = VecDotNorm2(petsclib::PetscLibType,s::PetscVec, t::PetscVec)

computes the inner product of two vectors and the 2

Collective

Input Parameters:

• s - first vector
• t - second vector

Output Parameters:

• dp - s'conj(t)
• nm - t'conj(t)

Level: advanced

-seealso: Vec, VecDot(), VecNorm(), VecDotBegin(), VecNormBegin(), VecDotEnd(), VecNormEnd()

External Links

• PETSc Manual: Vec/VecDotNorm2

val::PetscReal = VecDotRealPart(petsclib::PetscLibType,x::PetscVec, y::PetscVec)

Computes the real part of the vector dot product.

Collective

Input Parameters:

• x - first vector
• y - second vector

Output Parameter:

• val - the real part of the dot product;

Level: intermediate

Notes for Users of Complex Numbers: See VecDot() for more details on the definition of the dot product for complex numbers

For real numbers this returns the same value as VecDot()

For complex numbers in C^n (that is a vector of n components with a complex number for each component) this is equal to the usual real dot product on the the space R^{2n} (that is a vector of 2n components with the real or imaginary part of the complex numbers for components)

-seealso: , Vec, VecMDot(), VecTDot(), VecNorm(), VecDotBegin(), VecDotEnd(), VecDot(), VecDotNorm2()

External Links

• PETSc Manual: Vec/VecDotRealPart

newv::PetscVec = VecDuplicate(petsclib::PetscLibType,v::PetscVec)

Creates a new vector of the same type as an existing vector.

Collective

Input Parameter:

• v - a vector to mimic

Output Parameter:

• newv - location to put new vector

Level: beginner

-seealso: , Vec, VecDestroy(), VecDuplicateVecs(), VecCreate(), VecCopy()

External Links

• PETSc Manual: Vec/VecDuplicate

V::Vector{PetscVec} = VecDuplicateVecs(petsclib::PetscLibType,v::PetscVec, m::PetscInt)

Creates several vectors of the same type as an existing vector.

Collective

Input Parameters:

• m - the number of vectors to obtain
• v - a vector to mimic

Output Parameter:

• V - location to put pointer to array of vectors

Level: intermediate

-seealso: , Vec, , VecDestroyVecs(), VecDuplicate(), VecCreate(), VecMDot(), VecMAXPY(), KSPGMRES, KSPGMRESSetPreAllocateVectors()

External Links

• PETSc Manual: Vec/VecDuplicateVecs

flg::PetscBool = VecEqual(petsclib::PetscLibType,vec1::PetscVec, vec2::PetscVec)

Compares two vectors. Returns true if the two vectors are either pointing to the same memory buffer, or if the two vectors have the same local and global layout as well as bitwise equality of all entries. Does NOT take round-off errors into account.

Collective

Input Parameters:

• vec1 - the first vector
• vec2 - the second vector

Output Parameter:

• flg - PETSC_TRUE if the vectors are equal; PETSC_FALSE otherwise.

Level: intermediate

-seealso: Vec

External Links

• PETSc Manual: Vec/VecEqual

norm::PetscReal,norm_loc::PetscInt,norma::PetscReal,norma_loc::PetscInt,normr::PetscReal,normr_loc::PetscInt = VecErrorWeightedNorms(petsclib::PetscLibType,U::PetscVec, Y::PetscVec, E::PetscVec, wnormtype::NormType, atol::PetscReal, vatol::PetscVec, rtol::PetscReal, vrtol::PetscVec, ignore_max::PetscReal)

compute a weighted norm of the difference between two vectors

Collective

Input Parameters:

• U - first vector to be compared
• Y - second vector to be compared
• E - optional third vector representing the error (if not provided, the error is ||U-Y||)
• wnormtype - norm type
• atol - scalar for absolute tolerance
• vatol - vector representing per-entry absolute tolerances (can be NULL)
• rtol - scalar for relative tolerance
• vrtol - vector representing per-entry relative tolerances (can be NULL)
• ignore_max - ignore values smaller than this value in absolute terms.

Output Parameters:

• norm - weighted norm
• norm_loc - number of vector locations used for the weighted norm
• norma - weighted norm based on the absolute tolerance
• norma_loc - number of vector locations used for the absolute weighted norm
• normr - weighted norm based on the relative tolerance
• normr_loc - number of vector locations used for the relative weighted norm

Level: developer

-seealso: , Vec, NormType, TSErrorWeightedNorm(), TSErrorWeightedENorm()

External Links

• PETSc Manual: Vec/VecErrorWeightedNorms

VecExp(petsclib::PetscLibType,v::PetscVec)

Replaces each component of a vector by e^x_i

Not Collective

Input Parameter:

• v - The vector

Output Parameter:

• v - The vector of exponents

Level: beginner

-seealso: Vec, VecLog(), VecAbs(), VecSqrtAbs(), VecReciprocal()

External Links

• PETSc Manual: Vec/VecExp

VecFilter(petsclib::PetscLibType,v::PetscVec, tol::PetscReal)

Set all values in the vector with an absolute value less than or equal to the tolerance to zero

Input Parameters:

• v - The vector
• tol - The zero tolerance

Output Parameter:

• v - The filtered vector

Level: intermediate

-seealso: VecCreate(), VecSet(), MatFilter()

External Links

• PETSc Manual: Vec/VecFilter

VecFinalizePackage(petsclib::PetscLibType)

This function finalizes everything in the Vec package. It is called from PetscFinalize().

Level: developer

-seealso: PetscInitialize()

External Links

• PETSc Manual: Vec/VecFinalizePackage

VecFischer(petsclib::PetscLibType,X::PetscVec, F::PetscVec, L::PetscVec, U::PetscVec, FB::PetscVec)

Evaluates the Fischer problems.

Logically Collective

Input Parameters:

• X - current point
• F - function evaluated at x
• L - lower bounds
• U - upper bounds

Output Parameter:

• FB - The Fischer-Burmeister function vector

Level: developer

-seealso: Vec, VecSFischer(), MatDFischer(), MatDSFischer()

External Links

• PETSc Manual: Tao/VecFischer

VecFlag(petsclib::PetscLibType,xin::PetscVec, flg::PetscInt)

set infinity into the local part of the vector on any subset of MPI processes

Logically Collective

Input Parameters:

• xin - the vector, can be NULL but only if on all processes
• flg - indicates if this processes portion of the vector should be set to infinity

Level: developer

-seealso: , Vec, PetscLayout, VecGetLayout(), VecGetSize(), VecGetOwnershipRange(), VecGetOwnershipRanges()

External Links

• PETSc Manual: Vec/VecFlag

a::Vector{PetscScalar} = VecGetArray(petsclib::PetscLibType,x::PetscVec)

Returns a pointer to a contiguous array that contains this MPI processes's portion of the vector data

Logically Collective

Input Parameter:

• x - the vector

Output Parameter:

• a - location to put pointer to the array

Level: beginner

-seealso: , Vec, VecRestoreArray(), VecGetArrayRead(), VecGetArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArrayPair(), VecRestoreArrayPair(), VecGetArrayWrite(), VecRestoreArrayWrite(), VecGetArrayAndMemType()

External Links

• PETSc Manual: Vec/VecGetArray

a::PetscArray = VecGetArray1d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, mstart::PetscInt)

Returns a pointer to a 1d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray1d() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetArray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray2d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray1d

a::PetscArray = VecGetArray1dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, mstart::PetscInt)

Returns a pointer to a 1d contiguous array that will contain this processor's portion of the vector data. You MUST call VecRestoreArray1dWrite() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetArray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray2d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray1dWrite

a::Vector{PetscScalar} = VecGetArray2d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, mstart::PetscInt, nstart::PetscInt)

Returns a pointer to a 2d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray2d() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• n - second dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetArray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray2d

a::Vector{PetscScalar} = VecGetArray2dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, mstart::PetscInt, nstart::PetscInt)

Returns a pointer to a 2d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray2dRead() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• n - second dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetArray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray2dRead

a::Vector{PetscScalar} = VecGetArray2dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, mstart::PetscInt, nstart::PetscInt)

Returns a pointer to a 2d contiguous array that will contain this processor's portion of the vector data. You MUST call VecRestoreArray2dWrite() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• n - second dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetArray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray2dWrite

a::PetscArray = VecGetArray3d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt)

Returns a pointer to a 3d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray3d() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of three dimensional array
• n - second dimension of three dimensional array
• p - third dimension of three dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetarray(), DMDAVecRestoreArray(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray3d

a::PetscArray = VecGetArray3dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt)

Returns a pointer to a 3d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray3dRead() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of three dimensional array
• n - second dimension of three dimensional array
• p - third dimension of three dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetarray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray3dRead

a::PetscArray = VecGetArray3dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt)

Returns a pointer to a 3d contiguous array that will contain this processor's portion of the vector data. You MUST call VecRestoreArray3dWrite() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of three dimensional array
• n - second dimension of three dimensional array
• p - third dimension of three dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetarray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray3dWrite

a::PetscArray = VecGetArray4d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, q::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, qstart::PetscInt)

Returns a pointer to a 4d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray4d() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of four dimensional array
• n - second dimension of four dimensional array
• p - third dimension of four dimensional array
• q - fourth dimension of four dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• qstart - first index in the fourth coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetarray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray4d

a::PetscArray = VecGetArray4dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, q::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, qstart::PetscInt)

Returns a pointer to a 4d contiguous array that contains this processor's portion of the vector data. You MUST call VecRestoreArray4dRead() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of four dimensional array
• n - second dimension of four dimensional array
• p - third dimension of four dimensional array
• q - fourth dimension of four dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• qstart - first index in the fourth coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: beginner

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetarray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray4dRead

a::PetscArray = VecGetArray4dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, q::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, qstart::PetscInt)

Returns a pointer to a 4d contiguous array that will contain this processor's portion of the vector data. You MUST call VecRestoreArray4dWrite() when you no longer need access to the array.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of four dimensional array
• n - second dimension of four dimensional array
• p - third dimension of four dimensional array
• q - fourth dimension of four dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• qstart - first index in the fourth coordinate direction (often 0)

Output Parameter:

• a - location to put pointer to the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrays(), VecPlaceArray(), VecRestoreArray2d(), DMDAVecGetarray(), DMDAVecRestoreArray(), VecGetArray3d(), VecRestoreArray3d(), VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecGetArray4dWrite

a::Vector{PetscScalar},mtype::PetscMemType = VecGetArrayAndMemType(petsclib::PetscLibType,x::PetscVec)

Like VecGetArray(), but if this is a standard device vector (e.g., VECCUDA), the returned pointer will be a device pointer to the device memory that contains this MPI processes's portion of the vector data.

Logically Collective; No Fortran Support

Input Parameter:

• x - the vector

Output Parameters:

• a - location to put pointer to the array
• mtype - memory type of the array

Level: beginner

-seealso: , Vec, VecRestoreArrayAndMemType(), VecGetArrayReadAndMemType(), VecGetArrayWriteAndMemType(), VecRestoreArray(), VecGetArrayRead(), VecGetArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArrayPair(), VecRestoreArrayPair(), VecGetArrayWrite(), VecRestoreArrayWrite()

External Links

• PETSc Manual: Vec/VecGetArrayAndMemType

xv::Vector{PetscScalar},yv::Vector{PetscScalar} = VecGetArrayPair(petsclib::PetscLibType,x::PetscVec, y::PetscVec)

External Links

• PETSc Manual: Vec/VecGetArrayPair

a::Vector{PetscScalar} = VecGetArrayRead(petsclib::PetscLibType,x::PetscVec)

Get read

Not Collective

Input Parameter:

• x - the vector

Output Parameter:

• a - the array

Level: beginner

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair(), VecGetArrayAndMemType()

External Links

• PETSc Manual: Vec/VecGetArrayRead

a::Vector{PetscScalar},mtype::PetscMemType = VecGetArrayReadAndMemType(petsclib::PetscLibType,x::PetscVec)

Like VecGetArrayRead(), but if the input vector is a device vector, it will return a read The returned pointer is guaranteed to point to up-to-date data. For host vectors, it functions as VecGetArrayRead().

Not Collective; No Fortran Support

Input Parameter:

• x - the vector

Output Parameters:

• a - the array
• mtype - memory type of the array

Level: beginner

-seealso: , Vec, VecRestoreArrayReadAndMemType(), VecGetArrayAndMemType(), VecGetArrayWriteAndMemType(), VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

• PETSc Manual: Vec/VecGetArrayReadAndMemType

a::Vector{PetscScalar} = VecGetArrayWrite(petsclib::PetscLibType,x::PetscVec)

Returns a pointer to a contiguous array that WILL contain this MPI processes's portion of the vector data.

Logically Collective

Input Parameter:

• x - the vector

Output Parameter:

• a - location to put pointer to the array

Level: intermediate

-seealso: , Vec, VecRestoreArray(), VecGetArrayRead(), VecGetArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArrayPair(), VecRestoreArrayPair(), VecGetArray(), VecRestoreArrayWrite(), VecGetArrayAndMemType()

External Links

• PETSc Manual: Vec/VecGetArrayWrite

a::Vector{PetscScalar},mtype::PetscMemType = VecGetArrayWriteAndMemType(petsclib::PetscLibType,x::PetscVec)

Like VecGetArrayWrite(), but if this is a device vector it will always return a device pointer to the device memory that contains this processor's portion of the vector data.

Logically Collective; No Fortran Support

Input Parameter:

• x - the vector

Output Parameters:

• a - the array
• mtype - memory type of the array

Level: beginner

-seealso: , Vec, VecRestoreArrayWriteAndMemType(), VecGetArrayReadAndMemType(), VecGetArrayAndMemType(), VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair(),

External Links

• PETSc Manual: Vec/VecGetArrayWriteAndMemType

a::Vector{PetscScalar} = VecGetArrays(petsclib::PetscLibType,x::Vector{PetscVec}, n::PetscInt)

Returns a pointer to the arrays in a set of vectors that were created by a call to VecDuplicateVecs().

Logically Collective; No Fortran Support

Input Parameters:

• x - the vectors
• n - the number of vectors

Output Parameter:

• a - location to put pointer to the array

Level: intermediate

-seealso: , Vec, VecGetArray(), VecRestoreArrays()

External Links

• PETSc Manual: Vec/VecGetArrays

flg::PetscBool = VecGetBindingPropagates(petsclib::PetscLibType,v::PetscVec)

Gets whether the state of being bound to the CPU for a GPU vector type propagates to child and some other associated objects

Input Parameter:

• v - the vector

Output Parameter:

• flg - flag indicating whether the boundtocpu flag will be propagated

Level: developer

-seealso: , Vec, VecSetBindingPropagates()

External Links

• PETSc Manual: Vec/VecGetBindingPropagates

bs::PetscInt = VecGetBlockSize(petsclib::PetscLibType,v::PetscVec)

Gets the blocksize for the vector, i.e. what is used for VecSetValuesBlocked() and VecSetValuesBlockedLocal().

Not Collective

Input Parameter:

• v - the vector

Output Parameter:

• bs - the blocksize

Level: advanced

-seealso: , Vec, VecSetValuesBlocked(), VecSetLocalToGlobalMapping(), VecSetBlockSize()

External Links

• PETSc Manual: Vec/VecGetBlockSize

dm::PetscDM = VecGetDM(petsclib::PetscLibType,v::PetscVec)

Gets the DM defining the data layout of the vector

Not Collective

Input Parameter:

• v - The Vec

Output Parameter:

• dm - The DM

Level: intermediate

Note: A Vec may not have a DM associated with it.

See also:

DM, VecSetDM(), DMGetLocalVector(), DMGetGlobalVector(), DMSetVecType()

External Links

• PETSc Manual: DM/VecGetDM

VecGetLayout(petsclib::PetscLibType,x::PetscVec, map::PetscLayout)

get PetscLayout describing a vector layout

Not Collective

Input Parameter:

• x - the vector

Output Parameter:

• map - the layout

Level: developer

-seealso: , PetscLayout, Vec, VecGetSize(), VecGetOwnershipRange(), VecGetOwnershipRanges()

External Links

• PETSc Manual: Vec/VecGetLayout

size::PetscInt = VecGetLocalSize(petsclib::PetscLibType,x::PetscVec)

Returns the number of elements of the vector stored in local memory (that is on this MPI process)

Not Collective

Input Parameter:

• x - the vector

Output Parameter:

• size - the length of the local piece of the vector

Level: beginner

-seealso: , Vec, VecGetSize()

External Links

• PETSc Manual: Vec/VecGetLocalSize

VecGetLocalToGlobalMapping(petsclib::PetscLibType,X::PetscVec, mapping::ISLocalToGlobalMapping)

Gets the local

Not Collective

Input Parameter:

• X - the vector

Output Parameter:

• mapping - the mapping

Level: advanced

-seealso: , Vec, VecSetValuesLocal(), VecSetLocalToGlobalMapping()

External Links

• PETSc Manual: Vec/VecGetLocalToGlobalMapping

VecGetLocalVector(petsclib::PetscLibType,v::PetscVec, w::PetscVec)

Maps the local portion of a vector into a vector.

Collective

Input Parameter:

• v - The vector for which the local vector is desired.

Output Parameter:

• w - Upon exit this contains the local vector.

Level: beginner

-seealso: , Vec, VecCreateLocalVector(), VecRestoreLocalVector(), VecGetLocalVectorRead(), VecGetArrayRead(), VecGetArray()

External Links

• PETSc Manual: Vec/VecGetLocalVector

VecGetLocalVectorRead(petsclib::PetscLibType,v::PetscVec, w::PetscVec)

Maps the local portion of a vector into a vector.

Not Collective.

Input Parameter:

• v - The vector for which the local vector is desired.

Output Parameter:

• w - Upon exit this contains the local vector.

Level: beginner

-seealso: , Vec, VecCreateLocalVector(), VecRestoreLocalVectorRead(), VecGetLocalVector(), VecGetArrayRead(), VecGetArray()

External Links

• PETSc Manual: Vec/VecGetLocalVectorRead

VecGetOffloadMask(petsclib::PetscLibType,v::PetscVec, mask::PetscOffloadMask)

Get the offload mask of a Vec

Not Collective

Input Parameter:

• v - the vector

Output Parameter:

• mask - corresponding PetscOffloadMask enum value.

Level: intermediate

-seealso: , Vec, VecCreateSeqCUDA(), VecCreateSeqViennaCL(), VecGetArray(), VecGetType()

External Links

• PETSc Manual: Vec/VecGetOffloadMask

VecGetOptionsPrefix(petsclib::PetscLibType,v::PetscVec, prefix::Vector{Cchar})

Sets the prefix used for searching for all Vec options in the database.

Not Collective

Input Parameter:

• v - the Vec context

Output Parameter:

• prefix - pointer to the prefix string used

Level: advanced

-seealso: , Vec, VecAppendOptionsPrefix()

External Links

• PETSc Manual: Vec/VecGetOptionsPrefix

low::PetscInt,high::PetscInt = VecGetOwnershipRange(petsclib::PetscLibType,x::PetscVec)

Returns the range of indices owned by this process. The vector is laid out with the first n1 elements on the first processor, next n2 elements on the second, etc. For certain parallel layouts this range may not be well defined.

Not Collective

Input Parameter:

• x - the vector

Output Parameters:

• low - the first local element, pass in NULL if not interested
• high - one more than the last local element, pass in NULL if not interested

Level: beginner

-seealso: , Vec, MatGetOwnershipRange(), MatGetOwnershipRanges(), VecGetOwnershipRanges(), PetscSplitOwnership(), VecSetSizes(), VecCreateMPI(), PetscLayout, DMDAGetGhostCorners(), DM

External Links

• PETSc Manual: Vec/VecGetOwnershipRange

ranges::Vector{PetscInt} = VecGetOwnershipRanges(petsclib::PetscLibType,x::PetscVec)

Returns the range of indices owned by EACH processor, The vector is laid out with the first n1 elements on the first processor, next n2 elements on the second, etc. For certain parallel layouts this range may not be well defined.

Not Collective

Input Parameter:

• x - the vector

Output Parameter:

• ranges - array of length size + 1 with the start and end+1 for each process

Level: beginner

-seealso: , Vec, MatGetOwnershipRange(), MatGetOwnershipRanges(), VecGetOwnershipRange(), PetscSplitOwnership(), VecSetSizes(), VecCreateMPI(), PetscLayout, DMDAGetGhostCorners(), DM

External Links

• PETSc Manual: Vec/VecGetOwnershipRanges

VecGetPinnedMemoryMin(petsclib::PetscLibType,v::PetscVec, mbytes::Csize_t)

Get the minimum data size for which pinned memory will be used for host (CPU) allocations.

Logically Collective

Input Parameter:

• v - the vector

Output Parameter:

• mbytes - minimum data size in bytes

Level: developer

-seealso: , Vec, VecSetPinnedMemoryMin()

External Links

• PETSc Manual: Vec/VecGetPinnedMemoryMin

size::PetscInt = VecGetSize(petsclib::PetscLibType,x::PetscVec)

Returns the global number of elements of the vector.

Not Collective

Input Parameter:

• x - the vector

Output Parameter:

• size - the global length of the vector

Level: beginner

-seealso: , Vec, VecGetLocalSize()

External Links

• PETSc Manual: Vec/VecGetSize

VecGetState(petsclib::PetscLibType,v::PetscVec, state::PetscObjectState)

Gets the state of a Vec.

Not Collective

Input Parameter:

• v - the Vec context

Output Parameter:

• state - the object state

Level: advanced

-seealso: , Vec, VecCreate(), PetscObjectStateGet()

External Links

• PETSc Manual: Vec/VecGetState

VecGetSubVector(petsclib::PetscLibType,X::PetscVec, is::IS, Y::PetscVec)

Gets a vector representing part of another vector

Collective

Input Parameters:

• X - vector from which to extract a subvector
• is - index set representing portion of X to extract

Output Parameter:

• Y - subvector corresponding to is

Level: advanced

-seealso: , Vec, IS, VECNEST, MatCreateSubMatrix()

External Links

• PETSc Manual: Vec/VecGetSubVector

type::VecType = VecGetType(petsclib::PetscLibType,vec::PetscVec)

Gets the vector type name (as a string) from a Vec.

Not Collective

Input Parameter:

• vec - The vector

Output Parameter:

• type - The VecType of the vector

Level: intermediate

-seealso: , Vec, VecType, VecCreate(), VecDuplicate(), VecDuplicateVecs()

External Links

• PETSc Manual: Vec/VecGetType

y::Vector{PetscScalar} = VecGetValues(petsclib::PetscLibType,x::PetscVec, ni::PetscInt, ix::Vector{PetscInt})

Gets values from certain locations of a vector. Currently can only get values on the same processor on which they are owned

Not Collective

Input Parameters:

• x - vector to get values from
• ni - number of elements to get
• ix - indices where to get them from (in global 1d numbering)

Output Parameter:

• y - array of values, must be passed in with a length of ni

Level: beginner

-seealso: , Vec, VecAssemblyBegin(), VecAssemblyEnd(), VecSetValues()

External Links

• PETSc Manual: Vec/VecGetValues

values::Vector{PetscScalar} = VecGetValuesSection(petsclib::PetscLibType,v::PetscVec, s::PetscSection, point::PetscInt)

Gets all the values associated with a given point, according to the section, in the given Vec

Not Collective

Input Parameters:

• v - the Vec
• s - the organizing PetscSection
• point - the point

Output Parameter:

• values - the array of output values

Level: developer

-seealso: PetscSection, PetscSectionCreate(), VecSetValuesSection()

External Links

• PETSc Manual: Vec/VecGetValuesSection

VecGhostGetGhostIS(petsclib::PetscLibType,X::PetscVec, ghost::IS)

Return ghosting indices of a ghost vector

Input Parameters:

• X - ghost vector

Output Parameter:

• ghost - ghosting indices

Level: beginner

-seealso: VecCreateGhostWithArray(), VecCreateMPIWithArray()

External Links

• PETSc Manual: Vec/VecGhostGetGhostIS

l::PetscVec = VecGhostGetLocalForm(petsclib::PetscLibType,g::PetscVec)

Obtains the local ghosted representation of a parallel vector (obtained with VecCreateGhost(), VecCreateGhostWithArray() or VecCreateSeq()).

Logically Collective

Input Parameter:

• g - the global vector

Output Parameter:

• l - the local (ghosted) representation,NULL if g is not ghosted

Level: advanced

-seealso: , VecGhostUpdateBegin(), VecGhostUpdateEnd(), Vec, VecType, VecCreateGhost(), VecGhostRestoreLocalForm(), VecCreateGhostWithArray()

External Links

• PETSc Manual: Vec/VecGhostGetLocalForm

flg::PetscBool = VecGhostIsLocalForm(petsclib::PetscLibType,g::PetscVec, l::PetscVec)

Checks if a given vector is the local form of a global vector

Not Collective

Input Parameters:

• g - the global vector
• l - the local vector

Output Parameter:

• flg - PETSC_TRUE if l is the local form

Level: advanced

-seealso: , Vec, VecType, VecCreateGhost(), VecGhostRestoreLocalForm(), VecCreateGhostWithArray(), VecGhostGetLocalForm()

External Links

• PETSc Manual: Vec/VecGhostIsLocalForm

VecGhostRestoreLocalForm(petsclib::PetscLibType,g::PetscVec, l::PetscVec)

Restores the local ghosted representation of a parallel vector obtained with VecGhostGetLocalForm().

Logically Collective

Input Parameters:

• g - the global vector
• l - the local (ghosted) representation

Level: advanced

-seealso: , VecGhostUpdateBegin(), VecGhostUpdateEnd(), Vec, VecType, VecCreateGhost(), VecGhostGetLocalForm(), VecCreateGhostWithArray()

External Links

• PETSc Manual: Vec/VecGhostRestoreLocalForm

VecGhostUpdateBegin(petsclib::PetscLibType,g::PetscVec, insertmode::InsertMode, scattermode::ScatterMode)

Begins the vector scatter to update the vector from local representation to global or global representation to local.

Neighbor-wise Collective

Input Parameters:

• g - the vector (obtained with VecCreateGhost() or VecDuplicate())
• insertmode - one of ADD_VALUES, MAX_VALUES, MIN_VALUES or INSERT_VALUES
• scattermode - one of SCATTER_FORWARD (update ghosts) or SCATTER_REVERSE (update local values from ghosts)

Level: advanced

-seealso: , Vec, VecType, VecCreateGhost(), VecGhostUpdateEnd(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecCreateGhostWithArray()

External Links

• PETSc Manual: Vec/VecGhostUpdateBegin

VecGhostUpdateEnd(petsclib::PetscLibType,g::PetscVec, insertmode::InsertMode, scattermode::ScatterMode)

End the vector scatter to update the vector from local representation to global or global representation to local.

Neighbor-wise Collective

Input Parameters:

• g - the vector (obtained with VecCreateGhost() or VecDuplicate())
• insertmode - one of ADD_VALUES, MAX_VALUES, MIN_VALUES or INSERT_VALUES
• scattermode - one of SCATTER_FORWARD (update ghosts) or SCATTER_REVERSE (update local values from ghosts)

Level: advanced

-seealso: , Vec, VecType, VecCreateGhost(), VecGhostUpdateBegin(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecCreateGhostWithArray()

External Links

• PETSc Manual: Vec/VecGhostUpdateEnd

VecISAXPY(petsclib::PetscLibType,vfull::PetscVec, is::IS, alpha::PetscScalar, vreduced::PetscVec)

Adds a reduced vector to the appropriate elements of a full vfull[is[i]] += alpha*vreduced[i]

Logically Collective

Input Parameters:

• vfull - the full-space vector
• is - the index set for the reduced space
• alpha - the scalar coefficient
• vreduced - the reduced-space vector

Output Parameter:

• vfull - the sum of the full-space vector and reduced-space vector

Level: advanced

-seealso: VecISCopy(), VecISSet(), VecAXPY()

External Links

• PETSc Manual: Vec/VecISAXPY

VecISCopy(petsclib::PetscLibType,vfull::PetscVec, is::IS, mode::ScatterMode, vreduced::PetscVec)

Copies between a reduced vector and the appropriate elements of a full

Logically Collective

Input Parameters:

• vfull - the full-space vector
• is - the index set for the reduced space
• mode - the direction of copying, SCATTER_FORWARD or SCATTER_REVERSE
• vreduced - the reduced-space vector

Output Parameter:

• vfull - the sum of the full-space vector and reduced-space vector

Level: advanced

-seealso: VecISSet(), VecISAXPY(), VecCopy()

External Links

• PETSc Manual: Vec/VecISCopy

VecISSet(petsclib::PetscLibType,V::PetscVec, S::IS, c::PetscScalar)

Sets the elements of a vector, specified by an index set, to a constant

Logically Collective

Input Parameters:

• V - the vector
• S - index set for the locations in the vector
• c - the constant

Level: advanced

-seealso: VecISCopy(), VecISAXPY(), VecISShift(), VecSet()

External Links

• PETSc Manual: Vec/VecISSet

VecISShift(petsclib::PetscLibType,V::PetscVec, S::IS, c::PetscScalar)

Shifts the elements of a vector, specified by an index set, by a constant

Logically Collective

Input Parameters:

• V - the vector
• S - index set for the locations in the vector
• c - the constant

Level: advanced

-seealso: VecISCopy(), VecISAXPY(), VecISSet(), VecShift()

External Links

• PETSc Manual: Vec/VecISShift

VecImaginaryPart(petsclib::PetscLibType,v::PetscVec)

Replaces a complex vector with its imginary part

Collective

Input Parameter:

• v - the vector

Level: beginner

-seealso: Vec, VecNorm(), VecRealPart()

External Links

• PETSc Manual: Vec/VecImaginaryPart

VecInitializePackage(petsclib::PetscLibType)

This function initializes everything in the Vec package. It is called from PetscDLLibraryRegister_petscvec() when using dynamic libraries, and on the first call to VecCreate() when using shared or static libraries.

Level: developer

-seealso: PetscInitialize()

External Links

• PETSc Manual: Vec/VecInitializePackage

a::PetscScalar = VecKokkosPlaceArray(petsclib::PetscLibType,v::PetscVec)

External Links

• PETSc Manual: Vec/VecKokkosPlaceArray

VecKokkosResetArray(petsclib::PetscLibType,v::PetscVec)

External Links

• PETSc Manual: Vec/VecKokkosResetArray

VecLoad(petsclib::PetscLibType,vec::PetscVec, viewer::PetscViewer)

Loads a vector that has been stored in binary or HDF5 format with VecView().

Collective

Input Parameters:

• vec - the newly loaded vector, this needs to have been created with VecCreate() or

some related function before the call to VecLoad().

• viewer - binary file viewer, obtained from PetscViewerBinaryOpen() or

HDF5 file viewer, obtained from PetscViewerHDF5Open()

Level: intermediate

-seealso: , Vec, PetscViewerBinaryOpen(), VecView(), MatLoad()

External Links

• PETSc Manual: Vec/VecLoad

state::PetscInt = VecLockGet(petsclib::PetscLibType,x::PetscVec)

Get the current lock status of a vector

Logically Collective

Input Parameter:

• x - the vector

Output Parameter:

• state - greater than zero indicates the vector is locked for read; less than zero indicates the vector is

locked for write; equal to zero means the vector is unlocked, that is, it is free to read or write.

Level: advanced

-seealso: , Vec, VecRestoreArray(), VecGetArrayRead(), VecLockReadPush(), VecLockReadPop()

External Links

• PETSc Manual: Vec/VecLockGet

VecLockGetLocation(petsclib::PetscLibType,x::PetscVec, file::Vector{Cchar}, func::Vector{Cchar}, line::Cint)

External Links

• PETSc Manual: Vec/VecLockGetLocation

VecLockReadPop(petsclib::PetscLibType,x::PetscVec)

Pop a read

Logically Collective

Input Parameter:

• x - the vector

Level: intermediate

-seealso: , Vec, VecRestoreArray(), VecGetArrayRead(), VecLockReadPush(), VecLockGet()

External Links

• PETSc Manual: Vec/VecLockReadPop

VecLockReadPush(petsclib::PetscLibType,x::PetscVec)

Push a read

Logically Collective

Input Parameter:

• x - the vector

Level: intermediate

-seealso: , Vec, VecRestoreArray(), VecGetArrayRead(), VecLockReadPop(), VecLockGet()

External Links

• PETSc Manual: Vec/VecLockReadPush

VecLockWriteSet(petsclib::PetscLibType,x::PetscVec, flg::PetscBool)

Lock or unlock a vector for exclusive read/write access

Logically Collective

Input Parameters:

• x - the vector
• flg - PETSC_TRUE to lock the vector for exclusive read/write access; PETSC_FALSE to unlock it.

Level: intermediate

-seealso: , Vec, VecRestoreArray(), VecGetArrayRead(), VecLockReadPush(), VecLockReadPop(), VecLockGet()

External Links

• PETSc Manual: Vec/VecLockWriteSet

VecLog(petsclib::PetscLibType,v::PetscVec)

Replaces each component of a vector by log(x_i), the natural logarithm

Not Collective

Input Parameter:

• v - The vector

Output Parameter:

• v - The vector of logs

Level: beginner

-seealso: Vec, VecExp(), VecAbs(), VecSqrtAbs(), VecReciprocal()

External Links

• PETSc Manual: Vec/VecLog

VecMAXPBY(petsclib::PetscLibType,y::PetscVec, nv::PetscInt, alpha::Vector{PetscScalar}, beta::PetscScalar, x::Vector{PetscVec})

Computes y = beta y + sum alpha[i] x[i]

Logically Collective

Input Parameters:

• nv - number of scalars and x vectors
• alpha - array of scalars
• beta - scalar
• y - one vector
• x - array of vectors

Level: intermediate

-seealso: , Vec, VecMAXPY(), VecAYPX(), VecWAXPY(), VecAXPY(), VecAXPBYPCZ(), VecAXPBY()

External Links

• PETSc Manual: Vec/VecMAXPBY

VecMAXPY(petsclib::PetscLibType,y::PetscVec, nv::PetscInt, alpha::Vector{PetscScalar}, x::Vector{PetscVec})

Computes y = y + sum alpha[i] x[i]

Logically Collective

Input Parameters:

• nv - number of scalars and x vectors
• alpha - array of scalars
• y - one vector
• x - array of vectors

Level: intermediate

-seealso: , Vec, VecMAXPBY(),VecAYPX(), VecWAXPY(), VecAXPY(), VecAXPBYPCZ(), VecAXPBY(), VecDuplicateVecs()

External Links

• PETSc Manual: Vec/VecMAXPY

val::Vector{PetscScalar} = VecMDot(petsclib::PetscLibType,x::PetscVec, nv::PetscInt, y::Vector{PetscVec})

Computes multiple vector dot products.

Collective

Input Parameters:

• x - one vector
• nv - number of vectors
• y - array of vectors.

Output Parameter:

• val - array of the dot products (does not allocate the array)

Level: intermediate

Notes for Users of Complex Numbers: For complex vectors, VecMDot() computes -seealso: , Vec, VecMTDot(), VecDot(), VecDuplicateVecs()

External Links

• PETSc Manual: Vec/VecMDot

VecMDotBegin(petsclib::PetscLibType,x::PetscVec, nv::PetscInt, y::Vector{PetscVec}, result::Vector{PetscScalar})

Starts a split phase multiple dot product computation.

Input Parameters:

• x - the first vector
• nv - number of vectors
• y - array of vectors
• result - where the result will go (can be NULL)

Level: advanced

-seealso: VecMDotEnd(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecTDotBegin(), VecTDotEnd(), VecMTDotBegin(), VecMTDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecMDotBegin

result::Vector{PetscScalar} = VecMDotEnd(petsclib::PetscLibType,x::PetscVec, nv::PetscInt, y::Vector{PetscVec})

Ends a split phase multiple dot product computation.

Input Parameters:

• x - the first vector (can be NULL)
• nv - number of vectors
• y - array of vectors (can be NULL)

Output Parameter:

• result - where the result will go

Level: advanced

-seealso: VecMDotBegin(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecTDotBegin(), VecTDotEnd(), VecMTDotBegin(), VecMTDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecMDotEnd

VecMPISetGhost(petsclib::PetscLibType,vv::PetscVec, nghost::PetscInt, ghosts::Vector{PetscInt})

Sets the ghost points for an MPI ghost vector

Collective

Input Parameters:

• vv - the MPI vector
• nghost - number of local ghost points
• ghosts - global indices of ghost points, these do not need to be in increasing order (sorted)

Level: advanced

-seealso: , Vec, VecType, VecCreateSeq(), VecCreate(), VecDuplicate(), VecDuplicateVecs(), VecCreateMPI(), VecGhostGetLocalForm(), VecGhostRestoreLocalForm(), VecGhostUpdateBegin(), VecCreateGhostWithArray(), VecCreateMPIWithArray(), VecGhostUpdateEnd(), VecCreateGhostBlock(), VecCreateGhostBlockWithArray()

External Links

• PETSc Manual: Vec/VecMPISetGhost

val::Vector{PetscScalar} = VecMTDot(petsclib::PetscLibType,x::PetscVec, nv::PetscInt, y::Vector{PetscVec})

Computes indefinite vector multiple dot products. That is, it does NOT use the complex conjugate.

Collective

Input Parameters:

• x - one vector
• nv - number of vectors
• y - array of vectors. Note that vectors are pointers

Output Parameter:

• val - array of the dot products

Level: intermediate

Notes for Users of Complex Numbers: For complex vectors, VecMTDot() computes the indefinite form -seealso: , Vec, VecMDot(), VecTDot()

External Links

• PETSc Manual: Vec/VecMTDot

VecMTDotBegin(petsclib::PetscLibType,x::PetscVec, nv::PetscInt, y::Vector{PetscVec}, result::Vector{PetscScalar})

Starts a split phase transpose multiple dot product computation.

Input Parameters:

• x - the first vector
• nv - number of vectors
• y - array of vectors
• result - where the result will go (can be NULL)

Level: advanced

-seealso: VecMTDotEnd(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd(), VecMDotBegin(), VecMDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecMTDotBegin

result::Vector{PetscScalar} = VecMTDotEnd(petsclib::PetscLibType,x::PetscVec, nv::PetscInt, y::Vector{PetscVec})

Ends a split phase transpose multiple dot product computation.

Input Parameters:

• x - the first vector (can be NULL)
• nv - number of vectors
• y - array of vectors (can be NULL)

Output Parameter:

• result - where the result will go

Level: advanced

-seealso: VecMTDotBegin(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd(), VecMDotBegin(), VecMDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecMTDotEnd

p::PetscInt,val::PetscReal = VecMax(petsclib::PetscLibType,x::PetscVec)

Determines the vector component with maximum real part and its location.

Collective

Input Parameter:

• x - the vector

Output Parameters:

• p - the index of val (pass NULL if you don't want this) in the vector
• val - the maximum component

Level: intermediate

-seealso: , Vec, VecNorm(), VecMin()

External Links

• PETSc Manual: Vec/VecMax

max::PetscReal = VecMaxPointwiseDivide(petsclib::PetscLibType,x::PetscVec, y::PetscVec)

Computes the maximum of the componentwise division max = max_i abs(x[i]/y[i]).

Logically Collective

Input Parameters:

• x - the numerators
• y - the denominators

Output Parameter:

• max - the result

Level: advanced

-seealso: , Vec, VecPointwiseDivide(), VecPointwiseMult(), VecPointwiseMax(), VecPointwiseMin(), VecPointwiseMaxAbs()

External Links

• PETSc Manual: Vec/VecMaxPointwiseDivide

mean::PetscScalar = VecMean(petsclib::PetscLibType,v::PetscVec)

Computes the arithmetic mean of all the components of a vector.

Collective

Input Parameter:

• v - the vector

Output Parameter:

• mean - the result

Level: beginner

-seealso: Vec, VecSum(), VecNorm()

External Links

• PETSc Manual: Vec/VecMean

VecMedian(petsclib::PetscLibType,Vec1::PetscVec, Vec2::PetscVec, Vec3::PetscVec, VMedian::PetscVec)

Computes the componentwise median of three vectors and stores the result in this vector. Used primarily for projecting a vector within upper and lower bounds.

Logically Collective

Input Parameters:

• Vec1 - The first vector
• Vec2 - The second vector
• Vec3 - The third vector

Output Parameter:

• VMedian - The median vector (this can be any one of the input vectors)

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecMedian

p::PetscInt,val::PetscReal = VecMin(petsclib::PetscLibType,x::PetscVec)

Determines the vector component with minimum real part and its location.

Collective

Input Parameter:

• x - the vector

Output Parameters:

• p - the index of val (pass NULL if you don't want this location) in the vector
• val - the minimum component

Level: intermediate

-seealso: , Vec, VecMax()

External Links

• PETSc Manual: Vec/VecMin

N::PetscInt = VecNestGetSize(petsclib::PetscLibType,X::PetscVec)

Returns the size of the nest vector.

Not Collective

Input Parameter:

• X - nest vector

Output Parameter:

• N - number of nested vecs

Level: developer

-seealso: VECNEST, , Vec, VecType, VecNestGetSubVec(), VecNestGetSubVecs()

External Links

• PETSc Manual: Vec/VecNestGetSize

VecNestGetSubVec(petsclib::PetscLibType,X::PetscVec, idxm::PetscInt, sx::PetscVec)

Returns a single, sub

Not Collective

Input Parameters:

• X - nest vector
• idxm - index of the vector within the nest

Output Parameter:

• sx - vector at index idxm within the nest

Level: developer

-seealso: VECNEST, , Vec, VecType, VecNestGetSize(), VecNestGetSubVecs()

External Links

• PETSc Manual: Vec/VecNestGetSubVec

N::PetscInt = VecNestGetSubVecs(petsclib::PetscLibType,X::PetscVec, sx::Vector{PetscVec})

Returns the entire array of vectors defining a nest vector.

Not Collective

Input Parameter:

• X - nest vector

Output Parameters:

• N - number of nested vecs
• sx - array of vectors, can pass in NULL

Level: developer

-seealso: VECNEST, , Vec, VecType, VecNestGetSize(), VecNestGetSubVec()

External Links

• PETSc Manual: Vec/VecNestGetSubVecs

VecNestSetSubVec(petsclib::PetscLibType,X::PetscVec, idxm::PetscInt, sx::PetscVec)

Set a single component vector in a nest vector at specified index.

Not Collective

Input Parameters:

• X - nest vector
• idxm - index of the vector within the nest vector
• sx - vector at index idxm within the nest vector

Level: developer

-seealso: VECNEST, , Vec, VecType, VecNestSetSubVecs(), VecNestGetSubVec()

External Links

• PETSc Manual: Vec/VecNestSetSubVec

VecNestSetSubVecs(petsclib::PetscLibType,X::PetscVec, N::PetscInt, idxm::Vector{PetscInt}, sx::Vector{PetscVec})

Sets the component vectors at the specified indices in a nest vector.

Not Collective

Input Parameters:

• X - nest vector
• N - number of component vecs in sx
• idxm - indices of component vectors that are to be replaced
• sx - array of vectors

Level: developer

-seealso: VECNEST, , Vec, VecType, VecNestGetSize(), VecNestGetSubVec()

External Links

• PETSc Manual: Vec/VecNestSetSubVecs

val::PetscReal = VecNorm(petsclib::PetscLibType,x::PetscVec, type::NormType)

Computes the vector norm.

Collective

Input Parameters:

• x - the vector
• type - the type of the norm requested

Output Parameter:

• val - the norm

Level: intermediate

-seealso: , Vec, NormType, VecDot(), VecTDot(), VecDotBegin(), VecDotEnd(), VecNormAvailable(), VecNormBegin(), VecNormEnd(), NormType()

External Links

• PETSc Manual: Vec/VecNorm

available::PetscBool,val::PetscReal = VecNormAvailable(petsclib::PetscLibType,x::PetscVec, type::NormType)

Returns the vector norm if it is already known. That is, it has been previously computed and cached in the vector

Not Collective

Input Parameters:

• x - the vector
• type - one of NORM_1 (sumi |x[i]|), `NORM2sqrt(sum_i (x[i])^2),NORMINFINITY` maxi |x[i]|. Also available

NORM_1_AND_2, which computes both norms and stores them in a two element array.

Output Parameters:

• available - PETSC_TRUE if the val returned is valid
• val - the norm

Level: intermediate

-seealso: , Vec, VecDot(), VecTDot(), VecNorm(), VecDotBegin(), VecDotEnd(), VecNormBegin(), VecNormEnd()

External Links

• PETSc Manual: Vec/VecNormAvailable

VecNormBegin(petsclib::PetscLibType,x::PetscVec, ntype::NormType, result::PetscReal)

Starts a split phase norm computation.

Input Parameters:

• x - the first vector
• ntype - norm type, one of NORM_1, NORM_2, NORM_MAX, NORM_1_AND_2
• result - where the result will go (can be NULL)

Level: advanced

-seealso: VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecNormBegin

VecNormEnd(petsclib::PetscLibType,x::PetscVec, ntype::NormType, result::PetscReal)

Ends a split phase norm computation.

Input Parameters:

• x - the first vector
• ntype - norm type, one of NORM_1, NORM_2, NORM_MAX, NORM_1_AND_2
• result - where the result will go

Level: advanced

-seealso: VecNormBegin(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecNormEnd

val::PetscReal = VecNormalize(petsclib::PetscLibType,x::PetscVec)

Normalizes a vector by its 2

Collective

Input Parameter:

• x - the vector

Output Parameter:

• val - the vector norm before normalization. May be NULL if the value is not needed.

Level: intermediate

-seealso: , Vec, VecNorm(), NORM_2, NormType

External Links

• PETSc Manual: Vec/VecNormalize

VecPermute(petsclib::PetscLibType,x::PetscVec, row::IS, inv::PetscBool)

Permutes a vector in place using the given ordering.

Input Parameters:

• x - The vector
• row - The ordering
• inv - The flag for inverting the permutation

Level: beginner

-seealso: Vec, MatPermute()

External Links

• PETSc Manual: Vec/VecPermute

VecPlaceArray(petsclib::PetscLibType,vec::PetscVec, array::Vector{PetscScalar})

Allows one to replace the array in a vector with an array provided by the user. This is useful to avoid copying an array into a vector.

Logically Collective; No Fortran Support

Input Parameters:

• vec - the vector
• array - the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecReplaceArray(), VecResetArray()

External Links

• PETSc Manual: Vec/VecPlaceArray

VecPointwiseDivide(petsclib::PetscLibType,w::PetscVec, x::PetscVec, y::PetscVec)

Computes the component

Logically Collective

Input Parameters:

• x - the numerator vector
• y - the denominator vector

Output Parameter:

• w - the result

Level: advanced

-seealso: , Vec, VecPointwiseMult(), VecPointwiseMax(), VecPointwiseMin(), VecPointwiseMaxAbs(), VecMaxPointwiseDivide()

External Links

• PETSc Manual: Vec/VecPointwiseDivide

VecPointwiseMax(petsclib::PetscLibType,w::PetscVec, x::PetscVec, y::PetscVec)

Computes the component

Logically Collective

Input Parameters:

• x - the first input vector
• y - the second input vector

Output Parameter:

• w - the result

Level: advanced

-seealso: , Vec, VecPointwiseDivide(), VecPointwiseMult(), VecPointwiseMin(), VecPointwiseMaxAbs(), VecMaxPointwiseDivide()

External Links

• PETSc Manual: Vec/VecPointwiseMax

VecPointwiseMaxAbs(petsclib::PetscLibType,w::PetscVec, x::PetscVec, y::PetscVec)

Computes the component

Logically Collective

Input Parameters:

• x - the first input vector
• y - the second input vector

Output Parameter:

• w - the result

Level: advanced

-seealso: , Vec, VecPointwiseDivide(), VecPointwiseMult(), VecPointwiseMin(), VecPointwiseMax(), VecMaxPointwiseDivide()

External Links

• PETSc Manual: Vec/VecPointwiseMaxAbs

VecPointwiseMin(petsclib::PetscLibType,w::PetscVec, x::PetscVec, y::PetscVec)

Computes the component

Logically Collective

Input Parameters:

• x - the first input vector
• y - the second input vector

Output Parameter:

• w - the result

Level: advanced

-seealso: , Vec, VecPointwiseDivide(), VecPointwiseMult(), VecPointwiseMaxAbs(), VecMaxPointwiseDivide()

External Links

• PETSc Manual: Vec/VecPointwiseMin

VecPointwiseMult(petsclib::PetscLibType,w::PetscVec, x::PetscVec, y::PetscVec)

Computes the component

Logically Collective

Input Parameters:

• x - the first vector
• y - the second vector

Output Parameter:

• w - the result

Level: advanced

-seealso: , Vec, VecPointwiseDivide(), VecPointwiseMax(), VecPointwiseMin(), VecPointwiseMaxAbs(), VecMaxPointwiseDivide()

External Links

• PETSc Manual: Vec/VecPointwiseMult

VecPow(petsclib::PetscLibType,v::PetscVec, p::PetscScalar)

Replaces each component of a vector by x_i^p

Logically Collective

Input Parameters:

• v - the vector
• p - the exponent to use on each element

Level: intermediate

-seealso: Vec

External Links

• PETSc Manual: Vec/VecPow

VecRealPart(petsclib::PetscLibType,v::PetscVec)

Replaces a complex vector with its real part

Collective

Input Parameter:

• v - the vector

Level: beginner

-seealso: Vec, VecNorm(), VecImaginaryPart()

External Links

• PETSc Manual: Vec/VecRealPart

VecReciprocal(petsclib::PetscLibType,vec::PetscVec)

Replaces each component of a vector by its reciprocal.

Logically Collective

Input Parameter:

• vec - the vector

Output Parameter:

• vec - the vector reciprocal

Level: intermediate

-seealso: , Vec, VecLog(), VecExp(), VecSqrtAbs()

External Links

• PETSc Manual: Vec/VecReciprocal

VecRegister(petsclib::PetscLibType,sname::Vector{Cchar}, fnc::external)

Adds a new vector component implementation

Not Collective, No Fortran Support

Input Parameters:

• sname - The name of a new user-defined creation routine
• function - The creation routine

-seealso: VecRegisterAll(), VecRegisterDestroy()

External Links

• PETSc Manual: Vec/VecRegister

VecRegisterAll(petsclib::PetscLibType)

Registers all of the vector types in the Vec package.

Not Collective

Level: advanced

-seealso: , Vec, VecType, VecRegister(), VecRegisterDestroy()

External Links

• PETSc Manual: Vec/VecRegisterAll

VecReplaceArray(petsclib::PetscLibType,vec::PetscVec, array::Vector{PetscScalar})

Allows one to replace the array in a vector with an array provided by the user. This is useful to avoid copying an array into a vector.

Logically Collective; No Fortran Support

Input Parameters:

• vec - the vector
• array - the array

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecPlaceArray(), VecResetArray()

External Links

• PETSc Manual: Vec/VecReplaceArray

VecResetArray(petsclib::PetscLibType,vec::PetscVec)

Resets a vector to use its default memory. Call this after the use of VecPlaceArray().

Not Collective

Input Parameter:

• vec - the vector

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecReplaceArray(), VecPlaceArray()

External Links

• PETSc Manual: Vec/VecResetArray

VecRestoreArray(petsclib::PetscLibType,x::PetscVec, a::Vector{PetscScalar})

Restores a vector after VecGetArray() has been called and the array is no longer needed

Logically Collective

Input Parameters:

• x - the vector
• a - location of pointer to array obtained from VecGetArray()

Level: beginner

-seealso: , Vec, VecGetArray(), VecRestoreArrayRead(), VecRestoreArrays(), VecPlaceArray(), VecRestoreArray2d(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

• PETSc Manual: Vec/VecRestoreArray

VecRestoreArray1d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, mstart::PetscInt, a::PetscArray{PetscScalar, 1})

Restores a vector after VecGetArray1d() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray1d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray2d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray1d

VecRestoreArray1dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, mstart::PetscInt, a::PetscArray{PetscScalar, 1})

Restores a vector after VecGetArray1dRead() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray1dRead()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray2d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray1dRead

VecRestoreArray1dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, mstart::PetscInt, a::Vector{PetscScalar})

Restores a vector after VecGetArray1dRead() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray1dRead()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray2d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray1dRead

VecRestoreArray1dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, mstart::PetscInt, a::PetscArray{PetscScalar, 1})

Restores a vector after VecGetArray1dWrite() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray1d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray2d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray1dWrite

VecRestoreArray2d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, mstart::PetscInt, nstart::PetscInt, a::PetscArray{PetscScalar, 2})

Restores a vector after VecGetArray2d() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• n - second dimension of the two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray2d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray2d

VecRestoreArray2dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, mstart::PetscInt, nstart::PetscInt, a::PetscArray{PetscScalar, 2})

Restores a vector after VecGetArray2dRead() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• n - second dimension of the two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray2d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray2dRead

VecRestoreArray2dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, mstart::PetscInt, nstart::PetscInt, a::PetscArray{PetscScalar, 2})

Restores a vector after VecGetArray2dWrite() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of two dimensional array
• n - second dimension of the two dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray2d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray2dWrite

VecRestoreArray3d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, a::PetscArray{PetscScalar, 3})

Restores a vector after VecGetArray3d() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of three dimensional array
• n - second dimension of the three dimensional array
• p - third dimension of the three dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray3d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray3d

VecRestoreArray3dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, a::PetscArray{PetscScalar, 3})

Restores a vector after VecGetArray3dRead() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of three dimensional array
• n - second dimension of the three dimensional array
• p - third dimension of the three dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray3dRead()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray3dRead

VecRestoreArray3dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, a::PetscArray{PetscScalar, 3})

Restores a vector after VecGetArray3dWrite() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of three dimensional array
• n - second dimension of the three dimensional array
• p - third dimension of the three dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray3d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray3dWrite

VecRestoreArray4d(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, q::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, qstart::PetscInt, a::PetscArray{PetscScalar, 4})

Restores a vector after VecGetArray4d() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of four dimensional array
• n - second dimension of the four dimensional array
• p - third dimension of the four dimensional array
• q - fourth dimension of the four dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• qstart - first index in the fourth coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray4d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray4d

VecRestoreArray4dRead(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, q::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, qstart::PetscInt, a::PetscArray{PetscScalar, 4})

Restores a vector after VecGetArray4d() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of four dimensional array
• n - second dimension of the four dimensional array
• p - third dimension of the four dimensional array
• q - fourth dimension of the four dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• qstart - first index in the fourth coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray4dRead()

Level: beginner

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray4dRead

VecRestoreArray4dWrite(petsclib::PetscLibType,x::PetscVec, m::PetscInt, n::PetscInt, p::PetscInt, q::PetscInt, mstart::PetscInt, nstart::PetscInt, pstart::PetscInt, qstart::PetscInt, a::PetscArray{PetscScalar, 4})

Restores a vector after VecGetArray4dWrite() has been called.

Logically Collective

Input Parameters:

• x - the vector
• m - first dimension of four dimensional array
• n - second dimension of the four dimensional array
• p - third dimension of the four dimensional array
• q - fourth dimension of the four dimensional array
• mstart - first index you will use in first coordinate direction (often 0)
• nstart - first index in the second coordinate direction (often 0)
• pstart - first index in the third coordinate direction (often 0)
• qstart - first index in the fourth coordinate direction (often 0)
• a - location of pointer to array obtained from VecGetArray4d()

Level: developer

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecRestoreArrays(), VecPlaceArray(), VecGetArray2d(), VecGetArray3d(), VecRestoreArray3d(), DMDAVecGetArray(), DMDAVecRestoreArray() VecGetArray1d(), VecRestoreArray1d(), VecGetArray4d(), VecRestoreArray4d()

External Links

• PETSc Manual: Vec/VecRestoreArray4dWrite

VecRestoreArrayAndMemType(petsclib::PetscLibType,x::PetscVec, a::Vector{PetscScalar})

Restores a vector after VecGetArrayAndMemType() has been called.

Logically Collective; No Fortran Support

Input Parameters:

• x - the vector
• a - location of pointer to array obtained from VecGetArrayAndMemType()

Level: beginner

-seealso: , Vec, VecGetArrayAndMemType(), VecGetArray(), VecRestoreArrayRead(), VecRestoreArrays(), VecPlaceArray(), VecRestoreArray2d(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

• PETSc Manual: Vec/VecRestoreArrayAndMemType

VecRestoreArrayPair(petsclib::PetscLibType,x::PetscVec, y::PetscVec, xv::Vector{PetscScalar}, yv::Vector{PetscScalar})

External Links

• PETSc Manual: Vec/VecRestoreArrayPair

VecRestoreArrayRead(petsclib::PetscLibType,x::PetscVec, a::Vector{PetscScalar})

Restore array obtained with VecGetArrayRead()

Not Collective

Input Parameters:

• x - the vector
• a - the array

Level: beginner

-seealso: , Vec, VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

• PETSc Manual: Vec/VecRestoreArrayRead

VecRestoreArrayReadAndMemType(petsclib::PetscLibType,x::PetscVec, a::Vector{PetscScalar})

Restore array obtained with VecGetArrayReadAndMemType()

Not Collective; No Fortran Support

Input Parameters:

• x - the vector
• a - the array

Level: beginner

-seealso: , Vec, VecGetArrayReadAndMemType(), VecRestoreArrayAndMemType(), VecRestoreArrayWriteAndMemType(), VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

• PETSc Manual: Vec/VecRestoreArrayReadAndMemType

VecRestoreArrayWrite(petsclib::PetscLibType,x::PetscVec, a::Vector{PetscScalar})

Restores a vector after VecGetArrayWrite() has been called.

Logically Collective

Input Parameters:

• x - the vector
• a - location of pointer to array obtained from VecGetArray()

Level: beginner

-seealso: , Vec, VecGetArray(), VecRestoreArrayRead(), VecRestoreArrays(), VecPlaceArray(), VecRestoreArray2d(), VecGetArrayPair(), VecRestoreArrayPair(), VecGetArrayWrite()

External Links

• PETSc Manual: Vec/VecRestoreArrayWrite

VecRestoreArrayWriteAndMemType(petsclib::PetscLibType,x::PetscVec, a::Vector{PetscScalar})

Restore array obtained with VecGetArrayWriteAndMemType()

Logically Collective; No Fortran Support

Input Parameters:

• x - the vector
• a - the array

Level: beginner

-seealso: , Vec, VecGetArrayWriteAndMemType(), VecRestoreArrayAndMemType(), VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

• PETSc Manual: Vec/VecRestoreArrayWriteAndMemType

VecRestoreArrays(petsclib::PetscLibType,x::Vector{PetscVec}, n::PetscInt, a::Vector{PetscScalar})

Restores a group of vectors after VecGetArrays() has been called.

Logically Collective; No Fortran Support

Input Parameters:

• x - the vector
• n - the number of vectors
• a - location of pointer to arrays obtained from VecGetArrays()

-seealso: , Vec, VecGetArrays(), VecRestoreArray()

External Links

• PETSc Manual: Vec/VecRestoreArrays

VecRestoreLocalVector(petsclib::PetscLibType,v::PetscVec, w::PetscVec)

Unmaps the local portion of a vector previously mapped into a vector using VecGetLocalVector().

Logically Collective.

Input Parameters:

• v - The local portion of this vector was previously mapped into w using VecGetLocalVector().
• w - The vector into which the local portion of v was mapped.

Level: beginner

-seealso: , Vec, VecCreateLocalVector(), VecGetLocalVector(), VecGetLocalVectorRead(), VecRestoreLocalVectorRead(), LocalVectorRead(), VecGetArrayRead(), VecGetArray()

External Links

• PETSc Manual: Vec/VecRestoreLocalVector

VecRestoreLocalVectorRead(petsclib::PetscLibType,v::PetscVec, w::PetscVec)

Unmaps the local portion of a vector previously mapped into a vector using VecGetLocalVectorRead().

Not Collective.

Input Parameters:

• v - The local portion of this vector was previously mapped into w using VecGetLocalVectorRead().
• w - The vector into which the local portion of v was mapped.

Level: beginner

-seealso: , Vec, VecCreateLocalVector(), VecGetLocalVectorRead(), VecGetLocalVector(), VecGetArrayRead(), VecGetArray()

External Links

• PETSc Manual: Vec/VecRestoreLocalVectorRead

VecRestoreSubVector(petsclib::PetscLibType,X::PetscVec, is::IS, Y::PetscVec)

Restores a subvector extracted using VecGetSubVector()

Collective

Input Parameters:

• X - vector from which subvector was obtained
• is - index set representing the subset of X
• Y - subvector being restored

Level: advanced

-seealso: , Vec, IS, VecGetSubVector()

External Links

• PETSc Manual: Vec/VecRestoreSubVector

val::PetscScalar = VecTDot(petsclib::PetscLibType,x::PetscVec, y::PetscVec)

Computes an indefinite vector dot product. That is, this routine does NOT use the complex conjugate.

Collective

Input Parameters:

• x - first vector
• y - second vector

Output Parameter:

• val - the dot product

Level: intermediate

Notes for Users of Complex Numbers: For complex vectors, VecTDot() computes the indefinite form -seealso: , Vec, VecDot(), VecMTDot()

External Links

• PETSc Manual: Vec/VecTDot

VecTDotBegin(petsclib::PetscLibType,x::PetscVec, y::PetscVec, result::PetscScalar)

Starts a split phase transpose dot product computation.

Input Parameters:

• x - the first vector
• y - the second vector
• result - where the result will go (can be NULL)

Level: advanced

-seealso: VecTDotEnd(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd(), PetscCommSplitReductionBegin()

External Links

• PETSc Manual: Vec/VecTDotBegin

VecTDotEnd(petsclib::PetscLibType,x::PetscVec, y::PetscVec, result::PetscScalar)

Ends a split phase transpose dot product computation.

Input Parameters:

• x - the first vector (can be NULL)
• y - the second vector (can be NULL)
• result - where the result will go

Level: advanced

-seealso: VecTDotBegin(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd()

External Links

• PETSc Manual: Vec/VecTDotEnd

n::PetscInt,e::Vector{PetscScalar} = VecUniqueEntries(petsclib::PetscLibType,vec::PetscVec)

Compute the number of unique entries, and those entries

Collective

Input Parameter:

• vec - the vector

Output Parameters:

• n - The number of unique entries
• e - The entries, each MPI process receives all the unique entries

Level: intermediate

-seealso: Vec

External Links

• PETSc Manual: Vec/VecUniqueEntries

VecView(petsclib::PetscLibType,vec::PetscVec, viewer::PetscViewer)

Views a vector object.

Collective

Input Parameters:

• vec - the vector
• viewer - an optional PetscViewer visualization context

Level: beginner

-seealso: , Vec, VecViewFromOptions(), PetscViewerASCIIOpen(), PetscViewerDrawOpen(), PetscDrawLGCreate(), PetscViewerSocketOpen(), PetscViewerBinaryOpen(), VecLoad(), PetscViewerCreate(), PetscRealView(), PetscScalarView(), PetscIntView(), PetscViewerHDF5SetTimestep()

External Links

• PETSc Manual: Vec/VecView

VecViewFromOptions(petsclib::PetscLibType,A::PetscVec, obj::PetscObject, name::Vector{Cchar})

View a vector based on values in the options database

Collective

Input Parameters:

• A - the vector
• obj - optional object that provides the options prefix for this viewing, use 'NULL' to use the prefix of A
• name - command line option

Level: intermediate

-seealso: , Vec, VecView, PetscObjectViewFromOptions(), VecCreate()

External Links

• PETSc Manual: Vec/VecViewFromOptions

VecViewNative(petsclib::PetscLibType,vec::PetscVec, viewer::PetscViewer)

Views a vector object with the original type specific viewer

Collective

Input Parameters:

• vec - the vector
• viewer - an optional PetscViewer visualization context

Level: developer

-seealso: , Vec, PetscViewerASCIIOpen(), PetscViewerDrawOpen(), PetscDrawLGCreate(), VecView() PetscViewerSocketOpen(), PetscViewerBinaryOpen(), VecLoad(), PetscViewerCreate(), PetscRealView(), PetscScalarView(), PetscIntView(), PetscViewerHDF5SetTimestep()

External Links

• PETSc Manual: Vec/VecViewNative

VecWAXPY(petsclib::PetscLibType,w::PetscVec, alpha::PetscScalar, x::PetscVec, y::PetscVec)

Computes w = alpha x + y.

Logically Collective

Input Parameters:

• alpha - the scalar
• x - first vector, multiplied by alpha
• y - second vector

Output Parameter:

• w - the result

Level: intermediate

-seealso: , Vec, VecAXPY(), VecAYPX(), VecAXPBY(), VecMAXPY(), VecAXPBYPCZ()

External Links

• PETSc Manual: Vec/VecWAXPY

VecWhichBetween(petsclib::PetscLibType,VecLow::PetscVec, V::PetscVec, VecHigh::PetscVec, S::IS)

Creates an index set containing the indices where VecLow < V < VecHigh

Collective

Input Parameters:

• VecLow - lower bound
• V - Vector to compare
• VecHigh - higher bound

Output Parameter:

• S - The index set containing the indices i where veclow[i] < v[i] < vechigh[i]

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecWhichBetween

VecWhichBetweenOrEqual(petsclib::PetscLibType,VecLow::PetscVec, V::PetscVec, VecHigh::PetscVec, S::IS)

Creates an index set containing the indices where VecLow <= V <= VecHigh

Collective

Input Parameters:

• VecLow - lower bound
• V - Vector to compare
• VecHigh - higher bound

Output Parameter:

• S - The index set containing the indices i where veclow[i] <= v[i] <= vechigh[i]

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecWhichBetweenOrEqual

VecWhichEqual(petsclib::PetscLibType,Vec1::PetscVec, Vec2::PetscVec, S::IS)

Creates an index set containing the indices where the vectors Vec1 and Vec2 have identical elements.

Collective

Input Parameters:

• Vec1 - the first vector to compare
• Vec2 - the second two vector to compare

Output Parameter:

• S - The index set containing the indices i where vec1[i] == vec2[i]

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecWhichEqual

VecWhichGreaterThan(petsclib::PetscLibType,Vec1::PetscVec, Vec2::PetscVec, S::IS)

Creates an index set containing the indices where the vectors Vec1 > Vec2

Collective

Input Parameters:

• Vec1 - the first vector to compare
• Vec2 - the second vector to compare

Output Parameter:

• S - The index set containing the indices i where vec1[i] > vec2[i]

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecWhichGreaterThan

VecWhichInactive(petsclib::PetscLibType,VecLow::PetscVec, V::PetscVec, D::PetscVec, VecHigh::PetscVec, Strong::PetscBool, S::IS)

Creates an IS based on a set of vectors

Collective

Input Parameters:

• VecLow - lower bound
• V - Vector to compare
• D - Direction to compare
• VecHigh - higher bound
• Strong - indicator for applying strongly inactive test

Output Parameter:

• S - The index set containing the indices i where the bound is inactive

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecWhichInactive

VecWhichLessThan(petsclib::PetscLibType,Vec1::PetscVec, Vec2::PetscVec, S::IS)

Creates an index set containing the indices where the vectors Vec1 < Vec2

Collective

Input Parameters:

• Vec1 - the first vector to compare
• Vec2 - the second vector to compare

Output Parameter:

• S - The index set containing the indices i where vec1[i] < vec2[i]

Level: advanced

-seealso: Vec

External Links

• PETSc Manual: Vec/VecWhichLessThan

VecZeroEntries(petsclib::PetscLibType,vec::PetscVec)

puts a 0.0 in each element of a vector

Logically Collective

Input Parameter:

• vec - The vector

Level: beginner

-seealso: , Vec, VecCreate(), VecSetOptionsPrefix(), VecSet(), VecSetValues()

External Links

• PETSc Manual: Vec/VecZeroEntries

VecSFischer(petsclib::PetscLibType,X::PetscVec, F::PetscVec, L::PetscVec, U::PetscVec, mu::PetscReal, FB::PetscVec)

Evaluates the Smoothed Fischer complementarity problems.

Logically Collective

Input Parameters:

• X - current point
• F - function evaluated at x
• L - lower bounds
• U - upper bounds
• mu - smoothing parameter

Output Parameter:

• FB - The Smoothed Fischer-Burmeister function vector

-seealso: Vec, VecFischer(), MatDFischer(), MatDSFischer()

External Links

• PETSc Manual: Tao/VecSFischer

VecScale(petsclib::PetscLibType,x::PetscVec, alpha::PetscScalar)

Scales a vector.

Logically Collective

Input Parameters:

• x - the vector
• alpha - the scalar

Level: intermediate

-seealso: , Vec, VecSet()

External Links

• PETSc Manual: Vec/VecScale

VecScatterBegin(petsclib::PetscLibType,sf::VecScatter, x::PetscVec, y::PetscVec, addv::InsertMode, mode::ScatterMode)

Begins a generalized scatter from one vector to another. Complete the scattering phase with VecScatterEnd().

Neighbor-wise Collective

Input Parameters:

• sf - scatter context generated by VecScatterCreate()
• x - the vector from which we scatter
• y - the vector to which we scatter
• addv - either ADD_VALUES, MAX_VALUES, MIN_VALUES or INSERT_VALUES, with INSERT_VALUES mode any location

not scattered to retains its old value; i.e. the vector is NOT first zeroed.

• mode - the scattering mode, usually SCATTER_FORWARD. The available modes are: SCATTER_FORWARD or SCATTER_REVERSE

Level: intermediate

-seealso: , VecScatter, VecScatterCreate(), VecScatterEnd(), InsertMode, ScatterMode

External Links

• PETSc Manual: Vec/VecScatterBegin

VecScatterCopy(petsclib::PetscLibType,sf::VecScatter, newsf::VecScatter)

Makes a copy of a scatter context.

Collective

Input Parameter:

• sf - the scatter context

Output Parameter:

• newsf - the context copy

Level: advanced

-seealso: , VecScatter, VecScatterType, VecScatterCreate(), VecScatterDestroy()

External Links

• PETSc Manual: Vec/VecScatterCopy

newsf::VecScatter = VecScatterCreate(petsclib::PetscLibType,x::PetscVec, ix::IS, y::PetscVec, iy::IS)

Creates a vector scatter VecScatter context that is used to communicate entries between two vectors Vec

Collective

Input Parameters:

• x - a vector that defines the shape (parallel data layout of the vector) of vectors from which we scatter
• y - a vector that defines the shape (parallel data layout of the vector) of vectors to which we scatter
• ix - the indices of x to scatter (if NULL scatters all values)
• iy - the indices of y to hold results (if NULL fills entire vector yin in order)

Output Parameter:

• newsf - location to store the new scatter context

Options Database Keys:

• -vecscatter_view - Prints detail of communications
• -vecscatter_view ::ascii_info - Print less details about communication
• -vecscatter_merge - VecScatterBegin() handles all of the communication, VecScatterEnd() is a nop

eliminates the chance for overlap of computation and communication

Level: intermediate

-seealso: , VecScatter, VecScatterDestroy(), VecScatterCreateToAll(), VecScatterCreateToZero(), PetscSFCreate(), VecScatterType, InsertMode, ScatterMode, VecScatterBegin(), VecScatterEnd()

External Links

• PETSc Manual: Vec/VecScatterCreate

ctx::VecScatter,vout::PetscVec = VecScatterCreateToAll(petsclib::PetscLibType,vin::PetscVec)

Creates a vector and a scatter context that copies all vector values to each processor

Collective

Input Parameter:

• vin - an MPIVEC

Output Parameters:

• ctx - scatter context
• vout - output SEQVEC that is large enough to scatter into

Level: intermediate

-seealso: , VecScatter, VecScatterCreate(), VecScatterCreateToZero(), VecScatterBegin(), VecScatterEnd()

External Links

• PETSc Manual: Vec/VecScatterCreateToAll

ctx::VecScatter,vout::PetscVec = VecScatterCreateToZero(petsclib::PetscLibType,vin::PetscVec)

Creates an output vector and a scatter context used to copy all vector values into the output vector on the zeroth processor

Collective

Input Parameter:

• vin - Vec of type MPIVEC

Output Parameters:

• ctx - scatter context
• vout - output SEQVEC that is large enough to scatter into on processor 0 and

of length zero on all other processors

Level: intermediate

-seealso: , VecScatter, VecScatterCreate(), VecScatterCreateToAll(), VecScatterBegin(), VecScatterEnd()

External Links

• PETSc Manual: Vec/VecScatterCreateToZero

VecScatterDestroy(petsclib::PetscLibType,sf::VecScatter)

Destroys a scatter context created by VecScatterCreate()

Collective

Input Parameter:

• sf - the scatter context

Level: intermediate

-seealso: , VecScatter, VecScatterCreate(), VecScatterCopy()

External Links

• PETSc Manual: Vec/VecScatterDestroy

VecScatterEnd(petsclib::PetscLibType,sf::VecScatter, x::PetscVec, y::PetscVec, addv::InsertMode, mode::ScatterMode)

Ends a generalized scatter from one vector to another. Call after first calling VecScatterBegin().

Neighbor-wise Collective

Input Parameters:

• sf - scatter context generated by VecScatterCreate()
• x - the vector from which we scatter
• y - the vector to which we scatter
• addv - one of ADD_VALUES, MAX_VALUES, MIN_VALUES or INSERT_VALUES
• mode - the scattering mode, usually SCATTER_FORWARD. The available modes are: SCATTER_FORWARD, SCATTER_REVERSE

Level: intermediate

-seealso: , VecScatter, VecScatterBegin(), VecScatterCreate()

External Links

• PETSc Manual: Vec/VecScatterEnd

VecScatterFFTWToPetsc(petsclib::PetscLibType,A::PetscMat, x::PetscVec, y::PetscVec)

Converts MATFFTW output vector to a PETSc vector.

Collective

Input Parameters:

• A - MATFFTW matrix
• x - FFTW vector

Output Parameter:

• y - PETSc vector

Level: intermediate

-seealso: , Mat, VecScatterPetscToFFTW(), MATFFTW, MatCreateVecsFFTW()

External Links

• PETSc Manual: Mat/VecScatterFFTWToPetsc

flg::PetscBool = VecScatterGetMerged(petsclib::PetscLibType,sf::VecScatter)

Returns true if the scatter is completed in the VecScatterBegin() and the VecScatterEnd() does nothing

Not Collective

Input Parameter:

• sf - scatter context created with VecScatterCreate()

Output Parameter:

• flg - PETSC_TRUE if the VecScatterBegin()/VecScatterEnd() are all done during the VecScatterBegin()

Level: developer

-seealso: , VecScatter, VecScatterCreate(), VecScatterEnd(), VecScatterBegin()

External Links

• PETSc Manual: Vec/VecScatterGetMerged

type::VecScatterType = VecScatterGetType(petsclib::PetscLibType,sf::VecScatter)

Gets the vector scatter type name (as a string) from the VecScatter.

Not Collective

Input Parameter:

• sf - The vector scatter

Output Parameter:

• type - The vector scatter type name

Level: intermediate

-seealso: , VecScatter, VecScatterType, VecScatterSetType(), VecScatterCreate()

External Links

• PETSc Manual: Vec/VecScatterGetType

VecScatterPetscToFFTW(petsclib::PetscLibType,A::PetscMat, x::PetscVec, y::PetscVec)

Copies a PETSc vector to the vector that goes into MATFFTW calls.

Collective

Input Parameters:

• A - FFTW matrix
• x - the PETSc vector

Output Parameter:

• y - the FFTW vector

Level: intermediate

-seealso: , Mat, MATFFTW, VecScatterFFTWToPetsc(), MatCreateVecsFFTW()

External Links

• PETSc Manual: Mat/VecScatterPetscToFFTW

VecScatterRegister(petsclib::PetscLibType,sname::Vector{Cchar}, fnc::external)

Adds a new vector scatter component implementation

Not Collective

Input Parameters:

• sname - The name of a new user-defined creation routine
• function - The creation routine

Level: advanced

-seealso: , VecScatter, VecScatterType, VecRegister()

External Links

• PETSc Manual: Vec/VecScatterRegister

VecScatterRemap(petsclib::PetscLibType,sf::VecScatter, tomap::Vector{PetscInt}, frommap::Vector{PetscInt})

Remaps the "from" and "to" indices in a vector scatter context.

Collective

Input Parameters:

• sf - vector scatter context
• tomap - remapping plan for "to" indices (may be NULL).
• frommap - remapping plan for "from" indices (may be NULL)

Level: developer

-seealso: , VecScatter, VecScatterCreate()

External Links

• PETSc Manual: Vec/VecScatterRemap

VecScatterSetFromOptions(petsclib::PetscLibType,sf::VecScatter)

Configures the vector scatter from values in the options database.

Collective

Input Parameter:

• sf - The vector scatter

-seealso: , VecScatter, VecScatterCreate(), VecScatterDestroy(), VecScatterSetUp()

External Links

• PETSc Manual: Vec/VecScatterSetFromOptions

VecScatterSetType(petsclib::PetscLibType,sf::VecScatter, type::VecScatterType)

Builds a vector scatter, for a particular vector scatter implementation.

Collective

Input Parameters:

• sf - The VecScatter object
• type - The name of the vector scatter type

Options Database Key:

• -sf_type <type> - Sets the VecScatterType

Level: intermediate

-seealso: , VecScatter, VecScatterType, VecScatterGetType(), VecScatterCreate()

External Links

• PETSc Manual: Vec/VecScatterSetType

VecScatterSetUp(petsclib::PetscLibType,sf::VecScatter)

Sets up the VecScatter to be able to actually scatter information between vectors

Collective

Input Parameter:

• sf - the scatter context

Level: intermediate

-seealso: , VecScatter, VecScatterCreate(), VecScatterCopy()

External Links

• PETSc Manual: Vec/VecScatterSetUp

VecScatterView(petsclib::PetscLibType,sf::VecScatter, viewer::PetscViewer)

Views a vector scatter context.

Collective

Input Parameters:

• sf - the scatter context
• viewer - the viewer for displaying the context

Level: intermediate

-seealso: , VecScatter, PetscViewer, VecScatterViewFromOptions(), PetscObjectViewFromOptions(), VecScatterCreate()

External Links

• PETSc Manual: Vec/VecScatterView

VecScatterViewFromOptions(petsclib::PetscLibType,sf::VecScatter, obj::PetscObject, name::Vector{Cchar})

View a VecScatter object based on values in the options database

Collective

Input Parameters:

• sf - the scatter context
• obj - Optional object
• name - command line option