PhantomDumpEOSUtils.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once
 
#include "shammodels/sph/io/PhantomDump.hpp"
 
// cf phantom
// This module contains stuff to do with the equation of state
//  Current options:
//     1 = isothermal eos
//     2 = adiabatic/polytropic eos
//     3 = eos for a locally isothermal disc as in Lodato & Pringle (2007)
//     4 = GR isothermal
//     6 = eos for a locally isothermal disc as in Lodato & Pringle (2007),
//         centered on a sink particle
//     7 = z-dependent locally isothermal eos
//     8 = Barotropic eos
//     9 = Piecewise polytrope
//    10 = MESA EoS
//    11 = isothermal eos with zero pressure
//    12 = ideal gas with radiation pressure
//    13 = locally isothermal prescription from Farris et al. (2014) generalised for generic
//         hierarchical systems
//    14 = locally isothermal prescription from Farris et al. (2014) for
//         binarysystem
//    15 = Helmholtz free energy eos 16 = Shen eos 20 = Ideal gas + radiation + various
//         forms of recombination energy from HORMONE (Hirai et al., 2020)
//
 
namespace shammodels::sph::phdump {
 
    bool is_maxvxyzu_at_least_4(const PhantomDump &dump);
 
    void eos1_load(const PhantomDump &dump, f64 &cs);
 
    void eos1_write(PhantomDump &dump, const f64 &cs);
 
    void eos2_load(const PhantomDump &dump, f64 &gamma);
 
    void eos2_write(PhantomDump &dump, const f64 &gamma);
 
    void eos3_load(const PhantomDump &dump, f64 &cs0, f64 &q, f64 &r0);
 
    void eos3_write(PhantomDump &dump, const f64 &cs0, const f64 &q, const f64 &r0);
 
    void eos13_load(const PhantomDump &dump, f64 &cs0, f64 &q, f64 &r0);
 
    void eos13_write(PhantomDump &dump, const f64 &cs0, const f64 &q, const f64 &r0);
 
    void eos14_load(const PhantomDump &dump, f64 &cs0, f64 &q, f64 &r0);
 
    void eos14_write(PhantomDump &dump, const f64 &cs0, const f64 &q, const f64 &r0);
 
} // namespace shammodels::sph::phdump