docs(docs): added extensive docs
This commit is contained in:
@@ -117,142 +117,142 @@ $(function(){initNavTree('engine__defined_8h_source.html',''); initResizable(tru
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include <string></span></div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacegridfire.html">gridfire</a>{</div>
|
||||
<div class="foldopen" id="foldopen00016" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html"> 16</a></span> <span class="keyword">class </span><a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd">FileDefinedEngineView</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>, <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_engine_view.html">EngineView</a><DynamicEngine> {</div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd">FileDefinedEngineView</a>(</div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& baseEngine,</div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <span class="keyword">const</span> std::string& fileName,</div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1io_1_1_network_file_parser.html">io::NetworkFileParser</a>& parser</div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> );</div>
|
||||
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// --- EngineView Interface ---</span></div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a4c8b273c5cb3d470567c5691b68493a3">getBaseEngine</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <span class="comment">// --- Engine Interface ---</span></div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">const</span> std::vector<fourdst::atomic::Species>& <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8bb583e039b49608272997ed2d3387fa">getNetworkSpecies</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// --- DynamicEngine Interface ---</span></div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <a class="code hl_struct" href="structgridfire_1_1_step_derivatives.html">StepDerivatives<double></a> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a2c1d88b06568f9ea4c65e794d012ebfb">calculateRHSAndEnergy</a>(</div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a48b2451f96b8f5511ffc4071519c0810">generateJacobianMatrix</a>(</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> ) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a0ef8804780d13bbfce0856237bb00470">getJacobianMatrixEntry</a>(</div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">const</span> <span class="keywordtype">int</span> i_defined,</div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="keyword">const</span> <span class="keywordtype">int</span> j_defined</div>
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a27a5163157cc15c4cb3b99a5d3564dbd">generateStoichiometryMatrix</a>() <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a9da9224f5c99a5068f3d8cbf066e4693">getStoichiometryMatrixEntry</a>(</div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keyword">const</span> <span class="keywordtype">int</span> speciesIndex_defined,</div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">const</span> <span class="keywordtype">int</span> reactionIndex_defined</div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ac371fb66fd0a76a04df204c9dd9a05ef">calculateMolarReactionFlow</a>(</div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a>& <a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>,</div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a>& <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a5bbea17b69cc8f81bc251a04f4435a0c">getNetworkReactions</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> std::unordered_map<fourdst::atomic::Species, double> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ace3c6ea4841318c08695973ab3dcddc6">getSpeciesTimescales</a>(</div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
|
||||
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ace3568eadaba69e7357b4386c5ca3eb0">update</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">NetIn</a> &netIn) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
|
||||
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a92f14da849e99d07c1ff1347addb9263">setNetworkFile</a>(<span class="keyword">const</span> std::string& fileName);</div>
|
||||
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> </div>
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ad96bbee6d3d37b50d9236a975ef704c0">setScreeningModel</a>(<a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> model) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> </div>
|
||||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> [[nodiscard]] <a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#adbc50f397445f92b810d80cf329b8626">getScreeningModel</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187"> 71</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187">Config</a> = fourdst::config::Config;</div>
|
||||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08"> 72</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08">LogManager</a> = fourdst::logging::LogManager;</div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362"> 73</a></span> <a class="code hl_typedef" href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187">Config</a>& <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362">m_config</a> = Config::getInstance();</div>
|
||||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432"> 74</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432">m_logger</a> = LogManager::getInstance().getLogger(<span class="stringliteral">"log"</span>);</div>
|
||||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> </div>
|
||||
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81"> 76</a></span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81">m_baseEngine</a>;</div>
|
||||
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b"> 77</a></span> std::string <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b">m_fileName</a>; </div>
|
||||
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500"> 78</a></span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1io_1_1_network_file_parser.html">io::NetworkFileParser</a>& <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500">m_parser</a>; </div>
|
||||
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
|
||||
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e"> 80</a></span> std::vector<fourdst::atomic::Species> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e">m_activeSpecies</a>; </div>
|
||||
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2"> 81</a></span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2">m_activeReactions</a>; </div>
|
||||
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
||||
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b"> 83</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b">m_speciesIndexMap</a>; </div>
|
||||
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e"> 84</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e">m_reactionIndexMap</a>; </div>
|
||||
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> </div>
|
||||
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595"> 86</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595">m_isStale</a> = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
|
||||
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a3b5162b7be35405285ef9f825ec2663b">buildFromFile</a>(<span class="keyword">const</span> std::string& fileName);</div>
|
||||
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span></div>
|
||||
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a51ba09ff01fdcac1125d42f276c9a0a7">constructSpeciesIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span></div>
|
||||
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#aebb3f3548f8781506f31580706810a4e">constructReactionIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span></div>
|
||||
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> std::vector<double> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ac231044e37e0962f664f8465e1ccb022">mapViewToFull</a>(<span class="keyword">const</span> std::vector<double>& culled) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span></div>
|
||||
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> std::vector<double> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a97e5ee4651dbe6754678fe96e4702fee">mapFullToView</a>(<span class="keyword">const</span> std::vector<double>& full) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span></div>
|
||||
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8d2c6b9a33b9c8c172bbd2c2e2e9ffaf">mapViewToFullSpeciesIndex</a>(<span class="keywordtype">size_t</span> culledSpeciesIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span></div>
|
||||
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ae7d6f0ff9076d59d1245c047bbd1bdb9">mapViewToFullReactionIndex</a>(<span class="keywordtype">size_t</span> culledReactionIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> </div>
|
||||
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ae3f99002ab2c56a5bcdec00839f8628f">validateNetworkState</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> };</div>
|
||||
<div class="foldopen" id="foldopen00036" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html"> 36</a></span> <span class="keyword">class </span><a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd">FileDefinedEngineView</a> final: <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>, <span class="keyword">public</span> <a class="code hl_class" href="classgridfire_1_1_engine_view.html">EngineView</a><DynamicEngine> {</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">public</span>:</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keyword">explicit</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd">FileDefinedEngineView</a>(</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& baseEngine,</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">const</span> std::string& fileName,</div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1io_1_1_network_file_parser.html">io::NetworkFileParser</a>& parser</div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> );</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> </div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="comment">// --- EngineView Interface ---</span></div>
|
||||
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a4c8b273c5cb3d470567c5691b68493a3">getBaseEngine</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
||||
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// --- Engine Interface ---</span></div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">const</span> std::vector<fourdst::atomic::Species>& <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a8bb583e039b49608272997ed2d3387fa">getNetworkSpecies</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
|
||||
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="comment">// --- DynamicEngine Interface ---</span></div>
|
||||
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <a class="code hl_struct" href="structgridfire_1_1_step_derivatives.html">StepDerivatives<double></a> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a2c1d88b06568f9ea4c65e794d012ebfb">calculateRHSAndEnergy</a>(</div>
|
||||
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a48b2451f96b8f5511ffc4071519c0810">generateJacobianMatrix</a>(</div>
|
||||
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> ) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a0ef8804780d13bbfce0856237bb00470">getJacobianMatrixEntry</a>(</div>
|
||||
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <span class="keyword">const</span> <span class="keywordtype">int</span> i_defined,</div>
|
||||
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">const</span> <span class="keywordtype">int</span> j_defined</div>
|
||||
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a27a5163157cc15c4cb3b99a5d3564dbd">generateStoichiometryMatrix</a>() <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a9da9224f5c99a5068f3d8cbf066e4693">getStoichiometryMatrixEntry</a>(</div>
|
||||
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span> <span class="keyword">const</span> <span class="keywordtype">int</span> speciesIndex_defined,</div>
|
||||
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span> <span class="keyword">const</span> <span class="keywordtype">int</span> reactionIndex_defined</div>
|
||||
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <span class="keywordtype">double</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ac371fb66fd0a76a04df204c9dd9a05ef">calculateMolarReactionFlow</a>(</div>
|
||||
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1reaction_1_1_reaction.html">reaction::Reaction</a>& <a class="code hl_namespace" href="namespacegridfire_1_1reaction.html">reaction</a>,</div>
|
||||
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"> 156</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span> <span class="keyword">const</span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a>& <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a5bbea17b69cc8f81bc251a04f4435a0c">getNetworkReactions</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> std::unordered_map<fourdst::atomic::Species, double> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ace3c6ea4841318c08695973ab3dcddc6">getSpeciesTimescales</a>(</div>
|
||||
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> <span class="keyword">const</span> std::vector<double>& Y_defined,</div>
|
||||
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span> <span class="keyword">const</span> <span class="keywordtype">double</span> T9,</div>
|
||||
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> <span class="keyword">const</span> <span class="keywordtype">double</span> rho</div>
|
||||
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> ) <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span></div>
|
||||
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno"> 192</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ace3568eadaba69e7357b4386c5ca3eb0">update</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structgridfire_1_1_net_in.html">NetIn</a> &netIn) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno"> 193</span></div>
|
||||
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno"> 207</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a92f14da849e99d07c1ff1347addb9263">setNetworkFile</a>(<span class="keyword">const</span> std::string& fileName);</div>
|
||||
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span></div>
|
||||
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno"> 214</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ad96bbee6d3d37b50d9236a975ef704c0">setScreeningModel</a>(<a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> model) <span class="keyword">override</span>;</div>
|
||||
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno"> 215</span></div>
|
||||
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"> 221</span> [[nodiscard]] <a class="code hl_enumeration" href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">screening::ScreeningType</a> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#adbc50f397445f92b810d80cf329b8626">getScreeningModel</a>() <span class="keyword">const override</span>;</div>
|
||||
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187"> 223</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187">Config</a> = fourdst::config::Config;</div>
|
||||
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08"> 224</a></span> <span class="keyword">using </span><a class="code hl_typedef" href="classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08">LogManager</a> = fourdst::logging::LogManager;</div>
|
||||
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362"> 226</a></span> <a class="code hl_typedef" href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187">Config</a>& <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362">m_config</a> = Config::getInstance();</div>
|
||||
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432"> 228</a></span> quill::Logger* <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432">m_logger</a> = LogManager::getInstance().getLogger(<span class="stringliteral">"log"</span>);</div>
|
||||
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span></div>
|
||||
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81"> 231</a></span> <a class="code hl_class" href="classgridfire_1_1_dynamic_engine.html">DynamicEngine</a>& <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81">m_baseEngine</a>;</div>
|
||||
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b"> 233</a></span> std::string <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b">m_fileName</a>;</div>
|
||||
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500"> 235</a></span> <span class="keyword">const</span> <a class="code hl_class" href="classgridfire_1_1io_1_1_network_file_parser.html">io::NetworkFileParser</a>& <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500">m_parser</a>;</div>
|
||||
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span></div>
|
||||
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e"> 238</a></span> std::vector<fourdst::atomic::Species> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e">m_activeSpecies</a>;</div>
|
||||
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2"> 240</a></span> <a class="code hl_typedef" href="namespacegridfire_1_1reaction.html#aa86f08712565f278adacc7cd2361eb31">reaction::LogicalReactionSet</a> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2">m_activeReactions</a>;</div>
|
||||
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span></div>
|
||||
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b"> 243</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b">m_speciesIndexMap</a>;</div>
|
||||
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e"> 245</a></span> std::vector<size_t> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e">m_reactionIndexMap</a>;</div>
|
||||
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span></div>
|
||||
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"><a class="line" href="classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595"> 248</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595">m_isStale</a> = <span class="keyword">true</span>;</div>
|
||||
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span> </div>
|
||||
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno"> 268</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a3b5162b7be35405285ef9f825ec2663b">buildFromFile</a>(<span class="keyword">const</span> std::string& fileName);</div>
|
||||
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno"> 269</span></div>
|
||||
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno"> 280</span> std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a51ba09ff01fdcac1125d42f276c9a0a7">constructSpeciesIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno"> 281</span></div>
|
||||
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno"> 292</span> std::vector<size_t> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#aebb3f3548f8781506f31580706810a4e">constructReactionIndexMap</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno"> 293</span></div>
|
||||
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno"> 301</span> std::vector<double> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#adba3c11b11a04b2907c1635210d73dee">mapViewToFull</a>(<span class="keyword">const</span> std::vector<double>& defined) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno"> 302</span></div>
|
||||
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno"> 310</span> std::vector<double> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a97e5ee4651dbe6754678fe96e4702fee">mapFullToView</a>(<span class="keyword">const</span> std::vector<double>& full) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno"> 311</span></div>
|
||||
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno"> 320</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#aa2373955ef5b0eabf7a57c7208e38bb1">mapViewToFullSpeciesIndex</a>(<span class="keywordtype">size_t</span> definedSpeciesIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"> 321</span></div>
|
||||
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno"> 330</span> <span class="keywordtype">size_t</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#a74217a1f8fd8e6daff969cb17885315c">mapViewToFullReactionIndex</a>(<span class="keywordtype">size_t</span> definedReactionIndex) <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno"> 331</span></div>
|
||||
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno"> 337</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classgridfire_1_1_file_defined_engine_view.html#ae3f99002ab2c56a5bcdec00839f8628f">validateNetworkState</a>() <span class="keyword">const</span>;</div>
|
||||
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno"> 338</span> };</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span>}</div>
|
||||
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno"> 339</span>}</div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_dynamic_engine_html"><div class="ttname"><a href="classgridfire_1_1_dynamic_engine.html">gridfire::DynamicEngine</a></div><div class="ttdoc">Abstract class for engines supporting Jacobian and stoichiometry operations.</div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00121">engine_abstract.h:121</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_engine_view_html"><div class="ttname"><a href="classgridfire_1_1_engine_view.html">gridfire::EngineView</a></div><div class="ttdoc">Abstract base class for a "view" of a reaction network engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__view__abstract_8h_source.html#l00074">engine_view_abstract.h:74</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a0a9b07176cb93b54c677b6ce71fda500"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500">gridfire::FileDefinedEngineView::m_parser</a></div><div class="ttdeci">const io::NetworkFileParser & m_parser</div><div class="ttdoc">Parser for the network file.</div><div class="ttdef"><b>Definition</b> <a href="#l00078">engine_defined.h:78</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a0ef8804780d13bbfce0856237bb00470"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a0ef8804780d13bbfce0856237bb00470">gridfire::FileDefinedEngineView::getJacobianMatrixEntry</a></div><div class="ttdeci">double getJacobianMatrixEntry(const int i_defined, const int j_defined) const override</div><div class="ttdoc">Get an entry from the previously generated Jacobian matrix.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00056">engine_defined.cpp:56</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a1b343998b93955025a589b2b4541e33b"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b">gridfire::FileDefinedEngineView::m_fileName</a></div><div class="ttdeci">std::string m_fileName</div><div class="ttdoc">Name of the file defining the reaction set considered by the engine view.</div><div class="ttdef"><b>Definition</b> <a href="#l00077">engine_defined.h:77</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a27a5163157cc15c4cb3b99a5d3564dbd"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a27a5163157cc15c4cb3b99a5d3564dbd">gridfire::FileDefinedEngineView::generateStoichiometryMatrix</a></div><div class="ttdeci">void generateStoichiometryMatrix() override</div><div class="ttdoc">Generate the stoichiometry matrix for the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00068">engine_defined.cpp:68</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a299a0c61aa4f26029c770013c9feff5e"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e">gridfire::FileDefinedEngineView::m_activeSpecies</a></div><div class="ttdeci">std::vector< fourdst::atomic::Species > m_activeSpecies</div><div class="ttdoc">Active species in the defined engine.</div><div class="ttdef"><b>Definition</b> <a href="#l00080">engine_defined.h:80</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a2c1d88b06568f9ea4c65e794d012ebfb"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a2c1d88b06568f9ea4c65e794d012ebfb">gridfire::FileDefinedEngineView::calculateRHSAndEnergy</a></div><div class="ttdeci">StepDerivatives< double > calculateRHSAndEnergy(const std::vector< double > &Y_defined, const double T9, const double rho) const override</div><div class="ttdoc">Calculate the right-hand side (dY/dt) and energy generation.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00029">engine_defined.cpp:29</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a3b5162b7be35405285ef9f825ec2663b"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a3b5162b7be35405285ef9f825ec2663b">gridfire::FileDefinedEngineView::buildFromFile</a></div><div class="ttdeci">void buildFromFile(const std::string &fileName)</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00208">engine_defined.cpp:208</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a48b2451f96b8f5511ffc4071519c0810"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a48b2451f96b8f5511ffc4071519c0810">gridfire::FileDefinedEngineView::generateJacobianMatrix</a></div><div class="ttdeci">void generateJacobianMatrix(const std::vector< double > &Y_defined, const double T9, const double rho) override</div><div class="ttdoc">Generate the Jacobian matrix for the current state.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00045">engine_defined.cpp:45</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a4c8b273c5cb3d470567c5691b68493a3"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a4c8b273c5cb3d470567c5691b68493a3">gridfire::FileDefinedEngineView::getBaseEngine</a></div><div class="ttdeci">const DynamicEngine & getBaseEngine() const override</div><div class="ttdoc">Access the underlying engine instance.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00021">engine_defined.cpp:21</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a0a9b07176cb93b54c677b6ce71fda500"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a0a9b07176cb93b54c677b6ce71fda500">gridfire::FileDefinedEngineView::m_parser</a></div><div class="ttdeci">const io::NetworkFileParser & m_parser</div><div class="ttdoc">Active species in the defined engine.</div><div class="ttdef"><b>Definition</b> <a href="#l00235">engine_defined.h:235</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a0ef8804780d13bbfce0856237bb00470"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a0ef8804780d13bbfce0856237bb00470">gridfire::FileDefinedEngineView::getJacobianMatrixEntry</a></div><div class="ttdeci">double getJacobianMatrixEntry(const int i_defined, const int j_defined) const override</div><div class="ttdoc">Gets an entry from the Jacobian matrix for the active species.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00056">engine_defined.cpp:56</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a1b343998b93955025a589b2b4541e33b"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a1b343998b93955025a589b2b4541e33b">gridfire::FileDefinedEngineView::m_fileName</a></div><div class="ttdeci">std::string m_fileName</div><div class="ttdoc">Parser for the network file.</div><div class="ttdef"><b>Definition</b> <a href="#l00233">engine_defined.h:233</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a27a5163157cc15c4cb3b99a5d3564dbd"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a27a5163157cc15c4cb3b99a5d3564dbd">gridfire::FileDefinedEngineView::generateStoichiometryMatrix</a></div><div class="ttdeci">void generateStoichiometryMatrix() override</div><div class="ttdoc">Generates the stoichiometry matrix for the active reactions and species.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00068">engine_defined.cpp:68</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a299a0c61aa4f26029c770013c9feff5e"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a299a0c61aa4f26029c770013c9feff5e">gridfire::FileDefinedEngineView::m_activeSpecies</a></div><div class="ttdeci">std::vector< fourdst::atomic::Species > m_activeSpecies</div><div class="ttdoc">Active reactions in the defined engine.</div><div class="ttdef"><b>Definition</b> <a href="#l00238">engine_defined.h:238</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a2c1d88b06568f9ea4c65e794d012ebfb"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a2c1d88b06568f9ea4c65e794d012ebfb">gridfire::FileDefinedEngineView::calculateRHSAndEnergy</a></div><div class="ttdeci">StepDerivatives< double > calculateRHSAndEnergy(const std::vector< double > &Y_defined, const double T9, const double rho) const override</div><div class="ttdoc">Calculates the right-hand side (dY/dt) and energy generation for the active species.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00029">engine_defined.cpp:29</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a3b5162b7be35405285ef9f825ec2663b"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a3b5162b7be35405285ef9f825ec2663b">gridfire::FileDefinedEngineView::buildFromFile</a></div><div class="ttdeci">void buildFromFile(const std::string &fileName)</div><div class="ttdoc">Builds the active species and reaction sets from a file.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00208">engine_defined.cpp:208</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a48b2451f96b8f5511ffc4071519c0810"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a48b2451f96b8f5511ffc4071519c0810">gridfire::FileDefinedEngineView::generateJacobianMatrix</a></div><div class="ttdeci">void generateJacobianMatrix(const std::vector< double > &Y_defined, const double T9, const double rho) override</div><div class="ttdoc">Generates the Jacobian matrix for the active species.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00045">engine_defined.cpp:45</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a4c8b273c5cb3d470567c5691b68493a3"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a4c8b273c5cb3d470567c5691b68493a3">gridfire::FileDefinedEngineView::getBaseEngine</a></div><div class="ttdeci">const DynamicEngine & getBaseEngine() const override</div><div class="ttdoc">Gets the base engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00021">engine_defined.cpp:21</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a51ba09ff01fdcac1125d42f276c9a0a7"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a51ba09ff01fdcac1125d42f276c9a0a7">gridfire::FileDefinedEngineView::constructSpeciesIndexMap</a></div><div class="ttdeci">std::vector< size_t > constructSpeciesIndexMap() const</div><div class="ttdoc">Constructs the species index map.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00147">engine_defined.cpp:147</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a5bbea17b69cc8f81bc251a04f4435a0c"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a5bbea17b69cc8f81bc251a04f4435a0c">gridfire::FileDefinedEngineView::getNetworkReactions</a></div><div class="ttdeci">const reaction::LogicalReactionSet & getNetworkReactions() const override</div><div class="ttdoc">Get the set of logical reactions in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00102">engine_defined.cpp:102</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a63f8f85e75ecaab6fa39d48d7a846187"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187">gridfire::FileDefinedEngineView::Config</a></div><div class="ttdeci">fourdst::config::Config Config</div><div class="ttdef"><b>Definition</b> <a href="#l00071">engine_defined.h:71</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a6e421bc748933be31bed9ff53f12b595"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595">gridfire::FileDefinedEngineView::m_isStale</a></div><div class="ttdeci">bool m_isStale</div><div class="ttdef"><b>Definition</b> <a href="#l00086">engine_defined.h:86</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a7a80966c023ae722239491af58609362"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362">gridfire::FileDefinedEngineView::m_config</a></div><div class="ttdeci">Config & m_config</div><div class="ttdef"><b>Definition</b> <a href="#l00073">engine_defined.h:73</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a8bb583e039b49608272997ed2d3387fa"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a8bb583e039b49608272997ed2d3387fa">gridfire::FileDefinedEngineView::getNetworkSpecies</a></div><div class="ttdeci">const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override</div><div class="ttdoc">Get the list of species in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00025">engine_defined.cpp:25</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a8d2c6b9a33b9c8c172bbd2c2e2e9ffaf"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a8d2c6b9a33b9c8c172bbd2c2e2e9ffaf">gridfire::FileDefinedEngineView::mapViewToFullSpeciesIndex</a></div><div class="ttdeci">size_t mapViewToFullSpeciesIndex(size_t culledSpeciesIndex) const</div><div class="ttdoc">Maps a culled species index to a full species index.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00285">engine_defined.cpp:285</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a8f2f64bab0f516ed2a6fd529912e0acd"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd">gridfire::FileDefinedEngineView::FileDefinedEngineView</a></div><div class="ttdeci">FileDefinedEngineView(DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00008">engine_defined.cpp:8</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a92f14da849e99d07c1ff1347addb9263"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a92f14da849e99d07c1ff1347addb9263">gridfire::FileDefinedEngineView::setNetworkFile</a></div><div class="ttdeci">void setNetworkFile(const std::string &fileName)</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00133">engine_defined.cpp:133</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a5bbea17b69cc8f81bc251a04f4435a0c"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a5bbea17b69cc8f81bc251a04f4435a0c">gridfire::FileDefinedEngineView::getNetworkReactions</a></div><div class="ttdeci">const reaction::LogicalReactionSet & getNetworkReactions() const override</div><div class="ttdoc">Gets the set of active logical reactions in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00102">engine_defined.cpp:102</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a63f8f85e75ecaab6fa39d48d7a846187"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a63f8f85e75ecaab6fa39d48d7a846187">gridfire::FileDefinedEngineView::Config</a></div><div class="ttdeci">fourdst::config::Config Config</div><div class="ttdef"><b>Definition</b> <a href="#l00223">engine_defined.h:223</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a6e421bc748933be31bed9ff53f12b595"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a6e421bc748933be31bed9ff53f12b595">gridfire::FileDefinedEngineView::m_isStale</a></div><div class="ttdeci">bool m_isStale</div><div class="ttdoc">A flag indicating whether the view is stale and needs to be updated.</div><div class="ttdef"><b>Definition</b> <a href="#l00248">engine_defined.h:248</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a74217a1f8fd8e6daff969cb17885315c"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a74217a1f8fd8e6daff969cb17885315c">gridfire::FileDefinedEngineView::mapViewToFullReactionIndex</a></div><div class="ttdeci">size_t mapViewToFullReactionIndex(size_t definedReactionIndex) const</div><div class="ttdoc">Maps a culled reaction index to a full reaction index.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00294">engine_defined.cpp:294</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a7a80966c023ae722239491af58609362"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a7a80966c023ae722239491af58609362">gridfire::FileDefinedEngineView::m_config</a></div><div class="ttdeci">Config & m_config</div><div class="ttdoc">A reference to the singleton Config instance.</div><div class="ttdef"><b>Definition</b> <a href="#l00226">engine_defined.h:226</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a8bb583e039b49608272997ed2d3387fa"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a8bb583e039b49608272997ed2d3387fa">gridfire::FileDefinedEngineView::getNetworkSpecies</a></div><div class="ttdeci">const std::vector< fourdst::atomic::Species > & getNetworkSpecies() const override</div><div class="ttdoc">Gets the list of active species in the network defined by the file.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00025">engine_defined.cpp:25</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a8f2f64bab0f516ed2a6fd529912e0acd"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a8f2f64bab0f516ed2a6fd529912e0acd">gridfire::FileDefinedEngineView::FileDefinedEngineView</a></div><div class="ttdeci">FileDefinedEngineView(DynamicEngine &baseEngine, const std::string &fileName, const io::NetworkFileParser &parser)</div><div class="ttdoc">Constructs a FileDefinedEngineView.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00008">engine_defined.cpp:8</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a92f14da849e99d07c1ff1347addb9263"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a92f14da849e99d07c1ff1347addb9263">gridfire::FileDefinedEngineView::setNetworkFile</a></div><div class="ttdeci">void setNetworkFile(const std::string &fileName)</div><div class="ttdoc">Sets a new network file to define the active reactions.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00133">engine_defined.cpp:133</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a97e5ee4651dbe6754678fe96e4702fee"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a97e5ee4651dbe6754678fe96e4702fee">gridfire::FileDefinedEngineView::mapFullToView</a></div><div class="ttdeci">std::vector< double > mapFullToView(const std::vector< double > &full) const</div><div class="ttdoc">Maps a vector of full abundances to a vector of culled abundances.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00276">engine_defined.cpp:276</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a9d93633ed4ab68de94b7274f879a0432"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432">gridfire::FileDefinedEngineView::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdef"><b>Definition</b> <a href="#l00074">engine_defined.h:74</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a9da9224f5c99a5068f3d8cbf066e4693"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a9da9224f5c99a5068f3d8cbf066e4693">gridfire::FileDefinedEngineView::getStoichiometryMatrixEntry</a></div><div class="ttdeci">int getStoichiometryMatrixEntry(const int speciesIndex_defined, const int reactionIndex_defined) const override</div><div class="ttdoc">Get an entry from the stoichiometry matrix.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00074">engine_defined.cpp:74</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ac231044e37e0962f664f8465e1ccb022"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ac231044e37e0962f664f8465e1ccb022">gridfire::FileDefinedEngineView::mapViewToFull</a></div><div class="ttdeci">std::vector< double > mapViewToFull(const std::vector< double > &culled) const</div><div class="ttdoc">Maps a vector of culled abundances to a vector of full abundances.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00267">engine_defined.cpp:267</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ac371fb66fd0a76a04df204c9dd9a05ef"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ac371fb66fd0a76a04df204c9dd9a05ef">gridfire::FileDefinedEngineView::calculateMolarReactionFlow</a></div><div class="ttdeci">double calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const override</div><div class="ttdoc">Calculate the molar reaction flow for a given reaction.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00085">engine_defined.cpp:85</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_acbb1a9bcb775e6d50de512a333afed08"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08">gridfire::FileDefinedEngineView::LogManager</a></div><div class="ttdeci">fourdst::logging::LogManager LogManager</div><div class="ttdef"><b>Definition</b> <a href="#l00072">engine_defined.h:72</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ace3568eadaba69e7357b4386c5ca3eb0"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ace3568eadaba69e7357b4386c5ca3eb0">gridfire::FileDefinedEngineView::update</a></div><div class="ttdeci">void update(const NetIn &netIn) override</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00127">engine_defined.cpp:127</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ace3c6ea4841318c08695973ab3dcddc6"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ace3c6ea4841318c08695973ab3dcddc6">gridfire::FileDefinedEngineView::getSpeciesTimescales</a></div><div class="ttdeci">std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales(const std::vector< double > &Y_defined, const double T9, const double rho) const override</div><div class="ttdoc">Compute timescales for all species in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00108">engine_defined.cpp:108</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ad8454c98fa9a4bb45dc81059bc51fc81"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81">gridfire::FileDefinedEngineView::m_baseEngine</a></div><div class="ttdeci">DynamicEngine & m_baseEngine</div><div class="ttdef"><b>Definition</b> <a href="#l00076">engine_defined.h:76</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ad96bbee6d3d37b50d9236a975ef704c0"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ad96bbee6d3d37b50d9236a975ef704c0">gridfire::FileDefinedEngineView::setScreeningModel</a></div><div class="ttdeci">void setScreeningModel(screening::ScreeningType model) override</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00139">engine_defined.cpp:139</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_adbc50f397445f92b810d80cf329b8626"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#adbc50f397445f92b810d80cf329b8626">gridfire::FileDefinedEngineView::getScreeningModel</a></div><div class="ttdeci">screening::ScreeningType getScreeningModel() const override</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00143">engine_defined.cpp:143</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ae012da2b1f6169cb13e6075a73353ab2"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2">gridfire::FileDefinedEngineView::m_activeReactions</a></div><div class="ttdeci">reaction::LogicalReactionSet m_activeReactions</div><div class="ttdoc">Active reactions in the defined engine.</div><div class="ttdef"><b>Definition</b> <a href="#l00081">engine_defined.h:81</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ae3f99002ab2c56a5bcdec00839f8628f"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ae3f99002ab2c56a5bcdec00839f8628f">gridfire::FileDefinedEngineView::validateNetworkState</a></div><div class="ttdeci">void validateNetworkState() const</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00303">engine_defined.cpp:303</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ae7d6f0ff9076d59d1245c047bbd1bdb9"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ae7d6f0ff9076d59d1245c047bbd1bdb9">gridfire::FileDefinedEngineView::mapViewToFullReactionIndex</a></div><div class="ttdeci">size_t mapViewToFullReactionIndex(size_t culledReactionIndex) const</div><div class="ttdoc">Maps a culled reaction index to a full reaction index.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00294">engine_defined.cpp:294</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a9d93633ed4ab68de94b7274f879a0432"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a9d93633ed4ab68de94b7274f879a0432">gridfire::FileDefinedEngineView::m_logger</a></div><div class="ttdeci">quill::Logger * m_logger</div><div class="ttdoc">A pointer to the logger instance.</div><div class="ttdef"><b>Definition</b> <a href="#l00228">engine_defined.h:228</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_a9da9224f5c99a5068f3d8cbf066e4693"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#a9da9224f5c99a5068f3d8cbf066e4693">gridfire::FileDefinedEngineView::getStoichiometryMatrixEntry</a></div><div class="ttdeci">int getStoichiometryMatrixEntry(const int speciesIndex_defined, const int reactionIndex_defined) const override</div><div class="ttdoc">Gets an entry from the stoichiometry matrix for the active species and reactions.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00074">engine_defined.cpp:74</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_aa2373955ef5b0eabf7a57c7208e38bb1"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#aa2373955ef5b0eabf7a57c7208e38bb1">gridfire::FileDefinedEngineView::mapViewToFullSpeciesIndex</a></div><div class="ttdeci">size_t mapViewToFullSpeciesIndex(size_t definedSpeciesIndex) const</div><div class="ttdoc">Maps a culled species index to a full species index.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00285">engine_defined.cpp:285</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ac371fb66fd0a76a04df204c9dd9a05ef"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ac371fb66fd0a76a04df204c9dd9a05ef">gridfire::FileDefinedEngineView::calculateMolarReactionFlow</a></div><div class="ttdeci">double calculateMolarReactionFlow(const reaction::Reaction &reaction, const std::vector< double > &Y_defined, const double T9, const double rho) const override</div><div class="ttdoc">Calculates the molar reaction flow for a given reaction in the active network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00085">engine_defined.cpp:85</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_acbb1a9bcb775e6d50de512a333afed08"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#acbb1a9bcb775e6d50de512a333afed08">gridfire::FileDefinedEngineView::LogManager</a></div><div class="ttdeci">fourdst::logging::LogManager LogManager</div><div class="ttdef"><b>Definition</b> <a href="#l00224">engine_defined.h:224</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ace3568eadaba69e7357b4386c5ca3eb0"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ace3568eadaba69e7357b4386c5ca3eb0">gridfire::FileDefinedEngineView::update</a></div><div class="ttdeci">void update(const NetIn &netIn) override</div><div class="ttdoc">Updates the engine view if it is marked as stale.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00127">engine_defined.cpp:127</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ace3c6ea4841318c08695973ab3dcddc6"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ace3c6ea4841318c08695973ab3dcddc6">gridfire::FileDefinedEngineView::getSpeciesTimescales</a></div><div class="ttdeci">std::unordered_map< fourdst::atomic::Species, double > getSpeciesTimescales(const std::vector< double > &Y_defined, const double T9, const double rho) const override</div><div class="ttdoc">Computes timescales for all active species in the network.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00108">engine_defined.cpp:108</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ad8454c98fa9a4bb45dc81059bc51fc81"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ad8454c98fa9a4bb45dc81059bc51fc81">gridfire::FileDefinedEngineView::m_baseEngine</a></div><div class="ttdeci">DynamicEngine & m_baseEngine</div><div class="ttdoc">The underlying engine to which this view delegates calculations.</div><div class="ttdef"><b>Definition</b> <a href="#l00231">engine_defined.h:231</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ad96bbee6d3d37b50d9236a975ef704c0"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ad96bbee6d3d37b50d9236a975ef704c0">gridfire::FileDefinedEngineView::setScreeningModel</a></div><div class="ttdeci">void setScreeningModel(screening::ScreeningType model) override</div><div class="ttdoc">Sets the screening model for the base engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00139">engine_defined.cpp:139</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_adba3c11b11a04b2907c1635210d73dee"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#adba3c11b11a04b2907c1635210d73dee">gridfire::FileDefinedEngineView::mapViewToFull</a></div><div class="ttdeci">std::vector< double > mapViewToFull(const std::vector< double > &defined) const</div><div class="ttdoc">Maps a vector of culled abundances to a vector of full abundances.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00267">engine_defined.cpp:267</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_adbc50f397445f92b810d80cf329b8626"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#adbc50f397445f92b810d80cf329b8626">gridfire::FileDefinedEngineView::getScreeningModel</a></div><div class="ttdeci">screening::ScreeningType getScreeningModel() const override</div><div class="ttdoc">Gets the screening model from the base engine.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00143">engine_defined.cpp:143</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ae012da2b1f6169cb13e6075a73353ab2"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ae012da2b1f6169cb13e6075a73353ab2">gridfire::FileDefinedEngineView::m_activeReactions</a></div><div class="ttdeci">reaction::LogicalReactionSet m_activeReactions</div><div class="ttdoc">Maps indices of active species to indices in the full network.</div><div class="ttdef"><b>Definition</b> <a href="#l00240">engine_defined.h:240</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_ae3f99002ab2c56a5bcdec00839f8628f"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#ae3f99002ab2c56a5bcdec00839f8628f">gridfire::FileDefinedEngineView::validateNetworkState</a></div><div class="ttdeci">void validateNetworkState() const</div><div class="ttdoc">Validates that the FileDefinedEngineView is not stale.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00303">engine_defined.cpp:303</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_aebb3f3548f8781506f31580706810a4e"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#aebb3f3548f8781506f31580706810a4e">gridfire::FileDefinedEngineView::constructReactionIndexMap</a></div><div class="ttdeci">std::vector< size_t > constructReactionIndexMap() const</div><div class="ttdoc">Constructs the reaction index map.</div><div class="ttdef"><b>Definition</b> <a href="engine__defined_8cpp_source.html#l00176">engine_defined.cpp:176</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_aebd4a1a584f2784f1df3d503645be03b"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b">gridfire::FileDefinedEngineView::m_speciesIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_speciesIndexMap</div><div class="ttdoc">Maps indices of active species to indices in the full network.</div><div class="ttdef"><b>Definition</b> <a href="#l00083">engine_defined.h:83</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_af0a77a4749a15aae87bdecfccbd1736e"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e">gridfire::FileDefinedEngineView::m_reactionIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_reactionIndexMap</div><div class="ttdoc">Maps indices of active reactions to indices in the full network.</div><div class="ttdef"><b>Definition</b> <a href="#l00084">engine_defined.h:84</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1io_1_1_network_file_parser_html"><div class="ttname"><a href="classgridfire_1_1io_1_1_network_file_parser.html">gridfire::io::NetworkFileParser</a></div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00017">network_file.h:17</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_aebd4a1a584f2784f1df3d503645be03b"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#aebd4a1a584f2784f1df3d503645be03b">gridfire::FileDefinedEngineView::m_speciesIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_speciesIndexMap</div><div class="ttdoc">Maps indices of active reactions to indices in the full network.</div><div class="ttdef"><b>Definition</b> <a href="#l00243">engine_defined.h:243</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1_file_defined_engine_view_html_af0a77a4749a15aae87bdecfccbd1736e"><div class="ttname"><a href="classgridfire_1_1_file_defined_engine_view.html#af0a77a4749a15aae87bdecfccbd1736e">gridfire::FileDefinedEngineView::m_reactionIndexMap</a></div><div class="ttdeci">std::vector< size_t > m_reactionIndexMap</div><div class="ttdef"><b>Definition</b> <a href="#l00245">engine_defined.h:245</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1io_1_1_network_file_parser_html"><div class="ttname"><a href="classgridfire_1_1io_1_1_network_file_parser.html">gridfire::io::NetworkFileParser</a></div><div class="ttdoc">An abstract base class for network file parsers.</div><div class="ttdef"><b>Definition</b> <a href="network__file_8h_source.html#l00038">network_file.h:38</a></div></div>
|
||||
<div class="ttc" id="aclassgridfire_1_1reaction_1_1_reaction_html"><div class="ttname"><a href="classgridfire_1_1reaction_1_1_reaction.html">gridfire::reaction::Reaction</a></div><div class="ttdoc">Represents a single nuclear reaction from a specific data source.</div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00072">reaction.h:72</a></div></div>
|
||||
<div class="ttc" id="aengine__abstract_8h_html"><div class="ttname"><a href="engine__abstract_8h.html">engine_abstract.h</a></div><div class="ttdoc">Abstract interfaces for reaction network engines in GridFire.</div></div>
|
||||
<div class="ttc" id="aengine__view__abstract_8h_html"><div class="ttname"><a href="engine__view__abstract_8h.html">engine_view_abstract.h</a></div><div class="ttdoc">Abstract interfaces for engine "views" in GridFire.</div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1reaction_html"><div class="ttname"><a href="namespacegridfire_1_1reaction.html">gridfire::reaction</a></div><div class="ttdef"><b>Definition</b> <a href="reaction_8h_source.html#l00025">reaction.h:25</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#l00557">reaction.h:557</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a></div><div class="ttdeci">ScreeningType</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00008">screening_types.h:8</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_1_1screening_html_aa82aafbc4f8c28d0a75b60798e3a7d25"><div class="ttname"><a href="namespacegridfire_1_1screening.html#aa82aafbc4f8c28d0a75b60798e3a7d25">gridfire::screening::ScreeningType</a></div><div class="ttdeci">ScreeningType</div><div class="ttdoc">Enumerates the available plasma screening models.</div><div class="ttdef"><b>Definition</b> <a href="screening__types_8h_source.html#l00015">screening_types.h:15</a></div></div>
|
||||
<div class="ttc" id="anamespacegridfire_html"><div class="ttname"><a href="namespacegridfire.html">gridfire</a></div><div class="ttdef"><b>Definition</b> <a href="engine__abstract_8h_source.html#l00024">engine_abstract.h:24</a></div></div>
|
||||
<div class="ttc" id="anetwork_8h_html"><div class="ttname"><a href="network_8h.html">network.h</a></div></div>
|
||||
<div class="ttc" id="anetwork__file_8h_html"><div class="ttname"><a href="network__file_8h.html">network_file.h</a></div></div>
|
||||
|
||||
Reference in New Issue
Block a user