SNESGetGradient

Returns the vector where the gradient is stored.

Synopsis

int SNESGetGradient(SNES snes,Vec *r)
Not Collective, but Vec is parallel if SNES is parallel

Input Parameter

snes -the SNES context

Output Parameter

r -the gradient

Notes

SNESGetGradient() is valid for SNES_UNCONSTRAINED_MINIMIZATION methods only. An analogous routine for SNES_NONLINEAR_EQUATIONS methods is SNESGetFunction().

Keywords

SNES, nonlinear, get, gradient

See Also

SNESGetMinimizationFunction(), SNESGetSolution(), SNESGetFunction()

Level:advanced
Location:src/snes/interface/snes.c
SNES Index
Table of Contents