Struct CartesianCuboid2Vertex
pub struct CartesianCuboid2Vertex { /* private fields */ }
Expand description
Cuboid Domain with coordinates specialized for vertex systems in 2 dimensions
Implementations§
§impl CartesianCuboid2Vertex
impl CartesianCuboid2Vertex
pub fn from_boundaries_and_interaction_ranges(
min: [f64; 2],
max: [f64; 2],
interaction_ranges: [f64; 2],
) -> Result<CartesianCuboid2Vertex, CalcError>
Available on crate feature cpu_os_threads
only.
pub fn from_boundaries_and_interaction_ranges( min: [f64; 2], max: [f64; 2], interaction_ranges: [f64; 2], ) -> Result<CartesianCuboid2Vertex, CalcError>
cpu_os_threads
only.Builds a new CartesianCuboid2Vertex from given boundaries and maximum interaction ranges of the containing cells.
pub fn from_boundaries_and_n_voxels(
min: [f64; 2],
max: [f64; 2],
n_vox: [usize; 2],
) -> Result<CartesianCuboid2Vertex, CalcError>
Available on crate feature cpu_os_threads
only.
pub fn from_boundaries_and_n_voxels( min: [f64; 2], max: [f64; 2], n_vox: [usize; 2], ) -> Result<CartesianCuboid2Vertex, CalcError>
cpu_os_threads
only.Builds a new CartesianCuboid2Vertex from given boundaries and the number of voxels per dimension specified
Trait Implementations§
§impl Clone for CartesianCuboid2Vertex
impl Clone for CartesianCuboid2Vertex
§fn clone(&self) -> CartesianCuboid2Vertex
fn clone(&self) -> CartesianCuboid2Vertex
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read more§impl CreatePlottingRoot for CartesianCuboid2Vertex
impl CreatePlottingRoot for CartesianCuboid2Vertex
§fn create_bitmap_root<'a, T>(
&self,
image_size: u32,
filename: &'a T,
) -> Result<DrawingArea<BitMapBackend<'a>, Cartesian2d<RangedCoordf64, RangedCoordf64>>, DrawingError>
fn create_bitmap_root<'a, T>( &self, image_size: u32, filename: &'a T, ) -> Result<DrawingArea<BitMapBackend<'a>, Cartesian2d<RangedCoordf64, RangedCoordf64>>, DrawingError>
Creates a bitmap plotting root.
§impl Debug for CartesianCuboid2Vertex
impl Debug for CartesianCuboid2Vertex
§impl<'de> Deserialize<'de> for CartesianCuboid2Vertex
impl<'de> Deserialize<'de> for CartesianCuboid2Vertex
§fn deserialize<__D>(
__deserializer: __D,
) -> Result<CartesianCuboid2Vertex, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D,
) -> Result<CartesianCuboid2Vertex, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
§impl<Cel, const D: usize, const N: usize> Domain<Cel, [i64; 2], CartesianCuboidVoxel2Vertex<D, N>> for CartesianCuboid2Vertex
impl<Cel, const D: usize, const N: usize> Domain<Cel, [i64; 2], CartesianCuboidVoxel2Vertex<D, N>> for CartesianCuboid2Vertex
§fn apply_boundary(&self, cell: &mut Cel) -> Result<(), BoundaryError>
fn apply_boundary(&self, cell: &mut Cel) -> Result<(), BoundaryError>
Applies boundary conditions to a cell in order to keep it inside the simulation.
For the future, we aim to apply boundary conditions to the position of the cell rather than itself.
In addition, we would like to be able to invoke events such as Remove to maximize flexibility.
§fn get_voxel_index(&self, cell: &Cel) -> [i64; 2]
fn get_voxel_index(&self, cell: &Cel) -> [i64; 2]
Provided a cell, gives the corresponding Index and thus which voxel to sort into.
§fn get_all_indices(&self) -> Vec<[i64; 2]>
fn get_all_indices(&self) -> Vec<[i64; 2]>
Get all indices that are present in the simulation. Required for initial configuration of the simulation domain.
§fn get_neighbor_voxel_indices(&self, index: &[i64; 2]) -> Vec<[i64; 2]>
fn get_neighbor_voxel_indices(&self, index: &[i64; 2]) -> Vec<[i64; 2]>
Retrieves the neighboring voxels of the one specified.
§fn generate_contiguous_multi_voxel_regions(
&self,
n_regions: usize,
) -> Result<Vec<Vec<([i64; 2], CartesianCuboidVoxel2Vertex<D, N>)>>, CalcError>
fn generate_contiguous_multi_voxel_regions( &self, n_regions: usize, ) -> Result<Vec<Vec<([i64; 2], CartesianCuboidVoxel2Vertex<D, N>)>>, CalcError>
Allows the backend to split the domain into continuous regions which contain voxels.
These regions can then be used for parallelization.
§impl Serialize for CartesianCuboid2Vertex
impl Serialize for CartesianCuboid2Vertex
§fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S,
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
Auto Trait Implementations§
impl Freeze for CartesianCuboid2Vertex
impl RefUnwindSafe for CartesianCuboid2Vertex
impl Send for CartesianCuboid2Vertex
impl Sync for CartesianCuboid2Vertex
impl Unpin for CartesianCuboid2Vertex
impl UnwindSafe for CartesianCuboid2Vertex
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
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
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.