PETSc version v3.15.4-864-ge36148cd4c

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 PetscMemorySetGetMaximumUsage PetscSortIntWithDataArray
CHKERRMPI PetscMemoryView PetscSortIntWithPermutation
PETSC_VERSION PetscMemzero PetscSortIntWithScalarArray
PetscArraycmp PetscMergeIntArray PetscSortMPIInt
PetscArraycpy PetscMergeIntArrayPair PetscSortMPIIntWithArray
PetscArraymove PetscMergeMPIIntArray PetscSortMPIIntWithIntArray
PetscArrayzero PetscObjectBaseTypeCompare PetscSortReal
PetscBLASInt PetscObjectBaseTypeCompareAny PetscSortRealWithArrayInt
PetscBagCreate PetscObjectGetName PetscSortRealWithPermutation
PetscBagGetData PetscObjectOptionsBegin PetscSortRemoveDupsInt
PetscBagGetName PetscObjectTypeCompare PetscSortRemoveDupsMPIInt
PetscBagGetNames PetscObjectTypeCompareAny PetscSortRemoveDupsReal
PetscBagSetName PetscObjectView PetscSortReverseInt
PetscBagSetOptionsPrefix PetscObjectViewFromOptions PetscSortSplit
PetscBagViewFromOptions PetscOptionsBegin PetscSortSplitReal
PetscBarrier PetscOptionsBoolGroup PetscSortStrWithPermutation
PetscBoxAuthorize PetscOptionsBoolGroupBegin PetscSortedInt
PetscBoxRefresh PetscOptionsBoolGroupEnd PetscSortedMPIInt
PetscBoxUpload PetscOptionsClearValue PetscSortedReal
PetscCheckDupsInt PetscOptionsEList PetscSortedRemoveDupsInt
PetscCitationsRegister PetscOptionsEnd PetscStartMatlab
PetscCuBLASInt PetscOptionsFList PetscStrArrayDestroy
PetscDeviceContextFork 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
PetscMemoryGetMaximumUsage PetscSortIntWithArrayPair
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
Converts PetscGetRelativePath PetscObjectCopyFortranFunctionPointers
KSPCheckDot PetscGetTmp PetscObjectDestroyOptionsHandlers
KSPCheckNorm PetscGetUserName PetscObjectGetClassId
MPIU_Allreduce PetscGetVersion PetscObjectGetClassName
PETSC_HASH_MAP PetscGetVersionNumber PetscObjectGetFortranCallback
PETSC_HASH_SET PetscGetWorkingDirectory PetscObjectGetId
PETSC_MATLAB_ENGINE_ PetscHMapT PetscObjectGetNewTag
PETSC_MATLAB_ENGINE_SELF PetscHMapTClear PetscObjectGetTabLevel
PETSC_MATLAB_ENGINE_WORLD PetscHMapTCreate PetscObjectId
PetscAbortErrorHandler PetscHMapTDel PetscObjectIncrementTabLevel
PetscAddrAlign PetscHMapTDestroy PetscObjectInheritPrintedOptions
PetscAttachDebuggerErrorHandler PetscHMapTDuplicate PetscObjectList
PetscBinaryRead PetscHMapTFind PetscObjectListAdd
PetscBinarySeek PetscHMapTGet PetscObjectListDestroy
PetscBinarySynchronizedRead PetscHMapTGetCapacity PetscObjectListDuplicate
PetscBinarySynchronizedSeek PetscHMapTGetKeys PetscObjectListFind
PetscBinarySynchronizedWrite PetscHMapTGetPairs PetscObjectListRemoveReference
PetscBuildTwoSidedType PetscHMapTGetSize PetscObjectListReverseFind
PetscCalloc2 PetscHMapTGetVals PetscObjectName
PetscCalloc3 PetscHMapTHas PetscObjectPrintClassNamePrefixType
PetscCalloc4 PetscHMapTIterDel PetscObjectProcessOptionsHandlers
PetscCalloc5 PetscHMapTIterGet PetscObjectRegisterDestroy
PetscCalloc6 PetscHMapTIterSet PetscObjectRegisterDestroyAll
PetscCalloc7 PetscHMapTPut PetscObjectSetFortranCallback
PetscCheckPointer PetscHMapTQueryDel PetscObjectSetPrintedOptions
PetscClassId PetscHMapTQuerySet PetscObjectSetTabLevel
PetscCommBuildTwoSided PetscHMapTReset PetscObjectState
PetscCommBuildTwoSidedF PetscHMapTResize PetscObjectStateIncrease
PetscCommBuildTwoSidedFReq PetscHMapTSet PetscObjectsListGetGlobalNumbering
PetscCommBuildTwoSidedGetType PetscHSetT PetscOffloadMask
PetscCommBuildTwoSidedSetType PetscHSetTAdd PetscOmpCtrlBarrier
PetscCommDestroy PetscHSetTClear PetscOmpCtrlCreate
PetscCommDuplicate PetscHSetTCreate PetscOmpCtrlDestroy
PetscCommGetNewTag PetscHSetTDel PetscOmpCtrlGetOmpComms
PetscDLAddr PetscHSetTDestroy PetscOmpCtrlOmpRegionOnMasterBegin
PetscDLClose PetscHSetTDuplicate PetscOmpCtrlOmpRegionOnMasterEnd
PetscDLLibraryAppend PetscHSetTGetCapacity PetscOptionsClear
PetscDLLibraryClose PetscHSetTGetElems PetscOptionsDeprecated
PetscDLLibraryOpen PetscHSetTGetSize PetscOptionsFindPair
PetscDLLibraryPrepend PetscHSetTHas PetscOptionsInsertFile
PetscDLLibraryRetrieve PetscHSetTQueryAdd PetscParallelSortedInt
PetscDLLibrarySym PetscHSetTQueryDel PetscPopSignalHandler
PetscDLOpen PetscHSetTReset PetscPrefetchBlock
PetscDLSym PetscHSetTResize PetscProcessTree
PetscDefined PetscHSetTUpdate PetscPushSignalHandler
PetscDeviceConfigure PetscHeaderCreate PetscRandomFinalizePackage
PetscDeviceFinalizePackage PetscHeaderDestroy PetscRandomInitializePackage
PetscDeviceInitializePackage PetscHelpPrintf PetscRealloc
PetscElementalFinalizePackage PetscIgnoreErrorHandler PetscRegisterFinalize
PetscElementalInitializePackage PetscLogDouble PetscRegisterFinalizeAll
PetscElementalInitialized PetscMPIAbortErrorHandler PetscReturnErrorHandler
PetscEmacsClientErrorHandler PetscMPIDump PetscSSEIsEnabled
PetscEqualReal PetscMalloc2 PetscSegBuffer
PetscEqualScalar PetscMalloc3 PetscSegBufferCreate
PetscErrorMessage PetscMalloc4 PetscSegBufferDestroy
PetscErrorPrintf PetscMalloc5 PetscSegBufferExtractAlloc
PetscFClose PetscMalloc6 PetscSegBufferExtractInPlace
PetscFOpen PetscMalloc7 PetscSegBufferExtractTo
PetscFinalized PetscMallocA PetscSegBufferGet
PetscFormatConvert PetscMallocClear PetscSegBufferGetSize
PetscFormatConvertGetSize PetscMallocLogRequestedSizeGet PetscSegBufferUnuse
PetscFormatStrip PetscMallocLogRequestedSizeSet PetscSetDebugTerminal
PetscFortranCallbackGetSizes PetscMallocPopMaximumUsage PetscSetDebugger
PetscFortranCallbackRegister PetscMallocPushMaximumUsage PetscSetDebuggerFromString
PetscFree2 PetscMallocResetCUDAHost PetscSetDefaultDebugger
PetscFree3 PetscMallocResetDRAM PetscSetHelpVersionFunctions
PetscFree4 PetscMallocResetHIPHost PetscSharedTmp
PetscFree5 PetscMallocSet PetscSharedWorkingDirectory
PetscFree6 PetscMallocSetCUDAHost PetscShmCommGet
PetscFree7 PetscMallocSetCoalesce PetscShmCommGetMpiShmComm
PetscFreeA PetscMallocSetDRAM PetscShmCommGlobalToLocal
PetscFunctionBegin PetscMallocSetDebug PetscShmCommLocalToGlobal
PetscFunctionBeginHot PetscMallocSetHIPHost PetscSignalSegvCheckPointerOrMpi
PetscFunctionListAdd PetscMkdtemp PetscSplitOwnership
PetscFunctionListDestroy PetscNewLog PetscSplitOwnershipBlock
PetscFunctionListDuplicate PetscObjectAddOptionsHandler PetscSplitOwnershipEqual
PetscFunctionListFind PetscObjectCompareId PetscStackSAWsGrantAccess
PetscFunctionListGet PetscObjectComposedDataGetInt PetscStackSAWsTakeAccess
PetscFunctionListPrintTypes PetscObjectComposedDataGetIntstar PetscStopForDebugger
PetscFunctionListView PetscObjectComposedDataGetReal PetscTimSort
PetscFunctionReturn PetscObjectComposedDataGetRealstar PetscTimSortWithArray
PetscGatherMessageLengths PetscObjectComposedDataGetScalar PetscTime
PetscGatherMessageLengths2 PetscObjectComposedDataGetScalarstar PetscTimeAdd
PetscGatherNumberOfMessages PetscObjectComposedDataRegister PetscTimeSubtract
PetscGetArchType PetscObjectComposedDataSetInt PetscTraceBackErrorHandler
PetscGetFullPath PetscObjectComposedDataSetIntstar PetscVFPrintf
PetscGetHomeDirectory PetscObjectComposedDataSetReal PetscVSNPrintf
PetscGetHostName PetscObjectComposedDataSetRealstar SETERRMPI
PetscGetPetscDir PetscObjectComposedDataSetScalar
PetscGetRealPath PetscObjectComposedDataSetScalarstar
No deprecated routines
None: Not yet cataloged
PetscDeviceContextGetDevice

Table of Contents