PETSc version 3.15.5

PETSc System routines

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

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

Table of Contents