Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
Evolve::NoStopCondition Class Reference

A stopping condition that is never satisfied. More...

#include <StoppingCondition.h>

+ Inheritance diagram for Evolve::NoStopCondition:
+ Collaboration diagram for Evolve::NoStopCondition:

Public Member Functions

std::valarray< double > operator() (Core::EvolModeType, const std::valarray< double > &, const std::valarray< double > &, std::valarray< double > &stop_deriv) const
 
StoppingConditionType type (unsigned=0) const
 Identifies the condition as NO_STOP. More...
 
void reached (short, unsigned=0)
 See StoppingCondition::reached(). More...
 
- Public Member Functions inherited from Evolve::StoppingCondition
 StoppingCondition (short expected_crossing_deriv_sign=0)
 Create a generic stopping condition. More...
 
virtual size_t num_subconditions () const
 The number of subconditions in the current condition. 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 stopping condition that is never satisfied.

Definition at line 150 of file StoppingCondition.h.

Member Function Documentation

◆ operator()()

std::valarray<double> Evolve::NoStopCondition::operator() ( Core::EvolModeType  ,
const std::valarray< double > &  ,
const std::valarray< double > &  ,
std::valarray< double > &  stop_deriv 
) const
inlinevirtual

A single value is reternud that is always 1.

See StoppingCondition::operator()() for a description of the arguments.

Implements Evolve::StoppingCondition.

Definition at line 156 of file StoppingCondition.h.

◆ reached()

void Evolve::NoStopCondition::reached ( short  ,
unsigned  = 0 
)
inlinevirtual

See StoppingCondition::reached().

Reimplemented from Evolve::StoppingCondition.

Definition at line 166 of file StoppingCondition.h.

◆ type()

StoppingConditionType Evolve::NoStopCondition::type ( unsigned  = 0) const
inlinevirtual

Identifies the condition as NO_STOP.

Implements Evolve::StoppingCondition.

Definition at line 163 of file StoppingCondition.h.


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