Skip to main content
Ctrl+K
PETSc v3.24.5-686-g2b3a95b64d2c documentation - Home
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • Overview
  • Install
  • Tutorials
  • User-Guide
  • C/Fortran API
  • petsc4py API
  • FAQ
  • Community
  • Developers
  • Misc.
  • GitLab
  • TaoTermCompu...

TaoTermComputeGradient#

Evaluate the gradient of a TaoTerm for a given solution vector and parameter vector

Synopsis#

#include "petsctao.h" 
PetscErrorCode TaoTermComputeGradient(TaoTerm term, Vec x, Vec params, Vec g)

Collective

Input Parameters#

  • term - a TaoTerm representing a parametric function \(f(x; p)\)

  • x - the solution variable \(x\) in \(f(x; p)\)

  • params - the parameters \(p\) in \(f(x; p)\) (may be NULL if the term is not parametric)

Output Parameter#

  • g - the value of \(\nabla_x f(x; p)\)

See Also#

TaoTerm: composable objective function terms, TaoTerm, TaoTermComputeObjective(), TaoTermComputeObjectiveAndGradient(), TaoTermComputeHessian(), TaoTermShellSetGradient()

Level#

developer

Location#

src/tao/term/interface/taoterm.c

Implementations#

TaoTermComputeGradient_Callbacks() in src/tao/term/impls/callbacks/taotermcallbacks.c
TaoTermComputeGradient_Halfl2squared() in src/tao/term/impls/halfl2squared/taotermhalfl2squared.c
TaoTermComputeGradient_L1() in src/tao/term/impls/l1/taoterml1.c
TaoTermComputeGradient_Quadratic() in src/tao/term/impls/quadratic/taotermquadratic.c
TaoTermComputeGradient_Test() in src/tao/term/impls/shell/tests/ex1.c
TaoTermComputeGradient_Sum() in src/tao/term/impls/sum/taotermsum.c


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

On this page
  • Synopsis
  • Input Parameters
  • Output Parameter
  • See Also
  • Level
  • Location
  • Implementations
Edit on GitLab
Show Source

© Copyright 1991-2026, UChicago Argonne, LLC and the PETSc Development Team.

Created using Sphinx 7.3.7.

Built with the PyData Sphinx Theme 0.15.1.

Last updated on 2026-03-27T03:46:44-0500 (v3.24.5-686-g2b3a95b64d2c).