grid_level.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-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__UG__LIB_GRID__TOOLS__GRID_LEVEL__
#define __H__UG__LIB_GRID__TOOLS__GRID_LEVEL__
 
#include <string>
#include <iostream>
 
namespace ug{
 
class GridLevel
{
  public:
    enum{TOP = -1};
 
    enum ViewType{LEVEL = 0, SURFACE = 1};
 
  public:
    GridLevel() : m_level(TOP), m_type(SURFACE), m_bWithGhosts(false) {}
 
    GridLevel(int level, ViewType type, bool bWithGhosts = false)
      : m_level(level), m_type(type), m_bWithGhosts(bWithGhosts)
    {}
 
    GridLevel(int level)
      : m_level(level), m_type(SURFACE), m_bWithGhosts(false)
    {}
 
    GridLevel(int level, const std::string& type)
      : m_level(level), m_bWithGhosts(false)
    {
      if(type == "top") {m_type = LEVEL;}
      else if(type == "surf") {m_type = SURFACE;}
      else UG_THROW("Grid Level Type not in ['top' | 'surf'].");
    }
 
    int level() const {return m_level;}
 
    ViewType type() const {return m_type;}
 
    bool ghosts() const {return m_bWithGhosts;}
 
    bool top() const {return level() == TOP;}
 
    bool is_level() const {return type() == LEVEL;}
 
    bool is_surface() const {return type() == SURFACE;}
 
    bool operator==(const GridLevel& rhs) const {
      return (this->level() == rhs.level() && this->type() == rhs.type()
          && this->ghosts() == rhs.ghosts());
    }
 
    bool operator!=(const GridLevel& rhs) const {
      return !(this->operator==(rhs));
    }
 
    bool operator<(const GridLevel& rhs) const
    {
      if(this->type() != rhs.type()) return this->type() < rhs.type();
      if(this->ghosts() != rhs.ghosts()) return !this->ghosts();
      if(this->level() == rhs.level()) return false;
      if(this->level() == TOP) return false;
      if(rhs.level() == TOP) return true;
      return this->level() < rhs.level();
    }
 
    bool operator>(const GridLevel& rhs) const
    {
      if(this->type() != rhs.type()) return this->type() > rhs.type();
      if(this->ghosts() != rhs.ghosts()) return this->ghosts();
      if(this->level() == rhs.level()) return false;
      if(this->level() == TOP) return true;
      if(rhs.level() == TOP) return false;
      return this->level() > rhs.level();
    }
 
    bool operator<=(const GridLevel& rhs) const
    {
      return (*this < rhs || *this == rhs);
    }
 
    bool operator>=(const GridLevel& rhs) const
    {
      return (*this > rhs || *this == rhs);
    }
 
  protected:
    int m_level; 
    ViewType m_type;   
    bool m_bWithGhosts; 
};
 
std::ostream& operator<<(std::ostream& out, const GridLevel& v);
 
std::string GridLevelAppendix(const GridLevel& gl, int minfill = 2);
 
} // end namespace ug
 
#endif /* __H__UG__LIB_GRID__TOOLS__GRID_LEVEL__ */