Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Jun 6, 2023
1 parent 012bcd1 commit 7109258
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 1 deletion.
20 changes: 20 additions & 0 deletions FEM/FEM.html
Original file line number Diff line number Diff line change
Expand Up @@ -1390,6 +1390,19 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="FEM.Heat1D.Heat1DTransient.borderConditions">
<span class="sig-name descname"><span class="pre">borderConditions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#FEM.Heat1D.Heat1DTransient.borderConditions" title="Permalink to this definition">#</a></dt>
<dd><p>Assign border conditions to the system.
The border conditios are assigned in this order:</p>
<ol class="arabic simple">
<li><p>Natural border conditions</p></li>
<li><p>Essential border conditions</p></li>
</ol>
<p>This ensures that in a node with 2 border conditions
the essential border conditions will be applied.</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="FEM.Heat1D.Heat1DTransient.defineConvectiveBoderConditions">
<span class="sig-name descname"><span class="pre">defineConvectiveBoderConditions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#FEM.Heat1D.Heat1DTransient.defineConvectiveBoderConditions" title="Permalink to this definition">#</a></dt>
Expand All @@ -1416,6 +1429,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
<dd><p>Post process the solution and steps</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="FEM.Heat1D.Heat1DTransient.set_convective_conditions">
<span class="sig-name descname"><span class="pre">set_convective_conditions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FEM.Heat1D.Heat1DTransient.set_convective_conditions" title="Permalink to this definition">#</a></dt>
<dd></dd></dl>

</dd></dl>

</section>
Expand Down Expand Up @@ -1793,9 +1811,11 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
</ul>
</li>
<li><a class="reference internal" href="#FEM.Heat1D.Heat1DTransient"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient</span></code></a><ul>
<li><a class="reference internal" href="#FEM.Heat1D.Heat1DTransient.borderConditions"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.borderConditions()</span></code></a></li>
<li><a class="reference internal" href="#FEM.Heat1D.Heat1DTransient.defineConvectiveBoderConditions"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.defineConvectiveBoderConditions()</span></code></a></li>
<li><a class="reference internal" href="#FEM.Heat1D.Heat1DTransient.elementMatrices"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.elementMatrices()</span></code></a></li>
<li><a class="reference internal" href="#FEM.Heat1D.Heat1DTransient.postProcess"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.postProcess()</span></code></a></li>
<li><a class="reference internal" href="#FEM.Heat1D.Heat1DTransient.set_convective_conditions"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.set_convective_conditions()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 2 additions & 0 deletions FEM/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -388,9 +388,11 @@ <h1>FEM<a class="headerlink" href="#fem" title="Permalink to this heading">#</a>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="FEM.html#FEM.Heat1D.Heat1DTransient"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="FEM.html#FEM.Heat1D.Heat1DTransient.borderConditions"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.borderConditions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="FEM.html#FEM.Heat1D.Heat1DTransient.defineConvectiveBoderConditions"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.defineConvectiveBoderConditions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="FEM.html#FEM.Heat1D.Heat1DTransient.elementMatrices"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.elementMatrices()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="FEM.html#FEM.Heat1D.Heat1DTransient.postProcess"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.postProcess()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="FEM.html#FEM.Heat1D.Heat1DTransient.set_convective_conditions"><code class="docutils literal notranslate"><span class="pre">Heat1DTransient.set_convective_conditions()</span></code></a></li>
</ul>
</li>
</ul>
Expand Down
6 changes: 6 additions & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,11 @@ <h2>B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="FEM/FEM.html#FEM.Core.Core.borderConditions">borderConditions() (FEM.Core.Core method)</a>

<ul>
<li><a href="FEM/FEM.html#FEM.Heat1D.Heat1DTransient.borderConditions">(FEM.Heat1D.Heat1DTransient method)</a>
</li>
</ul></li>
<li><a href="FEM/FEM.Geometry.html#FEM.Geometry.Geometree.Quadrant3D.boxes_disjoint">boxes_disjoint() (FEM.Geometry.Geometree.Quadrant3D method)</a>
</li>
</ul></td>
Expand Down Expand Up @@ -1807,6 +1811,8 @@ <h2>S</h2>
<li><a href="FEM/FEM.Elements.E2D.html#FEM.Elements.E2D.Serendipity.Serendipity">Serendipity (class in FEM.Elements.E2D.Serendipity)</a>
</li>
<li><a href="FEM/FEM.html#FEM.Core.CoreParabolic.set_alpha">set_alpha() (FEM.Core.CoreParabolic method)</a>
</li>
<li><a href="FEM/FEM.html#FEM.Heat1D.Heat1DTransient.set_convective_conditions">set_convective_conditions() (FEM.Heat1D.Heat1DTransient method)</a>
</li>
<li><a href="FEM/FEM.html#FEM.Core.CoreHiperbolic.set_initial_condition">set_initial_condition() (FEM.Core.CoreHiperbolic method)</a>

Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 7109258

Please sign in to comment.