Struct gosh_elastic::Spring

pub struct Spring { /* private fields */ }

Represents an elastic spring between a central node i and with its neighboring node j.

Implementations

impl Spring

pub fn new(wij: f64) -> Self

Construct an Spring for elastic interaction between node i and node j

Parameters

• wij: the weight (elastic constant) of spring

pub fn with_length(self, dij: f64) -> Self

Set optional natural length of spring. The default value is 0.

pub fn energy_force(
    &self,
    displace: impl Into<Vector3f>,
    distance: impl Into<Option<f64>>
) -> (f64, Vector3f)

Returns energy and the force contribution of its neighbor j to center i.

displace is the displacement vector from center i to its neighbor j. distance is optional, if not set, it will be evaluated from displacement vector.

Trait Implementations

impl Clone for Spring

fn clone(&self) -> Spring

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spring

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

Formats the value using the given formatter.

impl Default for Spring

fn default() -> Spring

Returns the “default value” for a type.

impl Copy for Spring