Vector Operations (Vec)

PETSc vectors (Vec) are used to store the field variables in PDE-based (or other) simulations. Users guide chapter: Vectors and Parallel Data

Examples

Manual Pages by Level

Beginner - Basic usage

NORM_1 NORM_1_AND_2 NORM_2 NORM_FROBENIUS NORM_INFINITY NORM_MAX NormType REDUCTION_MEAN_IMAGINARYPART REDUCTION_MEAN_REALPART REDUCTION_SUM_IMAGINARYPART REDUCTION_SUM_REALPART ReductionType SCATTER_FORWARD SCATTER_REVERSE ScatterMode VECCUDA VECHIP VECKOKKOS VECMPI VECMPICUDA VECMPIHIP VECMPIKOKKOS VECMPIVIENNACL VECSEQ VECSEQKOKKOS VECSEQVIENNACL VECSTANDARD VECVIENNACL Vec VecAssemblyBegin

VecAssemblyEnd VecCopy VecCreate VecCreateLocalVector VecDestroy VecDestroyVecsF90 VecDuplicate VecDuplicateVecsF90 VecExp VecGetArray VecGetArray4dRead VecGetArrayAndMemType VecGetArrayF90 VecGetArrayRead VecGetArrayReadAndMemType VecGetArrayReadF90 VecGetArrayWriteAndMemType VecGetKokkosView VecGetKokkosViewWrite VecGetLocalSize VecGetLocalVector VecGetLocalVectorRead VecGetOwnershipRange VecGetOwnershipRanges VecGetSize VecGetValues VecImaginaryPart VecLog VecMean

VecPermute VecRealPart VecRestoreArray VecRestoreArray4dRead VecRestoreArrayAndMemType VecRestoreArrayF90 VecRestoreArrayRead VecRestoreArrayReadAndMemType VecRestoreArrayReadF90 VecRestoreArrayWrite VecRestoreArrayWriteAndMemType VecRestoreKokkosView VecRestoreKokkosViewWrite VecRestoreLocalVector VecRestoreLocalVectorRead VecSet VecSetFromOptions VecSetPreallocationCOO VecSetPreallocationCOOLocal VecSetValue VecSetValueLocal VecSetValues VecSetValuesCOO VecSqrtAbs VecSum VecTaggerBox VecType VecView VecZeroEntries

Intermediate - Setting options for algorithms and data structures

PetscSectionVecNorm VECNEST VecAXPBY VecAXPBYPCZ VecAXPY VecAYPX VecAbs VecBindToCPU VecBoundToCPU VecCUDAGetArray VecCUDAGetArrayRead VecCUDARestoreArray VecCUDARestoreArrayRead VecCUDARestoreArrayWrite VecChop VecConjugate VecCreateMPI VecCreateMPICUDA VecCreateMPICUDAWithArray VecCreateMPICUDAWithArrays VecCreateMPIHIP VecCreateMPIHIPWithArray VecCreateMPIHIPWithArrays VecCreateMPIKokkosWithArray VecCreateMPIViennaCLWithArray VecCreateMPIViennaCLWithArrays VecCreateMPIWithArray VecCreateSeq VecCreateSeqCUDA VecCreateSeqCUDAWithArrays VecCreateSeqHIP

VecCreateSeqHIPWithArrays VecCreateSeqKokkos VecCreateSeqKokkosWithArray VecCreateSeqViennaCL VecCreateSeqViennaCLWithArray VecCreateSeqViennaCLWithArrays VecCreateSeqWithArray VecDestroyVecs VecDot VecDotRealPart VecDuplicateVecs VecEqual VecGetArrayWrite VecGetArrays VecGetOffloadMask VecGetType VecHIPGetArray VecHIPGetArrayRead VecHIPRestoreArray VecHIPRestoreArrayRead VecHIPRestoreArrayWrite VecLoad VecLockReadPop VecLockReadPush VecLockWriteSet VecMAXPY VecMDot VecMTDot VecMax VecMin VecNorm

VecNormAvailable VecNormalize VecPow VecReciprocal VecRestoreArrays VecScale VecSetLocalToGlobalMapping VecSetOption VecSetRandom VecSetSizes VecSetType VecSetValuesBlocked VecSetValuesBlockedLocal VecSetValuesLocal VecShift VecStashSetInitialSize VecStashViewFromOptions VecStepMaxBounded VecTDot VecUniqueEntries VecViennaCLGetCLContext VecViennaCLGetCLMem VecViennaCLGetCLMemRead VecViennaCLGetCLMemWrite VecViennaCLGetCLQueue VecViennaCLPlaceArray VecViennaCLRestoreCLMem VecViennaCLRestoreCLMemWrite VecViewFromOptions VecWAXPY

Advanced - Setting more advanced options and customization

ISComplementVec PetscCommSplitReductionBegin VecAppendOptionsPrefix VecBoundGradientProjection VecCUDAGetArrayWrite VecCUDAPlaceArray VecCUDAReplaceArray VecCUDAResetArray VecConcatenate VecCreateGhost VecCreateGhostBlock VecCreateGhostBlockWithArray VecCreateGhostWithArray VecCreateNest VecCreateShared VecDotBegin VecDotEnd VecDotNorm2 VecGetArrayAligned VecGetBlockSize VecGetLocalToGlobalMapping VecGetOptionsPrefix VecGetSubVector VecGhostGetLocalForm VecGhostIsLocalForm VecGhostRestoreLocalForm VecGhostUpdateBegin VecGhostUpdateEnd VecHIPGetArrayWrite VecHIPPlaceArray VecHIPReplaceArray VecHIPResetArray VecISAXPY VecISCopy VecISSet VecLockGet VecMDotBegin VecMDotEnd VecMPISetGhost VecMTDotBegin VecMTDotEnd

VecMaxPointwiseDivide VecMedian VecNormBegin VecNormEnd VecOperation VecPointwiseDivide VecPointwiseMax VecPointwiseMaxAbs VecPointwiseMin VecPointwiseMult VecRegister VecRegisterAll VecRestoreSubVector VecSetBlockSize VecSetOperation VecSetOptionsPrefix VecSetUp VecStashGetInfo VecStashView VecStepBoundInfo VecStepMax VecStrideGather VecStrideGatherAll VecStrideMax VecStrideMaxAll VecStrideMin VecStrideMinAll VecStrideNorm VecStrideNormAll VecStrideScale VecStrideScaleAll VecStrideScatter VecStrideScatterAll VecStrideSet VecStrideSubSetGather VecStrideSubSetScatter VecStrideSum VecStrideSumAll VecSwap VecTDotBegin

VecTDotEnd VecTagger VecTaggerAbsoluteGetBox VecTaggerAbsoluteSetBox VecTaggerAndGetSubs VecTaggerAndSetSubs VecTaggerCDFGetBox VecTaggerCDFGetMethod VecTaggerCDFIterativeGetTolerances VecTaggerCDFIterativeSetTolerances VecTaggerCDFMethod VecTaggerCDFSetBox VecTaggerCDFSetMethod VecTaggerComputeBoxes VecTaggerComputeIS VecTaggerCreate VecTaggerDestroy VecTaggerGetBlockSize VecTaggerGetInvert VecTaggerGetType VecTaggerOrGetSubs VecTaggerOrSetSubs VecTaggerRegister VecTaggerRegisterAll VecTaggerRelativeGetBox VecTaggerRelativeSetBox VecTaggerSetBlockSize VecTaggerSetFromOptions VecTaggerSetInvert VecTaggerSetType VecTaggerSetUp VecTaggerType VecTaggerView VecWhichBetween VecWhichBetweenOrEqual VecWhichEqual VecWhichGreaterThan VecWhichInactive VecWhichLessThan Vecs

Developer - Interfaces rarely needed by applications programmers

ISFinalizePackage ISInitializePackage PetscSectionVecView SCATTER_FORWARD_LOCAL SCATTER_REVERSE_LOCAL VecCheckAssembled VecFinalizePackage VecGetArray1d VecGetArray1dRead VecGetArray1dWrite VecGetArray2d VecGetArray2dRead VecGetArray2dWrite VecGetArray3d VecGetArray3dRead VecGetArray3dWrite VecGetArray4d VecGetArray4dWrite

VecGetArrayPair VecGetBindingPropagates VecGetLayout VecGetPinnedMemoryMin VecGetValuesSection VecInitializePackage VecNestGetSize VecNestGetSubVec VecNestGetSubVecs VecNestSetSubVec VecNestSetSubVecs VecPlaceArray VecReplaceArray VecResetArray VecRestoreArray1d VecRestoreArray1dRead VecRestoreArray1dWrite

VecRestoreArray2d VecRestoreArray2dRead VecRestoreArray2dWrite VecRestoreArray3d VecRestoreArray3dRead VecRestoreArray3dWrite VecRestoreArray4d VecRestoreArray4dWrite VecRestoreArrayPair VecSetBindingPropagates VecSetLayout VecSetPinnedMemoryMin VecSetValuesSection VecTaggerFinalizePackage VecTaggerInitializePackage VecViennaCLResetArray VecViewNative

Deprecated - Functionality scheduled for removal in the future

VecLockPop

VecLockPush

Single list of manual pages

ISComplementVec ISFinalizePackage ISInitializePackage NORM_1 NORM_1_AND_2 NORM_2 NORM_FROBENIUS NORM_INFINITY NORM_MAX NormType PetscCommSplitReductionBegin PetscSectionVecNorm PetscSectionVecView REDUCTION_MEAN_IMAGINARYPART REDUCTION_MEAN_REALPART REDUCTION_SUM_IMAGINARYPART REDUCTION_SUM_REALPART ReductionType SCATTER_FORWARD SCATTER_FORWARD_LOCAL SCATTER_REVERSE SCATTER_REVERSE_LOCAL ScatterMode VECCUDA VECHIP VECKOKKOS VECMPI VECMPICUDA VECMPIHIP VECMPIKOKKOS VECMPIVIENNACL VECNEST VECSEQ VECSEQKOKKOS VECSEQVIENNACL VECSTANDARD VECVIENNACL Vec VecAXPBY VecAXPBYPCZ VecAXPY VecAYPX VecAbs VecAppendOptionsPrefix VecAssemblyBegin VecAssemblyEnd VecBindToCPU VecBoundGradientProjection VecBoundToCPU VecCUDAGetArray VecCUDAGetArrayRead VecCUDAGetArrayWrite VecCUDAPlaceArray VecCUDAReplaceArray VecCUDAResetArray VecCUDARestoreArray VecCUDARestoreArrayRead VecCUDARestoreArrayWrite VecCheckAssembled VecChop VecConcatenate VecConjugate VecCopy VecCreate VecCreateGhost VecCreateGhostBlock VecCreateGhostBlockWithArray VecCreateGhostWithArray VecCreateLocalVector VecCreateMPI VecCreateMPICUDA VecCreateMPICUDAWithArray VecCreateMPICUDAWithArrays VecCreateMPIHIP VecCreateMPIHIPWithArray VecCreateMPIHIPWithArrays VecCreateMPIKokkosWithArray VecCreateMPIViennaCLWithArray VecCreateMPIViennaCLWithArrays VecCreateMPIWithArray VecCreateNest VecCreateSeq VecCreateSeqCUDA VecCreateSeqCUDAWithArrays VecCreateSeqHIP VecCreateSeqHIPWithArrays VecCreateSeqKokkos VecCreateSeqKokkosWithArray VecCreateSeqViennaCL VecCreateSeqViennaCLWithArray VecCreateSeqViennaCLWithArrays VecCreateSeqWithArray VecCreateShared VecDestroy VecDestroyVecs VecDestroyVecsF90 VecDot VecDotBegin VecDotEnd VecDotNorm2 VecDotRealPart VecDuplicate VecDuplicateVecs VecDuplicateVecsF90 VecEqual VecExp VecFinalizePackage VecGetArray VecGetArray1d VecGetArray1dRead VecGetArray1dWrite VecGetArray2d VecGetArray2dRead VecGetArray2dWrite VecGetArray3d VecGetArray3dRead VecGetArray3dWrite VecGetArray4d VecGetArray4dRead

VecGetArray4dWrite VecGetArrayAligned VecGetArrayAndMemType VecGetArrayF90 VecGetArrayPair VecGetArrayRead VecGetArrayReadAndMemType VecGetArrayReadF90 VecGetArrayWrite VecGetArrayWriteAndMemType VecGetArrays VecGetBindingPropagates VecGetBlockSize VecGetKokkosView VecGetKokkosViewWrite VecGetLayout VecGetLocalSize VecGetLocalToGlobalMapping VecGetLocalVector VecGetLocalVectorRead VecGetOffloadMask VecGetOptionsPrefix VecGetOwnershipRange VecGetOwnershipRanges VecGetPinnedMemoryMin VecGetSize VecGetSubVector VecGetType VecGetValues VecGetValuesSection VecGhostGetLocalForm VecGhostIsLocalForm VecGhostRestoreLocalForm VecGhostUpdateBegin VecGhostUpdateEnd VecHIPGetArray VecHIPGetArrayRead VecHIPGetArrayWrite VecHIPPlaceArray VecHIPReplaceArray VecHIPResetArray VecHIPRestoreArray VecHIPRestoreArrayRead VecHIPRestoreArrayWrite VecISAXPY VecISCopy VecISSet VecImaginaryPart VecInitializePackage VecLoad VecLockGet VecLockPop VecLockPush VecLockReadPop VecLockReadPush VecLockWriteSet VecLog VecMAXPY VecMDot VecMDotBegin VecMDotEnd VecMPISetGhost VecMTDot VecMTDotBegin VecMTDotEnd VecMax VecMaxPointwiseDivide VecMean VecMedian VecMin VecNestGetSize VecNestGetSubVec VecNestGetSubVecs VecNestSetSubVec VecNestSetSubVecs VecNorm VecNormAvailable VecNormBegin VecNormEnd VecNormalize VecOperation VecPermute VecPlaceArray VecPointwiseDivide VecPointwiseMax VecPointwiseMaxAbs VecPointwiseMin VecPointwiseMult VecPow VecRealPart VecReciprocal VecRegister VecRegisterAll VecReplaceArray VecResetArray VecRestoreArray VecRestoreArray1d VecRestoreArray1dRead VecRestoreArray1dWrite VecRestoreArray2d VecRestoreArray2dRead VecRestoreArray2dWrite VecRestoreArray3d VecRestoreArray3dRead VecRestoreArray3dWrite VecRestoreArray4d VecRestoreArray4dRead VecRestoreArray4dWrite VecRestoreArrayAndMemType VecRestoreArrayF90 VecRestoreArrayPair VecRestoreArrayRead VecRestoreArrayReadAndMemType VecRestoreArrayReadF90 VecRestoreArrayWrite VecRestoreArrayWriteAndMemType VecRestoreArrays VecRestoreKokkosView

VecRestoreKokkosViewWrite VecRestoreLocalVector VecRestoreLocalVectorRead VecRestoreSubVector VecScale VecSet VecSetBindingPropagates VecSetBlockSize VecSetFromOptions VecSetLayout VecSetLocalToGlobalMapping VecSetOperation VecSetOption VecSetOptionsPrefix VecSetPinnedMemoryMin VecSetPreallocationCOO VecSetPreallocationCOOLocal VecSetRandom VecSetSizes VecSetType VecSetUp VecSetValue VecSetValueLocal VecSetValues VecSetValuesBlocked VecSetValuesBlockedLocal VecSetValuesCOO VecSetValuesLocal VecSetValuesSection VecShift VecSqrtAbs VecStashGetInfo VecStashSetInitialSize VecStashView VecStashViewFromOptions VecStepBoundInfo VecStepMax VecStepMaxBounded VecStrideGather VecStrideGatherAll VecStrideMax VecStrideMaxAll VecStrideMin VecStrideMinAll VecStrideNorm VecStrideNormAll VecStrideScale VecStrideScaleAll VecStrideScatter VecStrideScatterAll VecStrideSet VecStrideSubSetGather VecStrideSubSetScatter VecStrideSum VecStrideSumAll VecSum VecSwap VecTDot VecTDotBegin VecTDotEnd VecTagger VecTaggerAbsoluteGetBox VecTaggerAbsoluteSetBox VecTaggerAndGetSubs VecTaggerAndSetSubs VecTaggerBox VecTaggerCDFGetBox VecTaggerCDFGetMethod VecTaggerCDFIterativeGetTolerances VecTaggerCDFIterativeSetTolerances VecTaggerCDFMethod VecTaggerCDFSetBox VecTaggerCDFSetMethod VecTaggerComputeBoxes VecTaggerComputeIS VecTaggerCreate VecTaggerDestroy VecTaggerFinalizePackage VecTaggerGetBlockSize VecTaggerGetInvert VecTaggerGetType VecTaggerInitializePackage VecTaggerOrGetSubs VecTaggerOrSetSubs VecTaggerRegister VecTaggerRegisterAll VecTaggerRelativeGetBox VecTaggerRelativeSetBox VecTaggerSetBlockSize VecTaggerSetFromOptions VecTaggerSetInvert VecTaggerSetType VecTaggerSetUp VecTaggerType VecTaggerView VecType VecUniqueEntries VecViennaCLGetCLContext VecViennaCLGetCLMem VecViennaCLGetCLMemRead VecViennaCLGetCLMemWrite VecViennaCLGetCLQueue VecViennaCLPlaceArray VecViennaCLResetArray VecViennaCLRestoreCLMem VecViennaCLRestoreCLMemWrite VecView VecViewFromOptions VecViewNative VecWAXPY VecWhichBetween VecWhichBetweenOrEqual VecWhichEqual VecWhichGreaterThan VecWhichInactive VecWhichLessThan VecZeroEntries Vecs