Skip to main content

SourceContribution

Struct SourceContribution 

Source
pub struct SourceContribution {
    pub explicit: f64,
    pub implicit: f64,
}
Expand description

The explicit and implicit halves of a source term, per cell.

Upstream splits a source into Su (explicit, independent of the solution) and Sp (implicit, the coefficient of φ). Keeping them apart is not bookkeeping: putting a stabilising negative coefficient on the diagonal rather than in the right-hand side is what keeps the matrix diagonally dominant and the solve stable, and it is why a Darcy drag is written implicitly.

§Units

explicit is in the units of the equation’s residual per unit volume; implicit in those units divided by the solved variable. Both are per unit volume — multiplication by the cell volume happens when the contribution is placed into the matrix, matching upstream, which writes Sp[celli] += Vc*S.

Fields§

§explicit: f64

The part independent of the solved variable, per unit volume.

§implicit: f64

The coefficient of the solved variable, per unit volume.

Negative values stabilise. A sink proportional to the solution has a negative coefficient here, and it lands on the matrix diagonal with the sign flipped, increasing diagonal dominance.

Trait Implementations§

Source§

impl Clone for SourceContribution

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 Copy for SourceContribution

Source§

impl Debug for SourceContribution

Source§

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

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

impl Default for SourceContribution

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SourceContribution

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 SourceContribution

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.