Struct Brownian2D

pub struct Brownian2D {
    pub pos: Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>,
    pub diffusion_constant: f64,
    pub kb_temperature: f64,
}

Available on crate feature elli only.

Brownian motion of particles

Parameters & Variables

Symbol	Struct Field	Description
$D$	diffusion_constant	Damping constant of each particle.
$k_BT$	kb_temperature	Product of temperature $T$ and Boltzmann constant $k_B$.
$\vec{x}$	pos	Position of the particle.
$R(t)$	(automatically generated)	Gaussian process

Equations

We integrate the standard brownian motion stochastic differential equation. \begin{equation} \dot{\vec{x}} = -\frac{D}{k_B T}\nabla V(x) + \sqrt{2D}R(t) \end{equation} The new random vector is then also sampled by a distribution with greater width. If we choose this value larger than one, we can resolve smaller timesteps to more accurately solve the equations.

Fields

pos: Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>

Current position of the particle $\vec{x}$.

diffusion_constant: f64

Diffusion constant $D$.

kb_temperature: f64

The product of temperature and boltzmann constant $k_B T$.

Implementations

impl Brownian2D

pub fn new( pos: [f64; 2], diffusion_constant: f64, kb_temperature: f64, ) -> Brownian2D

Available on crate feature cpu_os_threads only.

Constructs a new Brownian2D

impl Brownian2D

pub fn set_pos(&mut self, pos: [f64; 2])

Available on crate feature cpu_os_threads only.

[pyo3] setter for pos

pub fn set_diffusion_constant(&mut self, diffusion_constant: f64)

Available on crate feature cpu_os_threads only.

[pyo3] setter for diffusion_constant

pub fn set_kb_temperature(&mut self, kb_temperature: f64)

Available on crate feature cpu_os_threads only.

[pyo3] setter for kb_temperature

pub fn get_pos(&self) -> [f64; 2]

Available on crate feature cpu_os_threads only.

[pyo3] getter for pos

pub fn get_diffusion_constant(&self) -> f64

Available on crate feature cpu_os_threads only.

[pyo3] getter for diffusion_constant

pub fn get_kb_temperature(&self) -> f64

Available on crate feature cpu_os_threads only.

[pyo3] getter for kb_temperature

Trait Implementations

impl AbsDiffEq for Brownian2D

type Epsilon = <f64 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <Brownian2D as AbsDiffEq>::Epsilon

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

fn abs_diff_eq( &self, other: &Brownian2D, epsilon: <Brownian2D 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 Clone for Brownian2D

fn clone(&self) -> Brownian2D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Brownian2D

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Brownian2D

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoPy<Py<PyAny>> for Brownian2D

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

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for Brownian2D

type Target = Brownian2D

The Python output type

type Output = Bound<'py, <Brownian2D as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Brownian2D as IntoPyObject<'py>>::Output, <Brownian2D as IntoPyObject<'py>>::Error>

Performs the conversion.

impl Mechanics<Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>> for Brownian2D

fn get_random_contribution( &self, rng: &mut ChaCha8Rng, dt: f64, ) -> Result<(Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>), RngError>

Define a new random variable in case that the mechanics type contains a random aspect to its motion. By default this function does nothing.

fn calculate_increment( &self, force: Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, ) -> Result<(Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>), CalcError>

Calculate the time-derivative of force and velocity given all the forces that act on the cell. Simple damping effects should be included in this trait if not explicitly given by the SubDomainForce trait.

impl PartialEq for Brownian2D

fn eq(&self, other: &Brownian2D) -> 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 Position<Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>> for Brownian2D

fn pos(&self) -> Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>

Gets the cells current position.

fn set_pos( &mut self, pos: &Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, )

Gets the cells current velocity.

impl PyClass for Brownian2D

type Frozen = False

Whether the pyclass is frozen.

impl PyTypeInfo for Brownian2D

const NAME: &'static str = "Brownian2D"

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

Returns the safe abstraction over the type object.

fn type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::type_object].

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

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

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl RelativeEq for Brownian2D

fn default_max_relative() -> <Brownian2D as AbsDiffEq>::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Brownian2D, epsilon: <Brownian2D as AbsDiffEq>::Epsilon, max_relative: <Brownian2D as AbsDiffEq>::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

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

The inverse of [RelativeEq::relative_eq].

impl Serialize for Brownian2D

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 Velocity<Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>> for Brownian2D

fn velocity(&self) -> Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>

Gets the cells current velocity.

fn set_velocity( &mut self, _velocity: &Matrix<f64, Const<2>, Const<1>, ArrayStorage<f64, 2, 1>>, )

Sets the cells current velocity.

impl DerefToPyAny for Brownian2D

impl StructuralPartialEq for Brownian2D