From 8e355464de4d631d9ae05de11ca81e8628e9b54b Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Wed, 26 Dec 2012 23:56:21 +0000 Subject: [PATCH] [Cython] Added physical constants to Sphinx docs --- doc/sphinx/cython/constants.rst | 54 +++++++++++++++++++++++++++++++++ doc/sphinx/cython/index.rst | 1 + 2 files changed, 55 insertions(+) create mode 100644 doc/sphinx/cython/constants.rst diff --git a/doc/sphinx/cython/constants.rst b/doc/sphinx/cython/constants.rst new file mode 100644 index 000000000..45ac12ada --- /dev/null +++ b/doc/sphinx/cython/constants.rst @@ -0,0 +1,54 @@ +.. py:currentmodule:: cantera + +Physical Constants +================== + +These values are the same as those in the Cantera C++ header file ct_defs.h. + +.. data:: Avogadro + + Avogadro's Number, /kmol + +.. data:: GasConstant + + The ideal gas constant in J/kmol-K + +.. data:: OneAtm + + One atmosphere in Pascals + +.. data:: Boltzmann + + Boltzmann constant + +.. data:: Planck + + Planck constant (J/s) + +.. data:: StefanBoltz + + The Stefan-Boltzmann constant, W/m^2K^4 + +.. data:: ElectronCharge + + The charge on an electron (C) + +.. data:: ElectronMass + + The mass of an electron (kg) + +.. data:: Faraday + + Faraday constant, C/kmol + +.. data:: lightSpeed + + Speed of Light (m/s). + +.. data:: permeability_0 + + Permeability of free space :math:`\mu_0` in N/A^2. + +.. data:: epsilon_0 + + Permittivity of free space (Farads/m = C^2/N/m^2) diff --git a/doc/sphinx/cython/index.rst b/doc/sphinx/cython/index.rst index 5020c541f..6472041fe 100644 --- a/doc/sphinx/cython/index.rst +++ b/doc/sphinx/cython/index.rst @@ -11,3 +11,4 @@ Contents: transport zerodim onedim + constants