cascade.outcome

class cascade.outcome

The simulation outcome enum.

This enum is used as the return value for the propagation methods of the sim class (such as cascade.sim.step() and cascade.sim.propagate_until()).

The possible values for the enum are:

• success, indicating the successful completion of a single step,

• time_limit, indicating that a time limit was reached,

• collision, indicating that a particle-particle collision occurred,

• reentry, indicating that a particle entered the reentry domain,

• exit, indicating that a particle exited the simulation domain,

• err_nf_state, indicating that one or more non-finite values were detected in the state of the simulation.

__init__()

Methods

__init__

Attributes

collision
err_nf_state
exit
name
reentry
success
time_limit
value