SNESComputeMinimizationFunction

Computes the function that has been set with SNESSetMinimizationFunction().

Synopsis

int SNESComputeMinimizationFunction(SNES snes,Vec x,double *y)
Collective on SNES

Input Parameters

snes - the SNES context
x - input vector

Output Parameter

y -function value

Notes

SNESComputeMinimizationFunction() is valid only for SNES_UNCONSTRAINED_MINIMIZATION methods. An analogous routine for SNES_NONLINEAR_EQUATIONS methods is SNESComputeFunction().

SNESComputeMinimizationFunction() is typically used within minimization implementations, so most users would not generally call this routine themselves.

Keywords

SNES, nonlinear, compute, minimization, function

See Also

SNESSetMinimizationFunction(), SNESGetMinimizationFunction(),
SNESComputeGradient(), SNESComputeHessian()

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