Skip to content

Commit

Permalink
Deploying to gh-pages from @ 148fca6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
gha3mi committed Apr 7, 2024
1 parent 54c73e0 commit 25f6987
Show file tree
Hide file tree
Showing 136 changed files with 437 additions and 417 deletions.
34 changes: 27 additions & 7 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,7 @@ <h2>How to run examples</h2>
<p><strong>Clone the repository:</strong></p>
<p>Clone the <code>ForCAD</code> repository from GitHub:</p>
<div class="codehilite"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/gha3mi/forcad.git
</code></pre></div>

<div class="codehilite"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>forcad
<span class="nb">cd</span><span class="w"> </span>forcad
</code></pre></div>

<h3>Using fpm</h3>
Expand All @@ -120,23 +118,45 @@ <h2>API documentation</h2>
<div class="codehilite"><pre><span></span><code>ford<span class="w"> </span>ford.yml
</code></pre></div>

<h2>ToDo</h2>
<h2>Roadmap</h2>
<p>This roadmap outlines upcoming features and enhancements for ForCAD. Feel free to contribute to these tasks or suggest new ideas!</p>
<ul>
<li>
<p>v0.2.0:</p>
<ul>
<li>[x] Add <code>insert_knots()</code> method for curves, surfaces and volumes.</li>
<li>[x] Add <code>elevate_degree()</code> method for curves, surfaces and volumes.</li>
<li>[x] Add <code>derivative()</code> method for curves, surfaces and volumes.</li>
</ul>
</li>
<li>
<p>v0.3.0:</p>
<ul>
<li>[ ] Add <code>remove_knots()</code> method for curves, surfaces and volumes.</li>
<li>[ ] Add <code>reduce_degree()</code> method for curves, surfaces and volumes.</li>
</ul>
</li>
<li>
<p>Future Tasks:</p>
<ul>
<li>[ ] Design a logo.</li>
<li>[ ] Add support binary <code>vtk</code> files.</li>
<li>[ ] Add support for multiple patches.</li>
<li>[ ] Add extraction of piecewise Bezier objects from NURBS.</li>
</ul>
</li>
</ul>
<h2>Contributing</h2>
<p>Contributions to <code>ForCAD</code> are welcome!
If you find any issues or would like to suggest improvements, please open an issue.</p>
<h2>References</h2>
<ul>
<li><a href="https://doi.org/10.1007/978-3-642-97385-7">The NURBS Book</a> by Les Piegl, Wayne Tiller</li>
<li><a href="https://doi.org/10.1016/B978-1-55860-669-2.X5000-3">An Introduction to NURBS</a> by David F. Rogers</li>
<li>
<p>Piegl, L., &amp; Tiller, W. (1995). The NURBS Book. In Monographs in Visual Communications. Springer Berlin Heidelberg. <a href="https://doi.org/10.1007/978-3-642-97385-7">https://doi.org/10.1007/978-3-642-97385-7</a></p>
</li>
<li>
<p>An Introduction to NURBS. (2001). Elsevier. <a href="https://doi.org/10.1016/b978-1-55860-669-2.x5000-3">https://doi.org/10.1016/b978-1-55860-669-2.x5000-3</a></p>
</li>
</ul>
</div>
<div class="col-md-4">
Expand Down Expand Up @@ -220,7 +240,7 @@ <h3>Derived Types</h3>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions interface/compute_multiplicity.html
Original file line number Diff line number Diff line change
Expand Up @@ -1166,7 +1166,7 @@ <h4>Arguments</h4>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-knot~4"></span>
<span class="anchor" id="variable-knot~3"></span>
real(kind=rk),
</td>
<td>intent(in)</td>
Expand Down Expand Up @@ -1215,7 +1215,7 @@ <h4>Arguments</h4>
<tbody>
<tr>
<td>
<span class="anchor" id="variable-knot~5"></span>
<span class="anchor" id="variable-knot~4"></span>
real(kind=rk),
</td>
<td>intent(in),</td>
Expand Down Expand Up @@ -1272,7 +1272,7 @@ <h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion interface/elemconn_c0.html
Original file line number Diff line number Diff line change
Expand Up @@ -1019,7 +1019,7 @@ <h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion interface/ndgrid.html
Original file line number Diff line number Diff line change
Expand Up @@ -808,7 +808,7 @@ <h4>Arguments</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/modules.html
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
42 changes: 21 additions & 21 deletions lists/procedures.html
Original file line number Diff line number Diff line change
Expand Up @@ -289,13 +289,13 @@ <h1>Procedures</h1>
</tr>
<tr>
<td><a href='../proc/generate_xc.html'>generate_Xc</a></td>
<td><a href='../program/example3_volume.html'>example3_volume</a></td>
<td><a href='../program/example_nurbs_volume.html'>example_nurbs_volume</a></td>
<td>Function</td>
<td></td>
</tr>
<tr>
<td><a href='../proc/generate_xc~2.html'>generate_Xc</a></td>
<td><a href='../program/example_nurbs_surface.html'>example_nurbs_surface</a></td>
<td><a href='../program/example3_volume.html'>example3_volume</a></td>
<td>Function</td>
<td></td>
</tr>
Expand All @@ -307,13 +307,13 @@ <h1>Procedures</h1>
</tr>
<tr>
<td><a href='../proc/generate_xc~4.html'>generate_Xc</a></td>
<td><a href='../program/example3_surface.html'>example3_surface</a></td>
<td><a href='../program/example_nurbs_surface.html'>example_nurbs_surface</a></td>
<td>Function</td>
<td></td>
</tr>
<tr>
<td><a href='../proc/generate_xc~5.html'>generate_Xc</a></td>
<td><a href='../program/example_nurbs_volume.html'>example_nurbs_volume</a></td>
<td><a href='../program/example3_surface.html'>example3_surface</a></td>
<td>Function</td>
<td></td>
</tr>
Expand Down Expand Up @@ -1587,17 +1587,17 @@ <h1>Procedures</h1>
<g id="call~~graph~~CallGraph_node41" class="node">
<title>proc~generate_xc</title>
<g id="a_call~~graph~~CallGraph_node41"><a xlink:href="../proc/generate_xc.html" xlink:title="generate_Xc">
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-840 229,-840 229,-816 309,-816 309,-840"/>
<text text-anchor="middle" x="269" y="-825.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-512 229,-512 229,-488 309,-488 309,-512"/>
<text text-anchor="middle" x="269" y="-497.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
</a>
</g>
</g>
<!-- proc~generate_xc~2 -->
<g id="call~~graph~~CallGraph_node42" class="node">
<title>proc~generate_xc~2</title>
<g id="a_call~~graph~~CallGraph_node42"><a xlink:href="../proc/generate_xc~2.html" xlink:title="generate_Xc">
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-1084 229,-1084 229,-1060 309,-1060 309,-1084"/>
<text text-anchor="middle" x="269" y="-1069.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-840 229,-840 229,-816 309,-816 309,-840"/>
<text text-anchor="middle" x="269" y="-825.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
</a>
</g>
</g>
Expand All @@ -1614,17 +1614,17 @@ <h1>Procedures</h1>
<g id="call~~graph~~CallGraph_node44" class="node">
<title>proc~generate_xc~4</title>
<g id="a_call~~graph~~CallGraph_node44"><a xlink:href="../proc/generate_xc~4.html" xlink:title="generate_Xc">
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-1492 229,-1492 229,-1468 309,-1468 309,-1492"/>
<text text-anchor="middle" x="269" y="-1477.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-1084 229,-1084 229,-1060 309,-1060 309,-1084"/>
<text text-anchor="middle" x="269" y="-1069.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
</a>
</g>
</g>
<!-- proc~generate_xc~5 -->
<g id="call~~graph~~CallGraph_node45" class="node">
<title>proc~generate_xc~5</title>
<g id="a_call~~graph~~CallGraph_node45"><a xlink:href="../proc/generate_xc~5.html" xlink:title="generate_Xc">
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-512 229,-512 229,-488 309,-488 309,-512"/>
<text text-anchor="middle" x="269" y="-497.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
<polygon fill="#d94e8f" stroke="#d94e8f" points="309,-1492 229,-1492 229,-1468 309,-1468 309,-1492"/>
<text text-anchor="middle" x="269" y="-1477.6" font-family="Helvetica,sans-Serif" font-size="10.50" fill="white">generate_Xc</text>
</a>
</g>
</g>
Expand Down Expand Up @@ -2405,9 +2405,9 @@ <h1>Procedures</h1>
<path fill="none" stroke="#ff0044" d="M100.14,-1366.83C121.41,-1357.78 151.69,-1345.56 179,-1337 186.35,-1334.7 194.11,-1332.51 201.86,-1330.48"/>
<polygon fill="#ff0044" stroke="#ff0044" points="202.81,-1333.85 211.64,-1328 201.09,-1327.07 202.81,-1333.85"/>
</g>
<!-- program~example3_surface&#45;&gt;proc~generate_xc~4 -->
<!-- program~example3_surface&#45;&gt;proc~generate_xc~5 -->
<g id="call~~graph~~CallGraph_edge123" class="edge">
<title>program~example3_surface&#45;&gt;proc~generate_xc~4</title>
<title>program~example3_surface&#45;&gt;proc~generate_xc~5</title>
<path fill="none" stroke="#ff0044" d="M126.73,-1390.85C132.51,-1393.34 138.07,-1396.36 143,-1400 166.2,-1417.14 155.75,-1436.92 179,-1454 190.69,-1462.59 205.18,-1468.35 219.05,-1472.22"/>
<polygon fill="#ff0044" stroke="#ff0044" points="218.44,-1475.67 228.99,-1474.71 220.14,-1468.88 218.44,-1475.67"/>
</g>
Expand Down Expand Up @@ -2462,9 +2462,9 @@ <h1>Procedures</h1>
<path fill="none" stroke="#ff0036" d="M79.23,-835.81C93.84,-810.52 131.07,-752.28 179,-723 182.84,-720.66 186.92,-718.57 191.13,-716.72"/>
<polygon fill="#ff0036" stroke="#ff0036" points="192.52,-719.94 200.55,-713.03 189.97,-713.42 192.52,-719.94"/>
</g>
<!-- program~example3_volume&#45;&gt;proc~generate_xc -->
<!-- program~example3_volume&#45;&gt;proc~generate_xc~2 -->
<g id="call~~graph~~CallGraph_edge131" class="edge">
<title>program~example3_volume&#45;&gt;proc~generate_xc</title>
<title>program~example3_volume&#45;&gt;proc~generate_xc~2</title>
<path fill="none" stroke="#ff0036" d="M126.7,-842.46C155.58,-839.5 190.84,-835.89 218.92,-833.02"/>
<polygon fill="#ff0036" stroke="#ff0036" points="219.32,-836.5 228.91,-832 218.6,-829.54 219.32,-836.5"/>
</g>
Expand Down Expand Up @@ -2558,9 +2558,9 @@ <h1>Procedures</h1>
<path fill="none" stroke="#ff001b" d="M80.26,-1185.3C95.95,-1209.14 133.8,-1261.77 179,-1290 185.53,-1294.08 192.72,-1297.54 200.11,-1300.47"/>
<polygon fill="#ff001b" stroke="#ff001b" points="198.93,-1303.77 209.52,-1303.91 201.33,-1297.19 198.93,-1303.77"/>
</g>
<!-- program~example_nurbs_surface&#45;&gt;proc~generate_xc~2 -->
<!-- program~example_nurbs_surface&#45;&gt;proc~generate_xc~4 -->
<g id="call~~graph~~CallGraph_edge144" class="edge">
<title>program~example_nurbs_surface&#45;&gt;proc~generate_xc~2</title>
<title>program~example_nurbs_surface&#45;&gt;proc~generate_xc~4</title>
<path fill="none" stroke="#ff001b" d="M86.36,-1160.94C105.83,-1144.57 142.94,-1115.37 179,-1098 191.48,-1091.99 205.63,-1087.08 218.91,-1083.21"/>
<polygon fill="#ff001b" stroke="#ff001b" points="220.16,-1086.5 228.86,-1080.46 218.29,-1079.75 220.16,-1086.5"/>
</g>
Expand Down Expand Up @@ -2603,9 +2603,9 @@ <h1>Procedures</h1>
<path fill="none" stroke="#ff000d" d="M84.81,-613.01C103.55,-630.61 141.09,-663.25 179,-681 183.56,-683.13 188.35,-685.06 193.25,-686.8"/>
<polygon fill="#ff000d" stroke="#ff000d" points="192.17,-690.13 202.77,-689.92 194.35,-683.48 192.17,-690.13"/>
</g>
<!-- program~example_nurbs_volume&#45;&gt;proc~generate_xc~5 -->
<!-- program~example_nurbs_volume&#45;&gt;proc~generate_xc -->
<g id="call~~graph~~CallGraph_edge150" class="edge">
<title>program~example_nurbs_volume&#45;&gt;proc~generate_xc~5</title>
<title>program~example_nurbs_volume&#45;&gt;proc~generate_xc</title>
<path fill="none" stroke="#ff000d" d="M84.81,-588.99C103.55,-571.39 141.09,-538.75 179,-521 191.37,-515.21 205.49,-510.93 218.77,-507.82"/>
<polygon fill="#ff000d" stroke="#ff000d" points="219.7,-511.2 228.72,-505.65 218.21,-504.36 219.7,-511.2"/>
</g>
Expand Down Expand Up @@ -2711,7 +2711,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/programs.html
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h1>Programs</h1>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
2 changes: 1 addition & 1 deletion lists/types.html
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
6 changes: 3 additions & 3 deletions module/forcad.html
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,10 @@ <h3 class="card-header card-title bg-light">Uses</h3>
<ul class="list-group list-group-flush">
<li class="list-group-item">
<ul class="list-inline">
<li class="list-inline-item"><a href='forcad_nurbs_volume.html'>forcad_nurbs_volume</a></li>
<li class="list-inline-item"><a href='forcad_nurbs_surface.html'>forcad_nurbs_surface</a></li>
<li class="list-inline-item"><a href='forcad_utils.html'>forcad_utils</a></li>
<li class="list-inline-item"><a href='forcad_nurbs_volume.html'>forcad_nurbs_volume</a></li>
<li class="list-inline-item"><a href='forcad_nurbs_curve.html'>forcad_nurbs_curve</a></li>
<li class="list-inline-item"><a href='forcad_utils.html'>forcad_utils</a></li>
</ul>
</li>
<li class="list-group-item">
Expand Down Expand Up @@ -546,7 +546,7 @@ <h4 class="modal-title" id="-graph-help-label">Graph Key</h4>
<p class="text-end">
Documentation generated by
<a href="https://github.com/Fortran-FOSS-Programmers/ford">FORD</a>
on 2024-04-07T10:12:46.294530 </p>
on 2024-04-07T10:48:53.347754 </p>
</div>
</div>
<br>
Expand Down
Loading

0 comments on commit 25f6987

Please sign in to comment.