[cig-commits] [commit] add_thermodynamic_potentials: Changed comment blob for burnman.SolidSolution (df86cd4)

[cig_noreply at geodynamics.org]

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

On branch  : add_thermodynamic_potentials
Link       : https://github.com/geodynamics/burnman/compare/2e5646d93cedbbf8eae54cc37cffc14e0aa85180...d5ddad03ff9f30f5a4efaddb4e3ec585ea1a7c51

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

commit df86cd4ab2584efd589b6fe3b3125b84101f8895
Author: Bob Myhill <myhill.bob at gmail.com>
Date:   Mon Sep 1 22:07:31 2014 +0200

    Changed comment blob for burnman.SolidSolution


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

df86cd4ab2584efd589b6fe3b3125b84101f8895
 burnman/solidsolution.py | 17 ++++++-----------
 1 file changed, 6 insertions(+), 11 deletions(-)

diff --git a/burnman/solidsolution.py b/burnman/solidsolution.py
index c6fa56b..92096ca 100644
--- a/burnman/solidsolution.py
+++ b/burnman/solidsolution.py
@@ -14,27 +14,22 @@ kd = lambda x,y : 1 if x==y else 0
 class SolidSolution(Mineral):
     """
     This is the base class for all solid solutions. 
+    Site occupancies, endmember activities and the constant
+    and pressure and temperature dependencies of the excess 
+    properties can be queried after using set_composition()
     States of the solid solution can only be queried after setting 
-    the pressure and temperature using set_state(). 
-    The method for computing properties of
-    the solution is set using set_method(), which should be done
-    once after creating the material.
+    the pressure, temperature and composition using set_state().
 
     This class is available as ``burnman.SolidSolution``.
 
-    If deriving from this class, set the properties in self.params
-    to the desired values. For more complicated materials you
-    can overwrite set_state(), change the params and then call
-    set_state() from this class.
-
     All the solid solution parameters are expected to be in SI units.  This
     means that the interaction parameters should be in J/mol, with the T 
-    and P derivatives in J/K/mol and m^3/(mol molecule).
+    and P derivatives in J/K/mol and m^3/mol.
     """
 
     # init sets up matrices to speed up calculations for when P, T, X is defined.
     def __init__(self, base_material, interaction_parameter):
-        # Initialise the solid soltion inputs
+        # Initialise the solid solution inputs
         self.base_material = base_material
         self.interaction_parameter = interaction_parameter