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,239 @@
<?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/utils/serialize/components.hpp Pages: 1 -->
<svg width="470pt" height="504pt"
viewBox="0.00 0.00 470.00 504.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 500)">
<title>src/include/serif/utils/serialize/components.hpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title=" ">
<polygon fill="#999999" stroke="#666666" points="206,-496 76,-496 76,-465.5 206,-465.5 206,-496"/>
<text xml:space="preserve" text-anchor="start" x="84" y="-482.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="141" y="-471.25" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/components.hpp</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:href="physics_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="196.25,-429.5 85.75,-429.5 85.75,-399 196.25,-399 196.25,-429.5"/>
<text xml:space="preserve" text-anchor="start" x="93.75" y="-416" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="141" y="-404.75" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/physics.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node2 -->
<g id="edge1_Node000001_Node000002" class="edge">
<title>Node1&#45;&gt;Node2</title>
<g id="a_edge1_Node000001_Node000002"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M141,-453.81C141,-445.64 141,-436.91 141,-429.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="137.5,-453.6 141,-463.6 144.5,-453.6 137.5,-453.6"/>
</a>
</g>
</g>
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:href="serialize_2discretization_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="170.12,-230 7.88,-230 7.88,-199.5 170.12,-199.5 170.12,-230"/>
<text xml:space="preserve" text-anchor="start" x="15.88" y="-216.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/backend</text>
<text xml:space="preserve" text-anchor="middle" x="89" y="-205.25" font-family="Helvetica,sans-Serif" font-size="10.00">/mfem/serialize/discretization.hpp</text>
</a>
</g>
</g>
<!-- Node2&#45;&gt;Node3 -->
<g id="edge2_Node000002_Node000003" class="edge">
<title>Node2&#45;&gt;Node3</title>
<g id="a_edge2_Node000002_Node000003"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M134.3,-387.81C123.27,-345.89 101.61,-263.63 92.83,-230.29"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="130.86,-388.48 136.79,-397.26 137.63,-386.7 130.86,-388.48"/>
</a>
</g>
</g>
<!-- Node5 -->
<g id="Node000005" class="node">
<title>Node5</title>
<g id="a_Node000005"><a xlink:href="utils_2serialize_2equations_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="261.38,-363 142.62,-363 142.62,-332.5 261.38,-332.5 261.38,-363"/>
<text xml:space="preserve" text-anchor="start" x="150.62" y="-349.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="202" y="-338.25" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/equations.hpp</text>
</a>
</g>
</g>
<!-- Node2&#45;&gt;Node5 -->
<g id="edge4_Node000002_Node000005" class="edge">
<title>Node2&#45;&gt;Node5</title>
<g id="a_edge4_Node000002_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M162.6,-390.41C171.12,-381.4 180.66,-371.32 188.21,-363.33"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="160.21,-387.84 155.88,-397.51 165.3,-392.65 160.21,-387.84"/>
</a>
</g>
</g>
<!-- Node4 -->
<g id="Node000004" class="node">
<title>Node4</title>
<g id="a_Node000004"><a xlink:href="backend_2mfem_2serialize_2configuration_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="160,-163.5 0,-163.5 0,-133 160,-133 160,-163.5"/>
<text xml:space="preserve" text-anchor="start" x="8" y="-150" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/backend</text>
<text xml:space="preserve" text-anchor="middle" x="80" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">/mfem/serialize/configuration.hpp</text>
</a>
</g>
</g>
<!-- Node3&#45;&gt;Node4 -->
<g id="edge3_Node000003_Node000004" class="edge">
<title>Node3&#45;&gt;Node4</title>
<g id="a_edge3_Node000003_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M85.38,-187.81C84.24,-179.64 83.02,-170.91 82.03,-163.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="81.9,-188.19 86.75,-197.61 88.83,-187.23 81.9,-188.19"/>
</a>
</g>
</g>
<!-- Node6 -->
<g id="Node000006" class="node">
<title>Node6</title>
<g id="a_Node000006"><a xlink:href="utils_2serialize_2model_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="290,-296.5 184,-296.5 184,-266 290,-266 290,-296.5"/>
<text xml:space="preserve" text-anchor="start" x="192" y="-283" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="237" y="-271.75" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/model.hpp</text>
</a>
</g>
</g>
<!-- Node5&#45;&gt;Node6 -->
<g id="edge5_Node000005_Node000006" class="edge">
<title>Node5&#45;&gt;Node6</title>
<g id="a_edge5_Node000005_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M215.31,-322.23C219.96,-313.66 225.02,-304.32 229.09,-296.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="212.36,-320.32 210.66,-330.78 218.51,-323.66 212.36,-320.32"/>
</a>
</g>
</g>
<!-- Node6&#45;&gt;Node3 -->
<g id="edge6_Node000006_Node000003" class="edge">
<title>Node6&#45;&gt;Node3</title>
<g id="a_edge6_Node000006_Node000003"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M193.1,-261.12C170.57,-251.3 143.57,-239.53 122.71,-230.44"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="191.46,-264.22 202.03,-265.01 194.26,-257.81 191.46,-264.22"/>
</a>
</g>
</g>
<!-- Node7 -->
<g id="Node000007" class="node">
<title>Node7</title>
<g id="a_Node000007"><a xlink:href="numerics_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="304.25,-230 187.75,-230 187.75,-199.5 304.25,-199.5 304.25,-230"/>
<text xml:space="preserve" text-anchor="start" x="195.75" y="-216.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="246" y="-205.25" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/numerics.hpp</text>
</a>
</g>
</g>
<!-- Node6&#45;&gt;Node7 -->
<g id="edge7_Node000006_Node000007" class="edge">
<title>Node6&#45;&gt;Node7</title>
<g id="a_edge7_Node000006_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M240.62,-254.31C241.76,-246.14 242.98,-237.41 243.97,-230.33"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="237.17,-253.73 239.25,-264.11 244.1,-254.69 237.17,-253.73"/>
</a>
</g>
</g>
<!-- Node9 -->
<g id="Node000009" class="node">
<title>Node9</title>
<g id="a_Node000009"><a xlink:href="utils_2serialize_2solver_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="438,-163.5 332,-163.5 332,-133 438,-133 438,-163.5"/>
<text xml:space="preserve" text-anchor="start" x="340" y="-150" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="385" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/solver.hpp</text>
</a>
</g>
</g>
<!-- Node6&#45;&gt;Node9 -->
<g id="edge13_Node000006_Node000009" class="edge">
<title>Node6&#45;&gt;Node9</title>
<g id="a_edge13_Node000006_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M271.87,-259.87C285.28,-251.36 300.39,-240.91 313,-230 336.86,-209.35 360.41,-181.03 373.78,-164"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="270.4,-256.66 263.74,-264.91 274.09,-262.61 270.4,-256.66"/>
</a>
</g>
</g>
<!-- Node7&#45;&gt;Node4 -->
<g id="edge8_Node000007_Node000004" class="edge">
<title>Node7&#45;&gt;Node4</title>
<g id="a_edge8_Node000007_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M197.78,-195.01C172.32,-185.12 141.52,-173.15 117.81,-163.94"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="196.33,-198.21 206.92,-198.57 198.87,-191.68 196.33,-198.21"/>
</a>
</g>
</g>
<!-- Node8 -->
<g id="Node000008" class="node">
<title>Node8</title>
<g id="a_Node000008"><a xlink:href="backend_2mfem_2serialize_2options_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="314,-163.5 178,-163.5 178,-133 314,-133 314,-163.5"/>
<text xml:space="preserve" text-anchor="start" x="186" y="-150" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/backend</text>
<text xml:space="preserve" text-anchor="middle" x="246" y="-138.75" font-family="Helvetica,sans-Serif" font-size="10.00">/mfem/serialize/options.hpp</text>
</a>
</g>
</g>
<!-- Node7&#45;&gt;Node8 -->
<g id="edge9_Node000007_Node000008" class="edge">
<title>Node7&#45;&gt;Node8</title>
<g id="a_edge9_Node000007_Node000008"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M246,-187.81C246,-179.64 246,-170.91 246,-163.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="242.5,-187.6 246,-197.6 249.5,-187.6 242.5,-187.6"/>
</a>
</g>
</g>
<!-- Node7&#45;&gt;Node9 -->
<g id="edge10_Node000007_Node000009" class="edge">
<title>Node7&#45;&gt;Node9</title>
<g id="a_edge10_Node000007_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M287.85,-194.33C308.96,-184.53 334.15,-172.85 353.58,-163.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="286.51,-191.09 278.91,-198.48 289.46,-197.44 286.51,-191.09"/>
</a>
</g>
</g>
<!-- Node10 -->
<g id="Node000010" class="node">
<title>Node10</title>
<g id="a_Node000010"><a xlink:href="serialize_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="441.38,-97 328.62,-97 328.62,-66.5 441.38,-66.5 441.38,-97"/>
<text xml:space="preserve" text-anchor="start" x="336.62" y="-83.5" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/utils</text>
<text xml:space="preserve" text-anchor="middle" x="385" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">/serialize/serialize.hpp</text>
</a>
</g>
</g>
<!-- Node9&#45;&gt;Node10 -->
<g id="edge11_Node000009_Node000010" class="edge">
<title>Node9&#45;&gt;Node10</title>
<g id="a_edge11_Node000009_Node000010"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M385,-121.31C385,-113.14 385,-104.41 385,-97.33"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="381.5,-121.1 385,-131.1 388.5,-121.1 381.5,-121.1"/>
</a>
</g>
</g>
<!-- Node11 -->
<g id="Node000011" class="node">
<title>Node11</title>
<g id="a_Node000011"><a xlink:href="backend__independent_8cpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="462,-30.5 308,-30.5 308,0 462,0 462,-30.5"/>
<text xml:space="preserve" text-anchor="start" x="316" y="-17" font-family="Helvetica,sans-Serif" font-size="10.00">src/compile_time_checks</text>
<text xml:space="preserve" text-anchor="middle" x="385" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">/serif/backend_independent.cpp</text>
</a>
</g>
</g>
<!-- Node10&#45;&gt;Node11 -->
<g id="edge12_Node000010_Node000011" class="edge">
<title>Node10&#45;&gt;Node11</title>
<g id="a_edge12_Node000010_Node000011"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M385,-54.81C385,-46.64 385,-37.91 385,-30.83"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="381.5,-54.6 385,-64.6 388.5,-54.6 381.5,-54.6"/>
</a>
</g>
</g>
</g>
</svg>

After

Width:  |  Height:  |  Size: 12 KiB