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
|
<!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/TSSetPreStage.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSSetPreStage</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="TSSetPreStage"><H1>TSSetPreStage</H1></A>
Sets the general-purpose function called once at the beginning of each stage.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"
PetscErrorCode TSSetPreStage(TS ts, PetscErrorCode (*func)(TS,PetscReal))
</PRE>
Logically Collective on <A HREF="../TS/TS.html#TS">TS</A>
<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>ts </B></TD><TD>- The <A HREF="../TS/TS.html#TS">TS</A> context obtained from <A HREF="../TS/TSCreate.html#TSCreate">TSCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD>- The function
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of func</FONT></H3>
<DT><B><A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> func(<A HREF="../TS/TS.html#TS">TS</A> ts, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> stagetime);</B> -
<br>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
There may be several stages per time step. If the solve for a given stage fails, the step may be rejected and retried.
The time step number being computed can be queried using <A HREF="../TS/TSGetTimeStepNumber.html#TSGetTimeStepNumber">TSGetTimeStepNumber</A>() and the total size of the step being
attempted can be obtained using <A HREF="../TS/TSGetTimeStep.html#TSGetTimeStep">TSGetTimeStep</A>(). The time at the start of the step is available via <A HREF="../TS/TSGetTime.html#TSGetTime">TSGetTime</A>().
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../TS/TS.html#TS">TS</A>, timestep
<BR>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../TS/TSSetPreStep.html#TSSetPreStep">TSSetPreStep</A>(), <A HREF="../TS/TSSetPostStep.html#TSSetPostStep">TSSetPostStep</A>(), <A HREF="../TS/TSGetApplicationContext.html#TSGetApplicationContext">TSGetApplicationContext</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/interface/ts.c.html#TSSetPreStage">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>
</BODY></HTML>
|