10
0
mirror of https://github.com/QuantumPackage/qp2.git synced 2024-11-03 20:53:54 +01:00
QuantumPackage/doc/programs/fci.html
2019-01-25 14:17:34 +01:00

347 lines
18 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>fci &mdash; Quantum Package 2.0 documentation</title>
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="fcidump" href="fcidump.html" />
<link rel="prev" title="diagonalize_h" href="diagonalize_h.html" />
<script src="../_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="../index.html" class="icon icon-home"> Quantum Package
</a>
<div class="version">
2.0
</div>
<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">
<p class="caption"><span class="caption-text">Introduction</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../intro/install.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intro/selected_ci.html">Selected Configuration Interaction</a></li>
</ul>
<p class="caption"><span class="caption-text">User's guide</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../users_guide/quickstart.html">Quick-start guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/interfaces.html">Interfaces</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/excited_states.html">Excited states</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/natural_orbitals.html">Natural orbitals</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/printing.html">Printing the near-<abbr title="Full Configuration Interaction">FCI</abbr> wave function</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/plugins.html">Working with external plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/qp_plugins.html">qp_plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../users_guide/index.html">Index of commands</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../users_guide/index.html#index-of-programs">Index of programs</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cis.html">cis</a></li>
<li class="toctree-l2"><a class="reference internal" href="cisd.html">cisd</a></li>
<li class="toctree-l2"><a class="reference internal" href="diagonalize_h.html">diagonalize_h</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">fci</a></li>
<li class="toctree-l2"><a class="reference internal" href="fcidump.html">fcidump</a></li>
<li class="toctree-l2"><a class="reference internal" href="four_idx_transform.html">four_idx_transform</a></li>
<li class="toctree-l2"><a class="reference internal" href="ks_scf.html">ks_scf</a></li>
<li class="toctree-l2"><a class="reference internal" href="molden.html">molden</a></li>
<li class="toctree-l2"><a class="reference internal" href="print_e_conv.html">print_e_conv</a></li>
<li class="toctree-l2"><a class="reference internal" href="print_wf.html">print_wf</a></li>
<li class="toctree-l2"><a class="reference internal" href="pt2.html">pt2</a></li>
<li class="toctree-l2"><a class="reference internal" href="rs_ks_scf.html">rs_ks_scf</a></li>
<li class="toctree-l2"><a class="reference internal" href="save_natorb.html">save_natorb</a></li>
<li class="toctree-l2"><a class="reference internal" href="save_one_e_dm.html">save_one_e_dm</a></li>
<li class="toctree-l2"><a class="reference internal" href="save_ortho_mos.html">save_ortho_mos</a></li>
<li class="toctree-l2"><a class="reference internal" href="scf.html">scf</a></li>
<li class="toctree-l2"><a class="reference internal" href="write_integrals_erf.html">write_integrals_erf</a></li>
</ul>
</li>
</ul>
<p class="caption"><span class="caption-text">Programmer's guide</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/programming.html">Programming in the <em>Quantum Package</em></a></li>
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/ezfio.html">EZFIO</a></li>
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/plugins.html">Developing plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/index.html">Index for programmers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../programmers_guide/plugins.html">Developing plugins</a></li>
</ul>
<p class="caption"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../appendix/benchmarks.html">Benchmarks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix/research.html">Some research made with the <em>Quantum Package</em></a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix/license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../appendix/contributors.html">Contributors</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Quantum Package</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="../index.html">Docs</a> &raquo;</li>
<li><a href="../users_guide/index.html">Index of commands</a> &raquo;</li>
<li>fci</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/programs/fci.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="fci">
<span id="id1"></span><h1>fci<a class="headerlink" href="#fci" title="Permalink to this headline"></a></h1>
<blockquote>
<div><p>Selected Full Configuration Interaction with stochastic selection
and PT2.</p>
<p>This program performs a <abbr title="Configuration Interaction using a Perturbative Selection">CIPSI</abbr>-like selected <abbr title="Configuration Interaction">CI</abbr> using a
stochastic scheme for both the selection of the important Slater
determinants and the computation of the <abbr title="Second order perturbative correction">PT2</abbr> correction. This
<abbr title="Configuration Interaction using a Perturbative Selection">CIPSI</abbr>-like algorithm will be performed for the lowest states of
the variational space (see <a class="reference internal" href="../modules/determinants.html#cmdoption-determinants-arg-n-states"><code class="xref std std-option docutils literal notranslate"><span class="pre">determinants</span> <span class="pre">n_states</span></code></a>). The
<abbr title="Full Configuration Interaction">FCI</abbr> program will stop when reaching at least one the two following
conditions:</p>
<ul class="simple">
<li>number of Slater determinants &gt; <a class="reference internal" href="../modules/determinants.html#cmdoption-determinants-arg-n-det-max"><code class="xref std std-option docutils literal notranslate"><span class="pre">determinants</span> <span class="pre">n_det_max</span></code></a></li>
<li><abbr title="Second order perturbative correction">PT2</abbr> &lt; <a class="reference internal" href="../modules/perturbation.html#cmdoption-perturbation-arg-pt2-max"><code class="xref std std-option docutils literal notranslate"><span class="pre">perturbation</span> <span class="pre">pt2_max</span></code></a></li>
</ul>
<p>The following other options can be of interest:</p>
<dl class="docutils">
<dt><a class="reference internal" href="../modules/determinants.html#cmdoption-determinants-arg-read-wf"><code class="xref std std-option docutils literal notranslate"><span class="pre">determinants</span> <span class="pre">read_wf</span></code></a></dt>
<dd>When set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the program starts with a ROHF-like Slater
determinant as a guess wave function. When set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the
program starts with the wave function(s) stored in the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a>
directory as guess wave function(s).</dd>
<dt><a class="reference internal" href="../modules/determinants.html#cmdoption-determinants-arg-s2-eig"><code class="xref std std-option docutils literal notranslate"><span class="pre">determinants</span> <span class="pre">s2_eig</span></code></a></dt>
<dd>When set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the selection will systematically add all the
necessary Slater determinants in order to have a pure spin wave
function with an <span class="math notranslate nohighlight">\(\widehat{S^2}\)</span> value corresponding to
<a class="reference internal" href="../modules/determinants.html#cmdoption-determinants-arg-expected-s2"><code class="xref std std-option docutils literal notranslate"><span class="pre">determinants</span> <span class="pre">expected_s2</span></code></a>.</dd>
</dl>
<p>For excited states calculations, it is recommended to start with
<span class="xref std std-ref">.cis.</span> or <span class="xref std std-ref">.cisd.</span> guess wave functions, eventually in
a restricted set of <abbr title="Molecular Orbitals">MOs</abbr>, and to set <a class="reference internal" href="../modules/determinants.html#cmdoption-determinants-arg-s2-eig"><code class="xref std std-option docutils literal notranslate"><span class="pre">determinants</span> <span class="pre">s2_eig</span></code></a>
to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
<p>Needs:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><a class="reference internal" href="../modules/determinants.html#c.psi_coef" title="psi_coef"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_coef</span></code></a></li>
<li><a class="reference internal" href="../modules/zmq.html#c.is_zmq_slave" title="is_zmq_slave"><code class="xref c c-data docutils literal notranslate"><span class="pre">is_zmq_slave</span></code></a></li>
</ul>
</td><td><ul class="simple">
<li><code class="xref c c-data docutils literal notranslate"><span class="pre">do_pt2</span></code></li>
<li><a class="reference internal" href="../modules/mo_two_e_ints.html#c.mo_two_e_integrals_in_map" title="mo_two_e_integrals_in_map"><code class="xref c c-data docutils literal notranslate"><span class="pre">mo_two_e_integrals_in_map</span></code></a></li>
</ul>
</td><td><ul class="simple">
<li><a class="reference internal" href="../modules/determinants.html#c.psi_det" title="psi_det"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_det</span></code></a></li>
</ul>
</td></tr></table>
<p>Calls:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><code class="xref c c-func docutils literal notranslate"><span class="pre">run_cipsi()</span></code></li>
</ul>
</td><td><ul class="simple">
<li><code class="xref c c-func docutils literal notranslate"><span class="pre">run_slave_cipsi()</span></code></li>
</ul>
</td><td><ul class="simple">
<li><code class="xref c c-func docutils literal notranslate"><span class="pre">run_stochastic_cipsi()</span></code></li>
</ul>
</td></tr></table>
<p>Touches:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><a class="reference internal" href="../modules/davidson.html#c.ci_electronic_energy" title="ci_electronic_energy"><code class="xref c c-data docutils literal notranslate"><span class="pre">ci_electronic_energy</span></code></a></li>
<li><a class="reference internal" href="../modules/davidson.html#c.ci_electronic_energy" title="ci_electronic_energy"><code class="xref c c-data docutils literal notranslate"><span class="pre">ci_electronic_energy</span></code></a></li>
<li><a class="reference internal" href="../modules/davidson.html#c.ci_energy" title="ci_energy"><code class="xref c c-data docutils literal notranslate"><span class="pre">ci_energy</span></code></a></li>
<li><a class="reference internal" href="../modules/davidson.html#c.ci_electronic_energy" title="ci_electronic_energy"><code class="xref c c-data docutils literal notranslate"><span class="pre">ci_electronic_energy</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.n_det" title="n_det"><code class="xref c c-data docutils literal notranslate"><span class="pre">n_det</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.psi_occ_pattern" title="psi_occ_pattern"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_occ_pattern</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.c0_weight" title="c0_weight"><code class="xref c c-data docutils literal notranslate"><span class="pre">c0_weight</span></code></a></li>
</ul>
</td><td><ul class="simple">
<li><code class="xref c c-data docutils literal notranslate"><span class="pre">distributed_davidson</span></code></li>
<li><a class="reference internal" href="../modules/determinants.html#c.psi_coef" title="psi_coef"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_coef</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.psi_det_sorted_bit" title="psi_det_sorted_bit"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_det_sorted_bit</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.psi_det" title="psi_det"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_det</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.psi_det_size" title="psi_det_size"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_det_size</span></code></a></li>
<li><a class="reference internal" href="../modules/determinants.html#c.psi_det_sorted_bit" title="psi_det_sorted_bit"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_det_sorted_bit</span></code></a></li>
</ul>
</td><td><ul class="simple">
<li><a class="reference internal" href="../modules/determinants.html#c.psi_occ_pattern" title="psi_occ_pattern"><code class="xref c c-data docutils literal notranslate"><span class="pre">psi_occ_pattern</span></code></a></li>
<li><a class="reference internal" href="../modules/cipsi.html#c.pt2_e0_denominator" title="pt2_e0_denominator"><code class="xref c c-data docutils literal notranslate"><span class="pre">pt2_e0_denominator</span></code></a></li>
<li><a class="reference internal" href="../modules/cipsi.html#c.pt2_stoch_istate" title="pt2_stoch_istate"><code class="xref c c-data docutils literal notranslate"><span class="pre">pt2_stoch_istate</span></code></a></li>
<li><code class="xref c c-data docutils literal notranslate"><span class="pre">read_wf</span></code></li>
<li><a class="reference internal" href="../modules/determinants.html#c.state_average_weight" title="state_average_weight"><code class="xref c c-data docutils literal notranslate"><span class="pre">state_average_weight</span></code></a></li>
<li><code class="xref c c-data docutils literal notranslate"><span class="pre">threshold_generators</span></code></li>
</ul>
</td></tr></table>
</div></blockquote>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="fcidump.html" class="btn btn-neutral float-right" title="fcidump" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="diagonalize_h.html" class="btn btn-neutral" title="diagonalize_h" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright 2018, A. Scemama, E. Giner
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/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" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="../_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>