orrery/uniform__sphere_8hpp_source.html

#pragma once


#include "orrery/core/particle_data.hpp"

#include "orrery/core/random.hpp"

#include "orrery/core/types.hpp"


namespace orrery::initial_conditions {


struct UniformSphereParameters {

    core::Index count = 0;


    core::Real total_mass = 1;


    core::Real radius = 1;

};


[[nodiscard]] core::ParticleData make_uniform_sphere(const UniformSphereParameters& parameters,

                                                     core::RandomSource& random);


[[nodiscard]] core::Real uniform_sphere_potential_energy(const UniformSphereParameters& parameters);


} // namespace orrery::initial_conditions

orrery::core::ParticleData
Storage for a set of point masses in structure-of-arrays layout.
Definition particle_data.hpp:43

orrery::core::RandomSource
A seeded stream of random numbers.
Definition random.hpp:46

particle_data.hpp
The particle store: one contiguous array per component.

random.hpp
The project's source of randomness, and the only one.

orrery::initial_conditions::UniformSphereParameters
A sphere of uniform density to sample.
Definition uniform_sphere.hpp:33

orrery::initial_conditions::UniformSphereParameters::total_mass
core::Real total_mass
Shared equally among the particles, so that the sampled density is uniform in mass as well as in numb...
Definition uniform_sphere.hpp:38

types.hpp
The scalar and index types that every layer of the project agrees on.

orrery::core::Index
std::size_t Index
The type of a particle index and of any count of particles.
Definition types.hpp:45

orrery::initial_conditions::make_uniform_sphere
core::ParticleData make_uniform_sphere(const UniformSphereParameters &parameters, core::RandomSource &random)
Sample count particles uniformly through the sphere, at rest.

orrery::initial_conditions::uniform_sphere_potential_energy
core::Real uniform_sphere_potential_energy(const UniformSphereParameters &parameters)
The potential energy of the model, -3 G M^2 / 5 R.