Documentation for f1eddf4d65

This commit is contained in:
realstealthninja
2025-07-09 10:53:16 +00:00
parent e7edde96ab
commit b41207008f
2497 changed files with 31270 additions and 40283 deletions

View File

@@ -4,7 +4,7 @@
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TheAlgorithms/C++: numerical_methods/ode_semi_implicit_euler.cpp File Reference</title>
<link rel="icon" href="../../favicon.svg" type="image/x-icon" />
@@ -19,7 +19,6 @@
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../cookie.js"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
@@ -60,26 +59,20 @@ window.MathJax = {
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "../../search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(1); });
/* @license-end */
$(function() { codefold.init(); });
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('../../',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
@@ -94,10 +87,9 @@ $(function() {
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('d3/d06/ode__semi__implicit__euler_8cpp.html','../../'); initResizable(true); });
/* @license-end */
$(function(){initNavTree('d3/d06/ode__semi__implicit__euler_8cpp.html','../../',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -121,8 +113,6 @@ $(function(){initNavTree('d3/d06/ode__semi__implicit__euler_8cpp.html','../../')
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ode_semi_implicit_euler.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
@@ -137,31 +127,25 @@ $(function(){initNavTree('d3/d06/ode__semi__implicit__euler_8cpp.html','../../')
</div><div class="textblock"><div class="dynheader">
Include dependency graph for ode_semi_implicit_euler.cpp:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="../../d6/db4/ode__semi__implicit__euler_8cpp__incl.svg" width="423" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<div class="center"><iframe scrolling="no" loading="lazy" frameborder="0" src="../../d6/db4/ode__semi__implicit__euler_8cpp__incl.svg" width="423" height="126"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
<p><a href="../../d3/d06/ode__semi__implicit__euler_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:abaeae8f62a018d197f0187a1c80a90fe" id="r_abaeae8f62a018d197f0187a1c80a90fe"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abaeae8f62a018d197f0187a1c80a90fe">problem</a> (const double &amp;x, std::valarray&lt; double &gt; *y, std::valarray&lt; double &gt; *dy)</td></tr>
<tr class="memdesc:abaeae8f62a018d197f0187a1c80a90fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Problem statement for a system with first-order differential equations. Updates the system differential variables. <br /></td></tr>
<tr class="separator:abaeae8f62a018d197f0187a1c80a90fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af3adf7b092a87868917ee5fb4255192b" id="r_af3adf7b092a87868917ee5fb4255192b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af3adf7b092a87868917ee5fb4255192b">exact_solution</a> (const double &amp;x, std::valarray&lt; double &gt; *y)</td></tr>
<tr class="memdesc:af3adf7b092a87868917ee5fb4255192b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exact solution of the problem. Used for solution comparison. <br /></td></tr>
<tr class="separator:af3adf7b092a87868917ee5fb4255192b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga827bf009831ddc477c5fa8891d5cb35f" id="r_ga827bf009831ddc477c5fa8891d5cb35f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d60/group__ode.html#ga827bf009831ddc477c5fa8891d5cb35f">semi_implicit_euler_step</a> (const double dx, const double &amp;x, std::valarray&lt; double &gt; *y, std::valarray&lt; double &gt; *dy)</td></tr>
<tr class="memdesc:ga827bf009831ddc477c5fa8891d5cb35f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute next step approximation using the semi-implicit-Euler method. <br /></td></tr>
<tr class="separator:ga827bf009831ddc477c5fa8891d5cb35f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3874d294ab00fe9ce8731c5b7991a089" id="r_ga3874d294ab00fe9ce8731c5b7991a089"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="../../d6/d60/group__ode.html#ga3874d294ab00fe9ce8731c5b7991a089">semi_implicit_euler</a> (double dx, double x0, double x_max, std::valarray&lt; double &gt; *y, bool save_to_file=false)</td></tr>
<tr class="memdesc:ga3874d294ab00fe9ce8731c5b7991a089"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute approximation using the semi-implicit-Euler method in the given limits. <br /></td></tr>
<tr class="separator:ga3874d294ab00fe9ce8731c5b7991a089"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa13517b8e5de1b75592052db7f7e237f" id="r_aa13517b8e5de1b75592052db7f7e237f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa13517b8e5de1b75592052db7f7e237f">save_exact_solution</a> (const double &amp;X0, const double &amp;X_MAX, const double &amp;step_size, const std::valarray&lt; double &gt; &amp;Y0)</td></tr>
<tr class="separator:aa13517b8e5de1b75592052db7f7e237f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ddf1224851353fc92bfbff6f499fa97" id="r_a0ddf1224851353fc92bfbff6f499fa97"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0ddf1224851353fc92bfbff6f499fa97">main</a> (int argc, char *argv[])</td></tr>
<tr class="separator:a0ddf1224851353fc92bfbff6f499fa97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Solve a multivariable first order <a href="https://en.wikipedia.org/wiki/Ordinary_differential_equation" target="_blank">ordinary differential equation (ODEs)</a> using <a href="https://en.wikipedia.org/wiki/Semi-implicit_Euler_method" target="_blank">semi implicit Euler method</a> </p>
<dl class="section author"><dt>Authors</dt><dd><a href="https://github.com/kvedala" target="_blank">Krishna Vedala</a> </dd></dl>
<p>The ODE being solved is: </p><p class="formulaDsp">
@@ -176,14 +160,14 @@ Functions</h2></td></tr>
v(x) &amp;=&amp; -\sin(x)\\
\end{eqnarray*}
</p>
<p> The computation results are stored to a text file <code>semi_implicit_euler.csv</code> and the exact soltuion results in <code>exact.csv</code> for comparison. <img src="https://raw.githubusercontent.com/TheAlgorithms/C-Plus-Plus/docs/images/numerical_methods/ode_semi_implicit_euler.svg" alt="Implementation solution" style="pointer-events: none;" class="inline"/></p>
<p> The computation results are stored to a text file <span class="tt">semi_implicit_euler.csv</span> and the exact soltuion results in <span class="tt">exact.csv</span> for comparison. <img src="https://raw.githubusercontent.com/TheAlgorithms/C-Plus-Plus/docs/images/numerical_methods/ode_semi_implicit_euler.svg" alt="Implementation solution" style="pointer-events: none;" class="inline"/></p>
<p>To implement <a href="https://en.wikipedia.org/wiki/Van_der_Pol_oscillator" target="_blank">Van der Pol oscillator</a>, change the <a class="el" href="#abaeae8f62a018d197f0187a1c80a90fe" title="Problem statement for a system with first-order differential equations. Updates the system differenti...">problem</a> function to: </p><div class="fragment"><div class="line"><span class="keyword">const</span> <span class="keywordtype">double</span> mu = 2.0;</div>
<div class="line">dy[0] = y[1];</div>
<div class="line">dy[1] = mu * (1.f - y[0] * y[0]) * y[1] - y[0];</div>
</div><!-- fragment --> <dl class="section see"><dt>See also</dt><dd><a class="el" href="../../d6/dd3/ode__midpoint__euler_8cpp.html" title="Solve a multivariable first order ordinary differential equation (ODEs) using midpoint Euler method">ode_midpoint_euler.cpp</a>, <a class="el" href="../../db/dd3/ode__forward__euler_8cpp.html" title="Solve a multivariable first order ordinary differential equation (ODEs) using forward Euler method">ode_forward_euler.cpp</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="../../d3/d06/ode__semi__implicit__euler_8cpp_source.html">ode_semi_implicit_euler.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
</div><a name="doc-func-members" id="doc-func-members"></a><h2 id="header-doc-func-members" class="groupheader">Function Documentation</h2>
<a id="af3adf7b092a87868917ee5fb4255192b" name="af3adf7b092a87868917ee5fb4255192b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af3adf7b092a87868917ee5fb4255192b">&#9670;&#160;</a></span>exact_solution()</h2>
@@ -389,11 +373,19 @@ Functions</h2></td></tr>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="../../dir_9c6faab82c22511b50177aa2e38e2780.html">numerical_methods</a></li><li class="navelem"><a class="el" href="../../d3/d06/ode__semi__implicit__euler_8cpp.html">ode_semi_implicit_euler.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
<li class="navelem"><a href="../../dir_9c6faab82c22511b50177aa2e38e2780.html">numerical_methods</a></li><li class="navelem"><a href="../../d3/d06/ode__semi__implicit__euler_8cpp.html">ode_semi_implicit_euler.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>