orrery/checkpoint_8hpp_source.html

#pragma once


#include <cstdint>

#include <filesystem>

#include <string_view>


#include "orrery/core/particle_data.hpp"

#include "orrery/core/types.hpp"

#include "orrery/sim/configuration.hpp"


namespace orrery::sim {


inline constexpr std::string_view kCheckpointMagic = "ORRERYCK";


inline constexpr std::uint32_t kCheckpointVersion = 1;


struct Checkpoint {

    Configuration configuration;


    core::Index step = 0;


    core::ParticleData particles;

};


void write_checkpoint(const std::filesystem::path& path, const Checkpoint& checkpoint);


[[nodiscard]] Checkpoint read_checkpoint(const std::filesystem::path& path);


} // namespace orrery::sim

orrery::sim::write_checkpoint
void write_checkpoint(const std::filesystem::path &path, const Checkpoint &checkpoint)
Write checkpoint to path, atomically.

orrery::sim::read_checkpoint
Checkpoint read_checkpoint(const std::filesystem::path &path)
Read a checkpoint back.

orrery::sim::kCheckpointVersion
constexpr std::uint32_t kCheckpointVersion
The version of the layout in docs/formats/checkpoint.md.
Definition checkpoint.hpp:56

orrery::sim::kCheckpointMagic
constexpr std::string_view kCheckpointMagic
The eight bytes every checkpoint starts with.
Definition checkpoint.hpp:53

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

configuration.hpp
Everything a run is, as data.

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

orrery::sim::Checkpoint
A run, stopped.
Definition checkpoint.hpp:59

orrery::sim::Checkpoint::particles
core::ParticleData particles
Positions, velocities, accelerations and masses, exactly as they were.
Definition checkpoint.hpp:72

orrery::sim::Checkpoint::configuration
Configuration configuration
The settings the run was started with, including the ones the command line supplied rather than the f...
Definition checkpoint.hpp:62

orrery::sim::Checkpoint::step
core::Index step
How many steps had been taken when this was written.
Definition checkpoint.hpp:69

orrery::sim::Configuration
A whole run, as data.
Definition configuration.hpp:332

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