[cig-commits] [commit] add_thermodynamic_potentials: Add interface for thermodynamic potentials (69d3701)

[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 69d3701fa27816a771c346cb4704e8d78d98b8a2
Author: ian-r-rose <ian.r.rose at gmail.com>
Date:   Wed Aug 27 12:52:22 2014 -0700

    Add interface for thermodynamic potentials


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

69d3701fa27816a771c346cb4704e8d78d98b8a2
 burnman/equation_of_state.py | 84 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)

diff --git a/burnman/equation_of_state.py b/burnman/equation_of_state.py
index 1f7ea13..7d2c38c 100644
--- a/burnman/equation_of_state.py
+++ b/burnman/equation_of_state.py
@@ -208,3 +208,87 @@ class EquationOfState:
         """
         raise NotImplementedError("")
 
+    def gibbs_free_energy( self, pressure, temperature, volume, params ):
+        """
+        Parameters
+        ----------
+        pressure : float
+            Pressure at which to evaluate the equation of state. [Pa]
+        temperature : float
+            Temperature at which to evaluate the equation of state. [K]
+        volume : float
+            Molar volume of the mineral.  For consistency this should be calculated
+            using :func:`volume`. [m^3]
+        params : dictionary
+            Dictionary containing material parameters required by the equation of state.
+
+        Returns
+        -------
+        G : float
+            Gibbs free energy of the mineral
+        """
+        raise NotImplementedError("")
+
+    def helmholtz_free_energy( self, pressure, temperature, volume, params ):
+        """
+        Parameters
+        ----------
+        pressure : float
+            Pressure at which to evaluate the equation of state. [Pa]
+        temperature : float
+            Temperature at which to evaluate the equation of state. [K]
+        volume : float
+            Molar volume of the mineral.  For consistency this should be calculated
+            using :func:`volume`. [m^3]
+        params : dictionary
+            Dictionary containing material parameters required by the equation of state.
+
+        Returns
+        -------
+        F : float
+            Helmholtz free energy of the mineral
+        """
+        raise NotImplementedError("")
+
+
+    def enthalpy( self, pressure, temperature, volume, params ):
+        """
+        Parameters
+        ----------
+        pressure : float
+            Pressure at which to evaluate the equation of state. [Pa]
+        temperature : float
+            Temperature at which to evaluate the equation of state. [K]
+        volume : float
+            Molar volume of the mineral.  For consistency this should be calculated
+            using :func:`volume`. [m^3]
+        params : dictionary
+            Dictionary containing material parameters required by the equation of state.
+
+        Returns
+        -------
+        H : float
+            Enthalpy of the mineral
+        """
+        raise NotImplementedError("")
+
+    def internal_energy( self, pressure, temperature, volume, params ):
+        """
+        Parameters
+        ----------
+        pressure : float
+            Pressure at which to evaluate the equation of state. [Pa]
+        temperature : float
+            Temperature at which to evaluate the equation of state. [K]
+        volume : float
+            Molar volume of the mineral.  For consistency this should be calculated
+            using :func:`volume`. [m^3]
+        params : dictionary
+            Dictionary containing material parameters required by the equation of state.
+
+        Returns
+        -------
+        U : float
+            Internal energy of the mineral
+        """
+        raise NotImplementedError("")