Struct CartesianCuboidRods

Source
pub struct CartesianCuboidRods<F, const D: usize> {
    pub domain: CartesianCuboid<F, D>,
}
Expand description

Cells are represented by rods

Fields§

§domain: CartesianCuboid<F, D>

The base-cuboid which is being repurposed

Trait Implementations§

Source§

impl<F, const D: usize, __cr_private_Cell, __cr_private_SubDomain, __cr_private_CellIterator> Domain<__cr_private_Cell, __cr_private_SubDomain, __cr_private_CellIterator> for CartesianCuboidRods<F, D>
where Self: DomainRngSeed + DomainCreateSubDomains<__cr_private_SubDomain> + SortCells<__cr_private_Cell, VoxelIndex = <Self as DomainCreateSubDomains<__cr_private_SubDomain>>::VoxelIndex>, __cr_private_SubDomain: SubDomain<VoxelIndex = <Self as DomainCreateSubDomains<__cr_private_SubDomain>>::VoxelIndex>, <Self as DomainCreateSubDomains<__cr_private_SubDomain>>::SubDomainIndex: Clone + Hash + Eq + Ord, <Self as DomainCreateSubDomains<__cr_private_SubDomain>>::VoxelIndex: Clone + Hash + Eq + Ord, __cr_private_CellIterator: IntoIterator<Item = __cr_private_Cell>,

Source§

type SubDomainIndex = <CartesianCuboidRods<F, D> as DomainCreateSubDomains<__cr_private_SubDomain>>::SubDomainIndex

Subdomains can be identified by their unique SubDomainIndex. The backend uses this property to construct a mapping (graph) between subdomains.
Source§

type VoxelIndex = <CartesianCuboidRods<F, D> as DomainCreateSubDomains<__cr_private_SubDomain>>::VoxelIndex

Similarly to the SubDomainIndex, voxels can be accessed by their unique index. The backend will use this information to construct a mapping (graph) between voxels inside their respective subdomains.
Source§

fn decompose( self, n_subdomains: NonZeroUsize, cells: __cr_private_CellIterator, ) -> Result<DecomposedDomain<Self::SubDomainIndex, __cr_private_SubDomain, __cr_private_Cell>, DecomposeError>

Deconstructs the [Domain] into its respective subdomains. Read more
Source§

impl<F, const D: usize> DomainCreateSubDomains<CartesianSubDomainRods<F, D>> for CartesianCuboidRods<F, D>
where F: 'static + Float + Debug + FromPrimitive,

Source§

type SubDomainIndex = usize

This should always be identical to [Domain::SubDomainIndex].
Source§

type VoxelIndex = [usize; D]

This should always be identical to [Domain::VoxelIndex].
Source§

fn create_subdomains( &self, n_subdomains: NonZeroUsize, ) -> Result<impl IntoIterator<Item = (Self::SubDomainIndex, CartesianSubDomainRods<F, D>, Vec<Self::VoxelIndex>)>, DecomposeError>

Generates at most n_subdomains. This function can also return a lower amount of subdomains but never less than 1.
Source§

impl<F, const D: usize> DomainRngSeed for CartesianCuboidRods<F, D>

Source§

fn get_rng_seed(&self) -> u64

Obtains the current rng seed
Source§

impl<C, F, const D: usize> SortCells<C> for CartesianCuboidRods<F, D>
where C: Position<Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>>, F: 'static + Field + Clone + Debug + FromPrimitive + ToPrimitive + Float + Copy,

Source§

type VoxelIndex = [usize; D]

An index which determines to which next smaller unit the cell should be assigned.
Source§

fn get_voxel_index_of( &self, cell: &C, ) -> Result<Self::VoxelIndex, BoundaryError>

If given a cell, we can sort this cell into the corresponding sub unit.

Auto Trait Implementations§

§

impl<F, const D: usize> Freeze for CartesianCuboidRods<F, D>
where F: Freeze,

§

impl<F, const D: usize> RefUnwindSafe for CartesianCuboidRods<F, D>
where F: RefUnwindSafe,

§

impl<F, const D: usize> Send for CartesianCuboidRods<F, D>
where F: Send,

§

impl<F, const D: usize> Sync for CartesianCuboidRods<F, D>
where F: Sync,

§

impl<F, const D: usize> Unpin for CartesianCuboidRods<F, D>
where F: Unpin,

§

impl<F, const D: usize> UnwindSafe for CartesianCuboidRods<F, D>
where F: 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
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> 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
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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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