Skip to content

Commit 63dad07

Browse files
committed
[Readme] document who maintains the solvers
1 parent 1f4c14a commit 63dad07

4 files changed

Lines changed: 70 additions & 0 deletions

File tree

src/shammodels/gsph/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# GSPH Solver
2+
3+
## Overview
4+
Godunov Smoothed Particle Hydrodynamics (GSPH) solver implementing Godunov-type Riemann solvers within the SPH framework.
5+
6+
## Maintainers
7+
- **Primary Maintainer**: Guo Yansong (guo.yansong.ngy@gmail.com)
8+
- **Contributors**:
9+
- Timothée David--Cléris (tim.shamrock@proton.me)
10+
- Yona Lapeyre (yona.lapeyre@ens-lyon.fr)
11+
12+
## Status
13+
- **Development Status**: Active
14+
15+
## References
16+
- Inutsuka (2002). Reformulation of Smoothed Particle Hydrodynamics with Riemann Solver. Journal of Computational Physics.
17+

src/shammodels/ramses/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# RAMSES Solver
2+
3+
## Overview
4+
Godunov Adaptive Mesh Refinement (AMR) solver based on the RAMSES code.
5+
6+
## Maintainers
7+
- **Primary Maintainer**: Timothée David--Cléris (tim.shamrock@proton.me)
8+
- **Contributors**:
9+
- Benoit Commercon (benoit.commercon@ens-lyon.fr)
10+
- Léodasce Sewanou (leodasce.sewanou@ens-lyon.fr)
11+
- Yona Lapeyre (yona.lapeyre@ens-lyon.fr)
12+
- Anass Serhani (anass.serhani@cnrs.fr)
13+
14+
## Status
15+
- **Development Status**: Active
16+
17+
## References
18+
- Teyssier (2002). Cosmological hydrodynamics with adaptive mesh refinement. A&A.
19+

src/shammodels/sph/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# SPH Solver
2+
3+
## Overview
4+
Smoothed Particle Hydrodynamics (SPH) solver based on the implementation in the Phantom code.
5+
6+
## Maintainers
7+
- **Primary Maintainer**: Timothée David--Cléris (tim.shamrock@proton.me)
8+
- **Contributors**:
9+
- Yona Lapeyre (yona.lapeyre@ens-lyon.fr)
10+
- David Fang (david.fang@ikmail.com)
11+
- Guo Yansong (guo.yansong.ngy@gmail.com)
12+
13+
## Status
14+
- **Development Status**: Active
15+
16+
## References
17+
- Price et al. (2018). Phantom: A Smoothed Particle Hydrodynamics and Magnetohydrodynamics Code for Astrophysics. PASA.
18+
- Monaghan (1992). Smoothed Particle Hydrodynamics. Annual Review of Astronomy and Astrophysics.
19+
- Price (2012). Smoothed particle hydrodynamics and magnetohydrodynamics. Journal of Computational Physics.
20+

src/shammodels/zeus/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# ZEUS Solver
2+
3+
## Overview
4+
Hydrodynamics solver using the Lax–Friedrichs scheme with artificial viscosity on a staggered grid.
5+
6+
## Maintainers
7+
- **Primary Maintainer**: Timothée David--Cléris (tim.shamrock@proton.me)
8+
9+
## Status
10+
- **Development Status**: Active
11+
12+
## References
13+
- Stone & Norman (1992). ZEUS-2D: A radiation magnetohydrodynamics code for astrophysical flows in two space dimensions.
14+

0 commit comments

Comments
 (0)