ohno / Antique.jl

Self-contained, well-tested, well-documented Analytical Solutions of Quantum Mechanical Equations.
https://ohno.github.io/Antique.jl/
MIT License
18 stars 3 forks source link

typo in the harmonic oscillator documentation #27

Closed ajarifi closed 3 months ago

ajarifi commented 3 months ago

HarmonicOscillator(α=1.0, m=1.0, ℏ=1.0). α should be replaced by k. Like this: HarmonicOscillator(k=1.0, m=1.0, ℏ=1.0).

ajarifi commented 3 months ago

\xi may need to be defined earlier in the potential.

@doc raw""" HarmonicOscillator(k=1.0, m=1.0, ℏ=1.0)

k is the force constant, m is the mass of particle and \hbar is the reduced Planck constant (Dirac's constant). """ HarmonicOscillator

@doc raw""" V(model::HarmonicOscillator, x)

V(x)
= \frac{1}{2} k x^2
= \frac{1}{2} m \omega^2 x^2
= \frac{1}{2} \hbar \omega \xi^2,

where \omega = \sqrt{k/m} is the angular frequency and \xi = \sqrt{\frac{m\omega}{\hbar}}x. """ V(model::HarmonicOscillator, x)

ohno commented 3 months ago

https://github.com/ohno/Antique.jl/commit/323f795c2cb7cf70a2442b36f31955084340d421