Update docs

This commit is contained in:
2023-12-04 22:23:30 +01:00
parent d30c98aed2
commit d318491dfe
133 changed files with 7487 additions and 2047 deletions

View File

@@ -109,17 +109,17 @@ $(document).ready(function(){initNavTree('phase__transition__mpi_8cpp.html','');
<div class="textblock"><code>#include &quot;<a class="el" href="data__type_8hpp_source.html">data_type.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="monte__carlo_8hpp_source.html">monte_carlo.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="utils_8hpp_source.html">utils.hpp</a>&quot;</code><br />
<code>#include &lt;algorithm&gt;</code><br />
<code>#include &lt;fstream&gt;</code><br />
<code>#include &lt;iostream&gt;</code><br />
<code>#include &lt;iterator&gt;</code><br />
<code>#include &lt;getopt.h&gt;</code><br />
<code>#include &lt;mpi.h&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="phase__transition__mpi_8cpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ac907e18135856c90366aaa599a9e10b1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="phase__transition__mpi_8cpp.html#ac907e18135856c90366aaa599a9e10b1">usage</a> (std::string filename)</td></tr>
<tr class="memdesc:ac907e18135856c90366aaa599a9e10b1"><td class="mdescLeft">&#160;</td><td class="mdescRight">A function that displays how to use the program and quits. <br /></td></tr>
<tr class="separator:ac907e18135856c90366aaa599a9e10b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="phase__transition__mpi_8cpp.html#a3c04138a5bfe5d72780bb7e82a18e627">main</a> (int argc, char **argv)</td></tr>
<tr class="memdesc:a3c04138a5bfe5d72780bb7e82a18e627"><td class="mdescLeft">&#160;</td><td class="mdescRight">The main function. <br /></td></tr>
<tr class="separator:a3c04138a5bfe5d72780bb7e82a18e627"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -130,6 +130,7 @@ Functions</h2></td></tr>
<dd>
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0</dd></dl>
<p>This program takes in 4 arguments: the start temperature, the end temperature, the amount of temperature points to simulate, and the amount of monte carlo samples to collect, in that order.</p>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000012">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<p class="definition">Definition in file <a class="el" href="phase__transition__mpi_8cpp_source.html">phase_transition_mpi.cpp</a>.</p>
@@ -162,7 +163,29 @@ Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<p>The main function. </p>
<p class="definition">Definition at line <a class="el" href="phase__transition__mpi_8cpp_source.html#l00024">24</a> of file <a class="el" href="phase__transition__mpi_8cpp_source.html">phase_transition_mpi.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="phase__transition__mpi_8cpp_source.html#l00038">38</a> of file <a class="el" href="phase__transition__mpi_8cpp_source.html">phase_transition_mpi.cpp</a>.</p>
</div>
</div>
<a id="ac907e18135856c90366aaa599a9e10b1" name="ac907e18135856c90366aaa599a9e10b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac907e18135856c90366aaa599a9e10b1">&#9670;&#160;</a></span>usage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usage </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>filename</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A function that displays how to use the program and quits. </p>
<p class="definition">Definition at line <a class="el" href="phase__transition__mpi_8cpp_source.html#l00025">25</a> of file <a class="el" href="phase__transition__mpi_8cpp_source.html">phase_transition_mpi.cpp</a>.</p>
</div>
</div>