rust-roche 0.1.4

Rust translation of Tom Marsh's cpp-roche package for modelling Roche distorted stars/binary systems.
Documentation 
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

use crate::Vec3;
use crate::set_earth;
use crate::fblink;
use crate::Star;
use crate::ingress_egress;
use crate::errors::RocheError;
use pyo3::prelude::*;

// q, i, delta_phi make a triad of values, any two of which can be used to find the third.


/// Given a mass ratio and a phase width of the eclipse, findi finds the inclination at which the eclipse has that width. 
/// It returns -1 if the eclipse is always wider than the specified width, -2 if it is always narrower. 
/// Otherwise it returns the inclination in degrees. 
/// \param q the mass ratio = M2/M1
/// \param dphi the phase width of the eclipse
/// \param acc the accuracy to use in fblink.
/// \param delta_i the accuracy in inclination to return. The returned inclination is accurate to within delta_i degrees.
///
#[pyfunction]
#[pyo3(signature = (q, dphi, acc=1.0e-4, delta_i=1.0e-5))]
pub fn findi(q: f64, dphi: f64, acc: f64, delta_i: f64) -> Result<f64, RocheError> {

    if q <= 0.0 {
        return Err(RocheError::ParameterError("mass ratio must be positive".to_string()));
    }
    if dphi <= 0.0 || dphi >= 0.25 {
        return Err(RocheError::ParameterError("phase width must be between 0 and 0.25".to_string()));
    }
    if acc <= 0.0 || acc >= 0.1 {
        return Err(RocheError::ParameterError("accuracy must be between 0 and 0.1".to_string()));
    }
    if delta_i <= 0.0 || delta_i >= 10.0 {
        return Err(RocheError::ParameterError("delta_i must be between 0 and 10 degrees".to_string()));
    }

    let mut ilo: f64 = 65.0;
    let mut ihi: f64 = 90.0;
    let phi: f64 = dphi/2.0;
    let earth1: Vec3 = set_earth::set_earth_iangle(ilo, phi);
    let earth2: Vec3 = set_earth::set_earth_iangle(ihi, phi);
    let r: Vec3 = Vec3::new(0.0, 0.0, 0.0);
    
    // eclipsed at ilo?
    let elo: bool = fblink::fblink(q, Star::Secondary, 1.0, 1.0, acc, &earth1, &r)?;
    let ehi: bool = fblink::fblink(q, Star::Secondary, 1.0, 1.0, acc, &earth2, &r)?;
    if elo && ehi {
        return Ok(-2.0);
    } else if !elo && !ehi {
        return Ok(-1.0);
    }
    while (ihi - ilo) > delta_i {
        let imid: f64 = (ilo + ihi)/2.0;
        let earth_mid: Vec3 = set_earth::set_earth_iangle(imid, phi);
        let emid: bool = fblink::fblink(q, Star::Secondary, 1.0, 1.0, acc, &earth_mid, &r)?;
        if emid {
            ihi = imid;
        } else {
            ilo = imid;
        }
    }
    Ok((ilo + ihi)/2.0)
}


/// Given an inclination and a phase width of the eclipse, findq finds the mass ratio at which the eclipse has that width. 
/// It returns -1 if the eclipse is always wider than the specified width, -2 if it is always narrower. 
/// Otherwise it returns the mass ratio. 
/// \param i the inclination in degrees
/// \param dphi the phase width of the eclipse
/// \param acc the accuracy to use in fblink.
/// \param delta_q the accuracy in mass ratio to return. The returned mass ratio is accurate to within delta_q.
///
#[pyfunction]
#[pyo3(signature = (i, dphi, acc=1.0e-4, delta_q=1.0e-5))]
pub fn findq(i: f64, dphi: f64, acc: f64, delta_q: f64) -> Result<f64, RocheError> {

    if i <= 0.0 || i >= 90.0 {
        return Err(RocheError::ParameterError("inclination must be between 0 and 90 degrees".to_string()));
    }
    if dphi <= 0.0 || dphi >= 0.25 {
        return Err(RocheError::ParameterError("phase width must be between 0 and 0.25".to_string()));
    }
    if acc <= 0.0 || acc >= 0.1 {
        return Err(RocheError::ParameterError("accuracy must be between 0 and 0.1".to_string()));
    }
    if delta_q <= 0.0 || delta_q >= 0.1 {
        return Err(RocheError::ParameterError("delta_q must be between 0 and 0.1".to_string()));
    }

    let mut qlo: f64 = 0.001;
    let mut qhi: f64 = 2.0;
    let phi: f64 = dphi/2.0;
    let earth: Vec3 = set_earth::set_earth_iangle(i, phi);
    let r: Vec3 = Vec3::new(0.0, 0.0, 0.0);

    let elo: bool = fblink::fblink(qlo, Star::Secondary, 1.0, 1.0, acc, &earth, &r)?;
    let ehi: bool = fblink::fblink(qhi, Star::Secondary, 1.0, 1.0, acc, &earth, &r)?;
    if elo && ehi {
        return Ok(-2.0);
    } else if !elo && !ehi {
        return Ok(-1.0);
    }
    while (qhi - qlo) > delta_q {
        let qmid: f64 = (qlo + qhi)/2.0;
        let emid: bool = fblink::fblink(qmid, Star::Secondary, 1.0, 1.0, acc, &earth, &r)?;
        if emid {
            qhi = qmid;
        } else {
            qlo = qmid;
        }
    }
    Ok((qlo + qhi)/2.0)
}

#[pyfunction]
#[pyo3(signature = (q, iangle, delta=1.0e-6))]
/// Given an mass ration and inclination, findphi finds the phase width of the white dwarf eclipse. 
/// It returns -1 if white dwarf is not eclipsed.
///
/// \param q the mass ratio = M2/M1
/// \param i the inclination in degrees
/// \param acc the accuracy to use in fblink.
/// \param delta the accuracy to use in ingress_egress.
/// \return the phase width of the white dwarf eclipse, or -1 if the white dwarf is not eclipsed.
///
pub fn findphi(q: f64, iangle: f64, delta: f64) -> Result<f64, RocheError> {

    let r: Vec3 = Vec3::new(0.0, 0.0, 0.0);
    let mut ingress: f64 = 0.0;
    let mut egress: f64 = 0.0;
    //q: f64, star: Star, spin: f64, ffac: f64, iangle: f64, delta: f64, r: &Vec3, ingress: &mut f64, egress: &mut f64
    let status: bool = ingress_egress::ingress_egress(
        q, Star::Secondary, 1.0, 1.0, iangle, delta, &r, &mut ingress, &mut egress
    )?;
    if !status {
        return Ok(-1.0);
    }
    Ok(egress-ingress)
}