local_dof_set.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__LOCAL_FINITE_ELEMENT__LOCAL_DOF_SET__
#define __H__UG__LIB_DISC__LOCAL_FINITE_ELEMENT__LOCAL_DOF_SET__
 
#include <vector>
#include <map>
 
#include "local_finite_element_id.h"
#include "lib_disc/reference_element/reference_element_traits.h"
#include "lib_grid/grid/grid_base_objects.h"
 
namespace ug{
 
 
class LocalDoF
{
  public:
    LocalDoF() : m_dim(-1), m_id(0), m_offset(0) {}
 
 
    LocalDoF(int dim, size_t id, size_t offset)
      : m_dim(dim), m_id(id), m_offset(offset)
    {}
 
    void set(int dim, size_t id, size_t offset)
    {
      m_dim = dim; m_id = id; m_offset = offset;
    }
 
    inline int dim() const {return m_dim;}
 
    inline size_t id() const {return m_id;}
 
    inline size_t offset() const {return m_offset;}
 
    bool operator==(const LocalDoF& v) const{
      return dim() == v.dim() && id() == v.id() && offset() == v.offset();
    }
 
    bool operator!=(const LocalDoF& v) const {return !((*this)==v);}
 
  protected:
    int m_dim;
 
    size_t m_id;
 
    size_t m_offset;
};
 
std::ostream& operator<<(std::ostream& out, const LocalDoF& v);
 
class LocalDoFSet
{
  public:
    int dim() const;
 
    virtual ReferenceObjectID roid() const = 0;
 
        size_t num_dof() const {return num_sh();}
    virtual size_t num_sh() const;
 
    virtual size_t num_dof(ReferenceObjectID roid) const = 0;
 
    virtual const LocalDoF& local_dof(size_t dof) const = 0;
 
    size_t num_dof(int d, size_t id) const;
 
    bool operator==(const LocalDoFSet& v) const;
 
    bool operator!=(const LocalDoFSet& v) const {return !((*this)==v);}
 
    virtual ~LocalDoFSet() {};
};
 
template <int TDim>
class DimLocalDoFSet : public LocalDoFSet
{
  public:
    DimLocalDoFSet();
 
    virtual bool exact_position_available() const = 0;
 
 
    virtual bool position(size_t i, MathVector<TDim>& pos) const = 0;
 
    bool operator==(const DimLocalDoFSet<TDim>& v) const;
 
    bool operator!=(const DimLocalDoFSet<TDim>& v) const {return !((*this)==v);}
};
 
 
std::ostream& operator<<(std::ostream& out, const LocalDoFSet& v);
template <int dim>
std::ostream& operator<<(std::ostream& out, const DimLocalDoFSet<dim>& v);
 
class CommonLocalDoFSet
{
  public:
    enum{NOT_SPECIFIED = -1};
 
    CommonLocalDoFSet() {clear();}
 
    void clear();
 
    void add(const LocalDoFSet& set);
 
    int num_dof(ReferenceObjectID roid) const {return m_vNumDoF[roid];}
 
  protected:
    int m_vNumDoF[NUM_REFERENCE_OBJECTS];
};
 
std::ostream& operator<<(std::ostream& out, const CommonLocalDoFSet& v);
 
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__LOCAL_FINITE_ELEMENT__LOCAL_DOF_SET__ */