swarm::monitors Namespace Reference

Namespace for monitors (i.e., stoppers & loggers) and their associated classes. More...

Classes
struct	combine_monitors_params
	Define parameters for combining monitors. More...
struct	combine
	Template to allow developer to join two monitors Signal is true if either monitor returns true. More...
struct	stop_on_ejection_or_close_encounter_or_crossing_orbit
	Combination of stop_on_ejcetion, stop_on_close_encounter and stop_on_crossing_orbit. More...
struct	stop_on_ejection_or_close_encounter
	Combination of stop_on_ejcetion and stop_on_close_encounter EXPERIMENTAL: This class is not thoroughly tested. More...
struct	log_time_interval_params
	Parameters for log_time_interval monitor log_on_interval (bool): log_interval (real): time between sucessive logging. More...
class	log_time_interval
	Monitor that logs the entire state of systems at periodic intervals of approximately "log_interval" Systems may be integrated for more than log interval before another log entry is written. More...
struct	log_transit_params
	Parameters for log_transit monitor log_transit_tol (real): desired precision of transit times (zero makes inactive) More...
class	log_transit
	Monitor that logs (the estimated transit time, the estimated minimum impact parameter in units of stellar radii, and the estimated velocity projected onto the planet of the sky in units of stellar radii per time) at times near a transit EXPERIMENTAL: This class is not thoroughly tested. More...
struct	monitor_template_params
	Structure for monitor_template_params. More...
class	monitor_template
	Empty monitor to use as a template. More...
struct	stop_on_all_but_two_at_large_distance_params
	Parameters for stop_on_all_but_two_at_large_distance monitor deactivate_on_close_encounter (bool): log_on_close_encounter (bool): verbose_on_close_encounter (bool): rmax (real): minimum distance between bodies to be considered isolated. More...
class	stop_on_all_but_two_at_large_distance
	Simple monitor that signals and logs when no more than two bodies are within a distance "rmax" of origin or another body. More...
struct	stop_on_any_large_distance_params
	Parameters for stop_on_any_large_distance monitor deactivate_on_close_encounter (bool): log_on_close_encounter (bool): verbose_on_close_encounter (bool): rmax (real): minimum distance between bodies to trigger. More...
class	stop_on_any_large_distance
	Simple monitor that logs when any one body is separated from EXPERIMENTAL: This class is not thoroughly tested. More...
struct	stop_on_close_encounter_param
	Parameters for stop_on_close_encounter monitor deactivate_on_close_encounter (bool): log_on_close_encounter (bool): verbose_on_close_encounter (bool): close_approach (real): maximum distance in Hill radii to trigger action. More...
class	stop_on_close_encounter
	Simple monitor to detect close encounters. More...
struct	stop_on_collision_param
	Parameters for stop_on_collision monitor deactivate_on_collision (bool): log_on_collision (bool): verbose_on_collision (bool): collision_distance_to_origin (real): default distance or collision if individual radii not avaliable. More...
class	stop_on_collision
	Simple monitor to detect physical collisions. More...
struct	stop_on_crossing_orbit_params
	Parameters for stop_on_crossing_orbit monitor deactivate_on_crossing (bool): log_on_crossing (bool): verbose_on_crossing (bool): More...
class	stop_on_crossing_orbit
	Stopping monitor to detect crossing orbits for planets EXPERIMENTAL: This class is not thoroughly tested. More...
struct	stop_on_ejection_params
	Parameters for stop_on_ejection monitor deactivate_on_ejection (bool): log_on_ejection (bool): verbose_on_ejection (bool): rmax (real): minimum distance to check for ejections. More...
class	stop_on_ejection
	Simple monitor that signals and logs when any body (other than body 0) meets all of the following criteria: More...

Detailed Description

Namespace for monitors (i.e., stoppers & loggers) and their associated classes.