Skip to content

Commit c0d0f31

Browse files
committed
better doxygen generation
1 parent be38b0b commit c0d0f31

441 files changed

Lines changed: 26129 additions & 15131 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -348,7 +348,7 @@ OPTIMIZE_OUTPUT_SLICE = NO
348348
#
349349
# Note see also the list of default file extension mappings.
350350

351-
EXTENSION_MAPPING = h=Cpp
351+
EXTENSION_MAPPING = h=C++
352352

353353
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
354354
# according to the Markdown format, which allows for more readable

docs/html/_b_s_s_n_c_hristoffel_tilde_8hpp.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,13 +142,20 @@
142142
<tr class="heading"><td colspan="2"><h2 id="header-func-members" class="groupheader"><a id="func-members" name="func-members"></a>
143143
Functions</h2></td></tr>
144144
<tr class="memitem:a551a841476db3f7665a53043c46349c2" id="r_a551a841476db3f7665a53043c46349c2"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
145-
<tr class="memitem:a551a841476db3f7665a53043c46349c2 template"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="namespacetensorium___r_g_1_1bssn.html#a551a841476db3f7665a53043c46349c2">tensorium_RG::bssn::compute_tildeGamma_contracted</a> (BSSNGridSoA&lt; T &gt; &amp;G)</td></tr>
145+
<tr class="memitem:a551a841476db3f7665a53043c46349c2 template"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="namespacetensorium___r_g_1_1bssn.html#a551a841476db3f7665a53043c46349c2">tensorium_RG::bssn::compute_tildeGamma_contracted</a> (<a class="el" href="classtensorium___r_g_1_1_b_s_s_n_grid_so_a.html">BSSNGridSoA</a>&lt; T &gt; &amp;G)</td></tr>
146146
<tr class="memdesc:a551a841476db3f7665a53043c46349c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refresh the evolved \(\tilde{\Gamma}^i\) from the metric inverse divergence. <br /></td></tr>
147+
<tr class="memitem:ac9153162b0e444ecc58bb99e8fe08dbd" id="r_ac9153162b0e444ecc58bb99e8fe08dbd"><td class="memTemplParams" colspan="2">template&lt;typename T&gt; </td></tr>
148+
<tr class="memitem:ac9153162b0e444ecc58bb99e8fe08dbd template"><td class="memItemLeft">void&#160;</td><td class="memItemRight"><a class="el" href="namespacetensorium___r_g_1_1bssn.html#ac9153162b0e444ecc58bb99e8fe08dbd">tensorium_RG::bssn::compute_tildeGamma_full</a> (<a class="el" href="classtensorium___r_g_1_1_b_s_s_n_grid_so_a.html">BSSNGridSoA</a>&lt; T &gt; &amp;G, <a class="el" href="structtensorium___r_g_1_1_field3_d.html">Field3D</a>&lt; T &gt; *Gamma27)</td></tr>
149+
<tr class="memdesc:ac9153162b0e444ecc58bb99e8fe08dbd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute the full \(\tilde{\Gamma}^i_{\ jk}\) tensor at every interior grid point. <br /></td></tr>
147150
</table>
148151
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
149152
<div class="textblock"><p>Builders for the Christoffel symbols \(\tilde{\Gamma}^i_{\ jk}\) and their contraction. </p>
150-
<p>Both helpers restrict loops to interior points so that the 4th-order derivative operators have valid data. <span class="tt">compute_tildeGamma_full</span> implements the textbook formula \(\tilde{\Gamma}^i_{\ jk} = \tfrac{1}{2}\tilde{\gamma}^{i\ell}(\partial_j\tilde{\gamma}_{\ell k} +
151-
\partial_k\tilde{\gamma}_{\ell j} - \partial_\ell \tilde{\gamma}_{jk})\) and stores the result in the 27-component cache (flattened as <span class="tt">[i][j][k]</span>). <span class="tt">compute_tildeGamma_contracted</span> recomputes the evolved \(\tilde{\Gamma}^i\) from the metric divergence to enforce the algebraic definition after projection steps. </p>
153+
<p>Both helpers restrict loops to interior points so that the 4th-order derivative operators have valid data. <span class="tt">compute_tildeGamma_full</span> implements the textbook formula </p><p class="formulaDsp">
154+
\[\tilde{\Gamma}^i_{\ jk} = \tfrac{1}{2}\tilde{\gamma}^{i\ell}(\partial_j\tilde{\gamma}_{\ell k} +
155+
\partial_k\tilde{\gamma}_{\ell j} - \partial_\ell \tilde{\gamma}_{jk})
156+
\]
157+
</p>
158+
<p> and stores the result in the 27-component cache (flattened as <span class="tt">[i][j][k]</span>). <span class="tt">compute_tildeGamma_contracted</span> recomputes the evolved \(\tilde{\Gamma}^i\) from the metric divergence to enforce the algebraic definition after projection steps. </p>
152159
</div></div><!-- contents -->
153160
</div><!-- doc-content -->
154161
<div id="page-nav" class="page-nav-panel">
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
var _b_s_s_n_c_hristoffel_tilde_8hpp =
22
[
3-
[ "tensorium_RG::bssn::compute_tildeGamma_contracted", "namespacetensorium___r_g_1_1bssn.html#a551a841476db3f7665a53043c46349c2", null ]
3+
[ "tensorium_RG::bssn::compute_tildeGamma_contracted", "namespacetensorium___r_g_1_1bssn.html#a551a841476db3f7665a53043c46349c2", null ],
4+
[ "tensorium_RG::bssn::compute_tildeGamma_full", "namespacetensorium___r_g_1_1bssn.html#ac9153162b0e444ecc58bb99e8fe08dbd", null ]
45
];

docs/html/_b_s_s_n_c_hristoffel_tilde_8hpp__incl.map

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<area shape="poly" id="edge1_Node000001_Node000002" title=" " alt="" coords="265,74,266,109,261,107,263,79"/>
55
<area shape="rect" id="Node000003" href="$_b_s_s_n_grid_derivatives_8hpp.html" title="High&#45;order finite&#45;difference stencils and dissipation operators used by the BSSN grid." alt="" coords="5,198,261,223"/>
66
<area shape="poly" id="edge11_Node000001_Node000003" title=" " alt="" coords="228,78,190,126,150,186,145,183,186,122,231,74"/>
7-
<area shape="rect" id="Node000005" href="$_b_s_s_n_grid_so_a_8hpp.html" title=" " alt="" coords="285,198,469,223"/>
7+
<area shape="rect" id="Node000005" href="$_b_s_s_n_grid_so_a_8hpp.html" title="Structure&#45;of&#45;arrays storage for all BSSN state variables." alt="" coords="285,198,469,223"/>
88
<area shape="poly" id="edge12_Node000001_Node000005" title=" " alt="" coords="302,74,343,123,360,153,371,184,366,183,355,155,339,125,301,79"/>
99
<area shape="poly" id="edge2_Node000002_Node000003" title=" " alt="" coords="240,152,170,192,167,188,243,148"/>
1010
<area shape="poly" id="edge4_Node000002_Node000005" title=" " alt="" coords="283,148,347,189,342,189,283,153"/>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
27e699007eb5c254bbcd8de926107064
1+
99a9eead9792c1920512521a11314019

docs/html/_b_s_s_n_c_hristoffel_tilde_8hpp__incl.svg

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)