Skip to main content

PySphConfig

oxiphysics_python::sph_api

Struct PySphConfig

pub struct PySphConfig {
    pub h: f64,
    pub rest_density: f64,
    pub stiffness: f64,
    pub viscosity: f64,
    pub gravity: [f64; 3],
    pub particle_mass: f64,
    pub floor_enabled: bool,
    pub floor_y: f64,
    pub floor_restitution: f64,
}

Expand description

Configuration for the SPH simulation.

Fields§

§h: f64

Smoothing length (kernel radius h).

§rest_density: f64

Reference (rest) density ρ₀ in kg/m³.

§stiffness: f64

Pressure stiffness constant k (state-equation coefficient).

§viscosity: f64

Dynamic viscosity μ.

§gravity: [f64; 3]

Gravity vector [gx, gy, gz].

§particle_mass: f64

Mass of each particle in kg.

§floor_enabled: bool

Whether to enforce a floor boundary at y=0 (floor_y).

§floor_y: f64

Y-coordinate of the floor plane (only used when floor_enabled).

§floor_restitution: f64

Coefficient of restitution for floor bounces (0=inelastic, 1=elastic).

Implementations§

impl PySphConfig

pub fn water() -> Self

Water-like default configuration.

pub fn gas() -> Self

Gas-like configuration with low density and stiffness.

Trait Implementations§

impl Clone for PySphConfig

fn clone(&self) -> PySphConfig

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for PySphConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

impl Default for PySphConfig

fn default() -> Self

Returns the “default value” for a type. Read more

impl<'de> Deserialize<'de> for PySphConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl Serialize for PySphConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

impl Freeze for PySphConfig

impl RefUnwindSafe for PySphConfig

impl Send for PySphConfig

impl Sync for PySphConfig

impl Unpin for PySphConfig

impl UnsafeUnpin for PySphConfig

impl UnwindSafe for PySphConfig

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,