SNESComputeGradient

Computes the gradient that has been set with SNESSetGradient().

Synopsis

int SNESComputeGradient(SNES snes,Vec x, Vec y)
Collective on SNES

Input Parameters

snes - the SNES context
x - input vector

Output Parameter

y -gradient vector

Notes

SNESComputeGradient() is valid only forSNES_UNCONSTRAINED_MINIMIZATION methods. An analogous routine forSNES_NONLINEAR_EQUATIONS methods is SNESComputeFunction().

Keywords

SNES, nonlinear, compute, gradient

See Also

SNESSetGradient(), SNESGetGradient(),
SNESComputeMinimizationFunction(), SNESComputeHessian()

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