run_output.hpp

Go to the documentation of this file.

#pragma once

 
#include <filesystem>
#include <optional>
#include <span>
 
#include "orrery/core/types.hpp"
#include "orrery/sim/configuration.hpp"
#include "orrery/sim/diagnostics_log.hpp"
#include "orrery/sim/trajectory.hpp"
 
namespace orrery::sim {
 
class Simulation;

class RunOutput {
public:
    virtual ~RunOutput() = default;

    virtual void record(const Simulation& simulation, bool is_final) = 0;
 
protected:
    // As on the other interfaces in this project: a class with a virtual
    // destructor suppresses the implicit copy and move operations, and copying
    // an implementation through a reference to this base would slice it.
    RunOutput() = default;
    RunOutput(const RunOutput&) = default;
    RunOutput(RunOutput&&) = default;
    RunOutput& operator=(const RunOutput&) = default;
    RunOutput& operator=(RunOutput&&) = default;
};

class FileOutput final : public RunOutput {
public:
    FileOutput(const Configuration& configuration, std::span<const core::Real> masses);
 
    void record(const Simulation& simulation, bool is_final) override;

    [[nodiscard]] core::Index frames_written() const noexcept;

    [[nodiscard]] core::Index checkpoints_written() const noexcept { return checkpoints_; }
 
private:
    [[nodiscard]] bool due(core::Index step, core::Index stride, bool is_final) const noexcept;
 
    Configuration configuration_;
 
    std::optional<TrajectoryWriter> trajectory_;
    std::optional<DiagnosticsLog> diagnostics_;
 
    std::filesystem::path checkpoint_path_;
    core::Index checkpoints_ = 0;
    bool first_ = true;
};
 
} // namespace orrery::sim