289 lines
16 KiB
HTML
289 lines
16 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: gridfire::screening::ScreeningModel Class Reference</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('classgridfire_1_1screening_1_1_screening_model.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="summary">
|
||
|
|
<a href="#pub-types">Public Types</a> |
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="classgridfire_1_1screening_1_1_screening_model-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle"><div class="title">gridfire::screening::ScreeningModel Class Reference<span class="mlabels"><span class="mlabel abstract">abstract</span></span></div></div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p><code>#include <<a class="el" href="screening__abstract_8h_source.html">screening_abstract.h</a>></code></p>
|
||
|
|
<div class="dynheader">
|
||
|
|
Inheritance diagram for gridfire::screening::ScreeningModel:</div>
|
||
|
|
<div class="dyncontent">
|
||
|
|
<div class="center">
|
||
|
|
<img src="classgridfire_1_1screening_1_1_screening_model.png" usemap="#gridfire::screening::ScreeningModel_map" alt=""/>
|
||
|
|
<map id="gridfire::screening::ScreeningModel_map" name="gridfire::screening::ScreeningModel_map">
|
||
|
|
<area href="classgridfire_1_1screening_1_1_bare_screening_model.html" alt="gridfire::screening::BareScreeningModel" shape="rect" coords="0,56,245,80"/>
|
||
|
|
<area href="classgridfire_1_1screening_1_1_weak_screening_model.html" alt="gridfire::screening::WeakScreeningModel" shape="rect" coords="255,56,500,80"/>
|
||
|
|
</map>
|
||
|
|
</div></div>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
|
||
|
|
Public Types</h2></td></tr>
|
||
|
|
<tr class="memitem:a107ff2897f040d6f27f69d56a0bdd28d" id="r_a107ff2897f040d6f27f69d56a0bdd28d"><td class="memItemLeft" align="right" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> = CppAD::AD<double></td></tr>
|
||
|
|
<tr class="separator:a107ff2897f040d6f27f69d56a0bdd28d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:adef175acdbd911527f56a1f1592579a7" id="r_adef175acdbd911527f56a1f1592579a7"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="#adef175acdbd911527f56a1f1592579a7">~ScreeningModel</a> ()=default</td></tr>
|
||
|
|
<tr class="separator:adef175acdbd911527f56a1f1592579a7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaec9184d80c86a2d8674e395dad81bde" id="r_aaec9184d80c86a2d8674e395dad81bde"><td class="memItemLeft" align="right" valign="top">virtual std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="#aaec9184d80c86a2d8674e395dad81bde">calculateScreeningFactors</a> (const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< double > &Y, const double T9, const double rho) const =0</td></tr>
|
||
|
|
<tr class="separator:aaec9184d80c86a2d8674e395dad81bde"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6c381a823cb9c1680d3e9c846da4ae22" id="r_a6c381a823cb9c1680d3e9c846da4ae22"><td class="memItemLeft" align="right" valign="top">virtual std::vector< <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="#a6c381a823cb9c1680d3e9c846da4ae22">calculateScreeningFactors</a> (const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &reactions, const std::vector< fourdst::atomic::Species > &species, const std::vector< <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> > &Y, const <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> T9, const <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> rho) const =0</td></tr>
|
||
|
|
<tr class="separator:a6c381a823cb9c1680d3e9c846da4ae22"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock">
|
||
|
|
<p class="definition">Definition at line <a class="el" href="screening__abstract_8h_source.html#l00012">12</a> of file <a class="el" href="screening__abstract_8h_source.html">screening_abstract.h</a>.</p>
|
||
|
|
</div><h2 class="groupheader">Member Typedef Documentation</h2>
|
||
|
|
<a id="a107ff2897f040d6f27f69d56a0bdd28d" name="a107ff2897f040d6f27f69d56a0bdd28d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a107ff2897f040d6f27f69d56a0bdd28d">◆ </a></span>ADDouble</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">using <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">gridfire::screening::ScreeningModel::ADDouble</a> = CppAD::AD<double></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p class="definition">Definition at line <a class="el" href="screening__abstract_8h_source.html#l00014">14</a> of file <a class="el" href="screening__abstract_8h_source.html">screening_abstract.h</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a id="adef175acdbd911527f56a1f1592579a7" name="adef175acdbd911527f56a1f1592579a7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#adef175acdbd911527f56a1f1592579a7">◆ </a></span>~ScreeningModel()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual gridfire::screening::ScreeningModel::~ScreeningModel </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel virtual">virtual</span><span class="mlabel default">default</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a id="a6c381a823cb9c1680d3e9c846da4ae22" name="a6c381a823cb9c1680d3e9c846da4ae22"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6c381a823cb9c1680d3e9c846da4ae22">◆ </a></span>calculateScreeningFactors() <span class="overload">[1/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual std::vector< <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> > gridfire::screening::ScreeningModel::calculateScreeningFactors </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &</td> <td class="paramname"><span class="paramname"><em>reactions</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const std::vector< fourdst::atomic::Species > &</td> <td class="paramname"><span class="paramname"><em>species</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const std::vector< <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a> > &</td> <td class="paramname"><span class="paramname"><em>Y</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a></td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const <a class="el" href="#a107ff2897f040d6f27f69d56a0bdd28d">ADDouble</a></td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac5647d633cd5bbd7cb5136b7fa4cad99">gridfire::screening::BareScreeningModel</a>, and <a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html#ac6bc78769670a460af1ff88284cb8ad4">gridfire::screening::WeakScreeningModel</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aaec9184d80c86a2d8674e395dad81bde" name="aaec9184d80c86a2d8674e395dad81bde"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaec9184d80c86a2d8674e395dad81bde">◆ </a></span>calculateScreeningFactors() <span class="overload">[2/2]</span></h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">virtual std::vector< double > gridfire::screening::ScreeningModel::calculateScreeningFactors </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const <a class="el" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> &</td> <td class="paramname"><span class="paramname"><em>reactions</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const std::vector< fourdst::atomic::Species > &</td> <td class="paramname"><span class="paramname"><em>species</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const std::vector< double > &</td> <td class="paramname"><span class="paramname"><em>Y</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>T9</em></span>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">const double</td> <td class="paramname"><span class="paramname"><em>rho</em></span> ) const</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel pure-virtual">pure virtual</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Implemented in <a class="el" href="classgridfire_1_1screening_1_1_bare_screening_model.html#ac35ad34c5da7e1b5087552aa5c83fe60">gridfire::screening::BareScreeningModel</a>, and <a class="el" href="classgridfire_1_1screening_1_1_weak_screening_model.html#afbaeaefe6b3ab3ecf81889ddc1cff76c">gridfire::screening::WeakScreeningModel</a>.</p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>src/network/include/gridfire/screening/<a class="el" href="screening__abstract_8h_source.html">screening_abstract.h</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="navelem"><a class="el" href="namespacegridfire.html">gridfire</a></li><li class="navelem"><a class="el" href="namespacegridfire_1_1screening.html">screening</a></li><li class="navelem"><a class="el" href="classgridfire_1_1screening_1_1_screening_model.html">ScreeningModel</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>
|