Project-4/docs/classIsingModel.html
2023-11-21 11:27:34 +01:00

739 lines
35 KiB
HTML

<!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: IsingModel Class 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('classIsingModel.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="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classIsingModel-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">IsingModel Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>The Ising model in 2 dimensions.
<a href="classIsingModel.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4a39ee7fbfbbf566f75bc28900ca9ea5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a4a39ee7fbfbbf566f75bc28900ca9ea5">IsingModel</a> (int <a class="el" href="classIsingModel.html#a2b8ac43baefeb386186266d5aa4de348">L</a>, double <a class="el" href="classIsingModel.html#a20fc4c0c99d8a119f70a1614784d4e5c">T</a>)</td></tr>
<tr class="memdesc:a4a39ee7fbfbbf566f75bc28900ca9ea5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the Ising model. <br /></td></tr>
<tr class="separator:a4a39ee7fbfbbf566f75bc28900ca9ea5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a46c9446e94854452f715d307c77c1c15"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a46c9446e94854452f715d307c77c1c15">IsingModel</a> (int <a class="el" href="classIsingModel.html#a2b8ac43baefeb386186266d5aa4de348">L</a>, double <a class="el" href="classIsingModel.html#a20fc4c0c99d8a119f70a1614784d4e5c">T</a>, int val)</td></tr>
<tr class="memdesc:a46c9446e94854452f715d307c77c1c15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for the Ising model. <br /></td></tr>
<tr class="separator:a46c9446e94854452f715d307c77c1c15"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56559d68dc9aaff1976d84b157f43488"><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="classIsingModel.html#a56559d68dc9aaff1976d84b157f43488">Metropolis</a> ()</td></tr>
<tr class="memdesc:a56559d68dc9aaff1976d84b157f43488"><td class="mdescLeft">&#160;</td><td class="mdescRight">The Metropolis algorithm. <br /></td></tr>
<tr class="separator:a56559d68dc9aaff1976d84b157f43488"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaa0787d964b004a17869811a5e947ff5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aaa0787d964b004a17869811a5e947ff5">get_E</a> ()</td></tr>
<tr class="memdesc:aaa0787d964b004a17869811a5e947ff5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current energy. <br /></td></tr>
<tr class="separator:aaa0787d964b004a17869811a5e947ff5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5701496e6483bc4668c486d6d3af625"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aa5701496e6483bc4668c486d6d3af625">get_M</a> ()</td></tr>
<tr class="memdesc:aa5701496e6483bc4668c486d6d3af625"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current magnetization. <br /></td></tr>
<tr class="separator:aa5701496e6483bc4668c486d6d3af625"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a34a4710949b4a70f3e37ca223aefcf8a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a34a4710949b4a70f3e37ca223aefcf8a">initialize_lattice</a> ()</td></tr>
<tr class="memdesc:a34a4710949b4a70f3e37ca223aefcf8a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the lattice with a random distribution of 1s and -1s. <br /></td></tr>
<tr class="separator:a34a4710949b4a70f3e37ca223aefcf8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6776109105051597c275670dabd0054a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a6776109105051597c275670dabd0054a">initialize_neighbors</a> ()</td></tr>
<tr class="memdesc:a6776109105051597c275670dabd0054a"><td class="mdescLeft">&#160;</td><td class="mdescRight">initialize the neighbors matrix. <br /></td></tr>
<tr class="separator:a6776109105051597c275670dabd0054a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aff9a1201933fd5408845a1447e4895b4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#aff9a1201933fd5408845a1447e4895b4">initialize_energy_diff</a> ()</td></tr>
<tr class="memdesc:aff9a1201933fd5408845a1447e4895b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the hashmap with the correct values. <br /></td></tr>
<tr class="separator:aff9a1201933fd5408845a1447e4895b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a926cf4964d190d2ce23e5a17201787a4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a926cf4964d190d2ce23e5a17201787a4">initialize_magnetization</a> ()</td></tr>
<tr class="memdesc:a926cf4964d190d2ce23e5a17201787a4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the magnetization. <br /></td></tr>
<tr class="separator:a926cf4964d190d2ce23e5a17201787a4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a59fced38c695e2fa647f53be81b9d2a1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a59fced38c695e2fa647f53be81b9d2a1">initialize_energy</a> ()</td></tr>
<tr class="memdesc:a59fced38c695e2fa647f53be81b9d2a1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the energy. <br /></td></tr>
<tr class="separator:a59fced38c695e2fa647f53be81b9d2a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf281f6f5ed02911ca6ab07004449864"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#acf281f6f5ed02911ca6ab07004449864">IsingModel</a> ()</td></tr>
<tr class="memdesc:acf281f6f5ed02911ca6ab07004449864"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor used for testing. <br /></td></tr>
<tr class="separator:acf281f6f5ed02911ca6ab07004449864"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a2c3c76c79717c968d7c227c58b46df41"><td class="memItemLeft" align="right" valign="top">arma::Mat&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a2c3c76c79717c968d7c227c58b46df41">lattice</a></td></tr>
<tr class="memdesc:a2c3c76c79717c968d7c227c58b46df41"><td class="mdescLeft">&#160;</td><td class="mdescRight">\( L \times L \) matrix where element \( x \in {-1, 1}\). <br /></td></tr>
<tr class="separator:a2c3c76c79717c968d7c227c58b46df41"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94093aaf30facca62737f2ac381fdbcd"><td class="memItemLeft" align="right" valign="top">arma::Mat&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a94093aaf30facca62737f2ac381fdbcd">neighbors</a></td></tr>
<tr class="memdesc:a94093aaf30facca62737f2ac381fdbcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">\( L \times 2 \) matrix with the neighbors of each element \( x_i \). <br /></td></tr>
<tr class="separator:a94093aaf30facca62737f2ac381fdbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1a4ceb1bb2593dbd20c51ed04100cbcd"><td class="memItemLeft" align="right" valign="top">std::unordered_map&lt; int, double &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a1a4ceb1bb2593dbd20c51ed04100cbcd">energy_diff</a></td></tr>
<tr class="memdesc:a1a4ceb1bb2593dbd20c51ed04100cbcd"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash map containing all possible energy changes. <br /></td></tr>
<tr class="separator:a1a4ceb1bb2593dbd20c51ed04100cbcd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20fc4c0c99d8a119f70a1614784d4e5c"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a20fc4c0c99d8a119f70a1614784d4e5c">T</a></td></tr>
<tr class="memdesc:a20fc4c0c99d8a119f70a1614784d4e5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The temperature of the model. <br /></td></tr>
<tr class="separator:a20fc4c0c99d8a119f70a1614784d4e5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2b8ac43baefeb386186266d5aa4de348"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a2b8ac43baefeb386186266d5aa4de348">L</a></td></tr>
<tr class="memdesc:a2b8ac43baefeb386186266d5aa4de348"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of the lattice. <br /></td></tr>
<tr class="separator:a2b8ac43baefeb386186266d5aa4de348"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9f872ca2054992161d53306119979dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#ae9f872ca2054992161d53306119979dd">E</a></td></tr>
<tr class="memdesc:ae9f872ca2054992161d53306119979dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current energy state. unit: \( J \). <br /></td></tr>
<tr class="separator:ae9f872ca2054992161d53306119979dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d373a61baca6b0faa607bb12d82cc47"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a0d373a61baca6b0faa607bb12d82cc47">M</a></td></tr>
<tr class="memdesc:a0d373a61baca6b0faa607bb12d82cc47"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current magnetic strength. unit: Unitless. <br /></td></tr>
<tr class="separator:a0d373a61baca6b0faa607bb12d82cc47"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a2b1cf104e0bda1fce78ed366e1ec7287"><td class="memItemLeft" align="right" valign="top">class&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classIsingModel.html#a2b1cf104e0bda1fce78ed366e1ec7287">IsingModelTest</a></td></tr>
<tr class="separator:a2b1cf104e0bda1fce78ed366e1ec7287"><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>The Ising model in 2 dimensions. </p>
<p>None of the methods are parallelized, as there is very little benefit in doing so. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00037">37</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acf281f6f5ed02911ca6ab07004449864" name="acf281f6f5ed02911ca6ab07004449864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf281f6f5ed02911ca6ab07004449864">&#9670;&#160;</a></span>IsingModel() <span class="overload">[1/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">IsingModel::IsingModel </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor used for testing. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00017">17</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a4a39ee7fbfbbf566f75bc28900ca9ea5" name="a4a39ee7fbfbbf566f75bc28900ca9ea5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4a39ee7fbfbbf566f75bc28900ca9ea5">&#9670;&#160;</a></span>IsingModel() <span class="overload">[2/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsingModel::IsingModel </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>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the Ising model. </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 system. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00021">21</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a46c9446e94854452f715d307c77c1c15" name="a46c9446e94854452f715d307c77c1c15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a46c9446e94854452f715d307c77c1c15">&#9670;&#160;</a></span>IsingModel() <span class="overload">[3/3]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">IsingModel::IsingModel </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>val</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor for the Ising model. </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 system. </td></tr>
<tr><td class="paramname">val</td><td>The value to set for all spins. </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00032">32</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aaa0787d964b004a17869811a5e947ff5" name="aaa0787d964b004a17869811a5e947ff5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa0787d964b004a17869811a5e947ff5">&#9670;&#160;</a></span>get_E()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IsingModel::get_E </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current energy. </p>
<dl class="section return"><dt>Returns</dt><dd>double </dd></dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00135">135</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="aa5701496e6483bc4668c486d6d3af625" name="aa5701496e6483bc4668c486d6d3af625"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5701496e6483bc4668c486d6d3af625">&#9670;&#160;</a></span>get_M()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int IsingModel::get_M </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current magnetization. </p>
<dl class="section return"><dt>Returns</dt><dd>double </dd></dl>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00140">140</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a59fced38c695e2fa647f53be81b9d2a1" name="a59fced38c695e2fa647f53be81b9d2a1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a59fced38c695e2fa647f53be81b9d2a1">&#9670;&#160;</a></span>initialize_energy()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_energy </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the energy. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00082">82</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="aff9a1201933fd5408845a1447e4895b4" name="aff9a1201933fd5408845a1447e4895b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aff9a1201933fd5408845a1447e4895b4">&#9670;&#160;</a></span>initialize_energy_diff()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_energy_diff </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the hashmap with the correct values. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00067">67</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a34a4710949b4a70f3e37ca223aefcf8a" name="a34a4710949b4a70f3e37ca223aefcf8a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a34a4710949b4a70f3e37ca223aefcf8a">&#9670;&#160;</a></span>initialize_lattice()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_lattice </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the lattice with a random distribution of 1s and -1s. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00044">44</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a926cf4964d190d2ce23e5a17201787a4" name="a926cf4964d190d2ce23e5a17201787a4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a926cf4964d190d2ce23e5a17201787a4">&#9670;&#160;</a></span>initialize_magnetization()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_magnetization </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the magnetization. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00074">74</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a6776109105051597c275670dabd0054a" name="a6776109105051597c275670dabd0054a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6776109105051597c275670dabd0054a">&#9670;&#160;</a></span>initialize_neighbors()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void IsingModel::initialize_neighbors </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>initialize the neighbors matrix. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00056">56</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<a id="a56559d68dc9aaff1976d84b157f43488" name="a56559d68dc9aaff1976d84b157f43488"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56559d68dc9aaff1976d84b157f43488">&#9670;&#160;</a></span>Metropolis()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classdata__t.html">data_t</a> IsingModel::Metropolis </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>The Metropolis algorithm. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8cpp_source.html#l00096">96</a> of file <a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a id="a2b1cf104e0bda1fce78ed366e1ec7287" name="a2b1cf104e0bda1fce78ed366e1ec7287"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b1cf104e0bda1fce78ed366e1ec7287">&#9670;&#160;</a></span>IsingModelTest</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="classIsingModelTest.html">IsingModelTest</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00039">39</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae9f872ca2054992161d53306119979dd" name="ae9f872ca2054992161d53306119979dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae9f872ca2054992161d53306119979dd">&#9670;&#160;</a></span>E</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int IsingModel::E</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current energy state. unit: \( J \). </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00068">68</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a1a4ceb1bb2593dbd20c51ed04100cbcd" name="a1a4ceb1bb2593dbd20c51ed04100cbcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a4ceb1bb2593dbd20c51ed04100cbcd">&#9670;&#160;</a></span>energy_diff</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::unordered_map&lt;int, double&gt; IsingModel::energy_diff</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A hash map containing all possible energy changes. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00056">56</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a2b8ac43baefeb386186266d5aa4de348" name="a2b8ac43baefeb386186266d5aa4de348"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2b8ac43baefeb386186266d5aa4de348">&#9670;&#160;</a></span>L</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int IsingModel::L</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the lattice. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00064">64</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a2c3c76c79717c968d7c227c58b46df41" name="a2c3c76c79717c968d7c227c58b46df41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c3c76c79717c968d7c227c58b46df41">&#9670;&#160;</a></span>lattice</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">arma::Mat&lt;int&gt; IsingModel::lattice</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>\( L \times L \) matrix where element \( x \in {-1, 1}\). </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00042">42</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a0d373a61baca6b0faa607bb12d82cc47" name="a0d373a61baca6b0faa607bb12d82cc47"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d373a61baca6b0faa607bb12d82cc47">&#9670;&#160;</a></span>M</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int IsingModel::M</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The current magnetic strength. unit: Unitless. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00072">72</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a94093aaf30facca62737f2ac381fdbcd" name="a94093aaf30facca62737f2ac381fdbcd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94093aaf30facca62737f2ac381fdbcd">&#9670;&#160;</a></span>neighbors</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">arma::Mat&lt;int&gt; IsingModel::neighbors</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>\( L \times 2 \) matrix with the neighbors of each element \( x_i \). </p>
<p>The reason why it's \( L \times 2 \) instead of \( L \times 2 \), is that we can see that we can use the same column for the left and upper neighbor, and we can use the same column for the right and lower neighbor. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00052">52</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<a id="a20fc4c0c99d8a119f70a1614784d4e5c" name="a20fc4c0c99d8a119f70a1614784d4e5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20fc4c0c99d8a119f70a1614784d4e5c">&#9670;&#160;</a></span>T</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">double IsingModel::T</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>The temperature of the model. </p>
<p class="definition">Definition at line <a class="el" href="IsingModel_8hpp_source.html#l00060">60</a> of file <a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="IsingModel_8hpp_source.html">IsingModel.hpp</a></li>
<li>src/<a class="el" href="IsingModel_8cpp_source.html">IsingModel.cpp</a></li>
</ul>
</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="classIsingModel.html">IsingModel</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>