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
|
<!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/TSStep.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSStep</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/TSStep.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSStep"><H1>TSStep</H1></A>
Steps one time step
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"
PetscErrorCode TSStep(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>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The public interface for the ODE/DAE solvers is <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>(), you should almost for sure be using that routine and not this routine.
<P>
The hook set using <A HREF="../TS/TSSetPreStep.html#TSSetPreStep">TSSetPreStep</A>() is called before each attempt to take the step. In general, the time step size may
be changed due to adaptive error controller or solve failures. Note that steps may contain multiple stages.
<P>
This may over-step the final time provided in <A HREF="../TS/TSSetDuration.html#TSSetDuration">TSSetDuration</A>() depending on the time-step used. <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>() interpolates to exactly the
time provided in <A HREF="../TS/TSSetDuration.html#TSSetDuration">TSSetDuration</A>(). One can use <A HREF="../TS/TSInterpolate.html#TSInterpolate">TSInterpolate</A>() to determine an interpolated solution within the final timestep.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../TS/TS.html#TS">TS</A>, timestep, solve
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../TS/TSCreate.html#TSCreate">TSCreate</A>(), <A HREF="../TS/TSSetUp.html#TSSetUp">TSSetUp</A>(), <A HREF="../TS/TSDestroy.html#TSDestroy">TSDestroy</A>(), <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>(), <A HREF="../TS/TSSetPreStep.html#TSSetPreStep">TSSetPreStep</A>(), <A HREF="../TS/TSSetPreStage.html#TSSetPreStage">TSSetPreStage</A>(), <A HREF="../TS/TSSetPostStage.html#TSSetPostStage">TSSetPostStage</A>(), <A HREF="../TS/TSInterpolate.html#TSInterpolate">TSInterpolate</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/interface/ts.c.html#TSStep">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/ex6.c.html">src/ts/examples/tutorials/ex6.c.html</A><BR>
</BODY></HTML>
|
