petsc-main 2021-04-20
Report Typos and Errors

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 UsingFortran
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
Converts PetscGetTmp PetscObjectDestroyOptionsHandlers
KSPCheckDot PetscGetUserName PetscObjectGetClassId
KSPCheckNorm PetscGetVersion PetscObjectGetClassName
MPIU_Allreduce PetscGetVersionNumber PetscObjectGetFortranCallback
PETSC_HASH_MAP PetscGetWorkingDirectory PetscObjectGetId
PETSC_HASH_SET PetscHMapT PetscObjectGetNewTag
PETSC_MATLAB_ENGINE_ PetscHMapTClear PetscObjectGetTabLevel
PETSC_MATLAB_ENGINE_SELF PetscHMapTCreate PetscObjectId
PETSC_MATLAB_ENGINE_WORLD PetscHMapTDel PetscObjectIncrementTabLevel
PetscAbortErrorHandler PetscHMapTDestroy PetscObjectInheritPrintedOptions
PetscAddrAlign PetscHMapTDuplicate PetscObjectList
PetscAttachDebuggerErrorHandler PetscHMapTFind PetscObjectListAdd
PetscBinaryRead PetscHMapTGet PetscObjectListDestroy
PetscBinarySeek PetscHMapTGetCapacity PetscObjectListDuplicate
PetscBinarySynchronizedRead PetscHMapTGetKeys PetscObjectListFind
PetscBinarySynchronizedSeek PetscHMapTGetPairs PetscObjectListRemoveReference
PetscBinarySynchronizedWrite PetscHMapTGetSize PetscObjectListReverseFind
PetscBuildTwoSidedType PetscHMapTGetVals PetscObjectName
PetscCalloc2 PetscHMapTHas PetscObjectPrintClassNamePrefixType
PetscCalloc3 PetscHMapTIterDel PetscObjectProcessOptionsHandlers
PetscCalloc4 PetscHMapTIterGet PetscObjectRegisterDestroy
PetscCalloc5 PetscHMapTIterSet PetscObjectRegisterDestroyAll
PetscCalloc6 PetscHMapTPut PetscObjectSetFortranCallback
PetscCalloc7 PetscHMapTQueryDel PetscObjectSetPrintedOptions
PetscCheckPointer PetscHMapTQuerySet PetscObjectSetTabLevel
PetscClassId PetscHMapTReset PetscObjectState
PetscCommBuildTwoSided PetscHMapTResize PetscObjectStateIncrease
PetscCommBuildTwoSidedF PetscHMapTSet PetscObjectsListGetGlobalNumbering
PetscCommBuildTwoSidedFReq PetscHSetT PetscOmpCtrlBarrier
PetscCommBuildTwoSidedGetType PetscHSetTAdd PetscOmpCtrlCreate
PetscCommBuildTwoSidedSetType PetscHSetTClear PetscOmpCtrlDestroy
PetscCommDestroy PetscHSetTCreate PetscOmpCtrlGetOmpComms
PetscCommDuplicate PetscHSetTDel PetscOmpCtrlOmpRegionOnMasterBegin
PetscCommGetNewTag PetscHSetTDestroy PetscOmpCtrlOmpRegionOnMasterEnd
PetscDLAddr PetscHSetTDuplicate PetscOptionsClear
PetscDLClose PetscHSetTGetCapacity PetscOptionsDeprecated
PetscDLLibraryAppend PetscHSetTGetElems PetscOptionsFindPair
PetscDLLibraryClose PetscHSetTGetSize PetscOptionsInsertFile
PetscDLLibraryOpen PetscHSetTHas PetscParallelSortedInt
PetscDLLibraryPrepend PetscHSetTQueryAdd PetscPopSignalHandler
PetscDLLibraryRetrieve PetscHSetTQueryDel PetscPrefetchBlock
PetscDLLibrarySym PetscHSetTReset PetscProcessTree
PetscDLOpen PetscHSetTResize PetscPushSignalHandler
PetscDLSym PetscHSetTUpdate PetscRandomFinalizePackage
PetscDefined PetscHeaderCreate PetscRandomInitializePackage
PetscElementalFinalizePackage PetscHeaderDestroy PetscRealloc
PetscElementalInitializePackage PetscHelpPrintf PetscRegisterFinalize
PetscElementalInitialized PetscIgnoreErrorHandler PetscRegisterFinalizeAll
PetscEmacsClientErrorHandler PetscLogDouble PetscReturnErrorHandler
PetscEqualReal PetscMPIAbortErrorHandler PetscSSEIsEnabled
PetscEqualScalar PetscMPIDump PetscSegBuffer
PetscErrorMessage PetscMalloc2 PetscSegBufferCreate
PetscErrorPrintf PetscMalloc3 PetscSegBufferDestroy
PetscFClose PetscMalloc4 PetscSegBufferExtractAlloc
PetscFOpen PetscMalloc5 PetscSegBufferExtractInPlace
PetscFinalized PetscMalloc6 PetscSegBufferExtractTo
PetscFormatConvert PetscMalloc7 PetscSegBufferGet
PetscFormatConvertGetSize PetscMallocA PetscSegBufferGetSize
PetscFormatStrip PetscMallocClear PetscSegBufferUnuse
PetscFortranCallbackGetSizes PetscMallocLogRequestedSizeGet PetscSetDebugTerminal
PetscFortranCallbackRegister PetscMallocLogRequestedSizeSet PetscSetDebugger
PetscFree2 PetscMallocPopMaximumUsage PetscSetDebuggerFromString
PetscFree3 PetscMallocPushMaximumUsage PetscSetDefaultDebugger
PetscFree4 PetscMallocResetCUDAHost PetscSetHelpVersionFunctions
PetscFree5 PetscMallocResetDRAM PetscSharedTmp
PetscFree6 PetscMallocSet PetscSharedWorkingDirectory
PetscFree7 PetscMallocSetCUDAHost PetscShmCommGet
PetscFreeA PetscMallocSetCoalesce PetscShmCommGetMpiShmComm
PetscFunctionBegin PetscMallocSetDRAM PetscShmCommGlobalToLocal
PetscFunctionBeginHot PetscMallocSetDebug PetscShmCommLocalToGlobal
PetscFunctionListAdd PetscMkdtemp PetscSignalSegvCheckPointerOrMpi
PetscFunctionListDestroy PetscNewLog PetscSplitOwnership
PetscFunctionListDuplicate PetscObjectAddOptionsHandler PetscSplitOwnershipBlock
PetscFunctionListFind PetscObjectCompareId PetscSplitOwnershipEqual
PetscFunctionListGet PetscObjectComposedDataGetInt PetscStackSAWsGrantAccess
PetscFunctionListPrintTypes PetscObjectComposedDataGetIntstar PetscStackSAWsTakeAccess
PetscFunctionListView PetscObjectComposedDataGetReal PetscStopForDebugger
PetscFunctionReturn PetscObjectComposedDataGetRealstar PetscTimSort
PetscGatherMessageLengths PetscObjectComposedDataGetScalar PetscTimSortWithArray
PetscGatherMessageLengths2 PetscObjectComposedDataGetScalarstar PetscTime
PetscGatherNumberOfMessages PetscObjectComposedDataRegister PetscTimeAdd
PetscGetArchType PetscObjectComposedDataSetInt PetscTimeSubtract
PetscGetFullPath PetscObjectComposedDataSetIntstar PetscTraceBackErrorHandler
PetscGetHomeDirectory PetscObjectComposedDataSetReal PetscVFPrintf
PetscGetHostName PetscObjectComposedDataSetRealstar PetscVSNPrintf
PetscGetPetscDir PetscObjectComposedDataSetScalar SETERRMPI
PetscGetRealPath PetscObjectComposedDataSetScalarstar
PetscGetRelativePath PetscObjectCopyFortranFunctionPointers
No deprecated routines

Table of Contents