Struct RodInteraction

pub struct RodInteraction<I>(pub I);

Available on crate feature elli only.

Automatically derives a Interaction suitable for rods from a point-wise interaction.

Tuple Fields

0: I

Trait Implementations

impl<I> AbsDiffEq for RodInteraction<I>

where I: AbsDiffEq + PartialEq, <I as AbsDiffEq>::Epsilon: Clone,

type Epsilon = <I as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <RodInteraction<I> as AbsDiffEq>::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq( &self, other: &RodInteraction<I>, epsilon: <RodInteraction<I> as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses the absolute difference to compute the approximimate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of [AbsDiffEq::abs_diff_eq].

impl<I> Clone for RodInteraction<I>

where I: Clone,

fn clone(&self) -> RodInteraction<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for RodInteraction<I>

where I: Debug,

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

Formats the value using the given formatter.

impl<'de, I> Deserialize<'de> for RodInteraction<I>

where I: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<I, F, Inf, const D: usize> Interaction<Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, Inf> for RodInteraction<I>

where I: Interaction<Matrix<F, Const<D>, Const<1>, ArrayStorage<F, D, 1>>, Matrix<F, Const<D>, Const<1>, ArrayStorage<F, D, 1>>, Matrix<F, Const<D>, Const<1>, ArrayStorage<F, D, 1>>, Inf>, F: 'static + RealField + Copy + Debug + Zero,

fn calculate_force_between( &self, own_pos: &Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, own_vel: &Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, ext_pos: &Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, ext_vel: &Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, ext_inf: &Inf, ) -> Result<(Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>), CalcError>

Calculates the forces (velocity-derivative) on the corresponding external position given external velocity. By providing velocities, we can calculate terms that are related to friction. The function returns two forces, one acting on the current agent and the other on the external agent.

fn is_neighbor( &self, own_pos: &Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, ext_pos: &Matrix<F, Dyn, Const<D>, VecStorage<F, Dyn, Const<D>>>, ext_inf: &Inf, ) -> Result<bool, CalcError>

Checks if the other cell represented by position and information is a neighbor to the current one or not.

fn react_to_neighbors(&mut self, neighbors: usize) -> Result<(), CalcError>

Reacts to the results gathered by the Interaction::is_neighbor method and changes the state of the cell.

impl<I, Inf> InteractionInformation<Inf> for RodInteraction<I>

where I: InteractionInformation<Inf>,

fn get_interaction_information(&self) -> Inf

Get additional information of cellular properties (ie. for cell-specific interactions).

impl<I> PartialEq for RodInteraction<I>

where I: PartialEq,

fn eq(&self, other: &RodInteraction<I>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<I> Serialize for RodInteraction<I>

where I: 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.

impl<I> StructuralPartialEq for RodInteraction<I>