File: TSSetFromOptions.html

package info (click to toggle)
petsc 3.7.5%2Bdfsg1-4
links: PTS, VCS
area: main
in suites: stretch
size: 163,864 kB
ctags: 618,438
sloc: ansic: 515,133; python: 29,793; makefile: 20,458; fortran: 18,998; cpp: 6,515; f90: 3,914; sh: 1,012; xml: 621; objc: 445; csh: 240; java: 13
file content (105 lines) | stat: -rw-r--r-- 8,024 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TS/TSSetFromOptions.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSSetFromOptions</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/TS/TSSetFromOptions.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSSetFromOptions"><H1>TSSetFromOptions</H1></A>
Sets various <A HREF="../TS/TS.html#TS">TS</A> parameters from user options. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"  
PetscErrorCode  TSSetFromOptions(TS ts)
</PRE>
Collective on <A HREF="../TS/TS.html#TS">TS</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>ts </B> -the <A HREF="../TS/TS.html#TS">TS</A> context obtained from <A HREF="../TS/TSCreate.html#TSCreate">TSCreate</A>()
<br>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_type &lt;type&gt; </B></TD><TD>- <A HREF="../TS/TSEULER.html#TSEULER">TSEULER</A>, <A HREF="../TS/TSBEULER.html#TSBEULER">TSBEULER</A>, <A HREF="../TS/TSSUNDIALS.html#TSSUNDIALS">TSSUNDIALS</A>, <A HREF="../TS/TSPSEUDO.html#TSPSEUDO">TSPSEUDO</A>, <A HREF="../TS/TSCN.html#TSCN">TSCN</A>, <A HREF="../TS/TSRK.html#TSRK">TSRK</A>, <A HREF="../TS/TSTHETA.html#TSTHETA">TSTHETA</A>, <A HREF="../TS/TSALPHA.html#TSALPHA">TSALPHA</A>, <A HREF="../TS/TSGL.html#TSGL">TSGL</A>, <A HREF="../TS/TSSSP.html#TSSSP">TSSSP</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_save_trajectory </B></TD><TD>- checkpoint the solution at each time-step
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_max_steps &lt;maxsteps&gt; </B></TD><TD>- maximum number of time-steps to take
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_final_time &lt;time&gt; </B></TD><TD>- maximum time to compute to
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_dt &lt;dt&gt; </B></TD><TD>- initial time step
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_exact_final_time &lt;stepover,interpolate,matchstep&gt; whether to stop at the exact given final time and how to compute the solution at that ti,e</B></TD><TD>- .  -ts_max_snes_failures &lt;maxfailures&gt; - Maximum number of nonlinear solve failures allowed
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_max_reject &lt;maxrejects&gt; </B></TD><TD>- Maximum number of step rejections before step fails
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_error_if_step_fails &lt;true,false&gt; </B></TD><TD>- Error if no step succeeds
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_rtol &lt;rtol&gt; </B></TD><TD>- relative tolerance for local truncation error
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_atol &lt;atol&gt; Absolute tolerance for local truncation error</B></TD><TD>- .  -ts_adjoint_solve &lt;yes,no&gt; After solving the ODE/DAE solve the adjoint problem (requires -ts_save_trajectory)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_fd_color </B></TD><TD>- Use finite differences with coloring to compute IJacobian
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor </B></TD><TD>- print information at each timestep
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_solution </B></TD><TD>- Monitor solution graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_error </B></TD><TD>- Monitor error graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_timestep </B></TD><TD>- Monitor timestep size graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_snes_iterations </B></TD><TD>- Monitor number nonlinear iterations for each timestep graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_lg_ksp_iterations </B></TD><TD>- Monitor number nonlinear iterations for each timestep graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_sp_eig </B></TD><TD>- Monitor eigenvalues of linearized operator graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_draw_solution </B></TD><TD>- Monitor solution graphically
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_draw_solution_phase  &lt;xleft,yleft,xright,yright&gt; </B></TD><TD>- Monitor solution graphically with phase diagram, requires problem with exactly 2 degrees of freedom
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_draw_error </B></TD><TD>- Monitor error graphically, requires use to have provided <A HREF="../TS/TSSetSolutionFunction.html#TSSetSolutionFunction">TSSetSolutionFunction</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_solution [ascii binary draw][:filename][:viewerformat] </B></TD><TD>- monitors the solution at each timestep
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_solution_vtk &lt;filename.vts&gt; </B></TD><TD>- Save each time step to a binary file, use filename-%%03D.vts
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_monitor_envelope </B></TD><TD>- determine maximum and minimum value of each component of the solution over the solution time
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_adjoint_monitor </B></TD><TD>- print information at each adjoint time step
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-ts_adjoint_monitor_draw_sensi </B></TD><TD>- monitor the sensitivity of the first cost function wrt initial conditions (lambda[0]) graphically
</TD></TR></TABLE>
<P>
Developer Note: We should unify all the -ts_monitor options in the way that -xxx_view has been unified
<P>

<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 <A HREF="../TS/TS.html#TS">TS</A>, timestep, set, options, database
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../TS/TSGetType.html#TSGetType">TSGetType</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/interface/ts.c.html#TSSetFromOptions">src/ts/interface/ts.c</A>
<BR><A HREF="./index.html">Index of all TS 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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ts/examples/tutorials/ex1.c.html">src/ts/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex2.c.html">src/ts/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex3.c.html">src/ts/examples/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex4.c.html">src/ts/examples/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex5.c.html">src/ts/examples/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex6.c.html">src/ts/examples/tutorials/ex6.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex7.c.html">src/ts/examples/tutorials/ex7.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex8.c.html">src/ts/examples/tutorials/ex8.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex9.c.html">src/ts/examples/tutorials/ex9.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex10.c.html">src/ts/examples/tutorials/ex10.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
</BODY></HTML>