Skip to main content

AmiCoupling

Struct AmiCoupling 

Source
pub struct AmiCoupling {
    pub target_face: usize,
    pub target_cell: usize,
    pub target_patch: usize,
    pub source_patch: usize,
    pub local: usize,
    pub weights: Vec<AmiWeight>,
}
Expand description

One target seam face of a PatchKind::CyclicAmi patch pair, together with the weighted set of source cells it couples to.

Mirrors the coupled-interface contribution of Foam::cyclicAMIFvPatchField whose patchNeighbourField() supplies the interpolated partner value Σ_k w_k · φ(source_cell_k).

The couplings are appended to the LDU face addressing after the internal faces and the CyclicCouplings: one LDU face per AmiWeight, laid out in ami_couplings order (see FvMesh::ami_ldu_start and FvMesh::n_ami_faces).

Fields§

§target_face: usize

Global face index of this target seam face.

§target_cell: usize

Owner cell of the target face — the “owner” side of every partial seam face in weights.

§target_patch: usize

Patch index of the target half of the AMI pair.

§source_patch: usize

Patch index of the source half of the AMI pair.

§local: usize

Local face index of the target face within its patch (target_face - patches[target_patch].start).

§weights: Vec<AmiWeight>

Weighted source contributions; per-target weights sum to ≈ 1.

Implementations§

Source§

impl AmiCoupling

Source

pub fn weight_sum(&self) -> f64

Sum of this target’s overlap weights. Equals 1 (to rounding) when the target face is fully covered by source faces — the conservation check.

Trait Implementations§

Source§

impl Clone for AmiCoupling

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AmiCoupling

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for AmiCoupling

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for AmiCoupling

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.