Skip to main content

SemiImplicitSource

Struct SemiImplicitSource 

Source
pub struct SemiImplicitSource { /* private fields */ }
Expand description

A constant source term with an explicit and an implicit part.

Upstream’s semiImplicitSource, the simplest fvModel there is, and the one that exercises the mechanism end to end without any physics of its own.

§Units

Both parts are per unit volume, in the units of the equation’s residual; see SourceContribution. The cell volume is applied when the contribution is placed into the matrix.

Implementations§

Source§

impl SemiImplicitSource

Source

pub fn new( name: impl Into<String>, field: impl Into<String>, selection: CellSelection, explicit: f64, implicit: f64, ) -> Self

A source named name on the equation for field, over selection.

explicit is added to the right-hand side; implicit is the coefficient of the solved variable, where a negative value is a sink and stabilises the matrix.

Source

pub fn name(&self) -> &str

The model’s name.

Source

pub fn field_name(&self) -> &str

The field whose equation this contributes to.

Source

pub fn selection(&self) -> &CellSelection

The cells acted on.

Source

pub fn contribution(&self) -> SourceContribution

The per-unit-volume contribution.

Trait Implementations§

Source§

impl Clone for SemiImplicitSource

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 SemiImplicitSource

Source§

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

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

impl PartialEq for SemiImplicitSource

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 SemiImplicitSource

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.