[cig-commits] [commit] master, validate_MT_params: Fix sphinx dox for eos (2de018f)
cig_noreply at geodynamics.org
cig_noreply at geodynamics.org
Fri Dec 12 18:30:01 PST 2014
Repository : https://github.com/geodynamics/burnman
On branches: master,validate_MT_params
Link : https://github.com/geodynamics/burnman/compare/80c2a295c42dfdb38f83f6c1334bf7d8f97a8463...409647ff05dfad6a686198cac1481bd46b5e2e62
>---------------------------------------------------------------
commit 2de018fec31fc1dee590d771c03ccb2341b68215
Author: ian-r-rose <ian.r.rose at gmail.com>
Date: Fri Dec 12 18:04:05 2014 -0800
Fix sphinx dox for eos
Fix namespace
>---------------------------------------------------------------
2de018fec31fc1dee590d771c03ccb2341b68215
sphinx/background.rst | 1 -
sphinx/eos.rst | 22 +++++++++++++++-------
2 files changed, 15 insertions(+), 8 deletions(-)
diff --git a/sphinx/background.rst b/sphinx/background.rst
index 07af973..2b3164e 100644
--- a/sphinx/background.rst
+++ b/sphinx/background.rst
@@ -82,7 +82,6 @@ these corrections are added to equations :eq:`V`--:eq:`G`:
.. math::
P_{th}(V,T) &={\frac{\gamma \Delta \mathcal{U}}{V}}, \\
- :label: Pth
K_{th}(V,T) &=(\gamma +1-q)\frac{\gamma \Delta \mathcal{U}}{V} -\gamma ^{2} \frac{\Delta(C_{V}T)}{V} ,\\
G_{th}(V,T) &= -\frac{\eta_{S} \Delta \mathcal{U}}{V}.
diff --git a/sphinx/eos.rst b/sphinx/eos.rst
index 9886b0a..8c8d962 100644
--- a/sphinx/eos.rst
+++ b/sphinx/eos.rst
@@ -3,23 +3,31 @@ Equations of state
Base class
----------
-.. autoclass:: burnman.equation_of_state.EquationOfState
+.. autoclass:: burnman.eos.EquationOfState
Birch-Murnaghan
---------------
-.. autoclass:: burnman.birch_murnaghan.BirchMurnaghanBase
+.. autoclass:: burnman.eos.BirchMurnaghanBase
-.. autoclass:: burnman.birch_murnaghan.BM2
+.. autoclass:: burnman.eos.BM2
-.. autoclass:: burnman.birch_murnaghan.BM3
+.. autoclass:: burnman.eos.BM3
Stixrude and Lithgow-Bertelloni Formulation
-------------------------------------------
-.. autoclass:: burnman.slb.SLBBase
+.. autoclass:: burnman.eos.SLBBase
-.. autoclass:: burnman.slb.SLB2
+.. autoclass:: burnman.eos.SLB2
-.. autoclass:: burnman.slb.SLB3
+.. autoclass:: burnman.eos.SLB3
+
+Modified Tait
+-------------
+.. autoclass:: burnman.eos.MT
+
+Cork
+----
+.. autoclass:: burnman.eos.CORK
More information about the CIG-COMMITS
mailing list