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:

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
	The face topology (boundary, conforming, or nonconforming).
struct {
ElementLocation   location
ElementConformity   conformity
int   index
int   local_face_id
int   orientation
}	element [2]
	Information about the adjacent elements.
FaceInfoTag	tag
	Detailed face information (see FaceInfoTag).
int	ncface
	If the face is nonconforming, the index of the NC face. -1 otherwise.
const DenseMatrix *	point_matrix
	The point matrix for nonconforming faces.

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

IsConforming()

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

inline

Return true if the face is a conforming face.

Definition at line 2165 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 2138 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 2123 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 2182 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 2171 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 2151 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 2130 of file mesh.hpp.

operator Mesh::FaceInfo()

mfem::Mesh::FaceInformation::operator Mesh::FaceInfo

(

)

const

cast operator from FaceInformation to FaceInfo.

Definition at line 1490 of file mesh.cpp.

Member Data Documentation

conformity

ElementConformity mfem::Mesh::FaceInformation::conformity

Definition at line 2106 of file mesh.hpp.

[struct]

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

Information about the adjacent elements.

index

int mfem::Mesh::FaceInformation::index

Definition at line 2107 of file mesh.hpp.

local_face_id

int mfem::Mesh::FaceInformation::local_face_id

Definition at line 2108 of file mesh.hpp.

location

ElementLocation mfem::Mesh::FaceInformation::location

Definition at line 2105 of file mesh.hpp.

ncface

int mfem::Mesh::FaceInformation::ncface

If the face is nonconforming, the index of the NC face. -1 otherwise.

Definition at line 2116 of file mesh.hpp.

orientation

int mfem::Mesh::FaceInformation::orientation

Definition at line 2109 of file mesh.hpp.

point_matrix

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

The point matrix for nonconforming faces.

Definition at line 2119 of file mesh.hpp.

tag

FaceInfoTag mfem::Mesh::FaceInformation::tag

Detailed face information (see FaceInfoTag).

Definition at line 2113 of file mesh.hpp.

topology

FaceTopology mfem::Mesh::FaceInformation::topology

The face topology (boundary, conforming, or nonconforming).

Definition at line 2100 of file mesh.hpp.

---

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

• mesh/mesh.hpp
• mesh/mesh.cpp