shamrock.model_sph.SPHModel_f64_3_M4#

class shamrock.model_sph.SPHModel_f64_3_M4#

Bases: pybind11_object

Methods

`add_big_disc_3d`
`add_cube_fcc_3d`
`add_cube_hcp_3d`
`add_cube_hcp_3d_v2`
`add_disc_3d`
`add_disc_3d_keplerian`
`add_kernel_value`
`add_sink`
`add_timestep_callback`
`apply_momentum_offset`
`apply_position_offset`
`change_htolerance`
`change_htolerances`
`compute_field`
`do_vtk_dump`
`dump`
`evolve_once`
`evolve_once_override_time`
`evolve_until`
`gen_config_from_phantom_dump`	This function generate a shamrock sph solver config from a phantom dump
`gen_default_config`
`get_box_dim_fcc_3d`
`get_closest_part_to`
`get_current_config`
`get_dt`
`get_hfact`
`get_ideal_fcc_box`
`get_ideal_hcp_box`
`get_particle_mass`
`get_patch_transform`
`get_setup`
`get_sinks`
`get_solver_dot_graph`
`get_solver_tex`
`get_sum`
`get_time`
`get_total_part_count`
`get_units`
`init`
`init_from_phantom_dump`
`init_scheduler`
`load_from_dump`
`make_analysis_disc`
`make_analysis_sodtube`
`make_phantom_dump`
`overwrite_field_value_f64`
`overwrite_field_value_f64_3`
`push_particle`
`push_particle_mhd`
`remap_positions`
`render_azymuthal_integ`
`render_cartesian_column_integ`
`render_cartesian_slice`
`render_column_integ`
`render_slice`
`resize_simulation_box`
`rho_h`
`set_cfl_cour`
`set_cfl_force`
`set_cfl_mult_stiffness`
`set_cfl_multipler`
`set_debug_dump`
`set_dt`
`set_eta_sink`
`set_field_value_lambda_f64`
`set_field_value_lambda_f64_3`
`set_next_dt`
`set_particle_mass`
`set_solver_config`
`set_time`
`set_value_in_a_box`
`set_value_in_sphere`
`solver_logs_cumulated_step_time`
`solver_logs_last_obj_count`
`solver_logs_last_rate`
`solver_logs_last_system_metrics`
`solver_logs_reset_cumulated_step_time`
`solver_logs_reset_step_count`
`solver_logs_step_count`
`timestep`
`total_mass_to_part_mass`

Init a simulation from another simulation

Killing sphere for SPH simulation

Basic disc simulation

Custom warp disc simulation

Using Shamrock SPH rendering module

Start a SPH simulation from a phantom dump

Tracking particles by id in SPH

Uniform box in SPH

Init a simulation from an upscaled simulation

add_big_disc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3, arg1: float, arg2: int, arg3: float, arg4: float, arg5: float, arg6: float, arg7: float, arg8: float, arg9: int) → float#

add_cube_fcc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: f64_3, arg2: f64_3) → None#

add_cube_hcp_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: f64_3, arg2: f64_3) → None#

add_cube_hcp_3d_v2(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: f64_3, arg2: f64_3) → None#

add_disc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3, arg1: float, arg2: int, arg3: float, arg4: float, arg5: float, arg6: float, arg7: float, arg8: float) → float#

add_disc_3d_keplerian(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3, arg1: int, arg2: float, arg3: float, arg4: float, arg5: float, arg6: float, arg7: float, arg8: float) → None#

add_kernel_value(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str, arg1: str, arg2: object, arg3: f64_3, arg4: float) → None#

add_sink(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: f64_3, arg2: f64_3, arg3: float) → None#

add_timestep_callback(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, *, step_begin: Callable[[], None] | None = None, step_end: Callable[[], None] | None = None) → None#

apply_momentum_offset(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3) → None#

apply_position_offset(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3) → None#

change_htolerance(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float) → None#

change_htolerances(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, *, coarse: float, fine: float) → None#

compute_field(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, name: str, field_type: str, custom_getter: Callable[[int, dict], numpy.ndarray[numpy.float64]] | None = None) → shamrock.pyshamrock.Field_f64 | shamrock.pyshamrock.Field_f64_3#

do_vtk_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str, arg1: bool) → None#

dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str) → None#

evolve_once(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → None#

evolve_once_override_time(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, t_curr: float, dt_input: float) → float#

evolve_until(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, target_time: float, *, niter_max: int = -1) → bool#

gen_config_from_phantom_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, dump: shammodels::sph::PhantomDump, bypass_error: bool = False) → shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig#: This function generate a shamrock sph solver config from a phantom dump

Parameters#

PhantomDump dump bypass_error = false (default) bypass any error in the config

gen_default_config(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig#

get_box_dim_fcc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: int, arg2: int, arg3: int) → f64_3#

get_closest_part_to(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3) → f64_3#

get_current_config(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig#

get_dt(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → float#

get_hfact(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → float#

get_ideal_fcc_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: f64_3, arg2: f64_3) → tuple[f64_3, f64_3]#

get_ideal_hcp_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float, arg1: f64_3, arg2: f64_3) → tuple[f64_3, f64_3]#

get_particle_mass(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → float#

get_patch_transform(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shamrock.pyshamrock.PatchCoordTransform_f64_3#

get_setup(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SPHSetup#

get_sinks(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → list#

get_solver_dot_graph(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → str#

get_solver_tex(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → str#

get_sum(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str, arg1: str) → object#

get_time(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → float#

get_total_part_count(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → int#

get_units(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shamrock.pyshamrock.UnitSystem | None#

init(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → None#

init_from_phantom_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, dump: shammodels::sph::PhantomDump, hpart_fact_load: float = 1.0) → None#

init_scheduler(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: int, arg1: int) → None#

load_from_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str) → None#

make_analysis_disc(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_AnalysisDisc#

make_analysis_sodtube(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, sod: shamrock.pyshamrock.phys.SodTube, direction: f64_3, time_val: float, x_ref: float, x_min: float, x_max: float) → shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_AnalysisSodTube#

make_phantom_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shammodels::sph::PhantomDump#

overwrite_field_value_f64(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str, arg1: Callable[[dict], list[float]], arg2: int) → None#

overwrite_field_value_f64_3(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str, arg1: Callable[[dict], list[f64_3]], arg2: int) → None#

push_particle(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: list[f64_3], arg1: list[float], arg2: list[float]) → None#

push_particle_mhd(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: list[f64_3], arg1: list[float], arg2: list[float], arg3: list[f64_3], arg4: list[float]) → None#

remap_positions(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: Callable[[f64_3], f64_3]) → None#

render_azymuthal_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, name: str, field_type: str, ring_rays: list[shamrock.pyshamrock.math.RingRay_f64_3], custom_getter: Callable[[int, dict], numpy.ndarray[numpy.float64]] | None = None) → list[float] | list[f64_3]#

render_cartesian_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, name: str, field_type: str, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int, custom_getter: Callable[[int, dict], numpy.ndarray[numpy.float64]] | None = None) → numpy.ndarray[numpy.float64]#

render_cartesian_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, name: str, field_type: str, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int, custom_getter: Callable[[int, dict], numpy.ndarray[numpy.float64]] | None = None) → numpy.ndarray[numpy.float64]#

render_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, name: str, field_type: str, rays: list[shamrock.pyshamrock.math.Ray_f64_3], custom_getter: Callable[[int, dict], numpy.ndarray[numpy.float64]] | None = None) → list[float] | list[f64_3]#

render_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, name: str, field_type: str, positions: list[f64_3], custom_getter: Callable[[int, dict], numpy.ndarray[numpy.float64]] | None = None) → list[float] | list[f64_3]#

resize_simulation_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: f64_3, arg1: f64_3) → None#

rho_h(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float) → float#

set_cfl_cour(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, cfl_cour: float) → None#

set_cfl_force(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, cfl_force: float) → None#

set_cfl_mult_stiffness(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, cstiff: float) → None#

set_cfl_multipler(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, lambda: float) → None#

set_debug_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: bool, arg1: str) → None#

set_dt(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float) → None#

set_eta_sink(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, eta_sink: float) → None#

set_field_value_lambda_f64(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, field_name: str, pos_to_val: Callable[[f64_3], float], offset: int = 0) → None#

set_field_value_lambda_f64_3(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, field_name: str, pos_to_val: Callable[[f64_3], f64_3], offset: int = 0) → None#

set_next_dt(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float) → None#

set_particle_mass(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, gpart_mass: float) → None#

set_solver_config(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4_SolverConfig) → None#

set_time(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float) → None#

set_value_in_a_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, field_name: str, field_type: str, value: object, box_min: f64_3, box_max: f64_3, *, ivar: int = 0) → None#

set_value_in_sphere(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: str, arg1: str, arg2: object, arg3: f64_3, arg4: float) → None#

solver_logs_cumulated_step_time(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → float#

solver_logs_last_obj_count(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → int#

solver_logs_last_rate(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → float#

solver_logs_last_system_metrics(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → dict#

solver_logs_reset_cumulated_step_time(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → None#

solver_logs_reset_step_count(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → None#

solver_logs_step_count(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → int#

timestep(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4) → shammodels::sph::TimestepLog#

total_mass_to_part_mass(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M4, arg0: float) → float#

shamrock.model_sph.SPHModel_f64_3_M4#

Parameters#