dune-alugrid  3.0.0
Public Types | Public Member Functions | Protected Member Functions | List of all members
Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm > Class Template Reference

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

Inheritance diagram for Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >:
Inheritance graph

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 (const bool levelIntersection=false)
 constructor creating empty face info More...
 
void updateFaceInfo (const GEOFaceType &face, int innerLevel, int innerTwist)
 
 ALU3dGridFaceInfo (const GEOFaceType &face, int innerTwist)
 
 ALU3dGridFaceInfo (const ALU3dGridFaceInfo &orig)
 
 ~ALU3dGridFaceInfo ()
 Destructor. More...
 
bool innerBoundary () const
 returns true if inside is a ghost entity More...
 
bool outerBoundary () const
 
bool boundary () const
 returns true if the face lies on the domain boundary More...
 
bool neighbor () const
 returns true if outside is something meaningfull More...
 
bool ghostBoundary () const
 
const GEOFaceTypeface () const
 Returns the ALU3dGrid face. More...
 
const GEOElementTypeinnerEntity () const
 Returns the inner element at that face. More...
 
const GEOElementTypeouterEntity () const
 
const BNDFaceTypeinnerFace () const
 
const BNDFaceTypeboundaryFace () const
 
int innerTwist () const
 Twist of the face seen from the inner element. More...
 
int outerTwist () const
 Twist of the face seen from the outer element. More...
 
int duneTwist (const int faceIdx, const int aluTwist) const
 Twist of the face seen from the inner element. More...
 
int innerALUFaceIndex () const
 Local number of the face in inner element (ALU3dGrid reference element) More...
 
int outerALUFaceIndex () const
 Local number of the face in outer element (ALU3dGrid reference element) More...
 
int outsideLevel () const
 
int segmentIndex () const
 return boundary segment index if intersection is with domain boundary More...
 
int boundaryId () const
 return boundary id if intersection is with domain boundary More...
 
ConformanceState conformanceState () const
 Description of conformance on the face. More...
 
bool parallel () const
 return whether we are in a parallel environment or not More...
 
bool conformingRefinement () const
 return true if conforming refinement is enabled More...
 
bool ghostCellsEnabled () const
 return true if ghost cells are enabled More...
 
void setFlags (const bool conformingRefinement, const bool ghostCellsEnabled)
 reset flags More...
 

Protected Member Functions

bool isElementLike () const
 returns true if outerEntity casts into a helement More...
 

Member Typedef Documentation

◆ BNDFaceType

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
typedef ImplTraits::BNDFaceType Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::BNDFaceType

◆ GEOElementType

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
typedef ImplTraits::GEOElementType Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::GEOElementType

◆ GEOFaceType

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
typedef ImplTraits::GEOFaceType Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::GEOFaceType

◆ GEOPeriodicType

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
typedef ImplTraits::GEOPeriodicType Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::GEOPeriodicType

◆ GhostPairType

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
typedef ImplTraits::GhostPairType Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::GhostPairType

◆ IMPLElementType

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
typedef ImplTraits::IMPLElementType Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::IMPLElementType

Member Enumeration Documentation

◆ ConformanceState

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

Constructor & Destructor Documentation

◆ ALU3dGridFaceInfo() [1/3]

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::ALU3dGridFaceInfo ( const bool  levelIntersection = false)
inline

constructor creating empty face info

◆ ALU3dGridFaceInfo() [2/3]

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

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 Copy constructor

◆ ALU3dGridFaceInfo() [3/3]

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::ALU3dGridFaceInfo ( const ALU3dGridFaceInfo< dim, dimworld, type, Comm > &  orig)

◆ ~ALU3dGridFaceInfo()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::~ALU3dGridFaceInfo ( )
inline

Destructor.

Member Function Documentation

◆ boundary()

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

returns true if the face lies on the domain boundary

◆ boundaryFace()

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

Returns the boundary (outer) element at that face

Note
This function is only meaningful at a boundary

◆ boundaryId()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
int Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::boundaryId ( ) const
inline

return boundary id if intersection is with domain boundary

◆ conformanceState()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
ALU3dGridFaceInfo< dim, dimworld, type, Comm >::ConformanceState Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::conformanceState ( ) const
inline

Description of conformance on the face.

◆ conformingRefinement()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::conformingRefinement ( ) const
inline

return true if conforming refinement is enabled

◆ duneTwist()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
int Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::duneTwist ( const int  faceIdx,
const int  aluTwist 
) const
inline

Twist of the face seen from the inner element.

◆ face()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
const ALU3dGridFaceInfo< dim, dimworld, type, Comm >::GEOFaceType & Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::face ( ) const
inline

Returns the ALU3dGrid face.

◆ ghostBoundary()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
bool Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::ghostBoundary ( ) const
inline

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

◆ ghostCellsEnabled()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm>
bool Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::ghostCellsEnabled ( ) const
inline

return true if ghost cells are enabled

◆ innerALUFaceIndex()

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

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

◆ innerBoundary()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
bool Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::innerBoundary ( ) const
inline

returns true if inside is a ghost entity

◆ innerEntity()

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

Returns the inner element at that face.

◆ innerFace()

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

Returns the inner element at that face

Note
This function is only meaningful at a boundary

◆ innerTwist()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
int Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::innerTwist ( ) const
inline

Twist of the face seen from the inner element.

◆ isElementLike()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
bool Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::isElementLike ( ) const
inlineprotected

returns true if outerEntity casts into a helement

◆ neighbor()

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

returns true if outside is something meaningfull

◆ outerALUFaceIndex()

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

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

◆ outerBoundary()

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

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

◆ outerEntity()

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

Returns the outer element at that face

Note
This function is only meaningful in the interior

◆ outerTwist()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
int Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::outerTwist ( ) const
inline

Twist of the face seen from the outer element.

◆ outsideLevel()

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

◆ parallel()

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

return whether we are in a parallel environment or not

◆ segmentIndex()

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

return boundary segment index if intersection is with domain boundary

◆ setFlags()

template<int dim, int dimworld, ALU3dGridElementType type, class Comm >
void Dune::ALU3dGridFaceInfo< dim, dimworld, type, Comm >::setFlags ( const bool  conformingRefinement,
const bool  ghostCellsEnabled 
)
inline

reset flags

◆ updateFaceInfo()

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

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