tboudreaux/MeanField_SERiF
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): built docs

Browse Source 
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:
Emily Boudreaux
2026-11-09 14:09:44 -05:00
parent d9c4919477
commit 6b57738330
32596 changed files with 4155414 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

326
docs/html/compactification_8hpp__incl_org.svg Normal file
View File

@@ -0,0 +1,326 @@
<?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/backend/mfem/mapping/compactification/compactification.hpp Pages: 1 -->
<svg width="652pt" height="305pt"
viewBox="0.00 0.00 652.00 305.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 300.5)">
<title>src/include/serif/backend/mfem/mapping/compactification/compactification.hpp</title>
<!-- Node1 -->
<g id="Node000001" class="node">
<title>Node1</title>
<g id="a_Node000001"><a xlink:title="File containing the definition of the ExteriorDomainMap interface, which is used to define the mappin...">
<polygon fill="#999999" stroke="#666666" points="374.88,-296.5 217.12,-296.5 217.12,-254.75 374.88,-254.75 374.88,-296.5"/>
<text xml:space="preserve" text-anchor="start" x="225.12" y="-283" font-family="Helvetica,sans-Serif" font-size="10.00">src/include/serif/backend</text>
<text xml:space="preserve" text-anchor="start" x="225.12" y="-271.75" font-family="Helvetica,sans-Serif" font-size="10.00">/mfem/mapping/compactification</text>
<text xml:space="preserve" text-anchor="middle" x="296" y="-260.5" font-family="Helvetica,sans-Serif" font-size="10.00">/compactification.hpp</text>
</a>
</g>
</g>
<!-- Node2 -->
<g id="Node000002" class="node">
<title>Node2</title>
<g id="a_Node000002"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="156.75,-207.5 91.25,-207.5 91.25,-188.25 156.75,-188.25 156.75,-207.5"/>
<text xml:space="preserve" text-anchor="middle" x="124" y="-194" font-family="Helvetica,sans-Serif" font-size="10.00">string_view</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="M246.92,-254.35C222.22,-243.98 191.89,-230.99 165,-218.75 160.91,-216.89 156.61,-214.87 152.4,-212.86"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="154.17,-209.83 143.64,-208.63 151.12,-216.13 154.17,-209.83"/>
</a>
</g>
</g>
<!-- Node3 -->
<g id="Node000003" class="node">
<title>Node3</title>
<g id="a_Node000003"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="225.62,-207.5 174.38,-207.5 174.38,-188.25 225.62,-188.25 225.62,-207.5"/>
<text xml:space="preserve" text-anchor="middle" x="200" y="-194" font-family="Helvetica,sans-Serif" font-size="10.00">memory</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node3 -->
<g id="edge2_Node000001_Node000003" class="edge">
<title>Node1&#45;&gt;Node3</title>
<g id="a_edge2_Node000001_Node000003"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M270.27,-254.33C254.6,-241.96 234.86,-226.38 220.29,-214.89"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="222.77,-212.38 212.75,-208.94 218.43,-217.88 222.77,-212.38"/>
</a>
</g>
</g>
<!-- Node4 -->
<g id="Node000004" class="node">
<title>Node4</title>
<g id="a_Node000004"><a xlink:href="status_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="348.25,-213.12 243.75,-213.12 243.75,-182.62 348.25,-182.62 348.25,-213.12"/>
<text xml:space="preserve" text-anchor="start" x="251.75" y="-199.62" font-family="Helvetica,sans-Serif" font-size="10.00">serif/backend/mfem</text>
<text xml:space="preserve" text-anchor="middle" x="296" y="-188.38" font-family="Helvetica,sans-Serif" font-size="10.00">/mapping/status.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node4 -->
<g id="edge3_Node000001_Node000004" class="edge">
<title>Node1&#45;&gt;Node4</title>
<g id="a_edge3_Node000001_Node000004"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M296,-254.33C296,-245.2 296,-234.34 296,-224.65"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="299.5,-224.74 296,-214.74 292.5,-224.74 299.5,-224.74"/>
</a>
</g>
</g>
<!-- Node12 -->
<g id="Node000012" class="node">
<title>Node12</title>
<g id="a_Node000012"><a xlink:href="input__result_8hpp.html" target="_top" xlink:title="File containing the input and result structures for the compactification mapping.">
<polygon fill="white" stroke="#666666" points="644,-218.75 514,-218.75 514,-177 644,-177 644,-218.75"/>
<text xml:space="preserve" text-anchor="start" x="522" y="-205.25" font-family="Helvetica,sans-Serif" font-size="10.00">serif/backend/mfem</text>
<text xml:space="preserve" text-anchor="start" x="522" y="-194" font-family="Helvetica,sans-Serif" font-size="10.00">/mapping/compactification</text>
<text xml:space="preserve" text-anchor="middle" x="579" y="-182.75" font-family="Helvetica,sans-Serif" font-size="10.00">/input_result.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node12 -->
<g id="edge14_Node000001_Node000012" class="edge">
<title>Node1&#45;&gt;Node12</title>
<g id="a_edge14_Node000001_Node000012"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M371.95,-254.34C408.82,-244.49 454.03,-232.4 502.57,-219.4"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="503.42,-222.8 512.17,-216.83 501.6,-216.04 503.42,-222.8"/>
</a>
</g>
</g>
<!-- Node15 -->
<g id="Node000015" class="node">
<title>Node15</title>
<g id="a_Node000015"><a xlink:href="compactification_2variation_8hpp.html" target="_top" xlink:title="File containing the structures for the variation of the compactification mapping.">
<polygon fill="white" stroke="#666666" points="496,-218.75 366,-218.75 366,-177 496,-177 496,-218.75"/>
<text xml:space="preserve" text-anchor="start" x="374" y="-205.25" font-family="Helvetica,sans-Serif" font-size="10.00">serif/backend/mfem</text>
<text xml:space="preserve" text-anchor="start" x="374" y="-194" font-family="Helvetica,sans-Serif" font-size="10.00">/mapping/compactification</text>
<text xml:space="preserve" text-anchor="middle" x="431" y="-182.75" font-family="Helvetica,sans-Serif" font-size="10.00">/variation.hpp</text>
</a>
</g>
</g>
<!-- Node1&#45;&gt;Node15 -->
<g id="edge17_Node000001_Node000015" class="edge">
<title>Node1&#45;&gt;Node15</title>
<g id="a_edge17_Node000001_Node000015"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M332.18,-254.33C348.37,-245.24 367.65,-234.42 384.86,-224.76"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="386.39,-227.92 393.4,-219.97 382.97,-221.81 386.39,-227.92"/>
</a>
</g>
</g>
<!-- Node5 -->
<g id="Node000005" class="node">
<title>Node5</title>
<g id="a_Node000005"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="361.38,-24.88 278.62,-24.88 278.62,-5.63 361.38,-5.63 361.38,-24.88"/>
<text xml:space="preserve" text-anchor="middle" x="320" y="-11.38" font-family="Helvetica,sans-Serif" font-size="10.00">unordered_map</text>
</a>
</g>
</g>
<!-- Node4&#45;&gt;Node5 -->
<g id="edge4_Node000004_Node000005" class="edge">
<title>Node4&#45;&gt;Node5</title>
<g id="a_edge4_Node000004_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M306.28,-182.52C313.37,-171.7 322.19,-156.16 326,-141 335.05,-105.01 329.32,-61.38 324.52,-36.41"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="327.96,-35.75 322.49,-26.68 321.11,-37.18 327.96,-35.75"/>
</a>
</g>
</g>
<!-- Node6 -->
<g id="Node000006" class="node">
<title>Node6</title>
<g id="a_Node000006"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="271.62,-85.75 226.38,-85.75 226.38,-66.5 271.62,-66.5 271.62,-85.75"/>
<text xml:space="preserve" text-anchor="middle" x="249" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">cstdint</text>
</a>
</g>
</g>
<!-- Node4&#45;&gt;Node6 -->
<g id="edge5_Node000004_Node000006" class="edge">
<title>Node4&#45;&gt;Node6</title>
<g id="a_edge5_Node000004_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M287.91,-182.49C281.89,-171.39 273.75,-155.53 268,-141 262.26,-126.49 257.29,-109.54 253.88,-96.74"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="257.36,-96.25 251.48,-87.43 250.58,-97.99 257.36,-96.25"/>
</a>
</g>
</g>
<!-- Node7 -->
<g id="Node000007" class="node">
<title>Node7</title>
<g id="a_Node000007"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="316.62,-141 277.38,-141 277.38,-121.75 316.62,-121.75 316.62,-141"/>
<text xml:space="preserve" text-anchor="middle" x="297" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">utility</text>
</a>
</g>
</g>
<!-- Node4&#45;&gt;Node7 -->
<g id="edge6_Node000004_Node000007" class="edge">
<title>Node4&#45;&gt;Node7</title>
<g id="a_edge6_Node000004_Node000007"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M296.23,-182.24C296.36,-173.45 296.54,-162.15 296.69,-152.53"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="300.18,-152.76 296.84,-142.71 293.19,-152.66 300.18,-152.76"/>
</a>
</g>
</g>
<!-- Node8 -->
<g id="Node000008" class="node">
<title>Node8</title>
<g id="a_Node000008"><a xlink:href="codes_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="221.12,-141 94.88,-141 94.88,-121.75 221.12,-121.75 221.12,-141"/>
<text xml:space="preserve" text-anchor="middle" x="158" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">serif/utils/error/codes.hpp</text>
</a>
</g>
</g>
<!-- Node4&#45;&gt;Node8 -->
<g id="edge7_Node000004_Node000008" class="edge">
<title>Node4&#45;&gt;Node8</title>
<g id="a_edge7_Node000004_Node000008"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M264.69,-182.24C241.59,-171.44 210.36,-156.85 187.66,-146.24"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="189.19,-143.09 178.65,-142.03 186.23,-149.43 189.19,-143.09"/>
</a>
</g>
</g>
<!-- Node9 -->
<g id="Node000009" class="node">
<title>Node9</title>
<g id="a_Node000009"><a xlink:href="enums_8hpp.html" target="_top" xlink:title=" ">
<polygon fill="white" stroke="#666666" points="208.25,-85.75 97.75,-85.75 97.75,-66.5 208.25,-66.5 208.25,-85.75"/>
<text xml:space="preserve" text-anchor="middle" x="153" y="-72.25" font-family="Helvetica,sans-Serif" font-size="10.00">serif/meta/enums.hpp</text>
</a>
</g>
</g>
<!-- Node4&#45;&gt;Node9 -->
<g id="edge13_Node000004_Node000009" class="edge">
<title>Node4&#45;&gt;Node9</title>
<g id="a_edge13_Node000004_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M252.14,-182.13C246.4,-180.34 240.57,-178.58 235,-177 169.45,-158.43 128.14,-194.53 86,-141 71.11,-122.08 96.6,-103.43 120.3,-91.21"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="121.74,-94.4 129.21,-86.89 118.68,-88.1 121.74,-94.4"/>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node6 -->
<g id="edge8_Node000008_Node000006" class="edge">
<title>Node8&#45;&gt;Node6</title>
<g id="a_edge8_Node000008_Node000006"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M173.44,-121.34C187.16,-113.31 207.5,-101.41 223.62,-91.98"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="225.32,-95.04 232.18,-86.97 221.78,-89 225.32,-95.04"/>
</a>
</g>
</g>
<!-- Node8&#45;&gt;Node9 -->
<g id="edge9_Node000008_Node000009" class="edge">
<title>Node8&#45;&gt;Node9</title>
<g id="a_edge9_Node000008_Node000009"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M157.17,-121.58C156.56,-114.99 155.68,-105.71 154.9,-97.32"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="158.4,-97.25 153.99,-87.62 151.44,-97.9 158.4,-97.25"/>
</a>
</g>
</g>
<!-- Node9&#45;&gt;Node5 -->
<g id="edge10_Node000009_Node000005" class="edge">
<title>Node9&#45;&gt;Node5</title>
<g id="a_edge10_Node000009_Node000005"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M178.73,-66.05C206.8,-56.16 251.96,-40.24 283.65,-29.07"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="284.55,-32.46 292.82,-25.83 282.22,-25.86 284.55,-32.46"/>
</a>
</g>
</g>
<!-- Node10 -->
<g id="Node000010" class="node">
<title>Node10</title>
<g id="a_Node000010"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="209.88,-24.88 148.12,-24.88 148.12,-5.63 209.88,-5.63 209.88,-24.88"/>
<text xml:space="preserve" text-anchor="middle" x="179" y="-11.38" font-family="Helvetica,sans-Serif" font-size="10.00">type_traits</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="M156.95,-66.18C160.5,-58.14 165.84,-46.05 170.37,-35.78"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="173.56,-37.22 174.4,-26.66 167.16,-34.39 173.56,-37.22"/>
</a>
</g>
</g>
<!-- Node11 -->
<g id="Node000011" class="node">
<title>Node11</title>
<g id="a_Node000011"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="130,-30.5 0,-30.5 0,0 130,0 130,-30.5"/>
<text xml:space="preserve" text-anchor="start" x="8" y="-17" font-family="Helvetica,sans-Serif" font-size="10.00">magic_enum/magic_enum</text>
<text xml:space="preserve" text-anchor="middle" x="65" y="-5.75" font-family="Helvetica,sans-Serif" font-size="10.00">_all.hpp</text>
</a>
</g>
</g>
<!-- Node9&#45;&gt;Node11 -->
<g id="edge12_Node000009_Node000011" class="edge">
<title>Node9&#45;&gt;Node11</title>
<g id="a_edge12_Node000009_Node000011"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M139.63,-66.18C128.12,-58.48 111.04,-47.05 96.13,-37.08"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="98.24,-34.28 87.98,-31.62 94.34,-40.09 98.24,-34.28"/>
</a>
</g>
</g>
<!-- Node13 -->
<g id="Node000013" class="node">
<title>Node13</title>
<g id="a_Node000013"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="636.12,-141 521.88,-141 521.88,-121.75 636.12,-121.75 636.12,-141"/>
<text xml:space="preserve" text-anchor="middle" x="579" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">mfem/linalg/vector.hpp</text>
</a>
</g>
</g>
<!-- Node12&#45;&gt;Node13 -->
<g id="edge15_Node000012_Node000013" class="edge">
<title>Node12&#45;&gt;Node13</title>
<g id="a_edge15_Node000012_Node000013"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M579,-176.82C579,-169.15 579,-160.39 579,-152.7"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="582.5,-152.96 579,-142.96 575.5,-152.96 582.5,-152.96"/>
</a>
</g>
</g>
<!-- Node14 -->
<g id="Node000014" class="node">
<title>Node14</title>
<g id="a_Node000014"><a xlink:title=" ">
<polygon fill="#e0e0e0" stroke="#999999" points="503.38,-141 372.62,-141 372.62,-121.75 503.38,-121.75 503.38,-141"/>
<text xml:space="preserve" text-anchor="middle" x="438" y="-127.5" font-family="Helvetica,sans-Serif" font-size="10.00">mfem/linalg/densemat.hpp</text>
</a>
</g>
</g>
<!-- Node12&#45;&gt;Node14 -->
<g id="edge16_Node000012_Node000014" class="edge">
<title>Node12&#45;&gt;Node14</title>
<g id="a_edge16_Node000012_Node000014"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M534.77,-176.64C513.07,-166.71 487.49,-155.01 468.08,-146.13"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="469.64,-143 459.09,-142.02 466.73,-149.37 469.64,-143"/>
</a>
</g>
</g>
<!-- Node15&#45;&gt;Node13 -->
<g id="edge18_Node000015_Node000013" class="edge">
<title>Node15&#45;&gt;Node13</title>
<g id="a_edge18_Node000015_Node000013"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M477.42,-176.64C500.42,-166.62 527.56,-154.79 548,-145.89"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="549.15,-149.2 556.92,-142 546.35,-142.79 549.15,-149.2"/>
</a>
</g>
</g>
<!-- Node15&#45;&gt;Node14 -->
<g id="edge19_Node000015_Node000014" class="edge">
<title>Node15&#45;&gt;Node14</title>
<g id="a_edge19_Node000015_Node000014"><a xlink:title=" ">
<path fill="none" stroke="#63b8ff" d="M433.18,-176.82C434.01,-169.15 434.96,-160.39 435.79,-152.7"/>
<polygon fill="#63b8ff" stroke="#63b8ff" points="439.25,-153.27 436.85,-142.95 432.29,-152.51 439.25,-153.27"/>
</a>
</g>
</g>
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB