140 lines
11 KiB
HTML
140 lines
11 KiB
HTML
|
<!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/screening/trampoline/py_screening.h 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"> 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&dn=expat.txt MIT */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&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&dn=expat.txt MIT */
|
||
|
|
$(function(){initNavTree('py__screening_8h_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">py_screening.h</div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
<a href="py__screening_8h.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">#pragma once</span></div>
|
||
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
|
||
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include "<a class="code" href="screening_8h.html">gridfire/screening/screening.h</a>"</span></div>
|
||
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
|
||
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <pybind11/pybind11.h></span></div>
|
||
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <pybind11/stl.h></span></div>
|
||
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <pybind11/functional.h></span> <span class="comment">// Needed for std::function</span></div>
|
||
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
||
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include <vector></span></div>
|
||
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
|
||
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "cppad/cppad.hpp"</span></div>
|
||
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
|
||
|
|
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
|
||
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_py_screening.html"> 13</a></span><span class="keyword">class </span><a class="code hl_class" href="class_py_screening.html">PyScreening</a> final : <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1screening_1_1_screening_model.html">gridfire::screening::ScreeningModel</a> {</div>
|
||
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> std::vector<double> <a class="code hl_function" href="class_py_screening.html#a2b8756c197eb89e77cb6dd231c979315">calculateScreeningFactors</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a> &reactions, <span class="keyword">const</span> std::vector<fourdst::atomic::Species> &species, <span class="keyword">const</span> std::vector<double> &Y, <span class="keyword">const</span> <span class="keywordtype">double</span> T9, <span class="keyword">const</span> <span class="keywordtype">double</span> rho) <span class="keyword">const override</span>;</div>
|
||
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> std::vector<ADDouble> <a class="code hl_function" href="class_py_screening.html#a2b8756c197eb89e77cb6dd231c979315">calculateScreeningFactors</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a> &reactions, <span class="keyword">const</span> std::vector<fourdst::atomic::Species> &species, <span class="keyword">const</span> std::vector<ADDouble> &Y, <span class="keyword">const</span> <a class="code hl_typedef" href="classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> T9, <span class="keyword">const</span> <a class="code hl_typedef" href="classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> rho) <span class="keyword">const override</span>;</div>
|
||
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span>};</div>
|
||
|
|
</div>
|
||
|
|
<div class="ttc" id="aclass_py_screening_html"><div class="ttname"><a href="class_py_screening.html">PyScreening</a></div><div class="ttdef"><b>Definition</b> <a href="#l00013">py_screening.h:13</a></div></div>
|
||
|
|
<div class="ttc" id="aclass_py_screening_html_a2b8756c197eb89e77cb6dd231c979315"><div class="ttname"><a href="class_py_screening.html#a2b8756c197eb89e77cb6dd231c979315">PyScreening::calculateScreeningFactors</a></div><div class="ttdeci">std::vector< double > calculateScreeningFactors(const gridfire::reaction::LogicalReactionSet &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const override</div><div class="ttdoc">Calculates screening factors for a set of reactions.</div><div class="ttdef"><b>Definition</b> <a href="py__screening_8cpp_source.html#l00016">py_screening.cpp:16</a></div></div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1screening_1_1_screening_model_html"><div class="ttname"><a href="classgridfire_1_1screening_1_1_screening_model.html">gridfire::screening::ScreeningModel</a></div><div class="ttdoc">An abstract base class for plasma screening models.</div><div class="ttdef"><b>Definition</b> <a href="screening__abstract_8h_source.html#l00027">screening_abstract.h:27</a></div></div>
|
||
|
|
<div class="ttc" id="aclassgridfire_1_1screening_1_1_screening_model_html_a107ff2897f040d6f27f69d56a0bdd28d"><div class="ttname"><a href="classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d">gridfire::screening::ScreeningModel::ADDouble</a></div><div class="ttdeci">CppAD::AD< double > ADDouble</div><div class="ttdoc">Alias for CppAD Automatic Differentiation type for double precision.</div><div class="ttdef"><b>Definition</b> <a href="screening__abstract_8h_source.html#l00030">screening_abstract.h:30</a></div></div>
|
||
|
|
<div class="ttc" id="anamespacegridfire_1_1reaction_html_aa86f08712565f278adacc7cd2361eb31"><div class="ttname"><a href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">gridfire::reaction::LogicalReactionSet</a></div><div class="ttdeci">TemplatedReactionSet< LogicalReaction > LogicalReactionSet</div><div class="ttdoc">A set of logical reactions.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00563">reaction.h:563</a></div></div>
|
||
|
|
<div class="ttc" id="ascreening_8h_html"><div class="ttname"><a href="screening_8h.html">screening.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="dir_4eba3bf96e8b886928c6be1f4154164d.html">screening</a></li><li class="navelem"><a class="el" href="dir_fe7d6b610561b6ccbae8c0cd892464cf.html">trampoline</a></li><li class="navelem"><a class="el" href="py__screening_8h.html">py_screening.h</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>
|