Update documentation

ZibraMax · Jun 5, 2023 · 012bcd1 · 012bcd1
1 parent 2f17d95
commit 012bcd1
Show file tree

Hide file tree

Showing 9 changed files with 48 additions and 7 deletions.
diff --git a/Examples/Examples.html b/Examples/Examples.html
@@ -728,6 +728,12 @@ <h4>Code<a class="headerlink" href="#id8" title="Permalink to this heading">#</a
 <section id="module-Examples.example51">
 <span id="examples-example51-module"></span><h2>Examples.example51 module<a class="headerlink" href="#module-Examples.example51" title="Permalink to this heading">#</a></h2>
 </section>
+<section id="examples-example52-module">
+<h2>Examples.example52 module<a class="headerlink" href="#examples-example52-module" title="Permalink to this heading">#</a></h2>
+</section>
+<section id="module-Examples.example53">
+<span id="examples-example53-module"></span><h2>Examples.example53 module<a class="headerlink" href="#module-Examples.example53" title="Permalink to this heading">#</a></h2>
+</section>
 <section id="module-Examples.example6">
 <span id="examples-example6-module"></span><h2>Examples.example6 module<a class="headerlink" href="#module-Examples.example6" title="Permalink to this heading">#</a></h2>
 <section id="test-of-point-inside-volumen-3d-elements">
@@ -989,6 +995,8 @@ <h4>Code<a class="headerlink" href="#id10" title="Permalink to this heading">#</
 <li><a class="reference internal" href="#module-Examples.example47">Examples.example47 module</a></li>
 <li><a class="reference internal" href="#module-Examples.example5">Examples.example5 module</a></li>
 <li><a class="reference internal" href="#module-Examples.example51">Examples.example51 module</a></li>
+<li><a class="reference internal" href="#examples-example52-module">Examples.example52 module</a></li>
+<li><a class="reference internal" href="#module-Examples.example53">Examples.example53 module</a></li>
 <li><a class="reference internal" href="#module-Examples.example6">Examples.example6 module</a><ul>
 <li><a class="reference internal" href="#test-of-point-inside-volumen-3d-elements">Test of point inside volumen (3D elements)</a><ul>
 <li><a class="reference internal" href="#id9">Code</a></li>

diff --git a/Examples/modules.html b/Examples/modules.html
@@ -300,6 +300,8 @@ <h1>Examples<a class="headerlink" href="#examples" title="Permalink to this head
 <li class="toctree-l2"><a class="reference internal" href="Examples.html#module-Examples.example47">Examples.example47 module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Examples.html#module-Examples.example5">Examples.example5 module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Examples.html#module-Examples.example51">Examples.example51 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Examples.html#examples-example52-module">Examples.example52 module</a></li>
+<li class="toctree-l2"><a class="reference internal" href="Examples.html#module-Examples.example53">Examples.example53 module</a></li>
 <li class="toctree-l2"><a class="reference internal" href="Examples.html#module-Examples.example6">Examples.example6 module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="Examples.html#test-of-point-inside-volumen-3d-elements">Test of point inside volumen (3D elements)</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="Examples.html#id9">Code</a></li>

diff --git a/FEM/FEM.Solvers.html b/FEM/FEM.Solvers.html
@@ -394,7 +394,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>Lineal Finite Element Solver.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="FEM.Solvers.Transient.Parabolic.run">
-<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#FEM.Solvers.Transient.Parabolic.run" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#FEM.Solvers.Transient.Parabolic.run" title="Permalink to this definition">#</a></dt>
 <dd><p>Solves the equation system</p>
 </dd></dl>
 

diff --git a/FEM/FEM.html b/FEM/FEM.html
@@ -638,7 +638,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>docstring for CoreTransient</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="FEM.Core.CoreTransient.apply_initial_condition">
-<span class="sig-name descname"><span class="pre">apply_initial_condition</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#FEM.Core.CoreTransient.apply_initial_condition" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">apply_initial_condition</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dt</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#FEM.Core.CoreTransient.apply_initial_condition" title="Permalink to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py method">
@@ -1375,7 +1375,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 <p>The differential equation is:</p>
 <div class="math-wrapper docutils container">
 <div class="math notranslate nohighlight">
-\[\frac{\partial T}{\partial t}-\frac{\partial}{\partialx}\left(Ak\frac{\partialT}{\partialx}\right)+\beta P(T-T_{\infty})=q\]</div>
+\[\frac{\partial T}{\partial t}-\frac{\partial}{\partial x}\left(Ak\frac{\partial T}{\partial x}\right)+\beta P(T-T_{\infty})=q\]</div>
 </div>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -1412,7 +1412,7 @@ <h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this
 
 <dl class="py method">
 <dt class="sig sig-object py" id="FEM.Heat1D.Heat1DTransient.postProcess">
-<span class="sig-name descname"><span class="pre">postProcess</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">t0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tf</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</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.postProcess" title="Permalink to this definition">#</a></dt>
+<span class="sig-name descname"><span class="pre">postProcess</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">t0</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tf</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dt</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ax</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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.postProcess" title="Permalink to this definition">#</a></dt>
 <dd><p>Post process the solution and steps</p>
 </dd></dl>
 

diff --git a/_sources/Examples/Examples.rst.txt b/_sources/Examples/Examples.rst.txt
@@ -393,6 +393,22 @@ Examples.example51 module
    :undoc-members:
    :show-inheritance:
 
+Examples.example52 module
+-------------------------
+
+.. automodule:: Examples.example52
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Examples.example53 module
+-------------------------
+
+.. automodule:: Examples.example53
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Examples.example6 module
 ------------------------
 

diff --git a/genindex.html b/genindex.html
@@ -586,15 +586,15 @@ <h2>E</h2>
           <li><a href="Examples/Examples.html#module-Examples.example24">module</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li>
     Examples.example25
 
         <ul>
           <li><a href="Examples/Examples.html#module-Examples.example25">module</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li>
     Examples.example26
 
@@ -789,6 +789,13 @@ <h2>E</h2>
 
         <ul>
           <li><a href="Examples/Examples.html#module-Examples.example51">module</a>
+</li>
+        </ul></li>
+        <li>
+    Examples.example53
+
+        <ul>
+          <li><a href="Examples/Examples.html#module-Examples.example53">module</a>
 </li>
         </ul></li>
         <li>
@@ -1469,6 +1476,8 @@ <h2>M</h2>
           <li><a href="Examples/Examples.html#module-Examples.Example50">Examples.Example50</a>
 </li>
           <li><a href="Examples/Examples.html#module-Examples.example51">Examples.example51</a>
+</li>
+          <li><a href="Examples/Examples.html#module-Examples.example53">Examples.example53</a>
 </li>
           <li><a href="Examples/Examples.html#module-Examples.example6">Examples.example6</a>
 </li>

diff --git a/objects.inv b/objects.inv
diff --git a/py-modindex.html b/py-modindex.html
@@ -499,6 +499,12 @@ <h1>Python Module Index</h1>
         <a href="Examples/Examples.html#module-Examples.example51"><code class="xref">Examples.example51</code></a></td><td>
     <em></em></td>
   </tr>
+  <tr class="cg-1">
+    <td></td>
+    <td>&#160;&#160;&#160;
+        <a href="Examples/Examples.html#module-Examples.example53"><code class="xref">Examples.example53</code></a></td><td>
+    <em></em></td>
+  </tr>
   <tr class="cg-1">
     <td></td>
     <td>&#160;&#160;&#160;

diff --git a/searchindex.js b/searchindex.js