ClampingStats.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <cstddef>
#include <string_view>
 
namespace ChemistryLib
{
namespace PhreeqcIOData
{
struct ClampingStats
{
    std::string_view worst_component_name;  
    std::size_t n_cells = 0;                
    std::size_t n_values = 0;               
    std::size_t n_severe_cells = 0;         
    std::size_t n_severe_values = 0;        
    double total_clamped_amount = 0.0;
    double worst_negative_value = 0.0;

    double clamp(double c, double warning_threshold, std::string_view name);

    ClampingStats& operator+=(ClampingStats const& other);

    void report(double warning_threshold) const;
};
}  // namespace PhreeqcIOData
}  // namespace ChemistryLib