Struct Boundaries 

pub struct Boundaries(/* private fields */);

Boundary conditions of all six faces (default: all PEC).

Implementations

impl Boundaries

pub fn all(b: Boundary) -> Self

The same boundary on every face.

pub fn with(self, face: Face, b: Boundary) -> Self

Builder: sets the boundary of face.

pub fn set(&mut self, face: Face, b: Boundary)

Sets the boundary of face.

pub fn get(&self, face: Face) -> &Boundary

The boundary of face.

pub fn as_array(&self) -> &[Boundary; 6]

The boundaries in Face::ALL order.

pub fn iter(&self) -> impl Iterator<Item = (Face, &Boundary)>

Iterates over (face, boundary) pairs in Face::ALL order.

pub fn validate(&self) -> Result<()>

Checks every face’s parameters, and that periodic faces come in opposite pairs.

pub fn is_periodic(&self, axis: Axis) -> bool

Whether the faces of axis are periodic.

Trait Implementations

impl Clone for Boundaries

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Boundaries

impl Debug for Boundaries

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

Formats the value using the given formatter.

impl Default for Boundaries

fn default() -> Self

Returns the “default value” for a type.

impl From<[Boundary; 6]> for Boundaries

fn from(b: [Boundary; 6]) -> Self

Converts to this type from the input type.

impl Index<Face> for Boundaries

type Output = Boundary

The returned type after indexing.

fn index(&self, face: Face) -> &Boundary

Performs the indexing (container[index]) operation.

impl IndexMut<Face> for Boundaries

fn index_mut(&mut self, face: Face) -> &mut Boundary

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

impl PartialEq for Boundaries

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Boundaries