Struct SpringOscillator 

pub struct SpringOscillator {
    pub spring_constant: f64,
    pub mass: f64,
}

A spring-mass oscillator state.

Fields

spring_constant: f64

mass: f64

Implementations

impl SpringOscillator

pub fn new(spring_constant: f64, mass: f64) -> Option<SpringOscillator>

Creates a spring oscillator from spring constant and mass.

pub fn angular_frequency(&self) -> Option<f64>

Computes angular frequency.

pub fn period(&self) -> Option<f64>

Computes period.

Examples

use core::f64::consts::PI;
use use_oscillation::SpringOscillator;

let oscillator = SpringOscillator::new(8.0, 2.0).unwrap();

assert!((oscillator.period().unwrap() - PI).abs() < 1.0e-12);

pub fn frequency(&self) -> Option<f64>

Computes frequency.

pub fn total_energy(&self, amplitude: f64) -> Option<f64>

Computes total oscillator energy for a given amplitude.

Trait Implementations

impl Clone for SpringOscillator

fn clone(&self) -> SpringOscillator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpringOscillator

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

Formats the value using the given formatter.

impl PartialEq for SpringOscillator

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

impl StructuralPartialEq for SpringOscillator