Debian Codegraph @

doc/compute_inertia_molecule.html

raw
1
2
3 <!DOCTYPE html>
4 <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5 <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6 <head>
7 <meta charset="utf-8">
8
9 <meta name="viewport" content="width=device-width, initial-scale=1.0">
10
11 <title>compute inertia/molecule command &mdash; LIGGGHTS v3.X documentation</title>
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29 <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
30
31
32
33
34
35 <link rel="top" title="LIGGGHTS v3.X documentation" href="index.html"/>
36
37
38 <script src="_static/js/modernizr.min.js"></script>
39
40 </head>
41
42 <body class="wy-body-for-nav" role="document">
43
44
45 <div class="wy-grid-for-nav">
46
47
48 <nav data-toggle="wy-nav-shift" class="wy-nav-side">
49 <div class="wy-side-scroll">
50 <div class="wy-side-nav-search">
51
52
53
54 <a href="Manual.html" class="icon icon-home"> LIGGGHTS
55
56
57
58 </a>
59
60
61
62
63 <div class="version">
64 v3.X
65 </div>
66
67
68
69
70 <div role="search">
71 <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
72 <input type="text" name="q" placeholder="Search docs" />
73 <input type="hidden" name="check_keywords" value="yes" />
74 <input type="hidden" name="area" value="default" />
75 </form>
76 </div>
77
78
79 </div>
80
81 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
82
83
84
85
86
87
88 <ul>
89 <li class="toctree-l1"><a class="reference internal" href="Section_intro.html">1. Introduction</a></li>
90 <li class="toctree-l1"><a class="reference internal" href="Section_start.html">2. Getting Started</a></li>
91 <li class="toctree-l1"><a class="reference internal" href="Section_input_script.html">3. Input Script</a></li>
92 <li class="toctree-l1"><a class="reference internal" href="Section_commands.html">4. Commands</a></li>
93 <li class="toctree-l1"><a class="reference internal" href="Section_gran_models.html">5. Contact models</a></li>
94 <li class="toctree-l1"><a class="reference internal" href="Section_mesh_modules.html">6. Mesh modules</a></li>
95 <li class="toctree-l1"><a class="reference internal" href="Section_packages.html">7. Packages</a></li>
96 <li class="toctree-l1"><a class="reference internal" href="Section_howto.html">8. How-to discussions</a></li>
97 <li class="toctree-l1"><a class="reference internal" href="Section_modify.html">9. Modifying &amp; extending LIGGGHTS(R)-PUBLIC</a></li>
98 <li class="toctree-l1"><a class="reference internal" href="Section_python.html">10. Python interface to LIGGGHTS(R)-PUBLIC</a></li>
99 <li class="toctree-l1"><a class="reference internal" href="Section_errors.html">11. Errors</a></li>
100 </ul>
101
102
103
104 </div>
105 </div>
106 </nav>
107
108 <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
109
110
111 <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
112
113 <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
114 <a href="Manual.html">LIGGGHTS</a>
115
116 </nav>
117
118
119
120 <div class="wy-nav-content">
121 <div class="rst-content">
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138 <div role="navigation" aria-label="breadcrumbs navigation">
139
140 <ul class="wy-breadcrumbs">
141
142 <li><a href="Manual.html">Docs</a> &raquo;</li>
143
144 <li>compute inertia/molecule command</li>
145
146
147 <li class="wy-breadcrumbs-aside">
148
149
150 <a href="_sources/compute_inertia_molecule.txt" rel="nofollow"> View page source</a>
151
152 <a href="http://www.cfdem.com"> Website</a>
153
154 <a href="Section_commands.html#comm" rel="nofollow"> Commands</a>
155
156
157
158 </li>
159
160 </ul>
161
162
163 <hr/>
164
165 </div>
166 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
167 <div itemprop="articleBody">
168
169 <div class="section" id="compute-inertia-molecule-command">
170 <span id="index-0"></span><h1>compute inertia/molecule command<a class="headerlink" href="#compute-inertia-molecule-command" title="Permalink to this headline">¶</a></h1>
171 <div class="section" id="syntax">
172 <h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
173 <div class="highlight-python"><div class="highlight"><pre>compute ID group-ID inertia/molecule general_keyword general_values
174 </pre></div>
175 </div>
176 <ul class="simple">
177 <li>ID, group-ID are documented in <a class="reference internal" href="compute.html"><em>compute</em></a> command</li>
178 <li>inertia/molecule = style name of this compute command</li>
179 <li>general_keywords general_values are documented in <a class="reference external" href="compute.html&quot;">compute</a></li>
180 </ul>
181 </div>
182 <div class="section" id="examples">
183 <h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
184 <div class="highlight-python"><div class="highlight"><pre>compute 1 fluid inertia/molecule
185 </pre></div>
186 </div>
187 </div>
188 <div class="section" id="description">
189 <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
190 <p>Define a computation that calculates the inertia tensor of individual
191 molecules. The calculation includes all effects due to atoms passing
192 thru periodic boundaries.</p>
193 <p>The symmetric intertia tensor has 6 components, ordered
194 Ixx,Iyy,Izz,Ixy,Iyz,Ixz. The tensor for a particular molecule is only
195 computed if one or more of its atoms is in the specified group.
196 Normally all atoms in the molecule should be in the group, however
197 this is not required. LIGGGHTS(R)-PUBLIC will warn you if this is not the case.
198 Only atoms in the group contribute to the inertia tensor and
199 associated center-of-mass calculation for the molecule.</p>
200 <p>The ordering of per-molecule quantities produced by this compute is
201 consistent with the ordering produced by other compute commands that
202 generate per-molecule datums. Conceptually, the molecule IDs will be
203 in ascending order for any molecule with one or more of its atoms in
204 the specified group.</p>
205 <div class="admonition warning">
206 <p class="first admonition-title">Warning</p>
207 <p class="last">The coordinates of an atom contribute to the
208 molecule&#8217;s inertia tensor in &#8220;unwrapped&#8221; form, by using the image
209 flags associated with each atom. See the <a class="reference internal" href="dump.html"><em>dump custom</em></a>
210 command for a discussion of &#8220;unwrapped&#8221; coordinates. See the Atoms
211 section of the <a class="reference internal" href="read_data.html"><em>read_data</em></a> command for a discussion of
212 image flags and how they are set for each atom. You can reset the
213 image flags (e.g. to 0) before invoking this compute by using the <a class="reference internal" href="set.html"><em>set image</em></a> command.</p>
214 </div>
215 <div class="admonition warning">
216 <p class="first admonition-title">Warning</p>
217 <p class="last">If an atom is part of a rigid body (see the <a class="reference internal" href="fix_rigid.html"><em>fix rigid</em></a> command), it&#8217;s periodic image flags are altered,
218 and its contribution to the inertia tensor may not reflect its true
219 contribution. See the <a class="reference internal" href="fix_rigid.html"><em>fix rigid</em></a> command for details.
220 Thus, to compute the inertia tensor of rigid bodies as they cross
221 periodic boundaries, you will need to post-process a <a class="reference internal" href="dump.html"><em>dump file</em></a> containing coordinates of the atoms in the bodies.</p>
222 </div>
223 </div>
224 <div class="section" id="output-info">
225 <h2>Output info<a class="headerlink" href="#output-info" title="Permalink to this headline">¶</a></h2>
226 <p>This compute calculates a global array where the number of rows =
227 Nmolecules and the number of columns = 6 for the 6 components of the
228 inertia tensor of each molecule, ordered as listed above. These
229 values can be accessed by any command that uses global array values
230 from a compute as input. See <span class="xref std std-ref">Section_howto 15</span> for an overview of LIGGGHTS(R)-PUBLIC output
231 options.</p>
232 <p>The array values are &#8220;intensive&#8221;. The array values will be in
233 distance <a class="reference internal" href="units.html"><em>units</em></a>.</p>
234 </div>
235 <div class="section" id="restrictions">
236 <h2>Restrictions<a class="headerlink" href="#restrictions" title="Permalink to this headline">¶</a></h2>
237 <blockquote>
238 <div>none</div></blockquote>
239 </div>
240 <div class="section" id="related-commands">
241 <h2>Related commands<a class="headerlink" href="#related-commands" title="Permalink to this headline">¶</a></h2>
242 <p><a class="reference internal" href="variable.html"><em>variable inertia() function</em></a></p>
243 <p><strong>Default:</strong> none</p>
244 </div>
245 </div>
246
247
248 </div>
249 <div class="articleComments">
250
251 </div>
252 </div>
253 <footer>
254
255
256 <hr/>
257
258 <div role="contentinfo">
259 <p>
260 &copy; Copyright 2016, DCS Computing GmbH, JKU Linz and Sandia Corporation.
261
262 </p>
263 </div>
264 Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
265
266 </footer>
267
268 </div>
269 </div>
270
271 </section>
272
273 </div>
274
275
276
277
278
279 <script type="text/javascript">
280 var DOCUMENTATION_OPTIONS = {
281 URL_ROOT:'./',
282 VERSION:'v3.X',
283 LANGUAGE:'None',
284 COLLAPSE_INDEX:false,
285 FILE_SUFFIX:'.html',
286 HAS_SOURCE: true,
287 SOURCELINK_SUFFIX: ''
288 };
289 </script>
290 <script type="text/javascript" src="_static/jquery.js"></script>
291 <script type="text/javascript" src="_static/underscore.js"></script>
292 <script type="text/javascript" src="_static/doctools.js"></script>
293
294
295
296
297
298 <script type="text/javascript" src="_static/js/theme.js"></script>
299
300
301
302
303 <script type="text/javascript">
304 jQuery(function () {
305 SphinxRtdTheme.StickyNav.enable();
306 });
307 </script>
308
309
310 </body>
311 </html>