Skip to main content

Photon

Struct Photon 

Source
pub struct Photon {
    pub energy_joules: f64,
}
Expand description

A lightweight photon wrapper stored by energy in joules.

Fields§

§energy_joules: f64

Photon energy in joules.

Implementations§

Source§

impl Photon

Source

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

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

Source

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

Creates a photon from frequency.

Source

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

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);
Examples found in repository?
examples/basic_usage.rs (line 12)
11fn main() -> Result<(), &'static str> {
12    let photon = Photon::from_wavelength(500.0e-9).ok_or("expected valid photon wavelength")?;
13    let matter_wave =
14        MatterWave::from_mass_velocity(2.0, 3.0).ok_or("expected valid matter wave")?;
15    let quantum_numbers =
16        QuantumNumbers::new(2, 1, 0, 1).ok_or("expected valid quantum numbers")?;
17
18    assert!(photon.energy_ev().ok_or("expected photon energy in eV")? > 0.0);
19    assert!(
20        matter_wave
21            .wavelength()
22            .ok_or("expected matter wavelength")?
23            > 0.0
24    );
25    assert!(approx_eq(quantum_numbers.spin_projection(), 0.5));
26    assert!(approx_eq(
27        hydrogen_energy_level_ev(1).ok_or("expected hydrogen energy level")?,
28        -RYDBERG_ENERGY_EV,
29    ));
30    assert!(approx_eq(
31        minimum_position_uncertainty(REDUCED_PLANCK_CONSTANT)
32            .ok_or("expected minimum uncertainty")?,
33        0.5,
34    ));
35
36    Ok(())
37}
Source

pub const fn energy_joules(&self) -> f64

Returns the photon energy in joules.

Source

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

Returns the photon energy in electron volts.

Examples found in repository?
examples/basic_usage.rs (line 18)
11fn main() -> Result<(), &'static str> {
12    let photon = Photon::from_wavelength(500.0e-9).ok_or("expected valid photon wavelength")?;
13    let matter_wave =
14        MatterWave::from_mass_velocity(2.0, 3.0).ok_or("expected valid matter wave")?;
15    let quantum_numbers =
16        QuantumNumbers::new(2, 1, 0, 1).ok_or("expected valid quantum numbers")?;
17
18    assert!(photon.energy_ev().ok_or("expected photon energy in eV")? > 0.0);
19    assert!(
20        matter_wave
21            .wavelength()
22            .ok_or("expected matter wavelength")?
23            > 0.0
24    );
25    assert!(approx_eq(quantum_numbers.spin_projection(), 0.5));
26    assert!(approx_eq(
27        hydrogen_energy_level_ev(1).ok_or("expected hydrogen energy level")?,
28        -RYDBERG_ENERGY_EV,
29    ));
30    assert!(approx_eq(
31        minimum_position_uncertainty(REDUCED_PLANCK_CONSTANT)
32            .ok_or("expected minimum uncertainty")?,
33        0.5,
34    ));
35
36    Ok(())
37}
Source

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

Returns the photon frequency in hertz.

Source

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

Returns the photon wavelength in meters.

Source

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

Returns the photon momentum magnitude in kilogram meters per second.

Trait Implementations§

Source§

impl Clone for Photon

Source§

fn clone(&self) -> Photon

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Photon

Source§

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

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

impl PartialEq for Photon

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Copy for Photon

Source§

impl StructuralPartialEq for Photon

Auto Trait Implementations§

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> 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.