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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! todo

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

use super::CurrentData;

#[allow(dead_code)]
/// the default current is (u, v) = (0, 0)
pub(crate) const DEFAULT_CURRENT: ConstantCurrent = ConstantCurrent { u: 0.0, v: 0.0 };

/// struct representing a constant current field.
///
/// # Properties:
///
/// * `u`: `f64` value representing x component of the current.
///
/// * `v`: `f64` value representing y component of the current.
pub(crate) struct ConstantCurrent {
    /// x component of the current
    u: f64,
    /// y component of the current
    v: f64,
}

#[allow(dead_code)]
impl ConstantCurrent {
    /// Constructor
    ///
    /// # Returns
    /// returns the constructed ConstantCurrent
    pub(crate) fn new(u: f64, v: f64) -> Self {
        ConstantCurrent { u, v }
    }
}

impl CurrentData for ConstantCurrent {
    /// get the current at point (x, y)
    ///
    /// # Arguments
    /// - `x` : `f64` the x location
    ///
    /// - `y` : `f64` the y location
    ///
    /// # Returns
    /// `Result<(f64, f64), Error>` : returns the values (u, v) or an Error.
    ///
    /// # Error
    /// The trait definition includes the chance for error. However, the
    /// `ConstantCurrent::current` should never return an error.
    fn current(&self, _point: &Point<f64>) -> Result<Current<f64>> {
        Ok(Current::new(self.u, self.v))
    }

    /// get the current and gradient at point (x, y)
    ///
    /// # Arguments
    /// - `x` : `f64` the x location
    ///
    /// - `y` : `f64` the y location
    ///
    /// # Returns
    /// `Result<((f64, f64), (f64, f64, f64, f64)), Error>` : returns the values
    /// (u, v) and (du/dx, du/dy, dv/dx, dv/dy) or an Error.
    ///
    /// # Error
    /// The trait definition includes the chance for error. However, the
    /// `ConstantCurrent::current_and_gradient` should never return an error.
    fn current_and_gradient(
        &self,
        _point: &Point<f64>,
    ) -> Result<(Current<f64>, (Gradient<f64>, Gradient<f64>))> {
        Ok((
            Current::new(self.u, self.v),
            (Gradient::new(0.0, 0.0), Gradient::new(0.0, 0.0)),
        ))
    }
}