dune-grid  2.2.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
Dune::ALU3dGridFaceInfo< type, Comm > Class Template Reference

#include <dune/grid/alugrid/3d/faceutility.hh>

Public Types

enum  ConformanceState { CONFORMING, REFINED_INNER, REFINED_OUTER, UNDEFINED }
typedef ImplTraits::GEOFaceType GEOFaceType
typedef ImplTraits::GEOElementType GEOElementType
typedef ImplTraits::GEOPeriodicType GEOPeriodicType
typedef ImplTraits::IMPLElementType IMPLElementType
typedef ImplTraits::GhostPairType GhostPairType
typedef ImplTraits::BNDFaceType BNDFaceType

Public Member Functions

 ALU3dGridFaceInfo ()
 constructor creating empty face info
void updateFaceInfo (const GEOFaceType &face, int innerLevel, int innerTwist)
 ALU3dGridFaceInfo (const GEOFaceType &face, int innerTwist)
 ALU3dGridFaceInfo (const ALU3dGridFaceInfo &orig)
 Copy constructor.
 ~ALU3dGridFaceInfo ()
 Destructor.
bool outerBoundary () const
bool boundary () const
 returns true if the face lies on the domain boundary
bool neighbor () const
 returns true if outside is something meaningfull
bool ghostBoundary () const
const GEOFaceTypeface () const
 Returns the ALU3dGrid face.
const GEOElementTypeinnerEntity () const
 Returns the inner element at that face.
const GEOElementTypeouterEntity () const
const BNDFaceTypeinnerFace () const
const BNDFaceTypeboundaryFace () const
int innerTwist () const
 Twist of the face seen from the inner element.
int outerTwist () const
 Twist of the face seen from the outer element.
int duneTwist (const int faceIdx, const int aluTwist) const
 Twist of the face seen from the inner element.
int innerALUFaceIndex () const
 Local number of the face in inner element (ALU3dGrid reference element)
int outerALUFaceIndex () const
 Local number of the face in outer element (ALU3dGrid reference element)
int outsideLevel () const
int segmentIndex () const
 return boundary segment index if intersection is with domain boundary
int boundaryId () const
 return boundary id if intersection is with domain boundary
ConformanceState conformanceState () const
 Description of conformance on the face.
bool parallel () const
 return whether we are in a parallel environment or not

Protected Member Functions

bool isElementLike () const
 returns true if outerEntity casts into a helement
bool innerBoundary () const
 returns true if inside is a ghost entity

Member Typedef Documentation

template<ALU3dGridElementType type, class Comm>
typedef ImplTraits::BNDFaceType Dune::ALU3dGridFaceInfo< type, Comm >::BNDFaceType
template<ALU3dGridElementType type, class Comm>
typedef ImplTraits::GEOElementType Dune::ALU3dGridFaceInfo< type, Comm >::GEOElementType
template<ALU3dGridElementType type, class Comm>
typedef ImplTraits::GEOFaceType Dune::ALU3dGridFaceInfo< type, Comm >::GEOFaceType
template<ALU3dGridElementType type, class Comm>
typedef ImplTraits::GEOPeriodicType Dune::ALU3dGridFaceInfo< type, Comm >::GEOPeriodicType
template<ALU3dGridElementType type, class Comm>
typedef ImplTraits::GhostPairType Dune::ALU3dGridFaceInfo< type, Comm >::GhostPairType
template<ALU3dGridElementType type, class Comm>
typedef ImplTraits::IMPLElementType Dune::ALU3dGridFaceInfo< type, Comm >::IMPLElementType

Member Enumeration Documentation

template<ALU3dGridElementType type, class Comm>
enum Dune::ALU3dGridFaceInfo::ConformanceState
Enumerator:
CONFORMING 
REFINED_INNER 
REFINED_OUTER 
UNDEFINED 

Constructor & Destructor Documentation

template<ALU3dGridElementType type, class Comm>
Dune::ALU3dGridFaceInfo< type, Comm >::ALU3dGridFaceInfo ( )

constructor creating empty face info

template<ALU3dGridElementType type, class Comm>
Dune::ALU3dGridFaceInfo< type, Comm >::ALU3dGridFaceInfo ( const GEOFaceType face,
int  innerTwist 
)

Construct a connector from a face and the twist seen from the inner element

Note
: The user is responsible for the consistency of the input data as well as for choosing the appropriate (i.e. most refined) face
template<ALU3dGridElementType type, class Comm>
Dune::ALU3dGridFaceInfo< type, Comm >::ALU3dGridFaceInfo ( const ALU3dGridFaceInfo< type, Comm > &  orig)

Copy constructor.

template<ALU3dGridElementType type, class Comm>
Dune::ALU3dGridFaceInfo< type, Comm >::~ALU3dGridFaceInfo ( )

Destructor.

Member Function Documentation

template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::boundary ( ) const

returns true if the face lies on the domain boundary

template<ALU3dGridElementType type, class Comm>
const BNDFaceType& Dune::ALU3dGridFaceInfo< type, Comm >::boundaryFace ( ) const

Returns the boundary (outer) element at that face

Note
This function is only meaningful at a boundary
template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::boundaryId ( ) const

return boundary id if intersection is with domain boundary

template<ALU3dGridElementType type, class Comm>
ConformanceState Dune::ALU3dGridFaceInfo< type, Comm >::conformanceState ( ) const
template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::duneTwist ( const int  faceIdx,
const int  aluTwist 
) const

Twist of the face seen from the inner element.

template<ALU3dGridElementType type, class Comm>
const GEOFaceType& Dune::ALU3dGridFaceInfo< type, Comm >::face ( ) const
template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::ghostBoundary ( ) const

is the neighbour element a ghost element or a ghost face in case of face true is returned

template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::innerALUFaceIndex ( ) const

Local number of the face in inner element (ALU3dGrid reference element)

template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::innerBoundary ( ) const
protected

returns true if inside is a ghost entity

template<ALU3dGridElementType type, class Comm>
const GEOElementType& Dune::ALU3dGridFaceInfo< type, Comm >::innerEntity ( ) const

Returns the inner element at that face.

template<ALU3dGridElementType type, class Comm>
const BNDFaceType& Dune::ALU3dGridFaceInfo< type, Comm >::innerFace ( ) const

Returns the inner element at that face

Note
This function is only meaningful at a boundary
template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::innerTwist ( ) const

Twist of the face seen from the inner element.

template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::isElementLike ( ) const
protected

returns true if outerEntity casts into a helement

template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::neighbor ( ) const

returns true if outside is something meaningfull

template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::outerALUFaceIndex ( ) const

Local number of the face in outer element (ALU3dGrid reference element)

template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::outerBoundary ( ) const

returns true if the face lies on the domain boundary and is not a periodic boundary

template<ALU3dGridElementType type, class Comm>
const GEOElementType& Dune::ALU3dGridFaceInfo< type, Comm >::outerEntity ( ) const

Returns the outer element at that face

Note
This function is only meaningful in the interior
template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::outerTwist ( ) const

Twist of the face seen from the outer element.

template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::outsideLevel ( ) const
template<ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< type, Comm >::parallel ( ) const
inline

return whether we are in a parallel environment or not

template<ALU3dGridElementType type, class Comm>
int Dune::ALU3dGridFaceInfo< type, Comm >::segmentIndex ( ) const

return boundary segment index if intersection is with domain boundary

template<ALU3dGridElementType type, class Comm>
void Dune::ALU3dGridFaceInfo< type, Comm >::updateFaceInfo ( const GEOFaceType face,
int  innerLevel,
int  innerTwist 
)

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