lammps/doc/html/fix_eos_table_rx.html

311 lines
14 KiB
HTML

<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>fix eos/table/rx command &mdash; LAMMPS documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinxcontrib-images/LightBox2/lightbox2/css/lightbox.css" type="text/css" />
<link rel="top" title="LAMMPS documentation" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-nav-search">
<a href="Manual.html" class="icon icon-home"> LAMMPS
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="Section_intro.html">1. Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_start.html">2. Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_commands.html">3. Commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_packages.html">4. Packages</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_accelerate.html">5. Accelerating LAMMPS performance</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_howto.html">6. How-to discussions</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_example.html">7. Example problems</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_perf.html">8. Performance &amp; scalability</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_tools.html">9. Additional tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_modify.html">10. Modifying &amp; extending LAMMPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_python.html">11. Python interface to LAMMPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_errors.html">12. Errors</a></li>
<li class="toctree-l1"><a class="reference internal" href="Section_history.html">13. Future and history</a></li>
</ul>
</div>
&nbsp;
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="Manual.html">LAMMPS</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="Manual.html">Docs</a> &raquo;</li>
<li>fix eos/table/rx command</li>
<li class="wy-breadcrumbs-aside">
<a href="http://lammps.sandia.gov">Website</a>
<a href="Section_commands.html#comm">Commands</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="fix-eos-table-rx-command">
<span id="index-0"></span><h1>fix eos/table/rx command</h1>
<div class="section" id="syntax">
<h2>Syntax</h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">fix</span> <span class="n">ID</span> <span class="n">group</span><span class="o">-</span><span class="n">ID</span> <span class="n">eos</span><span class="o">/</span><span class="n">table</span><span class="o">/</span><span class="n">rx</span> <span class="n">style</span> <span class="n">file1</span> <span class="n">N</span> <span class="n">keyword</span> <span class="n">file2</span>
</pre></div>
</div>
<ul class="simple">
<li>ID, group-ID are documented in <a class="reference internal" href="fix.html"><span class="doc">fix</span></a> command</li>
<li>eos/table/rx = style name of this fix command</li>
<li>style = <em>linear</em> = method of interpolation</li>
<li>file1 = filename containing the tabulated equation of state</li>
<li>N = use N values in <em>linear</em> tables</li>
<li>keyword = name of table keyword correponding to table file</li>
<li>file2 = filename containing the heats of formation of each species</li>
</ul>
</div>
<div class="section" id="examples">
<h2>Examples</h2>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">fix</span> <span class="mi">1</span> <span class="nb">all</span> <span class="n">eos</span><span class="o">/</span><span class="n">table</span><span class="o">/</span><span class="n">rx</span> <span class="n">linear</span> <span class="n">eos</span><span class="o">.</span><span class="n">table</span> <span class="mi">10000</span> <span class="n">KEYWORD</span> <span class="n">thermo</span><span class="o">.</span><span class="n">table</span>
</pre></div>
</div>
</div>
<div class="section" id="description">
<h2>Description</h2>
<p>Fix <em>eos/table/rx</em> applies a tabulated mesoparticle equation
of state to relate the concentration-dependent particle internal
energy (u_i) to the particle internal temperature (dpdTheta_i).</p>
<p>The concentration-dependent particle internal energy (u_i) is
computed according to the following relation:</p>
<img alt="Eqs/fix_eos_table_rx.jpg" class="align-center" src="Eqs/fix_eos_table_rx.jpg" />
<p>where <em>m</em> is the number of species, <em>c_i,j</em> is the concentration of
species <em>j</em> in particle <em>i</em>, <em>u_j</em> is the internal energy of species j,
<em>DeltaH_f,j</em> is the heat of formation of species <em>j</em>, N is the number of
molecules represented by the coarse-grained particle, kb is the
Boltzmann constant, and T is the temperature of the system.</p>
<p>Fix <em>eos/table/rx</em> creates interpolation tables of length <em>N</em> from <em>m</em>
internal energy values of each species <em>u_j</em> listed in a file as a
function of internal temperature. During a simulation, these tables
are used to interpolate internal energy or temperature values as needed.
The interpolation is done with the <em>linear</em> style. For the <em>linear</em> style,
the internal temperature is used to find 2 surrounding table values from
which an internal energy is computed by linear interpolation. A secant
solver is used to determine the internal temperature from the internal energy.</p>
<p>The first filename specifies a file containing tabulated internal
temperature and <em>m</em> internal energy values for each species <em>u_j</em>.
The keyword specifies a section of the file. The format of this
file is described below.</p>
<p>The second filename specifies a file containing heat of formation
<em>DeltaH_f,j</em> for each species.</p>
<hr class="docutils" />
<p>The format of a tabulated file is as follows (without the
parenthesized comments):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># EOS TABLE (one or more comment or blank lines)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">KEYWORD</span> <span class="p">(</span><span class="n">keyword</span> <span class="ow">is</span> <span class="n">first</span> <span class="n">text</span> <span class="n">on</span> <span class="n">line</span><span class="p">)</span>
<span class="n">N</span> <span class="mi">500</span> <span class="n">h2</span> <span class="n">no2</span> <span class="n">n2</span> <span class="o">...</span> <span class="n">no</span> <span class="p">(</span><span class="n">N</span> <span class="n">parameter</span> <span class="n">species1</span> <span class="n">species2</span> <span class="o">...</span> <span class="n">speciesN</span><span class="p">)</span>
<span class="p">(</span><span class="n">blank</span><span class="p">)</span>
<span class="mi">1</span> <span class="mf">1.00</span> <span class="mf">0.000</span> <span class="o">...</span> <span class="mf">0.0000</span> <span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="n">internal</span> <span class="n">temperature</span><span class="p">,</span> <span class="n">internal</span> <span class="n">energy</span> <span class="n">of</span> <span class="n">species</span> <span class="mi">1</span><span class="p">,</span> <span class="o">...</span><span class="p">,</span> <span class="n">internal</span> <span class="n">energy</span> <span class="n">of</span> <span class="n">species</span> <span class="n">m</span><span class="p">)</span>
<span class="mi">2</span> <span class="mf">1.02</span> <span class="mf">0.001</span> <span class="o">...</span> <span class="mf">0.0002</span>
<span class="o">...</span>
<span class="mi">500</span> <span class="mf">10.0</span> <span class="mf">0.500</span> <span class="o">...</span> <span class="mf">1.0000</span>
</pre></div>
</div>
<p>A section begins with a non-blank line whose 1st character is not a
&#8220;#&#8221;; blank lines or lines starting with &#8220;#&#8221; can be used as comments
between sections. The first line begins with a keyword which
identifies the section. The line can contain additional text, but the
initial text must match the argument specified in the fix command.</p>
<p>The next line lists the number of table entries and the species names
that correspond with all the species listed in the reaction equations
through the <em>fix rx</em> command.
The parameter &#8220;N&#8221; is required and its value is the number of table
entries that follow. Let Nfile = &#8220;N&#8221; in the tabulated file.
What LAMMPS does is a preliminary interpolation by creating splines
using the Nfile tabulated values as nodal points.</p>
<p>Following a blank line, the next N lines list the tabulated values.
On each line, the 1st value is the index from 1 to N, the 2nd value is
the internal temperature (in temperature units), the 3rd value until
the <em>m+3</em> value are the internal energies of the m species (in energy units).</p>
<p>Note that all internal temperature and internal energy values must
increase from one line to the next.</p>
<p>Note that one file can contain many sections, each with a tabulated
potential. LAMMPS reads the file section by section until it finds
one that matches the specified keyword.</p>
<hr class="docutils" />
<p>The format of a heat of formation file is as follows (without the
parenthesized comments):</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="c1"># HEAT OF FORMATION TABLE (one or more comment or blank lines)</span>
</pre></div>
</div>
<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">(</span><span class="n">blank</span><span class="p">)</span>
<span class="n">h2</span> <span class="mf">0.00</span> <span class="p">(</span><span class="n">species</span> <span class="n">name</span><span class="p">,</span> <span class="n">heat</span> <span class="n">of</span> <span class="n">formation</span><span class="p">)</span>
<span class="n">no2</span> <span class="mf">0.34</span>
<span class="n">n2</span> <span class="mf">0.00</span>
<span class="o">...</span>
<span class="n">no</span> <span class="mf">0.93</span>
</pre></div>
</div>
<p>Note that the species can be listed in any order. The tag that is
used as the species name must correspond with the tags used to define
the reactions with the <a class="reference internal" href="fix_rx.html"><span class="doc">fix rx</span></a> command.</p>
</div>
<hr class="docutils" />
<div class="section" id="restrictions">
<h2>Restrictions</h2>
<p>The fix <em>eos/table/rx</em> is only available if LAMMPS is built with the
USER-DPD package.</p>
<p>The equation of state must be a monotonically increasing function.</p>
<p>An exit error will occur if the internal temperature or internal
energies are not within the table cutoffs.</p>
</div>
<div class="section" id="related-commands">
<h2>Related commands</h2>
<p><a class="reference internal" href="fix_rx.html"><span class="doc">fix rx</span></a>,
<span class="xref doc">pair dpd/fdt</span></p>
<p><strong>Default:</strong> none</p>
<hr class="docutils" />
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2013 Sandia Corporation.
</p>
</div>
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>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/sphinxcontrib-images/LightBox2/lightbox2/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="_static/sphinxcontrib-images/LightBox2/lightbox2/js/lightbox.min.js"></script>
<script type="text/javascript" src="_static/sphinxcontrib-images/LightBox2/lightbox2-customize/jquery-noconflict.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>