DMTSSetForcingFunction#

set TS forcing function evaluation function

Synopsis#

#include "petscts.h" 
PetscErrorCode DMTSSetForcingFunction(DM dm, TSForcingFunction func, void *ctx)

Not Collective

Input Parameters#

  • dm - DM to be used with TS

  • func - forcing function evaluation routine

  • ctx - context for solution evaluation

Calling sequence of func#

PetscErrorCode func (TS ts, PetscReal t, Vec f,void *ctx)

  • ts - timestep context

  • t - current timestep

  • f - output vector

  • ctx - [optional] user-defined function context

Note#

TSSetForcingFunction() is normally used, but it calls this function internally because the user context is actually associated with the DM. This makes the interface consistent regardless of whether the user interacts with a DM or not. If DM took a more central role at some later date, this could become the primary method of setting the residual.

See Also#

TS: Scalable ODE and DAE Solvers, DM, TS, DMTSSetContext(), TSSetFunction(), DMTSSetJacobian(), TSSetForcingFunction(), DMTSGetForcingFunction()

Level#

advanced

Location#

src/ts/utils/dmts.c

Edit on GitLab

Index of all TS routines
Table of Contents for all manual pages
Index of all manual pages