diff --git a/doc/RTD/source/Planetary/equations_of_state.rst b/doc/RTD/source/Planetary/equations_of_state.rst index 63ad1a6cfb5beb7b2131f6744e02389bfe033b6c..15beef99e6b7d3c2ebc286a3b37c8d49a195a3a7 100644 --- a/doc/RTD/source/Planetary/equations_of_state.rst +++ b/doc/RTD/source/Planetary/equations_of_state.rst @@ -7,39 +7,51 @@ Planetary Equations of State ============================ Configuring SWIFT with the ``--with-equation-of-state=planetary`` and -``--with-hydro=planetary`` options enables the use of multiple EoS. +``--with-hydro=planetary`` options enables the use of multiple +equations of state (EoS). Every SPH particle then requires and carries the additional ``MaterialID`` flag from the initial conditions file. This flag indicates the particle's material and which EoS it should use. -So far, we have implemented several Tillotson, SESAME, and Hubbard \& MacFarlane -(1980) materials, with more on their way. -The material's ID is set by a base type ID (multiplied by 100), plus a minor -type: +It is important to check that the EoS you use are appropriate +for the conditions in the simulation that you run. -+ Tillotson (Melosh, 2007): Base type ``1`` +So far, we have implemented several Tillotson, ANEOS, SESAME, +and Hubbard \& MacFarlane (1980) materials, with more on the way. +The material's ID is set by a base type ID (multiplied by 100), +plus a minor type: + ++ Tillotson (Melosh, 2007): ``1`` + Iron: ``100`` + Granite: ``101`` + Water: ``102`` -+ Hubbard \& MacFarlane (1980): Base type ``2`` ++ Hubbard \& MacFarlane (1980): ``2`` + Hydrogen-helium atmosphere: ``200`` + Ice H20-CH4-NH3 mix: ``201`` + Rock SiO2-MgO-FeS-FeO mix: ``202`` -+ SESAME (and similar): Base type ``3`` ++ SESAME (and similar): ``3`` + Iron (2140): ``300`` + Basalt (7530): ``301`` + Water (7154): ``302`` - + Senft \& Stewart (2008) water (in a SESAME-style table): ``303`` + + Senft \& Stewart (2008) water in a SESAME-style table: ``303`` ++ ANEOS (in SESAME-style tables): ``4`` + + Forsterite (Stewart et al. 2019): ``400`` + + Iron (Stewart, zenodo.org/record/3866507): ``401`` + + Fe85Si15 (Stewart, zenodo.org/record/3866550): ``402`` Unlike the EoS for an ideal or isothermal gas, these more complicated materials do not always include transformations between the internal energy, -temperature, and entropy. At the moment, we have only implemented -\\(P(\\rho, u)\\) and \\(c_s(\\rho, u)\\). -This is sufficient for the simple :ref:`planetary_sph` hydrodynamics scheme, +temperature, and entropy. At the moment, we have implemented +\\(P(\\rho, u)\\) and \\(c_s(\\rho, u)\\), +which is sufficient for the :ref:`planetary_sph` hydrodynamics scheme, but makes these materials currently incompatible with entropy-based schemes. +The data files for the tabulated EoS can be downloaded using +the ``examples/EoSTables/get_eos_tables.sh`` script. + The Tillotson sound speed was derived using -\\(c_s^2 = \\left. \\dfrac{\\partial P}{\\partial \\rho} \\right|_S \\) -as described in `Kegerreis et al. (2019) <https://doi.org/10.1093/mnras/stz1606>`_. -The table files for the HM80 and SESAME-style EoS can be downloaded using -the ``swiftsim/examples/EoSTables/get_eos_tables.sh`` script. +\\(c_s^2 = \\left. ( \\partial P / \\partial \\rho ) \\right|_S \\) +as described in Kegerreis et al. (2019). +Note that there is a typo in the sign of +\\(du = T dS - P dV = T dS + (P / \\rho^2) d\\rho \\), +which was not used in the derivation. diff --git a/doc/RTD/source/Planetary/index.rst b/doc/RTD/source/Planetary/index.rst index c7e9be3db2d6f726e3ee018516e51f7d9de5f299..3bda4637e8a62a5f27100be1d5c2d7a6eece6576 100644 --- a/doc/RTD/source/Planetary/index.rst +++ b/doc/RTD/source/Planetary/index.rst @@ -7,24 +7,24 @@ Planetary Simulations ===================== SWIFT is also designed for running planetary simulations -with a focus on giant impacts, as presented in +with a current focus on giant impacts, as presented in `Kegerreis et al. (2019) <https://doi.org/10.1093/mnras/stz1606>`_, MNRAS 487:4. -New features for planetary simulations are in active development +More features for planetary simulations are in active development so please let us know if you are interested in using SWIFT or have any implementation requests. For example a new equation of state or extensions to the tools for creating initial conditions. You can find an example simulation in ``swiftsim/examples/Planetary/`` under ``EarthImpact/``. -The tabulated equations of state files can be downloaded using +The tabulated equation of state files can be downloaded using ``EoSTables/get_eos_tables.sh``. Planetary simulations are currently intended to be run with SWIFT configured to use the planetary hydrodynamics scheme and equations of state: ``--with-hydro=planetary`` and ``--with-equation-of-state=planetary``. These allow for multiple materials to be used, -chosen from the several available equations of state (more coming soon!). +chosen from the several available equations of state. .. toctree:: :maxdepth: 2 diff --git a/doc/RTD/source/Planetary/initial_conditions.rst b/doc/RTD/source/Planetary/initial_conditions.rst new file mode 100755 index 0000000000000000000000000000000000000000..151ce2193de7ee10846029cfd0eb016cbba859e2 --- /dev/null +++ b/doc/RTD/source/Planetary/initial_conditions.rst @@ -0,0 +1,12 @@ +.. Planetary Initial Conditions + Jacob Kegerreis, 13th March 2020 + +.. _planetary_initial_conditions: + +Initial Conditions +================== + +(Full documentation coming soon!) + +See `Kegerreis et al. (2019) <https://doi.org/10.1093/mnras/stz1606>`_ +and `SEAGen <https://github.com/jkeger/seagen>`_. \ No newline at end of file