Struct salva3d::TimestepManager[−][src]

pub struct TimestepManager { /* fields omitted */ }

Expand description

Structure responsible for regulating the timestep length of the simulation.

Implementations

[src]

impl TimestepManager

[src]

pub fn new(particle_radius: Real) -> Self

Initialize a new timestep manager with default parameters.

[src]

pub fn reset(&mut self, total_step_size: Real)

Resets the remaining time of the timestep manager.

[src]

pub fn is_done(&self) -> bool

Checks if all the time of this timestep has been consumed.

[src]

pub fn dt(&self) -> Real

The current substep length.

[src]

pub fn inv_dt(&self) -> Real

The inverse of the current substep length.

If the substep length is zero, this inverse is also zero.

[src]

pub fn advance(&mut self, fluids: &[Fluid ])

Advance to the next substep.

Auto Trait Implementations

impl RefUnwindSafe for TimestepManager

impl Send for TimestepManager

impl Sync for TimestepManager

impl Unpin for TimestepManager

impl UnwindSafe for TimestepManager

Blanket Implementations

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

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

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

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

pub fn is_in_subset(&self) -> bool

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

pub fn to_subset_unchecked(&self) -> SS

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

pub fn from_subset(element: &SS) -> SP

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

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct salva3d::TimestepManager[−][src]

Implementations

impl TimestepManager

pub fn new(particle_radius: Real) -> Self

pub fn reset(&mut self, total_step_size: Real)

pub fn is_done(&self) -> bool

pub fn dt(&self) -> Real

pub fn inv_dt(&self) -> Real

pub fn advance(&mut self, fluids: &[Fluid ])

Auto Trait Implementations

impl RefUnwindSafe for TimestepManager

impl Send for TimestepManager

impl Sync for TimestepManager

impl Unpin for TimestepManager

impl UnwindSafe for TimestepManager

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

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

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

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

type Error = Infallible

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

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

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

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

Struct salva3d::TimestepManager[−][src]

Implementations

impl TimestepManager

pub fn new(particle_radius: Real) -> Self

pub fn reset(&mut self, total_step_size: Real)

pub fn is_done(&self) -> bool

pub fn dt(&self) -> Real

pub fn inv_dt(&self) -> Real

pub fn advance(&mut self, fluids: &[Fluid])

Auto Trait Implementations

impl RefUnwindSafe for TimestepManager

impl Send for TimestepManager

impl Sync for TimestepManager

impl Unpin for TimestepManager

impl UnwindSafe for TimestepManager

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

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

pub fn is_in_subset(&self) -> bool

pub fn to_subset_unchecked(&self) -> SS

pub fn from_subset(element: &SS) -> SP

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

type Error = Infallible

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

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

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

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

pub fn advance(&mut self, fluids: &[Fluid ])

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

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

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

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

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

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

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