File: TSPseudoSetTimeStep.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 (57 lines) | stat: -rw-r--r-- 3,116 bytes parent folder | download
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
56
57
<!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/TSPseudoSetTimeStep.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSPseudoSetTimeStep</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/TSPseudoSetTimeStep.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSPseudoSetTimeStep"><H1>TSPseudoSetTimeStep</H1></A>
Sets the user-defined routine to be called at each pseudo-timestep to update the timestep. 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"   
PetscErrorCode  TSPseudoSetTimeStep(TS ts,PetscErrorCode (*dt)(TS,PetscReal*,void*),void *ctx)
</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>- timestep context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dt </B></TD><TD>- function to compute timestep
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- [optional] user-defined context for private data
required by the function (may be NULL)
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">Calling sequence of func</FONT></H3>
<DT><B>func (<A HREF="../TS/TS.html#TS">TS</A> ts,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> *newdt,void *ctx);</B> -
<br>
<DT><B>newdt </B> -the newly computed timestep
<br>
<DT><B>ctx </B> -[optional] timestep context
<br>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The routine set here will be called by <A HREF="../TS/TSPseudoComputeTimeStep.html#TSPseudoComputeTimeStep">TSPseudoComputeTimeStep</A>()
during the timestepping process.
If not set then <A HREF="../TS/TSPseudoTimeStepDefault.html#TSPseudoTimeStepDefault">TSPseudoTimeStepDefault</A>() is automatically used
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 timestep, pseudo, set
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../TS/TSPseudoTimeStepDefault.html#TSPseudoTimeStepDefault">TSPseudoTimeStepDefault</A>(), <A HREF="../TS/TSPseudoComputeTimeStep.html#TSPseudoComputeTimeStep">TSPseudoComputeTimeStep</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/impls/pseudo/posindep.c.html#TSPseudoSetTimeStep">src/ts/impls/pseudo/posindep.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>
</BODY></HTML>