TidalPotentialTerms.h

Go to the documentation of this file.

#ifndef __TIDAL_POTENTIAL_TERMS_H
#define __TIDAL_POTENTIAL_TERMS_H

#include <cmath>
#include <valarray>
#include "EccentricityExpansionCoefficients.h"
#include "../Core/Common.h"

//TODO: No longer need to worry about e-order

namespace Evolve {
    class LIB_PUBLIC TidalPotentialTerms {
    private:
        static EccentricityExpansionCoefficients __pms;

        static const double __Umm_coef[][3];

        double __Ummp_inclination;

        double __arg_of_periapsis;

        std::valarray< std::valarray<double> >
            __Ummp,

            __Ummp_deriv;

    public:

        TidalPotentialTerms();

        static void prepare(const std::string &tabulated_pms_fname,
                            double precision,
                            bool pre_load,
                            bool disable_precision_fail)
        {
            __pms.prepare(tabulated_pms_fname,
                          precision,
                          pre_load,
                          disable_precision_fail);
        }


        //\mathrm{precision}\f$. The reasoning is that if \f$p_{m,s}\f$ will
        static unsigned required_expansion_order(
            double e
        )
        {
            return std::max(
                std::max(
                    __pms.required_expansion_order(e, -2),
                    __pms.required_expansion_order(e, 0)
                ),
                __pms.required_expansion_order(e, 2)
            );
        }

        inline double get_expansion_precision() const
        {return __pms.get_expansion_precision();}

        static std::pair<double,double> get_expansion_range(int max_mp);

        void configure(double inclination, double arg_of_periapsis = 0);

        void operator()(
            double e,

            int m,

            int mp,

            std::complex<double> &no_deriv,

            std::complex<double> &inclination_deriv,

            std::complex<double> &eccentricity_deriv
        ) const;

        void operator()(
            double e,

            int m,

            int mp,

            double &no_deriv,

            double &inclination_deriv,

            double &eccentricity_deriv
        ) const;

        static unsigned max_expansion_order()
        {return __pms.max_expansion_order();}

        static const EccentricityExpansionCoefficients &
            expansion_coefficient_evaluator()
            {return __pms;}
    }; //End TidalPotentialTerms class.
} //End Evolve namespace

#endif