disc_galaxy.hpp

Go to the documentation of this file.

#pragma once

 
#include "orrery/core/particle_data.hpp"
#include "orrery/core/random.hpp"
#include "orrery/core/types.hpp"
#include "orrery/core/vec3.hpp"
 
namespace orrery::initial_conditions {

struct DiscGalaxyParameters {
    core::Index count = 0;

    core::Real disc_mass = 1;

    core::Real bulge_mass = static_cast<core::Real>(0.2);

    core::Real scale_length = 1;

    core::Real scale_height = static_cast<core::Real>(0.1);

    core::Real bulge_radius = static_cast<core::Real>(0.2);

    core::Real mass_fraction_cutoff = static_cast<core::Real>(0.99);

    core::Real softening = 0;

    core::Real inclination = 0;

    core::Real position_angle = 0;
};

[[nodiscard]] core::ParticleData make_disc_galaxy(const DiscGalaxyParameters& parameters,
                                                  core::RandomSource& random);

[[nodiscard]] core::Index disc_galaxy_disc_count(const DiscGalaxyParameters& parameters);

[[nodiscard]] core::Real disc_galaxy_particle_mass(const DiscGalaxyParameters& parameters);

[[nodiscard]] core::Real disc_galaxy_total_mass(const DiscGalaxyParameters& parameters);

[[nodiscard]] core::Real disc_galaxy_enclosed_mass(const DiscGalaxyParameters& parameters,
                                                   core::Real radius);

[[nodiscard]] core::Real disc_galaxy_circular_speed(const DiscGalaxyParameters& parameters,
                                                    core::Real radius);

[[nodiscard]] core::Vec3 disc_galaxy_spin_axis(const DiscGalaxyParameters& parameters);
 
} // namespace orrery::initial_conditions