Struct SurfaceField 

pub struct SurfaceField<T: Clone> {
    pub name: String,
    pub mesh: Arc<FvMesh>,
    pub internal: Field<T>,
    pub boundary: Vec<PatchField<T>>,
}

A surface field: one value per internal face in the internal field, plus one PatchField per boundary patch.

Mirrors Foam::surfaceScalarField / Foam::SurfaceField<Type>.

Why internal has length n_internal_faces, not n_faces

In OpenFOAM, surfaceScalarField.internalField() only covers the internal faces; boundary-face values live in boundaryField()[patch]. This matches the LDU matrix structure: lower and upper arrays have length n_internal_faces.

Fields

name: String

Field name (diagnostic label, e.g. "phi").

mesh: Arc<FvMesh>

Mesh this field is defined on.

internal: Field<T>

Face values for all internal faces; length == mesh.n_internal_faces.

boundary: Vec<PatchField<T>>

One entry per boundary patch; boundary[i].values has length mesh.patches[i].size.

Implementations

impl<T: Clone> SurfaceField<T>

pub fn new( name: impl Into<String>, mesh: Arc<FvMesh>, internal: Field<T>, boundary: Vec<PatchField<T>>, ) -> Self

Assemble a surface field from its internal-face values and per-patch boundary fields. In debug builds, asserts that internal has length mesh.n_internal_faces and that boundary has one entry per patch.

impl SurfaceField<f64>

pub fn zeros(name: impl Into<String>, mesh: Arc<FvMesh>) -> Self

Scalar surface field with all internal-face values zero and zero-gradient boundary patches.

pub fn uniform(name: impl Into<String>, mesh: Arc<FvMesh>, value: f64) -> Self

Scalar surface field with all internal-face values set to value and zero-gradient boundary patches.

impl SurfaceField<Vector3>

pub fn zero(name: impl Into<String>, mesh: Arc<FvMesh>) -> Self

Vector surface field with all internal-face values zero and zero-gradient boundary patches.

impl<T: Clone + Default> SurfaceField<T>

pub fn face_value(&self, f: usize) -> T

Value at any face: internal face → from internal; boundary face → from the appropriate patch’s values.

Trait Implementations

impl<T> Add for SurfaceField<T>

where T: Add<Output = T> + Clone + Default,

type Output = SurfaceField<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Clone + Clone> Clone for SurfaceField<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 + Clone> Debug for SurfaceField<T>

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

Formats the value using the given formatter.

impl<T> Div<f64> for SurfaceField<T>

where T: Mul<f64, Output = T> + Clone,

type Output = SurfaceField<T>

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = SurfaceField<T>

The resulting type after applying the * operator.

fn mul(self, rhs: SurfaceField<T>) -> SurfaceField<T>

Performs the * operation.

impl<T> Mul<f64> for SurfaceField<T>

where T: Mul<f64, Output = T> + Clone,

type Output = SurfaceField<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Neg for SurfaceField<T>

where T: Neg<Output = T> + Clone,

type Output = SurfaceField<T>

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl<T> Sub for SurfaceField<T>

where T: Sub<Output = T> + Clone + Default,

type Output = SurfaceField<T>

The resulting type after applying the - operator.

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

Performs the - operation.