petsc-3.14.6 2021-03-30
Report Typos and Errors

SNESLineSearchCreate

 Creates the line search context.

Synopsis

#include "petscsnes.h" 
PetscErrorCode SNESLineSearchCreate(MPI_Comm comm, SNESLineSearch *outlinesearch)
Logically Collective on Comm

Input Parameters

comm - MPI communicator for the line search (typically from the associated SNES context).

Output Parameters

outlinesearch - the new linesearch context

Notes

The preferred calling sequence for users is to use SNESGetLineSearch() to acquire the SNESLineSearch instance already associated with the SNES. This function is for developer use.

See Also

LineSearchDestroy(), SNESGetLineSearch()

Level

developer

Location

src/snes/linesearch/interface/linesearch.c

Implementations

SNESLineSearchCreate_NCGLinear in src/snes/impls/ncg/snesncg.c
SNESLineSearchCreate_Basic in src/snes/linesearch/impls/basic/linesearchbasic.c
SNESLineSearchCreate_BT in src/snes/linesearch/impls/bt/linesearchbt.c
SNESLineSearchCreate_CP in src/snes/linesearch/impls/cp/linesearchcp.c
SNESLineSearchCreate_L2 in src/snes/linesearch/impls/l2/linesearchl2.c
SNESLineSearchCreate_NLEQERR in src/snes/linesearch/impls/nleqerr/linesearchnleqerr.c
SNESLineSearchCreate_Shell in src/snes/linesearch/impls/shell/linesearchshell.c

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