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

TaoIsGradientDefined

 Checks to see if the user has declared an objective-only routine. Useful for determining when it is appropriate to call TaoComputeGradient() or TaoComputeGradientAndGradient()

Synopsis

#include "petsctao.h" 
PetscErrorCode TaoIsGradientDefined(Tao tao, PetscBool *flg)
Not Collective

Input Parameter

tao - the Tao context
ctx - PETSC_TRUE if gradient routine is set by user, PETSC_FALSE otherwise

See Also

TaoSetGradientRoutine(), TaoIsObjectiveDefined(), TaoIsObjectiveAndGradientDefined()

Level

developer

Location

src/tao/interface/taosolver_fg.c
Index of all Tao routines
Table of Contents for all manual pages
Index of all manual pages