Miscellaneous Structures¶

group
MiscRebStructs
Miscellaneous REBOUND structures
Enums

enum
REB_STATUS
¶ Enumeration describing the return status of rebound_integrate.
Values:

REB_RUNNING_PAUSED
= 3¶ Simulation is paused by visualization.

REB_RUNNING_LAST_STEP
= 2¶ Current timestep is the last one. Needed to ensures that t=tmax exactly.

REB_RUNNING
= 1¶ Simulation is current running, no error occured.

REB_EXIT_SUCCESS
= 0¶ Integration finished successfully.

REB_EXIT_ERROR
= 1¶ A generic error occured and the integration was not successfull.

REB_EXIT_NOPARTICLES
= 2¶ The integration ends early because no particles are left in the simulation.

REB_EXIT_ENCOUNTER
= 3¶ The integration ends early because two particles had a close encounter (see exit_min_distance)

REB_EXIT_ESCAPE
= 4¶ The integration ends early because a particle escaped (see exit_max_distance)

REB_EXIT_USER
= 5¶ User caused exit, simulation did not finish successfully.

REB_EXIT_SIGINT
= 6¶ SIGINT received. Simulation stopped.

REB_EXIT_COLLISION
= 7¶ The integration ends early because two particles collided.


struct
reb_collision
¶  #include <rebound.h>
Collision structure describing a single collision.
This structure is used to save a collision during collision search. It is passed to the collision_resolve function.

struct
reb_variational_configuration
¶  #include <rebound.h>
Struct describing the properties of a set of variational equations.
One struct describes one or more sets of variational equations. If testparticle is set to 1, then it is assumed that all particles are massive and all particles influence all other particles. If testparticle is >=0 then the particle with that index is assumed to be a testparticle, i.e. it does not influence other particles. For second order variational equation, index_1st_order_a/b is the index in the particle array that corresponds to the 1st order variational equations.
Public Members

struct reb_simulation *
sim
¶ Reference to the simulation.

int
order
¶ Order of the variational equation. 1 or 2.

int
index
¶ Index of the first variational particle in the particles array.

int
testparticle
¶ Is this variational configuration describe a test particle? 1 if not.

int
index_1st_order_a
¶ Used for 2nd order variational particles only: Index of the first first order variational particle in the particles array.

int
index_1st_order_b
¶ Used for 2nd order variational particles only: Index of the first first order variational particle in the particles array.

struct reb_simulation *

enum