local_finite_element_id.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_SHAPE_FUNCTION_SET__LOCAL_FINITE_ELEMENT_ID__
#define __H__UG__LIB_DISC__LOCAL_SHAPE_FUNCTION_SET__LOCAL_FINITE_ELEMENT_ID__
 
#include <sstream>
 
namespace ug{
 
 
// Doxygen group
 
 
 
 
class LFEID
{
  public:
    enum SpaceType
    {
      NONE = -1,
      LAGRANGE = 0,
      CROUZEIX_RAVIART,
      PIECEWISE_CONSTANT,
      DG,
      MINI,
      NEDELEC,
      USER_DEFINED,
      NUM_SPACE_TYPES
    };
 
    enum {ADAPTIV = -1, INVALID = -10};
 
  public:
    LFEID() : m_type(NONE), m_dim(-1), m_order(INVALID) {}
 
    LFEID(SpaceType type, int dim, int order)
      : m_type(type), m_dim(dim), m_order(order) {}
 
    int order() const {return m_order;}
 
    int dim() const {return m_dim;}
 
    SpaceType type() const {return m_type;}
 
    bool operator==(const LFEID& v) const
    {
      return (m_type == v.m_type && m_dim==v.m_dim && m_order==v.m_order);
    }
 
    bool operator!=(const LFEID& v) const {return !((*this)==v);}
 
 
    bool operator<(const LFEID& v) const
    {
      if(m_type != v.m_type) return m_type < v.m_type;
      else if(m_dim != v.m_dim) return m_dim < v.m_dim;
      else return m_order < v.m_order;
    }
 
    bool operator>(const LFEID& v) const
    {
      if(m_type != v.m_type) return m_type > v.m_type;
      else if(m_dim != v.m_dim) return m_dim > v.m_dim;
      else return m_order > v.m_order;
    }
 
    bool operator<=(const LFEID& v) const
    {
      return (*this < v || *this == v);
    }
 
    bool operator>=(const LFEID& v) const
    {
      return (*this > v || *this == v);
    }
 
    friend std::ostream& operator<<(std::ostream& out,  const LFEID& v);
 
  private:
    SpaceType m_type;
 
    int m_dim;
 
    int m_order;
};
 
std::ostream& operator<<(std::ostream& out, const LFEID& v);
 
LFEID ConvertStringToLFEID(const char* type, int dim, int order);
 
LFEID ConvertStringToLFEID(const char* type, int dim);
 
 
} // end namespace ug
 
#endif /* __H__UG__LIB_DISC__LOCAL_SHAPE_FUNCTION_SET__LOCAL_FINITE_ELEMENT_ID__ */