Skip to main content

SphSolver

oxiphysics_python::sph_api

Struct SphSolver 

Source 
pub struct SphSolver {
    pub sim: PySphSimulation,
    pub variant: SphVariant,
    pub max_pressure_iters: usize,
    pub pressure_tol: f64,
}
Expand description

Wrapper that holds a PySphSimulation along with a solver variant.

Fields§

§sim: PySphSimulation

The underlying SPH simulation.

§variant: SphVariant

Which variant to use when stepping.

§max_pressure_iters: usize

DFSPH: maximum iterations for the pressure solve.

§pressure_tol: f64

DFSPH: convergence tolerance for density error.

Implementations§

Source§

impl SphSolver

Source

pub fn wcsph(config: PySphConfig) -> Self

Create a WCSPH solver.

Source

pub fn dfsph(config: PySphConfig) -> Self

Create a DFSPH solver.

Source

pub fn step(&mut self, dt: f64)

Step the simulation. WCSPH uses the standard step; DFSPH uses an iterative pressure-correction approach.

Source

pub fn density_error(&self) -> f64

Return the current density error (max |ρ - ρ₀| / ρ₀).

Source

pub fn particle_count(&self) -> usize

Number of particles.

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

fn from_subset(element: &SS) -> SP

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.