Struct ChannelComm

pub struct ChannelComm<I, T> { /* private fields */ }

Available on crate feature chili only.

Sender-Receiver Communicator based on [crossbeam_channel].

This struct contains one receiver and multiple senders. It can be constructed by using the FromMap trait.

let map = std::collections::BTreeMap::from([
    (0, std::collections::BTreeSet::from([1])),
    (1, std::collections::BTreeSet::from([0, 2])),
    (2, std::collections::BTreeSet::from([1])),
]);

// Construct multiple communicators from a given map.
let mut channel_comms = ChannelComm::from_map(&map).unwrap();

// Send a message from 0 to 1
channel_comms.get_mut(&0).unwrap().send(&1, true);
channel_comms.get_mut(&0).unwrap().send(&1, false);
// Receive all elements at communicator 1
let elements = channel_comms.get_mut(&1).unwrap().receive();

assert_eq!(elements, vec![true, false]);

Trait Implementations

impl<I: Clone, T: Clone> Clone for ChannelComm<I, T>

fn clone(&self) -> ChannelComm<I, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I, T> Communicator<I, T> for ChannelComm<I, T>

where I: Hash + Eq + Ord,

fn receive(&mut self) -> Vec<T>

Receives the information previously sent

fn send(&mut self, receiver: &I, message: T) -> Result<(), SimulationError>

Sends information to a particular receiver.

impl<T, I> FromMap<I> for ChannelComm<I, T>

where I: Ord,

fn from_map( map: &BTreeMap<I, BTreeSet<I>>, ) -> Result<BTreeMap<I, Self>, IndexError>

where I: Clone + Hash + Eq,

SubDomains can be neighboring each other via complicated graphs. An easy way to represent this is by using a BTreeMap. We want to create Barriers which match the specified subdomain indices.