mantaray 0.2.0

Ray-tracing solver for ocean surface gravity waves that integrates the wave ray equations over spatially varying currents and bathymetry.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! CurrentData
//!
//! This module contains the following structs that implement the `CurrentData`
//! trait:
//! - `ConstantCurrent`

use crate::datatype::{Current, Gradient, Point};
use crate::error::Result;

mod cartesian_current;
mod constant_current;

#[allow(unused_imports)]
pub(super) use cartesian_current::CartesianCurrent;
#[allow(unused_imports)]
pub(super) use constant_current::ConstantCurrent;
#[allow(unused_imports)]
pub(super) use constant_current::DEFAULT_CURRENT;

/// A trait implementing methods to get current and gradient
pub(crate) trait CurrentData: Sync {
    #[allow(dead_code)]
    /// Current (u, v) at the given (x, y)
    fn current(&self, point: &Point<f64>) -> Result<Current<f64>>;

    /// Current (u, v) and the gradient (du/dx, du/dy, dv/dx, dv/dy)
    fn current_and_gradient(
        &self,
        point: &Point<f64>,
    ) -> Result<(Current<f64>, (Gradient<f64>, Gradient<f64>))>;
}