FYS3150/Project-4
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1762fc87ad
Project-4/docs/monte__carlo_8cpp.html
Cory 4086e30f6f
Add docs
2023-11-21 11:27:34 +01:00

484 lines
22 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>2 Dimensional Ising Model: src/monte_carlo.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">2 Dimensional Ising Model
</div>
<div id="projectbrief">Simulate the change in energy and magnetization in a ferro magnet</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('monte__carlo_8cpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">monte_carlo.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Implementation of the monte carlo functions.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="monte__carlo_8hpp_source.html">monte_carlo.hpp</a>&quot;</code><br />
<code>#include &lt;cmath&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
</div>
<p><a href="monte__carlo_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:ac97d0de27f2f0d50fc6ecf3a79f32826"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="monte__carlo_8cpp.html#ac97d0de27f2f0d50fc6ecf3a79f32826">monte_carlo_progression</a> (double T, int L, int cycles, const std::string filename)</td></tr>
<tr class="memdesc:ac97d0de27f2f0d50fc6ecf3a79f32826"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the expected values for each Monte Carlo cycles to file. <br /></td></tr>
<tr class="separator:ac97d0de27f2f0d50fc6ecf3a79f32826"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a89ddd777796c65eb2b289af11fc0ce09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="monte__carlo_8cpp.html#a89ddd777796c65eb2b289af11fc0ce09">monte_carlo_progression</a> (double T, int L, int cycles, int value, const std::string filename)</td></tr>
<tr class="memdesc:a89ddd777796c65eb2b289af11fc0ce09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Write the expected values for each Monte Carlo cycles to file. <br /></td></tr>
<tr class="separator:a89ddd777796c65eb2b289af11fc0ce09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962f704ab35208bf6541eb3b707a9559"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="monte__carlo_8cpp.html#a962f704ab35208bf6541eb3b707a9559">pd_estimate</a> (double T, int L, int cycles, const std::string filename)</td></tr>
<tr class="memdesc:a962f704ab35208bf6541eb3b707a9559"><td class="mdescLeft">&#160;</td><td class="mdescRight">Estimate the probability distribution for the energy. <br /></td></tr>
<tr class="separator:a962f704ab35208bf6541eb3b707a9559"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8f8d4c5e032ed8565a3ac518b32c6aed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="monte__carlo_8cpp.html#a8f8d4c5e032ed8565a3ac518b32c6aed">monte_carlo_serial</a> (int L, double T, int cycles)</td></tr>
<tr class="memdesc:a8f8d4c5e032ed8565a3ac518b32c6aed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the Metropolis algorithm for a certain amount of Monte Carlo cycles. <br /></td></tr>
<tr class="separator:a8f8d4c5e032ed8565a3ac518b32c6aed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acc34e2049a5030874f6f548f3adab958"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classdata__t.html">data_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="monte__carlo_8cpp.html#acc34e2049a5030874f6f548f3adab958">monte_carlo_parallel</a> (int L, double T, int cycles)</td></tr>
<tr class="memdesc:acc34e2049a5030874f6f548f3adab958"><td class="mdescLeft">&#160;</td><td class="mdescRight">Execute the Metropolis algorithm for a certain amount of Monte Carlo cycles in parallel. <br /></td></tr>
<tr class="separator:acc34e2049a5030874f6f548f3adab958"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7df22ace588b4d229d1029ce766d0009"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="monte__carlo_8cpp.html#a7df22ace588b4d229d1029ce766d0009">phase_transition</a> (int L, double start, double end, int points, std::function&lt; <a class="el" href="classdata__t.html">data_t</a>(int, double, int)&gt; monte_carlo, std::string outfile)</td></tr>
<tr class="memdesc:a7df22ace588b4d229d1029ce766d0009"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform the MCMC algorithm using a range of temperatures. <br /></td></tr>
<tr class="separator:a7df22ace588b4d229d1029ce766d0009"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Implementation of the monte carlo functions. </p>
<dl class="section author"><dt>Author</dt><dd>Cory Alexander Balaton (coryab) </dd>
<dd>
Janita Ovidie Sandtrøen Willumsen (janitaws)</dd></dl>
<dl class="section version"><dt>Version</dt><dd>1.0</dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000011">Bug:</a></b></dt><dd>No known bugs </dd></dl>
<p class="definition">Definition in file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="acc34e2049a5030874f6f548f3adab958" name="acc34e2049a5030874f6f548f3adab958"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acc34e2049a5030874f6f548f3adab958">&#9670;&#160;</a></span>monte_carlo_parallel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdata__t.html">data_t</a> monte_carlo_parallel </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cycles</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute the Metropolis algorithm for a certain amount of Monte Carlo cycles in parallel. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">L</td><td>The size of the lattice </td></tr>
<tr><td class="paramname">T</td><td>The Temperature for the Ising model </td></tr>
<tr><td class="paramname">cycles</td><td>The amount of Monte Carlo cycles to do</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="monte__carlo_8cpp_source.html#l00128">128</a> of file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div>
</div>
<a id="ac97d0de27f2f0d50fc6ecf3a79f32826" name="ac97d0de27f2f0d50fc6ecf3a79f32826"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac97d0de27f2f0d50fc6ecf3a79f32826">&#9670;&#160;</a></span>monte_carlo_progression() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void monte_carlo_progression </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cycles</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>filename</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the expected values for each Monte Carlo cycles to file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">T</td><td>Temperature </td></tr>
<tr><td class="paramname">L</td><td>The size of the lattice </td></tr>
<tr><td class="paramname">cycles</td><td>The amount of Monte Carlo cycles to do </td></tr>
<tr><td class="paramname">filename</td><td>The file to write to </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="monte__carlo_8cpp_source.html#l00017">17</a> of file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div>
</div>
<a id="a89ddd777796c65eb2b289af11fc0ce09" name="a89ddd777796c65eb2b289af11fc0ce09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a89ddd777796c65eb2b289af11fc0ce09">&#9670;&#160;</a></span>monte_carlo_progression() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void monte_carlo_progression </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cycles</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>value</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>filename</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the expected values for each Monte Carlo cycles to file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">T</td><td>Temperature </td></tr>
<tr><td class="paramname">L</td><td>The size of the lattice </td></tr>
<tr><td class="paramname">cycles</td><td>The amount of Monte Carlo cycles to do </td></tr>
<tr><td class="paramname">value</td><td>The value to set the elements in the lattice </td></tr>
<tr><td class="paramname">filename</td><td>The file to write to </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="monte__carlo_8cpp_source.html#l00051">51</a> of file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div>
</div>
<a id="a8f8d4c5e032ed8565a3ac518b32c6aed" name="a8f8d4c5e032ed8565a3ac518b32c6aed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8f8d4c5e032ed8565a3ac518b32c6aed">&#9670;&#160;</a></span>monte_carlo_serial()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdata__t.html">data_t</a> monte_carlo_serial </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cycles</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Execute the Metropolis algorithm for a certain amount of Monte Carlo cycles. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">L</td><td>The size of the lattice </td></tr>
<tr><td class="paramname">T</td><td>The Temperature for the Ising model </td></tr>
<tr><td class="paramname">cycles</td><td>The amount of Monte Carlo cycles to do</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classdata__t.html">data_t</a> </dd></dl>
<p class="definition">Definition at line <a class="el" href="monte__carlo_8cpp_source.html#l00111">111</a> of file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div>
</div>
<a id="a962f704ab35208bf6541eb3b707a9559" name="a962f704ab35208bf6541eb3b707a9559"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962f704ab35208bf6541eb3b707a9559">&#9670;&#160;</a></span>pd_estimate()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pd_estimate </td>
<td>(</td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>cycles</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string&#160;</td>
<td class="paramname"><em>filename</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Estimate the probability distribution for the energy. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">T</td><td>The temperature of the Ising model </td></tr>
<tr><td class="paramname">L</td><td>The size of the lattice </td></tr>
<tr><td class="paramname">cycles</td><td>The amount of Monte Carlo cycles to do </td></tr>
<tr><td class="paramname">filename</td><td>The file to write to </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="monte__carlo_8cpp_source.html#l00085">85</a> of file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div>
</div>
<a id="a7df22ace588b4d229d1029ce766d0009" name="a7df22ace588b4d229d1029ce766d0009"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7df22ace588b4d229d1029ce766d0009">&#9670;&#160;</a></span>phase_transition()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void phase_transition </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>L</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>start_T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double&#160;</td>
<td class="paramname"><em>end_T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>points_T</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::function&lt; <a class="el" href="classdata__t.html">data_t</a>(int, double, int)&gt;&#160;</td>
<td class="paramname"><em>monte_carlo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>outfile</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform the MCMC algorithm using a range of temperatures. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">L</td><td>The size of the lattice </td></tr>
<tr><td class="paramname">start_T</td><td>The start temperature </td></tr>
<tr><td class="paramname">end_T</td><td>The end temperature </td></tr>
<tr><td class="paramname">point_T</td><td>The amount of point to measure </td></tr>
<tr><td class="paramname">monte_carlo</td><td>Which Monte Carlo implementation to use </td></tr>
<tr><td class="paramname">outfile</td><td>The file to write the data to </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="monte__carlo_8cpp_source.html#l00156">156</a> of file <a class="el" href="monte__carlo_8cpp_source.html">monte_carlo.cpp</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="monte__carlo_8cpp.html">monte_carlo.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink