PETSc version 3.16.0

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 PetscOptionsBoundedInt
CHKERRCXX PetscDataType PetscOptionsEnum
CHKERRQ PetscDevice PetscOptionsEnumArray
CHKERRXX PetscDeviceContext PetscOptionsGetBool
CHKMEMQ PetscDeviceContextCreate PetscOptionsGetBoolArray
INSERT_VALUES PetscDeviceContextDestroy PetscOptionsGetEnum
InsertMode PetscDeviceContextDuplicate PetscOptionsGetEnumArray
MAX_VALUES PetscDeviceContextGetCurrentContext PetscOptionsGetInt
MIN_VALUES PetscDeviceContextJoinMode PetscOptionsGetIntArray
MPIU_COMPLEX PetscDeviceContextSetCurrentContext PetscOptionsGetReal
MPIU_INT PetscDeviceContextSetFromOptions PetscOptionsGetRealArray
MPIU_REAL PetscDeviceContextSetUp PetscOptionsGetScalar
MPIU_SCALAR PetscDeviceContextSynchronize PetscOptionsGetScalarArray
MPI_Comm PetscDeviceContextWaitForContext PetscOptionsGetString
PETSC_COMM_SELF PetscDeviceCreate PetscOptionsGetStringArray
PETSC_COMM_WORLD PetscDeviceDestroy PetscOptionsHasName
PETSC_DECIDE PetscDeviceKind PetscOptionsInt
PETSC_DEFAULT PetscErrorCode PetscOptionsIntArray
PETSC_DETERMINE PetscFileMode PetscOptionsName
PETSC_FALSE PetscFinalize PetscOptionsRangeInt
PETSC_IGNORE PetscFortranAddr PetscOptionsReal
PETSC_MPI_THREAD_REQUIRED PetscFree PetscOptionsRealArray
PETSC_TRUE PetscGetDate PetscOptionsScalar
PETSC_i PetscGlobalMinMaxInt PetscOptionsScalarArray
PetscAbs PetscGlobalMinMaxReal PetscOptionsString
PetscAbsInt PetscHIPInitialize PetscOptionsStringArray
PetscAbsReal PetscHIPInitializeCheck PetscOptionsViewer
PetscBag PetscImaginaryPart PetscRandomSetFromOptions
PetscBagDestroy PetscInitialize PetscRandomType
PetscBagLoad PetscInitializeFortran PetscRandomView
PetscBagRegisterBool PetscInitialized PetscReal
PetscBagRegisterBoolArray PetscInt PetscRealPart
PetscBagRegisterEnum PetscIsCloseAtTol PetscScalar
PetscBagRegisterInt PetscIsInfReal PetscSign
PetscBagRegisterInt64 PetscIsNanReal PetscSqr
PetscBagRegisterIntArray PetscIsNormalReal PetscSubcommSetFromOptions
PetscBagRegisterReal PetscMalloc PetscSubcommView
PetscBagRegisterRealArray PetscMalloc1 SETERRABORT
PetscBagRegisterScalar PetscMax SETERRQ
PetscBagRegisterString PetscMemType SETERRQ1
PetscBagSetFromOptions PetscMin SETERRQ2
PetscBagView PetscNew SETERRQ3
PetscBool PetscNot SETERRQ4
PetscCUDAInitialize PetscObject SETERRQ5
PetscCUDAInitializeCheck PetscObjectDestroy SETERRQ6
PetscCalloc PetscObjectSetFromOptions SETERRQ7
PetscCalloc1 PetscOffset SETERRQ8
PetscClipInterval PetscOptionsBool SETERRQ9
PetscComplex PetscOptionsBoolArray
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