A base class for all external stopping conditions. More...

Inheritance diagram for Evolve::ExternalStoppingCondition:

Collaboration diagram for Evolve::ExternalStoppingCondition:

Public Member Functions
StoppingConditionType	type (unsigned=0) const
	Identify this as an EXTERNAL condition. More...

Public Member Functions inherited from Evolve::StoppingCondition
	StoppingCondition (short expected_crossing_deriv_sign=0)
	Create a generic stopping condition. More...

virtual std::valarray< double >	operator() (Core::EvolModeType evol_mode, const std::valarray< double > &orbit, const std::valarray< double > &derivatives, std::valarray< double > &stop_deriv) const =0
	The values of quantities which should cross zero when the condition(s) is(are) satisfied. More...

virtual size_t	num_subconditions () const
	The number of subconditions in the current condition. More...

virtual void	reached (short deriv_sign, unsigned index=0)
	Called when a stopping condition has been reached by the evolution. More...

virtual short	expected_crossing_deriv_sign (unsigned index=0) const
	The expected sign of the derivative at the next zero-crossing. More...

virtual std::string	describe (int index=-1) const =0
	Overwrite with something returning a description of what the stopping condition is monitoring. More...

Detailed Description

A base class for all external stopping conditions.

Definition at line 173 of file StoppingCondition.h.

Member Function Documentation

StoppingConditionType Evolve::ExternalStoppingCondition::type ( unsigned = 0 ) const

inlinevirtual

Identify this as an EXTERNAL condition.

Definition at line 176 of file StoppingCondition.h.

The documentation for this class was generated from the following file: