Struct MiePotentialF32

pub struct MiePotentialF32 {
    pub radius: f32,
    pub strength: f32,
    pub bound: f32,
    pub cutoff: f32,
    pub en: f32,
    pub em: f32,
}

Generalizeation of the BoundLennardJones potential.

\begin{align} U(r) &= C\epsilon\left[ \left(\frac{\sigma}{r}\right)^n - \left(\frac{\sigma}{r}\right)^m\right]\\ C &= \frac{n}{n-m}\left(\frac{n}{m}\right)^{\frac{n}{n-m}}\\ V(r) &= \min(U(r), \beta)\theta(r-\zeta) \end{align}

This struct comes in a 64bit version MiePotential and a 32bit variant MiePotentialF32.

References

G. Mie, “Zur kinetischen Theorie der einatomigen Körper,” Annalen der Physik, vol. 316, no. 8. Wiley, pp. 657–697, Jan. 1903. doi: 10.1002/andp.19033160802.

Fields

radius: f32

Interaction strength $\epsilon$ of the potential.

strength: f32

Overall size $\sigma$ of the object of the potential.

bound: f32

Numerical bound $\beta$ of the interaction strength.

cutoff: f32

Defines a cutoff $\zeta$ after which the potential will be fixed to exactly zero.

en: f32

Exponent $n$ of the potential

em: f32

Exponent $m$ of the potential

Implementations

impl MiePotentialF32

pub fn new( radius: f32, strength: f32, bound: f32, cutoff: f32, en: f32, em: f32, ) -> MiePotentialF32

Available on crate feature cpu_os_threads only.

Constructs a new MiePotentialF32

use cellular_raza_building_blocks::MiePotentialF32;
let (radius, strength, bound, cutoff, en, em) = (1.0, 1.0, 1.0, 1.0, 1.0, 1.0);
let mie_potential = MiePotentialF32::new(
    radius,
    strength,
    bound,
    cutoff,
    en,
    em,
);

Trait Implementations

impl Clone for MiePotentialF32

fn clone(&self) -> MiePotentialF32

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MiePotentialF32

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MiePotentialF32

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<const D: usize> Interaction<Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, f32> for MiePotentialF32

fn calculate_force_between( &self, own_pos: &Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, _own_vel: &Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, ext_pos: &Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, _ext_vel: &Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, ext_radius: &f32, ) -> Result<(Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>, Matrix<f32, Const<D>, Const<1>, ArrayStorage<f32, D, 1>>), 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 get_interaction_information(&self) -> f32

Get additional information of cellular properties (ie. for cell-specific interactions). For now, this can also be used to get the mass of the other cell-agent. In the future, we will probably provide a custom function for this.

fn is_neighbor( &self, own_pos: &Pos, ext_pos: &Pos, 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 IntoPy<Py<PyAny>> for MiePotentialF32

fn into_py(self, py: Python<'_>) -> Py<PyAny>

Performs the conversion.

impl PartialEq for MiePotentialF32

fn eq(&self, other: &MiePotentialF32) -> 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 PyClass for MiePotentialF32

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for MiePotentialF32

const NAME: &'static str = "MiePotentialF32"

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_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl Serialize for MiePotentialF32

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 MiePotentialF32

impl StructuralPartialEq for MiePotentialF32