Chaste Commit::1fd4e48e3990e67db148bc1bc4cf6991a0049d0c
|
#include <StepSizeException.hpp>
Public Member Functions | |
StepSizeException (double suggestedNewStep, const std::string message, bool isTerminal) | |
virtual const char * | what () const throw () |
~StepSizeException () throw () | |
double | GetSuggestedNewStep () |
bool | IsTerminal () |
Private Attributes | |
double | mSuggestedNewStep |
const std::string | mMessage |
bool | mIsTerminal |
Exception class to handle the adaptive time stepping in off-lattice simulations.
We use this object since we are using it to signal to parent code that it needs to adapt the time step, rather than being an error for presentation to the user (for which we would use an Exception object).
Definition at line 46 of file StepSizeException.hpp.
|
inline |
Construct an exception with a message string.
suggestedNewStep | a suggestion for an updated timestep |
message | the error message to display |
isTerminal | whether the error is terminal if true the the simulation stops |
Definition at line 68 of file StepSizeException.hpp.
|
inline |
Destructor.
Definition at line 86 of file StepSizeException.hpp.
|
inline |
Definition at line 91 of file StepSizeException.hpp.
References mSuggestedNewStep.
|
inline |
|
inlinevirtual |
Overidden what() method to return the message specific to this error handler.
Definition at line 81 of file StepSizeException.hpp.
References mMessage.
|
private |
Whether or not to terminate the simulation.
Definition at line 57 of file StepSizeException.hpp.
Referenced by IsTerminal().
|
private |
|
private |
A suggested new time step.
Definition at line 51 of file StepSizeException.hpp.
Referenced by GetSuggestedNewStep().