TaoSetFromOptions#

Sets various Tao parameters from the options database

Synopsis#

#include "petsctao.h" 
PetscErrorCode TaoSetFromOptions(Tao tao)

Collective

Input Parameter#

tao - the Tao solver context

Options Database Keys#

-tao_type - The algorithm that Tao uses (lmvm, nls, etc.)
-tao_gatol - absolute error tolerance for ||gradient||
-tao_grtol - relative error tolerance for ||gradient||
-tao_gttol - reduction of ||gradient|| relative to initial gradient
-tao_max_it - sets maximum number of iterations
-tao_max_funcs - sets maximum number of function evaluations
-tao_fmin - stop if function value reaches fmin
-tao_steptol - stop if trust region radius less than
-tao_trust0 - initial trust region radius
-tao_view_solution - view the solution at the end of the optimization process
-tao_monitor - prints function value and residual norm at each iteration
-tao_monitor_short - same as -tao_monitor, but truncates very small values
-tao_monitor_constraint_norm - prints objective value, gradient, and constraint norm at each iteration
-tao_monitor_globalization - prints information about the globalization at each iteration
-tao_monitor_solution - prints solution vector at each iteration
-tao_monitor_ls_residual - prints least-squares residual vector at each iteration
-tao_monitor_step - prints step vector at each iteration
-tao_monitor_gradient - prints gradient vector at each iteration
-tao_monitor_solution_draw - graphically view solution vector at each iteration
-tao_monitor_step_draw - graphically view step vector at each iteration
-tao_monitor_gradient_draw - graphically view gradient at each iteration
-tao_monitor_cancel - cancels all monitors (except those set with command line)
-tao_fd_gradient - use gradient computed with finite differences
-tao_fd_hessian - use hessian computed with finite differences
-tao_mf_hessian - use matrix-free Hessian computed with finite differences
-tao_view - prints information about the Tao after solving
-tao_converged_reason - prints the reason Tao stopped iterating

Note#

To see all options, run your program with the -help option or consult the user’s manual. Should be called after TaoCreate() but before TaoSolve()

Level#

beginner

Location#

src/tao/interface/taosolver.c

Examples#

src/tao/tutorials/ex4.c
src/tao/pde_constrained/tutorials/hyperbolic.c
src/ts/tutorials/ex20opt_p.c
src/ts/tutorials/ex20opt_ic.c
src/tao/unconstrained/tutorials/spectraladjointassimilation.c
src/tao/unconstrained/tutorials/eptorsion1.c
src/tao/pde_constrained/tutorials/elliptic.c
src/tao/pde_constrained/tutorials/parabolic.c
src/tao/tutorials/ex3.c
src/tao/unconstrained/tutorials/rosenbrock1.c

Implementations#

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