1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
//
// A rust binding for the GSL library by Guillaume Gomez (guillaume1.gomez@gmail.com)
//
use crate::{types, Value};
use std::mem::MaybeUninit;
/// This routine computes the lowest-order normalized hydrogenic bound state radial wavefunction R_1 := 2Z \sqrt{Z} \exp(-Z r).
#[doc(alias = "gsl_sf_hydrogenicR_1")]
pub fn hydrogenicR_1(Z: f64, r: f64) -> f64 {
unsafe { sys::gsl_sf_hydrogenicR_1(Z, r) }
}
/// This routine computes the lowest-order normalized hydrogenic bound state radial wavefunction R_1 := 2Z \sqrt{Z} \exp(-Z r).
#[doc(alias = "gsl_sf_hydrogenicR_1_e")]
pub fn hydrogenicR_1_e(Z: f64, r: f64) -> Result<types::Result, Value> {
let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
let ret = unsafe { sys::gsl_sf_hydrogenicR_1_e(Z, r, result.as_mut_ptr()) };
result_handler!(ret, unsafe { result.assume_init() }.into())
}
/// This routine computes the n-th normalized hydrogenic bound state radial wavefunction,
///
/// R_n := 2 (Z^{3/2}/n^2) \sqrt{(n-l-1)!/(n+l)!} \exp(-Z r/n) (2Zr/n)^l
/// L^{2l+1}_{n-l-1}(2Zr/n).
///
/// where L^a_b(x) is the generalized Laguerre polynomial (see [`Laguerre Functions`](http://www.gnu.org/software/gsl/manual/html_node/Laguerre-Functions.html#Laguerre-Functions)).
/// The normalization is chosen such that the wavefunction \psi is given by \psi(n,l,r) = R_n Y_{lm}.
#[doc(alias = "gsl_sf_hydrogenicR")]
pub fn hydrogenicR(n: i32, l: i32, Z: f64, r: f64) -> f64 {
unsafe { sys::gsl_sf_hydrogenicR(n, l, Z, r) }
}
/// This routine computes the n-th normalized hydrogenic bound state radial wavefunction,
///
/// R_n := 2 (Z^{3/2}/n^2) \sqrt{(n-l-1)!/(n+l)!} \exp(-Z r/n) (2Zr/n)^l
/// L^{2l+1}_{n-l-1}(2Zr/n).
///
/// where L^a_b(x) is the generalized Laguerre polynomial (see [`Laguerre Functions`](http://www.gnu.org/software/gsl/manual/html_node/Laguerre-Functions.html#Laguerre-Functions)).
/// The normalization is chosen such that the wavefunction \psi is given by \psi(n,l,r) = R_n Y_{lm}.
#[doc(alias = "gsl_sf_hydrogenicR_e")]
pub fn hydrogenicR_e(n: i32, l: i32, Z: f64, r: f64) -> Result<types::Result, Value> {
let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
let ret = unsafe { sys::gsl_sf_hydrogenicR_e(n, l, Z, r, result.as_mut_ptr()) };
result_handler!(ret, unsafe { result.assume_init() }.into())
}
/// This function computes the Coulomb wave functions F_L(\eta,x), G_{L-k}(\eta,x) and their derivatives F'_L(\eta,x), G'_{L-k}(\eta,x) with respect to x. The parameters are restricted to L, L-k > -1/2, x > 0 and integer k. Note that L itself is not restricted to being an integer. The results are stored in the parameters F, G for the function values and Fp, Gp for the derivative values.
/// If an overflow occurs, GSL_EOVRFLW is returned and scaling exponents are stored in the modifiable parameters exp_F, exp_G.
///
/// Returns `(F, Fp, G, Gp)`.
#[doc(alias = "gsl_sf_coulomb_wave_FG_e")]
pub fn wave_FG_e(
eta: f64,
x: f64,
L_F: f64,
k: i32,
exp_F: &mut f64,
exp_G: &mut f64,
) -> Result<
(
::types::Result,
::types::Result,
::types::Result,
::types::Result,
),
Value,
> {
let mut F = MaybeUninit::<sys::gsl_sf_result>::uninit();
let mut Fp = MaybeUninit::<sys::gsl_sf_result>::uninit();
let mut G = MaybeUninit::<sys::gsl_sf_result>::uninit();
let mut Gp = MaybeUninit::<sys::gsl_sf_result>::uninit();
let ret = unsafe {
sys::gsl_sf_coulomb_wave_FG_e(
eta,
x,
L_F,
k,
F.as_mut_ptr(),
Fp.as_mut_ptr(),
G.as_mut_ptr(),
Gp.as_mut_ptr(),
exp_F,
exp_G,
)
};
result_handler!(
ret,
(
unsafe { F.assume_init() }.into(),
unsafe { Fp.assume_init() }.into(),
unsafe { G.assume_init() }.into(),
unsafe { Gp.assume_init() }.into(),
)
)
}
/// This function computes the Coulomb wave function F_L(\eta,x) for L = Lmin \dots Lmin + kmax,
/// storing the results in fc_array. In the case of overflow the exponent is stored in F_exponent.
///
/// Returns `F_exponent`.
#[doc(alias = "gsl_sf_coulomb_wave_F_array")]
pub fn wave_F_array(L_min: f64, eta: f64, x: f64, fc_array: &mut [f64]) -> Result<f64, Value> {
let mut F_exponent = 0.;
let ret = unsafe {
sys::gsl_sf_coulomb_wave_F_array(
L_min,
fc_array.len() as i32,
eta,
x,
fc_array.as_mut_ptr(),
&mut F_exponent,
)
};
result_handler!(ret, F_exponent)
}
/// This function computes the functions F_L(\eta,x), G_L(\eta,x) for L = Lmin \dots Lmin + kmax
/// storing the results in fc_array and gc_array. In the case of overflow the exponents are stored
/// in F_exponent and G_exponent.
///
/// Returns `(F_exponent, G_exponent)`.
#[doc(alias = "gsl_sf_coulomb_wave_FG_array")]
pub fn wave_FG_array(
L_min: f64,
eta: f64,
x: f64,
fc_array: &mut [f64],
gc_array: &mut [f64],
) -> Result<(f64, f64), Value> {
let mut F_exponent = 0.;
let mut G_exponent = 0.;
let ret = unsafe {
sys::gsl_sf_coulomb_wave_FG_array(
L_min,
fc_array.len() as i32,
eta,
x,
fc_array.as_mut_ptr(),
gc_array.as_mut_ptr(),
&mut F_exponent,
&mut G_exponent,
)
};
result_handler!(ret, (F_exponent, G_exponent))
}
/// This function computes the functions F_L(\eta,x), G_L(\eta,x) and their derivatives
/// F'_L(\eta,x), G'_L(\eta,x) for L = Lmin \dots Lmin + kmax storing the results in fc_array,
/// gc_array, fcp_array and gcp_array. In the case of overflow the exponents are stored in
/// F_exponent and G_exponent.
///
/// Returns `(F_exponent, G_exponent)`.
#[doc(alias = "gsl_sf_coulomb_wave_FGp_array")]
pub fn wave_FGp_array(
L_min: f64,
eta: f64,
x: f64,
fc_array: &mut [f64],
fcp_array: &mut [f64],
gc_array: &mut [f64],
gcp_array: &mut [f64],
) -> Result<(f64, f64), Value> {
let mut F_exponent = 0.;
let mut G_exponent = 0.;
let ret = unsafe {
sys::gsl_sf_coulomb_wave_FGp_array(
L_min,
fc_array.len() as i32,
eta,
x,
fc_array.as_mut_ptr(),
fcp_array.as_mut_ptr(),
gc_array.as_mut_ptr(),
gcp_array.as_mut_ptr(),
&mut F_exponent,
&mut G_exponent,
)
};
result_handler!(ret, (F_exponent, G_exponent))
}
/// This function computes the Coulomb wave function divided by the argument F_L(\eta, x)/x for
/// L = Lmin \dots Lmin + kmax, storing the results in fc_array. In the case of overflow the
/// exponent is stored in F_exponent. This function reduces to spherical Bessel functions in the
/// limit \eta \to 0.
///
/// Returns `F_exponent`.
#[doc(alias = "gsl_sf_coulomb_wave_sphF_array")]
pub fn wave_sphF_array(L_min: f64, eta: f64, x: f64, fc_array: &mut [f64]) -> Result<f64, Value> {
let mut F_exponent = 0.;
let ret = unsafe {
sys::gsl_sf_coulomb_wave_sphF_array(
L_min,
fc_array.len() as i32,
eta,
x,
fc_array.as_mut_ptr(),
&mut F_exponent,
)
};
result_handler!(ret, F_exponent)
}
/// This function computes the Coulomb wave function normalization constant C_L(\eta) for L > -1.
#[doc(alias = "gsl_sf_coulomb_CL_e")]
pub fn CL_e(L: f64, eta: f64) -> Result<types::Result, Value> {
let mut result = MaybeUninit::<sys::gsl_sf_result>::uninit();
let ret = unsafe { sys::gsl_sf_coulomb_CL_e(L, eta, result.as_mut_ptr()) };
result_handler!(ret, unsafe { result.assume_init() }.into())
}
/// This function computes the Coulomb wave function normalization constant C_L(\eta) for L = Lmin \dots Lmin + kmax, Lmin > -1.
#[doc(alias = "gsl_sf_coulomb_CL_array")]
pub fn CL_array(Lmin: f64, eta: f64, cl: &mut [f64]) -> Result<(), Value> {
let ret = unsafe { sys::gsl_sf_coulomb_CL_array(Lmin, cl.len() as i32, eta, cl.as_mut_ptr()) };
result_handler!(ret, ())
}