Merge branch 'master' of github.com:harpolea/r3d2

Author: harpolea

docs/conf.py

@@ -43,6 +43,7 @@
 extensions = [
     'nbsphinx',
     'sphinx.ext.mathjax', 'sphinx.ext.autodoc',
+    'IPython.sphinxext.ipython_console_highlighting',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/index.rst

@@ -6,16 +6,21 @@
 Welcome to R3D2's documentation!
 ================================
 
+R3D2 (Relativistic Reactive Riemann problem solver for Deflagrations and Detonations) solves the Riemann problem for the *relativistic* Euler equation. It also includes the option to include reaction terms, for "infinitely" fast reactions, leading to deflagrations and detonations.
+
+This code is intended for exploring possible solutions and relativistic effects, or for comparing against a compressible code with reactive sources. It is optimized for use with Jupyter notebooks. It is **not** intended for use within a HRSC code: the performance is far too poor, and the assumptions made to extreme.
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
+   riemann_problem
    eos_defns.rst
    states
    waves
-   riemann_problem
    tangential_change
+   p_v_plots
 
 Indices and tables
 ==================

docs/p_v_plots.ipynb

@@ -8,9 +8,9 @@
     "\n",
     "A Riemann Problem is specified by the state of the material to the left and right of the interface. In this hydrodynamic problem, the state is fully determined by an [equation of state](eos_defns.html) and the variables\n",
     "\n",
-    "\\begin{equation}\n",
+    "$$\n",
     "  {\\bf U} = \\begin{pmatrix} \\rho_0 \\\\ v_x \\\\ v_t \\\\ \\epsilon \\end{pmatrix},\n",
-    "\\end{equation}\n",
+    "$$\n",
     "\n",
     "where $\\rho_0$ is the rest-mass density, $v_x$ the velocity normal to the interface, $v_t$ the velocity tangential to the interface, and $\\epsilon$ the specific internal energy."
    ]
@@ -72,7 +72,7 @@
        "$\\begin{pmatrix} \\rho \\\\ v_x \\\\ v_t \\\\ \\epsilon \\end{pmatrix}= \\begin{pmatrix} 1.0000 \\\\ 0.1000 \\\\ 0.0000 \\\\ 2.0000 \\end{pmatrix}$"
       ],
       "text/plain": [
-       "<r3d2.state.State at 0x10faae6a0>"
+       "<r3d2.state.State at 0x10c556d68>"
       ]
      },
      "execution_count": 3,
@@ -104,7 +104,7 @@
        "$\\begin{pmatrix} \\rho \\\\ v_x \\\\ v_t \\\\ \\epsilon \\end{pmatrix}_{L} = \\begin{pmatrix} 10.0000 \\\\ -0.3000 \\\\ 0.1000 \\\\ 5.0000 \\end{pmatrix}$"
       ],
       "text/plain": [
-       "<r3d2.state.State at 0x10faaea20>"
+       "<r3d2.state.State at 0x10c57b160>"
       ]
      },
      "execution_count": 4,
@@ -139,7 +139,7 @@
        "$\\begin{pmatrix} \\rho \\\\ v_x \\\\ v_t \\\\ \\epsilon \\\\ q \\end{pmatrix}_{Reactive} = \\begin{pmatrix} 5.0000 \\\\ 0.1000 \\\\ 0.1000 \\\\ 2.0000 \\\\ 0.1000 \\end{pmatrix}$"
       ],
       "text/plain": [
-       "<r3d2.state.State at 0x10faaeef0>"
+       "<r3d2.state.State at 0x10c57b630>"
       ]
      },
      "execution_count": 5,

docs/riemann_problem.ipynb

@@ -165,7 +165,7 @@
        "$\\begin{pmatrix} \\rho \\\\ v_x \\\\ v_t \\\\ \\epsilon \\end{pmatrix}_{known} = \\begin{pmatrix} 1.0000 \\\\ 0.1000 \\\\ 0.0500 \\\\ 0.2000 \\end{pmatrix}$"
       ],
       "text/plain": [
-       "<r3d2.state.State at 0x7f50a35c4410>"
+       "<r3d2.state.State at 0x10c581eb8>"
       ]
      },
      "execution_count": 2,
@@ -218,7 +218,7 @@
        "${\\cal S}_{\\leftarrow}: \\lambda^{(0)}= -0.9614$"
       ],
       "text/plain": [
-       "<r3d2.wave.Wave at 0x7f50a35c48d0>"
+       "<r3d2.wave.Wave at 0x10c5a4390>"
       ]
      },
      "execution_count": 4,
@@ -250,7 +250,7 @@
        "${\\cal R}_{\\leftarrow}: \\lambda^{(0)}\\in [-0.3209, -0.2383]$"
       ],
       "text/plain": [
-       "<r3d2.wave.Wave at 0x7f50a35c4350>"
+       "<r3d2.wave.Wave at 0x10c5a4278>"
       ]
      },
      "execution_count": 5,
@@ -282,7 +282,7 @@
        "${\\cal S}_{\\rightarrow}: \\lambda^{(2)}= 0.9978$"
       ],
       "text/plain": [
-       "<r3d2.wave.Wave at 0x7f50a35c41d0>"
+       "<r3d2.wave.Wave at 0x10c5a45f8>"
       ]
      },
      "execution_count": 6,
@@ -315,7 +315,7 @@
        "${\\cal C}: \\lambda^{(1)}= 0.1000$"
       ],
       "text/plain": [
-       "<r3d2.wave.Wave at 0x7f50a35da210>"
+       "<r3d2.wave.Wave at 0x10c5a4cf8>"
       ]
      },
      "execution_count": 7,
@@ -350,7 +350,7 @@
        "$\\begin{pmatrix} \\rho \\\\ v_x \\\\ v_t \\\\ \\epsilon \\\\ q \\end{pmatrix}= \\begin{pmatrix} 5.0000 \\\\ 0.0000 \\\\ 0.0000 \\\\ 2.0000 \\\\ 0.1000 \\end{pmatrix}$"
       ],
       "text/plain": [
-       "<r3d2.state.State at 0x10faad320>"
+       "<r3d2.state.State at 0x10c5a4a20>"
       ]
      },
      "execution_count": 8,
@@ -403,7 +403,7 @@
        "${\\cal SDT}_{\\leftarrow}: \\lambda^{(0)}= -0.7979$"
       ],
       "text/plain": [
-       "<r3d2.wave.Wave at 0x10faad2b0>"
+       "<r3d2.wave.Wave at 0x10c5a4b38>"
       ]
      },
      "execution_count": 10,
@@ -435,7 +435,7 @@
        "$\\left({\\cal CJDF}_{\\leftarrow}{\\cal R}_{\\leftarrow}\\right) : \\lambda^{(0)}\\in [-0.6097, 0.7607]$"
       ],
       "text/plain": [
-       "<r3d2.wave.Wave at 0x10faad198>"
+       "<r3d2.wave.Wave at 0x10c5a49b0>"
       ]
      },
      "execution_count": 11,

docs/states.ipynb

@@ -57,7 +57,7 @@ def find_delta_v(p_star_guess):
             find_delta_v(pmax_rootfind)
         except ValueError:
             pmax_rootfind = pmax
-        
+
         self.p_star = brentq(find_delta_v, pmin_rootfind, pmax_rootfind)
         wave_l = Wave(self.state_l, self.p_star, 0)
         wave_r = Wave(self.state_r, self.p_star, 2)
@@ -67,7 +67,7 @@ def find_delta_v(p_star_guess):
                       Wave(self.state_star_l, self.state_star_r, 1), wave_r]
 
     def _figure_data(self, format):
-        fig, axs = pyplot.subplots(3,3)
+        fig, axs = pyplot.subplots(3,3, figsize=(10,6))
         ax = axs[0,0]
         for w in self.waves[0], self.waves[2]:
             if len(w.wavespeed)==1:

docs/tangential_change.ipynb

@@ -1,7 +1,2 @@
-numpy
-matplotlib>=1.5
-scipy>=0.10
-IPython>=3
 nbsphinx
 ipykernel
-setuptools>=18.5