cellular_raza::prelude

Struct DecomposedDomain

pub struct DecomposedDomain<I, S, C> {
    pub n_subdomains: NonZero<usize>,
    pub index_subdomain_cells: Vec<(I, S, Vec<C>)>,
    pub neighbor_map: BTreeMap<I, BTreeSet<I>>,
    pub rng_seed: u64,
}
Expand description

Generated by the decompose method. The backend will know how to deal with this type and crate a working simulation from it.

Fields§

§n_subdomains: NonZero<usize>

Number of spawned SubDomains. This number is guaranteed to be smaller or equal to the number may be different to the one given to the Domain::decompose method. Such behaviour can result from not being able to construct as many subdomains as desired. Note that this function will attempt to construct more SubDomains than available CPUs if given a larger number.

§index_subdomain_cells: Vec<(I, S, Vec<C>)>

Vector containing properties of individual SubDomains. Entries are Domain::SubDomainIndex, SubDomain, and a vector of cells.

§neighbor_map: BTreeMap<I, BTreeSet<I>>

Encapsulates how the subdomains are linked to each other. Eg. two subdomains without any boundary will never appear in each others collection of neighbors. For the future, we might opt to change to an undirected graph rather than a BTreeMap.

§rng_seed: u64

Initial seed of the simulation for random number generation.

Auto Trait Implementations§

§

impl<I, S, C> Freeze for DecomposedDomain<I, S, C>

§

impl<I, S, C> RefUnwindSafe for DecomposedDomain<I, S, C>
where I: RefUnwindSafe, S: RefUnwindSafe, C: RefUnwindSafe,

§

impl<I, S, C> Send for DecomposedDomain<I, S, C>
where I: Send, S: Send, C: Send,

§

impl<I, S, C> Sync for DecomposedDomain<I, S, C>
where I: Sync, S: Sync, C: Sync,

§

impl<I, S, C> Unpin for DecomposedDomain<I, S, C>
where I: Unpin, S: Unpin, C: Unpin,

§

impl<I, S, C> UnwindSafe for DecomposedDomain<I, S, C>
where I: RefUnwindSafe + UnwindSafe, S: UnwindSafe, C: UnwindSafe,

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
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
§

impl<T> Ungil for T
where T: Send,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,