FYS3150/Project-4
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Cory Balaton
2023-12-05 19:32:43 +01:00
parent 53900b1205
commit 5eff0b0d37
33 changed files with 564 additions and 1159 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
docs/mcmc__progression_8cpp_source.html
View File

@@ -101,28 +101,16 @@ $(document).ready(function(){initNavTree('mcmc__progression_8cpp_source.html',''
<div class="headertitle"><div class="title">mcmc_progression.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="mcmc__progression_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/** @file mcmc_progression.cpp</span></div>
<div class="line"><span class="lineno"> 2</span><span class="comment"> *</span></div>
<div class="line"><span class="lineno"> 3</span><span class="comment"> * @author Cory Alexander Balaton (coryab)</span></div>
<div class="line"><span class="lineno"> 4</span><span class="comment"> * @author Janita Ovidie Sandtrøen Willumsen (janitaws)</span></div>
<div class="line"><span class="lineno"> 5</span><span class="comment"> *</span></div>
<div class="line"><span class="lineno"> 6</span><span class="comment"> * @version 1.0</span></div>
<div class="line"><span class="lineno"> 7</span><span class="comment"> *</span></div>
<div class="line"><span class="lineno"> 8</span><span class="comment"> * @brief Execute the mcmc algorithm and write data to file after each</span></div>
<div class="line"><span class="lineno"> 9</span><span class="comment"> * Monte Carlo cycle.</span></div>
<div class="line"><span class="lineno"> 10</span><span class="comment"> *</span></div>
<div class="line"><span class="lineno"> 11</span><span class="comment"> * @bug No known bugs</span></div>
<div class="line"><span class="lineno"> 12</span><span class="comment"> * */</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="data__type_8hpp.html" title="Header for the data_t type.">&quot;data_type.hpp&quot;</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="monte__carlo_8hpp.html" title="Functions for Monte Carlo simulations.">&quot;monte_carlo.hpp&quot;</a></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#</span><span class="preprocessor">include</span> <a class="code" href="utils_8hpp.html" title="Function prototypes and macros that are useful.">&quot;utils.hpp&quot;</a></div>
<a href="mcmc__progression_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;<a class="code" href="data__type_8hpp.html">data_type.hpp</a>&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;<a class="code" href="monte__carlo_8hpp.html">monte_carlo.hpp</a>&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;<a class="code" href="utils_8hpp.html">utils.hpp</a>&quot;</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"> 17</span><span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor">&lt;</span><span class="preprocessor">getopt</span><span class="preprocessor">.</span><span class="preprocessor">h</span><span class="preprocessor">&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor">&lt;</span><span class="preprocessor">omp</span><span class="preprocessor">.</span><span class="preprocessor">h</span><span class="preprocessor">&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#</span><span class="preprocessor">include</span> <span class="preprocessor">&lt;</span><span class="preprocessor">string</span><span class="preprocessor">&gt;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &lt;getopt.h&gt;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &lt;omp.h&gt;</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="comment">/** @brief A function that displays how to use the program and quits.*/</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1"> 22</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="main_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a>(std::string filename)</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1"> 22</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a>(std::string filename)</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> std::cout &lt;&lt; <span class="stringliteral">&quot;Usage: &quot;</span> &lt;&lt; filename</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> &lt;&lt; <span class="stringliteral">&quot; &lt;temperature&gt; &lt;lattice size&gt; &quot;</span></div>
@@ -131,11 +119,10 @@ $(document).ready(function(){initNavTree('mcmc__progression_8cpp_source.html',''
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> exit(-1);</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> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">/** @brief The main function.*/</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="mcmc__progression_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627"> 32</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"><a class="line" href="mcmc__progression_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627"> 32</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="test__suite_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a>(<span class="keywordtype">int</span> argc, <span class="keywordtype">char</span> **argv)</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>{</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Command options</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">struct</span> option long_options[] = {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">struct </span>option long_options[] = {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {<span class="stringliteral">&quot;help&quot;</span>, 0, 0, 0}, {NULL, 0, NULL, 0}};</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">int</span> option_index = -1;</div>
@@ -152,17 +139,17 @@ $(document).ready(function(){initNavTree('mcmc__progression_8cpp_source.html',''
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordflow">switch</span> (option_index) {</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordflow">case</span> 0: <span class="comment">// Not a mistake. This just goes to the default.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> usage(argv[0]);</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <a class="code hl_function" href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a>(argv[0]);</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> }</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">break</span>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">case</span> <span class="stringliteral">&#39;h&#39;</span>:</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> <span class="keywordflow">case</span> <span class="charliteral">&#39;h&#39;</span>:</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">default</span>:</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> usage(argv[0]);</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> <a class="code hl_function" href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a>(argv[0]);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> }</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> <span class="comment">// Check that the number of arguments is at least 6.</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keywordflow">if</span> (argc &lt; 6) {</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> usage(argv[0]);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_function" href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a>(argv[0]);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</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">bool</span> ordered = <span class="keyword">false</span>;</div>
@@ -182,7 +169,7 @@ $(document).ready(function(){initNavTree('mcmc__progression_8cpp_source.html',''
<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"> 80</span> <span class="keywordflow">if</span> (ordered) {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <a class="code hl_define" href="utils_8hpp.html#aecc1f7a8a2493b9e021e5bff76a00a5b">DEBUG</a>(<span class="stringliteral">&quot;Hello&quot;</span>);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> montecarlo<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">::</a><a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">progression</a><a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">(</a>temp<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">,</a> L<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">,</a> cycles<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">,</a> 1<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">,</a> outfile<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">,</a> burn_in_time<a class="code hl_function" href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">)</a>;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> montecarlo::progression(temp, L, cycles, 1, outfile, burn_in_time);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> }</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordflow">else</span> {</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> montecarlo::progression(temp, L, cycles, outfile, burn_in_time);</div>
@@ -192,9 +179,11 @@ $(document).ready(function(){initNavTree('mcmc__progression_8cpp_source.html',''
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> std::cout &lt;&lt; <span class="stringliteral">&quot;Time: &quot;</span> &lt;&lt; t1 - t0 &lt;&lt; <span class="stringliteral">&quot; seconds\n&quot;</span>;</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>}</div>
<div class="ttc" id="amain_8cpp_html_a3c04138a5bfe5d72780bb7e82a18e627"><div class="ttname"><a href="main_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a></div><div class="ttdeci">int main(int argc, char **argv)</div><div class="ttdoc">The main function.</div><div class="ttdef"><b>Definition:</b> <a href="main_8cpp_source.html#l00125">main.cpp:125</a></div></div>
<div class="ttc" id="amain_8cpp_html_ac907e18135856c90366aaa599a9e10b1"><div class="ttname"><a href="main_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a></div><div class="ttdeci">void usage(std::string filename)</div><div class="ttdoc">A function that displays how to use the program and quits.</div><div class="ttdef"><b>Definition:</b> <a href="main_8cpp_source.html#l00110">main.cpp:110</a></div></div>
<div class="ttc" id="amonte__carlo_8hpp_html_a1549fc386bd3cdd1cdbe0261b9dd8415"><div class="ttname"><a href="monte__carlo_8hpp.html#a1549fc386bd3cdd1cdbe0261b9dd8415">montecarlo::progression</a></div><div class="ttdeci">void progression(double T, int L, int cycles, int value, const std::string filename, int burn_in_time=BURN_IN_TIME)</div><div class="ttdoc">Write the expected values for each Monte Carlo cycles to file.</div><div class="ttdef"><b>Definition:</b> <a href="monte__carlo_8cpp_source.html#l00046">monte_carlo.cpp:46</a></div></div>
<div class="ttc" id="adata__type_8hpp_html"><div class="ttname"><a href="data__type_8hpp.html">data_type.hpp</a></div><div class="ttdoc">Header for the data_t type.</div></div>
<div class="ttc" id="amcmc__progression_8cpp_html_ac907e18135856c90366aaa599a9e10b1"><div class="ttname"><a href="mcmc__progression_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a></div><div class="ttdeci">void usage(std::string filename)</div><div class="ttdoc">A function that displays how to use the program and quits.</div><div class="ttdef"><b>Definition:</b> <a href="mcmc__progression_8cpp_source.html#l00022">mcmc_progression.cpp:22</a></div></div>
<div class="ttc" id="amonte__carlo_8hpp_html"><div class="ttname"><a href="monte__carlo_8hpp.html">monte_carlo.hpp</a></div><div class="ttdoc">Functions for Monte Carlo simulations.</div></div>
<div class="ttc" id="atest__suite_8cpp_html_ae66f6b31b5ad750f1fe042a706a4e3d4"><div class="ttname"><a href="test__suite_8cpp.html#ae66f6b31b5ad750f1fe042a706a4e3d4">main</a></div><div class="ttdeci">int main()</div><div class="ttdoc">The main function.</div><div class="ttdef"><b>Definition:</b> <a href="test__suite_8cpp_source.html#l00110">test_suite.cpp:110</a></div></div>
<div class="ttc" id="autils_8hpp_html"><div class="ttname"><a href="utils_8hpp.html">utils.hpp</a></div><div class="ttdoc">Function prototypes and macros that are useful.</div></div>
<div class="ttc" id="autils_8hpp_html_aecc1f7a8a2493b9e021e5bff76a00a5b"><div class="ttname"><a href="utils_8hpp.html#aecc1f7a8a2493b9e021e5bff76a00a5b">DEBUG</a></div><div class="ttdeci">#define DEBUG(msg)</div><div class="ttdoc">Writes a debug message.</div><div class="ttdef"><b>Definition:</b> <a href="utils_8hpp_source.html#l00039">utils.hpp:39</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->