testLockMonitoring.h

Go to the documentation of this file.

#ifndef __TEST_LOCK_MONITORING_H
#define __TEST_LOCK_MONITORING_H

#include <sstream>
#include <boost/math/special_functions/sign.hpp>

#include "../shared/Common.h"
#include "../../Planet/PlanetZone.h"
#include "../../Planet/Planet.h"

namespace Evolve {
    class test_LockMonitoring : public Test::Suite {
    private:
        Planet::PlanetZone __zone;

        void set_expansion_order(int max_orbital_multiplier);

        void set_orbital_spin_frequeqncy(double orbital_frequency,
                                         double spin_frequency);

        void add_locks_to_message(
            const SpinOrbitLockInfo &lock_below,
            const SpinOrbitLockInfo &lock_above,
            std::ostringstream &message
        );

        void add_zone_locks_to_message(std::ostringstream &message);

        void check_monitored_locks(
            double orbital_frequency,
            double spin_frequency,
            const SpinOrbitLockInfo &expected_lock_below,
            const SpinOrbitLockInfo &expected_lock_above
        );

        double sample_range(
            std::pair<double, double> range,

            unsigned position
        );

        void check_tidal_frequency_range(
            double lock_set_orbital_frequency,

            double lock_set_spin_frequency,

            double test_orbital_frequency,

            std::pair<double, double> test_spin_frequency_range,

            //term being tested.
            int orbital_frequency_multiplier,

            //term being calculated.
            int spin_frequency_multiplier,

            int expected_correction
        );

        void check_unlocked_tidal_frequency(
            int expansion_order,

            int lower_lock_orbital_freuqency_multiplier,

            double orbital_frequency
        );
    protected:
        void setup() {};

        void tear_down() {};

    public:
        test_LockMonitoring();

        void test_lock_init();

        void test_tidal_frequency_fix();
    }; //End test_LockMonitoring class.

} //End Evolve namespace.

#endif