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

TaoSetOptionsPrefix

Sets the prefix used for searching for all TAO options in the database.

Synopsis

#include "petsctao.h" 
PetscErrorCode TaoSetOptionsPrefix(Tao tao, const char p[])

Logically Collective on Tao

Input Parameters

tao - the Tao context
prefix - the prefix string to prepend to all TAO option requests

Notes

A hyphen (-) must NOT be given at the beginning of the prefix name. The first character of all runtime options is AUTOMATICALLY the hyphen.

For example, to distinguish between the runtime options for two different TAO solvers, one could call

      TaoSetOptionsPrefix(tao1,"sys1_")
      TaoSetOptionsPrefix(tao2,"sys2_")

This would enable use of different options for each system, such as

      -sys1_tao_method blmvm -sys1_tao_gtol 1.e-3
      -sys2_tao_method lmvm  -sys2_tao_gtol 1.e-4

See Also

TaoAppendOptionsPrefix(), TaoGetOptionsPrefix()

Level

advanced

Location

src/tao/interface/taosolver.c

Examples

src/tao/tutorials/ex4.c.html

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