shamrock.model_sph.SPHModel_f64_3_M6#
- class shamrock.model_sph.SPHModel_f64_3_M6#
Bases:
pybind11_objectMethods
This function generate a shamrock sph solver config from a phantom dump
Get the dimensions of a periodic box holding a true FCC lattice of xcnt * ycnt * zcnt (see setup.make_generator_lattice_fcc).
Get the last CFL timesteps stored in the synchronized edges.
Overloaded function.
Overloaded function.
Overloaded function.
Overloaded function.
Overloaded function.
- add_big_disc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6, arg0: float, arg1: f64_3, arg2: f64_3) None#
- add_cube_hcp_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: float, arg1: f64_3, arg2: f64_3) None#
- add_cube_hcp_3d_v2(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: float, arg1: f64_3, arg2: f64_3) None#
- add_disc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6, 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_M6, arg0: str, arg1: str, arg2: object, arg3: f64_3, arg4: float) None#
- add_sink(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: float, arg1: f64_3, arg2: f64_3, arg3: float) None#
- add_timestep_callback(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, *, step_begin: Callable[[], None] | None = None, step_end: Callable[[], None] | None = None) None#
- change_htolerances(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, *, coarse: float, fine: float) None#
- compute_field(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, name: str, field_type: str, custom_getter: Callable[[int, shamrock.pyshamrock.PatchDataLazyGetter], numpy.ndarray[numpy.float64]] | None = None) shamrock.pyshamrock.Field_f64 | shamrock.pyshamrock.Field_f64_3#
- evolve_once_override_time(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, t_curr: float, dt_input: float) float#
- evolve_until(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, target_time: float, *, niter_max: int = -1, max_walltime: float = -1) shamrock.pyshamrock.EvolveUntilResults#
- gen_config_from_phantom_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, dump: shammodels::sph::PhantomDump, bypass_error: bool = False) shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6_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_M6) shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6_SolverConfig#
- get_box_dim_fcc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: float, arg1: int, arg2: int, arg3: int) f64_3#
- get_box_dim_true_fcc_3d(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, dr: float, xcnt: int, ycnt: int, zcnt: int) f64_3#
Get the dimensions of a periodic box holding a true FCC lattice of xcnt * ycnt * zcnt (see setup.make_generator_lattice_fcc). Unlike get_box_dim_fcc_3d (which actually describes a HCP lattice and is kept for backward compatibility), this throws if the box cannot be periodic: xcnt must be >= 2, ycnt even and zcnt a multiple of 3.
- get_closest_part_to(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: f64_3) f64_3#
- get_current_config(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6_SolverConfig#
- get_ideal_fcc_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6, arg0: float, arg1: f64_3, arg2: f64_3) tuple[f64_3, f64_3]#
- get_last_cfl_dts(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) dict#
Get the last CFL timesteps stored in the synchronized edges.
Returns a dict keyed by synchronized edge name:
"cfl_dt": the global CFL timestep of the last step (min over all CFL conditions)."cfl_dt_<type>"(e.g."cfl_dt_courant","cfl_dt_force","cfl_dt_sink_sink"): the CFL timestep of each condition enabled in the solver config, only present whenshow_cfl_detailis enabled.
All values are 0 before the first step. A condition that was not evaluated during the last step (e.g.
"cfl_dt_sink_sink"with no sinks) keeps its previous value.
- get_patch_transform(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shamrock.pyshamrock.PatchCoordTransform_f64_3#
- get_setup(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6_SPHSetup#
- get_units(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shamrock.pyshamrock.UnitSystem | None#
- init_from_phantom_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, dump: shammodels::sph::PhantomDump, hpart_fact_load: float = 1.0) None#
- make_analysis_disc(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6_AnalysisDisc#
- make_analysis_sodtube(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6_AnalysisSodTube#
- make_phantom_dump(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shammodels::sph::PhantomDump#
- overwrite_field_value_f64(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: str, arg1: Callable[[shamrock.pyshamrock.PatchDataLazyGetter], list[float]], arg2: int) None#
- overwrite_field_value_f64_3(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: str, arg1: Callable[[shamrock.pyshamrock.PatchDataLazyGetter], list[f64_3]], arg2: int) None#
- push_particle(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: list[f64_3], arg1: list[float], arg2: list[float]) None#
- push_particle_mhd(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6, arg0: Callable[[f64_3], f64_3]) None#
- render_azymuthal_integ(*args, **kwargs)#
Overloaded function.
render_azymuthal_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, name: str, field_type: str, ring_rays: list[shamrock.pyshamrock.math.RingRay_f64_3], custom_getter: Optional[Callable[[int, shamrock.pyshamrock.PatchDataLazyGetter], numpy.ndarray[numpy.float64]]] = None) -> Union[list[float], list[f64_3]]
render_azymuthal_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64, ring_rays: list[shamrock.pyshamrock.math.RingRay_f64_3]) -> list[float]
render_azymuthal_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64_3, ring_rays: list[shamrock.pyshamrock.math.RingRay_f64_3]) -> list[f64_3]
- render_cartesian_column_integ(*args, **kwargs)#
Overloaded function.
render_cartesian_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, name: str, field_type: str, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int, custom_getter: Optional[Callable[[int, shamrock.pyshamrock.PatchDataLazyGetter], numpy.ndarray[numpy.float64]]] = None) -> Union[numpy.ndarray[numpy.float64]]
render_cartesian_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int) -> numpy.ndarray[numpy.float64]
render_cartesian_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64_3, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int) -> numpy.ndarray[numpy.float64]
- render_cartesian_slice(*args, **kwargs)#
Overloaded function.
render_cartesian_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, name: str, field_type: str, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int, custom_getter: Optional[Callable[[int, shamrock.pyshamrock.PatchDataLazyGetter], numpy.ndarray[numpy.float64]]] = None) -> Union[numpy.ndarray[numpy.float64]]
render_cartesian_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int) -> numpy.ndarray[numpy.float64]
render_cartesian_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64_3, center: f64_3, delta_x: f64_3, delta_y: f64_3, nx: int, ny: int) -> numpy.ndarray[numpy.float64]
- render_column_integ(*args, **kwargs)#
Overloaded function.
render_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, name: str, field_type: str, rays: list[shamrock.pyshamrock.math.Ray_f64_3], custom_getter: Optional[Callable[[int, shamrock.pyshamrock.PatchDataLazyGetter], numpy.ndarray[numpy.float64]]] = None) -> Union[list[float], list[f64_3]]
render_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64, rays: list[shamrock.pyshamrock.math.Ray_f64_3]) -> list[float]
render_column_integ(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64_3, rays: list[shamrock.pyshamrock.math.Ray_f64_3]) -> list[f64_3]
- render_slice(*args, **kwargs)#
Overloaded function.
render_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, name: str, field_type: str, positions: list[f64_3], custom_getter: Optional[Callable[[int, shamrock.pyshamrock.PatchDataLazyGetter], numpy.ndarray[numpy.float64]]] = None) -> Union[list[float], list[f64_3]]
render_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64, positions: list[f64_3]) -> list[float]
render_slice(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, field: shamrock.pyshamrock.Field_f64_3, positions: list[f64_3]) -> list[f64_3]
- resize_simulation_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: f64_3, arg1: f64_3) None#
- set_field_value_lambda_f64(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6, field_name: str, pos_to_val: Callable[[f64_3], f64_3], offset: int = 0) None#
- set_solver_config(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, arg0: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6_SolverConfig) None#
- set_value_in_a_box(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6, 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_M6, arg0: str, arg1: str, arg2: object, arg3: f64_3, arg4: float) None#
- timestep(self: shamrock.pyshamrock.model_sph.SPHModel_f64_3_M6) shammodels::sph::TimestepLog#