Shamrock features#
Here is a somewhat exhaustive list of Shamrock’s features, do not hesitate to raise an issue if one appears 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:
Physical#
SPH model#
Core features#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Gas solver |
|
|||
Pseudo-Newtonian |
||||
MHD solver |
||||
One fluid multispecies dust |
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
|
||||
Periodic box |
Shock handling mechanisms#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Constant \(\alpha_{AV}\) |
||||
MM97 \(\alpha_{AV}\) |
||||
CD10 \(\alpha_{AV}\) |
||||
\(\alpha\)-disc viscosity |
Requires the warp diffusion test to fully validate |
Equations of state#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Isothermal |
||||
Adiabatic |
||||
Isothermal - LP07 |
||||
Isothermal - FA14 |
GSPH model#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Core solver |
Godunov model#
Principal components#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Ramses solver |
Needs some polishing to be considered production ready |
|||
Refinement handling |
||||
Multifluid dust |
Refinement criterions#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Mass based refinement |
||||
Pseudo-gradient refinement |
||||
Modified second derivative refinement |
Slope limiters#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
None |
||||
Minmod |
||||
VanLeer |
||||
Symmetrized VanLeer |
Riemann solvers#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Rusanov |
||||
HLL |
||||
HLLC |
||||
Dusty HLL |
||||
HB dust solver |
Zeus model#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Core solver |
Needs some polishing to be considered production ready |
NBody FMM solver#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Core solver |
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 |
|
|||
Test library |
|
|||
CI/CD |
|
Shamrock internal libraries#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Shamalgs |
|
|||
Shambackends |
|
|||
Shambase |
|
|||
Shambindings |
|
|||
Shamcmdopt |
|
|||
Shamcomm |
|
|||
Shammath |
|
|||
Shammodels |
|
|||
Shamphys |
|
|||
Shamrock |
|
|||
Shamsolvergraph |
||||
Shamsys |
|
|||
Shamtest |
|
|||
Shamtree |
|
|||
Shamunits |
|
Components#
Feature |
Status |
Contributor / Maintainer |
Paper to cite |
Details |
|---|---|---|---|---|
Patch system |
|
|||
Sparse communications |
|
|||
Radix Tree |
|