Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
Public Member Functions | Private Attributes | List of all members
Star::WindSaturationCondition Class Reference
Orbit Solver

Satisfied when the surface zone of a body is spinning at exactly the wind saturation frequency. More...

#include <WindSaturationCondition.h>

+ Inheritance diagram for Star::WindSaturationCondition:
+ Collaboration diagram for Star::WindSaturationCondition:

Public Member Functions

 WindSaturationCondition (SaturatingSkumanichWindBody &body, const Evolve::DissipatingBody &other_body, bool primary, bool saturated)
 
std::valarray< double > operator() (Core::EvolModeType evol_mode, const std::valarray< double > &orbit, const std::valarray< double > &derivatives, std::valarray< double > &stop_deriv) const
 The difference between the convective and wind saturation angular velocities divided by the latter. More...
 
Evolve::StoppingConditionType type (unsigned=0) const
 Identify this as a WIND_SATURATION condition. More...
 
void reached (short deriv_sign, unsigned index=0)
 See StoppingCondition::reached(). More...
 
virtual std::string describe (int index=-1) const
 See StoppingCondition::describe(). 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...
 

Private Attributes

double __saturation_freq
 The frequency at which the wind saturates. More...
 
SaturatingSkumanichWindBody & __body
 The body this condition is monitoring. More...
 
const Evolve::DissipatingBody & __other_body
 The primary body in the system if not __body. More...
 
bool __primary
 Is __body we are the primary in the system? More...
 

Detailed Description

Satisfied when the surface zone of a body is spinning at exactly the wind saturation frequency.

Definition at line 21 of file WindSaturationCondition.h.

Constructor & Destructor Documentation

◆ WindSaturationCondition()

Star::WindSaturationCondition::WindSaturationCondition ( SaturatingSkumanichWindBody &  body,
const Evolve::DissipatingBody &  other_body,
bool  primary,
bool  saturated 
)
inline
Parameters
bodyThe body whose wind saturation we are monitoring.
other_bodyThe other body in the system.
primaryIs the body we are monitoring the primary?
saturatedIs the wind currently saturated or not?

Definition at line 35 of file WindSaturationCondition.h.

Member Function Documentation

◆ describe()

std::string Star::WindSaturationCondition::describe ( int  index = -1) const
virtual

See StoppingCondition::describe().

Implements Evolve::StoppingCondition.

Definition at line 55 of file WindSaturationCondition.cpp.

◆ operator()()

std::valarray< double > Star::WindSaturationCondition::operator() ( Core::EvolModeType  evol_mode,
const std::valarray< double > &  orbit,
const std::valarray< double > &  derivatives,
std::valarray< double > &  stop_deriv 
) const
virtual

The difference between the convective and wind saturation angular velocities divided by the latter.

Implements Evolve::StoppingCondition.

Definition at line 12 of file WindSaturationCondition.cpp.

◆ reached()

void Star::WindSaturationCondition::reached ( short  deriv_sign,
unsigned  index = 0 
)
inlinevirtual

See StoppingCondition::reached().

Reimplemented from Evolve::StoppingCondition.

Definition at line 69 of file WindSaturationCondition.h.

◆ type()

Evolve::StoppingConditionType Star::WindSaturationCondition::type ( unsigned  = 0) const
inlinevirtual

Identify this as a WIND_SATURATION condition.

Implements Evolve::StoppingCondition.

Definition at line 65 of file WindSaturationCondition.h.

Member Data Documentation

◆ __body

SaturatingSkumanichWindBody& Star::WindSaturationCondition::__body
private

The body this condition is monitoring.

Definition at line 27 of file WindSaturationCondition.h.

◆ __other_body

const Evolve::DissipatingBody& Star::WindSaturationCondition::__other_body
private

The primary body in the system if not __body.

Definition at line 30 of file WindSaturationCondition.h.

◆ __primary

bool Star::WindSaturationCondition::__primary
private

Is __body we are the primary in the system?

Definition at line 33 of file WindSaturationCondition.h.

◆ __saturation_freq

double Star::WindSaturationCondition::__saturation_freq
private

The frequency at which the wind saturates.

Definition at line 24 of file WindSaturationCondition.h.

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