Struct Photon 

pub struct Photon {
    pub energy_joules: f64,
}

A lightweight photon wrapper stored by energy in joules.

Fields

energy_joules: f64

Photon energy in joules.

Implementations

impl Photon

pub fn from_energy_joules(energy_joules: f64) -> Option<Photon>

Creates a photon from non-negative finite energy in joules.

pub fn from_frequency(frequency: f64) -> Option<Photon>

Creates a photon from frequency.

Examples found in repository

examples/facade_quantum.rs (line 9)

fn main() -> Result<(), &'static str> {
    let photon = Photon::from_frequency(1.0).ok_or("expected valid photon")?;
    let quantum_numbers =
        QuantumNumbers::new(2, 1, 0, 1).ok_or("expected valid quantum numbers")?;
    let wavelength =
        hydrogen_transition_wavelength(2, 1).ok_or("expected transition wavelength")?;

    assert!(approx_eq(
        photon.energy_joules(),
        use_physics::PLANCK_CONSTANT
    ));
    assert!(approx_eq(quantum_numbers.spin_projection(), 0.5));
    assert!(wavelength > 0.0);

    Ok(())
}

pub fn from_wavelength(wavelength: f64) -> Option<Photon>

Creates a photon from wavelength.

Examples

use use_quantum::Photon;

let photon = Photon::from_wavelength(500.0e-9).ok_or("expected valid wavelength")?;

assert!(photon.energy_joules() > 0.0);

pub const fn energy_joules(&self) -> f64

Returns the photon energy in joules.

Examples found in repository

examples/facade_quantum.rs (line 16)

fn main() -> Result<(), &'static str> {
    let photon = Photon::from_frequency(1.0).ok_or("expected valid photon")?;
    let quantum_numbers =
        QuantumNumbers::new(2, 1, 0, 1).ok_or("expected valid quantum numbers")?;
    let wavelength =
        hydrogen_transition_wavelength(2, 1).ok_or("expected transition wavelength")?;

    assert!(approx_eq(
        photon.energy_joules(),
        use_physics::PLANCK_CONSTANT
    ));
    assert!(approx_eq(quantum_numbers.spin_projection(), 0.5));
    assert!(wavelength > 0.0);

    Ok(())
}

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

Returns the photon energy in electron volts.

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

Returns the photon frequency in hertz.

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

Returns the photon wavelength in meters.

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

Returns the photon momentum magnitude in kilogram meters per second.

Trait Implementations

impl Clone for Photon

fn clone(&self) -> Photon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Photon

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

Formats the value using the given formatter.

impl PartialEq for Photon

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

impl StructuralPartialEq for Photon