Skip to main content

CellSelection

Enum CellSelection 

Source
pub enum CellSelection {
    All,
    Zone(Arc<Vec<usize>>),
}
Expand description

The set of cells a source term acts on.

Upstream’s fvCellZone / cellSetOption. A source is almost never global: a heat source occupies one component, a porous drag one region, a melting model one material. This is how that restriction is expressed.

§Sharing

The cell list is held behind an Arc, per the workspace rule against lifetime parameters, so several models can share one selection without copying it.

Variants§

§

All

Every cell in the mesh.

§

Zone(Arc<Vec<usize>>)

An explicit list of cell indices.

Indices are not validated against a mesh here, because a selection is built before it meets one. An out-of-range index will panic on use, which is the correct outcome for what is a case-setup error.

Implementations§

Source§

impl CellSelection

Source

pub fn zone(cells: Vec<usize>) -> Self

A selection from an explicit list of cell indices.

Source

pub fn cells(&self, n_cells: usize) -> Vec<usize>

The selected cells, given a mesh cell count.

n_cells is used only to expand CellSelection::All.

Source

pub fn len(&self, n_cells: usize) -> usize

Number of selected cells, given a mesh cell count.

Source

pub fn is_empty(&self, n_cells: usize) -> bool

Whether the selection is empty.

An empty selection is legal — it contributes nothing — but is usually a case-setup mistake worth reporting.

Trait Implementations§

Source§

impl Clone for CellSelection

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 CellSelection

Source§

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

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

impl Eq for CellSelection

Source§

impl PartialEq for CellSelection

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 CellSelection

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.