Skip to main content

WaterSurface

Struct WaterSurface 

Source
pub struct WaterSurface {
    pub width: usize,
    pub depth: usize,
    pub cell_size: f32,
    pub height: Vec<f32>,
    pub vel_x: Vec<f32>,
    pub vel_z: Vec<f32>,
    pub rest_height: f32,
    pub wave_speed: f32,
    pub damping: f32,
    pub gravity: f32,
    /* private fields */
}
Expand description

Height-field water simulation using the shallow water equations.

Implements:

  • 2D height field h(x,z) and velocity field (vx, vz)
  • Wave propagation via semi-discrete shallow water equations
  • Damping for energy dissipation
  • Rain drops creating Gaussian ripples

Fields§

§width: usize

Grid width.

§depth: usize

Grid depth.

§cell_size: f32

Cell size in world units.

§height: Vec<f32>

Height field (water depth above flat bottom).

§vel_x: Vec<f32>

X-velocity field.

§vel_z: Vec<f32>

Z-velocity field.

§rest_height: f32

Rest height (equilibrium water depth).

§wave_speed: f32

Wave speed factor.

§damping: f32

Damping coefficient (0 = no damping, 1 = full damping per step).

§gravity: f32

Gravity acceleration.

Implementations§

Source§

impl WaterSurface

Source

pub fn new(width: usize, depth: usize, cell_size: f32, rest_height: f32) -> Self

Source

pub fn rain_drop( &mut self, world_x: f32, world_z: f32, amplitude: f32, radius: f32, )

Simulate a rain drop at (world_x, world_z) with given height perturbation.

Source

pub fn add_wave_source( &mut self, z_start: usize, z_end: usize, amplitude: f32, frequency: f32, )

Add a sinusoidal wave source at the left boundary.

Source

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

Advance the water simulation by dt seconds using explicit finite difference.

Source

pub fn sample_height(&self, world_x: f32, world_z: f32) -> f32

Sample water height at a world-space (x, z) position via bilinear interpolation.

Source

pub fn surface_normal(&self, world_x: f32, world_z: f32) -> Vec3

Compute the surface normal at a world-space (x, z) position.

Source

pub fn to_positions(&self, y_offset: f32) -> Vec<Vec3>

Extract height field as a flat array of world-space Vec3 positions.

Source

pub fn max_amplitude(&self) -> f32

Max height deviation from rest height (wave amplitude proxy).

Source

pub fn total_volume(&self) -> f32

Total fluid volume.

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,