5. Miscellaneous Utilities¶
Below are various miscellaneous utilities implemented in REBOUNDx.
5.1. track_min_distance¶
Authors |
|
Implementation Paper |
|
Based on |
None |
C Example |
Tracking a particle’s minimum distance from the central star. |
Python Example |
For a given particle, this keeps track of that particle’s minimum distance from another body in the simulation. User should add parameters to the particular particle whose distance should be tracked.
Effect Parameters
None
Particle Parameters
Only particles with their min_distance parameter set initially will track their minimum distance. The effect will
update this parameter when the particle gets closer than the value of min_distance, so the user has to set it
initially. By default, distance is measured from sim->particles[0], but you can specify a different particle by setting
the min_distance_from parameter to the hash of the target particle.
Name (C type) |
Required |
Description |
|---|---|---|
min_distance (double) |
Yes |
Particle’s mininimum distance. |
min_distance_from (uint32) |
No |
Hash for particle from which to measure distance |
min_distance_orbit (reb_orbit) |
No |
Parameter to store orbital elements at moment corresponding to min_distance (heliocentric) |
5.2. interpolation¶
Authors |
S.A. Baronett, D. Tamayo, N. Ferich |
Implementation Paper |
|
Based on |
|
C Example |
|
Python Example |
This isn’t an effect that’s loaded like the others, but an object that facilitates machine-independent interpolation of parameters that can be shared by both the C and Python versions. See the examples for how to use them.
Effect Parameters
Not applicable. See examples.
Particle Parameters
Not applicable. See examples.
5.3. steppers¶
Authors |
|
Implementation Paper |
|
Based on |
|
C Example |
None |
Python Example |
These are wrapper functions to taking steps with several of REBOUND’s integrators in order to build custom splitting schemes.
Effect Parameters
None
Particle Parameters
None