Struct VolField 

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

A volume field: one value per cell in the internal field, plus one PatchField per boundary patch.

Mirrors Foam::volScalarField / Foam::VolumeField<Type>. The internal field has length mesh.n_cells.

Fields

name: String

Field name (diagnostic label, e.g. "p", "U", "T").

mesh: Arc<FvMesh>

Mesh this field is defined on.

internal: Field<T>

Cell-centred values; length == mesh.n_cells.

boundary: Vec<PatchField<T>>

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

Implementations

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

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

Assemble a volume field from its cell-centred values and per-patch boundary fields. In debug builds, asserts that internal has length mesh.n_cells and that boundary has one entry per patch.

impl VolField<f64>

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

Uniform scalar field over the entire domain.

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

Zero-valued scalar field over the entire domain (zero-gradient boundaries).

impl VolField<Vector3>

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

Uniform vector field over the entire domain.

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

Zero-valued vector field over the entire domain (zero-gradient boundaries).

Trait Implementations

impl<T> Add for VolField<T>

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

type Output = VolField<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Clone + Clone> Clone for VolField<T>

fn clone(&self) -> VolField<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Clone> Debug for VolField<T>

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

Formats the value using the given formatter.

impl<T> Div<f64> for VolField<T>

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

type Output = VolField<T>

The resulting type after applying the / operator.

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

Performs the / operation.

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

type Output = VolField<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<VolField<Vector3>> for VolScalarField

type Output = VolField<Vector3>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Mul<f64> for VolField<T>

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

type Output = VolField<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> Neg for VolField<T>

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

type Output = VolField<T>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<T> Sub for VolField<T>

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

type Output = VolField<T>

The resulting type after applying the - operator.

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

Performs the - operation.