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: PyScreening 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('class_py_screening.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 = "#pri-methods" > Private Member Functions< / a > |
< a href = "class_py_screening-members.html" > List of all members< / a > < / div >
< div class = "headertitle" > < div class = "title" > PyScreening Class Reference< span class = "mlabels" > < span class = "mlabel final" > final< / span > < / span > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2025-07-31 10:54:31 -04:00
< p > < code > #include < py_screening.h> < / code > < / p >
2025-07-24 11:10:45 -04:00
< div class = "dynheader" >
Inheritance diagram for PyScreening:< / div >
< div class = "dyncontent" >
< div class = "center" >
< img src = "class_py_screening.png" usemap = "#PyScreening_map" alt = "" / >
< map id = "PyScreening_map" name = "PyScreening_map" >
< area href = "classgridfire_1_1screening_1_1_screening_model.html" title = "An abstract base class for plasma screening models." alt = "gridfire::screening::ScreeningModel" shape = "rect" coords = "0,0,214,24" / >
< / map >
< / div > < / div >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "pri-methods" name = "pri-methods" > < / a >
Private Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:a2b8756c197eb89e77cb6dd231c979315" id = "r_a2b8756c197eb89e77cb6dd231c979315" > < td class = "memItemLeft" align = "right" valign = "top" > std::vector< double >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a2b8756c197eb89e77cb6dd231c979315" > calculateScreeningFactors< / a > (const < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > gridfire::reaction::LogicalReactionSet< / a > & reactions, const std::vector< fourdst::atomic::Species > & species, const std::vector< double > & Y, const double T9, const double rho) const override< / td > < / tr >
< tr class = "memdesc:a2b8756c197eb89e77cb6dd231c979315" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Calculates screening factors for a set of reactions. < br / > < / td > < / tr >
< tr class = "separator:a2b8756c197eb89e77cb6dd231c979315" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "memitem:a5539d59311c778cf7f0006acc8f84ade" id = "r_a5539d59311c778cf7f0006acc8f84ade" > < td class = "memItemLeft" align = "right" valign = "top" > std::vector< < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "#a5539d59311c778cf7f0006acc8f84ade" > calculateScreeningFactors< / a > (const < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > gridfire::reaction::LogicalReactionSet< / a > & reactions, const std::vector< fourdst::atomic::Species > & species, const std::vector< < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > > & Y, const < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > T9, const < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > rho) const override< / td > < / tr >
< tr class = "memdesc:a5539d59311c778cf7f0006acc8f84ade" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Calculates screening factors using CppAD types for automatic differentiation. < br / > < / td > < / tr >
< tr class = "separator:a5539d59311c778cf7f0006acc8f84ade" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a id = "inherited" name = "inherited" > < / a >
Additional Inherited Members< / h2 > < / td > < / tr >
< tr class = "inherit_header pub_types_classgridfire_1_1screening_1_1_screening_model" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pub_types_classgridfire_1_1screening_1_1_screening_model')" > < img src = "closed.png" alt = "-" / >   Public Types inherited from < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html" > gridfire::screening::ScreeningModel< / a > < / td > < / tr >
< tr class = "memitem:a107ff2897f040d6f27f69d56a0bdd28d inherit pub_types_classgridfire_1_1screening_1_1_screening_model" id = "r_a107ff2897f040d6f27f69d56a0bdd28d" > < td class = "memItemLeft" align = "right" valign = "top" > using  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > = CppAD::AD< double> < / td > < / tr >
< tr class = "memdesc:a107ff2897f040d6f27f69d56a0bdd28d inherit pub_types_classgridfire_1_1screening_1_1_screening_model" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Alias for CppAD Automatic Differentiation type for double precision. < br / > < / td > < / tr >
< tr class = "separator:a107ff2897f040d6f27f69d56a0bdd28d inherit pub_types_classgridfire_1_1screening_1_1_screening_model" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< tr class = "inherit_header pub_methods_classgridfire_1_1screening_1_1_screening_model" > < td colspan = "2" onclick = "javascript:dynsection.toggleInherit('pub_methods_classgridfire_1_1screening_1_1_screening_model')" > < img src = "closed.png" alt = "-" / >   Public Member Functions inherited from < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html" > gridfire::screening::ScreeningModel< / a > < / td > < / tr >
< tr class = "memitem:adef175acdbd911527f56a1f1592579a7 inherit pub_methods_classgridfire_1_1screening_1_1_screening_model" id = "r_adef175acdbd911527f56a1f1592579a7" > < td class = "memItemLeft" align = "right" valign = "top" > virtual  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7" > ~ScreeningModel< / a > ()=default< / td > < / tr >
< tr class = "memdesc:adef175acdbd911527f56a1f1592579a7 inherit pub_methods_classgridfire_1_1screening_1_1_screening_model" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Virtual destructor. < br / > < / td > < / tr >
< tr class = "separator:adef175acdbd911527f56a1f1592579a7 inherit pub_methods_classgridfire_1_1screening_1_1_screening_model" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
2025-07-31 10:54:31 -04:00
< h2 class = "groupheader" > Member Function Documentation< / h2 >
2025-07-24 11:10:45 -04:00
< a id = "a5539d59311c778cf7f0006acc8f84ade" name = "a5539d59311c778cf7f0006acc8f84ade" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a5539d59311c778cf7f0006acc8f84ade" > ◆   < / 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" > std::vector< < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > > PyScreening::calculateScreeningFactors < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > gridfire::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 = "classgridfire_1_1screening_1_1_screening_model.html#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 = "classgridfire_1_1screening_1_1_screening_model.html#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 = "classgridfire_1_1screening_1_1_screening_model.html#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 override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Calculates screening factors using CppAD types for automatic differentiation. < / p >
< p > This is a pure virtual function that provides an overload of < code > calculateScreeningFactors< / code > for use with CppAD. It allows the derivatives of the screening factors with respect to abundances, temperature, and density to be computed automatically.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > reactions< / td > < td > The set of logical reactions in the network. < / td > < / tr >
< tr > < td class = "paramname" > species< / td > < td > A vector of all atomic species involved in the network. < / td > < / tr >
< tr > < td class = "paramname" > Y< / td > < td > A vector of the molar abundances (mol/g) for each species, as AD types. < / td > < / tr >
< tr > < td class = "paramname" > T9< / td > < td > The temperature in units of 10^9 K, as an AD type. < / td > < / tr >
< tr > < td class = "paramname" > rho< / td > < td > The plasma density in g/cm^3, as an AD type. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > A vector of screening factors (dimensionless), as AD types.< / dd > < / dl >
< p > < b > Note< / b > This method is essential for including the effects of screening in the Jacobian matrix of the reaction network. < / p >
< p > Implements < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22" > gridfire::screening::ScreeningModel< / a > .< / p >
< / div >
< / div >
< a id = "a2b8756c197eb89e77cb6dd231c979315" name = "a2b8756c197eb89e77cb6dd231c979315" > < / a >
< h2 class = "memtitle" > < span class = "permalink" > < a href = "#a2b8756c197eb89e77cb6dd231c979315" > ◆   < / 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" > std::vector< double > PyScreening::calculateScreeningFactors < / td >
< td > (< / td >
< td class = "paramtype" > const < a class = "el" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > gridfire::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 override" > override< / span > < span class = "mlabel private" > private< / span > < span class = "mlabel virtual" > virtual< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > Calculates screening factors for a set of reactions. < / p >
< p > This is a pure virtual function that must be implemented by derived classes. It computes the screening enhancement factor for each reaction in the provided set based on the given plasma conditions.< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > reactions< / td > < td > The set of logical reactions in the network. < / td > < / tr >
< tr > < td class = "paramname" > species< / td > < td > A vector of all atomic species involved in the network. < / td > < / tr >
< tr > < td class = "paramname" > Y< / td > < td > A vector of the molar abundances (mol/g) for each species. < / td > < / tr >
< tr > < td class = "paramname" > T9< / td > < td > The temperature in units of 10^9 K. < / td > < / tr >
< tr > < td class = "paramname" > rho< / td > < td > The plasma density in g/cm^3. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > A vector of screening factors (dimensionless), one for each reaction in the < code > reactions< / code > set, in the same order.< / dd > < / dl >
< p > < b > Pre-conditions< / b > < / p > < ul >
< li > The size of the < code > Y< / code > vector must match the size of the < code > species< / code > vector.< / li >
< li > < code > T9< / code > and < code > rho< / code > must be positive.< / li >
< / ul >
< p > < b > Post-conditions< / b > < / p > < ul >
< li > The returned vector will have the same size as the < code > reactions< / code > set.< / li >
< li > Each element in the returned vector will be > = 1.0.< / li >
< / ul >
< p > < b > Usage< / b > < / p > < div class = "fragment" > < div class = "line" > < span class = "comment" > // Assume ' model' is a std::unique_ptr< ScreeningModel> to a concrete implementation< / span > < / div >
< div class = "line" > < span class = "comment" > // and other parameters (reactions, species, Y, T9, rho) are initialized.< / span > < / div >
< div class = "line" > std::vector< double> screening_factors = model-> calculateScreeningFactors(< / div >
< div class = "line" > reactions, species, Y, T9, rho< / div >
< div class = "line" > );< / div >
< div class = "line" > < span class = "keywordflow" > for< / span > (< span class = "keywordtype" > size_t< / span > i = 0; i < reactions.size(); ++i) {< / div >
< div class = "line" > < span class = "comment" > // ... use screening_factors[i] ...< / span > < / div >
< div class = "line" > }< / div >
< / div > <!-- fragment -->
< p > Implements < a class = "el" href = "classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde" > gridfire::screening::ScreeningModel< / a > .< / p >
< / div >
< / div >
< hr / > The documentation for this class was generated from the following files:< ul >
2025-07-31 10:54:31 -04:00
< li > src/python/screening/trampoline/< a class = "el" href = "py__screening_8h.html" > py_screening.h< / a > < / li >
< li > src/python/screening/trampoline/< a class = "el" href = "py__screening_8cpp.html" > py_screening.cpp< / a > < / li >
2025-07-24 11:10:45 -04:00
< / 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 = "class_py_screening.html" > PyScreening< / 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 >
