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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sensitivity/TSForwardSetSensitivities.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSForwardSetSensitivities</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/Sensitivity/TSForwardSetSensitivities.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSForwardSetSensitivities"><H1>TSForwardSetSensitivities</H1></A>
Sets the initial value of the trajectory sensitivities of solution w.r.t. the problem parameters and initial values.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Sensitivity/TSForwardSetSensitivities.html#TSForwardSetSensitivities">TSForwardSetSensitivities</A>(<A HREF="../TS/TS.html#TS">TS</A> ts,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nump,<A HREF="../Mat/Mat.html#Mat">Mat</A> Smat)
</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>nump </B></TD><TD>- number of parameters
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>Smat </B></TD><TD>- sensitivities with respect to the parameters, the number of entries in these vectors is the same as the number of parameters
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Forward sensitivity is also called 'trajectory sensitivity' in some fields such as power systems.
This function turns on a flag to trigger <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>() to compute forward sensitivities automatically.
You must call this function before <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>().
The entries in the sensitivity matrix must be correctly initialized with the values S = dy/dp|startingtime.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sensitivity/TSForwardGetSensitivities.html#TSForwardGetSensitivities">TSForwardGetSensitivities</A>(), <A HREF="../Sensitivity/TSForwardSetIntegralGradients.html#TSForwardSetIntegralGradients">TSForwardSetIntegralGradients</A>(), <A HREF="../Sensitivity/TSForwardGetIntegralGradients.html#TSForwardGetIntegralGradients">TSForwardGetIntegralGradients</A>(), <A HREF="../Sensitivity/TSForwardStep.html#TSForwardStep">TSForwardStep</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/ts/interface/sensitivity/tssen.c.html#TSForwardSetSensitivities">src/ts/interface/sensitivity/tssen.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ts/tutorials/ex16fwd.c.html">src/ts/tutorials/ex16fwd.c.html</A><BR>
<BR><A HREF="./index.html">Index of all Sensitivity 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>
|