Struct SimplexView 

pub struct SimplexView<'a, SimplexDim, const MESH_DIM: usize> { /* private fields */ }

A view into a single simplex’s data.

This type can also be used as an index into a primal Cochain of the corresponding dimension, providing a shorter syntax and a type check to ensure the dimensions match:

let c_primal: Cochain<1, Primal> = mesh_3d.new_zero_cochain();
let c_dual: Cochain<2, Dual> = mesh_3d.new_zero_cochain();
for edge in mesh_3d.simplices::<1>() {
    let primal_val = c_primal[edge];
    let dual_val = c_dual[edge.dual()];
    // ..is a typechecked equivalent to
    let primal_val = c_primal.values[edge.index()];
    let dual_val = c_dual.values[edge.index()];
}

Something like this wouldn’t compile, for instance:

let c: Cochain<1, Dual> = mesh_3d.new_zero_cochain();
for edge in mesh_3d.simplices::<1>() {
    let val = c[edge];
    // ..but the index method would still work (almost certainly incorrectly):
    let val = c.values[edge.index()];
}

Implementations

impl<'a, SimplexDim, const MESH_DIM: usize> SimplexView<'a, SimplexDim, MESH_DIM>

where SimplexDim: DimName, Const<MESH_DIM>: DimNameSub<SimplexDim>,

pub fn vertices(&self) -> impl '_ + Iterator<Item = SVector<f64, MESH_DIM>>

Iterate over the vertices of this simplex.

pub fn vertex_indices(&self) -> impl '_ + Iterator<Item = usize>

Iterate over the vertex indices of this simplex.

pub fn index(&self) -> usize

Get the index of this simplex in the ordering of DIM-simplices.

pub fn volume(&self) -> f64

Get the unsigned volume of this simplex.

pub fn dual_volume(&self) -> f64

Get the unsigned volume of the dual cell corresponding to this simplex.

pub fn circumcenter(&self) -> SVector<f64, MESH_DIM>

Get the circumcenter of this simplex.

pub fn barycenter(&self) -> SVector<f64, MESH_DIM>

Get the barycenter of this simplex.

pub fn dual( self, ) -> DualCellView<'a, DimNameDiff<Const<MESH_DIM>, SimplexDim>, MESH_DIM>

Get the dual cell corresponding to this simplex.

impl<'a, SimplexDim, const MESH_DIM: usize> SimplexView<'a, SimplexDim, MESH_DIM>

where SimplexDim: DimNameAdd<U1>, Const<MESH_DIM>: DimNameSub<DimNameSum<SimplexDim, U1>>,

pub fn coboundary( self, ) -> BoundaryIter<'a, DimNameSum<SimplexDim, U1>, MESH_DIM>

Iterate over the k+1-dimensional simplices on whose boundary this simplex lies.

impl<'a, SimplexDim, const MESH_DIM: usize> SimplexView<'a, SimplexDim, MESH_DIM>

where SimplexDim: DimNameSub<U1>,

pub fn boundary(self) -> BoundaryIter<'a, DimNameDiff<SimplexDim, U1>, MESH_DIM>

Iterate over the k-1-dimensional simplices on the boundary of this simplex.

Trait Implementations

impl<'a, SimplexDim: Clone, const MESH_DIM: usize> Clone for SimplexView<'a, SimplexDim, MESH_DIM>

fn clone(&self) -> SimplexView<'a, SimplexDim, MESH_DIM>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, SimplexDim: Debug, const MESH_DIM: usize> Debug for SimplexView<'a, SimplexDim, MESH_DIM>

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

Formats the value using the given formatter.

impl<'a, D, const MESH_DIM: usize> Index<SimplexView<'a, D, MESH_DIM>> for CochainImpl<D, Primal>

where D: DimName, Const<MESH_DIM>: DimNameSub<D>,

type Output = f64

The returned type after indexing.

fn index(&self, simplex: SimplexView<'a, D, MESH_DIM>) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, D, const MESH_DIM: usize> IndexMut<SimplexView<'a, D, MESH_DIM>> for CochainImpl<D, Primal>

where D: DimName, Const<MESH_DIM>: DimNameSub<D>,

fn index_mut( &mut self, simplex: SimplexView<'a, D, MESH_DIM>, ) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, SimplexDim, const MESH_DIM: usize> PartialEq for SimplexView<'a, SimplexDim, MESH_DIM>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, SimplexDim: Copy, const MESH_DIM: usize> Copy for SimplexView<'a, SimplexDim, MESH_DIM>

impl<'a, SimplexDim, const MESH_DIM: usize> Eq for SimplexView<'a, SimplexDim, MESH_DIM>