Struct DomainBox

pub struct DomainBox<Dom> {
    pub domain_raw: Dom,
}

Available on crate feature cpu_os_threads only.

Wrapper around the user-defined simulation Domain

Fields

domain_raw: Dom

Raw simulation Domain

Trait Implementations

impl<Dom> Clone for DomainBox<Dom>

where Dom: Clone,

fn clone(&self) -> DomainBox<Dom>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de, Dom> Deserialize<'de> for DomainBox<Dom>

where Dom: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Cel, Ind, Vox, Dom> Domain<CellAgentBox<Cel>, Ind, Vox> for DomainBox<Dom>

where Dom: Domain<Cel, Ind, Vox>, Vox: Send + Sync, Cel: Send + Sync,

fn apply_boundary( &self, cbox: &mut CellAgentBox<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_neighbor_voxel_indices(&self, index: &Ind) -> Vec<Ind>

Retrieves the neighboring voxels of the one specified.

fn get_voxel_index(&self, cbox: &CellAgentBox<Cel>) -> Ind

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

fn get_all_indices(&self) -> Vec<Ind>

Get all indices that are present in the simulation. Required for initial configuration of the simulation domain.

fn generate_contiguous_multi_voxel_regions( &self, n_regions: usize, ) -> Result<Vec<Vec<(Ind, Vox)>>, CalcError>

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

impl<Dom> From<Dom> for DomainBox<Dom>

fn from(domain: Dom) -> DomainBox<Dom>

Converts to this type from the input type.

impl<Dom> Serialize for DomainBox<Dom>

where Dom: Serialize,

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.