MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::Mesh::FaceInformation Struct Reference

This structure is used as a human readable output format that deciphers 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.
 
bool IsShared () const
 Return true if the face is a shared interior face which is NOT a master nonconforming face.
 
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.
 
bool IsBoundary () const
 Return true if the face is a boundary face.
 
bool IsOfFaceType (FaceType type) const
 Return true if the face is of the same type as type.
 
bool IsConforming () const
 Return true if the face is a conforming face.
 
bool IsNonconformingFine () const
 Return true if the face is a nonconforming fine face.
 
bool IsNonconformingCoarse () const
 Return true if the face is a nonconforming coarse face.
 
 operator Mesh::FaceInfo () const
 cast operator from FaceInformation to FaceInfo.
 

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 deciphers 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 1893 of file mesh.hpp.

Member Function Documentation

◆ IsBoundary()

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

Return true if the face is a boundary face.

Definition at line 1935 of file mesh.hpp.

◆ IsConforming()

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

Return true if the face is a conforming face.

Definition at line 1955 of file mesh.hpp.

◆ IsInterior()

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 1928 of file mesh.hpp.

◆ IsLocal()

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 1912 of file mesh.hpp.

◆ IsNonconformingCoarse()

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 1972 of file mesh.hpp.

◆ IsNonconformingFine()

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

Return true if the face is a nonconforming fine face.

Definition at line 1961 of file mesh.hpp.

◆ IsOfFaceType()

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

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

Definition at line 1941 of file mesh.hpp.

◆ IsShared()

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 1919 of file mesh.hpp.

◆ operator Mesh::FaceInfo()

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

cast operator from FaceInformation to FaceInfo.

Definition at line 1291 of file mesh.cpp.

Member Data Documentation

◆ conformity

ElementConformity mfem::Mesh::FaceInformation::conformity

Definition at line 1900 of file mesh.hpp.

◆ [struct]

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

◆ index

int mfem::Mesh::FaceInformation::index

Definition at line 1901 of file mesh.hpp.

◆ local_face_id

int mfem::Mesh::FaceInformation::local_face_id

Definition at line 1902 of file mesh.hpp.

◆ location

ElementLocation mfem::Mesh::FaceInformation::location

Definition at line 1899 of file mesh.hpp.

◆ ncface

int mfem::Mesh::FaceInformation::ncface

Definition at line 1907 of file mesh.hpp.

◆ orientation

int mfem::Mesh::FaceInformation::orientation

Definition at line 1903 of file mesh.hpp.

◆ point_matrix

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

Definition at line 1908 of file mesh.hpp.

◆ tag

FaceInfoTag mfem::Mesh::FaceInformation::tag

Definition at line 1906 of file mesh.hpp.

◆ topology

FaceTopology mfem::Mesh::FaceInformation::topology

Definition at line 1895 of file mesh.hpp.


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