Skip to content

[Ramses] add a string based slope limiter selection #1637

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tdavidcl wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[Ramses] add a string based slope limiter selection #1637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f5e99a8
[Ramses] add a string based slope limiter selection
tdavidcl Feb 12, 2026
45e0c22
Apply suggestion from @nbrucy
tdavidcl Feb 16, 2026
0d3f31a
retry
tdavidcl Feb 16, 2026
00290f8
using json directly ?
tdavidcl Feb 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions doc/sphinx/examples/tests_ci/sod_tube_godunov_amr.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,8 @@
# cfg.set_riemann_solver_rusanov()
cfg.set_riemann_solver_hll()

# cfg.set_slope_lim_none()
# cfg.set_slope_lim_vanleer_f()
# cfg.set_slope_lim_vanleer_std()
# cfg.set_slope_lim_vanleer_sym()
cfg.set_slope_lim_minmod()
# Set the slope limiter (among "none", "vanleer_f", "vanleer_std", "vanleer_sym", "minmod")
cfg.set_slope_limiter("minmod")
cfg.set_face_time_interpolation(True)
mass_crit = 0.0000001 * 5 * 2 * 1.2
cfg.set_amr_mode_density_based(crit_mass=mass_crit)
Expand Down
71 changes: 63 additions & 8 deletions src/shammodels/ramses/include/shammodels/ramses/SolverConfig.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,66 @@ namespace shammodels::basegodunov {

enum RiemmanSolverMode { Rusanov = 0, HLL = 1, HLLC = 2 };

enum SlopeMode {
None = 0,
VanLeer_f = 1,
VanLeer_std = 2,
VanLeer_sym = 3,
Minmod = 4,
struct SlopeLimConfig {

enum SlopeMode {
None = 0,
VanLeer_f = 1,
VanLeer_std = 2,
VanLeer_sym = 3,
Minmod = 4,
};

inline static const std::map<std::string, SlopeMode> slope_mode_string_map = {
{"none", None},
{"vanleer_f", VanLeer_f},
{"vanleer_std", VanLeer_std},
{"vanleer_sym", VanLeer_sym},
{"minmod", Minmod},
};

inline static const std::vector<std::string> get_valid_slope_modes() {
std::vector<std::string> valid_slope_modes;
for (const auto &[key, value] : slope_mode_string_map) {
valid_slope_modes.push_back(key);
}
return valid_slope_modes;
}

SlopeMode mode;
};

inline void to_json(nlohmann::json &j, const SlopeLimConfig &p) {

for (const auto &[key, value] : SlopeLimConfig::slope_mode_string_map) {
if (value == p.mode) {
j = nlohmann::json{
{"slope_mode", key},
};
return;
}
}

throw shambase::make_except_with_loc<std::invalid_argument>(shambase::format(
"Unsupported slope mode: {} (expected one of: {})",
p.mode,
SlopeLimConfig::get_valid_slope_modes()));
}

inline void from_json(const nlohmann::json &j, SlopeLimConfig &p) {
std::string slope_mode = j.at("slope_mode").get<std::string>();

try {
p.mode = SlopeLimConfig::slope_mode_string_map.at(slope_mode);
} catch (const std::out_of_range &e) {
throw shambase::make_except_with_loc<std::invalid_argument>(shambase::format(
"Unsupported slope mode: {} (expected one of: {})\n current json: {}",
slope_mode,
SlopeLimConfig::get_valid_slope_modes(),
j.dump(4)));
}
}

enum DustRiemannSolverMode {
NoDust = 0,
DHLL = 1, // Dust HLL . This is merely the HLL solver for dust. It's then a Rusanov like
Expand Down Expand Up @@ -179,8 +231,11 @@ struct shammodels::basegodunov::SolverConfig {

inline void set_eos_gamma(Tscal gamma) { eos_gamma = gamma; }

RiemmanSolverMode riemman_config = HLL;
SlopeMode slope_config = VanLeer_sym;
RiemmanSolverMode riemman_config = HLL;
SlopeLimConfig slope_config = SlopeLimConfig{SlopeLimConfig::VanLeer_sym};

void set_slope_limiter(const nlohmann::json &j) { j.get_to<SlopeLimConfig>(slope_config); }

bool face_half_time_interpolation = true;

inline bool should_compute_rho_mean() { return is_gravity_on() && is_boundary_periodic(); }
Expand Down
62 changes: 57 additions & 5 deletions src/shammodels/ramses/src/pyRamsesModel.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,30 +72,82 @@ namespace shammodels::basegodunov {
[](TConfig &self) {
self.riemman_config = Rusanov;
})
.def(
"set_slope_limiter",
[](TConfig &self, std::string slope_mode) {
self.set_slope_limiter(
nlohmann::json{
{"slope_mode", slope_mode},
});
},
py::arg("slope_mode"),
R"==(
Set the slope limiter mode.
)==")
.def(
"set_slope_lim_none",
[](TConfig &self) {
self.slope_config = None;
ON_RANK_0(
logger::warn_ln(
"Ramses::SolverConfig",
".set_slope_lim_none() is deprecated, use .set_slope_limiter(\"none\") "
"instead"));
self.set_slope_limiter(
nlohmann::json{
{"slope_mode", "none"},
});
})
.def(
"set_slope_lim_vanleer_f",
[](TConfig &self) {
self.slope_config = VanLeer_f;
ON_RANK_0(
logger::warn_ln(
"Ramses::SolverConfig",
".set_slope_lim_vanleer_f() is deprecated, use "
".set_slope_limiter(\"vanleer_f\") instead"));
self.set_slope_limiter(
nlohmann::json{
{"slope_mode", "vanleer_f"},
});
})
.def(
"set_slope_lim_vanleer_std",
[](TConfig &self) {
self.slope_config = VanLeer_std;
ON_RANK_0(
logger::warn_ln(
"Ramses::SolverConfig",
".set_slope_lim_vanleer_std() is deprecated, use "
".set_slope_limiter(\"vanleer_std\") instead"));
self.set_slope_limiter(
nlohmann::json{
{"slope_mode", "vanleer_std"},
});
})
.def(
"set_slope_lim_vanleer_sym",
[](TConfig &self) {
self.slope_config = VanLeer_sym;
ON_RANK_0(
logger::warn_ln(
"Ramses::SolverConfig",
".set_slope_lim_vanleer_sym() is deprecated, use "
".set_slope_limiter(\"vanleer_sym\") instead"));
self.set_slope_limiter(
nlohmann::json{
{"slope_mode", "vanleer_sym"},
});
})
.def(
"set_slope_lim_minmod",
[](TConfig &self) {
self.slope_config = Minmod;
ON_RANK_0(
logger::warn_ln(
"Ramses::SolverConfig",
".set_slope_lim_minmod() is deprecated, use "
".set_slope_limiter(\"minmod\") instead"));
self.set_slope_limiter(
nlohmann::json{
{"slope_mode", "minmod"},
});
})
.def(
"set_face_time_interpolation",
Expand Down
Loading