tboudreaux/GridFire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
d852ee43fee107b9e97b0fa7a426785e58bce254
GridFire/docs/html/bindings_8cpp_source.html

194 lines
21 KiB
HTML
Raw Normal View History

docs(docs): asdded and cleaned up docs
2025-07-24 11:10:45 -04:00
<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<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>GridFire: src/python/bindings.cpp Source File</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="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>
<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 id="projectrow">
<td id="projectalign">
<div id="projectname">GridFire<span id="projectnumber">&#160;0.0.1a</span>
</div>
<div id="projectbrief">General Purpose Nuclear Network</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @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">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('bindings_8cpp_source.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<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="header">
<div class="headertitle"><div class="title">bindings.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="bindings_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;pybind11/pybind11.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#include &lt;pybind11/stl.h&gt;</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;<a class="code" href="types_2bindings_8h.html">types/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;<a class="code" href="partition_2bindings_8h.html">partition/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;<a class="code" href="expectations_2bindings_8h.html">expectations/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;<a class="code" href="engine_2bindings_8h.html">engine/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;<a class="code" href="exceptions_2bindings_8h.html">exceptions/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;<a class="code" href="io_2bindings_8h.html">io/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;<a class="code" href="reaction_2bindings_8h.html">reaction/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;<a class="code" href="screening_2bindings_8h.html">screening/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;<a class="code" href="solver_2bindings_8h.html">solver/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="utils_2bindings_8h.html">utils/bindings.h</a>&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="foldopen" id="foldopen00017" data-start="{" data-end="}">
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="bindings_8cpp.html#aa8955e3a8d1ea2d94e8a2c941a12c03f"> 17</a></span><a class="code hl_function" href="bindings_8cpp.html#aa8955e3a8d1ea2d94e8a2c941a12c03f">PYBIND11_MODULE</a>(<a class="code hl_namespace" href="namespacegridfire.html">gridfire</a>, m) {</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> m.doc() = <span class="stringliteral">&quot;Python bindings for the fourdst utility modules which are a part of the 4D-STAR project.&quot;</span>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> pybind11::module::import(<span class="stringliteral">&quot;fourdst.constants&quot;</span>);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> pybind11::module::import(<span class="stringliteral">&quot;fourdst.composition&quot;</span>);</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> pybind11::module::import(<span class="stringliteral">&quot;fourdst.config&quot;</span>);</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> pybind11::module::import(<span class="stringliteral">&quot;fourdst.atomic&quot;</span>);</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">auto</span> typeMod = m.def_submodule(<span class="stringliteral">&quot;type&quot;</span>, <span class="stringliteral">&quot;GridFire type bindings&quot;</span>);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> <a class="code hl_function" href="types_2bindings_8cpp.html#a37d2e0b6a2605d063eec5e2a64e9bcc5">register_type_bindings</a>(typeMod);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">auto</span> partitionMod = m.def_submodule(<span class="stringliteral">&quot;partition&quot;</span>, <span class="stringliteral">&quot;GridFire partition function bindings&quot;</span>);</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <a class="code hl_function" href="partition_2bindings_8cpp.html#a2806baaec82e0e6d66b80348584e08fd">register_partition_bindings</a>(partitionMod);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">auto</span> expectationMod = m.def_submodule(<span class="stringliteral">&quot;expectations&quot;</span>, <span class="stringliteral">&quot;GridFire expectations bindings&quot;</span>);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <a class="code hl_function" href="expectations_2bindings_8cpp.html#ac6720822f6ad76636adbc1ae6febc2c2">register_expectation_bindings</a>(expectationMod);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">auto</span> reactionMod = m.def_submodule(<span class="stringliteral">&quot;reaction&quot;</span>, <span class="stringliteral">&quot;GridFire reaction bindings&quot;</span>);</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_function" href="reaction_2bindings_8cpp.html#ae174b115814ec42920a799881cef1efa">register_reaction_bindings</a>(reactionMod);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">auto</span> screeningMod = m.def_submodule(<span class="stringliteral">&quot;screening&quot;</span>, <span class="stringliteral">&quot;GridFire plasma screening bindings&quot;</span>);</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_function" href="screening_2bindings_8cpp.html#a4fcef69d9382bfbc315cb061038627f4">register_screening_bindings</a>(screeningMod);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">auto</span> ioMod = m.def_submodule(<span class="stringliteral">&quot;io&quot;</span>, <span class="stringliteral">&quot;GridFire io bindings&quot;</span>);</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_function" href="io_2bindings_8cpp.html#a7f552627cbe94906e0ee98b121e77862">register_io_bindings</a>(ioMod);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">auto</span> exceptionMod = m.def_submodule(<span class="stringliteral">&quot;exceptions&quot;</span>, <span class="stringliteral">&quot;GridFire exceptions bindings&quot;</span>);</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_function" href="exceptions_2bindings_8cpp.html#a15a0d54e4fe015a87d9f7a63284c2958">register_exception_bindings</a>(exceptionMod);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">auto</span> engineMod = m.def_submodule(<span class="stringliteral">&quot;engine&quot;</span>, <span class="stringliteral">&quot;Engine and Engine View bindings&quot;</span>);</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_function" href="engine_2bindings_8cpp.html#ac2df9cd0e71d39b97ddd47b3e7024b0c">register_engine_bindings</a>(engineMod);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">auto</span> solverMod = m.def_submodule(<span class="stringliteral">&quot;solver&quot;</span>, <span class="stringliteral">&quot;GridFire numerical solver bindings&quot;</span>);</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_function" href="solver_2bindings_8cpp.html#a8b1a9e2faca389d99c0b5feaa4262630">register_solver_bindings</a>(solverMod);</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">auto</span> utilsMod = m.def_submodule(<span class="stringliteral">&quot;utils&quot;</span>, <span class="stringliteral">&quot;GridFire utility method bindings&quot;</span>);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_function" href="utils_2bindings_8cpp.html#a7af842f50ca4a721518e716d0229697c">register_utils_bindings</a>(utilsMod);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>}</div>
</div>
<div class="ttc" id="abindings_8cpp_html_aa8955e3a8d1ea2d94e8a2c941a12c03f"><div class="ttname"><a href="bindings_8cpp.html#aa8955e3a8d1ea2d94e8a2c941a12c03f">PYBIND11_MODULE</a></div><div class="ttdeci">PYBIND11_MODULE(gridfire, m)</div><div class="ttdef"><b>Definition</b> <a href="#l00017">bindings.cpp:17</a></div></div>
<div class="ttc" id="aengine_2bindings_8cpp_html_ac2df9cd0e71d39b97ddd47b3e7024b0c"><div class="ttname"><a href="engine_2bindings_8cpp.html#ac2df9cd0e71d39b97ddd47b3e7024b0c">register_engine_bindings</a></div><div class="ttdeci">void register_engine_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="engine_2bindings_8cpp_source.html#l00114">bindings.cpp:114</a></div></div>
<div class="ttc" id="aengine_2bindings_8h_html"><div class="ttname"><a href="engine_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="aexceptions_2bindings_8cpp_html_a15a0d54e4fe015a87d9f7a63284c2958"><div class="ttname"><a href="exceptions_2bindings_8cpp.html#a15a0d54e4fe015a87d9f7a63284c2958">register_exception_bindings</a></div><div class="ttdeci">void register_exception_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="exceptions_2bindings_8cpp_source.html#l00013">bindings.cpp:13</a></div></div>
<div class="ttc" id="aexceptions_2bindings_8h_html"><div class="ttname"><a href="exceptions_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="aexpectations_2bindings_8cpp_html_ac6720822f6ad76636adbc1ae6febc2c2"><div class="ttname"><a href="expectations_2bindings_8cpp.html#ac6720822f6ad76636adbc1ae6febc2c2">register_expectation_bindings</a></div><div class="ttdeci">void register_expectation_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="expectations_2bindings_8cpp_source.html#l00011">bindings.cpp:11</a></div></div>
<div class="ttc" id="aexpectations_2bindings_8h_html"><div class="ttname"><a href="expectations_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="aio_2bindings_8cpp_html_a7f552627cbe94906e0ee98b121e77862"><div class="ttname"><a href="io_2bindings_8cpp.html#a7f552627cbe94906e0ee98b121e77862">register_io_bindings</a></div><div class="ttdeci">void register_io_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="io_2bindings_8cpp_source.html#l00015">bindings.cpp:15</a></div></div>
<div class="ttc" id="aio_2bindings_8h_html"><div class="ttname"><a href="io_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="anamespacegridfire_html"><div class="ttname"><a href="namespacegridfire.html">gridfire</a></div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00031">engine_abstract.h:31</a></div></div>
<div class="ttc" id="apartition_2bindings_8cpp_html_a2806baaec82e0e6d66b80348584e08fd"><div class="ttname"><a href="partition_2bindings_8cpp.html#a2806baaec82e0e6d66b80348584e08fd">register_partition_bindings</a></div><div class="ttdeci">void register_partition_bindings(pybind11::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="partition_2bindings_8cpp_source.html#l00020">bindings.cpp:20</a></div></div>
<div class="ttc" id="apartition_2bindings_8h_html"><div class="ttname"><a href="partition_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="areaction_2bindings_8cpp_html_ae174b115814ec42920a799881cef1efa"><div class="ttname"><a href="reaction_2bindings_8cpp.html#ae174b115814ec42920a799881cef1efa">register_reaction_bindings</a></div><div class="ttdeci">void register_reaction_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="reaction_2bindings_8cpp_source.html#l00016">bindings.cpp:16</a></div></div>
<div class="ttc" id="areaction_2bindings_8h_html"><div class="ttname"><a href="reaction_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="ascreening_2bindings_8cpp_html_a4fcef69d9382bfbc315cb061038627f4"><div class="ttname"><a href="screening_2bindings_8cpp.html#a4fcef69d9382bfbc315cb061038627f4">register_screening_bindings</a></div><div class="ttdeci">void register_screening_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="screening_2bindings_8cpp_source.html#l00015">bindings.cpp:15</a></div></div>
<div class="ttc" id="ascreening_2bindings_8h_html"><div class="ttname"><a href="screening_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="asolver_2bindings_8cpp_html_a8b1a9e2faca389d99c0b5feaa4262630"><div class="ttname"><a href="solver_2bindings_8cpp.html#a8b1a9e2faca389d99c0b5feaa4262630">register_solver_bindings</a></div><div class="ttdeci">void register_solver_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="solver_2bindings_8cpp_source.html#l00013">bindings.cpp:13</a></div></div>
<div class="ttc" id="asolver_2bindings_8h_html"><div class="ttname"><a href="solver_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="atypes_2bindings_8cpp_html_a37d2e0b6a2605d063eec5e2a64e9bcc5"><div class="ttname"><a href="types_2bindings_8cpp.html#a37d2e0b6a2605d063eec5e2a64e9bcc5">register_type_bindings</a></div><div class="ttdeci">void register_type_bindings(pybind11::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="types_2bindings_8cpp_source.html#l00011">bindings.cpp:11</a></div></div>
<div class="ttc" id="atypes_2bindings_8h_html"><div class="ttname"><a href="types_2bindings_8h.html">bindings.h</a></div></div>
<div class="ttc" id="autils_2bindings_8cpp_html_a7af842f50ca4a721518e716d0229697c"><div class="ttname"><a href="utils_2bindings_8cpp.html#a7af842f50ca4a721518e716d0229697c">register_utils_bindings</a></div><div class="ttdeci">void register_utils_bindings(py::module &amp;m)</div><div class="ttdef"><b>Definition</b> <a href="utils_2bindings_8cpp_source.html#l00011">bindings.cpp:11</a></div></div>
<div class="ttc" id="autils_2bindings_8h_html"><div class="ttname"><a href="utils_2bindings_8h.html">bindings.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5c0d64f70903e893b1efe571a4b8de29.html">python</a></li><li class="navelem"><a class="el" href="bindings_8cpp.html">bindings.cpp</a></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>
</html>
Reference in New Issue Copy Permalink