SNESGetGradientNorm

Gets the norm of the current gradient that was set with SNESSSetGradient().

Synopsis

int SNESGetGradientNorm(SNES snes,Scalar *gnorm)
Collective on SNES

Input Parameter

snes -SNES context

Output Parameter

fnorm -2-norm of gradient

Note

SNESGetGradientNorm() is valid for SNES_UNCONSTRAINED_MINIMIZATION methods only. A related routine for SNES_NONLINEAR_EQUATIONS methods is SNESGetFunctionNorm().

Keywords

SNES, nonlinear, get, gradient, norm

See Also

so: SNESSetGradient()

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