Struct SimpleHarmonicOscillator 

pub struct SimpleHarmonicOscillator {
    pub amplitude: f64,
    pub angular_frequency: f64,
    pub phase: f64,
}

A simple scalar harmonic oscillator state.

Fields

amplitude: f64

angular_frequency: f64

phase: f64

Implementations

impl SimpleHarmonicOscillator

pub fn new( amplitude: f64, angular_frequency: f64, phase: f64, ) -> Option<SimpleHarmonicOscillator>

Creates a simple harmonic oscillator from amplitude, angular frequency, and phase.

pub fn displacement(&self, time: f64) -> Option<f64>

Computes displacement at time.

Examples

use use_oscillation::SimpleHarmonicOscillator;

let oscillator = SimpleHarmonicOscillator::new(2.0, 1.0, 0.0).unwrap();

assert!((oscillator.displacement(0.0).unwrap() - 2.0).abs() < 1.0e-12);

pub fn velocity(&self, time: f64) -> Option<f64>

Computes velocity at time.

pub fn acceleration(&self, time: f64) -> Option<f64>

Computes acceleration at time.

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

Computes the oscillation period.

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

Computes the oscillation frequency.

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

Computes maximum speed.

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

Computes maximum acceleration.

Trait Implementations

impl Clone for SimpleHarmonicOscillator

fn clone(&self) -> SimpleHarmonicOscillator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SimpleHarmonicOscillator

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

Formats the value using the given formatter.

impl PartialEq for SimpleHarmonicOscillator

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

impl StructuralPartialEq for SimpleHarmonicOscillator