Skip to content

Shamrock features

Here is a somewhat Exhaustive list of shamrock's features, do not hesitate to raise an issue if one appear to be missing. This page was made in order to list the features of the code as well as properly attributing contribution and avoid having multiple peoples working on the same features.

We list the features by categories as well as their status which can be any of: Production ready Ok WIP (Work in progress) Broken This page also trace the contributor who made the contribution as well as the corresponding paper to cite for each features. If any feature is notated with Wait for the paper ! please wait for the corresponding feature to be published before publishing anything using it.

Physical

SPH model

Core features

Feature Status Contributor / Maintainer Paper to cite Details
Gas solver Production ready Timothée David--Cléris Nasa ads
Sink particles Production ready Timothée David--Cléris Wait for the paper !
Pseudo-Newtonian
corrections		 Production ready Timothée David--Cléris Wait for the paper ! PR - #319
MHD solver WIP Yona Lapeyre Wait for the paper ! PR - #707
Feature Status Contributor / Maintainer Paper to cite Details
On the fly-plots Production ready Timothée David--Cléris Wait for the paper ! PR - #623
Conformance with Phantom Production ready Timothée David--Cléris
& Yona Lapeyre		 Nasa ads
Setup graph Production ready Timothée David--Cléris Wait for the paper ! PR - #593
Shearing box Production ready Timothée David--Cléris Wait for the paper !
Periodic box Production ready Timothée David--Cléris Wait for the paper !

Shock handling mechanisms

Feature Status Contributor / Maintainer Paper to cite Details
Constant \(\alpha_{AV}\) Production ready Timothée David--Cléris
& Yona Lapeyre
MM97 \(\alpha_{AV}\) Production ready Timothée David--Cléris Nasa ads - MM97
CD10 \(\alpha_{AV}\) Production ready Timothée David--Cléris Nasa ads - CD10
\(\alpha\)-disc viscosity Ok Yona Lapeyre Requires the warp diffusion test to fully validate

Equations of state

Feature Status Contributor / Maintainer Paper to cite Details
Isothermal Production ready Yona Lapeyre
Adiabatic Production ready Timothée David--Cléris
Isothermal - LP07 Production ready Yona Lapeyre PR - #361
Isothermal - FA14 Production ready Timothée David--Cléris

Godunov model

Principal components

Feature Status Contributor / Maintainer Paper to cite Details
Ramses solver Ok Timothée David--Cléris & Thomas Guillet Wait for the paper ! Needs some polishing to be considered production ready
Refinement handling Ok Timothée David--Cléris Wait for the paper !
Multifluid dust WIP Léodasce Sewanou Wait for the paper ! PR - #636

Refinement criterions

Feature Status Contributor / Maintainer Paper to cite Details
Mass based refinement Ok Timothée David--Cléris Wait for the paper !
Pseudo-gradient refinement WIP Léodasce Sewanou Wait for the paper !
Modified second derivative refinement WIP Léodasce Sewanou Wait for the paper !

Slope limiters

Feature Status Contributor / Maintainer Paper to cite Details
None Production ready Timothée David--Cléris Wait for the paper !
Minmod Production ready Timothée David--Cléris Wait for the paper !
VanLeer Production ready Timothée David--Cléris Wait for the paper !
Symmetrized VanLeer Production ready Timothée David--Cléris & Thomas Guillet Wait for the paper !

Riemann solvers

Feature Status Contributor / Maintainer Paper to cite Details
Rusanov Production ready Timothée David--Cléris & Thomas Guillet
HLL Production ready Timothée David--Cléris & Thomas Guillet
HLLC Production ready Léodasce Sewanou
Dusty HLL WIP Léodasce Sewanou
HB dust solver WIP Léodasce Sewanou

Zeus model

Feature Status Contributor / Maintainer Paper to cite Details
Core solver Ok Timothée David--Cléris Wait for the paper ! Needs some polishing to be considered production ready

NBody FMM solver

Feature Status Contributor / Maintainer Paper to cite Details
Core solver WIP Timothée David--Cléris Wait for the paper ! WIP of a N-Body FMM self-gravity solver, physically correct but not usable for any production runs yet.

Framework

Software

Feature Status Contributor / Maintainer Paper to cite Details
Python integration Production ready Timothée David--Cléris Nasa ads
Test library Production ready Timothée David--Cléris Nasa ads
CI/CD Production ready Timothée David--Cléris Nasa ads

Shamrock internal libraries

Feature Status Contributor / Maintainer Paper to cite Details
Shamalgs Production ready Timothée David--Cléris Nasa ads
Shambackends Production ready Timothée David--Cléris Nasa ads
Shambase Production ready Timothée David--Cléris Nasa ads
Shambindings Production ready Timothée David--Cléris Nasa ads
Shamcmdopt Production ready Timothée David--Cléris Nasa ads
Shamcomm Production ready Timothée David--Cléris Nasa ads
Shammath Production ready Timothée David--Cléris Nasa ads
Shammodels Production ready Timothée David--Cléris Nasa ads
Shamphys Production ready Timothée David--Cléris Nasa ads
Shamrock Production ready Timothée David--Cléris Nasa ads
Shamsys Production ready Timothée David--Cléris Nasa ads
Shamtest Production ready Timothée David--Cléris Nasa ads
Shamtree Production ready Timothée David--Cléris Nasa ads
Shamunits Production ready Timothée David--Cléris Nasa ads

Components

Feature Status Contributor / Maintainer Paper to cite Details
Patch system Production ready Timothée David--Cléris Nasa ads
Sparse communications Production ready Timothée David--Cléris Nasa ads
Radix Tree Production ready Timothée David--Cléris Nasa ads