Skip to content

Commit

Permalink
collapsed examples in geometries
Browse files Browse the repository at this point in the history
  • Loading branch information
tobre1 committed Dec 16, 2023
1 parent 8c74014 commit 678a4a7
Show file tree
Hide file tree
Showing 13 changed files with 89 additions and 40 deletions.
2 changes: 1 addition & 1 deletion docs/_includes/title.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<img src="../assets/images/logo.png" alt="Logo" class="logo">
<img src="/assets/images/logo.png" alt="Logo" class="logo">
<pre> </pre>
<p style="color:rgb(0, 80, 119);font-size:140%;">ViennaPS</p>
10 changes: 5 additions & 5 deletions docs/_site/assets/js/search-data.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/_site/geo/basic/fin.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@
<span class="k">const</span> <span class="kt">bool</span> <span class="n">periodicBoundary</span> <span class="o">=</span> <span class="nb">false</span><span class="p">,</span>
<span class="k">const</span> <span class="kt">bool</span> <span class="n">makeMask</span> <span class="o">=</span> <span class="nb">false</span><span class="p">,</span>
<span class="k">const</span> <span class="n">psMaterial</span> <span class="n">material</span> <span class="o">=</span> <span class="n">psMaterial</span><span class="o">::</span><span class="n">None</span><span class="p">)</span>
</code></pre></div></div> <div class="table-wrapper"><table> <thead> <tr> <th>Parameter</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">domain</code></td> <td>Specifies the type of domain for the fin geometry.</td> <td><code class="language-plaintext highlighter-rouge">psSmartPointer&lt;psDomain&lt;NumericType, D&gt;</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">gridDelta</code></td> <td>Represents the grid spacing or resolution used in the simulation.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">xExtent</code></td> <td>Defines the extent of the fin geometry in the x-direction.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">yExtent</code></td> <td>Specifies the extent of the fin geometry in the y-direction.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">finWidth</code></td> <td>Sets the width of the fin.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">finHeight</code></td> <td>Determines the height of the fin.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">baseHeight</code></td> <td>(Optional) Sets the base height of the fin. Default is set to 0.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">periodicBoundary</code></td> <td>(Optional) If set to true, enables periodic boundaries in both x and y directions. Default is set to false.</td> <td><code class="language-plaintext highlighter-rouge">bool</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">makeMask</code></td> <td>(Optional) If set to true, allows the fin to function as a mask, with specified material applied only to the bottom. Default is set to false.</td> <td><code class="language-plaintext highlighter-rouge">bool</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">material</code></td> <td>(Optional) Specifies the material used for the fin. Default is set to <code class="language-plaintext highlighter-rouge">psMaterial_None</code>.</td> <td><code class="language-plaintext highlighter-rouge">psMaterial</code></td> </tr> </tbody> </table></div> <p><strong>Example usage:</strong></p> <p class="label label-blue">C++:</p> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">auto</span> <span class="n">domain</span> <span class="o">=</span> <span class="n">psSmartPointer</span><span class="o">&lt;</span><span class="n">psDomain</span><span class="o">&lt;</span><span class="n">NumericType</span><span class="p">,</span> <span class="n">D</span><span class="o">&gt;&gt;::</span><span class="n">New</span><span class="p">();</span>
</code></pre></div></div> <div class="table-wrapper"><table> <thead> <tr> <th>Parameter</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">domain</code></td> <td>Specifies the type of domain for the fin geometry.</td> <td><code class="language-plaintext highlighter-rouge">psSmartPointer&lt;psDomain&lt;NumericType, D&gt;</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">gridDelta</code></td> <td>Represents the grid spacing or resolution used in the simulation.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">xExtent</code></td> <td>Defines the extent of the fin geometry in the x-direction.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">yExtent</code></td> <td>Specifies the extent of the fin geometry in the y-direction.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">finWidth</code></td> <td>Sets the width of the fin.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">finHeight</code></td> <td>Determines the height of the fin.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">baseHeight</code></td> <td>(Optional) Sets the base height of the fin. Default is set to 0.</td> <td><code class="language-plaintext highlighter-rouge">NumericType</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">periodicBoundary</code></td> <td>(Optional) If set to true, enables periodic boundaries in both x and y directions. Default is set to false.</td> <td><code class="language-plaintext highlighter-rouge">bool</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">makeMask</code></td> <td>(Optional) If set to true, allows the fin to function as a mask, with specified material applied only to the bottom. Default is set to false.</td> <td><code class="language-plaintext highlighter-rouge">bool</code></td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">material</code></td> <td>(Optional) Specifies the material used for the fin. Default is set to <code class="language-plaintext highlighter-rouge">psMaterial_None</code>.</td> <td><code class="language-plaintext highlighter-rouge">psMaterial</code></td> </tr> </tbody> </table></div> <p><strong>Example usage:</strong></p> <details> <summary> <p class="label label-blue">C++</p> </summary> <div class="language-c++ highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">auto</span> <span class="n">domain</span> <span class="o">=</span> <span class="n">psSmartPointer</span><span class="o">&lt;</span><span class="n">psDomain</span><span class="o">&lt;</span><span class="n">NumericType</span><span class="p">,</span> <span class="n">D</span><span class="o">&gt;&gt;::</span><span class="n">New</span><span class="p">();</span>
<span class="n">psMakeFin</span><span class="o">&lt;</span><span class="n">NumericType</span><span class="p">,</span> <span class="n">D</span><span class="o">&gt;</span><span class="p">(</span><span class="n">domain</span><span class="p">,</span> <span class="mf">0.5</span><span class="p">,</span> <span class="mf">10.0</span><span class="p">,</span> <span class="mf">10.0</span><span class="p">,</span> <span class="mf">5.0</span><span class="p">,</span> <span class="mf">5.0</span><span class="p">,</span> <span class="mf">0.</span><span class="p">,</span> <span class="nb">false</span><span class="p">,</span> <span class="nb">false</span><span class="p">,</span>
<span class="n">psMaterial</span><span class="o">::</span><span class="n">Si</span><span class="p">)</span>
<span class="p">.</span><span class="n">apply</span><span class="p">();</span>
</code></pre></div></div> <p class="label label-green">Python:</p> <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">domain</span> <span class="o">=</span> <span class="n">vps</span><span class="p">.</span><span class="nc">Domain</span><span class="p">()</span>
</code></pre></div> </div> </details> <details> <summary> <p class="label label-green">Python:</p> </summary> <div class="language-python highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="n">domain</span> <span class="o">=</span> <span class="n">vps</span><span class="p">.</span><span class="nc">Domain</span><span class="p">()</span>
<span class="n">vps</span><span class="p">.</span><span class="nc">MakeFin</span><span class="p">(</span><span class="n">domain</span><span class="o">=</span><span class="n">domain</span><span class="p">,</span>
<span class="n">gridDelta</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
<span class="n">xExtent</span><span class="o">=</span><span class="mf">10.0</span><span class="p">,</span>
Expand All @@ -25,4 +25,4 @@
<span class="n">makeMask</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span>
<span class="n">material</span><span class="o">=</span><span class="n">vps</span><span class="p">.</span><span class="n">Material</span><span class="p">.</span><span class="n">Si</span><span class="p">,</span>
<span class="p">).</span><span class="nf">apply</span><span class="p">()</span>
</code></pre></div></div> </main> <hr> <footer> <div class="d-flex mt-2"> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
</code></pre></div> </div> </details> </main> <hr> <footer> <div class="d-flex mt-2"> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> </body> </html>
Loading

0 comments on commit 678a4a7

Please sign in to comment.