PETSc version v3.16.3-686-g5e81a9049f

PETSc System routines

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

Beginner - Basic usage
ADD_VALUES PetscDevice PetscOptionsBoolArray
CHKERRCXX PetscDeviceConfigure PetscOptionsBoundedInt
CHKERRQ PetscDeviceContext PetscOptionsEnum
CHKERRXX PetscDeviceContextCreate PetscOptionsEnumArray
CHKMEMQ PetscDeviceContextDestroy PetscOptionsGetBool
INSERT_VALUES PetscDeviceContextDuplicate PetscOptionsGetBoolArray
InsertMode PetscDeviceContextGetCurrentContext PetscOptionsGetEnum
MAX_VALUES PetscDeviceContextJoinMode PetscOptionsGetEnumArray
MIN_VALUES PetscDeviceContextSetCurrentContext PetscOptionsGetInt
MPIU_COMPLEX PetscDeviceContextSetFromOptions PetscOptionsGetIntArray
MPIU_INT PetscDeviceContextSetUp PetscOptionsGetReal
MPIU_REAL PetscDeviceContextSynchronize PetscOptionsGetRealArray
MPIU_SCALAR PetscDeviceContextWaitForContext PetscOptionsGetScalar
MPI_Comm PetscDeviceCreate PetscOptionsGetScalarArray
PETSC_COMM_SELF PetscDeviceDestroy PetscOptionsGetString
PETSC_COMM_WORLD PetscDeviceInitType PetscOptionsGetStringArray
PETSC_DECIDE PetscDeviceInitialize PetscOptionsHasName
PETSC_DEFAULT PetscDeviceInitialized PetscOptionsInt
PETSC_DETERMINE PetscDeviceType PetscOptionsIntArray
PETSC_FALSE PetscDeviceView PetscOptionsName
PETSC_IGNORE PetscErrorCode PetscOptionsRangeInt
PETSC_MPI_THREAD_REQUIRED PetscFileMode PetscOptionsReal
PETSC_TRUE PetscFinalize PetscOptionsRealArray
PETSC_i PetscFortranAddr PetscOptionsScalar
PetscAbs PetscFree PetscOptionsScalarArray
PetscAbsInt PetscGetDate PetscOptionsString
PetscAbsReal PetscGlobalMinMaxInt PetscOptionsStringArray
PetscBag PetscGlobalMinMaxReal PetscOptionsViewer
PetscBagDestroy PetscImaginaryPart PetscRandomSetFromOptions
PetscBagLoad PetscInitialize PetscRandomType
PetscBagRegisterBool PetscInitializeFortran PetscRandomView
PetscBagRegisterBoolArray PetscInitialized PetscReal
PetscBagRegisterEnum PetscInt PetscRealPart
PetscBagRegisterInt PetscIsCloseAtTol PetscScalar
PetscBagRegisterInt64 PetscIsInfReal PetscSign
PetscBagRegisterIntArray PetscIsNanReal PetscSqr
PetscBagRegisterReal PetscIsNormalReal PetscSubcommSetFromOptions
PetscBagRegisterRealArray PetscMalloc PetscSubcommView
PetscBagRegisterScalar PetscMalloc1 SETERRABORT
PetscBagRegisterString PetscMax SETERRQ
PetscBagSetFromOptions PetscMemType SETERRQ1
PetscBagView PetscMin SETERRQ2
PetscBool PetscNew SETERRQ3
PetscCalloc PetscNot SETERRQ4
PetscCalloc1 PetscObject SETERRQ5
PetscClipInterval PetscObjectDestroy SETERRQ6
PetscComplex PetscObjectSetFromOptions SETERRQ7
PetscCopyMode PetscOffset SETERRQ8
PetscDataType PetscOptionsBool SETERRQ9
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 PetscIntSumError PetscObjectSetUp
PetscApproximateGTE PetscIntSumTruncate PetscObjectStateGet
PetscApproximateLTE PetscMPIDataTypeToPetscDataType PetscObjectStateSet
PetscAttachDebugger PetscMPIIntCast PetscObjectsDump
PetscBLASIntCast PetscMallocTraceGet PetscObjectsGetObject
PetscBT PetscMallocTraceSet PetscObjectsView
PetscBinaryClose PetscMallocValidate PetscOptionsAllUsed
PetscBinaryOpen PetscMallocView PetscOptionsCreate
PetscBinarySeekType PetscMallocViewGet PetscOptionsDestroy
PetscBinaryWrite PetscMallocViewSet PetscOptionsGetAll
PetscCeilInt PetscMatlabEngineCreate PetscOptionsGetenv
PetscCheckPointerSetIntensity PetscMatlabEngineDestroy PetscOptionsHasHelp
PetscContainer PetscMatlabEngineEvaluate PetscOptionsInsert
PetscContainerCreate PetscMatlabEngineGet PetscOptionsLeft
PetscContainerDestroy PetscMatlabEngineGetArray PetscOptionsLeftGet
PetscContainerGetPointer PetscMatlabEngineGetOutput PetscOptionsLeftRestore
PetscContainerSetPointer PetscMatlabEnginePrintOutput PetscOptionsPop
PetscContainerSetUserDestroy PetscMatlabEnginePut PetscOptionsPrefixPop
PetscContainerUserDestroyDefault PetscMatlabEnginePutArray PetscOptionsPrefixPush
PetscCuBLASIntCast PetscObjectAppendOptionsPrefix PetscOptionsPush
PetscDLLibrary PetscObjectComm PetscOptionsReject
PetscDataTypeFromString PetscObjectCompose PetscOptionsSetAlias
PetscDataTypeGetSize PetscObjectComposeFunction PetscOptionsUsed
PetscDataTypeToMPIDataType PetscObjectDereference PetscOptionsView
PetscDetermineInitialFPTrap PetscObjectGetComm PetscPullJSONValue
PetscEListFind PetscObjectGetOptions PetscPushJSONValue
PetscEnd PetscObjectGetOptionsPrefix PetscRandomRegister
PetscEnumFind PetscObjectGetReference PetscRandomRegisterAll
PetscErrorType PetscObjectGetType PetscRealIntMultTruncate
PetscFPTrapPop PetscObjectPrependOptionsPrefix PetscSAWsBlock
PetscFPTrapPush PetscObjectQuery PetscSSLDestroyContext
PetscFixFilename PetscObjectQueryFunction PetscSSLInitializeContext
PetscFunctionList PetscObjectReference PetscSetFPTrap
PetscGetProgramName PetscObjectSAWsBlock PetscSignalHandlerDefault
PetscHTTPRequest PetscObjectSAWsGrantAccess PetscSubcomm
PetscHTTPSConnect PetscObjectSAWsSetBlock PetscSubcommCreate
PetscHTTPSRequest PetscObjectSAWsTakeAccess PetscSubcommDestroy
PetscInitializeNoArguments PetscObjectSetName PetscSubcommSetNumber
PetscIntCast PetscObjectSetOptions PetscSubcommSetType
PetscIntMultError PetscObjectSetOptionsPrefix PetscSubcommSetTypeGeneral
PetscIntMultTruncate PetscObjectSetType PetscWaitOnError
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
No deprecated routines

Table of Contents