Skip to main content

Bussi

Struct Bussi 

Source
pub struct Bussi { /* private fields */ }
Expand description

Stochastic momentum rescaling.

The time constant $\tau$ sets how long the kinetic energy of the system takes to decay to equilibrium.

When $\tau$ is 0, the rescaling factor $\alpha$ is:

 \alpha = \sqrt{\frac{g kT}{K}}

where $K$ is the instantaneous kinetic energy of the corresponding translational or rotational degrees of freedom, $N$ is the number of degrees of freedom, and $g$ is a random value sampled from the gamma distribution $\Gamma(N, 1)$ with the probability density function:

   f_N(g) = \frac{1}{\Gamma{(N)}} g^{N-1} e^{-g}

When $\tau$ is non-zero, $\alpha$ is given by:

\alpha = \sqrt{e^{-\delta t / \tau}
     + (1 - e^{-\delta t / \tau}) \frac{(2 g + n^2) kT}{2 K}
     + 2 n \sqrt{e^{-\delta t / \tau} (1-e^{-\delta t / \tau})
        \frac{kT}{2 K}}}

where $\delta t$ is the integration time step size and $n$ is a random value sampled from the standard normal distribution $\mathcal{N}(0, 1)$.

§Reference

§Example

use hoomd_md::thermostat::Bussi;

let bussi = Bussi::new(0.5);

Implementations§

Source§

impl Bussi

Source

pub fn new(tau: f64) -> Self

Construct a new Bussi thermostat with the given time constant.

§Example
use hoomd_md::thermostat::Bussi;

let bussi = Bussi::new(0.5);
Source

pub fn energy(&self) -> f64

The total energy of the thermostat.

§Example
use hoomd_md::thermostat::Bussi;

let bussi = Bussi::new(0.1);
let energy = bussi.energy();

Trait Implementations§

Source§

impl Clone for Bussi

Source§

fn clone(&self) -> Bussi

Returns a duplicate 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 Debug for Bussi

Source§

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

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

impl Default for Bussi

Source§

fn default() -> Bussi

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Bussi

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 PartialEq for Bussi

Source§

fn eq(&self, other: &Bussi) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for Bussi

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<M> Thermostat<M> for Bussi
where M: Temperature,

Source§

fn integrate_half_step_one<R: Rng + ?Sized>( &mut self, rng: &mut R, macrostate: &M, delta_t: f64, kinetic_energy: f64, degrees_of_freedom: usize, ) -> f64

Integrate the thermostat one half step forward in time. Read more
Source§

fn integrate_half_step_two<R: Rng + ?Sized>( &mut self, _rng: &mut R, _macrostate: &M, _delta_t: f64, _kinetic_energy: f64, _degrees_of_freedom: usize, ) -> f64

Integrate the thermostat one half step forward in time. Read more
Source§

impl StructuralPartialEq for Bussi

Auto Trait Implementations§

§

impl Freeze for Bussi

§

impl RefUnwindSafe for Bussi

§

impl Send for Bussi

§

impl Sync for Bussi

§

impl Unpin for Bussi

§

impl UnsafeUnpin for Bussi

§

impl UnwindSafe for Bussi

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,