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
|
<!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/TSAdaptCandidateAdd.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSAdaptCandidateAdd</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/TSAdaptCandidateAdd.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSAdaptCandidateAdd"><H1>TSAdaptCandidateAdd</H1></A>
add a candidate scheme for the adaptive controller to select from
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"
PetscErrorCode TSAdaptCandidateAdd(TSAdapt adapt,const char name[],PetscInt order,PetscInt stageorder,PetscReal ccfl,PetscReal cost,PetscBool inuse)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>adapt </B></TD><TD>- time step adaptivity context, obtained with <A HREF="../TS/TSGetAdapt.html#TSGetAdapt">TSGetAdapt</A>() or <A HREF="../TS/TSAdaptCreate.html#TSAdaptCreate">TSAdaptCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- name of the candidate scheme to add
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>order </B></TD><TD>- order of the candidate scheme
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>stageorder </B></TD><TD>- stage order of the candidate scheme
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ccfl </B></TD><TD>- stability coefficient relative to explicit Euler, used for CFL constraints
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cost </B></TD><TD>- relative measure of the amount of work required for the candidate scheme
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>inuse </B></TD><TD>- indicates that this scheme is the one currently in use, this flag can only be set for one scheme
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Note</FONT></H3>
This routine is not available in Fortran.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../TS/TSAdaptCandidatesClear.html#TSAdaptCandidatesClear">TSAdaptCandidatesClear</A>(), <A HREF="../TS/TSAdaptChoose.html#TSAdaptChoose">TSAdaptChoose</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>developer
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/ts/adapt/interface/tsadapt.c.html#TSAdaptCandidateAdd">src/ts/adapt/interface/tsadapt.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>
|
