Overview of Scenarios

All three scenario dicts are merged under apebench.scenarios.scenario_dict.

Difficulty Mode

apebench.scenarios.difficulty.scenario_dict module-attribute

scenario_dict = {
    "diff_lin": Linear,
    "diff_lin_simple": LinearSimple,
    "diff_adv": Advection,
    "diff_diff": Diffusion,
    "diff_adv_diff": AdvectionDiffusion,
    "diff_disp": Dispersion,
    "diff_hyp_diff": HyperDiffusion,
    "diff_four": FirstFour,
    "diff_conv": Convection,
    "diff_burgers": Burgers,
    "diff_kdv": KortewegDeVries,
    "diff_ks_cons": KuramotoSivashinskyConservative,
    "diff_ks": KuramotoSivashinsky,
    "diff_nonlin": Nonlinear,
    "diff_burgers_sc": BurgersSingleChannel,
    "diff_fisher": FisherKPP,
}

Physical Mode

apebench.scenarios.physical.scenario_dict module-attribute

scenario_dict = {
    "phy_poisson": Poisson,
    "phy_sh": SwiftHohenberg,
    "phy_gs": GrayScott,
    "phy_gs_type": GrayScottType,
    "phy_decay_turb": DecayingTurbulence,
    "phy_kolm_flow": KolmogorovFlow,
    "phy_lin": Linear,
    "phy_lin_simple": LinearSimple,
    "phy_adv": Advection,
    "phy_diff": Diffusion,
    "phy_adv_diff": AdvectionDiffusion,
    "phy_disp": Dispersion,
    "phy_hyp_diff": HyperDiffusion,
    "phy_four": FirstFour,
    "phy_nonlin": Nonlinear,
    "phy_burgers_sc": BurgersSingleChannel,
    "phy_kdv": KortewegDeVries,
    "phy_ks": KuramotoSivashinsky,
    "phy_conv": Convection,
    "phy_burgers": Burgers,
    "phy_ks_cons": KuramotoSivashinskyConservative,
    "phy_poly": Polynomial,
    "phy_fisher": FisherKPP,
    "phy_unbal_adv": UnbalancedAdvection,
    "phy_diag_diff": DiagonalDiffusion,
    "phy_aniso_diff": AnisotropicDiffusion,
    "phy_mix_disp": SpatiallyMixedDispersion,
    "phy_mix_hyp": SpatiallyMixedHyperDiffusion,
}

Normalized Mode

apebench.scenarios.normalized.scenario_dict module-attribute

scenario_dict = {
    "norm_lin": Linear,
    "norm_adv": Advection,
    "norm_diff": Diffusion,
    "norm_adv_diff": AdvectionDiffusion,
    "norm_disp": Dispersion,
    "norm_fisher": FisherKPP,
    "norm_four": FirstFour,
    "norm_hypdiff": HyperDiffusion,
    "norm_nonlin": Nonlinear,
    "norm_conv": Convection,
    "norm_burgers": Burgers,
    "norm_kdv": KortewegDeVries,
    "norm_ks_cons": KuramotoSivashinskyConservative,
    "norm_ks": KuramotoSivashinsky,
    "norm_burgers_sc": BurgersSingleChannel,
    "norm_lin_simple": LinearSimple,
}

Scenarios Guaranteed to be Stable

... under their default configuration. For difficulty-based scenarios, all of them are valid for 1d, 2d, and 3d.

apebench.scenarios.guaranteed_non_nan module-attribute

guaranteed_non_nan: list[tuple[str, int]] = [
    ("norm_lin", 1),
    ("norm_adv", 1),
    ("norm_diff", 1),
    ("norm_adv_diff", 1),
    ("norm_disp", 1),
    ("norm_fisher", 1),
    ("norm_four", 1),
    ("norm_hypdiff", 1),
    ("norm_nonlin", 1),
    ("norm_conv", 1),
    ("norm_burgers", 1),
    ("norm_kdv", 1),
    ("norm_ks_cons", 1),
    ("norm_ks", 1),
    ("norm_burgers_sc", 1),
    ("norm_lin_simple", 1),
    ("phy_poisson", 1),
    ("phy_sh", 2),
    ("phy_gs", 2),
    ("phy_gs_type", 2),
    ("phy_decay_turb", 2),
    ("phy_kolm_flow", 2),
    ("phy_lin", 1),
    ("phy_lin_simple", 1),
    ("phy_adv", 1),
    ("phy_diff", 1),
    ("phy_adv_diff", 1),
    ("phy_disp", 1),
    ("phy_hyp_diff", 1),
    ("phy_four", 1),
    ("phy_nonlin", 1),
    ("phy_burgers_sc", 1),
    ("phy_kdv", 1),
    ("phy_ks", 1),
    ("phy_conv", 1),
    ("phy_burgers", 1),
    ("phy_ks_cons", 1),
    ("phy_poly", 1),
    ("phy_fisher", 1),
    ("phy_unbal_adv", 3),
    ("phy_diag_diff", 2),
    ("phy_aniso_diff", 2),
    ("phy_mix_disp", 2),
    ("phy_mix_hyp", 2),
]