deploy: AutoPas/AutoPas@0d13475

doxygen_documentation_md-flexible/git-master/RegularGridDecomposition_8cpp__incl.md5

@@ -1 +1 @@
-c607f7190248562d024e9b461bc3a6f7
+b65445b515be9d8eefdce6a22b2d20ff

doxygen_documentation_md-flexible/git-master/RegularGridDecomposition_8h_source.html

@@ -257,17 +257,17 @@
 <div class="ttc" id="aclassRegularGridDecomposition_html"><div class="ttname"><a href="classRegularGridDecomposition.html">RegularGridDecomposition</a></div><div class="ttdoc">This class can be used as a domain decomposition which divides the domain in equal sized rectangular ...</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:30</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a029156bc14ca591df219eb214b8dd443"><div class="ttname"><a href="classRegularGridDecomposition.html#a029156bc14ca591df219eb214b8dd443">RegularGridDecomposition::getGlobalBoxMax</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getGlobalBoxMax() const override</div><div class="ttdoc">Returns the maximum coordinates of global domain.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:69</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a395d343d2af97f31c9797a96a1b2674c"><div class="ttname"><a href="classRegularGridDecomposition.html#a395d343d2af97f31c9797a96a1b2674c">RegularGridDecomposition::reflectParticlesAtBoundaries</a></div><div class="ttdeci">void reflectParticlesAtBoundaries(AutoPasType &amp;autoPasContainer, ParticlePropertiesLibraryType &amp;PPL)</div><div class="ttdoc">Reflects particles within a reflective skin along the inside of a boundary.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:299</div></div>
-<div class="ttc" id="aclassRegularGridDecomposition_html_a435c2e43d49ae892c2e9d40d1c8e9b7f"><div class="ttname"><a href="classRegularGridDecomposition.html#a435c2e43d49ae892c2e9d40d1c8e9b7f">RegularGridDecomposition::exchangeHaloParticles</a></div><div class="ttdeci">void exchangeHaloParticles(AutoPasType &amp;autoPasContainer)</div><div class="ttdoc">Exchanges halo particles with all neighbors of the provided AutoPasContainer.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:163</div></div>
+<div class="ttc" id="aclassRegularGridDecomposition_html_a435c2e43d49ae892c2e9d40d1c8e9b7f"><div class="ttname"><a href="classRegularGridDecomposition.html#a435c2e43d49ae892c2e9d40d1c8e9b7f">RegularGridDecomposition::exchangeHaloParticles</a></div><div class="ttdeci">void exchangeHaloParticles(AutoPasType &amp;autoPasContainer)</div><div class="ttdoc">Exchanges halo particles with all neighbors of the provided AutoPasContainer.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:164</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a4a45086f0205b295eead78073337229e"><div class="ttname"><a href="classRegularGridDecomposition.html#a4a45086f0205b295eead78073337229e">RegularGridDecomposition::getDomainId</a></div><div class="ttdeci">const std::array&lt; int, 3 &gt; &amp; getDomainId() const</div><div class="ttdoc">Returns the current processes domain id.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:99</div></div>
-<div class="ttc" id="aclassRegularGridDecomposition_html_a5365f723981b2f8c7f01ff13d14cf012"><div class="ttname"><a href="classRegularGridDecomposition.html#a5365f723981b2f8c7f01ff13d14cf012">RegularGridDecomposition::isInsideLocalDomain</a></div><div class="ttdeci">bool isInsideLocalDomain(const std::array&lt; double, 3 &gt; &amp;coordinates) const override</div><div class="ttdoc">Checks if the provided coordinates are located in the local domain.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:155</div></div>
-<div class="ttc" id="aclassRegularGridDecomposition_html_a5b2af0ed91f75cd0893c761cb3245638"><div class="ttname"><a href="classRegularGridDecomposition.html#a5b2af0ed91f75cd0893c761cb3245638">RegularGridDecomposition::getNumberOfSubdomains</a></div><div class="ttdeci">int getNumberOfSubdomains() const</div><div class="ttdoc">Returns the number of subdomains in the simulation.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:104</div></div>
+<div class="ttc" id="aclassRegularGridDecomposition_html_a5365f723981b2f8c7f01ff13d14cf012"><div class="ttname"><a href="classRegularGridDecomposition.html#a5365f723981b2f8c7f01ff13d14cf012">RegularGridDecomposition::isInsideLocalDomain</a></div><div class="ttdeci">bool isInsideLocalDomain(const std::array&lt; double, 3 &gt; &amp;coordinates) const override</div><div class="ttdoc">Checks if the provided coordinates are located in the local domain.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:156</div></div>
+<div class="ttc" id="aclassRegularGridDecomposition_html_a5b2af0ed91f75cd0893c761cb3245638"><div class="ttname"><a href="classRegularGridDecomposition.html#a5b2af0ed91f75cd0893c761cb3245638">RegularGridDecomposition::getNumberOfSubdomains</a></div><div class="ttdeci">int getNumberOfSubdomains() const</div><div class="ttdoc">Returns the number of subdomains in the simulation.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:105</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a5c321d3ea9bf5a718b71546f84d0c3b4"><div class="ttname"><a href="classRegularGridDecomposition.html#a5c321d3ea9bf5a718b71546f84d0c3b4">RegularGridDecomposition::getLocalBoxMax</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getLocalBoxMax() const override</div><div class="ttdoc">Returns the maximum coordinates of local domain.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:81</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a64f294d0d3542ab2855550aa6f3c5024"><div class="ttname"><a href="classRegularGridDecomposition.html#a64f294d0d3542ab2855550aa6f3c5024">RegularGridDecomposition::getSubdomainCount</a></div><div class="ttdeci">int getSubdomainCount() const</div><div class="ttdoc">Returns the numnber of subdomains in the decomposition.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:93</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a7bc4e34bb15955223e09597cfa0b1d9f"><div class="ttname"><a href="classRegularGridDecomposition.html#a7bc4e34bb15955223e09597cfa0b1d9f">RegularGridDecomposition::getLocalBoxMin</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getLocalBoxMin() const override</div><div class="ttdoc">Returns the minimum coordinates of local domain.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:75</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_a994956d11a8db57fa3c3fc5b85f799b5"><div class="ttname"><a href="classRegularGridDecomposition.html#a994956d11a8db57fa3c3fc5b85f799b5">RegularGridDecomposition::getDomainIndex</a></div><div class="ttdeci">int getDomainIndex() const override</div><div class="ttdoc">Returns the index of the local domain in the global domain context.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:57</div></div>
-<div class="ttc" id="aclassRegularGridDecomposition_html_a9b6d7afe1cf9bbb2f620f5d8959022f8"><div class="ttname"><a href="classRegularGridDecomposition.html#a9b6d7afe1cf9bbb2f620f5d8959022f8">RegularGridDecomposition::getExtentOfSubdomain</a></div><div class="ttdeci">std::array&lt; int, 6 &gt; getExtentOfSubdomain(int subdomainIndex) const</div><div class="ttdoc">Calculates and returns the extent of the subdomain with inde subdomainIndex.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:159</div></div>
-<div class="ttc" id="aclassRegularGridDecomposition_html_a9d4d5d120ebe13c0e63a6edb95a1fcac"><div class="ttname"><a href="classRegularGridDecomposition.html#a9d4d5d120ebe13c0e63a6edb95a1fcac">RegularGridDecomposition::update</a></div><div class="ttdeci">void update(const double &amp;work) override</div><div class="ttdoc">Used to update the domain to the current topology.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:84</div></div>
-<div class="ttc" id="aclassRegularGridDecomposition_html_aacc9b702339dd1e40f6ad1a6706592fa"><div class="ttname"><a href="classRegularGridDecomposition.html#aacc9b702339dd1e40f6ad1a6706592fa">RegularGridDecomposition::exchangeMigratingParticles</a></div><div class="ttdeci">void exchangeMigratingParticles(AutoPasType &amp;autoPasContainer, std::vector&lt; ParticleType &gt; &amp;emigrants)</div><div class="ttdoc">Exchanges migrating particles with all neighbors of the provided AutoPasContainer.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:233</div></div>
+<div class="ttc" id="aclassRegularGridDecomposition_html_a9b6d7afe1cf9bbb2f620f5d8959022f8"><div class="ttname"><a href="classRegularGridDecomposition.html#a9b6d7afe1cf9bbb2f620f5d8959022f8">RegularGridDecomposition::getExtentOfSubdomain</a></div><div class="ttdeci">std::array&lt; int, 6 &gt; getExtentOfSubdomain(int subdomainIndex) const</div><div class="ttdoc">Calculates and returns the extent of the subdomain with inde subdomainIndex.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:160</div></div>
+<div class="ttc" id="aclassRegularGridDecomposition_html_a9d4d5d120ebe13c0e63a6edb95a1fcac"><div class="ttname"><a href="classRegularGridDecomposition.html#a9d4d5d120ebe13c0e63a6edb95a1fcac">RegularGridDecomposition::update</a></div><div class="ttdeci">void update(const double &amp;work) override</div><div class="ttdoc">Used to update the domain to the current topology.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:85</div></div>
+<div class="ttc" id="aclassRegularGridDecomposition_html_aacc9b702339dd1e40f6ad1a6706592fa"><div class="ttname"><a href="classRegularGridDecomposition.html#aacc9b702339dd1e40f6ad1a6706592fa">RegularGridDecomposition::exchangeMigratingParticles</a></div><div class="ttdeci">void exchangeMigratingParticles(AutoPasType &amp;autoPasContainer, std::vector&lt; ParticleType &gt; &amp;emigrants)</div><div class="ttdoc">Exchanges migrating particles with all neighbors of the provided AutoPasContainer.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.cpp:234</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_ab4b279161c670fca089463c4b96955cb"><div class="ttname"><a href="classRegularGridDecomposition.html#ab4b279161c670fca089463c4b96955cb">RegularGridDecomposition::getDecomposition</a></div><div class="ttdeci">const std::array&lt; int, 3 &gt; &amp; getDecomposition() const</div><div class="ttdoc">Returns the number of domains in each dimension.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:87</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_abe34b2dbf203faeb1f5e332b1cc8c57e"><div class="ttname"><a href="classRegularGridDecomposition.html#abe34b2dbf203faeb1f5e332b1cc8c57e">RegularGridDecomposition::~RegularGridDecomposition</a></div><div class="ttdeci">~RegularGridDecomposition() override</div><div class="ttdoc">Destructor.</div></div>
 <div class="ttc" id="aclassRegularGridDecomposition_html_acf4f02949c46016b252187db0f2f3e83"><div class="ttname"><a href="classRegularGridDecomposition.html#acf4f02949c46016b252187db0f2f3e83">RegularGridDecomposition::getGlobalBoxMin</a></div><div class="ttdeci">const std::array&lt; double, 3 &gt; &amp; getGlobalBoxMin() const override</div><div class="ttdoc">Returns the minimum coordinates of global domain.</div><div class="ttdef"><b>Definition:</b> RegularGridDecomposition.h:63</div></div>