SNESLineSearchPreCheck#

Prepares the line search for being applied.

Synopsis#

#include "petscsnes.h" 
PetscErrorCode SNESLineSearchPreCheck(SNESLineSearch linesearch, Vec X, Vec Y, PetscBool *changed)

Logically Collective

Input Parameters#

  • linesearch - The linesearch instance.

  • X - The current solution

  • Y - The step direction

Output Parameter#

  • changed - Indicator that the precheck routine has changed anything

Note#

This calls any function provided with SNESLineSearchSetPreCheck()

See Also#

SNESLineSearch, SNESGetLineSearch(), SNESLineSearchPostCheck(), SNESLineSearchSetPreCheck(), SNESLineSearchGetPreCheck(), SNESLineSearchSetPostCheck(), `SNESLineSearchGetPostCheck()``

Level#

advanced

Location#

src/snes/linesearch/interface/linesearch.c


Edit on GitLab

Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages