python_tutorial.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Cantera Tutorial: Python"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Getting Started"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "collapsed": true
   },
   "source": [
    "Open a new Jupyter Notebook. If unfamiliar with Jupyter Notebooks see the [Jupyter Documentation](https://jupyter.readthedocs.io/en/latest/install.html) for installation and basic use instructions. Import the Cantera Python module and NumPy by running:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "import cantera as ct\n",
    "import numpy as np"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": []
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "When using Cantera, the first thing you usually need is an object representing some phase of matter. Here, we'll create a gas mixture:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 3,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1 = ct.Solution('gri30.xml')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To view the state of the mixture, *call* the `gas1` object as if it were a function:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 4,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "  gri30:\n",
      "\n",
      "       temperature             300  K\n",
      "          pressure          101325  Pa\n",
      "           density       0.0818891  kg/m^3\n",
      "  mean mol. weight         2.01588  amu\n",
      "\n",
      "                          1 kg            1 kmol\n",
      "                       -----------      ------------\n",
      "          enthalpy           26470        5.336e+04     J\n",
      "   internal energy     -1.2109e+06       -2.441e+06     J\n",
      "           entropy           64914        1.309e+05     J/K\n",
      "    Gibbs function     -1.9448e+07        -3.92e+07     J\n",
      " heat capacity c_p           14312        2.885e+04     J/K\n",
      " heat capacity c_v           10187        2.054e+04     J/K\n",
      "\n",
      "                           X                 Y          Chem. Pot. / RT\n",
      "                     -------------     ------------     ------------\n",
      "                H2              1                1         -15.7173\n",
      "     [  +52 minor]              0                0\n",
      "\n"
     ]
    }
   ],
   "source": [
    "gas1()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "What you have just done is created an object `gas1` that implements GRI-Mech 3.0, the 53-species, 325-reaction natural gas combustion mechanism developed by Gregory P. Smith, David M. Golden, Michael Frenklach, Nigel W. Moriarty, Boris Eiteneer, Mikhail Goldenberg, C. Thomas Bowman, Ronald K. Hanson, Soonho Song, William C. Gardiner, Jr., Vitali V. Lissianski, and Zhiwei Qin.  See the [GRI-Mech Home Page](http://combustion.berkeley.edu/gri-mech/) for more information.\n",
    "\n",
    "The `gas1` object has properties you would expect for a gas mixture: a temperature, a pressure, species mole and mass fractions, etc. As we will soon see, it has many more properties.\n",
    "\n",
    "The summary of the state of `gas1` that you found above shows that the new objects created from the `gri30.xml` input file start out with a temperature of 300 K, a pressure of 1 atm, and have a composition that consists of only one species, in this case hydrogen. There is nothing special about H2 - it just happens to be the first species listed in the input file defining GRI-Mech 3.0. In general, whichever species is listed first will initially have a mole fraction of 1.0, and all others will be zero."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Setting the State"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The state of the object can easily be changed. For example:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 5,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.TP = 1200, 101325"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "sets the temperature to 1200 K and the pressure to 101325 Pa (Cantera always uses SI Units). After this statement, calling `gas1()` results in:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 6,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "  gri30:\n",
      "\n",
      "       temperature            1200  K\n",
      "          pressure          101325  Pa\n",
      "           density       0.0204723  kg/m^3\n",
      "  mean mol. weight         2.01588  amu\n",
      "\n",
      "                          1 kg            1 kmol\n",
      "                       -----------      ------------\n",
      "          enthalpy      1.3296e+07         2.68e+07     J\n",
      "   internal energy      8.3462e+06        1.682e+07     J\n",
      "           entropy           85228        1.718e+05     J/K\n",
      "    Gibbs function     -8.8978e+07       -1.794e+08     J\n",
      " heat capacity c_p           15378          3.1e+04     J/K\n",
      " heat capacity c_v           11253        2.269e+04     J/K\n",
      "\n",
      "                           X                 Y          Chem. Pot. / RT\n",
      "                     -------------     ------------     ------------\n",
      "                H2              1                1         -17.9775\n",
      "     [  +52 minor]              0                0\n",
      "\n"
     ]
    }
   ],
   "source": [
    "gas1()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Notice that the temperature has been changed as requested, but the pressure has changed too. The density and the composition have not.\n",
    "\n",
    "Thermodynamics generally requires that *two* properties in addition to composition information be specified to fix the intensive state of a substance (or mixture). The state of the mixture can be set using several combinations of two properties. The following are all equivalent:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.TP = 1200, 101325            # temperature, pressure\n",
    "gas1.TD = 1200, 0.0204723         # temperature, density\n",
    "gas1.HP = 1.32956e7, 101325       # specific enthalpy, pressure\n",
    "gas1.UV = 8.34619e6, 1/0.0204723  # specific internal energy, specific volume\n",
    "gas1.SP = 85227.6, 101325         # specific entropy, pressure\n",
    "gas1.SV = 85227.6, 1/0.0204723    # specific entropy, specific volume"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.basis = 'mass'"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In each case, the values of the intensive properties must be entered *per unit mass*.\n",
    "\n",
    "Properties may be read independently, such as"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 9,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "1200.0044548350836"
      ]
     },
     "execution_count": 9,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "gas1.T"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "or"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 10,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "13295636.190310445"
      ]
     },
     "execution_count": 10,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "gas1.h"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "or together:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 11,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "(8346238.627182945, 48.84649013545132)"
      ]
     },
     "execution_count": 11,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "gas1.UV"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The composition can be set in terms of either mole fractions (`X`) or mass fractions (`Y`):"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 12,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.X = 'CH4:1, O2:2, N2:7.52'"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Mass and mole fractions can also be set using the `dict` object, for cases where the composition is stored in a variable or being computed:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 13,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "phi = 0.8\n",
    "gas1.X = {'CH4':1, 'O2':2/phi, 'N2': 2*3.76/phi}"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 14,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.set_equivalence_ratio(phi, 'CH4:1, C3H8:1', 'O2:1, N2:3.76')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "When the composition alone is changed, the temperature and density are held constant. This means that the pressure and other intensive properties will change. The composition can also be set in conjunction with the intensive properties of the mixture:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 15,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "  gri30:\n",
      "\n",
      "       temperature            1200  K\n",
      "          pressure          101325  Pa\n",
      "           density        0.280629  kg/m^3\n",
      "  mean mol. weight         27.6332  amu\n",
      "\n",
      "                          1 kg            1 kmol\n",
      "                       -----------      ------------\n",
      "          enthalpy      8.6194e+05        2.382e+07     J\n",
      "   internal energy      5.0088e+05        1.384e+07     J\n",
      "           entropy          8914.3        2.463e+05     J/K\n",
      "    Gibbs function     -9.8352e+06       -2.718e+08     J\n",
      " heat capacity c_p          1397.3        3.861e+04     J/K\n",
      " heat capacity c_v          1096.4         3.03e+04     J/K\n",
      "\n",
      "                           X                 Y          Chem. Pot. / RT\n",
      "                     -------------     ------------     ------------\n",
      "                O2       0.190114         0.220149         -28.7472\n",
      "               CH4       0.095057        0.0551863          -35.961\n",
      "                N2       0.714829         0.724665         -25.6789\n",
      "     [  +50 minor]              0                0\n",
      "\n"
     ]
    }
   ],
   "source": [
    "gas1.TPX = 1200, 101325, 'CH4:1, O2:2, N2:7.52'\n",
    "gas1()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The composition above was specified using a string. The format is a comma-separated list of `<species name>:<relative mole numbers>` pairs. The mole numbers will be normalized to produce the mole fractions, and therefore they are \"relative\" mole numbers. Mass fractions can be set this way too by changing `X` to `Y` in the above statements.\n",
    "\n",
    "The composition can also be set using an array, which must have the same size as the number of species. For example, to set all 53 mole fractions to the same value, do this:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 39,
   "metadata": {},
   "outputs": [],
   "source": [
    "nsp = gas1.n_species\n",
    "gas1.X = np.ones(nsp)  # NumPy array of 53 ones"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Or, to set all the mass fractions to equal values:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.Y = np.ones(nsp)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "When setting the state, you can control what properties are held constant by passing the special value `None` to the property setter. For example, to change the specific volume to 2.1 m<sup>3</sup>/kg while holding entropy constant:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 23,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.SV = None, 2.1"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Or to set the mass fractions while holding temperature and pressure constant:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 24,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas1.TPX = None, None, 'CH4:1.0, O2:0.5'"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Working with a Subset of Species"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 25,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[<Species H2>, <Species H>, <Species O>, <Species O2>, <Species OH>, <Species H2O>, <Species HO2>, <Species H2O2>, <Species C>, <Species CH>, <Species CH2>, <Species CH2(S)>, <Species CH3>, <Species CH4>, <Species CO>, <Species CO2>, <Species HCO>, <Species CH2O>, <Species CH2OH>, <Species CH3O>, <Species CH3OH>, <Species C2H>, <Species C2H2>, <Species C2H3>, <Species C2H4>, <Species C2H5>, <Species C2H6>, <Species HCCO>, <Species CH2CO>, <Species HCCOH>, <Species N>, <Species NH>, <Species NH2>, <Species NH3>, <Species NNH>, <Species NO>, <Species NO2>, <Species N2O>, <Species HNO>, <Species CN>, <Species HCN>, <Species H2CN>, <Species HCNN>, <Species HCNO>, <Species HOCN>, <Species HNCO>, <Species NCO>, <Species N2>, <Species AR>, <Species C3H7>, <Species C3H8>, <Species CH2CHO>, <Species CH3CHO>]\n"
     ]
    }
   ],
   "source": [
    "print(gas1.species())"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Many properties of a [`Solution`](http://cantera.github.io/docs/sphinx/html/cython/importing.html#cantera.Solution) provide values for each species present in the phase. If you want to get values only for a subset of these species, you can use Python's \"slicing\" syntax to select data for just the species of interest. To get the mole fractions of just the major species in `gas1`, in the order specified, you can write:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 26,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[ 0.66666667  0.33333333  0.          0.          0.        ]\n"
     ]
    }
   ],
   "source": [
    "Xmajor = gas1['CH4','O2','CO2','H2O','N2'].X\n",
    "print(Xmajor)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If you want to use the same set of species repeatedly, you can keep a reference to the sliced phase object:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 27,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[-0.01562118 -0.01468203  0.          0.          0.        ]\n"
     ]
    }
   ],
   "source": [
    "major = gas1['CH4','O2','CO2','H2O','N2']\n",
    "cp_major = major.partial_molar_cp\n",
    "wdot_major = major.net_production_rates\n",
    "print(wdot_major)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The slice object and the original object share the same internal state, so modifications to one will affect the other."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 30,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "[ -8.65079182e-06  -8.53258797e-06   0.00000000e+00   0.00000000e+00\n",
      "  -3.28511272e-13]\n",
      "[ 0.09505703  0.19011407  0.          0.          0.7148289 ]\n"
     ]
    }
   ],
   "source": [
    "gas1.TPX = 1200, 101325, 'CH4:1, N2:7.52, O2:2'\n",
    "print(major.net_production_rates)\n",
    "print(major.X)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Working with Mechanism Files"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In the previous example, we created an object that models an ideal gas mixture with the species and reactions of GRI-Mech 3.0, using the `gri30.xml` input file included with Cantera. This is a \"pre-processed\" XML input file written in a format that is easy for Cantera to parse, but hard for humans to write. Cantera also supports an input file format that is easier for humans to write, called *CTI*. Several reaction mechanism files in this format are included with Cantera, including ones that model high-temperature air, a hydrogen/oxygen reaction mechanism, and a few surface reaction mechanisms. These files are usually located in the `data` subdirectory of the Cantera installation directory, e.g. `C:\\\\Program Files\\\\Cantera\\\\data` on Windows or `/usr/local/cantera/data/` on Unix/Linux/Mac OS X machines, depending on how you installed Cantera and the options you specified.\n",
    "\n",
    "If, for some reason, Cantera has difficulty finding where these files are on your system, set environment variable `CANTERA_DATA` to the directory or directories (separated using `;` on Windows or `:` on other operating systems) where they are located. Alternatively, you can call function [`add_directory`](http://cantera.github.io/docs/sphinx/html/cython/importing.html#cantera.add_directory) to add a directory to the Cantera search path:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 31,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "ct.add_directory('/usr/local/cantera/my_data_files')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Cantera input files are plain text files, and can be created with any text editor. See the document *[Defining Phases](http://cantera.github.io/docs/sphinx/html/cti/index.html#sec-defining-phases)* for more information.\n",
    "\n",
    "A Cantera input file may contain more than one phase specification, or may contain specifications of interfaces (surfaces). Here, we import definitions of two bulk phases and the interface between them from the file `diamond.cti`:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 32,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "gas2 = ct.Solution('diamond.cti', 'gas')\n",
    "diamond = ct.Solution('diamond.cti', 'diamond')\n",
    "diamond_surf = ct.Interface('diamond.cti', 'diamond_100', [gas2, diamond])"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Note that the bulk (i.e., 3D or homogenous) phases that participate in the surface reactions must also be passed as arguments to [`Interface`](http://cantera.github.io/docs/sphinx/html/cython/importing.html#cantera.Interface)."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Converting CK-format files"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "See *[Converting CK-format files](http://cantera.github.io/docs/sphinx/html/cti/input-files.html#sec-ck-format-conversion)* in the *[Working with Input Files](http://cantera.github.io/docs/sphinx/html/cti/input-files.html#sec-input-files)* documentation."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Getting Help"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In addition to the Sphinx-generated *[Python Module Documentation](http://cantera.github.io/docs/sphinx/html/cython/index.html#sec-cython-documentation)*, documentation of the Python classes and their methods can be accessed from within the Python interpreter as well.\n",
    "\n",
    "Suppose you have created a Cantera object and want to know what methads are avialable for it, and get help on using the methods:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 33,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g = ct.Solution('gri30.xml')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To get help on the Python class that this object is an instance of, put a question mark `?` after the variable:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 34,
   "metadata": {},
   "outputs": [],
   "source": [
    "g?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For a simple list of the properties and methods of this object:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 35,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "['DP',\n",
       " 'DPX',\n",
       " 'DPY',\n",
       " 'HP',\n",
       " 'HPX',\n",
       " 'HPY',\n",
       " 'ID',\n",
       " 'P',\n",
       " 'P_sat',\n",
       " 'SP',\n",
       " 'SPX',\n",
       " 'SPY',\n",
       " 'SV',\n",
       " 'SVX',\n",
       " 'SVY',\n",
       " 'T',\n",
       " 'TD',\n",
       " 'TDX',\n",
       " 'TDY',\n",
       " 'TP',\n",
       " 'TPX',\n",
       " 'TPY',\n",
       " 'T_sat',\n",
       " 'UV',\n",
       " 'UVX',\n",
       " 'UVY',\n",
       " 'X',\n",
       " 'Y',\n",
       " '__call__',\n",
       " '__class__',\n",
       " '__copy__',\n",
       " '__delattr__',\n",
       " '__dir__',\n",
       " '__doc__',\n",
       " '__eq__',\n",
       " '__format__',\n",
       " '__ge__',\n",
       " '__getattribute__',\n",
       " '__getitem__',\n",
       " '__gt__',\n",
       " '__hash__',\n",
       " '__init__',\n",
       " '__init_subclass__',\n",
       " '__le__',\n",
       " '__lt__',\n",
       " '__module__',\n",
       " '__ne__',\n",
       " '__new__',\n",
       " '__pyx_vtable__',\n",
       " '__reduce__',\n",
       " '__reduce_ex__',\n",
       " '__repr__',\n",
       " '__setattr__',\n",
       " '__sizeof__',\n",
       " '__slots__',\n",
       " '__str__',\n",
       " '__subclasshook__',\n",
       " '_check_kinetics_species_index',\n",
       " '_check_phase_index',\n",
       " '_check_reaction_index',\n",
       " '_full_states',\n",
       " '_init_cti_xml',\n",
       " '_init_parts',\n",
       " '_references',\n",
       " 'activities',\n",
       " 'activity_coefficients',\n",
       " 'add_reaction',\n",
       " 'add_species',\n",
       " 'atomic_weight',\n",
       " 'atomic_weights',\n",
       " 'basis',\n",
       " 'binary_diff_coeffs',\n",
       " 'chemical_potentials',\n",
       " 'concentrations',\n",
       " 'cp',\n",
       " 'cp_mass',\n",
       " 'cp_mole',\n",
       " 'creation_rates',\n",
       " 'critical_density',\n",
       " 'critical_pressure',\n",
       " 'critical_temperature',\n",
       " 'cv',\n",
       " 'cv_mass',\n",
       " 'cv_mole',\n",
       " 'delta_enthalpy',\n",
       " 'delta_entropy',\n",
       " 'delta_gibbs',\n",
       " 'delta_standard_enthalpy',\n",
       " 'delta_standard_entropy',\n",
       " 'delta_standard_gibbs',\n",
       " 'density',\n",
       " 'density_mass',\n",
       " 'density_mole',\n",
       " 'destruction_rates',\n",
       " 'electric_potential',\n",
       " 'electrical_conductivity',\n",
       " 'electrochemical_potentials',\n",
       " 'element_index',\n",
       " 'element_name',\n",
       " 'element_names',\n",
       " 'element_potentials',\n",
       " 'elemental_mass_fraction',\n",
       " 'elemental_mole_fraction',\n",
       " 'enthalpy_mass',\n",
       " 'enthalpy_mole',\n",
       " 'entropy_mass',\n",
       " 'entropy_mole',\n",
       " 'equilibrate',\n",
       " 'equilibrium_constants',\n",
       " 'forward_rate_constants',\n",
       " 'forward_rates_of_progress',\n",
       " 'g',\n",
       " 'gibbs_mass',\n",
       " 'gibbs_mole',\n",
       " 'h',\n",
       " 'int_energy_mass',\n",
       " 'int_energy_mole',\n",
       " 'is_reversible',\n",
       " 'isothermal_compressibility',\n",
       " 'kinetics_species_index',\n",
       " 'mass_fraction_dict',\n",
       " 'max_temp',\n",
       " 'mean_molecular_weight',\n",
       " 'min_temp',\n",
       " 'mix_diff_coeffs',\n",
       " 'mix_diff_coeffs_mass',\n",
       " 'mix_diff_coeffs_mole',\n",
       " 'modify_reaction',\n",
       " 'modify_species',\n",
       " 'mole_fraction_dict',\n",
       " 'molecular_weights',\n",
       " 'multi_diff_coeffs',\n",
       " 'multiplier',\n",
       " 'n_atoms',\n",
       " 'n_elements',\n",
       " 'n_phases',\n",
       " 'n_reactions',\n",
       " 'n_selected_species',\n",
       " 'n_species',\n",
       " 'n_total_species',\n",
       " 'name',\n",
       " 'net_production_rates',\n",
       " 'net_rates_of_progress',\n",
       " 'partial_molar_cp',\n",
       " 'partial_molar_enthalpies',\n",
       " 'partial_molar_entropies',\n",
       " 'partial_molar_int_energies',\n",
       " 'partial_molar_volumes',\n",
       " 'product_stoich_coeff',\n",
       " 'product_stoich_coeffs',\n",
       " 'products',\n",
       " 'reactant_stoich_coeff',\n",
       " 'reactant_stoich_coeffs',\n",
       " 'reactants',\n",
       " 'reaction',\n",
       " 'reaction_equation',\n",
       " 'reaction_equations',\n",
       " 'reaction_phase_index',\n",
       " 'reaction_type',\n",
       " 'reactions',\n",
       " 'reference_pressure',\n",
       " 'report',\n",
       " 'reverse_rate_constants',\n",
       " 'reverse_rates_of_progress',\n",
       " 's',\n",
       " 'selected_species',\n",
       " 'set_equivalence_ratio',\n",
       " 'set_multiplier',\n",
       " 'set_unnormalized_mass_fractions',\n",
       " 'set_unnormalized_mole_fractions',\n",
       " 'species',\n",
       " 'species_index',\n",
       " 'species_name',\n",
       " 'species_names',\n",
       " 'standard_cp_R',\n",
       " 'standard_enthalpies_RT',\n",
       " 'standard_entropies_R',\n",
       " 'standard_gibbs_RT',\n",
       " 'standard_int_energies_RT',\n",
       " 'state',\n",
       " 'thermal_conductivity',\n",
       " 'thermal_diff_coeffs',\n",
       " 'thermal_expansion_coeff',\n",
       " 'transport_model',\n",
       " 'u',\n",
       " 'v',\n",
       " 'viscosity',\n",
       " 'volume_mass',\n",
       " 'volume_mole']"
      ]
     },
     "execution_count": 35,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "dir(g)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To get help on a specific method, e.g. the `species_index` method:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 41,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g.species_index?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "For properties, getting the documentation is slightly trickier, as the usual method will give you help for the *result*, e.g.:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 42,
   "metadata": {
    "collapsed": true,
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "g.T?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "provides help on Python's `float` class. To get the help for the temperature property, ask for the attribute of the class object itself:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 43,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g.__class__.T?"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Help can also be obtained using the `help` function:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 37,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Help on built-in function species_index:\n",
      "\n",
      "species_index(...) method of cantera.composite.Solution instance\n",
      "    ThermoPhase.species_index(self, species) -> int\n",
      "    \n",
      "    The index of species *species*, which may be specified as a string or\n",
      "    an integer. In the latter case, the index is checked for validity and\n",
      "    returned. If no such species is present, an exception is thrown.\n",
      "\n"
     ]
    }
   ],
   "source": [
    "help(g.species_index)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Chemical Equilibrium"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "To set a gas mixture to a state of chemical equilibrium, use the `equilibrate` method:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 39,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "  gri30:\n",
      "\n",
      "       temperature             300  K\n",
      "          pressure          101325  Pa\n",
      "           density         1.12477  kg/m^3\n",
      "  mean mol. weight         27.6886  amu\n",
      "\n",
      "                          1 kg            1 kmol\n",
      "                       -----------      ------------\n",
      "          enthalpy     -2.8724e+06       -7.953e+07     J\n",
      "   internal energy     -2.9624e+06       -8.203e+07     J\n",
      "           entropy          7226.7        2.001e+05     J/K\n",
      "    Gibbs function     -5.0404e+06       -1.396e+08     J\n",
      " heat capacity c_p          1106.5        3.064e+04     J/K\n",
      " heat capacity c_v          806.22        2.232e+04     J/K\n",
      "\n",
      "                           X                 Y          Chem. Pot. / RT\n",
      "                     -------------     ------------     ------------\n",
      "                O2      0.0095511        0.0110379         -29.3248\n",
      "               H2O       0.181471         0.118072         -121.367\n",
      "               CO2      0.0907354          0.14422         -185.873\n",
      "               NO2    6.06037e-12      1.00695e-11         -41.0069\n",
      "                N2       0.718243          0.72667         -23.3641\n",
      "     [  +48 minor]    4.75341e-17      5.15425e-17\n",
      "\n"
     ]
    }
   ],
   "source": [
    "g = ct.Solution('gri30.xml')\n",
    "g.TPX = 300.0, ct.one_atm, 'CH4:0.95, O2:2, N2:7.52'\n",
    "g.equilibrate('TP')\n",
    "g()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The above statement sets the state of object `g` to the state of chemical equilibrium holding temperature and pressure fixed. Alternatively, the specific enthalpy and pressure can be held fixed:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 40,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "\n",
      "  gri30:\n",
      "\n",
      "       temperature         2188.95  K\n",
      "          pressure          101325  Pa\n",
      "           density        0.153491  kg/m^3\n",
      "  mean mol. weight         27.5699  amu\n",
      "\n",
      "                          1 kg            1 kmol\n",
      "                       -----------      ------------\n",
      "          enthalpy     -2.4244e+05       -6.684e+06     J\n",
      "   internal energy     -9.0258e+05       -2.488e+07     J\n",
      "           entropy          9804.2        2.703e+05     J/K\n",
      "    Gibbs function     -2.1703e+07       -5.984e+08     J\n",
      " heat capacity c_p          1500.5        4.137e+04     J/K\n",
      " heat capacity c_v            1199        3.306e+04     J/K\n",
      "\n",
      "                           X                 Y          Chem. Pot. / RT\n",
      "                     -------------     ------------     ------------\n",
      "                H2     0.00183219      0.000133967         -26.0724\n",
      "                 H    0.000226589      8.28395e-06         -13.0362\n",
      "                 O    0.000259255      0.000150451         -16.8188\n",
      "                O2      0.0106002         0.012303         -33.6375\n",
      "                OH       0.003003       0.00185249          -29.855\n",
      "               H2O       0.177246         0.115819         -42.8912\n",
      "               HO2    8.09373e-07      9.68982e-07         -46.6737\n",
      "              H2O2    6.05342e-08      7.46847e-08           -59.71\n",
      "                CO     0.00464094       0.00471509         -39.4619\n",
      "               CO2      0.0857056         0.136812         -56.2807\n",
      "               HCO    2.55305e-10      2.68718e-10         -52.4981\n",
      "              CH2O    3.46769e-12      3.77665e-12         -65.5343\n",
      "                 N    9.26414e-09      4.70659e-09         -13.7885\n",
      "                NH    1.22315e-09      6.66131e-10         -26.8247\n",
      "               NH2    4.05215e-10      2.35496e-10         -39.8609\n",
      "               NH3    1.02612e-09      6.33857e-10         -52.8971\n",
      "               NNH    4.33561e-10      4.56387e-10         -40.6132\n",
      "                NO     0.00264269       0.00287621         -30.6072\n",
      "               NO2    7.71447e-07       1.2873e-06          -47.426\n",
      "               N2O    1.40895e-07      2.24926e-07         -44.3957\n",
      "               HNO    3.31157e-08      3.72526e-08         -43.6434\n",
      "                CN    1.40828e-14      1.32899e-14         -36.4316\n",
      "               HCN    3.76929e-12      3.69488e-12         -49.4678\n",
      "              HOCN    3.81703e-13      5.95679e-13         -66.2866\n",
      "              HNCO    1.42871e-10      2.22962e-10         -66.2866\n",
      "               NCO     6.3704e-12      9.70863e-12         -53.2504\n",
      "                N2       0.713842         0.725327         -27.5769\n",
      "     [  +26 minor]    5.11968e-17      6.17786e-17\n",
      "\n"
     ]
    }
   ],
   "source": [
    "g.TPX = 300.0, ct.one_atm, 'CH4:0.95, O2:2, N2:7.52'\n",
    "g.equilibrate('HP')\n",
    "g()"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Other options are:\n",
    "* `'UV'` for fixed specific internal energy and specific volume\n",
    "* `'SV'` for fixed specific entropy and specific volume\n",
    "* `'SP'` for fixed specific entropy and pressure\n",
    "\n",
    "How can you tell if `equilibrate` has correctly found the chemical equilibrium state? One way is to verify that the net rates of progress of all reversible reactions are zero. Here is the code to do this:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 41,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g.TPX = 300.0, ct.one_atm, 'CH4:0.95, O2:2, N2:7.52'\n",
    "g.equilibrate('HP')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 42,
   "metadata": {
    "scrolled": true
   },
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "     0    3.875e-15  \n",
      "     1    3.888e-15  \n",
      "     2    3.936e-16  \n",
      "     3    5.418e-15  \n",
      "     4   -7.383e-15  \n",
      "     5    3.383e-15  \n",
      "     6   -3.538e-15  \n",
      "     7    1.609e-15  \n",
      "     8    -3.62e-15  \n",
      "     9   -2.063e-15  \n",
      "    10    2.128e-15  \n",
      "    11   -4.998e-15  \n",
      "    12    4.946e-15  \n",
      "    13   -3.656e-15  \n",
      "    14            0  \n",
      "    15    6.764e-15  \n",
      "    16    8.891e-15  \n",
      "    17   -6.214e-15  \n",
      "    18   -5.872e-15  \n",
      "    19   -9.114e-15  \n",
      "    20     1.86e-14  \n",
      "    21    1.137e-14  \n",
      "    22    5.257e-15  \n",
      "    23   -3.542e-15  \n",
      "    24    3.836e-15  \n",
      "    25    2.677e-14  \n",
      "    26   -3.144e-14  \n",
      "    27   -1.069e-14  \n",
      "    28    1.346e-14  \n",
      "    29   -9.094e-15  \n",
      "    30   -1.368e-14  \n",
      "    31   -1.789e-14  \n",
      "    32   -5.598e-15  \n",
      "    33   -1.272e-14  \n",
      "    34   -1.268e-14  \n",
      "    35    -1.27e-14  \n",
      "    37   -4.305e-15  \n",
      "    38      3.7e-15  \n",
      "    39    3.773e-15  \n",
      "    40    4.038e-16  \n",
      "    41    1.078e-14  \n",
      "    42   -1.232e-15  \n",
      "    43    5.606e-15  \n",
      "    44    1.102e-14  \n",
      "    45    6.963e-15  \n",
      "    46   -1.136e-15  \n",
      "    47    5.242e-15  \n",
      "    48    8.914e-15  \n",
      "    49    1.929e-15  \n",
      "    50   -1.726e-15  \n",
      "    51   -3.404e-15  \n",
      "    52    8.662e-15  \n",
      "    53    5.302e-15  \n",
      "    54    5.229e-15  \n",
      "    55   -1.161e-15  \n",
      "    56   -6.276e-16  \n",
      "    57   -6.257e-16  \n",
      "    58     5.61e-15  \n",
      "    59    6.747e-15  \n",
      "    60    1.003e-14  \n",
      "    61    8.762e-15  \n",
      "    62    5.757e-15  \n",
      "    63   -6.719e-16  \n",
      "    64    5.186e-15  \n",
      "    65    9.755e-15  \n",
      "    66    9.023e-15  \n",
      "    67   -1.201e-16  \n",
      "    68    2.431e-16  \n",
      "    69   -8.732e-15  \n",
      "    70    1.114e-15  \n",
      "    71    1.912e-15  \n",
      "    72    3.602e-15  \n",
      "    73   -1.545e-14  \n",
      "    74    5.165e-15  \n",
      "    75    3.044e-14  \n",
      "    76    2.144e-14  \n",
      "    77     -2.5e-14  \n",
      "    78   -1.071e-14  \n",
      "    79    1.328e-14  \n",
      "    80    8.908e-15  \n",
      "    81    2.713e-15  \n",
      "    82    1.307e-16  \n",
      "    83   -8.034e-15  \n",
      "    84   -4.055e-16  \n",
      "    85   -1.978e-15  \n",
      "    86    9.201e-15  \n",
      "    87   -9.784e-15  \n",
      "    88   -9.853e-15  \n",
      "    89   -8.968e-15  \n",
      "    90   -5.261e-15  \n",
      "    91   -1.955e-15  \n",
      "    92   -6.475e-15  \n",
      "    93   -3.751e-15  \n",
      "    94   -4.994e-15  \n",
      "    95   -3.115e-15  \n",
      "    96   -1.427e-15  \n",
      "    97    7.126e-15  \n",
      "    98   -9.332e-15  \n",
      "    99   -3.743e-15  \n",
      "   100   -8.332e-15  \n",
      "   101    7.067e-15  \n",
      "   102    3.612e-15  \n",
      "   103   -1.392e-14  \n",
      "   104   -9.728e-16  \n",
      "   105    7.184e-15  \n",
      "   106   -1.732e-15  \n",
      "   107   -4.372e-15  \n",
      "   108    6.317e-15  \n",
      "   109    7.062e-15  \n",
      "   110   -3.533e-15  \n",
      "   111    3.753e-15  \n",
      "   112   -1.979e-14  \n",
      "   113    4.862e-15  \n",
      "   114    5.817e-15  \n",
      "   115    5.681e-15  \n",
      "   116    7.082e-15  \n",
      "   117    2.197e-15  \n",
      "   118    -2.79e-15  \n",
      "   119   -8.636e-15  \n",
      "   120    5.119e-16  \n",
      "   121   -5.532e-15  \n",
      "   122     1.76e-15  \n",
      "   123   -9.156e-15  \n",
      "   124   -1.666e-15  \n",
      "   125    2.142e-15  \n",
      "   126    5.118e-15  \n",
      "   127    1.517e-15  \n",
      "   128   -3.586e-15  \n",
      "   129   -1.862e-15  \n",
      "   130    1.615e-14  \n",
      "   131    7.138e-15  \n",
      "   132    3.736e-15  \n",
      "   133   -7.055e-15  \n",
      "   135    1.542e-15  \n",
      "   136            0  \n",
      "   137   -7.333e-15  \n",
      "   138    3.571e-15  \n",
      "   139   -1.392e-15  \n",
      "   140   -1.048e-14  \n",
      "   141   -1.717e-15  \n",
      "   143    1.181e-15  \n",
      "   144   -3.739e-15  \n",
      "   145    3.122e-15  \n",
      "   146   -3.316e-15  \n",
      "   147   -1.808e-15  \n",
      "   148   -8.904e-15  \n",
      "   149    8.231e-15  \n",
      "   150   -1.798e-15  \n",
      "   151   -1.669e-15  \n",
      "   152     5.34e-15  \n",
      "   153   -2.494e-14  \n",
      "   154   -7.424e-15  \n",
      "   155   -4.252e-16  \n",
      "   156   -3.364e-15  \n",
      "   157    1.859e-15  \n",
      "   158   -2.858e-14  \n",
      "   159     3.23e-15  \n",
      "   160   -1.571e-14  \n",
      "   161   -8.163e-15  \n",
      "   162   -8.163e-15  \n",
      "   163     3.18e-15  \n",
      "   164   -2.662e-14  \n",
      "   165    7.023e-16  \n",
      "   166    5.471e-16  \n",
      "   167    1.029e-15  \n",
      "   168    9.088e-15  \n",
      "   169    8.738e-15  \n",
      "   170   -1.092e-14  \n",
      "   171   -7.694e-15  \n",
      "   172   -7.347e-15  \n",
      "   173     4.43e-15  \n",
      "   174    1.659e-14  \n",
      "   175   -1.836e-14  \n",
      "   176   -3.214e-14  \n",
      "   177   -5.383e-15  \n",
      "   178   -2.518e-16  \n",
      "   179   -3.705e-15  \n",
      "   180    2.004e-15  \n",
      "   181    5.283e-15  \n",
      "   182   -1.867e-15  \n",
      "   183    -8.82e-15  \n",
      "   184   -4.648e-15  \n",
      "   185   -6.941e-16  \n",
      "   186   -8.639e-15  \n",
      "   187     1.26e-14  \n",
      "   188    1.433e-14  \n",
      "   189    1.616e-15  \n",
      "   190     1.87e-15  \n",
      "   191    -1.86e-15  \n",
      "   192   -3.467e-15  \n",
      "   193    3.986e-16  \n",
      "   194    5.013e-15  \n",
      "   195     1.84e-15  \n",
      "   196    6.239e-15  \n",
      "   197   -1.435e-16  \n",
      "   198    2.029e-15  \n",
      "   199    5.927e-15  \n",
      "   200    4.586e-15  \n",
      "   201     5.65e-15  \n",
      "   202   -2.329e-15  \n",
      "   203    4.219e-15  \n",
      "   204    4.254e-15  \n",
      "   205   -3.865e-15  \n",
      "   206    5.166e-15  \n",
      "   207    6.729e-15  \n",
      "   208    5.216e-15  \n",
      "   209    3.673e-15  \n",
      "   210   -3.846e-15  \n",
      "   211    1.982e-15  \n",
      "   212     3.31e-15  \n",
      "   213    3.559e-15  \n",
      "   214    1.836e-15  \n",
      "   215   -1.082e-15  \n",
      "   216   -2.039e-15  \n",
      "   217   -2.712e-15  \n",
      "   218   -5.802e-16  \n",
      "   219   -2.056e-16  \n",
      "   220   -2.403e-15  \n",
      "   221    2.063e-15  \n",
      "   222    1.712e-16  \n",
      "   223     2.93e-15  \n",
      "   224            0  \n",
      "   225    7.203e-15  \n",
      "   226   -6.388e-16  \n",
      "   227   -5.168e-15  \n",
      "   228   -1.051e-14  \n",
      "   229   -1.934e-15  \n",
      "   230   -6.826e-15  \n",
      "   231   -7.234e-15  \n",
      "   232   -4.041e-15  \n",
      "   233   -1.392e-14  \n",
      "   234   -9.271e-15  \n",
      "   235   -6.087e-15  \n",
      "   236    2.179e-16  \n",
      "   237   -3.477e-15  \n",
      "   238   -1.761e-15  \n",
      "   239     5.67e-15  \n",
      "   240    3.561e-15  \n",
      "   241    2.914e-15  \n",
      "   242    1.032e-15  \n",
      "   243   -6.989e-15  \n",
      "   244    -7.29e-15  \n",
      "   245    3.691e-15  \n",
      "   246   -2.076e-15  \n",
      "   247   -3.304e-15  \n",
      "   248   -1.249e-14  \n",
      "   249   -3.795e-15  \n",
      "   250   -1.051e-14  \n",
      "   251   -1.269e-14  \n",
      "   252     -3.8e-15  \n",
      "   253   -9.079e-15  \n",
      "   254   -1.443e-14  \n",
      "   255   -1.062e-14  \n",
      "   256    -1.79e-16  \n",
      "   257    5.415e-15  \n",
      "   258   -5.265e-15  \n",
      "   259    -1.36e-15  \n",
      "   260   -1.442e-15  \n",
      "   261    6.327e-15  \n",
      "   262    1.404e-14  \n",
      "   263    2.419e-15  \n",
      "   264    2.761e-15  \n",
      "   265    8.569e-15  \n",
      "   266   -6.232e-15  \n",
      "   267   -1.347e-14  \n",
      "   268    3.166e-15  \n",
      "   269   -1.972e-15  \n",
      "   270    7.137e-15  \n",
      "   271    1.773e-15  \n",
      "   272    5.259e-15  \n",
      "   273   -2.331e-14  \n",
      "   274   -7.171e-15  \n",
      "   275   -3.579e-15  \n",
      "   276    4.798e-15  \n",
      "   277    3.249e-15  \n",
      "   278    5.492e-15  \n",
      "   279    7.237e-15  \n",
      "   280    5.352e-15  \n",
      "   281    3.469e-16  \n",
      "   282    5.394e-15  \n",
      "   284   -6.135e-15  \n",
      "   285    1.609e-14  \n",
      "   286     9.28e-15  \n",
      "   288    7.279e-15  \n",
      "   290    1.466e-15  \n",
      "   293   -9.173e-15  \n",
      "   294   -1.312e-14  \n",
      "   295   -8.806e-16  \n",
      "   298   -1.318e-15  \n",
      "   303   -2.366e-15  \n",
      "   307    1.076e-14  \n",
      "   308    7.121e-15  \n",
      "   309            0  \n",
      "   310   -1.257e-14  \n",
      "   311    8.366e-15  \n",
      "   312    4.162e-15  \n",
      "   313   -2.545e-15  \n",
      "   314    8.823e-15  \n",
      "   315   -1.838e-14  \n",
      "   316    1.897e-15  \n",
      "   317   -2.547e-15  \n",
      "   318   -2.333e-14  \n",
      "   319   -5.035e-15  \n",
      "   320    -1.32e-14  \n",
      "   321    -1.69e-14  \n",
      "   322    4.465e-16  \n",
      "   324   -3.549e-14  \n"
     ]
    }
   ],
   "source": [
    "rf = g.forward_rates_of_progress\n",
    "rr = g.reverse_rates_of_progress\n",
    "for i in range(g.n_reactions):\n",
    "    if g.is_reversible(i) and rf[i] != 0.0:\n",
    "        print('  %4i   %10.4g  ' % (i, (rf[i] - rr[i])/rf[i]))"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If the magnitudes of the numbers in this list are all very small (which in this case they are), then each reversible reaction is very nearly equilibrated, which only occurs if the gas is in chemical equilibrium.\n",
    "\n",
    "You might be wondering how `equilibrate` works. (Then again, you might not.) Method `equilibrate` invokes Cantera's chemical equilibrium solver, which uses an element potential method. The element potential method is one of a class of equivalent *nonstoichiometric* methods that all have the characteristic that the probelm reduces to solving a set of $M$ nonlinear algebraic equations, where $M$ is the number of elements (not species). The so-called *stoichiometric* methods, on the other hand (including the Gibbs minimization), require solving $K$ nonlinear equations, where $K$ is the number of species (usually $K >> M$). See Smith and Missen's \"Chemical Reaction Equilibrium Analysis\" for more information on the various algorithms and their characteristics.\n",
    "\n",
    "Cantera uses a damped Newton method to solve these equations, and does a few other things to generate a good starting guess and to produce a reasonably robust algorithm. If you want to know more about the details, look at the on-line documentated source code of Cantera C++ class [`ChemEquil.h`](http://cantera.org/docs/doxygen/html/ChemEquil_8h.html)."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Chemical Kinetics"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "[`Solution`](http://cantera.github.io/docs/sphinx/html/cython/importing.html#cantera.Solution) objects are also [`Kinetics`](http://cantera.github.io/docs/sphinx/html/cython/kinetics.html#cantera.Kinetics) objects, and provide all of the methods necessary to compute the thermodynamic quantities associated with each reaction, reaction rates, and species creation and destruction rates. They also provide methods to inspect the quantities that define each reaction, such as the rate constants and the stoichiometric coefficients. The rate calculation functions are used extensively within Cantera's *[reactor network model](http://cantera.github.io/docs/sphinx/html/cython/zerodim.html#sec-cython-zerodim)* and *[1D flame model](http://cantera.github.io/docs/sphinx/html/cython/onedim.html#sec-cython-onedim)*.\n",
    "\n",
    "Information about individual reactions that are independent of the thermodynamic state can be obtained by accessing [`Reaction`](http://cantera.github.io/docs/sphinx/html/cython/kinetics.html#cantera.Reaction) objects with the [`Kinetics.reaction`](http://cantera.github.io/docs/sphinx/html/cython/kinetics.html#cantera.Kinetics.reaction) method:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 32,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "<ElementaryReaction: H2 + O <=> H + OH>"
      ]
     },
     "execution_count": 32,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "g = ct.Solution('gri30.cti')\n",
    "r = g.reaction(2)  # get a Reaction object\n",
    "r"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 33,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'H2': 1.0, 'O': 1.0}"
      ]
     },
     "execution_count": 33,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r.reactants"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 34,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "{'H': 1.0, 'OH': 1.0}"
      ]
     },
     "execution_count": 34,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r.products"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 35,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Arrhenius(A=38.7, b=2.7, E=2.61918e+07)"
      ]
     },
     "execution_count": 35,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "r.rate"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If we are interested in only certain types of reactions, we can use this information to filter the full list of reactions to find just the ones of interest. For example, here we find the indices of just those reactions which convert `CO` into `CO2`:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 43,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "CO + O (+M) <=> CO2 (+M)\n",
      "CO + O2 <=> CO2 + O\n",
      "CO + OH <=> CO2 + H\n",
      "CO + HO2 <=> CO2 + OH\n"
     ]
    }
   ],
   "source": [
    "II = [i for i, r in enumerate(g.reactions()) if 'CO' in r.reactants and 'CO2' in r.products]\n",
    "\n",
    "for i in II:\n",
    "    print(g.reaction(i).equation)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "(Actually, we should also include the reactions where the reaction is written such that `CO2` is a reactant and `CO` is a product, but for this example, we'll just stick to this smaller set of reactions.) Now, let's set the composition to an interesting state:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 44,
   "metadata": {
    "collapsed": true
   },
   "outputs": [],
   "source": [
    "g.TPX = 300, 101325, {'CH4':0.6, 'O2':1.0, 'N2':3.76}\n",
    "g.equilibrate('HP')"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "We can verify that this is an equilibrium state by seeing that the net reactions rates are essentially zero:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 45,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "array([  6.77626358e-20,   2.47757137e-20,   2.88657986e-15,\n",
       "         3.64224167e-20])"
      ]
     },
     "execution_count": 45,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "g.net_rates_of_progress[II]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Now let's see what happens if we decrease the temperature of the mixture:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 46,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "array([  3.18644948e-05,   5.00489577e-08,   1.05964923e-01,\n",
       "         2.89502609e-06])"
      ]
     },
     "execution_count": 46,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "g.TP = g.T-100, None\n",
    "g.net_rates_of_progress[II]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "All of the reaction rates are positive, favoring the formation of `CO2` from `CO`, with the third reaction, `CO + OH <=> CO2 + H` proceeding the fastest. If we look at the enthalpy change associated with each of these reactions:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 47,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "array([ -5.33034657e+08,  -2.23248515e+07,  -8.76650086e+07,\n",
       "        -2.49169628e+08])"
      ]
     },
     "execution_count": 47,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "g.delta_enthalpy[II]"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "we see that the change is negative in each case, indicating a net release of thermal energy. The total heat release rate can be computed either from the reaction rates:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 48,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "-58013370.720878579"
      ]
     },
     "execution_count": 48,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "np.dot(g.net_rates_of_progress, g.delta_enthalpy)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "or from the species production rates:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 49,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "-58013370.720878519"
      ]
     },
     "execution_count": 49,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "np.dot(g.net_production_rates, g.partial_molar_enthalpies)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The contribution from just the selected reactions is:"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 50,
   "metadata": {},
   "outputs": [
    {
     "data": {
      "text/plain": [
       "-9307123.2625653017"
      ]
     },
     "execution_count": 50,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "np.dot(g.net_rates_of_progress[II], g.delta_enthalpy[II])"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "or about 16% of the total heat release rate."
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.1"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}