debug_writer.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2015:  G-CSC, Goethe University Frankfurt
 * Author: Andreas Vogel
 * 
 * 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__LIB_ALGEBRA__OPERATOR__DEBUG_WRITER__
#define __H__LIB_ALGEBRA__OPERATOR__DEBUG_WRITER__
 
#include "common/util/smart_pointer.h"
#include "common/math/ugmath.h"
#include "common/profiler/profiler.h"
#include "common/util/file_util.h"
 
namespace ug{
 
template <size_t dim>
class IPositionProvider
{
public:
 
  virtual bool get_positions(std::vector<MathVector<dim> >&vec) = 0;
  virtual ~IPositionProvider() {}
};
 
class DebugWriterContext
{
  public:
  
    DebugWriterContext () : m_baseDir(".") {}
  
    inline void set_base_dir(const char* const baseDir) {m_baseDir = std::string(baseDir);}
    std::string get_base_dir() { return m_baseDir; }
    
    inline void enter_section(const char* secDir) {m_secDir.push_back(secDir);}
    
    inline void leave_section () {m_secDir.pop_back();}
 
    void print_message(const char * msg)
    {
      UG_LOG ("DBG > ");
      for (size_t i = 0; i < m_secDir.size (); i++)
      {
        UG_LOG (":" << m_secDir[i]);
      }
      UG_LOG (" > " << msg);
    }
 
    void compose_file_path(std::string& path)
    {
      path = get_base_dir ();
      if (! FileExists (path))
      {
        UG_WARNING ("IVectorDebugWriter: Directory '" << path << "' does not exist. Using cwd instead.\n");
        path = ".";
      }
      for (size_t i = 0; i < m_secDir.size (); i++)
      {
        path.append ("/"); //TODO: This can be OS-dependent.
        path.append (m_secDir[i]);
        if ((! FileExists (path)) && ! CreateDirectory (path))
          UG_WARNING ("IVectorDebugWriter: Could not create directory '" << path << "'. Using cwd instead.\n");
      }
      path.append ("/"); //TODO: This can be OS-dependent.
    }
    
  protected:
 
    std::string m_baseDir;
    
    std::vector<std::string> m_secDir;
};
 
 
template <typename TVector>
class IVectorDebugWriter
{
  public:
    typedef TVector vector_type;
 
  public:
    IVectorDebugWriter()
    : m_spContext (new DebugWriterContext), m_currentDim(-1) {}
    
    virtual ~IVectorDebugWriter(){}
 
    virtual void write_vector(const vector_type& vec, const char* name) = 0;
    
    int current_dimension() const {return m_currentDim;}
 
    template <int dim>
    const std::vector<MathVector<dim> >& get_positions() const
    {
      if(m_currentDim != dim) throw(UGError("Current dim is different."));
      return get_pos(Int2Type<dim>());
    }
 
    virtual void update_positions() {};
 
    template <int dim>
    void set_positions(const std::vector<MathVector<dim> >& vPos)
    {
      get_pos(Int2Type<dim>()) = vPos; m_currentDim = dim;
    }
 
    template <int dim>
    void set_positions(IPositionProvider<dim> & provider)
    {
      provider.get_positions(get_pos(Int2Type<dim>()));
      m_currentDim = dim;
    }
 
    int get_dim() const
    {
      return m_currentDim;
    }
  
    void set_context(SmartPtr<DebugWriterContext> context) {m_spContext = context;}
    
    SmartPtr<DebugWriterContext> get_context() {return m_spContext;}
 
    ConstSmartPtr<DebugWriterContext> get_context() const {return m_spContext;}
 
    virtual void print_message(const char * msg) {if (m_spContext.valid()) m_spContext->print_message(msg);}
 
    inline void set_base_dir(const char* const baseDir)
    {
      if (! m_spContext.valid())
        set_context (SmartPtr<DebugWriterContext> (new DebugWriterContext));
      m_spContext->set_base_dir (baseDir);
    }
    
    std::string get_base_dir() {return (m_spContext.valid())?  m_spContext->get_base_dir() : "";}
    
    inline void enter_section(const char* secDir) {if (m_spContext.valid()) m_spContext->enter_section (secDir);}
    
    inline void leave_section () {if (m_spContext.valid()) m_spContext->leave_section ();}
 
  protected:
  
    template <int dim>
    std::vector<MathVector<dim> >& positions()
    {
      m_currentDim = dim; return get_pos(Int2Type<dim>());
    }
    
    void compose_file_path(std::string& path)
    {
      if (m_spContext.valid()) m_spContext->compose_file_path (path);
      else path = ".";
    }
    
  protected:
  
    SmartPtr<DebugWriterContext> m_spContext;
 
    int m_currentDim;
 
    std::vector<MathVector<1> > m_vPos1d;
    std::vector<MathVector<2> > m_vPos2d;
    std::vector<MathVector<3> > m_vPos3d;
 
    std::vector<MathVector<1> >& get_pos(Int2Type<1>) {return m_vPos1d;}
    std::vector<MathVector<2> >& get_pos(Int2Type<2>) {return m_vPos2d;}
    std::vector<MathVector<3> >& get_pos(Int2Type<3>) {return m_vPos3d;}
    const std::vector<MathVector<1> >& get_pos(Int2Type<1>) const {return m_vPos1d;}
    const std::vector<MathVector<2> >& get_pos(Int2Type<2>) const {return m_vPos2d;}
    const std::vector<MathVector<3> >& get_pos(Int2Type<3>) const {return m_vPos3d;}
};
 
 
template <typename TAlgebra>
class IDebugWriter : public IVectorDebugWriter<typename TAlgebra::vector_type>
{
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename TAlgebra::vector_type vector_type;
 
    typedef typename TAlgebra::matrix_type matrix_type;
 
  public:
    virtual void write_vector(const vector_type& vec, const char* name) = 0;
 
    virtual void write_matrix(const matrix_type& mat, const char* name) = 0;
};
 
 
template <typename TVector>
class VectorDebugWritingObject
{
  public:
    typedef TVector vector_type;
 
  public:
    VectorDebugWritingObject() : m_spVectorDebugWriter(NULL) {}
    VectorDebugWritingObject(SmartPtr<IVectorDebugWriter<vector_type> > spDebugWriter)
      : m_spVectorDebugWriter(spDebugWriter) {}
 
    virtual ~VectorDebugWritingObject() {}
 
    virtual void set_debug(SmartPtr<IVectorDebugWriter<vector_type> > spDebugWriter)
    {
      m_spVectorDebugWriter = spDebugWriter;
    }
 
    SmartPtr<IVectorDebugWriter<vector_type> > vector_debug_writer() {return m_spVectorDebugWriter;}
    ConstSmartPtr<IVectorDebugWriter<vector_type> > vector_debug_writer() const {return m_spVectorDebugWriter;}
 
    bool vector_debug_writer_valid() const {return m_spVectorDebugWriter.valid();}
  
    void write_debug(const vector_type& vec, const char* filename)
    {
      write_debug(vec, std::string (filename));
    }
    
  protected:
    virtual void write_debug(const vector_type& vec, std::string name)
    {
      PROFILE_FUNC_GROUP("algebra debug");
    //  if no debug writer set, we're done
      if(m_spVectorDebugWriter.invalid()) return;
 
    //  check ending
      size_t iExtPos = name.find_last_of(".");
      if(iExtPos != std::string::npos && name.substr(iExtPos).compare(".vec") != 0)
        UG_THROW("Only '.vec' format supported for vectors, but"
                " filename is '"<<name<<"'.");
 
      if(iExtPos == std::string::npos)
        name.append(".vec");
 
    //  write
      m_spVectorDebugWriter->write_vector(vec, name.c_str());
    }
    
    void print_debugger_message(std::string msg)
    {
      print_debugger_message(msg.c_str());
    }
    void print_debugger_message(const char * msg)
    {
      if (m_spVectorDebugWriter.valid()) m_spVectorDebugWriter->print_message(msg);
    }
 
    void enter_vector_debug_writer_section(std::string secDir)
    {
        enter_vector_debug_writer_section(secDir.c_str());
    }
    void enter_vector_debug_writer_section(const char * secDir)
    {
      if (m_spVectorDebugWriter.valid()) m_spVectorDebugWriter->enter_section(secDir);
    }
  
    void leave_vector_debug_writer_section()
    {
      if (m_spVectorDebugWriter.valid()) m_spVectorDebugWriter->leave_section();
    }
  
  protected:
    SmartPtr<IVectorDebugWriter<vector_type> > m_spVectorDebugWriter;
};
 
template <typename TAlgebra>
class DebugWritingObject : public VectorDebugWritingObject<typename TAlgebra::vector_type>
{
  public:
    typedef TAlgebra algebra_type;
 
    typedef typename TAlgebra::vector_type vector_type;
 
    typedef typename TAlgebra::matrix_type matrix_type;
 
  protected:
    using VectorDebugWritingObject<vector_type>::write_debug;
    using VectorDebugWritingObject<vector_type>::set_debug;
 
  public:
    DebugWritingObject() : m_spDebugWriter(NULL) {}
    DebugWritingObject(SmartPtr<IDebugWriter<algebra_type> > spDebugWriter)
      :   VectorDebugWritingObject<vector_type>(spDebugWriter),
        m_spDebugWriter(spDebugWriter) {}
 
    DebugWritingObject(const DebugWritingObject<algebra_type> &parent)
      :   VectorDebugWritingObject<vector_type>(parent.m_spDebugWriter),
        m_spDebugWriter(parent.m_spDebugWriter) {}
 
    virtual ~DebugWritingObject() {}
 
    virtual void set_debug(SmartPtr<IDebugWriter<algebra_type> > spDebugWriter)
    {
      m_spDebugWriter = spDebugWriter;
      VectorDebugWritingObject<vector_type>::set_debug(m_spDebugWriter);
    }
 
    SmartPtr<IDebugWriter<algebra_type> > debug_writer() {return m_spDebugWriter;}
    ConstSmartPtr<IDebugWriter<algebra_type> > debug_writer() const {return m_spDebugWriter;}
 
    bool debug_writer_valid() const {return m_spDebugWriter.valid();}
    
  protected:
    void write_debug(const matrix_type& mat, const char* filename)
    {
      write_debug(mat, std::string(filename));
    }
    void write_debug(const matrix_type& mat, std::string name)
    {
      PROFILE_FUNC_GROUP("algebra debug");
    //  if no debug writer set, we're done
      if(m_spDebugWriter.invalid()) return;
 
    //  check ending
      size_t iExtPos = name.find_last_of(".");
      if(iExtPos != std::string::npos && name.substr(iExtPos).compare(".mat") != 0)
        UG_THROW("Only '.mat' format supported for matrices, but"
                " filename is '"<<name<<"'.");
 
      if(iExtPos == std::string::npos)
        name.append(".mat");
 
    //  write
      m_spDebugWriter->write_matrix(mat, name.c_str());
    }
 
    void enter_debug_writer_section(std::string secDir)
    {
      enter_debug_writer_section(secDir.c_str());
    }
    void enter_debug_writer_section(const char * secDir)
    {
      if (m_spDebugWriter.valid()) m_spDebugWriter->enter_section(secDir);
    }
  
    void leave_debug_writer_section()
    {
      if (m_spDebugWriter.valid()) m_spDebugWriter->leave_section();
    }
  
  protected:
    SmartPtr<IDebugWriter<algebra_type> > m_spDebugWriter;
};
 
} // end namespace ug
 
#endif /* __H__LIB_ALGEBRA__OPERATOR__DEBUG_WRITER__ */