SNESComputeFunction

Calls the function that has been set with SNESSetFunction().

Synopsis

#include "snes.h"  
int SNESComputeFunction(SNES snes,Vec x,Vec y)
Collective on SNES

Input Parameters

snes - the SNES context
x - input vector

Output Parameter

y -function vector, as set by SNESSetFunction()

Notes

SNESComputeFunction() is valid for SNES_NONLINEAR_EQUATIONS methods only. Analogous routines for SNES_UNCONSTRAINED_MINIMIZATION methods are SNESComputeMinimizationFunction() and SNESComputeGradient();

SNESComputeFunction() is typically used within nonlinear solvers implementations, so most users would not generally call this routine themselves.

Keywords

SNES, nonlinear, compute, function

See Also

SNESSetFunction(), SNESGetFunction()

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