EvolvingStellarCore.h

Go to the documentation of this file.

#ifndef __EVOLVING_STELLAR_CORE_H
#define __EVOLVING_STELLAR_CORE_H

#include "../Core/SharedLibraryExportMacros.h"
#include "EvolvingStellarZone.h"

#include "../Core/Functions.h"
#include "../StellarEvolution/EvolvingStellarQuantity.h"

namespace Star {

    class LIB_PUBLIC EvolvingStellarCore : public EvolvingStellarZone {
    private:
        const double __NEGLIGIBLE_INERTIA = 0.0;
        const double __NEGLIGIBLE_MASS = 0.0;
        const double __NEGLIGIBLE_RADIUS = 0.0;

        double __formation_age;

        enum QuantityIndex {
            MASS,   
            RADIUS, 
            INERTIA,
        };

        double positive_definite_quantity(size_t quantity,
                                          double age,
                                          unsigned deriv_order,
                                          double min_value) const;

        double current_positive_definite_quantity(size_t quantity,
                                                  unsigned deriv_order,
                                                  double min_value) const;

    public:
        EvolvingStellarCore(
            double formation_age=Core::Inf,

            const StellarEvolution::EvolvingStellarQuantity *mass = NULL,

            const StellarEvolution::EvolvingStellarQuantity *radius = NULL,

            const StellarEvolution::EvolvingStellarQuantity
            *moment_of_inertia = NULL
        ) :
            EvolvingStellarZone({mass, radius, moment_of_inertia}),
            __formation_age(formation_age)
        {}

        double moment_of_inertia(int deriv_order = 0) const
        {
            return current_positive_definite_quantity(INERTIA,
                                                      deriv_order,
                                                      __NEGLIGIBLE_INERTIA);
        }

        double moment_of_inertia(double age, int deriv_order = 0) const
        {
            return positive_definite_quantity(INERTIA,
                                              age,
                                              deriv_order,
                                              __NEGLIGIBLE_INERTIA);
        }

        double outer_radius(int deriv_order = 0) const
        {
            return current_positive_definite_quantity(RADIUS,
                                                      deriv_order,
                                                      __NEGLIGIBLE_RADIUS);
        }

        double outer_radius(double age, int deriv_order = 0) const
        {
            return positive_definite_quantity(RADIUS,
                                              age,
                                              deriv_order,
                                              __NEGLIGIBLE_RADIUS);
        }

        double outer_mass(int deriv_order = 0) const
        {
            return current_positive_definite_quantity(MASS,
                                                      deriv_order,
                                                      __NEGLIGIBLE_MASS);
        }

        double outer_mass(double age, int deriv_order = 0) const
        {
            return positive_definite_quantity(MASS,
                                              age,
                                              deriv_order,
                                              __NEGLIGIBLE_MASS);
        }

        double formation_age() const {return __formation_age;}
    }; //End EvolvingStellarCore class.

}//End Star namespace.

#endif