Struct CartesianDiffusion2DSubDomain

pub struct CartesianDiffusion2DSubDomain<F> {
    pub diffusion_constant: F,
    /* private fields */
}

Available on crate feature elli only.

Subdomain for the CartesianDiffusion2D domain.

Fields

diffusion_constant: F

Diffusion constant

Trait Implementations

impl<F> Clone for CartesianDiffusion2DSubDomain<F>

where F: Clone,

fn clone(&self) -> CartesianDiffusion2DSubDomain<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> Debug for CartesianDiffusion2DSubDomain<F>

where F: Debug,

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

Formats the value using the given formatter.

impl<'de, F> Deserialize<'de> for CartesianDiffusion2DSubDomain<F>

where F: 'static + PartialEq + Clone + Debug + Serialize + for<'a> Deserialize<'a>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F> DomainCreateSubDomains<CartesianDiffusion2DSubDomain<F>> for CartesianDiffusion2D<F>

where F: RealField + Copy + AsPrimitive<usize> + 'static + Float + Debug + FromPrimitive, usize: AsPrimitive<F>,

type SubDomainIndex = usize

This should always be identical to Domain::SubDomainIndex.

type VoxelIndex = [usize; 2]

This should always be identical to Domain::VoxelIndex.

fn create_subdomains( &self, n_subdomains: NonZero<usize>, ) -> Result<impl IntoIterator<Item = (<CartesianDiffusion2D<F> as DomainCreateSubDomains<CartesianDiffusion2DSubDomain<F>>>::SubDomainIndex, CartesianDiffusion2DSubDomain<F>, Vec<<CartesianDiffusion2D<F> as DomainCreateSubDomains<CartesianDiffusion2DSubDomain<F>>>::VoxelIndex>)>, DecomposeError>

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

impl<F> Serialize for CartesianDiffusion2DSubDomain<F>

where F: 'static + PartialEq + Clone + Debug + Serialize + for<'a> Deserialize<'a>,

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<F, __cr_private_Cell> SortCells<__cr_private_Cell> for CartesianDiffusion2DSubDomain<F>

where CartesianSubDomain<F, 2>: SortCells<__cr_private_Cell>,

type VoxelIndex = <CartesianSubDomain<F, 2> as SortCells<__cr_private_Cell>>::VoxelIndex

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

fn get_voxel_index_of( &self, cell: &__cr_private_Cell, ) -> Result<<CartesianDiffusion2DSubDomain<F> as SortCells<__cr_private_Cell>>::VoxelIndex, BoundaryError>

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

impl<F> SubDomain for CartesianDiffusion2DSubDomain<F>

type VoxelIndex = <CartesianSubDomain<F, 2> as SubDomain>::VoxelIndex

Individual Voxels inside each subdomain can be accessed by this index.

fn get_neighbor_voxel_indices( &self, voxel_index: &<CartesianDiffusion2DSubDomain<F> as SubDomain>::VoxelIndex, ) -> Vec<<CartesianDiffusion2DSubDomain<F> as SubDomain>::VoxelIndex>

Obtains the neighbor voxels of the specified voxel index. This function behaves similarly to SortCells::get_voxel_index_of in that it also has to return indices which are in other SubDomains.

fn get_all_indices( &self, ) -> Vec<<CartesianDiffusion2DSubDomain<F> as SubDomain>::VoxelIndex>

Get all voxel indices of this SubDomain.

impl<F, __cr_private_Pos, __cr_private_Vel> SubDomainMechanics<__cr_private_Pos, __cr_private_Vel> for CartesianDiffusion2DSubDomain<F>

where CartesianSubDomain<F, 2>: SubDomainMechanics<__cr_private_Pos, __cr_private_Vel>,

fn apply_boundary( &self, pos: &mut __cr_private_Pos, vel: &mut __cr_private_Vel, ) -> Result<(), BoundaryError>

If the subdomain has boundary conditions, this function will enforce them onto the cells. For the future, we plan to replace this function to additionally obtain information about the previous and current location of the cell.

impl<F> SubDomainReactions<Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>, F> for CartesianDiffusion2DSubDomain<F>

where F: RealField + Copy + AsPrimitive<usize> + ScalarOperand, usize: AsPrimitive<F>,

type BorderInfo = BorderInfo

Exchanged information to locate neighboring subdomains.

type NeighborValue = NeighborValue<F>

Extracellular value of neighbor

fn treat_increments<I, J>( &mut self, neighbors: I, sources: J, ) -> Result<(), CalcError>

where I: IntoIterator<Item = <CartesianDiffusion2DSubDomain<F> as SubDomainReactions<Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>, F>>::NeighborValue>, J: IntoIterator<Item = (Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>)>,

Combines increments which have been obtained by neighbors and cell-sources

fn update_fluid_dynamics(&mut self, dt: F) -> Result<(), CalcError>

Main update function to calculate new values of extracellular concentrations.

fn get_extracellular_at_pos( &self, pos: &Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, ) -> Result<Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>, CalcError>

Obtain extracellular concentrations at given point.

fn get_neighbor_value( &self, border_info: <CartesianDiffusion2DSubDomain<F> as SubDomainReactions<Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>, F>>::BorderInfo, ) -> <CartesianDiffusion2DSubDomain<F> as SubDomainReactions<Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>, F>>::NeighborValue

Obtains the SubDomainReactions::NeighborValue which should be sent to the neighbor which has exposed the given SubDomainReactions::BorderInfo.

fn get_border_info( &self, ) -> <CartesianDiffusion2DSubDomain<F> as SubDomainReactions<Matrix<F, Const<2>, Const<1>, ArrayStorage<F, 2, 1>>, Matrix<F, Dyn, Const<1>, VecStorage<F, Dyn, Const<1>>>, F>>::BorderInfo

Obtains the SubDomainReactions::BorderInfo used to retrieve the SubDomainReactions::NeighborValue.