Skip to content

Commit

Permalink
doc: update
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgepiloto committed Sep 9, 2024
1 parent c50a127 commit be690a9
Showing 1 changed file with 25 additions and 28 deletions.
53 changes: 25 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,31 +61,28 @@ where `author` is the name of the author which developed the solver and `YYYY`
the year of publication. Any of the solvers hosted by the `ALL_SOLVERS` macro
can be used.

**Parameters**
- `mu`: the gravitational parameter, that is the mass of the attracting body
- times the gravitational constant.
- `r1`: initial position vector.
- `r2`: final position vector.
- `tof`: time of flight between initial and final vectors.

**Additional parameters**
- `M`: the number of revolutions. If zero (default), direct transfer is assumed.
- `prograde`: this parameter controls the inclination of the final orbit. If set
- to `True`, the transfer will have an inclination between 0 and 90 degrees
- while if `False` inclinations between 90 and 180 are provided.
- `low_path`: selects the type of path when more than two solutions are available.
- There is no actual advantage on one or another solution, unless you have
- particular constrains on your mission.
- `maxiter`: maximum number of iterations allowed when computing the solution.
- `atol`: absolute tolerance for the iterative method.
- `rtol`: relative tolerance for the iterative method.
- `full_output`: if `True`, it returns additional information such us the number
of iterations.

**Returns**
* `v1`: initial velocity vector.
* `v2`: final velocity vector.

**Additional returns**
* `numiter`: number of iterations. Only if `full_output` has been set to `True`.
* `tpi`: time per iteration. Only if `full_output` has been set to `True`.

| Parameter | Description |
|--------------|-------------|
| `mu` | The gravitational parameter, i.e., mass of the attracting body times the gravitational constant. |
| `r1` | Initial position vector. |
| `r2` | Final position vector. |
| `tof` | Time of flight between initial and final vectors. |
|--------------|-------------|
| `M` | The number of revolutions. If zero (default), direct transfer is assumed. |
| `prograde` | Controls the inclination of the final orbit. If `True`, inclination between 0 and 90 degrees. If `False`, inclination between 90 and 180 degrees. |
| `low_path` | Selects the type of path when more than two solutions are available. No specific advantage unless there are mission constraints. |
| `maxiter` | Maximum number of iterations allowed when computing the solution. |
| `atol` | Absolute tolerance for the iterative method. |
| `rtol` | Relative tolerance for the iterative method. |
| `full_output`| If `True`, returns additional information such as the number of iterations. |

### Returns

| Return | Description |
|..--------|-------------|
| `v1` | Initial velocity vector. |
| `v2` | Final velocity vector. |
|----------|-------------|
| `numiter`| Number of iterations (only if `full_output` is `True`). |
| `tpi` | Time per iteration (only if `full_output` is `True`). |

0 comments on commit be690a9

Please sign in to comment.