[cig-commits] [commit] doc_updates: Update text (a6933cb)

[cig_noreply at geodynamics.org]

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

On branch  : doc_updates
Link       : https://github.com/geodynamics/burnman/compare/6c3867ee9c87680370dbc313761a117ed1768619...a6933cbfa9fe909cc180098ec5fde582d24e090b

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

commit a6933cbfa9fe909cc180098ec5fde582d24e090b
Author: ian-r-rose <ian.r.rose at gmail.com>
Date:   Tue Dec 30 17:46:06 2014 -0800

    Update text


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

a6933cbfa9fe909cc180098ec5fde582d24e090b
 sphinx/background_thermoelastics.txt | 19 ++++++++++++-------
 sphinx/background_userinputs.txt     |  2 +-
 2 files changed, 13 insertions(+), 8 deletions(-)

diff --git a/sphinx/background_thermoelastics.txt b/sphinx/background_thermoelastics.txt
index f41de72..93d3f85 100644
--- a/sphinx/background_thermoelastics.txt
+++ b/sphinx/background_thermoelastics.txt
@@ -8,14 +8,19 @@ To calculate the bulk (:math:`K`) modulus, shear modulus (:math:`G`) and
 density (:math:`\rho`) of a material at a given pressure (:math:`P`) and
 temperature (:math:`T`), optionally defined by a geotherm) and determine the
 seismic velocities (:math:`V_S, V_P, V_\Phi`), one uses an Equation of State
-(EoS).  Currently the following EoSs are supported in BurnMan: the
-Birch-Murnaghan formulation (excludes temperature effects, 
-:cite:`Poirier1991`), and the Birch-Murnaghan formulation with a
-Mie-Grüneisen-Debye temperature correction as formulated by
-:cite:`Stixrude2005`.  To calculate these thermoelastic parameters, the EoS
-requires the user to input three parameters: pressure, temperature, the phases
+(EoS).  Currently the following EoSs are supported in BurnMan:
+
+* Birch-Murnaghan finite-strain EoS (excludes temperature effects, :cite:`Poirier1991`), 
+* Birch-Murnaghan finite-strain EoS with a Mie-Grüneisen-Debye thermal correction, as formulated by :cite:`Stixrude2005`.
+* Birch-Murnaghan finite-strain EoS with a Mie-Grüneisen-Debye thermal correction, as formulated by :cite:`Matas2007`.
+* Modified Tait EoS with a pseudo-Einstein model for thermal corrections, as formulated by :cite:`HP2011`.
+* Compensated-Redlich-Kwong for fluids, as formulated by :cite:`HP2011`.
+
+
+To calculate these thermoelastic parameters, the EoS
+requires the user to input the pressure, temperature, and the phases
 and their molar fractions.  These inputs and outputs are further discussed in
-Section :ref:`ref-methods-user-input`.
+:ref:`ref-methods-user-input`.
 
 
 
diff --git a/sphinx/background_userinputs.txt b/sphinx/background_userinputs.txt
index 3a602de..88320cc 100644
--- a/sphinx/background_userinputs.txt
+++ b/sphinx/background_userinputs.txt
@@ -25,7 +25,7 @@ These minerals are "wrapped," so as to switch from the high spin to high spin mi
 While not realistic, for the sake of simplicity, the spin transitions are considered to be sharp at a given pressure.
 
 *Minerals depending on Fe partitioning* -- The wrapper function can partition iron, for example between ferropericlase, fp, and perovskite, pv.
-It requires the input of the iron mol fraction with regards to Mg, :math:`X_\mathrm{fp}` and :math:`X_\mathrm{pv}`, which then defines the chemistry of an Mg-Fe solid solution according to (:math:`\mathrm{Mg}_{1-X_{\mathrm{Fe}}^{\mathrm{fp}}}$,$\mathrm{Fe}_{X_{\mathrm{Fe}}^{\mathrm{fp}}}$)$\mathrm{O}$ or ($\mathrm{Mg}_{1-X_{\mathrm{Fe}}^{\mathrm{pv}}}$,$\mathrm{Fe}_{X_{\mathrm{Fe}}^{\mathrm{pv}}}$)$\mathrm{SiO_3}`.
+It requires the input of the iron mol fraction with regards to Mg, :math:`X_\mathrm{fp}` and :math:`X_\mathrm{pv}`, which then defines the chemistry of an Mg-Fe solid solution according to (:math:`\mathrm{Mg}_{1-X_{\mathrm{Fe}}^{\mathrm{fp}}},\mathrm{Fe}_{X_{\mathrm{Fe}}^{\mathrm{fp}}})\mathrm{O}` or :math:`(\mathrm{Mg}_{1-X_{\mathrm{Fe}}^{\mathrm{pv}}},\mathrm{Fe}_{X_{\mathrm{Fe}}^{\mathrm{pv}}})\mathrm{SiO_3}`.
 The iron mol fractions can be set to be constant or varying with P and T as needed.
 Alternatively one can calculate the iron mol fraction from the distribution coefficient :math:`K_D` defined as