~liggghts-dev/liggghts/public

« back to all changes in this revision

Viewing changes to doc/fix_multisphere.html

  • Committer: kloss
  • Date: 2017-11-29 17:39:00 UTC
  • Revision ID: git-v1:84ba3d76a050e741fb5291d0845a0896fe718ed2
release version 3.8.0 on 2017-11-29_18-39-00

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
 
2
2
 
3
 
 
4
3
<!DOCTYPE html>
5
4
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
6
5
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
14
13
 
15
14
  
16
15
  
 
16
  
 
17
  
17
18
 
18
19
  
19
20
 
81
82
          
82
83
            
83
84
            
84
 
                <ul>
 
85
              
 
86
            
 
87
            
 
88
              <ul>
85
89
<li class="toctree-l1"><a class="reference internal" href="Section_intro.html">1. Introduction</a></li>
86
90
<li class="toctree-l1"><a class="reference internal" href="Section_start.html">2. Getting Started</a></li>
87
91
<li class="toctree-l1"><a class="reference internal" href="Section_input_script.html">3. Input Script</a></li>
105
109
 
106
110
      
107
111
      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
108
 
        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
109
 
        <a href="Manual.html">LIGGGHTS</a>
 
112
        
 
113
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
 
114
          <a href="Manual.html">LIGGGHTS</a>
 
115
        
110
116
      </nav>
111
117
 
112
118
 
119
125
 
120
126
 
121
127
 
 
128
 
 
129
 
 
130
 
 
131
 
 
132
 
 
133
 
 
134
 
 
135
 
 
136
 
 
137
 
122
138
<div role="navigation" aria-label="breadcrumbs navigation">
 
139
 
123
140
  <ul class="wy-breadcrumbs">
124
 
    <li><a href="Manual.html">Docs</a> &raquo;</li>
125
 
      
126
 
    <li>fix multisphere command</li>
127
 
    <li class="wy-breadcrumbs-aside">
128
 
      
129
 
        
130
 
          <a href="_sources/fix_multisphere.txt" rel="nofollow"> View page source</a> 
131
 
        
 
141
    
 
142
      <li><a href="Manual.html">Docs</a> &raquo;</li>
 
143
        
 
144
      <li>fix multisphere command</li>
 
145
    
 
146
    
 
147
      <li class="wy-breadcrumbs-aside">
 
148
        
 
149
            
 
150
            <a href="_sources/fix_multisphere.txt" rel="nofollow"> View page source</a>
 
151
          
132
152
          <a href="http://www.cfdem.com"> Website</a>
133
 
        
134
 
          <a href="Section_commands.html#comm" rel="nofollow"> Commands</a>
135
 
          
136
 
        
137
 
      
138
 
    </li>
 
153
          
 
154
            <a href="Section_commands.html#comm" rel="nofollow"> Commands</a>
 
155
            
 
156
          
 
157
        
 
158
      </li>
 
159
    
139
160
  </ul>
 
161
 
 
162
  
140
163
  <hr/>
141
164
  
142
165
</div>
147
170
<span id="index-0"></span><h1>fix multisphere command<a class="headerlink" href="#fix-multisphere-command" title="Permalink to this headline">¶</a></h1>
148
171
<div class="section" id="syntax">
149
172
<h2>Syntax<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h2>
150
 
<div class="highlight-python"><pre>fix ID group-ID multisphere</pre>
 
173
<div class="highlight-python"><div class="highlight"><pre>fix ID group-ID multisphere
 
174
</pre></div>
151
175
</div>
152
176
<ul class="simple">
153
177
<li>ID, group-ID are documented in <a class="reference internal" href="fix.html"><em>fix</em></a> command</li>
 
178
<li>multisphere = style name of this fix command</li>
 
179
<li>zero or more keyword/value pairs may be appended</li>
 
180
<li>keyword = <em>allow_group_and_set</em> or <em>allow_heatsource</em> or <em>CAddRhoFluid</em></li>
154
181
</ul>
 
182
<pre class="literal-block">
 
183
<em>allow_group_and_set</em> value = 'yes' or 'no'
 
184
  yes, no = determines if group and set command are allowed in the current simulation.
 
185
<em>allow_heatsource</em> value = 'yes' or 'no'
 
186
  yes, no = determines if heatsources are allowed in the current simulation.
 
187
<em>CAddRhoFluid</em> value = CAdd RhoFluid
 
188
  CAdd = Coefficient for additional mass term. (Usually 0.5)
 
189
  RhoFluid = Fluid density
 
190
</pre>
155
191
</div>
156
192
<div class="section" id="examples">
157
193
<h2>Examples<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
158
 
<div class="highlight-python"><pre>fix ms all multisphere</pre>
 
194
<div class="highlight-python"><div class="highlight"><pre>fix ms all multisphere
 
195
</pre></div>
159
196
</div>
160
197
</div>
161
198
<div class="section" id="description">
190
227
other time-integration fixes (e.g. nve, nvt, npt), or you will be
191
228
integrating their motion more than once each timestep.</p>
192
229
</div>
 
230
<p>The option <em>CAddRhoFluid</em> enables additional mass terms for the integration of
 
231
multisphere particles. These model the influence of displaced fluid on the
 
232
particle motion.</p>
193
233
</div>
194
234
<hr class="docutils" />
195
235
<div class="section" id="restart-fix-modify-output-run-start-stop-minimize-info">
196
236
<h2>Restart, fix_modify, output, run start/stop, minimize info<a class="headerlink" href="#restart-fix-modify-output-run-start-stop-minimize-info" title="Permalink to this headline">¶</a></h2>
197
 
<p>No information about this fix is written to <a class="reference internal" href="restart.html"><em>binary restart files</em></a>.  This means you can currently not restart a simulation
 
237
<p>Information about this fix is written to <a class="reference internal" href="restart.html"><em>binary restart files</em></a>.  This means you can restart a simulation
198
238
using multisphere particles.</p>
199
 
<p>None of the <a class="reference internal" href="fix_modify.html"><em>fix_modify</em></a> options are relevant to this
200
 
fix.  No global scalar or vector or per-atom quantities are stored by
201
 
this fix for access by various <em class="xref std std-ref">output commands</em>.  No parameter of this fix can be
 
239
<dl class="docutils">
 
240
<dt><a class="reference internal" href="fix_modify.html"><em>fix_modify</em></a> can be used to manipulate the fflag and tflag switches</dt>
 
241
<dd>of multispheres. They can be initially defined in the</dd>
 
242
</dl>
 
243
<p><a class="reference internal" href="fix_particletemplate_multisphere.html"><em>fix_particletemplate_multisphere</em></a> command.
 
244
The fix_modify manipulates all multispheres, not only the initially defined f/tflags from the template.</p>
 
245
<div class="highlight-python"><div class="highlight"><pre>E.g. fix_modify ms fflag on on off tflag on on off
 
246
</pre></div>
 
247
</div>
 
248
<p>No global scalar or vector or per-atom quantities are stored by
 
249
this fix for access by various <span class="xref std std-ref">output commands</span>.  No parameter of this fix can be
202
250
used with the <em>start/stop</em> keywords of the <a class="reference internal" href="run.html"><em>run</em></a> command.
203
 
This fix is not invoked during <tt class="xref doc docutils literal"><span class="pre">energy</span> <span class="pre">minimization</span></tt>.</p>
 
251
This fix is not invoked during <code class="xref doc docutils literal"><span class="pre">energy</span> <span class="pre">minimization</span></code>.</p>
204
252
</div>
205
253
<div class="section" id="restrictions">
206
254
<h2>Restrictions<a class="headerlink" href="#restrictions" title="Permalink to this headline">¶</a></h2>
208
256
<p>Only one fix multisphere at a time is allowed.
209
257
Heat transfer simulations are not possible when using this fix
210
258
(e.g. <a class="reference internal" href="fix_heat_gran_conduction.html"><em>fix heat/gran/conduction</em></a>)</p>
211
 
<p>The PUBLIC version does not support (i) parallel computation, (ii)
212
 
restart of multisphere simulations</p>
213
259
<div class="admonition warning">
214
260
<p class="first admonition-title">Warning</p>
215
261
<p class="last">All fixes or computes gathering statistical output
222
268
<div class="section" id="related-commands">
223
269
<h2>Related commands<a class="headerlink" href="#related-commands" title="Permalink to this headline">¶</a></h2>
224
270
<p><a class="reference internal" href="fix_rigid.html"><em>fix_rigid</em></a>
225
 
<a class="reference internal" href="fix_particletemplate_sphere.html"><em>fix_particletemplate_sphere</em></a>
 
271
<a class="reference internal" href="fix_particletemplate_multisphere.html"><em>fix_particletemplate_multisphere</em></a>
226
272
<a class="reference internal" href="neigh_modify.html"><em>neigh_modify</em></a></p>
227
 
<p><strong>Default:</strong> none</p>
228
 
</div>
229
 
</div>
230
 
 
231
 
 
 
273
</div>
 
274
<div class="section" id="default">
 
275
<h2>Default<a class="headerlink" href="#default" title="Permalink to this headline">¶</a></h2>
 
276
<p><em>allow_group_and_set</em> = &#8216;no&#8217;
 
277
<em>allow_heatsource</em> = &#8216;no&#8217;</p>
 
278
</div>
 
279
</div>
 
280
 
 
281
 
 
282
           </div>
 
283
           <div class="articleComments">
 
284
            
232
285
           </div>
233
286
          </div>
234
287
          <footer>
259
312
 
260
313
    <script type="text/javascript">
261
314
        var DOCUMENTATION_OPTIONS = {
262
 
            URL_ROOT:'',
 
315
            URL_ROOT:'./',
263
316
            VERSION:'v3.X',
 
317
            LANGUAGE:'None',
264
318
            COLLAPSE_INDEX:false,
265
319
            FILE_SUFFIX:'.html',
266
 
            HAS_SOURCE:  true
 
320
            HAS_SOURCE:  true,
 
321
            SOURCELINK_SUFFIX: ''
267
322
        };
268
323
    </script>
269
324
      <script type="text/javascript" src="_static/jquery.js"></script>