Struct CartesianDiffusion2DSubDomain

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

Subdomain for the CartesianDiffusion2D domain.

Fields§

§diffusion_constant: F

Diffusion constant

Trait Implementations§

Source§

impl<F: Clone> Clone for CartesianDiffusion2DSubDomain<F>

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug> Debug for CartesianDiffusion2DSubDomain<F>

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<F> DomainCreateSubDomains<CartesianDiffusion2DSubDomain<F>> for CartesianDiffusion2D<F>
where F: RealField + Copy + AsPrimitive<usize> + 'static + Float + Debug + FromPrimitive, usize: AsPrimitive<F>,

Source§

type SubDomainIndex = usize

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

type VoxelIndex = [usize; 2]

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

fn create_subdomains( &self, n_subdomains: NonZeroUsize, ) -> Result<impl IntoIterator<Item = (Self::SubDomainIndex, CartesianDiffusion2DSubDomain<F>, 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> Serialize for CartesianDiffusion2DSubDomain<F>
where F: 'static + PartialEq + Clone + Debug + Serialize + for<'a> Deserialize<'a>,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<F, __cr_private_Cell> SortCells<__cr_private_Cell> for CartesianDiffusion2DSubDomain<F>
where CartesianSubDomain<F, 2>: SortCells<__cr_private_Cell>,

Source§

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.
Source§

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

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

impl<F> SubDomain for CartesianDiffusion2DSubDomain<F>

Source§

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

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

fn get_neighbor_voxel_indices( &self, voxel_index: &Self::VoxelIndex, ) -> Vec<Self::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.
Source§

fn get_all_indices(&self) -> Vec<Self::VoxelIndex>

Get all voxel indices of this [SubDomain].
Source§

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

Source§

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.
Source§

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

Source§

type BorderInfo = BorderInfo

Exchanged information to locate neighboring subdomains.
Source§

type NeighborValue = NeighborValue<F>

Extracellular value of neighbor
Source§

fn treat_increments<I, J>( &mut self, neighbors: I, sources: J, ) -> Result<(), CalcError>
where I: IntoIterator<Item = Self::NeighborValue>, J: IntoIterator<Item = (SVector<F, 2>, DVector<F>)>,

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

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

Main update function to calculate new values of extracellular concentrations.
Source§

fn get_extracellular_at_pos( &self, pos: &SVector<F, 2>, ) -> Result<DVector<F>, CalcError>

Obtain extracellular concentrations at given point.
Source§

fn get_neighbor_value( &self, border_info: Self::BorderInfo, ) -> Self::NeighborValue

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

fn get_border_info(&self) -> Self::BorderInfo

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

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

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