mg_stats.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017:  G-CSC, Goethe University Frankfurt
 * Author: Sebastian Reiter
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 */
 
#ifndef __H__UG_mg_stats
#define __H__UG_mg_stats
 
#include <string>
#include <vector>
#include "common/util/table.h"
 
namespace ug{
 
template <typename TDomain, typename TAlgebra>
class MGStats {
  public:
    typedef GridFunction<TDomain, TAlgebra> grid_func_t;
    typedef SmartPtr<grid_func_t>     sp_grid_func_t;
 
 
    enum Stage {
      BEFORE_PRE_SMOOTH,
      AFTER_PRE_SMOOTH,
      BEFORE_POST_SMOOTH,
      AFTER_POST_SMOOTH,
      INVALID         // always last!
    };
 
    static const int NUM_STAGES = INVALID + 1;
 
    MGStats();
 
 
    void set_exit_on_error(bool exitOnError);
 
 
    void set_write_err_vecs(bool writeErrVecs);
 
 
    void set_write_err_diffs(bool writeErrDiffs);
 
 
    void set_active_stages(const std::vector<int>& activeStages);
 
 
    void set_filename_prefix(const char* filename);
 
    void save_stats_to_file();
 
    void save_stats_to_file(const char* filename);
 
    void print();
 
    void clear();
 
 
    void set_defect(grid_func_t& gf, int lvl, Stage stage);
 
    const char* stage_name(Stage stage) {
      const char* stageNames[] = {  "BEFORE_PRE_SMOOTH",
                      "AFTER_PRE_SMOOTH",
                      "BEFORE_POST_SMOOTH",
                      "AFTER_POST_SMOOTH",
                      "INVALID"};
      return stageNames[stage];
    }
 
    const char* stage_norm_name(Stage stage) {
      const char* stageNames[] = {  "|bef pre smth|",
                      "|aft pre smth|",
                      "|bef post smth|",
                      "|aft post smth|",
                      "|INVALID|"};
      return stageNames[stage];
    }
 
  private:
    void level_required(int lvl);
    void write_header(int maxLvl);
 
    struct FuncEntry{
      FuncEntry() : stage(INVALID), norm(0) {}
      sp_grid_func_t  func;
      sp_grid_func_t  tmpFunc;
      Stage     stage;
      number      norm;
    };
 
    std::vector<FuncEntry>  m_funcs;
    bool    m_stageIsActive[NUM_STAGES];
    StringTable m_stats;
    int     m_statsRow;
    int     m_lastLvlWritten;
    int     m_maxLvl;
    std::string m_filenamePrefix;
    bool    m_exitOnError;
    bool    m_writeErrVecs;
    bool    m_writeErrDiffs;
};
 
 
}// end of namespace
 
//  include implementation
#include "mg_stats_impl.hpp"
 
 
#endif  //__H__UG_mg_stats