petsc-master 2020-11-25
Report Typos and Errors

Time steppers for ODE and DAE - TS: Examples

The time-stepping (TS) component provides ODE and DAE integrators as well as pseudo-timestepping. TS internally employs SNES to solve the nonlinear problems at each time step (except for the Sundials functions, which use nonlinear solvers within Sundials). TS users can also set SNES options directly in application codes by first extracting the SNES context from the TS context via TSGetSNES() and then directly calling various SNES (and KSP and PC with further unwrapping) routines (e.g., PCSetType() ).

Beginner - Basic usage
DMDATSSetIFunctionLocal TSGLLEAdapt TSSSPType
DMDATSSetIJacobianLocal TSGLLEAdaptType TSSUNDIALS
DMDATSSetRHSFunctionLocal TSGLLEType TSSetEventTolerances
DMDATSSetRHSJacobianLocal TSGetConvergedReason TSSetExactFinalTime
DMTSSetIFunctionLocal TSGetEquationType TSSetForcingFunction
DMTSSetIJacobianLocal TSGetExactFinalTime TSSetFromOptions
DMTSSetRHSFunctionLocal TSGetKSP TSSetI2Function
TS TSGetPrevTime TSSetI2Jacobian
TS2SetSolution TSGetProblemType TSSetIFunction
TSALPHA TSGetSNES TSSetIJacobian
TSALPHA2 TSGetSolveTime TSSetProblemType
TSARKIMEX TSGetTime TSSetRHSFunction
TSARKIMEXType TSGetTolerances TSSetRHSJacobian
TSAdapt TSMIMEX TSSetSolution
TSAdaptType TSMPRK TSSetSolutionFunction
TSBDF TSMPRKType TSSetTolerances
TSBEULER TSPSEUDO TSSolve
TSBasicSymplectic TSProblemType TSSundialsMonitorInternalSteps
TSBasicSymplecticType TSRADAU5 TSSundialsSetMaxTimeStep
TSCN TSRHSSplitSetRHSFunction TSSundialsSetMinTimeStep
TSConvergedReason TSRK TSTHETA
TSCreate TSRKType TSType
TSDISCGRAD TSROSW TSView
TSDestroy TSReset TS_CONVERGED_EVENT
TSEIMEX TSRosWSetType TS_CONVERGED_ITERATING
TSEIMEXType TSRosWType TS_CONVERGED_ITS
TSEULER TSSSP TS_CONVERGED_PSEUDO_FATOL
TSEquationType TSSSPGetNumStages TS_CONVERGED_PSEUDO_FRTOL
TSExactFinalTimeOption TSSSPGetType TS_CONVERGED_TIME
TSGLEE TSSSPRKS104 TS_CONVERGED_USER
TSGLEEMode TSSSPRKS2 TS_DIVERGED_NONLINEAR_SOLVE
TSGLEEType TSSSPRKS3 TS_DIVERGED_STEP_REJECTED
TSGLLE TSSSPSetNumStages
TSGLLEAcceptType TSSSPSetType
Intermediate - Setting options for algorithms and data structures
DMTSSetBoundaryLocal TSGetOptionsPrefix TSRKGetType
TS2GetSolution TSGetRHSJacobian TSRKSetMultirate
TSADAPTBASIC TSGetSNESFailures TSRKSetType
TSADAPTCFL TSGetSNESIterations TSROSW2M
TSADAPTDSP TSGetSolution TSROSW2P
TSADAPTGLEE TSGetStepNumber TSROSW4L
TSADAPTNONE TSGetStepRejections TSROSWASSP3P3S1C
TSARKIMEXGetFullyImplicit TSGetTimeError TSROSWGRK4T
TSARKIMEXGetType TSGetTimeStep TSROSWLASSP3P4S2C
TSARKIMEXSetFullyImplicit TSGetType TSROSWLLSSP3P4S2C
TSARKIMEXSetType TSGetUseSplitRHSFunction TSROSWRA34PW2
TSAdaptDSPSetFilter TSInterpolate TSROSWRA3PW
TSAdaptDSPSetPID TSLoad TSROSWRODAS3
TSAdaptGetClip TSMPRKGetType TSROSWSANDU3
TSAdaptGetMaxIgnore TSMPRKSetType TSROSWSHAMP4
TSAdaptGetSafety TSMonitorCancel TSROSWTHETA1
TSAdaptGetScaleSolveFailed TSMonitorDefault TSROSWTHETA2
TSAdaptGetStepLimits TSMonitorDrawCtxCreate TSROSWVELDD4
TSAdaptGetType TSMonitorDrawCtxDestroy TSResetTrajectory
TSAdaptLoad TSMonitorDrawError TSRosWGetType
TSAdaptSetAlwaysAccept TSMonitorDrawSolution TSRosWSetRecomputeJacobian
TSAdaptSetClip TSMonitorDrawSolutionFunction TSSetApplicationContext
TSAdaptSetMaxIgnore TSMonitorDrawSolutionPhase TSSetCFLTimeLocal
TSAdaptSetMonitor TSMonitorEnvelope TSSetDM
TSAdaptSetSafety TSMonitorEnvelopeCtxCreate TSSetErrorIfStepFails
TSAdaptSetScaleSolveFailed TSMonitorEnvelopeCtxDestroy TSSetEventHandler
TSAdaptSetStepLimits TSMonitorEnvelopeGetBounds TSSetFunctionDomainError
TSAdaptSetType TSMonitorError TSSetMaxSNESFailures
TSAlpha2SetRadius TSMonitorExtreme TSSetMaxStepRejections
TSAlphaSetRadius TSMonitorLGCtxCreate TSSetMaxSteps
TSBASICSYMPLECTICSIEULER TSMonitorLGCtxDestroy TSSetMaxTime
TSBASICSYMPLECTICVELVERLET TSMonitorLGCtxSetDisplayVariables TSSetPostEvaluate
TSBDFGetOrder TSMonitorLGCtxSetTransform TSSetPostStage
TSBDFSetOrder TSMonitorLGCtxSetVariableNames TSSetPostStep
TSBasicSymplecticGetType TSMonitorLGError TSSetPreStage
TSBasicSymplecticSetType TSMonitorLGGetVariableNames TSSetPreStep
TSComputeIFunctionLinear TSMonitorLGSetDisplayVariables TSSetSaveTrajectory
TSComputeIJacobianDefaultColor TSMonitorLGSetTransform TSSetTime
TSComputeRHSFunctionLinear TSMonitorLGSetVariableNames TSSetTimeError
TSComputeRHSJacobianConstant TSMonitorLGSolution TSSetTimeStep
TSDiscGradGetFormulation TSMonitorSPEigCtxCreate TSSetType
TSDiscGradSetFormulation TSMonitorSPEigCtxDestroy TSSetUseSplitRHSFunction
TSEIMEXSetMaxRows TSMonitorSPSwarmSolution TSSundialsSetTolerance
TSEIMEXSetOrdAdapt TSMonitorSet TSSundialsSetType
TSEIMEXSetRowCol TSMonitorSolution TSTRAJECTORYBASIC
TSGLEEGetType TSMonitorSolutionVTK TSTRAJECTORYMEMORY
TSGLEESetType TSMonitorSolutionVTKDestroy TSTRAJECTORYSINGLEFILE
TSGLLESetAcceptType TSPseudoSetTimeStep TSTRAJECTORYVISUALIZATION
TSGLLESetType TSPythonSetType TSThetaSetEndpoint
TSGetAdapt TSRHSJacobianSetReuse TSThetaSetTheta
TSGetApplicationContext TSRHSSplitGetIS TSTrajectorySetTransform
TSGetAuxSolution TSRHSSplitSetIS TSTrajectorySetVariableNames
TSGetDM TSRKGetMultirate TSTrajectoryViewFromOptions
TSGetKSPIterations TSRKGetOrder TSViewFromOptions
Advanced - Setting more advanced options and customization
DMTSGetForcingFunction TSBasicSymplecticRegisterAll TSPseudoTimeStepDefault
DMTSGetI2Function TSBasicSymplecticRegisterDestroy TSPseudoVerifyTimeStep
DMTSGetI2Jacobian TSComputeExactError TSPseudoVerifyTimeStepDefault
DMTSGetIFunction TSComputeIJacobianConstant TSRHSJacobianTest
DMTSGetIJacobian TSComputeInitialCondition TSRHSJacobianTestTranspose
DMTSGetRHSFunction TSEvaluateStep TSRHSSplitGetSubTS
DMTSGetRHSJacobian TSEvaluateWLTE TSRHSSplitGetSubTSs
DMTSGetSolutionFunction TSGLEE23 TSRK1FE
DMTSGetTransientVariable TSGLEE24 TSRK2A
DMTSSetForcingFunction TSGLEE25i TSRK3
DMTSSetI2Function TSGLEE35 TSRK3BS
DMTSSetI2Jacobian TSGLEEEXRK2A TSRK4
DMTSSetIFunction TSGLEERK285EX TSRK5BS
DMTSSetIFunctionSerialize TSGLEERK32G1 TSRK5DP
DMTSSetIJacobian TSGLEERegister TSRK5F
DMTSSetIJacobianSerialize TSGLEERegisterAll TSRK6VR
DMTSSetRHSFunction TSGLEERegisterDestroy TSRK7VR
DMTSSetRHSJacobian TSGLLEAcceptRegister TSRK8VR
DMTSSetSolutionFunction TSGLLEAdaptRegister TSRKRegister
DMTSSetTransientVariable TSGLLEAdaptRegisterAll TSRKRegisterAll
SNESTSFormFunction TSGLLEGetAdapt TSRKRegisterDestroy
TSARKIMEX1BEE TSGLLERegister TSRegister
TSARKIMEX2C TSGLLERegisterAll TSRegisterAll
TSARKIMEX2D TSGetCFLTime TSRestartStep
TSARKIMEX2E TSGetComputeExactError TSRollBack
TSARKIMEX3 TSGetComputeInitialCondition TSRosWRegister
TSARKIMEX4 TSGetI2Function TSRosWRegisterAll
TSARKIMEX5 TSGetI2Jacobian TSRosWRegisterDestroy
TSARKIMEXA2 TSGetIFunction TSSetComputeExactError
TSARKIMEXARS122 TSGetIJacobian TSSetComputeInitialCondition
TSARKIMEXARS443 TSGetMaxSteps TSSetConvergedReason
TSARKIMEXBPR3 TSGetMaxTime TSSetEquationType
TSARKIMEXL2 TSGetRHSFunction TSSetOptionsPrefix
TSARKIMEXPRSSP2 TSGetSolutionComponents TSSetPostEventIntervalStep
TSARKIMEXRegister TSGetStages TSSetStepNumber
TSARKIMEXRegisterAll TSGetTrajectory TSSetTransientVariable
TSARKIMEXRegisterDestroy TSMPRK2A22 TSSetUp
TSAdaptHistoryGetStep TSMPRK2A23 TSSundialsGetIterations
TSAdaptHistorySetHistory TSMPRK2A32 TSSundialsGetPC
TSAdaptHistorySetTrajectory TSMPRK2A33 TSSundialsSetGramSchmidtType
TSAdaptRegister TSMPRK3P2M TSSundialsSetLinearTolerance
TSAdaptRegisterAll TSMPRKP2 TSSundialsSetMaxl
TSAdaptSetCheckStage TSMPRKP3 TSSundialsSetMaxord
TSAdaptSetTimeStepIncreaseDelay TSMPRKRegister TSThetaGetEndpoint
TSAlpha2GetParams TSMPRKRegisterAll TSThetaGetTheta
TSAlpha2SetParams TSMPRKRegisterDestroy TSTrajectory
TSAlphaGetParams TSPseudoIncrementDtFromInitialDt TSTrajectorySetKeepFiles
TSAlphaSetParams TSPseudoSetMaxTimeStep TSTrajectorySetUseHistory
TSAppendOptionsPrefix TSPseudoSetTimeStepIncrement TSVISetVariableBounds
TSBasicSymplecticRegister TSPseudoSetVerifyTimeStep
Developer - Interfaces intended primarily for library developers, not for typical applications programmers
DMCopyDMTS TSComputeIJacobian TSRKFinalizePackage
DMGetDMTS TSComputeLinearStability TSRKGetTableau
DMGetDMTSWrite TSComputeRHSFunction TSRKInitializePackage
DMPlexTSComputeBoundary TSComputeRHSJacobian TSRosWFinalizePackage
DMPlexTSComputeIFunctionFEM TSComputeSolutionFunction TSRosWInitializePackage
DMPlexTSComputeIJacobianFEM TSComputeTransientVariable TSRosWRegisterRos4
DMPlexTSComputeRHSFunctionFVM TSErrorWeightedENorm TSSSPFinalizePackage
DMTSCheckFromOptions TSErrorWeightedENorm2 TSSSPInitializePackage
DMTSCheckJacobian TSErrorWeightedENormInfinity TSSetSNES
DMTSCheckResidual TSErrorWeightedNorm TSStep
DMTSCopy TSErrorWeightedNorm2 TSTrajectoryCreate
SNESTSFormJacobian TSErrorWeightedNormInfinity TSTrajectoryDestroy
TSADAPTHISTORY TSFinalizePackage TSTrajectoryGet
TSARKIMEXFinalizePackage TSFunctionDomainError TSTrajectoryGetNumSteps
TSARKIMEXInitializePackage TSGLEEFinalizePackage TSTrajectoryGetSolutionOnly
TSAdaptCandidateAdd TSGLEEInitializePackage TSTrajectoryGetType
TSAdaptCandidatesClear TSGLLEAdaptInitializePackage TSTrajectoryGetUpdatedHistoryVecs
TSAdaptCandidatesGet TSGLLEFinalizePackage TSTrajectoryGetVecs
TSAdaptCheckStage TSGLLEInitializePackage TSTrajectoryRegister
TSAdaptChoose TSHasTransientVariable TSTrajectoryRegisterAll
TSAdaptCreate TSInitializePackage TSTrajectoryReset
TSAdaptFinalizePackage TSMPRKFinalizePackage TSTrajectoryRestoreUpdatedHistoryVecs
TSAdaptInitializePackage TSMPRKInitializePackage TSTrajectorySet
TSAdaptReset TSMonitor TSTrajectorySetDirname
TSBasicSymplecticFinalizePackage TSMonitorSetFromOptions TSTrajectorySetFiletemplate
TSBasicSymplecticInitializePackage TSPostEvaluate TSTrajectorySetFromOptions
TSClone TSPostStage TSTrajectorySetMonitor
TSComputeForcingFunction TSPostStep TSTrajectorySetSolutionOnly
TSComputeI2Function TSPreStage TSTrajectorySetType
TSComputeI2Jacobian TSPreStep TSTrajectorySetUp
TSComputeIFunction TSPseudoComputeTimeStep TSTrajectoryView
Deprecated - Functionality scheduled for removal in future versions
TSGetDuration TSGetTotalSteps TSSetInitialTimeStep
TSGetTimeStepNumber TSSetDuration

Table of Contents