Code Modules List ================= The AREPO code contains a number of physics modules that take the form of extensions of the code for specific science applications. Examples include MHD, non-equilibrium chemistry, tracer particles, etc. Usually, these modules have been developed by a single person or a small group of people, and are proprietary to them. If other people want to use these code parts for their own project, they have to check with the corresponding authors first. Depending on the policy they have defined, such a use may (or may not) be possible and may involve a request for co-authorship in publications. In any case, **please check this list for a first info about the usage policies** of different, clearly defined modules. In case of doubt, please feel free to discuss with the corresponding module authors. **When starting to develop a new module, please add a short note here about its purpose and its 'in progress' status. When finalizing a module, possibly in conjunction with a first publication, please update and expand its documentation as appropriate.** ----- Geometry -------- AMR ^^^ Use Cartesian-based adaptive mesh refinement instead of the usual Voronoi approach for the discretization of the hydrodynamics. * Documentation: :doc:`modules_amr` * Authors: Andreas Bauer, Ruediger Pakmor * Status: in progress, experimental only. ----- Solvers and Equation Systems ---------------------------- MHD ^^^ Ideal MHD implementation. This implementation uses cell-centered magnetic fields and employs the Powell/Dedner scheme for divergence cleaning. * Documentation: :doc:`modules_mhd` * Authors: Ruediger Pakmor * Status: working, production ready. MHD_CT ^^^^^^ Constrained transport Ideal MHD implementation. More accurate and robust (and experimental) than the Powell/Dedner scheme. * Documentation: :doc:`modules_mhd_ct` * Authors: Philip Mocz * Status: ? NON_IDEAL_MHD ^^^^^^^^^^^^^ Non-ideal MHD on the moving mesh: Ohmic resistivity, ambipolar diffusion and the Hall effect (Zier et al. 2024a/b). Extends the Powell/Dedner MHD solver. * Documentation: :doc:`modules_non_ideal_mhd` * Authors: Oliver Zier * Status: working, production ready. GLOBAL_VISCOSITY ^^^^^^^^^^^^^^^^ Solve Navier-Stokes instead of Euler equations. * Documentation: TODO. * Authors: Diego Munoz * Status: working, production ready? SPECIAL_RELATIVITY ^^^^^^^^^^^^^^^^^^ Special relativistic hydro solver for Arepo. * Documentation: :doc:`modules_special_relativity` * Authors: Andreas Bauswein * Status: in progress development only. ----- Radiation Transport ------------------- RT ^^ Radiative transfer module (cone method). * Documentation: TODO. * Authors: Margarita Petkova? * Status: ? TREECOLV2 ^^^^^^^^^ The TreeCol module (obtain column density maps of sky during treewalk) * Documentation: :doc:`modules_treecolv2` * Authors: Paul Clark and Simon Glover * Status: Production ready. BRAGINSKII_VISCOSITY ^^^^^^^^^^^^^^^^^^^^ Enables Braginskii viscosity, a special type of viscosity which is relevant for weakly-collisional and magnetized plasmas, e.g. the intracluster medium in galaxy clusters. * Documentation: :doc:`modules_braginskii_viscosity` * Authors: Thomas Berlok, Ruediger Pakmor and Christoph Pfrommer * Status: Basic functionality working, comoving integration is work in progress. MRT ^^^ Moment based radiative transfer using the M1 closure relation. * Documentation: :doc:`modules_mrt` * Authors: Rahul Kannan * Status: Production ready. ----- Physical Models (Galaxy/Cosmological) ------------------------------------- GFM ^^^ The 'galaxy formation model' with several components originally developed for the Illustris simulation. Includes galactic-scale winds, stellar evolution and enrichment. * Documentation: :doc:`modules_gfm` * Authors: Mark Vogelsberger, Paul Torrey, Shy Genel (and others) * Status: working, production ready. GFM_CHEMTAGS ^^^^^^^^^^^^ Chemical tagging to follow in more detail the origin of mass/metals from different processes. * Documentation: :doc:`modules_gfm_chemtags` * Authors: Jill Naiman * Status: working, production ready. GFM_DUST ^^^^^^^^ Passive scalar model for the formation and evolution of dust. * Documentation: :doc:`modules_gfm_dust` * Authors: Ryan McKinnon * Status: working, production ready? DUST_LIVE ^^^^^^^^^ Particle-based framework for dust grain dynamics and size evolution. * Documentation: :doc:`modules_dust_live` * Authors: Ryan McKinnon * Status: in progress development only. BLACK_HOLES ^^^^^^^^^^^ Treatment of supermassive blackholes, including their seeding, accretion, and feedback. * Documentation: :doc:`modules_black_holes` * Authors: Debora Sijacki, Mark Vogelsberger (and others) * Status: working, production ready. SF_ECOGAL ^^^^^^^^^ Star formation & feedback module. * Documentation: :doc:`modules_sf_ecogal` * Authors: Robin Tress, Junia Goeller (and others) * Status: In development SNE ^^^ Supernova feedback module coupled to ``SF_ECOGAL`` * Documentation: :doc:`modules_sne` * Authors: Robin Tress, Rowan Smith, Andre Bubel * Status: In development BLACK_HOLES_CAMBS ^^^^^^^^^^^^^^^^^ Master switch for supermassive blackhole models in development by the Cambridge (UK) group. This includes accretion and feedback modifications, jet feedback (BH_JET_FEEDBACK, Bourne & Sijacki 2017), accretion disc model (BH_AD_SPIN, Fiacconi et al. 2018) and black hole refinement (REFINEMENT_AROUND_BH, Curtis & Sijacki 2015). * Documentation: :doc:`modules_black_holes_cambs` * Authors: Module dependents - main contacts Debora Sijacki, Martin Bourne, Sophie Koudmani * Status: see individual modules, contact authors for details BH_JET_FEEDBACK ^^^^^^^^^^^^^^^ Jet feedback model developed by Martin Bourne (Bourne & Sijacki 2017), included in BLACK_HOLES_CAMBS. * Documentation: :doc:`modules_black_holes_cambs` * Authors: Martin Bourne * Status: usable but under constant development, contact Martin Bourne for current status BH_AD_SPIN ^^^^^^^^^^ Subgrid alpha-disc model by Davide Fiaconni (Fiaconni et al 2018), included in BLACK_HOLES_CAMBS. * Documentation: :doc:`modules_black_holes_cambs` * Authors: Davide Fiaconni (contact Debora Sijacki or Martin Bourne) * Status: usable but under constant development, contact Debora Sijacki or Martin Bourne for current status REFINEMENT_AROUND_BH ^^^^^^^^^^^^^^^^^^^^ Super-Lagrangian refinement scheme around BHs by Mike Curtis (Curtis & Sijacki 2015), original version included in standard BLACK_HOLES, modified version included in BLACK_HOLES_CAMBS. * Documentation: :doc:`modules_black_holes_cambs` * Authors: Mike Curtis, Martin Bourne (new development) * Status: usable but under constant development, contact Martin Bourne for current status GRACKLE ^^^^^^^ Replaces the standard cooling implementation with functions from the Grackle library. * Documentation: :doc:`modules_grackle` * Authors: Matthew Smith * Status: in progress development only. COSMIC_RAYS ^^^^^^^^^^^ Cosmic Ray implementation. * Documentation: :doc:`modules_cosmic_rays` * Authors: Ruediger Pakmor (and others) * Status: usable, under active development. SMUGGLE ^^^^^^^ Stellar feedback and ISM physics module of FM, intended for 'resolved' ISM resolution runs. * Documentation: :doc:`modules_smuggle_sfr` * Authors: Federico Marinacci (and others) * Status: in progress development only. SIDM ^^^^ Self-interacting dark matter model. * Documentation: TODO. * Authors: Mark Vogelsberger * Status: working, production ready? NOCTUA Black Holes ^^^^^^^^^^^^^^^^^^ Black hole accretion and seeding module for the Noctua framework * Documentation: :doc:`modules_noctua_black_holes` * Authors: Jonathan Petersson * Status: in progress development only. NOCTUA Stellar Evolution ^^^^^^^^^^^^^^^^^^^^^^^^ Stellar evolution and feedback module for the Noctua framework * Documentation: :doc:`modules_noctua_stellar` * Authors: Patrick Hirling * Status: in progress development only. ----- Physical Models (Other) ----------------------- SGCHEM ^^^^^^ A set of routines for modelling gas-phase chemistry and cooling. Currently implements a very simple H, C, O network. * Documentation: :doc:`modules_sgchem` * Authors: Simon Glover (and others) * Status: usable, under active development. CIRCUMSTELLAR ^^^^^^^^^^^^^ Models for circumstellar disks. * Documentation: TODO. * Authors: Diego Munoz * Status: ? EOS_OPAL ^^^^^^^^ OPAL equation of state for stellar applications. * Documentation: :doc:`modules_eos_opal` * Authors: Sebastian Ohlmann * Status: working, production ready. ----- Analysis -------- TRACER_* ^^^^^^^^ Implementation of tracer particles that allow to follow the flow of gas (as well as stars/BHs if relevant) in a 'Lagrangian' way. Also the passive scalar field. * Documentation: :doc:`modules_tracer` * Authors: Shy Genel, Dylan Nelson (and others) * Status: working, production ready. SHOCK_FINDER ^^^^^^^^^^^^ Hydrodynamic shock finder implementation. * Documentation: :doc:`modules_shock_finder` * Authors: Kevin Schaal * Status: working, production ready. ----- These are what seem to be 'master' module switches, entirely lacking documentation at present: Unknown ------- * AB_TURB * EOS_DEGENERATE * NUCLEAR_NETWORK * BOUNDARY_CELLS (replaces SPECIAL_BOUNDARY / BOUNDARY_*_MINID / STICKYFLAGS / BOUNDARY_FLAG; see src/boundaries/) * WINDTUNNEL * SNE_FEEDBACK