MFEM  v4.5.1
Finite element discretization library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | Public Attributes | List of all members
mfem::Mesh::FaceInformation Struct Reference

This structure is used as a human readable output format that decipheres the information contained in Mesh::FaceInfo when using the Mesh::GetFaceInformation() method. More...

#include <mesh.hpp>

Collaboration diagram for mfem::Mesh::FaceInformation:
[legend]

Public Member Functions

bool IsLocal () const
 Return true if the face is a local interior face which is NOT a master nonconforming face. More...
 
bool IsShared () const
 Return true if the face is a shared interior face which is NOT a master nonconforming face. More...
 
bool IsInterior () const
 return true if the face is an interior face to the computation domain, either a local or shared interior face (not a boundary face) which is NOT a master nonconforming face. More...
 
bool IsBoundary () const
 Return true if the face is a boundary face. More...
 
bool IsOfFaceType (FaceType type) const
 Return true if the face is of the same type as type. More...
 
bool IsConforming () const
 Return true if the face is a conforming face. More...
 
bool IsNonconformingFine () const
 Return true if the face is a nonconforming fine face. More...
 
bool IsNonconformingCoarse () const
 Return true if the face is a nonconforming coarse face. More...
 
 operator Mesh::FaceInfo () const
 cast operator from FaceInformation to FaceInfo. More...
 

Public Attributes

FaceTopology topology
 
struct {
   ElementLocation   location
 
   ElementConformity   conformity
 
   int   index
 
   int   local_face_id
 
   int   orientation
 
element [2]
 
FaceInfoTag tag
 
int ncface
 
const DenseMatrixpoint_matrix
 

Detailed Description

This structure is used as a human readable output format that decipheres the information contained in Mesh::FaceInfo when using the Mesh::GetFaceInformation() method.

The element indices in this structure don't need further processing, contrary to the ones obtained through Mesh::GetFacesElements and can directly be used, e.g., Elem1 and Elem2 indices. Likewise the orientations for Elem1 and Elem2 already take into account special cases and can be used as is.

Definition at line 1356 of file mesh.hpp.

Member Function Documentation

bool mfem::Mesh::FaceInformation::IsBoundary ( ) const
inline

Return true if the face is a boundary face.

Definition at line 1398 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsConforming ( ) const
inline

Return true if the face is a conforming face.

Definition at line 1418 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsInterior ( ) const
inline

return true if the face is an interior face to the computation domain, either a local or shared interior face (not a boundary face) which is NOT a master nonconforming face.

Definition at line 1391 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsLocal ( ) const
inline

Return true if the face is a local interior face which is NOT a master nonconforming face.

Definition at line 1375 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsNonconformingCoarse ( ) const
inline

Return true if the face is a nonconforming coarse face.

Note that ghost nonconforming master faces cannot be clearly identified as such with the currently available information, so this method will return false for such faces.

Definition at line 1435 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsNonconformingFine ( ) const
inline

Return true if the face is a nonconforming fine face.

Definition at line 1424 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsOfFaceType ( FaceType  type) const
inline

Return true if the face is of the same type as type.

Definition at line 1404 of file mesh.hpp.

bool mfem::Mesh::FaceInformation::IsShared ( ) const
inline

Return true if the face is a shared interior face which is NOT a master nonconforming face.

Definition at line 1382 of file mesh.hpp.

mfem::Mesh::FaceInformation::operator Mesh::FaceInfo ( ) const

cast operator from FaceInformation to FaceInfo.

Definition at line 1253 of file mesh.cpp.

Member Data Documentation

ElementConformity mfem::Mesh::FaceInformation::conformity

Definition at line 1363 of file mesh.hpp.

struct { ... } mfem::Mesh::FaceInformation::element[2]
int mfem::Mesh::FaceInformation::index

Definition at line 1364 of file mesh.hpp.

int mfem::Mesh::FaceInformation::local_face_id

Definition at line 1365 of file mesh.hpp.

ElementLocation mfem::Mesh::FaceInformation::location

Definition at line 1362 of file mesh.hpp.

int mfem::Mesh::FaceInformation::ncface

Definition at line 1370 of file mesh.hpp.

int mfem::Mesh::FaceInformation::orientation

Definition at line 1366 of file mesh.hpp.

const DenseMatrix* mfem::Mesh::FaceInformation::point_matrix

Definition at line 1371 of file mesh.hpp.

FaceInfoTag mfem::Mesh::FaceInformation::tag

Definition at line 1369 of file mesh.hpp.

FaceTopology mfem::Mesh::FaceInformation::topology

Definition at line 1358 of file mesh.hpp.


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