Documentation for 4aa06e7d26d35450b168a38573abdbc5ab4d2fb5

espressomd · Aug 9, 2023 · 5344069 · 5344069
1 parent 0a8771b
commit 5344069
Show file tree

Hide file tree

Showing 9,631 changed files with 3,996,445 additions and 0 deletions.
diff --git a/doc/_images/ccmake-example.png b/doc/_images/ccmake-example.png
diff --git a/doc/_images/conical_frustum.png b/doc/_images/conical_frustum.png
diff --git a/doc/_images/constraint-distance.png b/doc/_images/constraint-distance.png
diff --git a/doc/_images/constraint-force.png b/doc/_images/constraint-force.png
diff --git a/doc/_images/constraint-force_only_positive.png b/doc/_images/constraint-force_only_positive.png
diff --git a/doc/_images/correlator_scheme.png b/doc/_images/correlator_scheme.png
diff --git a/doc/_images/diamond.png b/doc/_images/diamond.png
diff --git a/doc/_images/dihedral-angle.pdf b/doc/_images/dihedral-angle.pdf
diff --git a/doc/_images/elc-errordist.pdf b/doc/_images/elc-errordist.pdf
diff --git a/doc/_images/inter_angle.png b/doc/_images/inter_angle.png
diff --git a/doc/_images/oif-arealocal.png b/doc/_images/oif-arealocal.png
diff --git a/doc/_images/oif-bending.png b/doc/_images/oif-bending.png
diff --git a/doc/_images/oif-stretching.png b/doc/_images/oif-stretching.png
diff --git a/doc/_images/oif-volcons.png b/doc/_images/oif-volcons.png
diff --git a/doc/_images/oif.png b/doc/_images/oif.png
diff --git a/doc/_images/oif1.png b/doc/_images/oif1.png
diff --git a/doc/_images/oif2.png b/doc/_images/oif2.png
diff --git a/doc/_images/oif3.png b/doc/_images/oif3.png
diff --git a/doc/_images/oifchannel.png b/doc/_images/oifchannel.png
diff --git a/doc/_images/oifcolored-triangles.png b/doc/_images/oifcolored-triangles.png
diff --git a/doc/_images/oifcylinder.png b/doc/_images/oifcylinder.png
diff --git a/doc/_images/oifrhomboid.png b/doc/_images/oifrhomboid.png
diff --git a/doc/_images/oifstretched-sphere.png b/doc/_images/oifstretched-sphere.png
diff --git a/doc/_images/oifvectordata.png b/doc/_images/oifvectordata.png
diff --git a/doc/_images/shape-conical_frustum.png b/doc/_images/shape-conical_frustum.png
diff --git a/doc/_images/shape-cylinder.png b/doc/_images/shape-cylinder.png
diff --git a/doc/_images/shape-ellipsoid.png b/doc/_images/shape-ellipsoid.png
diff --git a/doc/_images/shape-hollowconicalfrustum_central_angle.png b/doc/_images/shape-hollowconicalfrustum_central_angle.png
diff --git a/doc/_images/shape-simplepore.png b/doc/_images/shape-simplepore.png
diff --git a/doc/_images/shape-slitpore.png b/doc/_images/shape-slitpore.png
diff --git a/doc/_images/shape-sphere.png b/doc/_images/shape-sphere.png
diff --git a/doc/_images/shape-spherocylinder.png b/doc/_images/shape-spherocylinder.png
diff --git a/doc/_images/shape-torus.png b/doc/_images/shape-torus.png
diff --git a/doc/_images/shape-wall.png b/doc/_images/shape-wall.png
diff --git a/doc/_images/slitpore.png b/doc/_images/slitpore.png
diff --git a/doc/_images/vs-code-settings.png b/doc/_images/vs-code-settings.png
diff --git a/doc/_modules/espressomd/accumulators.html b/doc/_modules/espressomd/accumulators.html
diff --git a/doc/_modules/espressomd/actors.html b/doc/_modules/espressomd/actors.html
@@ -0,0 +1,171 @@
+
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>espressomd.actors &#8212; ESPResSo 4.3-dev documentation</title>
+    <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/blockquotes.css" />
+    <link rel="stylesheet" type="text/css" href="../../_static/custom.css" />
+    <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
+    <script src="../../_static/jquery.js"></script>
+    <script src="../../_static/underscore.js"></script>
+    <script src="../../_static/doctools.js"></script>
+    <script src="../../_static/toggleprompt.js"></script>
+    <link rel="index" title="Index" href="../../genindex.html" />
+    <link rel="search" title="Search" href="../../search.html" />
+
+  <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
+
+
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+
+  </head><body>
+
+
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+
+
+          <div class="body" role="main">
+
+  <h1>Source code for espressomd.actors</h1><div class="highlight"><pre>
+<span></span><span class="c1"># Copyright (C) 2010-2022 The ESPResSo project</span>
+<span class="c1">#</span>
+<span class="c1"># This file is part of ESPResSo.</span>
+<span class="c1">#</span>
+<span class="c1"># ESPResSo is free software: you can redistribute it and/or modify</span>
+<span class="c1"># it under the terms of the GNU General Public License as published by</span>
+<span class="c1"># the Free Software Foundation, either version 3 of the License, or</span>
+<span class="c1"># (at your option) any later version.</span>
+<span class="c1">#</span>
+<span class="c1"># ESPResSo is distributed in the hope that it will be useful,</span>
+<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
+<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
+<span class="c1"># GNU General Public License for more details.</span>
+<span class="c1">#</span>
+<span class="c1"># You should have received a copy of the GNU General Public License</span>
+<span class="c1"># along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
+
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">highlander</span>
+<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">script_interface</span>
+
+
+<div class="viewcode-block" id="Actors"><a class="viewcode-back" href="../../espressomd.html#espressomd.actors.Actors">[docs]</a><span class="k">class</span> <span class="nc">Actors</span><span class="p">:</span>
+
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Container for actor objects.</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="n">active_actors</span> <span class="o">=</span> <span class="p">[]</span>
+
+    <span class="k">def</span> <span class="fm">__del__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
+
+    <span class="k">def</span> <span class="nf">__getstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span>
+
+    <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">active_actors</span><span class="p">):</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">[:]</span> <span class="o">=</span> <span class="p">[]</span>
+        <span class="k">for</span> <span class="n">actor</span> <span class="ow">in</span> <span class="n">active_actors</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">actor</span><span class="p">)</span>
+            <span class="n">actor</span><span class="o">.</span><span class="n">_activate</span><span class="p">()</span>
+
+<div class="viewcode-block" id="Actors.add"><a class="viewcode-back" href="../../espressomd.html#espressomd.actors.Actors.add">[docs]</a>    <span class="k">def</span> <span class="nf">add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">actor</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        actor :</span>
+<span class="sd">            Actor to add to this container.</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">actor</span> <span class="ow">in</span> <span class="n">Actors</span><span class="o">.</span><span class="n">active_actors</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="n">highlander</span><span class="o">.</span><span class="n">ThereCanOnlyBeOne</span><span class="p">(</span><span class="n">actor</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">actor</span><span class="p">,</span> <span class="n">script_interface</span><span class="o">.</span><span class="n">ScriptInterfaceHelper</span><span class="p">):</span>
+            <span class="n">actor</span><span class="o">.</span><span class="n">_activate</span><span class="p">()</span>
+
+        <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">actor</span><span class="p">)</span>
+
+        <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">actor</span><span class="p">,</span> <span class="n">script_interface</span><span class="o">.</span><span class="n">ScriptInterfaceHelper</span><span class="p">):</span>
+            <span class="n">actor</span><span class="o">.</span><span class="n">_activate</span><span class="p">()</span></div>
+
+<div class="viewcode-block" id="Actors.remove"><a class="viewcode-back" href="../../espressomd.html#espressomd.actors.Actors.remove">[docs]</a>    <span class="k">def</span> <span class="nf">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">actor</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Parameters</span>
+<span class="sd">        ----------</span>
+<span class="sd">        actor :</span>
+<span class="sd">            Actor to remove from this container.</span>
+
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">if</span> <span class="n">actor</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">:</span>
+            <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Actor is not active&quot;</span><span class="p">)</span>
+        <span class="n">actor</span><span class="o">.</span><span class="n">_deactivate</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">actor</span><span class="p">)</span></div>
+
+<div class="viewcode-block" id="Actors.clear"><a class="viewcode-back" href="../../espressomd.html#espressomd.actors.Actors.clear">[docs]</a>    <span class="k">def</span> <span class="nf">clear</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="sd">&quot;&quot;&quot;Remove all actors.&quot;&quot;&quot;</span>
+        <span class="c1"># The order in which actors are removed matters. Some actors set up</span>
+        <span class="c1"># global bitfields that activate sanity checks on the MD cellsystem,</span>
+        <span class="c1"># and reset these bitfields when removed. Actors need to be removed</span>
+        <span class="c1"># in the reverse order they were inserted to guarantee pre-conditions</span>
+        <span class="c1"># and post-conditions are always met.</span>
+        <span class="k">while</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">):</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">])</span></div>
+
+    <span class="k">def</span> <span class="fm">__str__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">[</span><span class="n">key</span><span class="p">]</span>
+
+    <span class="k">def</span> <span class="fm">__len__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">return</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">)</span>
+
+    <span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+        <span class="k">for</span> <span class="n">actor</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">active_actors</span><span class="p">:</span>
+            <span class="k">yield</span> <span class="n">actor</span>
+
+    <span class="k">def</span> <span class="fm">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">idx</span><span class="p">):</span>
+        <span class="n">actor</span> <span class="o">=</span> <span class="bp">self</span><span class="p">[</span><span class="n">idx</span><span class="p">]</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">actor</span><span class="p">)</span></div>
+</pre></div>
+
+          </div>
+
+        </div>
+      </div>
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+<div id="searchbox" style="display: none" role="search">
+  <h3 id="searchlabel">Quick search</h3>
+    <div class="searchformwrapper">
+    <form class="search" action="../../search.html" method="get">
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
+      <input type="submit" value="Go" />
+    </form>
+    </div>
+</div>
+<script>$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="footer">
+      &copy;2018-2023, The ESPResSo project.
+
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.5.0</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
+
+    </div>
+
+
+
+
+  </body>
+</html>