Planetary Orbital Evolution due to Tides
Orbital evolution of two objects experiencing tides
Public Member Functions | Private Attributes | List of all members
TwoPhaseLagZone Class Reference

A class that only defines the phase lag function for zones. More...

#include <TwoPhaseLagZone.h>

+ Inheritance diagram for TwoPhaseLagZone:
+ Collaboration diagram for TwoPhaseLagZone:

Public Member Functions

 TwoPhaseLagZone (double equilibrium_modified_lag=0, double inertial_modified_lag=0)
 Create the zone with the given phase lags. More...
 
void set_equilibrium_modified_lag (double lag)
 Set the modified pase lag outside the inertia wave frequency range. More...
 
void set_inertial_modified_lag (double lag)
 Set the modified pase lag in the inertia wave frequency range. More...
 
virtual double modified_phase_lag (int orbital_frequency_multiplier, int spin_frequency_multiplier, double forcing_frequency, Dissipation::QuantityEntry entry, double &above_lock_value) const
 Should return the tidal phase lag time the love number for the given tidal term (or one of its derivatives). More...
 
virtual double love_coefficient (int, int, Dissipation::QuantityEntry) const
 Should return the corresponding component of the love coefficient (Lai 2012 Equation 24). More...
 

Private Attributes

double __equilibrium_modified_lag
 The modified pase lag outside the inertia wave frequency range. More...
 
double __inertial_modified_lag
 The modified phase lag in the inertial wave frequency range. More...
 

Detailed Description

A class that only defines the phase lag function for zones.

Definition at line 15 of file TwoPhaseLagZone.h.

Constructor & Destructor Documentation

◆ TwoPhaseLagZone()

TwoPhaseLagZone::TwoPhaseLagZone ( double  equilibrium_modified_lag = 0,
double  inertial_modified_lag = 0 
)
inline

Create the zone with the given phase lags.

Parameters
equilibrium_modified_lagThe modified pase lag outside the inertia wave frequency range.
inertial_modified_lagThe modified phase lag in the inertial wave frequency range.

Definition at line 24 of file TwoPhaseLagZone.h.

Member Function Documentation

◆ love_coefficient()

virtual double TwoPhaseLagZone::love_coefficient ( int  ,
int  ,
Dissipation::QuantityEntry   
) const
inlinevirtual

Should return the corresponding component of the love coefficient (Lai 2012 Equation 24).

Definition at line 76 of file TwoPhaseLagZone.h.

◆ modified_phase_lag()

double TwoPhaseLagZone::modified_phase_lag ( int  orbital_frequency_multiplier,
int  spin_frequency_multiplier,
double  forcing_frequency,
Dissipation::QuantityEntry  entry,
double &  above_lock_value 
) const
virtual

Should return the tidal phase lag time the love number for the given tidal term (or one of its derivatives).

In case the forcing frequency is exactly zero, it should return the phase lag for the case of the spin frequency approaching the term from below. The lag for spin frequency approaching from above should be written to above_lock_value. If the forcing frequency is non-zero, leave above_lock_value untouched.

Parameters
orbital_frequency_multiplierThe multiplier of the orbital frequency in the expression for the forcing frequency.
spin_frequency_multiplierThe multiplier of the spin frequency in the expression for the forcing frequency.
forcing_frequencyThe current forcing frequency in rad/day.
entryThe return value should be either the phase lag itself (NO_DERIV) or its derivative w.r.t. the specified quantity.
above_lock_valueIf the lag of a locked term is calculated this should be set to the lag assuming the spin frequency is just above the lock. Otherwise, leave untouched.

Definition at line 3 of file TwoPhaseLagZone.cpp.

◆ set_equilibrium_modified_lag()

void TwoPhaseLagZone::set_equilibrium_modified_lag ( double  lag)
inline

Set the modified pase lag outside the inertia wave frequency range.

Definition at line 37 of file TwoPhaseLagZone.h.

◆ set_inertial_modified_lag()

void TwoPhaseLagZone::set_inertial_modified_lag ( double  lag)
inline

Set the modified pase lag in the inertia wave frequency range.

Definition at line 41 of file TwoPhaseLagZone.h.

Member Data Documentation

◆ __equilibrium_modified_lag

double TwoPhaseLagZone::__equilibrium_modified_lag
private

The modified pase lag outside the inertia wave frequency range.

Definition at line 18 of file TwoPhaseLagZone.h.

◆ __inertial_modified_lag

double TwoPhaseLagZone::__inertial_modified_lag
private

The modified phase lag in the inertial wave frequency range.

Definition at line 18 of file TwoPhaseLagZone.h.

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