timestep_report.hpp

Go to the documentation of this file.

// -------------------------------------------------------//
//
// SHAMROCK code for hydrodynamics
// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
//
// -------------------------------------------------------//
 
#pragma once
 
#include "shambase/aliases_float.hpp"
#include "shambase/aliases_int.hpp"
#include "shamsys/system_metrics.hpp"
#include <optional>
#include <string>
 
namespace shammodels {
 
    std::string report_perf_timestep(
        f64 rate,
        u64 nobj,
        u64 npatch,
        f64 tcompute,
        f64 mpi_timer,
        f64 alloc_time_device,
        f64 alloc_time_host,
        size_t max_mem_device,
        size_t max_mem_host,
        shamsys::SystemMetrics system_metrics = {},
        bool report_power_usage               = false);
 
} // namespace shammodels