


<!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>Index &mdash; BGK 0.1 documentation</title>
  

  
  

  

  
  
    

  

  
  
    <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  

  

  
    <link rel="top" title="BGK 0.1 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-scroll">
        <div class="wy-side-nav-search">
          

          
            <a href="index.html" class="icon icon-home"> BGK
          

          
          </a>

          
            
            
              <div class="version">
                0.1
              </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">
          
            
            
                <ul>
<li class="toctree-l1"><a class="reference internal" href="main.html">main</a></li>
<li class="toctree-l1"><a class="reference internal" href="bgk.html">bgk</a></li>
<li class="toctree-l1"><a class="reference internal" href="State.html">State</a></li>
<li class="toctree-l1"><a class="reference internal" href="TestData.html">TestData</a></li>
<li class="toctree-l1"><a class="reference internal" href="Timer.html">Timer</a></li>
<li class="toctree-l1"><a class="reference internal" href="AngularD.html">AngularD</a></li>
<li class="toctree-l1"><a class="reference internal" href="TimeIntegrator.html">TimeIntegrator</a></li>
<li class="toctree-l1"><a class="reference internal" href="Moments.html">Moments</a></li>
<li class="toctree-l1"><a class="reference internal" href="Collision.html">Collision</a></li>
<li class="toctree-l1"><a class="reference internal" href="SpatialDBase.html">SpatialDBase</a></li>
<li class="toctree-l1"><a class="reference internal" href="SpatialDFactory.html">SpatialDFactory</a></li>
<li class="toctree-l1"><a class="reference internal" href="SpatialDFD.html">SpatialDFD</a></li>
<li class="toctree-l1"><a class="reference internal" href="SpatialDFEM.html">SpatialDFEM</a></li>
</ul>

            
          
        </div>
      </div>
    </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="index.html">BGK</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></li>
      <li class="wy-breadcrumbs-aside">
        
          
        
      </li>
  </ul>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            

<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
 <a href="#A"><strong>A</strong></a>
 | <a href="#B"><strong>B</strong></a>
 | <a href="#C"><strong>C</strong></a>
 | <a href="#D"><strong>D</strong></a>
 | <a href="#E"><strong>E</strong></a>
 | <a href="#F"><strong>F</strong></a>
 | <a href="#G"><strong>G</strong></a>
 | <a href="#H"><strong>H</strong></a>
 | <a href="#I"><strong>I</strong></a>
 | <a href="#L"><strong>L</strong></a>
 | <a href="#M"><strong>M</strong></a>
 | <a href="#P"><strong>P</strong></a>
 | <a href="#R"><strong>R</strong></a>
 | <a href="#S"><strong>S</strong></a>
 | <a href="#T"><strong>T</strong></a>
 | <a href="#U"><strong>U</strong></a>
 | <a href="#V"><strong>V</strong></a>
 
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.after_first_plot">after_first_plot (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="AngularD.html#src.AngularD">AngularD (in module src)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="State.html#src.State.apply_ini_bcs2next">apply_ini_bcs2next() (src.State method)</a>
  </dt>

      
  <dt><a href="State.html#src.State.apply_zero_bcs2next">apply_zero_bcs2next() (src.State method)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDBase.html#src.SpatialDBase.B">B (src.SpatialDBase attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.bcs">bcs (src.TestData attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="bgk.html#src.bgk">bgk() (in module src)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="C">C</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDBase.html#src.SpatialDBase.C">C (src.SpatialDBase attribute)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.chiF">chiF (src.Collision attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.chiH">chiH (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision">Collision (class in src)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDBase.html#src.SpatialDBase.D_l">D_l (src.SpatialDBase attribute)</a>
  </dt>

      
  <dt><a href="SpatialDBase.html#src.SpatialDBase.D_r">D_r (src.SpatialDBase attribute)</a>
  </dt>

      
  <dt><a href="SpatialDFactory.html#src.SpatialDFactory.dictionnary">dictionnary (src.SpatialDFactory attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Timer.html#src.Timer.display">display() (src.Timer method)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.domain">domain (src.TestData attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.dx">dx (src.State attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.equation">equation (src.TimeIntegrator attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="State.html#src.State.f">f (src.State attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.f_0">f_0 (src.TestData attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.f_ini">f_ini (src.State attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="State.html#src.State.f_next">f_next (src.State attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.f_prev">f_prev (src.State attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDFactory.html#src.SpatialDFactory.getListOfSchemes">getListOfSchemes() (src.SpatialDFactory method)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="State.html#src.State.h">h (src.State attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.h_ini">h_ini (src.State attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.h_next">h_next (src.State attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.h_prev">h_prev (src.State attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.h_rho">h_rho (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.h_T">h_T (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.h_u">h_u (src.Collision attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.init">init() (src.TimeIntegrator method)</a>
  </dt>

      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.it_max">it_max (src.TimeIntegrator attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.iterate">iterate() (src.TimeIntegrator method)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Timer.html#src.Timer.log">log (src.Timer attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Timer.html#src.Timer.log_counter">log_counter (src.Timer attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Moments.html#src.Moments">Moments (in module src)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.Phi">Phi (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.plot">plot() (src.TestData method)</a>
  </dt>

      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.plot_moments">plot_moments() (src.TimeIntegrator method)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="State.html#src.State.project_f_0">project_f_0() (src.State method)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.Psi">Psi (src.Collision attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDFactory.html#src.SpatialDFactory.registerScheme">registerScheme() (src.SpatialDFactory method)</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer.report">report() (src.Timer method)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.rho">rho (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.rho_0">rho_0 (src.TestData attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDFEM.html#src.SpatialDFEM.scal_source">scal_source() (src.SpatialDFEM method)</a>
  </dt>

      
  <dt><a href="SpatialDFEM.html#src.SpatialDFEM.set_B">set_B() (src.SpatialDFEM method)</a>
  </dt>

      
  <dt><a href="SpatialDFEM.html#src.SpatialDFEM.set_D">set_D() (src.SpatialDFEM method)</a>
  </dt>

      
  <dt><a href="State.html#src.State.settings">settings (src.State attribute)</a>
  </dt>

      
  <dt><a href="SpatialDBase.html#src.SpatialDBase">SpatialDBase (class in src)</a>
  </dt>

      
  <dt><a href="SpatialDBase.html#src.SpatialDBase.SpatialDBase">SpatialDBase() (src.SpatialDBase method)</a>
  </dt>

      
  <dt><a href="SpatialDFactory.html#src.SpatialDFactory">SpatialDFactory (class in src)</a>
  </dt>

      
  <dt><a href="SpatialDFactory.html#src.SpatialDFactory.SpatialDFactory">SpatialDFactory() (src.SpatialDFactory method)</a>
  </dt>

      
  <dt><a href="SpatialDFD.html#src.SpatialDFD">SpatialDFD (class in src)</a>
  </dt>

      
  <dt><a href="SpatialDFD.html#src.SpatialDFD.SpatialDFD">SpatialDFD() (src.SpatialDFD method)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDFEM.html#src.SpatialDFEM">SpatialDFEM (class in src)</a>
  </dt>

      
  <dt><a href="SpatialDFEM.html#src.SpatialDFEM.SpatialDFEM">SpatialDFEM() (src.SpatialDFEM method)</a>
  </dt>

      
  <dt><a href="AngularD.html#module-src">src (module)</a>, <a href="Collision.html#module-src">[1]</a>, <a href="Moments.html#module-src">[2]</a>, <a href="SpatialDBase.html#module-src">[3]</a>, <a href="SpatialDFD.html#module-src">[4]</a>, <a href="SpatialDFEM.html#module-src">[5]</a>, <a href="SpatialDFactory.html#module-src">[6]</a>, <a href="State.html#module-src">[7]</a>, <a href="TestData.html#module-src">[8]</a>, <a href="TimeIntegrator.html#module-src">[9]</a>, <a href="Timer.html#module-src">[10]</a>, <a href="bgk.html#module-src">[11]</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer.start">start() (src.Timer method)</a>
  </dt>

      
  <dt><a href="State.html#src.State">State (class in src)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.state">state (src.Collision attribute)</a>
  </dt>

      <dd><dl>
        
  <dt><a href="SpatialDBase.html#src.SpatialDBase.state">(src.SpatialDBase attribute)</a>
  </dt>

        
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.state">(src.TimeIntegrator attribute)</a>
  </dt>

      </dl></dd>
      
  <dt><a href="State.html#src.State.State">State() (src.State method)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.subplot_rho">subplot_rho (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.subplot_T">subplot_T (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="Collision.html#src.Collision.subplot_u">subplot_u (src.Collision attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.T">T (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.T_0">T_0 (src.TestData attribute)</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer.t_end">t_end (src.Timer attribute)</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer.t_ini">t_ini (src.Timer attribute)</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer.t_total">t_total (src.Timer attribute)</a>
  </dt>

      
  <dt><a href="State.html#src.State.test">test (src.State attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData">TestData (class in src)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="TestData.html#src.TestData.TestData">TestData() (src.TestData method)</a>
  </dt>

      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.time_now">time_now (src.TimeIntegrator attribute)</a>
  </dt>

      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator">TimeIntegrator (class in src)</a>
  </dt>

      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.TimeIntegrator">TimeIntegrator() (src.TimeIntegrator method)</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer">Timer (class in src)</a>
  </dt>

      
  <dt><a href="Timer.html#src.Timer.Timer">Timer() (src.Timer method)</a>
  </dt>

      
  <dt><a href="TimeIntegrator.html#src.TimeIntegrator.tol">tol (src.TimeIntegrator attribute)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Collision.html#src.Collision.u">u (src.Collision attribute)</a>
  </dt>

      
  <dt><a href="TestData.html#src.TestData.u_0">u_0 (src.TestData attribute)</a>
  </dt>

  </dl></td>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="SpatialDFEM.html#src.SpatialDFEM.update_C">update_C() (src.SpatialDFEM method)</a>
  </dt>

  </dl></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%" valign="top"><dl>
      
  <dt><a href="Timer.html#src.Timer.verb">verb (src.Timer attribute)</a>
  </dt>

  </dl></td>
</tr></table>



           </div>
          </div>
          <footer>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2016, Sebastian Gonzalez Pintor.

    </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:'0.1',
            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/js/theme.js"></script>
  

  
  
  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.StickyNav.enable();
      });
  </script>
   

</body>
</html>