2025-07-01 11:40:58 -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/network/include/gridfire/screening/screening_abstract.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('screening__abstract_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" > screening_abstract.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a href = "screening__abstract_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 = "reaction_8h.html" > gridfire/reaction/reaction.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 " fourdst/composition/atomicSpecies.h" < / span > < / div >
< div class = "line" > < a id = "l00006" name = "l00006" > < / a > < span class = "lineno" > 6< / span > < / div >
< div class = "line" > < a id = "l00007" name = "l00007" > < / a > < span class = "lineno" > 7< / span > < span class = "preprocessor" > #include " cppad/cppad.hpp" < / 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 = "foldopen" id = "foldopen00011" data-start = "{" data-end = "}" >
< div class = "line" > < a id = "l00011" name = "l00011" > < / a > < span class = "lineno" > < a class = "line" href = "namespacegridfire_1_1screening.html" > 11< / a > < / span > < span class = "keyword" > namespace < / span > < a class = "code hl_namespace" href = "namespacegridfire_1_1screening.html" > gridfire::screening< / a > {< / div >
2025-07-01 15:06:22 -04:00
< div class = "foldopen" id = "foldopen00027" data-start = "{" data-end = "};" >
< div class = "line" > < a id = "l00027" name = "l00027" > < / a > < span class = "lineno" > < a class = "line" href = "classgridfire_1_1screening_1_1_screening_model.html" > 27< / a > < / span > < span class = "keyword" > class < / span > < a class = "code hl_class" href = "classgridfire_1_1screening_1_1_screening_model.html" > ScreeningModel< / a > {< / div >
< div class = "line" > < a id = "l00028" name = "l00028" > < / a > < span class = "lineno" > 28< / span > < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a id = "l00030" name = "l00030" > < / a > < span class = "lineno" > < a class = "line" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > 30< / a > < / span > < span class = "keyword" > using < / span > < a class = "code hl_typedef" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > = CppAD::AD< double> ;< / div >
< div class = "line" > < a id = "l00036" name = "l00036" > < / a > < span class = "lineno" > < a class = "line" href = "classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7" > 36< / a > < / span > < span class = "keyword" > virtual< / span > < a class = "code hl_function" href = "classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7" > ~ScreeningModel< / a > () = < span class = "keywordflow" > default< / span > ;< / div >
< div class = "line" > < a id = "l00037" name = "l00037" > < / a > < span class = "lineno" > 37< / span > < / div >
< div class = "line" > < a id = "l00073" name = "l00073" > < / a > < span class = "lineno" > < a class = "line" href = "classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde" > 73< / a > < / span > < span class = "keyword" > virtual< / span > std::vector< double> < a class = "code hl_function" href = "classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde" > calculateScreeningFactors< / a > (< / div >
< div class = "line" > < a id = "l00074" name = "l00074" > < / a > < span class = "lineno" > 74< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > reaction::LogicalReactionSet< / a > & reactions,< / div >
< div class = "line" > < a id = "l00075" name = "l00075" > < / a > < span class = "lineno" > 75< / span > < span class = "keyword" > const< / span > std::vector< fourdst::atomic::Species> & species,< / div >
< div class = "line" > < a id = "l00076" name = "l00076" > < / a > < span class = "lineno" > 76< / span > < span class = "keyword" > const< / span > std::vector< double> & Y,< / div >
< div class = "line" > < a id = "l00077" name = "l00077" > < / a > < span class = "lineno" > 77< / span > < span class = "keyword" > const< / span > < span class = "keywordtype" > double< / span > T9,< / div >
< div class = "line" > < a id = "l00078" name = "l00078" > < / a > < span class = "lineno" > 78< / span > < span class = "keyword" > const< / span > < span class = "keywordtype" > double< / span > rho< / div >
< div class = "line" > < a id = "l00079" name = "l00079" > < / a > < span class = "lineno" > 79< / span > ) < span class = "keyword" > const< / span > = 0;< / div >
< div class = "line" > < a id = "l00080" name = "l00080" > < / a > < span class = "lineno" > 80< / span > < / div >
< div class = "line" > < a id = "l00100" name = "l00100" > < / a > < span class = "lineno" > < a class = "line" href = "classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22" > 100< / a > < / span > < span class = "keyword" > virtual< / span > std::vector< ADDouble> < a class = "code hl_function" href = "classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22" > calculateScreeningFactors< / a > (< / div >
< div class = "line" > < a id = "l00101" name = "l00101" > < / a > < span class = "lineno" > 101< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31" > reaction::LogicalReactionSet< / a > & reactions,< / div >
< div class = "line" > < a id = "l00102" name = "l00102" > < / a > < span class = "lineno" > 102< / span > < span class = "keyword" > const< / span > std::vector< fourdst::atomic::Species> & species,< / div >
< div class = "line" > < a id = "l00103" name = "l00103" > < / a > < span class = "lineno" > 103< / span > < span class = "keyword" > const< / span > std::vector< ADDouble> & Y,< / div >
< div class = "line" > < a id = "l00104" name = "l00104" > < / a > < span class = "lineno" > 104< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > T9,< / div >
< div class = "line" > < a id = "l00105" name = "l00105" > < / a > < span class = "lineno" > 105< / span > < span class = "keyword" > const< / span > < a class = "code hl_typedef" href = "classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d" > ADDouble< / a > rho< / div >
< div class = "line" > < a id = "l00106" name = "l00106" > < / a > < span class = "lineno" > 106< / span > ) < span class = "keyword" > const< / span > = 0;< / div >
< div class = "line" > < a id = "l00107" name = "l00107" > < / a > < span class = "lineno" > 107< / span > };< / div >
2025-07-01 11:40:58 -04:00
< / div >
2025-07-01 15:06:22 -04:00
< div class = "line" > < a id = "l00108" name = "l00108" > < / a > < span class = "lineno" > 108< / span > }< / div >
2025-07-01 11:40:58 -04:00
< / div >
2025-07-01 15:06:22 -04:00
< 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 = "#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 = "#l00030" > screening_abstract.h:30< / a > < / div > < / div >
< div class = "ttc" id = "aclassgridfire_1_1screening_1_1_screening_model_html_a6c381a823cb9c1680d3e9c846da4ae22" > < div class = "ttname" > < a href = "classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22" > gridfire::screening::ScreeningModel::calculateScreeningFactors< / a > < / div > < div class = "ttdeci" > virtual std::vector< ADDouble > calculateScreeningFactors(const reaction::LogicalReactionSet & reactions, const std::vector< fourdst::atomic::Species > & species, const std::vector< ADDouble > & Y, const ADDouble T9, const ADDouble rho) const =0< / div > < div class = "ttdoc" > Calculates screening factors using CppAD types for automatic differentiation.< / div > < / div >
< div class = "ttc" id = "aclassgridfire_1_1screening_1_1_screening_model_html_aaec9184d80c86a2d8674e395dad81bde" > < div class = "ttname" > < a href = "classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde" > gridfire::screening::ScreeningModel::calculateScreeningFactors< / a > < / div > < div class = "ttdeci" > virtual std::vector< double > calculateScreeningFactors(const reaction::LogicalReactionSet & reactions, const std::vector< fourdst::atomic::Species > & species, const std::vector< double > & Y, const double T9, const double rho) const =0< / div > < div class = "ttdoc" > Calculates screening factors for a set of reactions.< / div > < / div >
< div class = "ttc" id = "aclassgridfire_1_1screening_1_1_screening_model_html_adef175acdbd911527f56a1f1592579a7" > < div class = "ttname" > < a href = "classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7" > gridfire::screening::ScreeningModel::~ScreeningModel< / a > < / div > < div class = "ttdeci" > virtual ~ScreeningModel()=default< / div > < div class = "ttdoc" > Virtual destructor.< / div > < / div >
2025-07-01 11:40:58 -04:00
< 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#l00557" > reaction.h:557< / a > < / div > < / div >
< div class = "ttc" id = "anamespacegridfire_1_1screening_html" > < div class = "ttname" > < a href = "namespacegridfire_1_1screening.html" > gridfire::screening< / a > < / div > < div class = "ttdef" > < b > Definition< / b > < a href = "#l00011" > screening_abstract.h:11< / a > < / div > < / div >
< div class = "ttc" id = "areaction_8h_html" > < div class = "ttname" > < a href = "reaction_8h.html" > reaction.h< / a > < / div > < div class = "ttdoc" > Defines classes for representing and managing nuclear reactions.< / 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_fc4c7f03e1a69a98c370fae55a743828.html" > network< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_5cccfa813acdf3744b542715860d37b2.html" > include< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_2a1262ef5950eb718393488a3eb5aa9f.html" > gridfire< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_a1a1065684fbb5b386566d81dc65d72d.html" > screening< / a > < / li > < li class = "navelem" > < a class = "el" href = "screening__abstract_8h.html" > screening_abstract.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 >
