Struct CartesianCuboid2

pub struct CartesianCuboid2 { /* private fields */ }

Available on crate feature elli only.

Cuboid Domain with regular cartesian coordinates in 2D

Implementations

impl CartesianCuboid2

pub fn from_boundaries_and_interaction_ranges( min: [f64; 2], max: [f64; 2], interaction_ranges: [f64; 2], ) -> Result<CartesianCuboid2, CalcError>

Available on crate feature cpu_os_threads only.

Builds a new CartesianCuboid2 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<CartesianCuboid2, CalcError>

Available on crate feature cpu_os_threads only.

Builds a new CartesianCuboid2 from given boundaries and the number of voxels per dimension specified.

Trait Implementations

impl Clone for CartesianCuboid2

fn clone(&self) -> CartesianCuboid2

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CreatePlottingRoot for CartesianCuboid2

fn create_bitmap_root<'a, T>( &self, image_size: u32, filename: &'a T, ) -> Result<DrawingArea<BitMapBackend<'a>, Cartesian2d<RangedCoordf64, RangedCoordf64>>, DrawingError>

where T: AsRef<Path> + ?Sized,

Creates a bitmap plotting root.

impl Debug for CartesianCuboid2

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CartesianCuboid2

fn deserialize<__D>( __deserializer: __D, ) -> Result<CartesianCuboid2, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Cel, const N: usize> Domain<Cel, [i64; 2], CartesianCuboidVoxel2<N>> for CartesianCuboid2

where Cel: Position<Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>> + Velocity<Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>>,

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]

Provided a cell, gives the corresponding Index and thus which voxel to sort into.

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]>

Retrieves the neighboring voxels of the one specified.

fn generate_contiguous_multi_voxel_regions( &self, n_regions: usize, ) -> Result<Vec<Vec<([i64; 2], CartesianCuboidVoxel2<N>)>>, CalcError>

Allows the backend to split the domain into continuous regions which contain voxels. These regions can then be used for parallelization.

impl<'py> IntoPyObject<'py> for CartesianCuboid2

type Target = CartesianCuboid2

The Python output type

type Output = Bound<'py, <CartesianCuboid2 as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<CartesianCuboid2 as IntoPyObject<'py>>::Output, <CartesianCuboid2 as IntoPyObject<'py>>::Error>

Performs the conversion.

impl PyClass for CartesianCuboid2

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for CartesianCuboid2

const NAME: &'static str = "CartesianCuboid2"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl Serialize for CartesianCuboid2

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.

impl DerefToPyAny for CartesianCuboid2