PETSc version 3.16.6
PETSc System routines
PETSc provides a variety of "system" level routines, including parallel file access, synchronized printing to screen.
Beginner - Basic usage
ADD_VALUES
PetscCopyMode
PetscOptionsEnum
CHKERRA
PetscDataType
PetscOptionsEnumArray
CHKERRCXX
PetscDevice
PetscOptionsGetBool
CHKERRQ
PetscDeviceContext
PetscOptionsGetBoolArray
CHKERRXX
PetscDeviceContextCreate
PetscOptionsGetEnum
CHKMEMQ
PetscDeviceContextDestroy
PetscOptionsGetEnumArray
INSERT_VALUES
PetscDeviceContextDuplicate
PetscOptionsGetInt
InsertMode
PetscDeviceContextGetCurrentContext
PetscOptionsGetIntArray
MAX_VALUES
PetscDeviceContextJoinMode
PetscOptionsGetReal
MIN_VALUES
PetscDeviceContextSetCurrentContext
PetscOptionsGetRealArray
MPIU_COMPLEX
PetscDeviceContextSetFromOptions
PetscOptionsGetScalar
MPIU_INT
PetscDeviceContextSetUp
PetscOptionsGetScalarArray
MPIU_REAL
PetscDeviceContextSynchronize
PetscOptionsGetString
MPIU_SCALAR
PetscDeviceContextWaitForContext
PetscOptionsGetStringArray
MPI_Comm
PetscDeviceCreate
PetscOptionsHasName
PETSC_COMM_SELF
PetscDeviceDestroy
PetscOptionsInt
PETSC_COMM_WORLD
PetscDeviceKind
PetscOptionsIntArray
PETSC_DECIDE
PetscErrorCode
PetscOptionsName
PETSC_DEFAULT
PetscFileMode
PetscOptionsRangeInt
PETSC_DETERMINE
PetscFinalize
PetscOptionsReal
PETSC_FALSE
PetscFortranAddr
PetscOptionsRealArray
PETSC_IGNORE
PetscFree
PetscOptionsScalar
PETSC_MPI_THREAD_REQUIRED
PetscGetDate
PetscOptionsScalarArray
PETSC_TRUE
PetscGlobalMinMaxInt
PetscOptionsString
PETSC_i
PetscGlobalMinMaxReal
PetscOptionsStringArray
PetscAbs
PetscHIPInitialize
PetscOptionsViewer
PetscAbsInt
PetscHIPInitializeCheck
PetscRandomSetFromOptions
PetscAbsReal
PetscImaginaryPart
PetscRandomType
PetscBag
PetscInitialize
PetscRandomView
PetscBagDestroy
PetscInitializeFortran
PetscReal
PetscBagLoad
PetscInitialized
PetscRealPart
PetscBagRegisterBool
PetscInt
PetscScalar
PetscBagRegisterBoolArray
PetscIsCloseAtTol
PetscSign
PetscBagRegisterEnum
PetscIsInfReal
PetscSqr
PetscBagRegisterInt
PetscIsNanReal
PetscSubcommSetFromOptions
PetscBagRegisterInt64
PetscIsNormalReal
PetscSubcommView
PetscBagRegisterIntArray
PetscMalloc
SETERRA
PetscBagRegisterReal
PetscMalloc1
SETERRABORT
PetscBagRegisterRealArray
PetscMax
SETERRQ
PetscBagRegisterScalar
PetscMemType
SETERRQ1
PetscBagRegisterString
PetscMin
SETERRQ2
PetscBagSetFromOptions
PetscNew
SETERRQ3
PetscBagView
PetscNot
SETERRQ4
PetscBool
PetscObject
SETERRQ5
PetscCUDAInitialize
PetscObjectDestroy
SETERRQ6
PetscCUDAInitializeCheck
PetscObjectSetFromOptions
SETERRQ7
PetscCalloc
PetscOffset
SETERRQ8
PetscCalloc1
PetscOptionsBool
SETERRQ9
PetscClipInterval
PetscOptionsBoolArray
PetscComplex
PetscOptionsBoundedInt
Intermediate - Setting options for algorithms and data structures
CHKERRABORT
PetscMemoryGetMaximumUsage
PetscSortIntWithArrayPair
CHKERRMPI
PetscMemorySetGetMaximumUsage
PetscSortIntWithDataArray
PETSC_VERSION
PetscMemoryView
PetscSortIntWithPermutation
PetscArraycmp
PetscMemzero
PetscSortIntWithScalarArray
PetscArraycpy
PetscMergeIntArray
PetscSortMPIInt
PetscArraymove
PetscMergeIntArrayPair
PetscSortMPIIntWithArray
PetscArrayzero
PetscMergeMPIIntArray
PetscSortMPIIntWithIntArray
PetscBLASInt
PetscObjectBaseTypeCompare
PetscSortReal
PetscBagCreate
PetscObjectBaseTypeCompareAny
PetscSortRealWithArrayInt
PetscBagGetData
PetscObjectGetName
PetscSortRealWithPermutation
PetscBagGetName
PetscObjectOptionsBegin
PetscSortRemoveDupsInt
PetscBagGetNames
PetscObjectTypeCompare
PetscSortRemoveDupsMPIInt
PetscBagSetName
PetscObjectTypeCompareAny
PetscSortRemoveDupsReal
PetscBagSetOptionsPrefix
PetscObjectView
PetscSortReverseInt
PetscBagViewFromOptions
PetscObjectViewFromOptions
PetscSortSplit
PetscBarrier
PetscOptionsBegin
PetscSortSplitReal
PetscBoxAuthorize
PetscOptionsBoolGroup
PetscSortStrWithPermutation
PetscBoxRefresh
PetscOptionsBoolGroupBegin
PetscSortedInt
PetscBoxUpload
PetscOptionsBoolGroupEnd
PetscSortedMPIInt
PetscCheckDupsInt
PetscOptionsClearValue
PetscSortedReal
PetscCitationsRegister
PetscOptionsEList
PetscSortedRemoveDupsInt
PetscCuBLASInt
PetscOptionsEnd
PetscStartMatlab
PetscDeviceContextFork
PetscOptionsFList
PetscStrArrayDestroy
PetscDeviceContextGetDevice
PetscOptionsGetEList
PetscStrArrayallocpy
PetscDeviceContextGetStreamType
PetscOptionsHead
PetscStrInList
PetscDeviceContextJoin
PetscOptionsInsertArgs
PetscStrNArrayDestroy
PetscDeviceContextQueryIdle
PetscOptionsInsertFileYAML
PetscStrNArrayallocpy
PetscDeviceContextSetDevice
PetscOptionsInsertString
PetscStrToArray
PetscDeviceContextSetStreamType
PetscOptionsInsertStringYAML
PetscStrToArrayDestroy
PetscEnum
PetscOptionsMonitorDefault
PetscStrallocpy
PetscError
PetscOptionsMonitorSet
PetscStrbeginswith
PetscFPrintf
PetscOptionsSetValue
PetscStrcasecmp
PetscFileRetrieve
PetscOptionsTail
PetscStrcat
PetscFindInt
PetscOptionsValidKey
PetscStrchr
PetscFindMPIInt
PetscPClose
PetscStrcmp
PetscFindReal
PetscPOpen
PetscStrcpy
PetscFreeArguments
PetscPOpenSetMachine
PetscStreamType
PetscFunctionBeginUser
PetscPopErrorHandler
PetscStrendswith
PetscGetArgs
PetscPrintf
PetscStrendswithwhich
PetscGetArguments
PetscProcessPlacementView
PetscStrgrt
PetscGetCPUTime
PetscPushErrorHandler
PetscStrlcat
PetscGlobusAuthorize
PetscRandom
PetscStrlen
PetscGlobusGetTransfers
PetscRandomCreate
PetscStrncmp
PetscGlobusUpload
PetscRandomDestroy
PetscStrncpy
PetscGoogleDriveAuthorize
PetscRandomGetInterval
PetscStrrchr
PetscGoogleDriveRefresh
PetscRandomGetSeed
PetscStrreplace
PetscGoogleDriveUpload
PetscRandomGetType
PetscStrrstr
PetscHasExternalPackage
PetscRandomGetValue
PetscStrstr
PetscHeap
PetscRandomGetValueReal
PetscStrtolower
PetscIntSortSemiOrdered
PetscRandomGetValues
PetscStrtoupper
PetscIntSortSemiOrderedWithArray
PetscRandomGetValuesReal
PetscSubcommGetChild
PetscIntView
PetscRandomSeed
PetscSubcommGetContiguousParent
PetscLinearRegression
PetscRandomSetInterval
PetscSubcommGetParent
PetscLs
PetscRandomSetSeed
PetscSubcommSetOptionsPrefix
PetscMPIInt
PetscRandomSetType
PetscSynchronizedFGets
PetscMPIIntSortSemiOrdered
PetscRandomViewFromOptions
PetscSynchronizedFPrintf
PetscMPIIntSortSemiOrderedWithArray
PetscRealSortSemiOrdered
PetscSynchronizedFlush
PetscMallocDump
PetscRealSortSemiOrderedWithArrayInt
PetscSynchronizedPrintf
PetscMallocGetCurrentUsage
PetscRealView
PetscTellMyCell
PetscMallocGetDebug
PetscSNPrintf
PetscTestDirectory
PetscMallocGetMaximumUsage
PetscSNPrintfCount
PetscTestFile
PetscMallocGetStack
PetscScalarView
PetscTextBelt
PetscMatlabEngine
PetscSequentialPhaseBegin
PetscToken
PetscMemcmp
PetscSequentialPhaseEnd
PetscTokenCreate
PetscMemcpy
PetscSleep
PetscTokenDestroy
PetscMemmove
PetscSortInt
PetscTokenFind
PetscMemoryGetCurrentUsage
PetscSortIntWithArray
PetscURLShorten
Advanced - Setting more advanced options and customization
PETSCABORT
PetscLikely
PetscObjectStateSet
PetscAttachDebugger
PetscMPIDataTypeToPetscDataType
PetscObjectsDump
PetscBLASIntCast
PetscMPIIntCast
PetscObjectsGetObject
PetscBT
PetscMallocTraceGet
PetscObjectsView
PetscBinaryClose
PetscMallocTraceSet
PetscOptionsAllUsed
PetscBinaryOpen
PetscMallocValidate
PetscOptionsCreate
PetscBinarySeekType
PetscMallocView
PetscOptionsDestroy
PetscBinaryWrite
PetscMallocViewGet
PetscOptionsGetAll
PetscCheckPointerSetIntensity
PetscMallocViewSet
PetscOptionsGetenv
PetscContainer
PetscMatlabEngineCreate
PetscOptionsHasHelp
PetscContainerCreate
PetscMatlabEngineDestroy
PetscOptionsInsert
PetscContainerDestroy
PetscMatlabEngineEvaluate
PetscOptionsLeft
PetscContainerGetPointer
PetscMatlabEngineGet
PetscOptionsLeftGet
PetscContainerSetPointer
PetscMatlabEngineGetArray
PetscOptionsLeftRestore
PetscContainerSetUserDestroy
PetscMatlabEngineGetOutput
PetscOptionsPop
PetscContainerUserDestroyDefault
PetscMatlabEnginePrintOutput
PetscOptionsPrefixPop
PetscCuBLASIntCast
PetscMatlabEnginePut
PetscOptionsPrefixPush
PetscDLLibrary
PetscMatlabEnginePutArray
PetscOptionsPush
PetscDataTypeFromString
PetscObjectAppendOptionsPrefix
PetscOptionsReject
PetscDataTypeGetSize
PetscObjectComm
PetscOptionsSetAlias
PetscDataTypeToMPIDataType
PetscObjectCompose
PetscOptionsUsed
PetscDetermineInitialFPTrap
PetscObjectComposeFunction
PetscOptionsView
PetscEListFind
PetscObjectDereference
PetscPullJSONValue
PetscEnd
PetscObjectGetComm
PetscPushJSONValue
PetscEnumFind
PetscObjectGetOptions
PetscRandomRegister
PetscErrorType
PetscObjectGetOptionsPrefix
PetscRandomRegisterAll
PetscFPTrapPop
PetscObjectGetReference
PetscRealIntMultTruncate
PetscFPTrapPush
PetscObjectGetType
PetscSAWsBlock
PetscFixFilename
PetscObjectPrependOptionsPrefix
PetscSSLDestroyContext
PetscFunctionList
PetscObjectQuery
PetscSSLInitializeContext
PetscGTE
PetscObjectQueryFunction
PetscSetFPTrap
PetscGetProgramName
PetscObjectReference
PetscSignalHandlerDefault
PetscHTTPRequest
PetscObjectSAWsBlock
PetscSubcomm
PetscHTTPSConnect
PetscObjectSAWsGrantAccess
PetscSubcommCreate
PetscHTTPSRequest
PetscObjectSAWsSetBlock
PetscSubcommDestroy
PetscInitializeNoArguments
PetscObjectSAWsTakeAccess
PetscSubcommSetNumber
PetscIntCast
PetscObjectSetName
PetscSubcommSetType
PetscIntMultError
PetscObjectSetOptions
PetscSubcommSetTypeGeneral
PetscIntMultTruncate
PetscObjectSetOptionsPrefix
PetscUnlikely
PetscIntSumError
PetscObjectSetType
PetscUnlikelyDebug
PetscIntSumTruncate
PetscObjectSetUp
PetscWaitOnError
PetscLTE
PetscObjectStateGet
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
KSPCheckDot
PetscGetTmp
PetscObjectCopyFortranFunctionPointers
KSPCheckNorm
PetscGetUserName
PetscObjectDestroyOptionsHandlers
MPIU_Allreduce
PetscGetVersion
PetscObjectGetClassId
PETSC_HASH_MAP
PetscGetVersionNumber
PetscObjectGetClassName
PETSC_HASH_SET
PetscGetWorkingDirectory
PetscObjectGetFortranCallback
PETSC_MATLAB_ENGINE_
PetscHMapT
PetscObjectGetId
PETSC_MATLAB_ENGINE_SELF
PetscHMapTClear
PetscObjectGetNewTag
PETSC_MATLAB_ENGINE_WORLD
PetscHMapTCreate
PetscObjectGetTabLevel
PetscAbortErrorHandler
PetscHMapTDel
PetscObjectId
PetscAddrAlign
PetscHMapTDestroy
PetscObjectIncrementTabLevel
PetscAttachDebuggerErrorHandler
PetscHMapTDuplicate
PetscObjectInheritPrintedOptions
PetscBinaryRead
PetscHMapTFind
PetscObjectList
PetscBinarySeek
PetscHMapTGet
PetscObjectListAdd
PetscBinarySynchronizedRead
PetscHMapTGetCapacity
PetscObjectListDestroy
PetscBinarySynchronizedSeek
PetscHMapTGetKeys
PetscObjectListDuplicate
PetscBinarySynchronizedWrite
PetscHMapTGetPairs
PetscObjectListFind
PetscBuildTwoSidedType
PetscHMapTGetSize
PetscObjectListRemoveReference
PetscCalloc2
PetscHMapTGetVals
PetscObjectListReverseFind
PetscCalloc3
PetscHMapTHas
PetscObjectName
PetscCalloc4
PetscHMapTIterDel
PetscObjectPrintClassNamePrefixType
PetscCalloc5
PetscHMapTIterGet
PetscObjectProcessOptionsHandlers
PetscCalloc6
PetscHMapTIterSet
PetscObjectRegisterDestroy
PetscCalloc7
PetscHMapTPut
PetscObjectRegisterDestroyAll
PetscCheckPointer
PetscHMapTQueryDel
PetscObjectSetFortranCallback
PetscClassId
PetscHMapTQuerySet
PetscObjectSetPrintedOptions
PetscCommBuildTwoSided
PetscHMapTReset
PetscObjectSetTabLevel
PetscCommBuildTwoSidedF
PetscHMapTResize
PetscObjectState
PetscCommBuildTwoSidedFReq
PetscHMapTSet
PetscObjectStateIncrease
PetscCommBuildTwoSidedGetType
PetscHSetT
PetscObjectsListGetGlobalNumbering
PetscCommBuildTwoSidedSetType
PetscHSetTAdd
PetscOffloadMask
PetscCommDestroy
PetscHSetTClear
PetscOmpCtrlBarrier
PetscCommDuplicate
PetscHSetTCreate
PetscOmpCtrlCreate
PetscCommGetNewTag
PetscHSetTDel
PetscOmpCtrlDestroy
PetscDLAddr
PetscHSetTDestroy
PetscOmpCtrlGetOmpComms
PetscDLClose
PetscHSetTDuplicate
PetscOmpCtrlOmpRegionOnMasterBegin
PetscDLLibraryAppend
PetscHSetTGetCapacity
PetscOmpCtrlOmpRegionOnMasterEnd
PetscDLLibraryClose
PetscHSetTGetElems
PetscOptionsClear
PetscDLLibraryOpen
PetscHSetTGetSize
PetscOptionsDeprecated
PetscDLLibraryPrepend
PetscHSetTHas
PetscOptionsFindPair
PetscDLLibraryRetrieve
PetscHSetTQueryAdd
PetscOptionsInsertFile
PetscDLLibrarySym
PetscHSetTQueryDel
PetscParallelSortedInt
PetscDLOpen
PetscHSetTReset
PetscPopSignalHandler
PetscDLSym
PetscHSetTResize
PetscPrefetchBlock
PetscDefined
PetscHSetTUpdate
PetscProcessTree
PetscDeviceConfigure
PetscHeaderCreate
PetscPushSignalHandler
PetscDeviceFinalizePackage
PetscHeaderDestroy
PetscRandomFinalizePackage
PetscDeviceInitializePackage
PetscHelpPrintf
PetscRandomInitializePackage
PetscElementalFinalizePackage
PetscIgnoreErrorHandler
PetscRealloc
PetscElementalInitializePackage
PetscLogDouble
PetscRegisterFinalize
PetscElementalInitialized
PetscMPIAbortErrorHandler
PetscRegisterFinalizeAll
PetscEmacsClientErrorHandler
PetscMPIDump
PetscReturnErrorHandler
PetscEqualReal
PetscMPIFortranDatatypeToC
PetscSSEIsEnabled
PetscEqualScalar
PetscMalloc2
PetscSegBuffer
PetscErrorMessage
PetscMalloc3
PetscSegBufferCreate
PetscErrorPrintf
PetscMalloc4
PetscSegBufferDestroy
PetscFClose
PetscMalloc5
PetscSegBufferExtractAlloc
PetscFOpen
PetscMalloc6
PetscSegBufferExtractInPlace
PetscFinalized
PetscMalloc7
PetscSegBufferExtractTo
PetscFormatConvert
PetscMallocA
PetscSegBufferGet
PetscFormatConvertGetSize
PetscMallocClear
PetscSegBufferGetSize
PetscFormatStrip
PetscMallocLogRequestedSizeGet
PetscSegBufferUnuse
PetscFortranCallbackGetSizes
PetscMallocLogRequestedSizeSet
PetscSetDebugTerminal
PetscFortranCallbackRegister
PetscMallocPopMaximumUsage
PetscSetDebugger
PetscFree2
PetscMallocPushMaximumUsage
PetscSetDebuggerFromString
PetscFree3
PetscMallocResetCUDAHost
PetscSetDefaultDebugger
PetscFree4
PetscMallocResetDRAM
PetscSetHelpVersionFunctions
PetscFree5
PetscMallocResetHIPHost
PetscSharedTmp
PetscFree6
PetscMallocSet
PetscSharedWorkingDirectory
PetscFree7
PetscMallocSetCUDAHost
PetscShmCommGet
PetscFreeA
PetscMallocSetCoalesce
PetscShmCommGetMpiShmComm
PetscFunctionBegin
PetscMallocSetDRAM
PetscShmCommGlobalToLocal
PetscFunctionBeginHot
PetscMallocSetDebug
PetscShmCommLocalToGlobal
PetscFunctionListAdd
PetscMallocSetHIPHost
PetscSignalSegvCheckPointerOrMpi
PetscFunctionListDestroy
PetscMkdtemp
PetscSplitOwnership
PetscFunctionListDuplicate
PetscNewLog
PetscSplitOwnershipBlock
PetscFunctionListFind
PetscObjectAddOptionsHandler
PetscSplitOwnershipEqual
PetscFunctionListGet
PetscObjectCompareId
PetscStackSAWsGrantAccess
PetscFunctionListPrintTypes
PetscObjectComposedDataGetInt
PetscStackSAWsTakeAccess
PetscFunctionListView
PetscObjectComposedDataGetIntstar
PetscStopForDebugger
PetscFunctionReturn
PetscObjectComposedDataGetReal
PetscTimSort
PetscGatherMessageLengths
PetscObjectComposedDataGetRealstar
PetscTimSortWithArray
PetscGatherMessageLengths2
PetscObjectComposedDataGetScalar
PetscTime
PetscGatherNumberOfMessages
PetscObjectComposedDataGetScalarstar
PetscTimeAdd
PetscGetArchType
PetscObjectComposedDataRegister
PetscTimeSubtract
PetscGetFullPath
PetscObjectComposedDataSetInt
PetscTraceBackErrorHandler
PetscGetHomeDirectory
PetscObjectComposedDataSetIntstar
PetscVFPrintf
PetscGetHostName
PetscObjectComposedDataSetReal
PetscVSNPrintf
PetscGetPetscDir
PetscObjectComposedDataSetRealstar
SETERRMPI
PetscGetRealPath
PetscObjectComposedDataSetScalar
PetscGetRelativePath
PetscObjectComposedDataSetScalarstar
No deprecated routines
Table of Contents