docs(docs): built docs

Note for now much of the docs is LLM written. This was done to save time and focus on code development. The docs have been LOOSLEY reviewed. However, the code itself has been either fully written by hand or fully reviewed. Therefore, the docs should at the moment be seen as a loose resource rather than authoratiative (and this is on top of the general ability for docs to drift)
This commit is contained in:
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions

View File

@@ -0,0 +1,195 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Generated by graphviz version 14.1.2 (20260124.0452)
-->
<!-- Title: src/include/serif/model/backend Pages: 1 -->
<svg width="543pt" height="142pt"
viewBox="0.00 0.00 543.00 142.00" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<g id="graph0" class="graph" transform="scale(1 1) rotate(0) translate(4 137.75)">
<title>src/include/serif/model/backend</title>
<g id="clust1" class="cluster">
<title>clusterdir_c6d007d78fd1e188923aaa983ad27a9c</title>
<g id="a_clust1"><a xlink:href="dir_c6d007d78fd1e188923aaa983ad27a9c.html" target="_top" xlink:title="model">
<polygon fill="#edf0f7" stroke="#7f7f7f" stroke-dasharray="5,2" points="8,-8 8,-125.75 190,-125.75 190,-8 8,-8"/>
<text xml:space="preserve" text-anchor="middle" x="99" y="-112.25" font-family="Helvetica,sans-Serif" font-size="10.00">model</text>
</a>
</g>
</g>
<g id="clust2" class="cluster">
<title>clusterdir_1321e11519a62974e86a4faacafbe0f0</title>
<g id="a_clust2"><a xlink:href="dir_1321e11519a62974e86a4faacafbe0f0.html" target="_top">
<polygon fill="#edf0f7" stroke="#404040" stroke-width="2" points="55,-63.25 55,-98.5 182,-98.5 182,-63.25 55,-63.25"/>
</a>
</g>
</g>
<!-- dir_5f07be07dcf2ba461fbe10830fcbce8f -->
<g id="node1" class="node">
<title>dir_5f07be07dcf2ba461fbe10830fcbce8f</title>
<g id="a_node1"><a xlink:href="dir_5f07be07dcf2ba461fbe10830fcbce8f.html" target="_top" xlink:title="computations">
<polygon fill="#a2b4d6" stroke="#404040" points="90.25,-35.25 15.75,-35.25 15.75,-16 90.25,-16 90.25,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="53" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">computations</text>
</a>
</g>
</g>
<!-- dir_68b73560b2431cfe0191ac50c96ddaa2 -->
<g id="node2" class="node">
<title>dir_68b73560b2431cfe0191ac50c96ddaa2</title>
<g id="a_node2"><a xlink:href="dir_68b73560b2431cfe0191ac50c96ddaa2.html" target="_top" xlink:title="normalization">
<polygon fill="#a2b4d6" stroke="#404040" points="181.88,-35.25 108.12,-35.25 108.12,-16 181.88,-16 181.88,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="145" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">normalization</text>
</a>
</g>
</g>
<!-- dir_1321e11519a62974e86a4faacafbe0f0 -->
<g id="node3" class="node">
<title>dir_1321e11519a62974e86a4faacafbe0f0</title>
<text xml:space="preserve" text-anchor="middle" x="89" y="-77" font-family="Helvetica,sans-Serif" font-size="10.00">backend</text>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55 -->
<g id="node4" class="node">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55</title>
<g id="a_node4"><a xlink:href="dir_6e51cc7b7ddb655e1826abd9d1ba1d55.html" target="_top" xlink:title="mfem">
<polygon fill="#a2b4d6" stroke="#404040" points="174.38,-90.5 133.62,-90.5 133.62,-71.25 174.38,-71.25 174.38,-90.5"/>
<text xml:space="preserve" text-anchor="middle" x="154" y="-77" font-family="Helvetica,sans-Serif" font-size="10.00">mfem</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_5f07be07dcf2ba461fbe10830fcbce8f -->
<g id="edge2" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_5f07be07dcf2ba461fbe10830fcbce8f</title>
<g id="a_edge2"><a xlink:href="dir_000085_000025.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M137.86,-70.81C133.38,-68.33 128.52,-65.67 124,-63.25 109.81,-55.66 93.91,-47.43 80.75,-40.7"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="82.72,-37.77 72.22,-36.35 79.54,-44.01 82.72,-37.77"/>
</a>
</g>
<g id="a_edge2&#45;headlabel"><a xlink:href="dir_000085_000025.html" target="_top" xlink:title="1">
<text xml:space="preserve" text-anchor="middle" x="85.87" y="-32.32" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">1</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_68b73560b2431cfe0191ac50c96ddaa2 -->
<g id="edge4" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_68b73560b2431cfe0191ac50c96ddaa2</title>
<g id="a_edge4"><a xlink:href="dir_000085_000105.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M152.51,-71.08C151.4,-64.49 149.83,-55.21 148.41,-46.82"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="151.89,-46.38 146.77,-37.1 144.99,-47.55 151.89,-46.38"/>
</a>
</g>
<g id="a_edge4&#45;headlabel"><a xlink:href="dir_000085_000105.html" target="_top" xlink:title="2">
<text xml:space="preserve" text-anchor="middle" x="155.03" y="-44.08" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">2</text>
</a>
</g>
</g>
<!-- dir_be6e56fd9d960fc911ddc1deae607fd9 -->
<g id="node5" class="node">
<title>dir_be6e56fd9d960fc911ddc1deae607fd9</title>
<g id="a_node5"><a xlink:href="dir_be6e56fd9d960fc911ddc1deae607fd9.html" target="_top" xlink:title="operators">
<polygon fill="#edf0f7" stroke="red" stroke-dasharray="5,2" points="256.25,-35.25 199.75,-35.25 199.75,-16 256.25,-16 256.25,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="228" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">operators</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_be6e56fd9d960fc911ddc1deae607fd9 -->
<g id="edge7" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_be6e56fd9d960fc911ddc1deae607fd9</title>
<g id="a_edge7"><a xlink:href="dir_000085_000109.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M166.55,-70.84C177.46,-62.99 193.5,-51.45 206.46,-42.12"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="208.33,-45.09 214.4,-36.41 204.24,-39.41 208.33,-45.09"/>
</a>
</g>
<g id="a_edge7&#45;headlabel"><a xlink:href="dir_000085_000109.html" target="_top" xlink:title="6">
<text xml:space="preserve" text-anchor="middle" x="208.3" y="-44.74" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">6</text>
</a>
</g>
</g>
<!-- dir_afafc166fe2ea9700a3140fe454efa1d -->
<g id="node6" class="node">
<title>dir_afafc166fe2ea9700a3140fe454efa1d</title>
<g id="a_node6"><a xlink:href="dir_afafc166fe2ea9700a3140fe454efa1d.html" target="_top" xlink:title="geometry">
<polygon fill="#edf0f7" stroke="red" stroke-dasharray="5,2" points="331.25,-35.25 274.75,-35.25 274.75,-16 331.25,-16 331.25,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="303" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">geometry</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_afafc166fe2ea9700a3140fe454efa1d -->
<g id="edge6" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_afafc166fe2ea9700a3140fe454efa1d</title>
<g id="a_edge6"><a xlink:href="dir_000085_000059.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M174.72,-72.47C198.54,-63.96 238.08,-49.83 266.97,-39.5"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="267.81,-42.92 276.05,-36.26 265.45,-36.33 267.81,-42.92"/>
</a>
</g>
<g id="a_edge6&#45;headlabel"><a xlink:href="dir_000085_000059.html" target="_top" xlink:title="6">
<text xml:space="preserve" text-anchor="middle" x="266.8" y="-42.42" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">6</text>
</a>
</g>
</g>
<!-- dir_0fcf4c89a1274e6563f11975b8f6a431 -->
<g id="node7" class="node">
<title>dir_0fcf4c89a1274e6563f11975b8f6a431</title>
<g id="a_node7"><a xlink:href="dir_0fcf4c89a1274e6563f11975b8f6a431.html" target="_top" xlink:title="utils">
<polygon fill="#edf0f7" stroke="red" stroke-dasharray="5,2" points="383,-35.25 349,-35.25 349,-16 383,-16 383,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="366" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">utils</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_0fcf4c89a1274e6563f11975b8f6a431 -->
<g id="edge1" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_0fcf4c89a1274e6563f11975b8f6a431</title>
<g id="a_edge1"><a xlink:href="dir_000085_000151.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M174.79,-75.49C207.51,-68.46 273.19,-53.85 337.92,-35.65"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="338.6,-39.1 347.27,-33 336.69,-32.37 338.6,-39.1"/>
</a>
</g>
<g id="a_edge1&#45;headlabel"><a xlink:href="dir_000085_000151.html" target="_top" xlink:title="6">
<text xml:space="preserve" text-anchor="middle" x="337.38" y="-38.53" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">6</text>
</a>
</g>
</g>
<!-- dir_61ce9618cc59c903e19fcd7c3ff79031 -->
<g id="node8" class="node">
<title>dir_61ce9618cc59c903e19fcd7c3ff79031</title>
<g id="a_node8"><a xlink:href="dir_61ce9618cc59c903e19fcd7c3ff79031.html" target="_top" xlink:title="solver">
<polygon fill="#edf0f7" stroke="red" stroke-dasharray="5,2" points="443.12,-35.25 400.88,-35.25 400.88,-16 443.12,-16 443.12,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="422" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">solver</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_61ce9618cc59c903e19fcd7c3ff79031 -->
<g id="edge3" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_61ce9618cc59c903e19fcd7c3ff79031</title>
<g id="a_edge3"><a xlink:href="dir_000085_000131.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M174.83,-76.65C214.64,-70.34 304.47,-55.43 389.31,-35.71"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="390.03,-39.14 398.96,-33.44 388.43,-32.32 390.03,-39.14"/>
</a>
</g>
<g id="a_edge3&#45;headlabel"><a xlink:href="dir_000085_000131.html" target="_top" xlink:title="2">
<text xml:space="preserve" text-anchor="middle" x="388.66" y="-38.5" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">2</text>
</a>
</g>
</g>
<!-- dir_7fd1bd470eaeb2bcec2963effbdf83df -->
<g id="node9" class="node">
<title>dir_7fd1bd470eaeb2bcec2963effbdf83df</title>
<g id="a_node9"><a xlink:href="dir_7fd1bd470eaeb2bcec2963effbdf83df.html" target="_top" xlink:title="discretization">
<polygon fill="#edf0f7" stroke="red" stroke-dasharray="5,2" points="534.88,-35.25 461.12,-35.25 461.12,-16 534.88,-16 534.88,-35.25"/>
<text xml:space="preserve" text-anchor="middle" x="498" y="-21.75" font-family="Helvetica,sans-Serif" font-size="10.00">discretization</text>
</a>
</g>
</g>
<!-- dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_7fd1bd470eaeb2bcec2963effbdf83df -->
<g id="edge5" class="edge">
<title>dir_6e51cc7b7ddb655e1826abd9d1ba1d55&#45;&gt;dir_7fd1bd470eaeb2bcec2963effbdf83df</title>
<g id="a_edge5"><a xlink:href="dir_000085_000044.html" target="_top">
<path fill="none" stroke="#63b8ff" d="M174.63,-77.05C221.51,-70.58 339.84,-53.93 449.59,-35.6"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="450.09,-39.07 459.37,-33.96 448.93,-32.16 450.09,-39.07"/>
</a>
</g>
<g id="a_edge5&#45;headlabel"><a xlink:href="dir_000085_000044.html" target="_top" xlink:title="1">
<text xml:space="preserve" text-anchor="middle" x="448.51" y="-38.34" font-family="Helvetica,sans-Serif" font-size="10.00" fill="#63b8ff">1</text>
</a>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 11 KiB