shamrock.model_sph.SPHModel_f64_3_M4_SolverConfig#

class shamrock.model_sph.SPHModel_f64_3_M4_SolverConfig#

Bases: pybind11_object

Methods

add_ext_force_lense_thirring

add_ext_force_paczynski_wiita

add_ext_force_point_mass

add_ext_force_shearing_box

add_ext_force_velocity_dissipation

add_ext_force_vertical_disc_potential

add_kill_sphere

compute_GW

from_json

Converts a json like dictionary to a config

get_units

print_status

set_IdealMHD

set_NonIdealMHD

set_artif_viscosity_Constant

set_artif_viscosity_ConstantDisc

set_artif_viscosity_None

set_artif_viscosity_VaryingCD10

set_artif_viscosity_VaryingMM97

set_boundary_free

set_boundary_periodic

set_boundary_shearing_periodic

set_cfl_cour

set_cfl_force

set_cfl_mult_stiffness

set_dust_ballabio_ts_limiter

set_dust_drag_constant

set_dust_drag_epstein

set_dust_evol_coala_coag

Enable the COALA dust coagulation source term.

set_dust_mode_monofluid_complete

set_dust_mode_monofluid_tva

set_dust_mode_none

set_enable_particle_reordering

set_eos_adiabatic

set_eos_barotropic

set_eos_fermi

set_eos_isothermal

set_eos_locally_isothermal

set_eos_locally_isothermalFA2014

set_eos_locally_isothermalFA2014_extended

set_eos_locally_isothermalLP07

set_eos_polytropic

set_eta_sink

set_filter_empty_patch_gz

set_max_neigh_cache_size

set_neigh_cache_strategy

Set the strategy used to build the neighbours cache.

set_particle_mass

set_particle_reordering_step_freq

set_particle_tracking

set_save_dt_to_fields

set_scheduler_config

set_self_gravity_direct

set_self_gravity_fmm

set_self_gravity_mm

set_self_gravity_none

set_self_gravity_sfmm

set_show_cfl_detail

set_show_ghost_stats

set_show_ghost_zone_graph

set_show_neigh_stats

set_smoothing_length_density_based

set_smoothing_length_density_based_bisecting_nr

set_smoothing_length_density_based_neigh_lim

set_softening_none

set_softening_plummer

set_tree_reduction_level

set_two_stage_search

Set the neighbours cache strategy from a boolean.

set_units

should_save_dt_to_fields

to_json

Converts the config to a json like dictionary

use_luminosity

Sphere advection with multiple patch

Sphere advection with multiple patch

Init a simulation from another simulation

Init a simulation from another simulation

Killing sphere for SPH simulation

Killing sphere for SPH simulation

Orszag-Tang vortex in SPH

Orszag-Tang vortex in SPH

Basic disc simulation

Basic disc simulation

Custom warp disc simulation

Custom warp disc simulation

Using Shamrock SPH rendering module

Using Shamrock SPH rendering module

Shearing box in SPH

Shearing box in SPH

SPH Setup logs

SPH Setup logs

Tracking particles by id in SPH

Tracking particles by id in SPH

Uniform box in SPH

Uniform box in SPH

Init a simulation from an upscaled simulation

Init a simulation from an upscaled simulation

Isolated star GW emmission

Isolated star GW emmission

Testing the MHD rotor problem (3D) with SPMHD

Testing the MHD rotor problem (3D) with SPMHD

CI test: SPH barotropic equation of state

CI test: SPH barotropic equation of state
add_ext_force_lense_thirring(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, central_mass: float, Racc: float, a_spin: float, dir_spin: f64_3, central_pos: f64_3 = (0.0, 0.0, 0.0)) → None#
add_ext_force_paczynski_wiita(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float, arg1: f64_3, arg2: float) → None#
add_ext_force_point_mass(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, central_mass: float, Racc: float, *, central_pos: f64_3 = (0.0, 0.0, 0.0)) → None#
add_ext_force_shearing_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, Omega_0: float, eta: float, q: float) → None#
add_ext_force_velocity_dissipation(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, eta: float) → None#
add_ext_force_vertical_disc_potential(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, central_mass: float, R0: float) → None#
add_kill_sphere(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, center: f64_3, radius: float) → None#
compute_GW(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
from_json(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: object) → None#

Converts a json like dictionary to a config

get_units(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → shamrock.pyshamrock.UnitSystem | None#
print_status(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_IdealMHD(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, sigma_mhd: float, alpha_B: float = 1.0) → None#
set_NonIdealMHD(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, sigma_mhd: float, etaO: float, etaH: float, etaAD: float, alpha_B: float = 1.0) → None#
set_artif_viscosity_Constant(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, alpha_u: float, alpha_AV: float, beta_AV: float) → None#
set_artif_viscosity_ConstantDisc(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, alpha_AV: float, alpha_u: float, beta_AV: float) → None#
set_artif_viscosity_None(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_artif_viscosity_VaryingCD10(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, alpha_min: float, alpha_max: float, sigma_decay: float, alpha_u: float, beta_AV: float) → None#
set_artif_viscosity_VaryingMM97(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, alpha_min: float, alpha_max: float, sigma_decay: float, alpha_u: float, beta_AV: float) → None#
set_boundary_free(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_boundary_periodic(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_boundary_shearing_periodic(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: i32_3, arg1: i32_3, arg2: float) → None#
set_cfl_cour(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_cfl_force(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_cfl_mult_stiffness(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_dust_ballabio_ts_limiter(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, enabled: bool) → None#
set_dust_drag_constant(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: list[float]) → None#
set_dust_drag_epstein(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, gamma: float, grain_sizes: list[float], grain_densities: list[float]) → None#
set_dust_evol_coala_coag(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, rhodust_eps: float, vfrag_threshold: float, massgrid: list[float], tabflux_coag: numpy.ndarray[numpy.float64], tau_frac: float = 10.0) → None#

Enable the COALA dust coagulation source term.

Args:

rhodust_eps: Dust density floor. vfrag_threshold: Fragmentation velocity threshold, must be positive.

In this coagulation-only mode, a pair of dust bins whose differential velocity |dv_ij| exceeds this value gets dv_ij = 0. This is a crude stand-in for fragmentation (“poor man” fragmentation), not a fragmentation model. Pass math.inf to disable it.

massgrid: Dust mass grid bin edges, of size nbins + 1. tabflux_coag: Tabulated coagulation flux, of shape

(nbins, nbins, nbins).

tau_frac: The source term on s_j is integrated implicitly over

dt_eff = max(dt, tau_frac * rhodust_eps / |S|), that is over at least the time needed to move tau_frac * rhodust_eps. This bounds the rate of an empty bin when dt is null or tiny (e.g. right after a dust injection). Must be positive.

set_dust_mode_monofluid_complete(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, ndust: int) → None#
set_dust_mode_monofluid_tva(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, nvar: int, pure_diffusion_mode: bool = False, C_1_fluid: float = 0.1, C_drift: float = 1.0, cfl_density_threshold: float = 2.220446049250313e-16, ensure_s_j_positivity: bool = True, smooth_s_positivity_limiter: bool = False, dust_corrected_av: bool = False, clamp_dust_frac: float | None = None, pair_gate_s_positivity_limiter: bool = False) → None#
set_dust_mode_none(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_enable_particle_reordering(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_eos_adiabatic(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_eos_barotropic(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, cs0: float, rho0: float, gamma0: float = 1.6666666666666667) → None#
set_eos_fermi(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, mu_e: float) → None#
set_eos_isothermal(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_eos_locally_isothermal(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_eos_locally_isothermalFA2014(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, h_over_r: float) → None#
set_eos_locally_isothermalFA2014_extended(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, cs0: float, q: float, r0: float, n_sinks: int) → None#
set_eos_locally_isothermalLP07(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, cs0: float, q: float, r0: float) → None#
set_eos_polytropic(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float, arg1: float) → None#
set_eta_sink(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_filter_empty_patch_gz(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_max_neigh_cache_size(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: object) → None#
set_neigh_cache_strategy(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: shamrock.pyshamrock.NeighCacheStrategy) → None#

Set the strategy used to build the neighbours cache.

Parameters#

strategyNeighCacheStrategy

Either NeighCacheStrategy.SingleStage or NeighCacheStrategy.TwoStage (the default), as obtained from from shamrock import NeighCacheStrategy.

set_particle_mass(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: float) → None#
set_particle_reordering_step_freq(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: int) → None#
set_particle_tracking(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_save_dt_to_fields(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_scheduler_config(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, split_load_value: int, merge_load_value: int) → None#
set_self_gravity_direct(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, reference_mode: bool = False) → None#
set_self_gravity_fmm(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, order: int, opening_angle: float, reduction_level: int = 3) → None#
set_self_gravity_mm(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, order: int, opening_angle: float, reduction_level: int = 3) → None#
set_self_gravity_none(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_self_gravity_sfmm(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, order: int, opening_angle: float, leaf_lowering: bool = True, reduction_level: int = 3) → None#
set_show_cfl_detail(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, show_cfl_detail: bool) → None#
set_show_ghost_stats(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_show_ghost_zone_graph(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_show_neigh_stats(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#
set_smoothing_length_density_based(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_smoothing_length_density_based_bisecting_nr(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_smoothing_length_density_based_neigh_lim(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: int) → None#
set_softening_none(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#
set_softening_plummer(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, *, epsilon: float) → None#
set_tree_reduction_level(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: int) → None#

Set the neighbours cache strategy from a boolean.

Deprecated since version Use: set_neigh_cache_strategy() instead.

set_units(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: shamrock.pyshamrock.UnitSystem) → None#
should_save_dt_to_fields(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → bool#
to_json(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → object#

Converts the config to a json like dictionary

use_luminosity(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig, arg0: bool) → None#