convergence_table.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 1999 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
#ifndef dealii_convergence_table_h
#define dealii_convergence_table_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/table_handler.h>
#include <deal.II/base/types.h>
 
#include <ostream>
#include <string>
 
 
DEAL_II_NAMESPACE_OPEN
 
 
class ConvergenceTable : public TableHandler
{
public:
  ConvergenceTable() = default;
 
  enum RateMode
  {
    none,
    reduction_rate,
    reduction_rate_log2
  };
 
  void
  evaluate_convergence_rates(const std::string &data_column_key,
                             const std::string &reference_column_key,
                             const RateMode     rate_mode,
                             const unsigned int dim = 2);
 
 
  void
  evaluate_convergence_rates(const std::string &data_column_key,
                             const RateMode     rate_mode);
 
  void
  omit_column_from_convergence_rate_evaluation(const std::string &key);
 
  void
  evaluate_all_convergence_rates(const std::string &reference_column_key,
                                 const RateMode     rate_mode);
 
  void
  evaluate_all_convergence_rates(const RateMode rate_mode);
 
  DeclException1(ExcRateColumnAlreadyExists,
                 std::string,
                 << "Rate column <" << arg1 << "> does already exist.");
};
 
 
DEAL_II_NAMESPACE_CLOSE
 
#endif