function_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_DISC__COMMON__FUNCTION_GROUP__
#define __H__UG__LIB_DISC__COMMON__FUNCTION_GROUP__
 
#include <vector>
#include <string>
 
#include "common/common.h"
#include "lib_disc/local_finite_element/local_finite_element_id.h"
#include "lib_disc/dof_manager/function_pattern.h"
 
namespace ug{
 
class FunctionGroup
{
  public:
    FunctionGroup();
 
    FunctionGroup(ConstSmartPtr<FunctionPattern> spFuncPattern);
 
    FunctionGroup(ConstSmartPtr<FunctionPattern> spFuncPattern, const char* name);
 
    FunctionGroup(ConstSmartPtr<FunctionPattern> spFuncPattern, const std::string& name);
 
    FunctionGroup(ConstSmartPtr<FunctionPattern> spFuncPattern, const std::vector<std::string>& vName);
 
    void set_function_pattern(ConstSmartPtr<FunctionPattern> spFuncPattern);
 
    ConstSmartPtr<FunctionPattern> function_pattern() const
      {return m_spFunctionPattern;}
 
    void add(size_t fct);
 
    void add(const char* name);
 
    void add(const std::string& name);
 
    void add(const std::vector<std::string>& name);
 
    void add(const FunctionGroup& fctGroup);
 
    void add_all();
 
    void remove(size_t fct);
 
    void remove(const char* name);
 
    void remove(const std::string& name);
 
    void remove(const std::vector<std::string>& vName);
 
    void clear() {m_vFunction.clear();}
 
    void sort();
 
    bool empty() const {return m_vFunction.empty();}
 
    size_t size() const {return m_vFunction.size();}
 
    const char* name(size_t i) const;
 
    std::string names() const;
 
    size_t operator[](size_t i) const {return unique_id(i);}
 
    size_t unique_id(size_t i) const
    {
      UG_ASSERT(i < size(), "Invalid function access");
      return m_vFunction[i];
    }
 
 
    int dim(size_t i) const;
 
 
    int dim() const;
 
    LFEID local_finite_element_id(size_t i) const;
    LFEID lfeid(size_t i) const;
 
    bool contains(size_t uniqueID) const;
 
    bool contains(const FunctionGroup& fctGroup) const;
 
    size_t local_index(size_t uniqueID) const;
 
  protected:
    bool is_init() const {return m_spFunctionPattern.valid();}
 
  protected:
    ConstSmartPtr<FunctionPattern> m_spFunctionPattern;
 
    std::vector<size_t> m_vFunction;
};
 
 
class FunctionIndexMapping
{
  public:
    void clear() {m_vMapping.clear();}
 
    void push_back(size_t indexTo){m_vMapping.push_back(indexTo);}
 
    size_t num_fct() const {return m_vMapping.size();}
 
    size_t operator[](size_t i) const
    {
      UG_ASSERT(i < num_fct(), "Invalid index.\n");
      return m_vMapping[i];
    }
 
  protected:
    std::vector<size_t> m_vMapping;
};
 
 
inline
std::ostream& operator<< (std::ostream& outStream, const ug::FunctionIndexMapping& map)
{
  outStream << '[';
  for(size_t i = 0; i < map.num_fct(); ++i)
  {
    outStream << map[i];
    if(i !=  map.num_fct()-1) outStream << ',';
  }
  outStream << ']';
  return outStream;
}
 
inline
std::ostream& operator<< (std::ostream& outStream, const ug::FunctionGroup& grp)
{
  outStream << '[';
  for(size_t i = 0; i < grp.size(); ++i)
  {
    outStream << grp[i];
    if(i !=  grp.size()-1) outStream << ',';
  }
  outStream << ']';
  return outStream;
}
 
} // end namespace ug
 
#endif /*__H__UG__LIB_DISC__COMMON__FUNCTION_GROUP__ */