convergence_table.h

// ---------------------------------------------------------------------
//
// Copyright (C) 1999 - 2018 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------

#ifndef dealii_convergence_table_h
#define dealii_convergence_table_h


#include <deal.II/base/config.h>

#include <deal.II/base/table_handler.h>

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