[cig-commits] [commit] split_mt: Added detail to HP_TMT and MT class documentation (252dfa3)

[cig_noreply at geodynamics.org]

Repository : https://github.com/geodynamics/burnman

On branch  : split_mt
Link       : https://github.com/geodynamics/burnman/compare/69e63fe58f5ca98a9452b9046fbcc5b552660fbb...252dfa37a0186b6136d708b751bcf0873dd651da

>---------------------------------------------------------------

commit 252dfa37a0186b6136d708b751bcf0873dd651da
Author: Bob Myhill <myhill.bob at gmail.com>
Date:   Sun Jan 4 18:30:07 2015 +0100

    Added detail to HP_TMT and MT class documentation


>---------------------------------------------------------------

252dfa37a0186b6136d708b751bcf0873dd651da
 burnman/eos/hp.py            | 6 ++++++
 burnman/eos/modified_tait.py | 5 +++++
 2 files changed, 11 insertions(+)

diff --git a/burnman/eos/hp.py b/burnman/eos/hp.py
index 2ba5090..e71192a 100644
--- a/burnman/eos/hp.py
+++ b/burnman/eos/hp.py
@@ -21,6 +21,12 @@ class HP_TMT(eos.EquationOfState):
     """
     Base class for the Holland and Powell (2011) correction to
     the generic modified Tait equation of state (class MT).
+
+
+    An instance "m" of a Mineral can be assigned this 
+    equation of state with the command m.set_method('hp_tmt')
+    (or by initialising the class with the param 
+    equation_of_state = 'hp_tmt'
     """
 
     def volume(self, pressure,temperature,params):
diff --git a/burnman/eos/modified_tait.py b/burnman/eos/modified_tait.py
index cf465a6..f00ae00 100644
--- a/burnman/eos/modified_tait.py
+++ b/burnman/eos/modified_tait.py
@@ -52,6 +52,11 @@ class MT(eos.EquationOfState):
     Base class for a generic modified Tait equation of state.  
     References for this can be found in Huang and Chow (1974) 
     and Holland and Powell (2011; followed here).
+
+    An instance "m" of a Mineral can be assigned this 
+    equation of state with the command m.set_method('mt')
+    (or by initialising the class with the param 
+    equation_of_state = 'mt'
     """
 
     def volume(self, pressure,temperature,params):