Struct Field 

pub struct Field<T> { /* private fields */ }

A flat array over all cells or faces, with element-wise arithmetic.

Mirrors Foam::Field<Type> from src/OpenFOAM/fields/Fields/Field/Field.H. The raw storage is Vec<T> with no dimension bookkeeping — that lives in the wrapping VolField/SurfaceField.

Implementations

impl<T: Clone> Field<T>

pub fn new(data: Vec<T>) -> Self

Wrap an existing Vec<T> as a field (no copy).

pub fn uniform(n: usize, value: T) -> Self

Field of n elements all equal to value.

pub fn from_fn(n: usize, f: impl Fn(usize) -> T) -> Self

Field of n elements, element i set to f(i).

pub fn len(&self) -> usize

Number of elements in the field.

pub fn is_empty(&self) -> bool

True if the field has no elements.

pub fn as_slice(&self) -> &[T]

Borrow the underlying storage as a slice.

pub fn as_mut_slice(&mut self) -> &mut [T]

Mutably borrow the underlying storage as a slice.

pub fn into_vec(self) -> Vec<T>

Consume the field, returning its underlying Vec<T>.

pub fn iter(&self) -> Iter<'_, T>

Iterator over element references.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Iterator over mutable element references.

pub fn map<U: Clone>(&self, f: impl Fn(&T) -> U) -> Field<U>

Map f element-wise, returning a new Field<U> of the same length.

impl Field<f64>

pub fn zeros(n: usize) -> Self

Scalar field of n zeros.

pub fn ones(n: usize) -> Self

Scalar field of n ones.

pub fn sum(&self) -> f64

Sum of all elements.

pub fn mean(&self) -> f64

Arithmetic mean of all elements; returns 0.0 for an empty field.

pub fn min(&self) -> f64

Smallest element (+∞ for an empty field).

pub fn max(&self) -> f64

Largest element (−∞ for an empty field).

pub fn l2_norm(&self) -> f64

Euclidean (L2) norm: sqrt(sum(x_i²)).

pub fn abs(&self) -> Self

Element-wise absolute value.

pub fn clamp(&self, lo: f64, hi: f64) -> Self

Element-wise clamp.

pub fn pointwise_mul(&self, rhs: &Self) -> Self

Element-wise product of two scalar fields.

pub fn pointwise_div(&self, rhs: &Self) -> Self

Element-wise division of two scalar fields.

pub fn weighted_sum(&self, weights: &Field<f64>) -> f64

Weighted sum: sum(w[i] * x[i]).

impl Field<Vector3>

pub fn zero_vec(n: usize) -> Self

Vector field of n zero vectors.

pub fn dot_field(&self, rhs: &Field<Vector3>) -> Field<f64>

Element-wise dot product → scalar field.

pub fn scale(&self, s: &Field<f64>) -> Self

Scale each element by the corresponding scalar field entry.

Trait Implementations

impl<T: Add<Output = T> + Clone> Add for Field<T>

type Output = Field<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Add<Output = T> + Clone> AddAssign for Field<T>

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl<T> AsRef<[T]> for Field<T>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for Field<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Field<T>

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

Formats the value using the given formatter.

impl Default for Field<f64>

fn default() -> Self

Returns the “default value” for a type.

impl Default for Field<Vector3>

fn default() -> Self

Returns the “default value” for a type.

impl Default for Field<Tensor>

fn default() -> Self

Returns the “default value” for a type.

impl Default for Field<SymmTensor>

fn default() -> Self

Returns the “default value” for a type.

impl Default for Field<SphericalTensor>

fn default() -> Self

Returns the “default value” for a type.

impl Div for Field<f64>

type Output = Field<f64>

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self

Performs the / operation.

impl<T: Mul<f64, Output = T> + Clone> Div<f64> for Field<T>

type Output = Field<T>

The resulting type after applying the / operator.

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

Performs the / operation.

impl<T: Clone> From<Vec<T>> for Field<T>

fn from(v: Vec<T>) -> Self

Converts to this type from the input type.

impl<T> Index<usize> for Field<T>

type Output = T

The returned type after indexing.

fn index(&self, i: usize) -> &T

Performs the indexing (container[index]) operation.

impl<T> IndexMut<usize> for Field<T>

fn index_mut(&mut self, i: usize) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T> IntoIterator for Field<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Field<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Mul for Field<f64>

type Output = Field<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl Mul<Field<Vector3>> for f64

type Output = Field<Vector3>

The resulting type after applying the * operator.

fn mul(self, rhs: Field<Vector3>) -> Field<Vector3>

Performs the * operation.

impl Mul<Field<Vector3>> for Field<f64>

type Output = Field<Vector3>

The resulting type after applying the * operator.

fn mul(self, rhs: Field<Vector3>) -> Field<Vector3>

Performs the * operation.

impl Mul<Field<f64>> for f64

type Output = Field<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: Field<f64>) -> Field<f64>

Performs the * operation.

impl Mul<Field<f64>> for Field<Vector3>

type Output = Field<Vector3>

The resulting type after applying the * operator.

fn mul(self, rhs: Field<f64>) -> Field<Vector3>

Performs the * operation.

impl<T: Mul<f64, Output = T> + Clone> Mul<f64> for Field<T>

type Output = Field<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T: Neg<Output = T> + Clone> Neg for Field<T>

type Output = Field<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T: PartialEq> PartialEq for Field<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for Field<T>

impl<T: Sub<Output = T> + Clone> Sub for Field<T>

type Output = Field<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Sub<Output = T> + Clone> SubAssign for Field<T>

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.