PETSc version 3.17.2

PETSc System routines

PETSc provides a variety of "system" level routines, including parallel file access, synchronized printing to screen.

Beginner - Basic usage
ADD_VALUES PetscCheck PetscMin
CHKERRA PetscClipInterval PetscNew
CHKMEMQ PetscCompl PetscNot
INSERT_VALUES PetscComplex PetscObject
InsertMode PetscConcat PetscObjectDestroy
MAX_VALUES PetscCopyMode PetscObjectSetFromOptions
MIN_VALUES PetscDataType PetscOffset
MPIU_COMPLEX PetscDevice PetscOptionsBool
MPIU_INT PetscDeviceConfigure PetscOptionsBoolArray
MPIU_REAL PetscDeviceContext PetscOptionsBoundedInt
MPIU_SCALAR PetscDeviceContextCreate PetscOptionsEnum
MPI_Comm PetscDeviceContextDestroy PetscOptionsEnumArray
PETSC_COMM_SELF PetscDeviceContextDuplicate PetscOptionsGetBool
PETSC_COMM_WORLD PetscDeviceContextGetCurrentContext PetscOptionsGetBoolArray
PETSC_CONSTEXPR_14 PetscDeviceContextJoinMode PetscOptionsGetEnum
PETSC_DECIDE PetscDeviceContextSetCurrentContext PetscOptionsGetEnumArray
PETSC_DEFAULT PetscDeviceContextSetFromOptions PetscOptionsGetInt
PETSC_DETERMINE PetscDeviceContextSetUp PetscOptionsGetIntArray
PETSC_FALSE PetscDeviceContextSynchronize PetscOptionsGetReal
PETSC_IGNORE PetscDeviceContextWaitForContext PetscOptionsGetRealArray
PETSC_MPI_THREAD_REQUIRED PetscDeviceCreate PetscOptionsGetScalar
PETSC_NODISCARD PetscDeviceDestroy PetscOptionsGetScalarArray
PETSC_NULLPTR PetscDeviceGetDeviceId PetscOptionsGetString
PETSC_TRUE PetscDeviceInitType PetscOptionsGetStringArray
PETSC_i PetscDeviceInitialize PetscOptionsHasName
PetscAbs PetscDeviceInitialized PetscOptionsInt
PetscAbsInt PetscDeviceType PetscOptionsIntArray
PetscAbsReal PetscDeviceView PetscOptionsName
PetscAssert PetscErrorCode PetscOptionsRangeInt
PetscBag PetscExpand PetscOptionsReal
PetscBagDestroy PetscExpandToNothing PetscOptionsRealArray
PetscBagLoad PetscFileMode PetscOptionsScalar
PetscBagRegisterBool PetscFinalize PetscOptionsScalarArray
PetscBagRegisterBoolArray PetscFortranAddr PetscOptionsString
PetscBagRegisterEnum PetscFree PetscOptionsStringArray
PetscBagRegisterInt PetscGetDate PetscOptionsViewer
PetscBagRegisterInt64 PetscGlobalMinMaxInt PetscRandomSetFromOptions
PetscBagRegisterIntArray PetscGlobalMinMaxReal PetscRandomType
PetscBagRegisterReal PetscImaginaryPart PetscRandomView
PetscBagRegisterRealArray PetscInitialize PetscReal
PetscBagRegisterScalar PetscInitializeFortran PetscRealPart
PetscBagRegisterString PetscInitialized PetscScalar
PetscBagSetFromOptions PetscInt PetscSign
PetscBagView PetscIsCloseAtTol PetscSqr
PetscBool PetscIsInfReal PetscStringize
PetscCall PetscIsNanReal PetscSubcommSetFromOptions
PetscCallCXX PetscIsNormalReal PetscSubcommView
PetscCallMPI PetscMalloc SETERRA
PetscCallThrow PetscMalloc1 SETERRABORT
PetscCalloc PetscMax SETERRQ
PetscCalloc1 PetscMemType
Intermediate - Setting options for algorithms and data structures
PETSC_ATTRIBUTE_COLD PetscMemoryGetCurrentUsage PetscSortIntWithCountArray
PETSC_VERSION PetscMemoryGetMaximumUsage PetscSortIntWithDataArray
PetscArraycmp PetscMemorySetGetMaximumUsage PetscSortIntWithIntCountArrayPair
PetscArraycpy PetscMemoryView PetscSortIntWithPermutation
PetscArraymove PetscMemzero PetscSortIntWithScalarArray
PetscArrayzero PetscMergeIntArray PetscSortMPIInt
PetscBLASInt PetscMergeIntArrayPair PetscSortMPIIntWithArray
PetscBagCreate PetscMergeMPIIntArray PetscSortMPIIntWithIntArray
PetscBagGetData PetscObjectBaseTypeCompare PetscSortReal
PetscBagGetName PetscObjectBaseTypeCompareAny PetscSortRealWithArrayInt
PetscBagGetNames PetscObjectGetName PetscSortRealWithPermutation
PetscBagSetName PetscObjectOptionsBegin PetscSortRemoveDupsInt
PetscBagSetOptionsPrefix PetscObjectTypeCompare PetscSortRemoveDupsMPIInt
PetscBagViewFromOptions PetscObjectTypeCompareAny PetscSortRemoveDupsReal
PetscBarrier PetscObjectView PetscSortReverseInt
PetscBoxAuthorize PetscObjectViewFromOptions PetscSortSplit
PetscBoxRefresh PetscOptionsBegin PetscSortSplitReal
PetscBoxUpload PetscOptionsBoolGroup PetscSortStrWithPermutation
PetscCallAbort PetscOptionsBoolGroupBegin PetscSortedCheckDupsInt
PetscCheckDupsInt PetscOptionsBoolGroupEnd PetscSortedInt
PetscCitationsRegister PetscOptionsClearValue PetscSortedMPIInt
PetscCount PetscOptionsEList PetscSortedReal
PetscCuBLASInt PetscOptionsEnd PetscSortedRemoveDupsInt
PetscDefined PetscOptionsFList PetscStartMatlab
PetscDeviceContextFork PetscOptionsGetEList PetscStrArrayDestroy
PetscDeviceContextGetDevice PetscOptionsHead PetscStrArrayallocpy
PetscDeviceContextGetStreamType PetscOptionsInsertArgs PetscStrInList
PetscDeviceContextJoin PetscOptionsInsertFileYAML PetscStrNArrayDestroy
PetscDeviceContextQueryIdle PetscOptionsInsertString PetscStrNArrayallocpy
PetscDeviceContextSetDevice PetscOptionsInsertStringYAML PetscStrToArray
PetscDeviceContextSetStreamType PetscOptionsMonitorDefault PetscStrToArrayDestroy
PetscEnum PetscOptionsMonitorSet PetscStrallocpy
PetscError PetscOptionsSetValue PetscStrbeginswith
PetscFPrintf PetscOptionsTail PetscStrcasecmp
PetscFileRetrieve PetscOptionsValidKey PetscStrcat
PetscFindInt PetscPClose PetscStrchr
PetscFindMPIInt PetscPOpen PetscStrcmp
PetscFindReal PetscPOpenSetMachine PetscStrcpy
PetscFreeArguments PetscPopErrorHandler PetscStreamType
PetscFunctionBeginUser PetscPrintf PetscStrendswith
PetscGetArgs PetscProcessPlacementView PetscStrendswithwhich
PetscGetArguments PetscPushErrorHandler PetscStrgrt
PetscGetCPUTime PetscRandom PetscStrlcat
PetscGlobusAuthorize PetscRandomCreate PetscStrlen
PetscGlobusGetTransfers PetscRandomDestroy PetscStrncmp
PetscGlobusUpload PetscRandomGetInterval PetscStrncpy
PetscGoogleDriveAuthorize PetscRandomGetSeed PetscStrrchr
PetscGoogleDriveRefresh PetscRandomGetType PetscStrreplace
PetscGoogleDriveUpload PetscRandomGetValue PetscStrrstr
PetscHasAttribute PetscRandomGetValueReal PetscStrstr
PetscHasExternalPackage PetscRandomGetValues PetscStrtolower
PetscHeap PetscRandomGetValuesReal PetscStrtoupper
PetscIntSortSemiOrdered PetscRandomSeed PetscSubcommGetChild
PetscIntSortSemiOrderedWithArray PetscRandomSetInterval PetscSubcommGetContiguousParent
PetscIntView PetscRandomSetSeed PetscSubcommGetParent
PetscLinearRegression PetscRandomSetType PetscSubcommSetOptionsPrefix
PetscLs PetscRandomViewFromOptions PetscSynchronizedFGets
PetscMPIInt PetscRealSortSemiOrdered PetscSynchronizedFPrintf
PetscMPIIntSortSemiOrdered PetscRealSortSemiOrderedWithArrayInt PetscSynchronizedFlush
PetscMPIIntSortSemiOrderedWithArray PetscRealView PetscSynchronizedPrintf
PetscMacroReturns PetscSNPrintf PetscTellMyCell
PetscMallocDump PetscSNPrintfCount PetscTestDirectory
PetscMallocGetCurrentUsage PetscScalarView PetscTestFile
PetscMallocGetDebug PetscSequentialPhaseBegin PetscTextBelt
PetscMallocGetMaximumUsage PetscSequentialPhaseEnd PetscToken
PetscMallocGetStack PetscSizeT PetscTokenCreate
PetscMatlabEngine PetscSleep PetscTokenDestroy
PetscMemcmp PetscSortInt PetscTokenFind
PetscMemcpy PetscSortIntWithArray PetscURLShorten
PetscMemmove PetscSortIntWithArrayPair
Advanced - Setting more advanced options and customization
PETSCABORT PetscIntSumTruncate PetscObjectStateSet
PetscApproximateGTE PetscLikely PetscObjectsDump
PetscApproximateLTE PetscMPIDataTypeToPetscDataType PetscObjectsGetObject
PetscAttachDebugger PetscMPIIntCast PetscObjectsView
PetscBLASIntCast PetscMallocTraceGet PetscOptionsAllUsed
PetscBT PetscMallocTraceSet PetscOptionsCreate
PetscBinaryClose PetscMallocValidate PetscOptionsDestroy
PetscBinaryOpen PetscMallocView PetscOptionsGetAll
PetscBinarySeekType PetscMallocViewGet PetscOptionsGetenv
PetscBinaryWrite PetscMallocViewSet PetscOptionsHasHelp
PetscCeilInt PetscMatlabEngineCreate PetscOptionsInsert
PetscCheckPointerSetIntensity PetscMatlabEngineDestroy PetscOptionsLeft
PetscContainer PetscMatlabEngineEvaluate PetscOptionsLeftGet
PetscContainerCreate PetscMatlabEngineGet PetscOptionsLeftRestore
PetscContainerDestroy PetscMatlabEngineGetArray PetscOptionsPop
PetscContainerGetPointer PetscMatlabEngineGetOutput PetscOptionsPrefixPop
PetscContainerSetPointer PetscMatlabEnginePrintOutput PetscOptionsPrefixPush
PetscContainerSetUserDestroy PetscMatlabEnginePut PetscOptionsPush
PetscContainerUserDestroyDefault PetscMatlabEnginePutArray PetscOptionsReject
PetscCountCast PetscObjectAppendOptionsPrefix PetscOptionsSetAlias
PetscCuBLASIntCast PetscObjectComm PetscOptionsUsed
PetscDLLibrary PetscObjectCompose PetscOptionsView
PetscDataTypeFromString PetscObjectComposeFunction PetscPullJSONValue
PetscDataTypeGetSize PetscObjectDereference PetscPushJSONValue
PetscDataTypeToMPIDataType PetscObjectGetComm PetscRandomRegister
PetscDetermineInitialFPTrap PetscObjectGetOptions PetscRandomRegisterAll
PetscEListFind PetscObjectGetOptionsPrefix PetscRealIntMultTruncate
PetscEnd PetscObjectGetReference PetscSAWsBlock
PetscEnumFind PetscObjectGetType PetscSSLDestroyContext
PetscErrorType PetscObjectPrependOptionsPrefix PetscSSLInitializeContext
PetscFPTrapPop PetscObjectQuery PetscSetFPTrap
PetscFPTrapPush PetscObjectQueryFunction PetscSignalHandlerDefault
PetscFixFilename PetscObjectReference PetscSubcomm
PetscFunctionList PetscObjectSAWsBlock PetscSubcommCreate
PetscGetProgramName PetscObjectSAWsGrantAccess PetscSubcommDestroy
PetscHTTPRequest PetscObjectSAWsSetBlock PetscSubcommSetNumber
PetscHTTPSConnect PetscObjectSAWsTakeAccess PetscSubcommSetType
PetscHTTPSRequest PetscObjectSetName PetscSubcommSetTypeGeneral
PetscInitializeNoArguments PetscObjectSetOptions PetscUnlikely
PetscIntCast PetscObjectSetOptionsPrefix PetscUnlikelyDebug
PetscIntMultError PetscObjectSetType PetscUnreachable
PetscIntMultTruncate PetscObjectSetUp PetscWaitOnError
PetscIntSumError 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
PetscCommGetComm PetscHSetTDel PetscOmpCtrlDestroy
PetscCommGetNewTag PetscHSetTDestroy PetscOmpCtrlGetOmpComms
PetscCommRestoreComm PetscHSetTDuplicate PetscOmpCtrlOmpRegionOnMasterBegin
PetscDLAddr PetscHSetTGetCapacity PetscOmpCtrlOmpRegionOnMasterEnd
PetscDLClose PetscHSetTGetElems PetscOptionsClear
PetscDLLibraryAppend PetscHSetTGetSize PetscOptionsDeprecated
PetscDLLibraryClose PetscHSetTHas PetscOptionsFindPair
PetscDLLibraryOpen PetscHSetTQueryAdd PetscOptionsInsertFile
PetscDLLibraryPrepend PetscHSetTQueryDel PetscParallelSortedInt
PetscDLLibraryRetrieve PetscHSetTReset PetscPopSignalHandler
PetscDLLibrarySym PetscHSetTResize PetscPrefetchBlock
PetscDLOpen PetscHSetTUpdate PetscProcessTree
PetscDLSym 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
Deprecated - Functionality scheduled for removal in future versions
CHKERRABORT CHKERRMPI CHKERRXX
CHKERRCXX CHKERRQ PetscCheckFalse

Table of Contents