From 15a179c6a00bf549c3c5d7c097d21f081e7383b3 Mon Sep 17 00:00:00 2001 From: Alex Ganose Date: Mon, 9 Mar 2020 16:21:16 -0700 Subject: [PATCH] Fix typos in API doc --- src/Brooglie.jl | 2 +- src/CaptureRate.jl | 10 +++++----- src/Potential.jl | 8 ++++---- src/paramScan.jl | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/src/Brooglie.jl b/src/Brooglie.jl index ba3a1a2..beecfb4 100644 --- a/src/Brooglie.jl +++ b/src/Brooglie.jl @@ -115,7 +115,7 @@ normalizewf(φ, L) = φ / √integrate(φ.^2, L) Solve the potential `V`(x,y,z,...) in a grid xᵢ ∈ [`a`,`b`], discretized in `N` steps. -The particle is asumed to have mass `m` (by default 1, a electron mass). +The particle is assumed to have mass `m` (by default 1, a electron mass). The function will return the `nev` first energy levels (in Hartree[^1]) and its normalized eigenfunctions. diff --git a/src/CaptureRate.jl b/src/CaptureRate.jl index ad06c01..ba585f0 100644 --- a/src/CaptureRate.jl +++ b/src/CaptureRate.jl @@ -15,7 +15,7 @@ Stores two `potential`s with e-ph coupling constant `W` to calculate the capture ## Fields - `name` -- the name of a configuration coordinate. -- `V1` and `V2` -- the initial and fianal `potential`s. +- `V1` and `V2` -- the initial and final `potential`s. - `W` -- the e-ph coupling matrix element. - `g` -- the degeneracy. - `temperature` -- the temperature range where `capt_coeff` is calculated. @@ -46,10 +46,10 @@ conf_coord(pot_i::potential, pot_f::potential) = conf_coord("", pot_i, pot_f, In """ calc_overlap!(cc::conf_coord; cut_off = 0.25, σ = 0.025) -Calculate phonon overlap between phonon wave functions 'potenrial.χ'. +Calculate phonon overlap between phonon wave functions 'potential.χ'. If energy difference is larger then the cutoff (eV) `abs(cc.V1.ϵ[i] - cc.V2.ϵ[j]) > cut_off`, the overlap will not be calculated. -Delta functions are replaced by a Gaussians function with widths `σ`. +Delta functions are replaced by Gaussian functions with widths `σ`. """ function calc_overlap!(cc::conf_coord; cut_off = 0.25, σ = 0.025) Q₀ = cc.V1.Q0 @@ -77,7 +77,7 @@ end """ calc_capt_coeff!(cc::conf_coord, V::Float64, temperature) -Calculte the capture coefficient `cc.capt_coeff` as a function of `temperature` which is a `UnitRange`. +Calculate the capture coefficient `cc.capt_coeff` as a function of `temperature` which is a `UnitRange`. `V` is a volume where the electron-phonon coupling matrix element `cc.W` is calculated. The lowest thermal occupation number of the eigenstate must be lower than `occ_cut_off = 1E-5`. @@ -127,7 +127,7 @@ end # importing parameters """ Depreciated. -Construct `conf_coord` from two potentials `pot_i` (initila) and 'pot_f' (final) and configure dictionalry `cfg`. +Construct `conf_coord` from two potentials `pot_i` (initial) and 'pot_f' (final) and configure dictionary `cfg`. """ function cc_from_dict(pot_i, pot_f, cfg::Dict)::conf_coord cc = conf_coord(pot_i, pot_f) diff --git a/src/Potential.jl b/src/Potential.jl index 24ccfc0..0e36f33 100644 --- a/src/Potential.jl +++ b/src/Potential.jl @@ -17,7 +17,7 @@ Stores a potential in one-dimensional space Q, with discreet points (E0, Q0) and - `QE_data` -- the (n X 2) DataFrame of data points (Q vs Energy). - `E0`, `Q0` -- the minimum point of the potential [`Q0`, `E0`]. - `func_type` -- the type of fitting function ("bspline", "spline", "harmonic", "polyfunc", "morse_poly", "morse"). -- `params` -- the list of hyper paramters for the fitting function. +- `params` -- the list of hyper parameters for the fitting function. - `Q`, `E` -- `Q` and `E`=`func(Q, p_opt; params)`. - `nev` -- the number of eigenvalues to be evaluated. - `ϵ` -- the list of eigenvalues @@ -82,7 +82,7 @@ Fit a function `pot.func_type` to `QE_data` on the domain `Q`. Polynomial function; `y = E₀ + Σ coeffs[i].* (x .- Q₀) .^(i-1)`. - `poly_order`: the maximum order of polynomials. - - `p0`: the initial paramters for the fitting function. + - `p0`: the initial parameters for the fitting function. ## Example - Spline fit @@ -237,7 +237,7 @@ end # read potential """ Depreciated. -Construct `potential` from `QE_data` and configure dictionalry `cfg`. +Construct `potential` from `QE_data` and configure dictionary `cfg`. """ function pot_from_dict(QE_data::DataFrame, cfg::Dict)::potential pot = potential() @@ -351,7 +351,7 @@ end function get_bspline(Qs, Es) # BSplines assume your data is uniformly spaced on the grid - # Qs, Es have to be eqaully-spaced (Range) + # Qs, Es have to be equally-spaced (Range) if Qs[1] > Qs[end] Qs = reverse(Qs) Es = reverse(Es) diff --git a/src/paramScan.jl b/src/paramScan.jl index 5a249a4..6c6074c 100644 --- a/src/paramScan.jl +++ b/src/paramScan.jl @@ -98,7 +98,7 @@ function fitMorseParams(a_i, a_f, b_i, b_f, Q0, E0) a_i: first parameter of the Morse potential of the initial state a_f: first parameter of the Morse potential of the final state b_i: second parameter of the Morse potential of the initial state - b_f: seond parameter of the Morse potential of the final state + b_f: second parameter of the Morse potential of the final state Q0 : horizontal shift between the PES', in amu^0.5 Å^-1 E0 : vertical shift between the PES', in eV