MatMFFDSetFunction — PETSc 3.23.0 documentation

Skip to main content
`Ctrl`+`K`

# MatMFFDSetFunction

Sets the function used in applying the matrix-free `MATMFFD` matrix.

## Synopsis

    #include "petscmat.h"
    PetscErrorCode MatMFFDSetFunction(Mat mat, PetscErrorCode (*func)(void *funcctx, Vec x, Vec f), void *funcctx)

Logically Collective

## Input Parameters

- mat - the matrix-free matrix `MATMFFD` created via `MatCreateSNESMF()` or `MatCreateMFFD()`

- func - the function to use

- funcctx - optional function context passed to function

## Calling sequence of `func`

- funcctx - user provided context

- x - input vector

- f - computed output function

## Notes

If you use this you MUST call `MatAssemblyBegin()` and `MatAssemblyEnd()` on the matrix-free matrix inside your compute Jacobian routine

If this is not set then it will use the function set with `SNESSetFunction()` if `MatCreateSNESMF()` was used.

## See Also

Matrices, `Mat`, `MATMFFD`, `MatCreateSNESMF()`, `MatMFFDGetH()`, `MatCreateMFFD()`, `MatMFFDSetHHistory()`, `MatMFFDResetHHistory()`, `SNESSetFunction()`

## Level

advanced

## Location

src/mat/impls/mffd/mffd.c

## Examples

src/snes/tutorials/ex22.c

## Implementations

MatMFFDSetFunction_MFFD(Mat mat, PetscErrorCode (*func)() in src/mat/impls/mffd/mffd.c

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