docs(docs): added extensive docs
This commit is contained in:
@@ -114,36 +114,36 @@ $(function(){initNavTree('screening__abstract_8h_source.html',''); initResizable
|
||||
<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>
|
||||
<div class="foldopen" id="foldopen00012" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="classgridfire_1_1screening_1_1_screening_model.html"> 12</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="l00013" name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classgridfire_1_1screening_1_1_screening_model.html#a107ff2897f040d6f27f69d56a0bdd28d"> 14</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="l00015" name="l00015"></a><span class="lineno"><a class="line" href="classgridfire_1_1screening_1_1_screening_model.html#adef175acdbd911527f56a1f1592579a7"> 15</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="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classgridfire_1_1screening_1_1_screening_model.html#aaec9184d80c86a2d8674e395dad81bde"> 17</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="l00018" name="l00018"></a><span class="lineno"> 18</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="l00019" name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">const</span> std::vector<fourdst::atomic::Species>& species,</div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">const</span> std::vector<double>& Y,</div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> ) <span class="keyword">const</span> = 0;</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"><a class="line" href="classgridfire_1_1screening_1_1_screening_model.html#a6c381a823cb9c1680d3e9c846da4ae22"> 25</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="l00026" name="l00026"></a><span class="lineno"> 26</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="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">const</span> std::vector<fourdst::atomic::Species>& species,</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">const</span> std::vector<ADDouble>& Y,</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</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="l00030" name="l00030"></a><span class="lineno"> 30</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="l00031" name="l00031"></a><span class="lineno"> 31</span> ) <span class="keyword">const</span> = 0;</div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> };</div>
|
||||
<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>
|
||||
</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>}</div>
|
||||
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>}</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="ttdef"><b>Definition</b> <a href="#l00012">screening_abstract.h:12</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="ttdef"><b>Definition</b> <a href="#l00014">screening_abstract.h:14</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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
|
||||
Reference in New Issue
Block a user