plummer.hpp

Go to the documentation of this file.

#pragma once

 
#include <numbers>
 
#include "orrery/core/particle_data.hpp"
#include "orrery/core/random.hpp"
#include "orrery/core/types.hpp"
 
namespace orrery::initial_conditions {

inline constexpr core::Real kStandardPlummerRadius = 3 * std::numbers::pi_v<core::Real> / 16;

struct PlummerParameters {
    core::Index count = 0;

    core::Real total_mass = 1;
 
    core::Real scale_radius = kStandardPlummerRadius;

    core::Real mass_fraction_cutoff = static_cast<core::Real>(0.999);
};

[[nodiscard]] core::ParticleData make_plummer_sphere(const PlummerParameters& parameters,
                                                     core::RandomSource& random);

[[nodiscard]] core::Real plummer_potential_energy(const PlummerParameters& parameters);

[[nodiscard]] core::Real plummer_kinetic_energy(const PlummerParameters& parameters);

[[nodiscard]] core::Real plummer_total_energy(const PlummerParameters& parameters);
 
} // namespace orrery::initial_conditions