Vec - Low-level Interface

This page documents the low-level, automatically wrapped PETSc Vec functions available through LibPETSc. These functions provide direct access to the PETSc C API.

For the high-level Julia interface, see Vec.

Overview

The Vec interface includes:

Core Vec operations: Creation, manipulation, and mathematical operations on vectors (~186 functions in Vec_wrappers.jl)
Vec utilities: Scatter operations, FFTW integration, and advanced vector operations (~76 functions in Vecs_wrappers.jl)
VecTagger: Tools for tagging/marking vector elements based on criteria (~31 functions in VecTagger_wrappers.jl)

Usage

All low-level Vec functions require a petsclib parameter as the first argument:

using PETSc

# Get the library instance
petsclib = PETSc.petsclibs[1]
PETSc.initialize(petsclib)

# Get PETSc types
PetscInt = petsclib.PetscInt

# Create a vector
vec = LibPETSc.VecCreate(petsclib, LibPETSc.PETSC_COMM_SELF)
LibPETSc.VecSetSizes(petsclib, vec, PetscInt(10), PetscInt(10))
LibPETSc.VecSetType(petsclib, vec, "seq")  # Set vector type
LibPETSc.VecSetFromOptions(petsclib, vec)

# Set values
LibPETSc.VecSet(petsclib, vec, 1.0)

# Query the vector
size = LibPETSc.VecGetSize(petsclib, vec)
println("Vector size: $size")

# Get values (0-based indexing!)
idx = PetscInt(0)
val = LibPETSc.VecGetValues(petsclib, vec, PetscInt(1), [idx])
println("Value at index 0: $(val[1])")

# Clean up
LibPETSc.VecDestroy(petsclib, vec)
PETSc.finalize(petsclib)

Function Reference

PETSc.LibPETSc.VecAXPBY — Method

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

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

See also: Vec, VecAYPX(), VecMAXPY(), VecWAXPY(), VecAXPY(), VecAXPBYPCZ()

External Links

PETSc Manual: Vec/VecAXPBY

source

PETSc.LibPETSc.VecAXPBYPCZ — Method

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

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

See also: Vec, VecAYPX(), VecMAXPY(), VecWAXPY(), VecAXPY(), VecAXPBY()

External Links

PETSc Manual: Vec/VecAXPBYPCZ

source

PETSc.LibPETSc.VecAXPY — Method

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

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

See also: Vec, VecAYPX(), VecMAXPY(), VecWAXPY(), VecAXPBYPCZ(), VecAXPBY()

External Links

PETSc Manual: Vec/VecAXPY

source

PETSc.LibPETSc.VecAYPX — Method

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

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

See also: Vec, VecMAXPY(), VecWAXPY(), VecAXPY(), VecAXPBYPCZ(), VecAXPBY()

External Links

PETSc Manual: Vec/VecAYPX

source

PETSc.LibPETSc.VecAbs — Method

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

Replaces every element in a vector with its absolute value.

Logically Collective

Input Parameter:

v - the vector

Level: intermediate

See also: Vec, VecExp(), VecSqrtAbs(), VecReciprocal(), VecLog(), VecPointwiseSign()

External Links

PETSc Manual: Vec/VecAbs

source

PETSc.LibPETSc.VecAppendOptionsPrefix — Method

VecAppendOptionsPrefix(petsclib::PetscLibType, v::AbstractPetscVec, prefix::String)

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

See also: Vec, VecGetOptionsPrefix()

External Links

PETSc Manual: Vec/VecAppendOptionsPrefix

source

PETSc.LibPETSc.VecAssemblyBegin — Method

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

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

See also: Vec, VecAssemblyEnd(), VecSetValues()

External Links

PETSc Manual: Vec/VecAssemblyBegin

source

PETSc.LibPETSc.VecAssemblyEnd — Method

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

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

Collective

Input Parameter:

vec - the vector

Options Database Keys:

-vec_view [viewertype][:...] - Display the vector. See VecViewFromOptions()/PetscObjectViewFromOptions() for the possible arguments
-vecstash_view [viewertype][:...] - Display the vector stash. See VecStashViewFromOptions()/PetscObjectViewFromOptions() for the possible arguments

Level: beginner

See also: Vec, VecAssemblyBegin(), VecSetValues(), VecViewFromOptions(), VecStashViewFromOptions(), PetscObjectViewFromOptions()

External Links

PETSc Manual: Vec/VecAssemblyEnd

source

PETSc.LibPETSc.VecBindToCPU — Method

VecBindToCPU(petsclib::PetscLibType, v::AbstractPetscVec, 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

See also: Vec

External Links

PETSc Manual: Vec/VecBoundGradientProjection

source

PETSc.LibPETSc.VecBoundToCPU — Method

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

query if a vector is bound to the CPU

Not collective

Input Parameter:

v - the vector

Output Parameter:

flg - the logical flag

Level: intermediate

See also: Vec

External Links

PETSc Manual: Vec/VecEqual

source

PETSc.LibPETSc.VecErrorWeightedNorms — Method

norm::PetscReal,norm_loc::PetscInt,norma::PetscReal,norma_loc::PetscInt,normr::PetscReal,normr_loc::PetscInt = VecErrorWeightedNorms(petsclib::PetscLibType, U::AbstractPetscVec, Y::AbstractPetscVec, E::AbstractPetscVec, wnormtype::NormType, atol::PetscReal, vatol::AbstractPetscVec, rtol::PetscReal, vrtol::AbstractPetscVec, 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

See also: Vec, NormType, TSErrorWeightedNorm(), TSErrorWeightedENorm()

External Links

PETSc Manual: Vec/VecErrorWeightedNorms

source

PETSc.LibPETSc.VecExp — Method

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

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

See also: Vec, VecLog(), VecAbs(), VecSqrtAbs(), VecReciprocal()

External Links

PETSc Manual: Vec/VecExp

source

PETSc.LibPETSc.VecFilter — Method

VecFilter(petsclib::PetscLibType, v::AbstractPetscVec, 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

See also: VecCreate(), VecSet(), MatFilter()

External Links

PETSc Manual: Vec/VecFilter

source

PETSc.LibPETSc.VecFinalizePackage — Method

VecFinalizePackage(petsclib::PetscLibType)

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

Level: developer

See also: Vec

External Links

PETSc Manual: Vec/VecMedian

source

PETSc.LibPETSc.VecMin — Method

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

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

See also: Vec

External Links

PETSc Manual: Vec/VecPow

source

PETSc.LibPETSc.VecRealPart — Method

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

Replaces a complex vector with its real part

Collective

Input Parameter:

v - the vector

Level: beginner

See also: Vec, VecNorm(), VecImaginaryPart()

External Links

PETSc Manual: Vec/VecRealPart

source

PETSc.LibPETSc.VecReciprocal — Method

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

Replaces each component of a vector by its reciprocal.

Logically Collective

Input Parameter:

vec - the vector

Output Parameter:

vec - the vector reciprocal

Level: intermediate

See also: Vec, VecLog(), VecExp(), VecSqrtAbs()

External Links

PETSc Manual: Vec/VecReciprocal

source

PETSc.LibPETSc.VecRegister — Method

VecRegister(petsclib::PetscLibType, sname::String, 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

See also: VecRegisterAll(), VecRegisterDestroy()

External Links

PETSc Manual: Vec/VecRegister

source

PETSc.LibPETSc.VecRegisterAll — Method

VecRegisterAll(petsclib::PetscLibType)

Registers all of the vector types in the Vec package.

Not Collective

Level: advanced

See also: Vec, VecType, VecRegister(), VecRegisterDestroy()

External Links

PETSc Manual: Vec/VecRegisterAll

source

PETSc.LibPETSc.VecReplaceArray — Method

VecReplaceArray(petsclib::PetscLibType, vec::AbstractPetscVec, 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

See also: Vec, VecGetArray(), VecRestoreArray(), VecPlaceArray(), VecResetArray()

External Links

PETSc Manual: Vec/VecReplaceArray

source

PETSc.LibPETSc.VecResetArray — Method

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

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

Not Collective

Input Parameter:

vec - the vector

Level: developer

See also: Vec, VecGetArray(), VecRestoreArray(), VecReplaceArray(), VecPlaceArray()

External Links

PETSc Manual: Vec/VecResetArray

source

PETSc.LibPETSc.VecRestoreArray — Method

VecRestoreArray(petsclib::PetscLibType, x::AbstractPetscVec, a::Union{Ptr, AbstractArray{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

See also: Vec, VecGetArray(), VecRestoreArrayRead(), VecRestoreArrays(), VecPlaceArray(), VecRestoreArray2d(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

PETSc Manual: Vec/VecRestoreArray

source

PETSc.LibPETSc.VecRestoreArray1d — Method

VecRestoreArray1d(petsclib::PetscLibType, x::AbstractPetscVec, 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

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

External Links

PETSc Manual: Vec/VecRestoreArray1d

source

PETSc.LibPETSc.VecRestoreArray1dRead — Method

VecRestoreArray1dRead(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray1dRead

source

PETSc.LibPETSc.VecRestoreArray1dWrite — Method

VecRestoreArray1dWrite(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray1dWrite

source

PETSc.LibPETSc.VecRestoreArray2d — Method

VecRestoreArray2d(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray2d

source

PETSc.LibPETSc.VecRestoreArray2dRead — Method

VecRestoreArray2dRead(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray2dRead

source

PETSc.LibPETSc.VecRestoreArray2dWrite — Method

VecRestoreArray2dWrite(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray2dWrite

source

PETSc.LibPETSc.VecRestoreArray3d — Method

VecRestoreArray3d(petsclib::PetscLibType, x::AbstractPetscVec, 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

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

External Links

PETSc Manual: Vec/VecRestoreArray3d

source

PETSc.LibPETSc.VecRestoreArray3dRead — Method

VecRestoreArray3dRead(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray3dRead

source

PETSc.LibPETSc.VecRestoreArray3dWrite — Method

VecRestoreArray3dWrite(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray3dWrite

source

PETSc.LibPETSc.VecRestoreArray4d — Method

VecRestoreArray4d(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray4d

source

PETSc.LibPETSc.VecRestoreArray4dRead — Method

VecRestoreArray4dRead(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray4dRead

source

PETSc.LibPETSc.VecRestoreArray4dWrite — Method

VecRestoreArray4dWrite(petsclib::PetscLibType, x::AbstractPetscVec, 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

External Links

PETSc Manual: Vec/VecRestoreArray4dWrite

source

PETSc.LibPETSc.VecRestoreArrayAndMemType — Method

VecRestoreArrayAndMemType(petsclib::PetscLibType, x::AbstractPetscVec, a::Union{Ptr, AbstractArray{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

See also: Vec, VecGetArrayAndMemType(), VecGetArray(), VecRestoreArrayRead(), VecRestoreArrays(), VecPlaceArray(), VecRestoreArray2d(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

PETSc Manual: Vec/VecRestoreArrayAndMemType

source

PETSc.LibPETSc.VecRestoreArrayRead — Method

VecRestoreArrayRead(petsclib::PetscLibType, x::AbstractPetscVec, a::Union{Ptr, AbstractArray{PetscScalar}})

Restore array obtained with VecGetArrayRead()

Not Collective

Input Parameters:

x - the vector
a - the array

Level: beginner

See also: Vec, VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

PETSc Manual: Vec/VecRestoreArrayRead

source

PETSc.LibPETSc.VecRestoreArrayReadAndMemType — Method

VecRestoreArrayReadAndMemType(petsclib::PetscLibType, x::AbstractPetscVec, a::Union{Ptr, AbstractArray{PetscScalar}})

Restore array obtained with VecGetArrayReadAndMemType()

Not Collective; No Fortran Support

Input Parameters:

x - the vector
a - the array

Level: beginner

See also: Vec, VecGetArrayReadAndMemType(), VecRestoreArrayAndMemType(), VecRestoreArrayWriteAndMemType(), VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

PETSc Manual: Vec/VecRestoreArrayReadAndMemType

source

PETSc.LibPETSc.VecRestoreArrayWrite — Method

VecRestoreArrayWrite(petsclib::PetscLibType, x::AbstractPetscVec, a::Union{Ptr, AbstractArray{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

See also: Vec, VecGetArray(), VecRestoreArrayRead(), VecRestoreArrays(), VecPlaceArray(), VecRestoreArray2d(), VecGetArrayPair(), VecRestoreArrayPair(), VecGetArrayWrite()

External Links

PETSc Manual: Vec/VecRestoreArrayWrite

source

PETSc.LibPETSc.VecRestoreArrayWriteAndMemType — Method

VecRestoreArrayWriteAndMemType(petsclib::PetscLibType, x::AbstractPetscVec, a::Union{Ptr, AbstractArray{PetscScalar}})

Restore array obtained with VecGetArrayWriteAndMemType()

Logically Collective; No Fortran Support

Input Parameters:

x - the vector
a - the array

Level: beginner

See also: Vec, VecGetArrayWriteAndMemType(), VecRestoreArrayAndMemType(), VecGetArray(), VecRestoreArray(), VecGetArrayPair(), VecRestoreArrayPair()

External Links

PETSc Manual: Vec/VecRestoreArrayWriteAndMemType

source

PETSc.LibPETSc.VecRestoreArrays — Method

VecRestoreArrays(petsclib::PetscLibType, x::Vector{<:AbstractPetscVec}, 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()

See also: Vec, VecGetArrays(), VecRestoreArray()

External Links

PETSc Manual: Vec/VecRestoreArrays

source

PETSc.LibPETSc.VecRestoreLocalVector — Method

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

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

See also: Vec, VecCreateLocalVector(), VecGetLocalVector(), VecGetLocalVectorRead(), VecRestoreLocalVectorRead(), LocalVectorRead(), VecGetArrayRead(), VecGetArray()

External Links

PETSc Manual: Vec/VecRestoreLocalVector

source

PETSc.LibPETSc.VecRestoreLocalVectorRead — Method

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

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

See also: Vec, VecCreateLocalVector(), VecGetLocalVectorRead(), VecGetLocalVector(), VecGetArrayRead(), VecGetArray()

External Links

PETSc Manual: Vec/VecRestoreLocalVectorRead

source

PETSc.LibPETSc.VecRestoreSubVector — Method

VecRestoreSubVector(petsclib::PetscLibType, X::AbstractPetscVec, is::AbstractIS, Y::AbstractPetscVec)

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

See also: Vec, IS, VecGetSubVector()

External Links

PETSc Manual: Vec/VecRestoreSubVector

source

PETSc.LibPETSc.VecTDot — Method

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

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 $val = (x,y) = y^T x,$ where y^T denotes the transpose of y.

Use VecDot() for the inner product $val = (x,y) = y^H x,$ where y^H denotes the conjugate transpose of y.

See also: Vec, VecDot(), VecMTDot()

External Links

PETSc Manual: Vec/VecTDot

source

PETSc.LibPETSc.VecTDotBegin — Method

result::PetscScalar = VecTDotBegin(petsclib::PetscLibType, x::AbstractPetscVec, y::AbstractPetscVec)

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

See also: VecTDotEnd(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd(), PetscCommSplitReductionBegin()

External Links

PETSc Manual: Vec/VecTDotBegin

source

PETSc.LibPETSc.VecTDotEnd — Method

result::PetscScalar = VecTDotEnd(petsclib::PetscLibType, x::AbstractPetscVec, y::AbstractPetscVec)

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

See also: VecTDotBegin(), VecNormBegin(), VecNormEnd(), VecNorm(), VecDot(), VecMDot(), VecDotBegin(), VecDotEnd()

External Links

PETSc Manual: Vec/VecTDotEnd

source

PETSc.LibPETSc.VecUniqueEntries — Method

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

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

See also: Vec

External Links

PETSc Manual: Vec/VecUniqueEntries

source

PETSc.LibPETSc.VecView — Method

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

Views a vector object.

Collective

Input Parameters:

vec - the vector
viewer - an optional PetscViewer visualization context

Level: beginner

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

External Links

PETSc Manual: Vec/VecView

source

PETSc.LibPETSc.VecViewFromOptions — Method

VecViewFromOptions(petsclib::PetscLibType, A::AbstractPetscVec, obj, name::String)

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

Options Database Key:

-name [viewertype][:...] - option name and values. See PetscObjectViewFromOptions() for the possible arguments

Level: intermediate

See also: Vec, VecView, PetscObjectViewFromOptions(), VecCreate()

External Links

PETSc Manual: Vec/VecViewFromOptions

source

PETSc.LibPETSc.VecViewNative — Method

VecViewNative(petsclib::PetscLibType, vec::AbstractPetscVec, 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

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

External Links

PETSc Manual: Vec/VecViewNative

source

PETSc.LibPETSc.VecWAXPY — Method

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

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

See also: Vec, VecAXPY(), VecAYPX(), VecAXPBY(), VecMAXPY(), VecAXPBYPCZ()

External Links

PETSc Manual: Vec/VecWAXPY

source

PETSc.LibPETSc.VecWhichBetween — Method

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

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

See also: Vec

External Links

PETSc Manual: Vec/VecWhichBetween

source

PETSc.LibPETSc.VecWhichBetweenOrEqual — Method

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

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

See also: Vec

External Links

PETSc Manual: Vec/VecWhichBetweenOrEqual

source

PETSc.LibPETSc.VecWhichEqual — Method

S::IS = VecWhichEqual(petsclib::PetscLibType, Vec1::AbstractPetscVec, Vec2::AbstractPetscVec)

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

See also: Vec

External Links

PETSc Manual: Vec/VecWhichEqual

source

PETSc.LibPETSc.VecWhichGreaterThan — Method

S::IS = VecWhichGreaterThan(petsclib::PetscLibType, Vec1::AbstractPetscVec, Vec2::AbstractPetscVec)

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

See also: Vec

External Links

PETSc Manual: Vec/VecWhichGreaterThan

source

PETSc.LibPETSc.VecWhichInactive — Method

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

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

See also: Vec

External Links

PETSc Manual: Vec/VecWhichInactive

source

PETSc.LibPETSc.VecWhichLessThan — Method

S::IS = VecWhichLessThan(petsclib::PetscLibType, Vec1::AbstractPetscVec, Vec2::AbstractPetscVec)

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

See also: Vec

External Links

PETSc Manual: Vec/VecWhichLessThan

source

PETSc.LibPETSc.VecZeroEntries — Method

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

puts a 0.0 in each element of a vector

Logically Collective

Input Parameter:

vec - The vector

Level: beginner

See also: Vec, VecCreate(), VecSetOptionsPrefix(), VecSet(), VecSetValues()

External Links

PETSc Manual: Vec/VecZeroEntries

source

PETSc.LibPETSc.VecSFischer — Method

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

Evaluates the Smoothed Fischer-Burmeister function for 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

See also: Vec, VecFischer(), MatDFischer(), MatDSFischer()

External Links

PETSc Manual: Tao/VecSFischer

source

PETSc.LibPETSc.VecScale — Method

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

Scales a vector.

Logically Collective

Input Parameters:

x - the vector
alpha - the scalar

Level: intermediate

See also: Vec

External Links

PETSc Manual: Vec/VecStepBoundInfo

source

PETSc.LibPETSc.VecStepMax — Method

step::PetscReal = VecStepMax(petsclib::PetscLibType, X::AbstractPetscVec, DX::AbstractPetscVec)

Returns the largest value so that x[i] + step*DX[i] >= 0 for all i

Collective

Input Parameters:

X - vector with no negative entries
DX - a step direction, can have negative, positive or zero entries

Output Parameter:

step - largest value such that x[i] + step*DX[i] >= 0 for all i

Level: advanced

See also: Vec

External Links

PETSc Manual: Vec/VecStepMax

source

PETSc.LibPETSc.VecStepMaxBounded — Method

stepmax::PetscReal = VecStepMaxBounded(petsclib::PetscLibType, X::AbstractPetscVec, DX::AbstractPetscVec, XL::AbstractPetscVec, XU::AbstractPetscVec)

See below

Collective

Input Parameters:

X - vector with no negative entries
XL - lower bounds
XU - upper bounds
DX - step direction, can have negative, positive or zero entries

Output Parameter:

stepmax - minimum value so that X[i] + stepmaxDX[i] <= XL[i] or XU[i] <= X[i] + stepmaxDX[i]

Level: intermediate

See also: Vec

External Links

PETSc Manual: Vec/VecStepMaxBounded

source

PETSc.LibPETSc.VecStrideGather — Method

VecStrideGather(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt, s::AbstractPetscVec, addv::InsertMode)

Gathers a single component from a multi-component vector into another vector.

Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)
addv - one of ADD_VALUES, INSERT_VALUES, MAX_VALUES

Output Parameter:

s - the location where the subvector is stored

Level: advanced

See also: Vec, VecStrideNorm(), VecStrideScatter(), VecStrideMin(), VecStrideMax(), VecStrideGatherAll(), VecStrideScatterAll()

External Links

PETSc Manual: Vec/VecStrideGather

source

PETSc.LibPETSc.VecStrideGatherAll — Method

VecStrideGatherAll(petsclib::PetscLibType, v::AbstractPetscVec, s::Vector{<:AbstractPetscVec}, addv::InsertMode)

Gathers all the single components from a multi-component vector into separate vectors.

Collective

Input Parameters:

v - the vector
addv - one of ADD_VALUES, INSERT_VALUES, MAX_VALUES

Output Parameter:

s - the location where the subvectors are stored

Level: advanced

See also: Vec, VecStrideNorm(), VecStrideScatter(), VecStrideMin(), VecStrideMax(), VecStrideGather(), VecStrideScatterAll()

External Links

PETSc Manual: Vec/VecStrideGatherAll

source

PETSc.LibPETSc.VecStrideMax — Method

idex::PetscInt,nrm::PetscReal = VecStrideMax(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt)

Computes the maximum of subvector of a vector defined by a starting point and a stride and optionally its location.

Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)

Output Parameters:

idex - the location where the maximum occurred (pass NULL if not required)
nrm - the maximum value in the subvector

Level: advanced

See also: Vec, VecMax(), VecStrideNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMin()

External Links

PETSc Manual: Vec/VecStrideMax

source

PETSc.LibPETSc.VecStrideMaxAll — Method

VecStrideMaxAll(petsclib::PetscLibType, v::AbstractPetscVec, idex::Vector{PetscInt}, nrm::Vector{PetscReal})

Computes the maximums of subvectors of a vector defined by a starting point and a stride and optionally its location.

Collective

Input Parameter:

v - the vector

Output Parameters:

idex - the location where the maximum occurred (not supported, pass NULL,

if you need this, send mail to petsc-maint@mcs.anl.gov to request it)

nrm - the maximum values of each subvector

Level: advanced

See also: Vec, VecMax(), VecStrideNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMin()

External Links

PETSc Manual: Vec/VecStrideMaxAll

source

PETSc.LibPETSc.VecStrideMin — Method

idex::PetscInt,nrm::PetscReal = VecStrideMin(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt)

Computes the minimum of subvector of a vector defined by a starting point and a stride and optionally its location.

Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)

Output Parameters:

idex - the location where the minimum occurred. (pass NULL if not required)
nrm - the minimum value in the subvector

Level: advanced

See also: Vec, VecMin(), VecStrideNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideMin

source

PETSc.LibPETSc.VecStrideMinAll — Method

VecStrideMinAll(petsclib::PetscLibType, v::AbstractPetscVec, idex::Vector{PetscInt}, nrm::Vector{PetscReal})

Computes the minimum of subvector of a vector defined by a starting point and a stride and optionally its location.

Collective

Input Parameter:

v - the vector

Output Parameters:

idex - the location where the minimum occurred (not supported, pass NULL,

if you need this, send mail to petsc-maint@mcs.anl.gov to request it)

nrm - the minimums of each subvector

Level: advanced

See also: Vec, VecMin(), VecStrideNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideMinAll

source

PETSc.LibPETSc.VecStrideNorm — Method

nrm::PetscReal = VecStrideNorm(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt, ntype::NormType)

Computes the norm of subvector of a vector defined by a starting point and a stride.

Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)
ntype - type of norm, one of NORM_1, NORM_2, NORM_INFINITY

Output Parameter:

nrm - the norm

Level: advanced

See also: Vec, VecNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideNorm

source

PETSc.LibPETSc.VecStrideNormAll — Method

VecStrideNormAll(petsclib::PetscLibType, v::AbstractPetscVec, ntype::NormType, nrm::Vector{PetscReal})

Computes the norms of subvectors of a vector defined by a starting point and a stride.

Collective

Input Parameters:

v - the vector
ntype - type of norm, one of NORM_1, NORM_2, NORM_INFINITY

Output Parameter:

nrm - the norms

Level: advanced

See also: Vec, VecNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideNormAll

source

PETSc.LibPETSc.VecStrideScale — Method

VecStrideScale(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt, scale::PetscScalar)

Scales a subvector of a vector defined by a starting point and a stride.

Logically Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)
scale - value to multiply each subvector entry by

Level: advanced

See also: Vec, VecNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideScale

source

PETSc.LibPETSc.VecStrideScaleAll — Method

VecStrideScaleAll(petsclib::PetscLibType, v::AbstractPetscVec, scales::Vector{PetscScalar})

Scales the subvectors of a vector defined by a starting point and a stride.

Logically Collective

Input Parameters:

v - the vector
scales - values to multiply each subvector entry by

Level: advanced

See also: Vec, VecNorm(), VecStrideScale(), VecScale(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideScaleAll

source

PETSc.LibPETSc.VecStrideScatter — Method

VecStrideScatter(petsclib::PetscLibType, s::AbstractPetscVec, start::PetscInt, v::AbstractPetscVec, addv::InsertMode)

Scatters a single component from a vector into a multi-component vector.

Collective

Input Parameters:

s - the single-component vector
start - starting point of the subvector (defined by a stride)
addv - one of ADD_VALUES, INSERT_VALUES, MAX_VALUES

Output Parameter:

v - the location where the subvector is scattered (the multi-component vector)

Level: advanced

See also: Vec, VecStrideNorm(), VecStrideGather(), VecStrideMin(), VecStrideMax(), VecStrideGatherAll(), VecStrideScatterAll(), VecStrideSubSetScatter(), VecStrideSubSetGather()

External Links

PETSc Manual: Vec/VecStrideScatter

source

PETSc.LibPETSc.VecStrideScatterAll — Method

VecStrideScatterAll(petsclib::PetscLibType, s::Vector{<:AbstractPetscVec}, v::AbstractPetscVec, addv::InsertMode)

Scatters all the single components from separate vectors into a multi-component vector.

Collective

Input Parameters:

s - the location where the subvectors are stored
addv - one of ADD_VALUES, INSERT_VALUES, MAX_VALUES

Output Parameter:

v - the multicomponent vector

Level: advanced

See also: Vec, VecStrideNorm(), VecStrideScatter(), VecStrideMin(), VecStrideMax(), VecStrideGather()

External Links

PETSc Manual: Vec/VecStrideScatterAll

source

PETSc.LibPETSc.VecStrideSet — Method

VecStrideSet(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt, s::PetscScalar)

Sets a subvector of a vector defined by a starting point and a stride with a given value

Logically Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)
s - value to set for each entry in that subvector

Level: advanced

See also: Vec, VecNorm(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax(), VecStrideScale()

External Links

PETSc Manual: Vec/VecStrideSet

source

PETSc.LibPETSc.VecStrideSubSetGather — Method

VecStrideSubSetGather(petsclib::PetscLibType, v::AbstractPetscVec, nidx::PetscInt, idxv::Vector{PetscInt}, idxs::Vector{PetscInt}, s::AbstractPetscVec, addv::InsertMode)

Gathers a subset of components from a multi-component vector into another vector.

Collective

Input Parameters:

v - the vector
nidx - the number of indices
idxv - the indices of the components 0 <= idxv[0] ...idxv[nidx-1] < bs(v), they need not be sorted
idxs - the indices of the components 0 <= idxs[0] ...idxs[nidx-1] < bs(s), they need not be sorted, may be null if nidx == bs(s) or is PETSC_DETERMINE
addv - one of ADD_VALUES, INSERT_VALUES, MAX_VALUES

Output Parameter:

s - the location where the subvector is stored

Level: advanced

See also: Vec, VecStrideNorm(), VecStrideScatter(), VecStrideGather(), VecStrideSubSetScatter(), VecStrideMin(), VecStrideMax(), VecStrideGatherAll(), VecStrideScatterAll()

External Links

PETSc Manual: Vec/VecStrideSubSetGather

source

PETSc.LibPETSc.VecStrideSubSetScatter — Method

VecStrideSubSetScatter(petsclib::PetscLibType, s::AbstractPetscVec, nidx::PetscInt, idxs::Vector{PetscInt}, idxv::Vector{PetscInt}, v::AbstractPetscVec, addv::InsertMode)

Scatters components from a vector into a subset of components of a multi-component vector.

Collective

Input Parameters:

s - the smaller-component vector
nidx - the number of indices in idx
idxs - the indices of the components in the smaller-component vector, 0 <= idxs[0] ...idxs[nidx-1] < bs(s) they need not be sorted, may be null if nidx == bs(s) or is PETSC_DETERMINE
idxv - the indices of the components in the larger-component vector, 0 <= idx[0] ...idx[nidx-1] < bs(v) they need not be sorted
addv - one of ADD_VALUES, INSERT_VALUES, MAX_VALUES

Output Parameter:

v - the location where the subvector is into scattered (the multi-component vector)

Level: advanced

See also: Vec, VecStrideNorm(), VecStrideGather(), VecStrideSubSetGather(), VecStrideMin(), VecStrideMax(), VecStrideGatherAll(), VecStrideScatterAll()

External Links

PETSc Manual: Vec/VecStrideSubSetScatter

source

PETSc.LibPETSc.VecStrideSum — Method

sum::PetscScalar = VecStrideSum(petsclib::PetscLibType, v::AbstractPetscVec, start::PetscInt)

Computes the sum of subvector of a vector defined by a starting point and a stride.

Collective

Input Parameters:

v - the vector
start - starting point of the subvector (defined by a stride)

Output Parameter:

sum - the sum

Level: advanced

See also: Vec, VecSum(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideSum

source

PETSc.LibPETSc.VecStrideSumAll — Method

VecStrideSumAll(petsclib::PetscLibType, v::AbstractPetscVec, sums::Vector{PetscScalar})

Computes the sums of subvectors of a vector defined by a stride.

Collective

Input Parameter:

v - the vector

Output Parameter:

sums - the sums

Level: advanced

See also: Vec, VecSum(), VecStrideGather(), VecStrideScatter(), VecStrideMin(), VecStrideMax()

External Links

PETSc Manual: Vec/VecStrideSumAll

source

PETSc.LibPETSc.VecSum — Method

sum::PetscScalar = VecSum(petsclib::PetscLibType, v::AbstractPetscVec)

Computes the sum of all the components of a vector.

Collective

Input Parameter:

v - the vector

Output Parameter:

sum - the result

Level: beginner

See also: Vec, VecMean(), VecNorm()

External Links

PETSc Manual: Vec/VecSum

source

PETSc.LibPETSc.VecSwap — Method

VecSwap(petsclib::PetscLibType, x::AbstractPetscVec, y::AbstractPetscVec)

Swaps the values between two vectors, x and y.

Logically Collective

Input Parameters:

x - the first vector
y - the second vector

Level: advanced