9
1
mirror of https://github.com/QuantumPackage/qp2.git synced 2024-12-27 22:03:29 +01:00
qp2/doc/modules/fci.html
2019-01-25 14:17:34 +01:00

441 lines
24 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="generators_cas" href="generators_cas.html" />
<link rel="prev" title="ezfio_files" href="ezfio_files.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>
<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"><a class="reference internal" href="../users_guide/index.html#index-of-programs">Index of programs</a></li>
</ul>
<p class="caption"><span class="caption-text">Programmer's guide</span></p>
<ul class="current">
<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 current"><a class="reference internal" href="../programmers_guide/index.html">Index for programmers</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="../programmers_guide/index.html#index-of-modules">Index of Modules</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="ao_basis.html">ao_basis</a></li>
<li class="toctree-l3"><a class="reference internal" href="ao_one_e_ints.html">ao_one_e_integrals</a></li>
<li class="toctree-l3"><a class="reference internal" href="ao_two_e_erf_ints.html">ao_two_e_erf_ints</a></li>
<li class="toctree-l3"><a class="reference internal" href="ao_two_e_ints.html">ao_two_e_ints</a></li>
<li class="toctree-l3"><a class="reference internal" href="aux_quantities.html">aux_quantities</a></li>
<li class="toctree-l3"><a class="reference internal" href="becke_numerical_grid.html">becke_numerical_grid</a></li>
<li class="toctree-l3"><a class="reference internal" href="bitmask.html">bitmask module</a></li>
<li class="toctree-l3"><a class="reference internal" href="cipsi.html">cipsi</a></li>
<li class="toctree-l3"><a class="reference internal" href="cis.html">cis</a></li>
<li class="toctree-l3"><a class="reference internal" href="cisd.html">cisd</a></li>
<li class="toctree-l3"><a class="reference internal" href="davidson.html">davidson</a></li>
<li class="toctree-l3"><a class="reference internal" href="davidson_dressed.html">davidson_dressed</a></li>
<li class="toctree-l3"><a class="reference internal" href="davidson_undressed.html">davidson_undressed</a></li>
<li class="toctree-l3"><a class="reference internal" href="density_for_dft.html">density_for_dft</a></li>
<li class="toctree-l3"><a class="reference internal" href="determinants.html">determinants</a></li>
<li class="toctree-l3"><a class="reference internal" href="dft_keywords.html">dft_keywords</a></li>
<li class="toctree-l3"><a class="reference internal" href="dft_utils_in_r.html">dft_utils_in_r</a></li>
<li class="toctree-l3"><a class="reference internal" href="dft_utils_one_e.html">dft_utils_one_e</a></li>
<li class="toctree-l3"><a class="reference internal" href="dressing.html">dress_zmq</a></li>
<li class="toctree-l3"><a class="reference internal" href="electrons.html">electrons</a></li>
<li class="toctree-l3"><a class="reference internal" href="ezfio_files.html">ezfio_files</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">fci</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#the-user-point-of-view">The user point of view</a></li>
<li class="toctree-l4"><a class="reference internal" href="#the-programmer-point-of-view">The programmer point of view</a></li>
<li class="toctree-l4"><a class="reference internal" href="#ezfio-parameters">EZFIO parameters</a></li>
<li class="toctree-l4"><a class="reference internal" href="#programs">Programs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#providers">Providers</a></li>
<li class="toctree-l4"><a class="reference internal" href="#subroutines-functions">Subroutines / functions</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="generators_cas.html">generators_cas</a></li>
<li class="toctree-l3"><a class="reference internal" href="generators_full.html">generators_full</a></li>
<li class="toctree-l3"><a class="reference internal" href="hartree_fock.html">hartree_fock</a></li>
<li class="toctree-l3"><a class="reference internal" href="iterations.html">iterations</a></li>
<li class="toctree-l3"><a class="reference internal" href="kohn_sham.html">kohn_sham</a></li>
<li class="toctree-l3"><a class="reference internal" href="kohn_sham_rs.html">kohn_sham_rs</a></li>
<li class="toctree-l3"><a class="reference internal" href="mo_basis.html">mo_basis</a></li>
<li class="toctree-l3"><a class="reference internal" href="mo_guess.html">mo_guess</a></li>
<li class="toctree-l3"><a class="reference internal" href="mo_one_e_ints.html">mo_one_e_integrals</a></li>
<li class="toctree-l3"><a class="reference internal" href="mo_two_e_erf_ints.html">mo_two_e_erf_ints</a></li>
<li class="toctree-l3"><a class="reference internal" href="mo_two_e_ints.html">mo_two_e_ints</a></li>
<li class="toctree-l3"><a class="reference internal" href="mpi.html">mpi</a></li>
<li class="toctree-l3"><a class="reference internal" href="nuclei.html">nuclei</a></li>
<li class="toctree-l3"><a class="reference internal" href="perturbation.html">perturbation</a></li>
<li class="toctree-l3"><a class="reference internal" href="pseudo.html">pseudo</a></li>
<li class="toctree-l3"><a class="reference internal" href="psiref_cas.html">psiref_cas</a></li>
<li class="toctree-l3"><a class="reference internal" href="psiref_utils.html">psiref_utils</a></li>
<li class="toctree-l3"><a class="reference internal" href="scf_utils.html">scf_utils</a></li>
<li class="toctree-l3"><a class="reference internal" href="selectors_cassd.html">selectors_cassd</a></li>
<li class="toctree-l3"><a class="reference internal" href="selectors_full.html">selectors_full</a></li>
<li class="toctree-l3"><a class="reference internal" href="selectors_utils.html">selectors_utils</a></li>
<li class="toctree-l3"><a class="reference internal" href="single_ref_method.html">single_ref_method</a></li>
<li class="toctree-l3"><a class="reference internal" href="tools.html">tools</a></li>
<li class="toctree-l3"><a class="reference internal" href="utils.html">utils</a></li>
<li class="toctree-l3"><a class="reference internal" href="zmq.html">zmq</a></li>
<li class="toctree-l3"><a class="reference internal" href="../programmers_guide/qp_name.html">qp_name</a></li>
<li class="toctree-l3"><a class="reference internal" href="../programmers_guide/qp_test.html">qp_test</a></li>
<li class="toctree-l3"><a class="reference internal" href="../programmers_guide/conventions.html">Coding conventions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../programmers_guide/index.html#index-of-providers">Index of Providers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../programmers_guide/index.html#index-of-subroutines-functions">Index of Subroutines/Functions</a></li>
</ul>
</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="../programmers_guide/index.html">Index for programmers</a> &raquo;</li>
<li>fci</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/modules/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="module-fci"></span><h1>fci<a class="headerlink" href="#fci" title="Permalink to this headline"></a></h1>
<p><abbr title="Configuration Interaction using a Perturbative Selection">CIPSI</abbr> algorithm in the full configuration interaction space.</p>
<div class="section" id="the-user-point-of-view">
<h2>The user point of view<a class="headerlink" href="#the-user-point-of-view" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><code class="xref c c-func docutils literal notranslate"><span class="pre">fci()</span></code> performs <abbr title="Configuration Interaction using a Perturbative Selection">CIPSI</abbr> calculations using a stochastic scheme for both the selection and the <abbr title="Second order perturbative correction">PT2</abbr> contribution,</li>
<li><code class="xref c c-func docutils literal notranslate"><span class="pre">pt2()</span></code> computes the <abbr title="Second order perturbative correction">PT2</abbr> contribution using the wave function stored in the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a>
database.</li>
</ul>
<p>The main keywords/options for this module are:</p>
<ul class="simple">
<li><a class="reference internal" href="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> : maximum number of Slater determinants in the CIPSI wave function. The <strong class="command">fci</strong> program will stop when the size of the CIPSI wave function will exceed <a class="reference internal" href="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><a class="reference internal" href="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> : absolute value of the <abbr title="Second order perturbative correction">PT2</abbr> to stop the CIPSI calculation. Once the <abbr title="Second order perturbative correction">PT2</abbr> <span class="math notranslate nohighlight">\(&lt;\)</span> <a class="reference internal" href="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>, the CIPSI calculation stops.</li>
<li><a class="reference internal" href="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> : number of states to consider in the CIPSI calculation.</li>
<li><a class="reference internal" href="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> : if False, starts with a ROHF-like determinant, if True, starts with the current wave function(s) stored in the <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a> folder.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">For a multi-state calculation, it is recommended to start with <code class="xref c c-func docutils literal notranslate"><span class="pre">cis()</span></code> or <code class="xref c c-func docutils literal notranslate"><span class="pre">cisd()</span></code>
wave functions as a guess.</p>
</div>
<ul class="simple">
<li><a class="reference internal" href="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> : if True, systematically add all the determinants needed to have a pure value of <span class="math notranslate nohighlight">\(S^2\)</span>. Also, if True, it tracks only the states having the good <a class="reference internal" href="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>.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">For a multi-state calculation, it is recommended to start with <code class="xref c c-func docutils literal notranslate"><span class="pre">cis()</span></code> or <code class="xref c c-func docutils literal notranslate"><span class="pre">cisd()</span></code>
wave functions as a guess.</p>
</div>
<ul class="simple">
<li><a class="reference internal" href="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> : expected value of <span class="math notranslate nohighlight">\(S^2\)</span> for the desired spin multiplicity.</li>
</ul>
</div>
<div class="section" id="the-programmer-point-of-view">
<h2>The programmer point of view<a class="headerlink" href="#the-programmer-point-of-view" title="Permalink to this headline"></a></h2>
<p>This module have been created with the <span class="xref std std-ref">cipsi</span> module.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last">The documentation of the <span class="xref std std-ref">cipsi</span> module.</p>
</div>
</div>
<div class="section" id="ezfio-parameters">
<h2>EZFIO parameters<a class="headerlink" href="#ezfio-parameters" title="Permalink to this headline"></a></h2>
<dl class="option">
<dt id="cmdoption-fci-arg-energy">
<code class="descname">energy</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-fci-arg-energy" title="Permalink to this definition"></a></dt>
<dd><p>Calculated Selected <abbr title="Full Configuration Interaction">FCI</abbr> energy</p>
</dd></dl>
<dl class="option">
<dt id="cmdoption-fci-arg-energy-pt2">
<code class="descname">energy_pt2</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-fci-arg-energy-pt2" title="Permalink to this definition"></a></dt>
<dd><p>Calculated <abbr title="Full Configuration Interaction">FCI</abbr> energy + <abbr title="Second order perturbative correction">PT2</abbr></p>
</dd></dl>
</div>
<div class="section" id="programs">
<h2>Programs<a class="headerlink" href="#programs" title="Permalink to this headline"></a></h2>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="../programs/fci.html#fci"><span class="std std-ref">fci</span></a></li>
<li><a class="reference internal" href="../programs/pt2.html#pt2"><span class="std std-ref">pt2</span></a></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="providers">
<h2>Providers<a class="headerlink" href="#providers" title="Permalink to this headline"></a></h2>
<dl class="var">
<dt id="c.do_ddci">
<code class="descname">do_ddci</code><a class="headerlink" href="#c.do_ddci" title="Permalink to this definition"></a></dt>
<dd><p>File : <code class="file docutils literal notranslate"><span class="pre">fci/class.irp.f</span></code></p>
<div class="code fortran highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">logical</span> <span class="p">::</span> <span class="n">do_only_1h1p</span>
<span class="n">logical</span> <span class="p">::</span> <span class="n">do_ddci</span>
</pre></div>
</div>
<p>In the FCI case, all those are always false</p>
</dd></dl>
<dl class="var">
<dt id="c.do_only_1h1p">
<code class="descname">do_only_1h1p</code><a class="headerlink" href="#c.do_only_1h1p" title="Permalink to this definition"></a></dt>
<dd><p>File : <code class="file docutils literal notranslate"><span class="pre">fci/class.irp.f</span></code></p>
<div class="code fortran highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">logical</span> <span class="p">::</span> <span class="n">do_only_1h1p</span>
<span class="n">logical</span> <span class="p">::</span> <span class="n">do_ddci</span>
</pre></div>
</div>
<p>In the FCI case, all those are always false</p>
</dd></dl>
</div>
<div class="section" id="subroutines-functions">
<h2>Subroutines / functions<a class="headerlink" href="#subroutines-functions" title="Permalink to this headline"></a></h2>
<dl class="function">
<dt id="c.save_energy:">
<code class="descname">save_energy:</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#c.save_energy:" title="Permalink to this definition"></a></dt>
<dd><p>File : <code class="file docutils literal notranslate"><span class="pre">fci/save_energy.irp.f</span></code></p>
<div class="code fortran highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">subroutine</span> <span class="n">save_energy</span><span class="p">(</span><span class="n">E</span><span class="p">,</span><span class="n">pt2</span><span class="p">)</span>
</pre></div>
</div>
<p>Saves the energy in <a class="reference external" href="http://gitlab.com/scemama/EZFIO">EZFIO</a>.</p>
<p>Needs:</p>
<table class="hlist"><tr><td><ul class="simple">
<li><code class="xref c c-data docutils literal notranslate"><span class="pre">n_states</span></code></li>
</ul>
</td><td><ul class="simple">
</ul>
</td><td><ul class="simple">
</ul>
</td></tr></table>
<p>Called by:</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_stochastic_cipsi()</span></code></li>
</ul>
</td><td><ul class="simple">
</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">ezfio_set_fci_energy()</span></code></li>
</ul>
</td><td><ul class="simple">
<li><code class="xref c c-func docutils literal notranslate"><span class="pre">ezfio_set_fci_energy_pt2()</span></code></li>
</ul>
</td><td><ul class="simple">
</ul>
</td></tr></table>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="generators_cas.html" class="btn btn-neutral float-right" title="generators_cas" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="ezfio_files.html" class="btn btn-neutral" title="ezfio_files" 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>