1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TaoLineSearch/TaoLineSearchSetOptionsPrefix.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoLineSearchSetOptionsPrefix</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.7.5 v3.7.5 docs/manualpages/TaoLineSearch/TaoLineSearchSetOptionsPrefix.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoLineSearchSetOptionsPrefix"><H1>TaoLineSearchSetOptionsPrefix</H1></A>
Sets the prefix used for searching for all TaoLineSearch options in the database.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctaolinesearch.h"
PetscErrorCode TaoLineSearchSetOptionsPrefix(TaoLineSearch ls, const char p[])
</PRE>
<P>
Logically Collective on TaoLineSearch
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ls </B></TD><TD>- the TaoLineSearch context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>prefix </B></TD><TD>- the prefix string to prepend to all TAO option requests
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
A hyphen (-) must NOT be given at the beginning of the prefix name.
The first character of all runtime options is AUTOMATICALLY the hyphen.
<P>
For example, to distinguish between the runtime options for two
different line searches, one could call
<PRE>
<A HREF="../TaoLineSearch/TaoLineSearchSetOptionsPrefix.html#TaoLineSearchSetOptionsPrefix">TaoLineSearchSetOptionsPrefix</A>(ls1,"sys1_")
<A HREF="../TaoLineSearch/TaoLineSearchSetOptionsPrefix.html#TaoLineSearchSetOptionsPrefix">TaoLineSearchSetOptionsPrefix</A>(ls2,"sys2_")
</PRE>
<P>
This would enable use of different options for each system, such as
<PRE>
-sys1_tao_ls_type mt
-sys2_tao_ls_type armijo
</PRE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../TaoLineSearch/TaoLineSearchAppendOptionsPrefix.html#TaoLineSearchAppendOptionsPrefix">TaoLineSearchAppendOptionsPrefix</A>(), <A HREF="../TaoLineSearch/TaoLineSearchGetOptionsPrefix.html#TaoLineSearchGetOptionsPrefix">TaoLineSearchGetOptionsPrefix</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/tao/linesearch/interface/taolinesearch.c.html#TaoLineSearchSetOptionsPrefix">src/tao/linesearch/interface/taolinesearch.c</A>
<BR><A HREF="./index.html">Index of all TaoLineSearch routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|