include/deal.II/base/convergence_table.h

00001 //---------------------------------------------------------------------------
00002 //    @f$Id: convergence_table.h 25345 2012-03-31 08:37:04Z bangerth @f$
00003 //
00004 //    Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2008, 2011, 2012 by the deal.II authors
00005 //
00006 //    This file is subject to QPL and may not be  distributed
00007 //    without copyright and license information. Please refer
00008 //    to the file deal.II/doc/license.html for the  text  and
00009 //    further information on this license.
00010 //
00011 //---------------------------------------------------------------------------
00012 #ifndef __deal2__convergence_table_h
00013 #define __deal2__convergence_table_h
00014 
00015 
00016 #include <deal.II/base/config.h>
00017 #include <deal.II/base/table_handler.h>
00018 
00019 DEAL_II_NAMESPACE_OPEN
00020 
00021 
00058 class ConvergenceTable: public TableHandler
00059 {
00060   public:
00064     ConvergenceTable();
00065 
00069     enum RateMode {
00073           none,
00079           reduction_rate,
00089           reduction_rate_log2
00090     };
00091 
00140     void
00141     evaluate_convergence_rates (const std::string &data_column_key,
00142                                 const std::string &reference_column_key,
00143                                 const RateMode     rate_mode);
00144 
00145 
00172     void
00173     evaluate_convergence_rates (const std::string &data_column_key,
00174                                 const RateMode     rate_mode);
00175 
00187     void
00188     omit_column_from_convergence_rate_evaluation(const std::string &key);
00189 
00217     void
00218     evaluate_all_convergence_rates(const std::string &reference_column_key,
00219                                    const RateMode     rate_mode);
00220 
00245     void
00246     evaluate_all_convergence_rates(const RateMode rate_mode);
00247 
00254     DeclException0 (ExcWrongValueType);
00255 
00259     DeclException1 (ExcRateColumnAlreadyExists,
00260                     std::string,
00261                     << "Rate column <" << arg1 << "> does already exist.");
00263 };
00264 
00265 
00266 DEAL_II_NAMESPACE_CLOSE
00267 
00268 #endif
00269 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

deal.II documentation generated on Tue May 22 2012 12:06:04 by doxygen 1.7.3