Struct SymmTensor 

pub struct SymmTensor {
    pub xx: f64,
    pub xy: f64,
    pub xz: f64,
    pub yy: f64,
    pub yz: f64,
    pub zz: f64,
}

Symmetric 3×3 tensor stored in upper-triangle order: xx, xy, xz, yy, yz, zz. Maps to Foam::symmTensor (Foam::SymmTensor<scalar>).

Fields

xx: f64

xy: f64

xz: f64

yy: f64

yz: f64

zz: f64

Implementations

impl SymmTensor

pub const ZERO: Self

The zero tensor (all components 0).

pub const IDENTITY: Self

The identity tensor (unit diagonal, zero off-diagonal).

pub fn new(xx: f64, xy: f64, xz: f64, yy: f64, yz: f64, zz: f64) -> Self

Construct from the six upper-triangle components (xx, xy, xz, yy, yz, zz).

pub fn from_diag(xx: f64, yy: f64, zz: f64) -> Self

Construct from diagonal only (off-diagonal = 0).

pub fn row_x(self) -> Vector3

Row vectors (yx = xy, zx = xz, zy = yz because symmetric)

pub fn row_y(self) -> Vector3

pub fn row_z(self) -> Vector3

pub fn diag(self) -> Vector3

Diagonal as a vector

pub fn tr(self) -> f64

Trace: xx + yy + zz

pub fn sph(self) -> SphericalTensor

Spherical (isotropic) part: (tr/3) * I

pub fn dev(self) -> Self

Deviatoric part: self - (tr/3)*I

pub fn dev2(self) -> Self

Two-thirds deviatoric part: self - (2*tr/3)*I

pub fn det(self) -> f64

Determinant

pub fn adjunct(self) -> Self

Adjunct (= cofactor matrix, same as adjunct because symmetric)

pub fn inv(self) -> Self

Inverse = adjunct / det. Panics if singular in debug builds.

pub fn safe_inv(self) -> Self

Inverse with fallback: returns ZERO if nearly singular.

pub fn mag_sqr(self) -> f64

Frobenius norm squared (off-diagonal counted twice, matching OpenFOAM)

pub fn mag(self) -> f64

pub fn diag_sqr(self) -> f64

Sum of squared diagonal entries (not Frobenius)

pub fn inner_sqr(self) -> Self

Self² as a SymmTensor (S·S where both factors are symmetric)

pub fn double_inner(self, rhs: Self) -> f64

Double contraction (Frobenius inner product). C++ operator&&. Note: off-diagonal elements contribute twice because the tensor is symmetric.

pub fn mat_vec(self, v: Vector3) -> Vector3

Matrix multiply SymmTensor·Vector → Vector. C++ operator&(SymmTensor, Vector).

pub fn hodge_dual(self) -> Vector3

Hodge dual: returns the axial vector. C++ operator*(SymmTensor).

pub fn from_outer(v: Vector3) -> Self

Outer (dyadic) product of a vector with itself: v ⊗ v → SymmTensor. C++ sqr(Vector).

pub fn invariant_i(self) -> f64

First invariant: trace

pub fn invariant_ii(self) -> f64

Second invariant: (xxyy + yyzz + xx*zz) - (xy² + yz² + xz²)

pub fn invariant_iii(self) -> f64

Third invariant: determinant

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

Linear interpolation

pub fn is_identity(self, tol: f64) -> bool

True if the tensor is (approximately) the identity.

Trait Implementations

impl Add for SymmTensor

type Output = SymmTensor

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<SphericalTensor> for SymmTensor

type Output = SymmTensor

The resulting type after applying the + operator.

fn add(self, spt: SphericalTensor) -> Self

Performs the + operation.

impl Add<SymmTensor> for SphericalTensor

type Output = SymmTensor

The resulting type after applying the + operator.

fn add(self, st: SymmTensor) -> SymmTensor

Performs the + operation.

impl Add<SymmTensor> for Tensor

type Output = Tensor

The resulting type after applying the + operator.

fn add(self, st: SymmTensor) -> Self

Performs the + operation.

impl Add<Tensor> for SymmTensor

type Output = Tensor

The resulting type after applying the + operator.

fn add(self, t: Tensor) -> Tensor

Performs the + operation.

impl AddAssign for SymmTensor

fn add_assign(&mut self, r: Self)

Performs the += operation.

impl Clone for SymmTensor

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 SymmTensor

impl Debug for SymmTensor

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

Formats the value using the given formatter.

impl Default for SymmTensor

fn default() -> Self

Returns the “default value” for a type.

impl Div<f64> for SymmTensor

type Output = SymmTensor

The resulting type after applying the / operator.

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

Performs the / operation.

impl From<SphericalTensor> for SymmTensor

fn from(st: SphericalTensor) -> Self

Converts to this type from the input type.

impl From<SymmTensor> for Tensor

fn from(st: SymmTensor) -> Self

Converts to this type from the input type.

impl Mul for SymmTensor

type Output = Tensor

The resulting type after applying the * operator.

fn mul(self, st: SymmTensor) -> Tensor

Performs the * operation.

impl Mul<SphericalTensor> for SymmTensor

type Output = SymmTensor

The resulting type after applying the * operator.

fn mul(self, spt: SphericalTensor) -> Self

Performs the * operation.

impl Mul<SymmTensor> for f64

type Output = SymmTensor

The resulting type after applying the * operator.

fn mul(self, st: SymmTensor) -> SymmTensor

Performs the * operation.

impl Mul<SymmTensor> for SphericalTensor

type Output = SymmTensor

The resulting type after applying the * operator.

fn mul(self, st: SymmTensor) -> SymmTensor

Performs the * operation.

impl Mul<SymmTensor> for Tensor

type Output = Tensor

The resulting type after applying the * operator.

fn mul(self, st: SymmTensor) -> Self

Performs the * operation.

impl Mul<Tensor> for SymmTensor

type Output = Tensor

The resulting type after applying the * operator.

fn mul(self, t: Tensor) -> Tensor

Performs the * operation.

impl Mul<f64> for SymmTensor

type Output = SymmTensor

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f64> for SymmTensor

fn mul_assign(&mut self, s: f64)

Performs the *= operation.

impl Neg for SymmTensor

type Output = SymmTensor

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for SymmTensor

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SymmTensor

impl Sub for SymmTensor

type Output = SymmTensor

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<SphericalTensor> for SymmTensor

type Output = SymmTensor

The resulting type after applying the - operator.

fn sub(self, spt: SphericalTensor) -> Self

Performs the - operation.

impl Sub<SymmTensor> for SphericalTensor

type Output = SymmTensor

The resulting type after applying the - operator.

fn sub(self, st: SymmTensor) -> SymmTensor

Performs the - operation.

impl Sub<SymmTensor> for Tensor

type Output = Tensor

The resulting type after applying the - operator.

fn sub(self, st: SymmTensor) -> Self

Performs the - operation.

impl Sub<Tensor> for SymmTensor

type Output = Tensor

The resulting type after applying the - operator.

fn sub(self, t: Tensor) -> Tensor

Performs the - operation.

impl SubAssign for SymmTensor

fn sub_assign(&mut self, r: Self)

Performs the -= operation.