Struct Vector3 

pub struct Vector3 {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

3-component vector. Maps to Foam::vector (Foam::Vector<scalar>). Component layout: x, y, z.

Fields

x: f64

y: f64

z: f64

Implementations

impl Vector3

pub const ZERO: Self

Zero vector (0, 0, 0).

pub const ONE: Self

Vector of ones (1, 1, 1).

pub const X: Self

Unit vector along the x axis (1, 0, 0).

pub const Y: Self

Unit vector along the y axis (0, 1, 0).

pub const Z: Self

Unit vector along the z axis (0, 0, 1).

pub fn new(x: f64, y: f64, z: f64) -> Self

Construct a vector from its x, y, z components.

pub fn mag_sqr(self) -> f64

Squared magnitude: |v|² = x² + y² + z²

pub fn mag(self) -> f64

Magnitude: |v|

pub fn dist_sqr(self, other: Self) -> f64

Squared distance to another vector

pub fn dist(self, other: Self) -> f64

Distance to another vector

pub fn dot(self, other: Self) -> f64

Dot (inner) product. C++ operator&(Vector, Vector).

pub fn cross(self, other: Self) -> Self

Cross product. C++ operator^(Vector, Vector).

pub fn normalise(self, tol: f64) -> Self

Normalise to unit vector; returns zero if |v| < tol.

pub fn remove_collinear(self, unit_vec: Self) -> Self

Remove the component collinear with unit_vec: self - (self·unit) * unit.

pub fn lerp(a: Self, b: Self, t: f64) -> Self

Linear interpolation: (1-t)*a + t*b.

Trait Implementations

impl Add for Vector3

type Output = Vector3

The resulting type after applying the + operator.

fn add(self, r: Self) -> Self

Performs the + operation.

impl AddAssign for Vector3

fn add_assign(&mut self, r: Self)

Performs the += operation.

impl Clone for Vector3

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Vector3

impl Debug for Vector3

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Vector3

fn default() -> Self

Returns the “default value” for a type.

impl Div<f64> for Vector3

type Output = Vector3

The resulting type after applying the / operator.

fn div(self, s: f64) -> Self

Performs the / operation.

impl DivAssign<f64> for Vector3

fn div_assign(&mut self, s: f64)

Performs the /= operation.

impl Mul for Vector3

type Output = Tensor

The resulting type after applying the * operator.

fn mul(self, v: Vector3) -> Tensor

Performs the * operation.

impl Mul<Vector3> for f64

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, v: Vector3) -> Vector3

Performs the * operation.

impl Mul<f64> for Vector3

type Output = Vector3

The resulting type after applying the * operator.

fn mul(self, s: f64) -> Self

Performs the * operation.

impl MulAssign<f64> for Vector3

fn mul_assign(&mut self, s: f64)

Performs the *= operation.

impl Neg for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Vector3

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Vector3

impl Sub for Vector3

type Output = Vector3

The resulting type after applying the - operator.

fn sub(self, r: Self) -> Self

Performs the - operation.

impl SubAssign for Vector3

fn sub_assign(&mut self, r: Self)

Performs the -= operation.