subset_group.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-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__SUBSET_GROUP__
#define __H__UG__LIB_GRID__SUBSET_GROUP__
 
#include <vector>
#include <string>
#include "lib_grid/tools/subset_handler_interface.h"
 
namespace ug{
 
 
class SubsetGroup
{
  public:
    SubsetGroup();
 
    SubsetGroup(ConstSmartPtr<ISubsetHandler> sh);
 
    SubsetGroup(ConstSmartPtr<ISubsetHandler> sh, const char* names);
 
    SubsetGroup(ConstSmartPtr<ISubsetHandler> sh, const std::string& names);
 
    SubsetGroup(ConstSmartPtr<ISubsetHandler> sh, const std::vector<std::string>& vName);
 
    void set_subset_handler(ConstSmartPtr<ISubsetHandler> sh) {m_pSH = sh; clear();}
 
    ConstSmartPtr<ISubsetHandler> subset_handler() const {return m_pSH;}
 
    void add(int si);
 
    void add(const char* name);
 
    void add(const std::string& name);
 
 
    void add(const std::vector<std::string>& vName);
 
    void add(const SubsetGroup& ssGroup);
 
    void add_all();
 
    void remove(int si);
 
    void remove(const char* name);
 
    void remove(const std::string& name);
 
 
    void remove(const std::vector<std::string>& vName);
 
    void remove(const SubsetGroup& ssGroup);
 
    void clear() {m_vSubset.clear();}
 
    bool empty() const {return m_vSubset.empty();}
 
    inline size_t size() const
    {
      if (!m_pSH.valid()) return 0;
      return m_vSubset.size();
    }
 
    inline int operator[](size_t i) const
    {
      UG_ASSERT(is_init(), "No SubsetHandler set.");
      UG_ASSERT(i < size(), "requested subset does not exist.");
      return m_vSubset[i];
    }
    
    inline const std::vector<int>& index_vector() const
    {
      return m_vSubset;
    }
 
    const char* name(size_t i) const;
 
    bool regular_grid(size_t i) const;
 
 
    int dim(size_t i) const;
 
 
    int get_highest_subset_dimension() const;
 
    bool contains(int si) const;
 
    bool contains(const char* name) const;
 
  protected:
  // returns if SubsetGroup is ready for use
    bool is_init() const {return m_pSH.valid();}
 
  protected:
    ConstSmartPtr<ISubsetHandler> m_pSH; 
    std::vector<int> m_vSubset; 
};
 
bool SameDimensionsInAllSubsets(const SubsetGroup& subsetGroup);
 
void RemoveLowerDimSubsets(SubsetGroup& subsetGroup);
 
} // end namespace ug
 
#endif /*__H__UG__LIB_GRID__SUBSET_GROUP__ */