.. _ref-api-eos:

Equation of State Classes and Functions
=======================================

.. contents::
   :local:
   :class: this-will-duplicate-information-and-it-is-still-useful-here
   :depth: 2


Isothermal Equations of State
-----------------------------

Base class
~~~~~~~~~~

.. autoclass:: burnman.eos.IsothermalEquationOfState

birch murnaghan
~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.birch_murnaghan.BM3

.. autoclass:: burnman.eos.birch_murnaghan.BM3Shear2

.. autoclass:: burnman.eos.birch_murnaghan.BM4

.. autoclass:: burnman.eos.birch_murnaghan.BirchMurnaghanBase

macaw
~~~~~

.. autoclass:: burnman.eos.macaw.MACAW

modified tait
~~~~~~~~~~~~~

.. autoclass:: burnman.eos.modified_tait.MT

morse potential
~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.morse_potential.Morse

murnaghan
~~~~~~~~~

.. autoclass:: burnman.eos.murnaghan.Murnaghan

reciprocal kprime
~~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.reciprocal_kprime.RKprime

spock
~~~~~

.. autoclass:: burnman.eos.spock.SPOCK

vinet
~~~~~

.. autoclass:: burnman.eos.vinet.Vinet

Thermal Equations of State
--------------------------

Base class
~~~~~~~~~~

.. autoclass:: burnman.eos.EquationOfState

aa
~~

.. autoclass:: burnman.eos.aa.AA

brosh calphad
~~~~~~~~~~~~~

.. autoclass:: burnman.eos.brosh_calphad.BroshCalphad

cork
~~~~

.. autoclass:: burnman.eos.cork.CORK

dks liquid
~~~~~~~~~~

.. autoclass:: burnman.eos.dks_liquid.DKS_L

dks solid
~~~~~~~~~

.. autoclass:: burnman.eos.dks_solid.DKS_S

hp
~~

.. autoclass:: burnman.eos.hp.HP98

.. autoclass:: burnman.eos.hp.HP_TMT

.. autoclass:: burnman.eos.hp.HP_TMTL

mie grueneisen debye
~~~~~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.mie_grueneisen_debye.MGD2

.. autoclass:: burnman.eos.mie_grueneisen_debye.MGD3

.. autoclass:: burnman.eos.mie_grueneisen_debye.MGDBase

modular mie grueneisen debye
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.modular_mie_grueneisen_debye.ModularMGD

.. autoclass:: burnman.eos.modular_mie_grueneisen_debye.ModularMGDWithAnharmonicity

slb
~~~

.. autoclass:: burnman.eos.slb.SLB2

.. autoclass:: burnman.eos.slb.SLB3

.. autoclass:: burnman.eos.slb.SLB3Conductive

.. autoclass:: burnman.eos.slb.SLBBase

Other Equation of State classes
-------------------------------

anharmonic debye
~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.anharmonic_debye.AnharmonicDebye

anharmonic prefactor models
~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.anharmonic_prefactor_models.AnharmonicPrefactorModel

.. autoclass:: burnman.eos.anharmonic_prefactor_models.PowerLaw

.. autoclass:: burnman.eos.anharmonic_prefactor_models.Sigmoid

anharmonic thermal models
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.anharmonic_thermal_models.AnharmonicThermalModelBase

debye temperature models
~~~~~~~~~~~~~~~~~~~~~~~~

.. autoclass:: burnman.eos.debye_temperature_models.DebyeTemperatureModelBase

Equation of State Functions
---------------------------

anharmonic thermal models
~~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.anharmonic_thermal_models.LogNormal

.. autofunction:: burnman.eos.anharmonic_thermal_models.Pade

birch murnaghan
~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.birch_murnaghan.bulk_modulus_fourth_order

.. autofunction:: burnman.eos.birch_murnaghan.bulk_modulus_third_order

.. autofunction:: burnman.eos.birch_murnaghan.pressure_fourth_order

.. autofunction:: burnman.eos.birch_murnaghan.pressure_third_order

.. autofunction:: burnman.eos.birch_murnaghan.shear_modulus_second_order

.. autofunction:: burnman.eos.birch_murnaghan.shear_modulus_third_order

.. autofunction:: burnman.eos.birch_murnaghan.volume_fourth_order

.. autofunction:: burnman.eos.birch_murnaghan.volume_third_order

bukowinski electronic
~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.bukowinski_electronic.CVoverT

.. autofunction:: burnman.eos.bukowinski_electronic.KToverV

.. autofunction:: burnman.eos.bukowinski_electronic.aKT

.. autofunction:: burnman.eos.bukowinski_electronic.entropy

.. autofunction:: burnman.eos.bukowinski_electronic.helmholtz

.. autofunction:: burnman.eos.bukowinski_electronic.pressure

debye
~~~~~

.. autofunction:: burnman.eos.debye.d2helmholtz_dTheta2

.. autofunction:: burnman.eos.debye.debye_fn

.. autofunction:: burnman.eos.debye.debye_fn_cheb

.. autofunction:: burnman.eos.debye.dentropy_dTheta

.. autofunction:: burnman.eos.debye.dhelmholtz_dTheta

.. autofunction:: burnman.eos.debye.dmolar_heat_capacity_v_dT

.. autofunction:: burnman.eos.debye.entropy

.. autofunction:: burnman.eos.debye.helmholtz_energy

.. autofunction:: burnman.eos.debye.molar_heat_capacity_v

.. autofunction:: burnman.eos.debye.thermal_energy

debye temperature models
~~~~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.debye_temperature_models.PowerLawGamma

.. autofunction:: burnman.eos.debye_temperature_models.PowerLawGammaSimple

.. autofunction:: burnman.eos.debye_temperature_models.SLB

einstein
~~~~~~~~

.. autofunction:: burnman.eos.einstein.d2helmholtz_dTheta2

.. autofunction:: burnman.eos.einstein.dentropy_dTheta

.. autofunction:: burnman.eos.einstein.dhelmholtz_dTheta

.. autofunction:: burnman.eos.einstein.dmolar_heat_capacity_v_dT

.. autofunction:: burnman.eos.einstein.entropy

.. autofunction:: burnman.eos.einstein.helmholtz_energy

.. autofunction:: burnman.eos.einstein.molar_heat_capacity_v

.. autofunction:: burnman.eos.einstein.thermal_energy

macaw
~~~~~

.. autofunction:: burnman.eos.macaw.make_params

modified tait
~~~~~~~~~~~~~

.. autofunction:: burnman.eos.modified_tait.bulk_modulus

.. autofunction:: burnman.eos.modified_tait.intVdP

.. autofunction:: burnman.eos.modified_tait.pressure_modified_tait

.. autofunction:: burnman.eos.modified_tait.tait_constants

.. autofunction:: burnman.eos.modified_tait.volume

morse potential
~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.morse_potential.bulk_modulus

.. autofunction:: burnman.eos.morse_potential.morse_potential

.. autofunction:: burnman.eos.morse_potential.shear_modulus

.. autofunction:: burnman.eos.morse_potential.volume

murnaghan
~~~~~~~~~

.. autofunction:: burnman.eos.murnaghan.bulk_modulus

.. autofunction:: burnman.eos.murnaghan.energy

.. autofunction:: burnman.eos.murnaghan.intVdP

.. autofunction:: burnman.eos.murnaghan.pressure

.. autofunction:: burnman.eos.murnaghan.volume

property modifiers
~~~~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.property_modifiers.bragg_williams_excesses

.. autofunction:: burnman.eos.property_modifiers.calculate_property_modifications

.. autofunction:: burnman.eos.property_modifiers.debye_delta_excesses

.. autofunction:: burnman.eos.property_modifiers.debye_excesses

.. autofunction:: burnman.eos.property_modifiers.einstein_delta_excesses

.. autofunction:: burnman.eos.property_modifiers.einstein_excesses

.. autofunction:: burnman.eos.property_modifiers.landau_excesses

.. autofunction:: burnman.eos.property_modifiers.landau_hp_excesses

.. autofunction:: burnman.eos.property_modifiers.landau_slb_2022_excesses

.. autofunction:: burnman.eos.property_modifiers.linear_excesses

.. autofunction:: burnman.eos.property_modifiers.magnetic_excesses_chs

reciprocal kprime
~~~~~~~~~~~~~~~~~

.. autofunction:: burnman.eos.reciprocal_kprime.bulk_modulus

.. autofunction:: burnman.eos.reciprocal_kprime.shear_modulus

vinet
~~~~~

.. autofunction:: burnman.eos.vinet.bulk_modulus_vinet

.. autofunction:: burnman.eos.vinet.pressure_vinet

.. autofunction:: burnman.eos.vinet.volume_vinet