Reference documentation for deal.II version 8.1.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
convergence_table.h
1 // ---------------------------------------------------------------------
2 // @f$Id: convergence_table.h 30036 2013-07-18 16:55:32Z maier @f$
3 //
4 // Copyright (C) 1999 - 2013 by the deal.II authors
5 //
6 // This file is part of the deal.II library.
7 //
8 // The deal.II library is free software; you can use it, redistribute
9 // it, and/or modify it under the terms of the GNU Lesser General
10 // Public License as published by the Free Software Foundation; either
11 // version 2.1 of the License, or (at your option) any later version.
12 // The full text of the license can be found in the file LICENSE at
13 // the top level of the deal.II distribution.
14 //
15 // ---------------------------------------------------------------------
16 
17 #ifndef __deal2__convergence_table_h
18 #define __deal2__convergence_table_h
19 
20 
21 #include <deal.II/base/config.h>
22 #include <deal.II/base/table_handler.h>
23 
24 DEAL_II_NAMESPACE_OPEN
25 
26 
64 {
65 public:
70 
74  enum RateMode
75  {
89  };
90 
135  void
136  evaluate_convergence_rates (const std::string &data_column_key,
137  const std::string &reference_column_key,
138  const RateMode rate_mode,
139  const unsigned int dim = 2);
140 
141 
158  void
159  evaluate_convergence_rates (const std::string &data_column_key,
160  const RateMode rate_mode);
161 
169  void
170  omit_column_from_convergence_rate_evaluation(const std::string &key);
171 
186  void
187  evaluate_all_convergence_rates(const std::string &reference_column_key,
188  const RateMode rate_mode);
189 
203  void
204  evaluate_all_convergence_rates(const RateMode rate_mode);
205 
212  DeclException0 (ExcWrongValueType);
213 
217  DeclException1 (ExcRateColumnAlreadyExists,
218  std::string,
219  << "Rate column <" << arg1 << "> does already exist.");
221 };
222 
223 
224 DEAL_II_NAMESPACE_CLOSE
225 
226 #endif
DeclException1(ExcRateColumnAlreadyExists, std::string,<< "Rate column <"<< arg1<< "> does already exist.")
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_convergence_rates(const std::string &data_column_key, const std::string &reference_column_key, const RateMode rate_mode, const unsigned int dim=2)
DeclException0(ExcWrongValueType)