ug4
ug::LFEID Class Reference

Identifier for Local Finite Elements. More...

#include <local_finite_element_id.h>

Public Types

enum  { ADAPTIV = -1 , INVALID = -10 }
 special possibilities for order More...
 
enum  SpaceType {
  NONE = -1 , LAGRANGE = 0 , CROUZEIX_RAVIART , PIECEWISE_CONSTANT ,
  DG , MINI , NEDELEC , USER_DEFINED ,
  NUM_SPACE_TYPES
}
 Space Type. More...
 

Public Member Functions

int dim () const
 returns the space dimension of the local finite element More...
 
 LFEID ()
 default constructor More...
 
 LFEID (SpaceType type, int dim, int order)
 constructor with values More...
 
bool operator!= (const LFEID &v) const
 inequality check More...
 
bool operator< (const LFEID &v) const
 operator < More...
 
bool operator<= (const LFEID &v) const
 operator <= More...
 
bool operator== (const LFEID &v) const
 equality check More...
 
bool operator> (const LFEID &v) const
 operator > More...
 
bool operator>= (const LFEID &v) const
 operator >= More...
 
int order () const
 returns the order of the local finite element More...
 
SpaceType type () const
 returns the type of the local finite element More...
 

Private Attributes

int m_dim
 dimension More...
 
int m_order
 Order. More...
 
SpaceType m_type
 Space type. More...
 

Friends

std::ostream & operator<< (std::ostream &out, const LFEID &v)
 writes the Identifier to the output stream More...
 

Detailed Description

Identifier for Local Finite Elements.

This Class is used to distinguish between different local finite elements (lfe). Each lfe has a unique Space Type (e.g. Lagrange, DG) and the order of trial functions. It the function space is p-adaptive, the enum ADAPTIVE is set as order.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

special possibilities for order

Enumerator
ADAPTIV 
INVALID 

◆ SpaceType

Space Type.

Enumerator
NONE 
LAGRANGE 
CROUZEIX_RAVIART 
PIECEWISE_CONSTANT 
DG 
MINI 
NEDELEC 
USER_DEFINED 
NUM_SPACE_TYPES 

Constructor & Destructor Documentation

◆ LFEID() [1/2]

ug::LFEID::LFEID ( )
inline

default constructor

◆ LFEID() [2/2]

ug::LFEID::LFEID ( SpaceType  type,
int  dim,
int  order 
)
inline

constructor with values

Member Function Documentation

◆ dim()

◆ operator!=()

bool ug::LFEID::operator!= ( const LFEID v) const
inline

inequality check

◆ operator<()

bool ug::LFEID::operator< ( const LFEID v) const
inline

operator <

returns comparison which set id is regarded lesser The Local Finite Elements are ordered by type first, then by dimension and then by increasing order.

References m_dim, m_order, and m_type.

◆ operator<=()

bool ug::LFEID::operator<= ( const LFEID v) const
inline

operator <=

◆ operator==()

bool ug::LFEID::operator== ( const LFEID v) const
inline

equality check

References m_dim, m_order, and m_type.

◆ operator>()

bool ug::LFEID::operator> ( const LFEID v) const
inline

operator >

References m_dim, m_order, and m_type.

◆ operator>=()

bool ug::LFEID::operator>= ( const LFEID v) const
inline

operator >=

◆ order()

◆ type()

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  out,
const LFEID v 
)
friend

writes the Identifier to the output stream

Member Data Documentation

◆ m_dim

int ug::LFEID::m_dim
private

dimension

Referenced by dim(), operator<(), operator==(), and operator>().

◆ m_order

int ug::LFEID::m_order
private

Order.

Referenced by operator<(), operator==(), operator>(), and order().

◆ m_type

SpaceType ug::LFEID::m_type
private

Space type.

Referenced by operator<(), operator==(), operator>(), and type().


The documentation for this class was generated from the following file: