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

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2025-06-11 11:41:55 -04:00
parent 1e5938df0d
commit f0e1840c91
138 changed files with 18404 additions and 7317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

172
docs/html/globals_func.html
View File

@@ -1,65 +1,65 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>New 4DSSE Code: File Members</title>
<title>SERiF: File Members</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">New 4DSSE Code
&#160;<span id="projectnumber">0.0.1a</span>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">SERiF<span id="projectnumber">&#160;0.0.1a</span>
</div>
<div id="projectbrief">3+1D Stellar Structure and Evolution</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
@@ -72,8 +72,8 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('globals_func.html',''); initResizable(); });
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('globals_func.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
@@ -86,110 +86,74 @@ $(document).ready(function(){initNavTree('globals_func.html',''); initResizable(
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="contents">
&#160;
<div class="textblock">Here is a list of all functions with links to the files they belong to:</div>
<h3><a id="index_c"></a>- c -</h3><ul>
<li>ComputeMeshVolume()
: <a class="el" href="meshIOTest_8cpp.html#aa6ba7ddcf2f95334ee7497d22d9f0f25">meshIOTest.cpp</a>
</li>
<h3><a id="index_c" name="index_c"></a>- c -</h3><ul>
<li>ComputeMeshVolume()&#160;:&#160;<a class="el" href="mesh_i_o_test_8cpp.html#aa6ba7ddcf2f95334ee7497d22d9f0f25">meshIOTest.cpp</a></li>
<li>createResource()&#160;:&#160;<a class="el" href="resource_manager_types_8cpp.html#ae0a43e40a0c5e0fd54274c9cd8688d19">resourceManagerTypes.cpp</a>, <a class="el" href="resource_manager_types_8h.html#ae0a43e40a0c5e0fd54274c9cd8688d19">resourceManagerTypes.h</a></li>
</ul>
<h3><a id="index_i"></a>- i -</h3><ul>
<li>initlaize_opac()
: <a class="el" href="opac_8h.html#a6243596bfdc55d73744ebecd9e577ee8">opac.h</a>
</li>
<li>is_big_endian()
: <a class="el" href="opatIO_8cpp.html#aed5f3e73e01248d8a2d6792a69081f9e">opatIO.cpp</a>
</li>
<h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
<li>getFirstSegment()&#160;:&#160;<a class="el" href="resource_manager_types_8cpp.html#a3adea101b1d749fb0eaee2e91b7e10fe">resourceManagerTypes.cpp</a>, <a class="el" href="resource_manager_types_8h.html#a3adea101b1d749fb0eaee2e91b7e10fe">resourceManagerTypes.h</a></li>
<li>getLastLine()&#160;:&#160;<a class="el" href="probe_test_8cpp.html#a6181751ac1c7f7f38b548af87ad506ab">probeTest.cpp</a></li>
</ul>
<h3><a id="index_m"></a>- m -</h3><ul>
<li>main()
: <a class="el" href="testDObject_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">testDObject.cpp</a>
</li>
<h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
<li>heap_allocate_contiguous_2D_memory()&#160;:&#160;<a class="el" href="helm_8cpp.html#a0537c506d77a3dfea9b237aeb07f3281">helm.cpp</a>, <a class="el" href="helm_8h.html#a0537c506d77a3dfea9b237aeb07f3281">helm.h</a></li>
<li>heap_deallocate_contiguous_2D_memory()&#160;:&#160;<a class="el" href="helm_8cpp.html#a82f032cfe64e2576c67986660cbe824d">helm.cpp</a>, <a class="el" href="helm_8h.html#a82f032cfe64e2576c67986660cbe824d">helm.h</a></li>
</ul>
<h3><a id="index_o"></a>- o -</h3><ul>
<li>operator&lt;&lt;()
: <a class="el" href="DObject_8cpp.html#a5b2896a287295bf59a0b9e4d0af21161">DObject.cpp</a>
, <a class="el" href="Metadata_8cpp.html#a9bc49cc23da2d1ff8b3e197630b9dfd2">Metadata.cpp</a>
</li>
<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
<li>initlaize_opac()&#160;:&#160;<a class="el" href="opac_8h.html#a6243596bfdc55d73744ebecd9e577ee8">opac.h</a></li>
</ul>
<h3><a id="index_s"></a>- s -</h3><ul>
<li>seed()
: <a class="el" href="mkTestData_8py.html#a5023056b6831877dbf79e9a082600e78">mkTestData.py</a>
</li>
<li>swap_bytes()
: <a class="el" href="opatIO_8cpp.html#a33dcb837958721219b4198c267c7fd0f">opatIO.cpp</a>
</li>
<h3><a id="index_m" name="index_m"></a>- m -</h3><ul>
<li>main()&#160;:&#160;<a class="el" href="comp_8cpp.html#ac4c0f8a8146b128f1b8f920e3a9c3b1e">comp.cpp</a>, <a class="el" href="test_d_object_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">testDObject.cpp</a></li>
</ul>
<h3><a id="index_t"></a>- t -</h3><ul>
<li>TEST_F()
: <a class="el" href="meshIOTest_8cpp.html#a94653e9cb8a24090f2c4c02fc8bfdfbb">meshIOTest.cpp</a>
, <a class="el" href="LockableDObjectTest_8cpp.html#a5c2342bfafc553d23125fb3ae05af2a7">LockableDObjectTest.cpp</a>
, <a class="el" href="MetadataTest_8cpp.html#adbb375b61bd5961e38e8c5b51e538e75">MetadataTest.cpp</a>
, <a class="el" href="meshIOTest_8cpp.html#a0cb4f62baac8f32aaefbab6c9e5b93bc">meshIOTest.cpp</a>
, <a class="el" href="configTest_8cpp.html#a2aab0fda134fe1428d1b647316df718f">configTest.cpp</a>
, <a class="el" href="meshIOTest_8cpp.html#af5cb16ec6a340bbd827bd2d7adac4f68">meshIOTest.cpp</a>
, <a class="el" href="opatIOTest_8cpp.html#ac3a79e8bac7362518c4495f4b9136a99">opatIOTest.cpp</a>
, <a class="el" href="LockableDObjectTest_8cpp.html#aca2c2dcb4394094c27dc37453ea9a37f">LockableDObjectTest.cpp</a>
, <a class="el" href="configTest_8cpp.html#ae70df34c2371cc5c992f20fbf6e6354b">configTest.cpp</a>
, <a class="el" href="constTest_8cpp.html#ae050a185fbc60349459af47e661bd3e1">constTest.cpp</a>
, <a class="el" href="DObjectTest_8cpp.html#a3fc628b3943158a063739c03a4c2ca1f">DObjectTest.cpp</a>
, <a class="el" href="LockableDObjectTest_8cpp.html#a5c694ab0fb07081c02cac1f0bc3f3e73">LockableDObjectTest.cpp</a>
</li>
<li>testFunction()
: <a class="el" href="testDObject_8cpp.html#a5cce1ff8e67a00ce9122097c4bbb5b02">testDObject.cpp</a>
</li>
<li>theta_initial_guess()
: <a class="el" href="polyCoeff_8cpp.html#a1ac632f61c6dcebf44b4802e11878ad1">polyCoeff.cpp</a>
, <a class="el" href="polyCoeff_8h.html#a1ac632f61c6dcebf44b4802e11878ad1">polyCoeff.h</a>
</li>
<h3><a id="index_o" name="index_o"></a>- o -</h3><ul>
<li>operator&lt;&lt;()&#160;:&#160;<a class="el" href="_d_object_8cpp.html#aa54e75574f0302a2ca7252f9f0f0b3f1">DObject.cpp</a>, <a class="el" href="_metadata_8cpp.html#a12949a1ea26c4ff1afeb97101c0493c5">Metadata.cpp</a></li>
</ul>
<h3><a id="index_v"></a>- v -</h3><ul>
<li>vec_xi_coeff_func()
: <a class="el" href="polyCoeff_8cpp.html#a56f9e1ef409635c3a47be264168177fc">polyCoeff.cpp</a>
, <a class="el" href="polyCoeff_8h.html#a56f9e1ef409635c3a47be264168177fc">polyCoeff.h</a>
</li>
<h3><a id="index_r" name="index_r"></a>- r -</h3><ul>
<li>recurse_keys()&#160;:&#160;<a class="el" href="config_8cpp.html#ab6a5a8b7202ea0d40956283276057e8c">config.cpp</a></li>
</ul>
<h3><a id="index_w"></a>- w -</h3><ul>
<li>write_solution_to_csv()
: <a class="el" href="polyIO_8cpp.html#aead019e8410035332b8c834c88f12a3e">polyIO.cpp</a>
, <a class="el" href="polyIO_8h.html#aead019e8410035332b8c834c88f12a3e">polyIO.h</a>
, <a class="el" href="polyMFEMUtils_8h.html#aead019e8410035332b8c834c88f12a3e">polyMFEMUtils.h</a>
</li>
<h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>stripTimestamps()&#160;:&#160;<a class="el" href="probe_test_8cpp.html#a1177d7bc99ddb16fe874dc41441b9725">probeTest.cpp</a></li>
</ul>
<h3><a id="index_x"></a>- x -</h3><ul>
<li>xi_coeff_func()
: <a class="el" href="polyCoeff_8cpp.html#a6869b3eabb3ea76f69cf49572dead231">polyCoeff.cpp</a>
, <a class="el" href="polyCoeff_8h.html#a6869b3eabb3ea76f69cf49572dead231">polyCoeff.h</a>
</li>
<h3><a id="index_t" name="index_t"></a>- t -</h3><ul>
<li>TEST_F()&#160;:&#160;<a class="el" href="composition_test_8cpp.html#a99ba25c32a6e47956d231d484dc8e7cd">compositionTest.cpp</a>, <a class="el" href="config_test_8cpp.html#ae70df34c2371cc5c992f20fbf6e6354b">configTest.cpp</a>, <a class="el" href="const_test_8cpp.html#ae050a185fbc60349459af47e661bd3e1">constTest.cpp</a>, <a class="el" href="_d_object_test_8cpp.html#a3fc628b3943158a063739c03a4c2ca1f">DObjectTest.cpp</a>, <a class="el" href="_lockable_d_object_test_8cpp.html#a5c694ab0fb07081c02cac1f0bc3f3e73">LockableDObjectTest.cpp</a>, <a class="el" href="_metadata_test_8cpp.html#adbb375b61bd5961e38e8c5b51e538e75">MetadataTest.cpp</a>, <a class="el" href="eos_test_8cpp.html#a27d86e530fc20098b426edbc39c0c7e5">eosTest.cpp</a>, <a class="el" href="mesh_i_o_test_8cpp.html#a0cb4f62baac8f32aaefbab6c9e5b93bc">meshIOTest.cpp</a>, <a class="el" href="approx8_test_8cpp.html#a282ac3f9d020662bcaa9f8ad569d3a60">approx8Test.cpp</a>, <a class="el" href="poly_test_8cpp.html#a4d8d8c3608d63a6200aa3ccc54c885f5">polyTest.cpp</a>, <a class="el" href="probe_test_8cpp.html#a99cf9b4c0cf0a327598829cb53d87174">probeTest.cpp</a>, <a class="el" href="resource_manager_test_8cpp.html#a8b35d7c9fce4657fbfd3cd094c7dced5">resourceManagerTest.cpp</a></li>
<li>testFunction()&#160;:&#160;<a class="el" href="test_d_object_8cpp.html#a5cce1ff8e67a00ce9122097c4bbb5b02">testDObject.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>