Arcane::FaceDirectionMng Class Reference

Info on the faces of a specific direction X, Y, or Z of a structured mesh. More...

#include <arcane/cartesianmesh/FaceDirectionMng.h>

Classes
class	Impl

Public Member Functions
	FaceDirectionMng ()
	Creates an empty instance.
DirFace	face (Face f) const
	Direction face corresponding to face f.
DirFace	face (FaceLocalId f) const
	Direction face corresponding to face f.
__host__ __device__ DirFaceLocalId	dirFaceId (FaceLocalId f) const
	Direction face corresponding to face f.
FaceGroup	allFaces () const
	Group of all faces in the direction.
FaceGroup	overlapFaces () const
	Group of all overlap faces in the direction.
FaceGroup	inPatchFaces () const
	Group of all faces within the patch in the direction.
FaceGroup	innerFaces () const
	Group of all internal faces in the direction.
FaceGroup	outerFaces () const
	Group of all external faces in the direction.
DirFace	operator[] (Face f) const
	Direction face corresponding to face f.
DirFace	operator[] (FaceLocalId f) const
	Direction face corresponding to face f.
DirFace	operator[] (FaceEnumerator iface) const
	Direction face corresponding to the face iterator iface.
eMeshDirection	direction () const
	Direction value.

Detailed Description

Info on the faces of a specific direction X, Y, or Z of a structured mesh.

Definition at line 114 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

Constructor & Destructor Documentation

FaceDirectionMng()

Arcane::FaceDirectionMng::FaceDirectionMng

(

)

Creates an empty instance.

The instance is not valid until _internalInit() has been called.

Definition at line 63 of file FaceDirectionMng.cc.

References Arcane::MD_DirInvalid.

Member Function Documentation

allFaces()

FaceGroup Arcane::FaceDirectionMng::allFaces

(

)

const

Group of all faces in the direction.

Definition at line 513 of file FaceDirectionMng.cc.

direction()

eMeshDirection Arcane::FaceDirectionMng::direction ( ) const

inline

Direction value.

Definition at line 230 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

dirFaceId()

__host__ __device__ DirFaceLocalId Arcane::FaceDirectionMng::dirFaceId ( FaceLocalId f ) const

inline

Direction face corresponding to face f.

Definition at line 147 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

face() [1/2]

DirFace Arcane::FaceDirectionMng::face ( Face f ) const

inline

Direction face corresponding to face f.

Definition at line 136 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

References Arcane::Item::localId().

face() [2/2]

DirFace Arcane::FaceDirectionMng::face ( FaceLocalId f ) const

inline

Direction face corresponding to face f.

Definition at line 141 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

innerFaces()

FaceGroup Arcane::FaceDirectionMng::innerFaces

(

)

const

Group of all internal faces in the direction.

A face is considered internal if its cell in front and behind is not null and is not an overlap cell.

Definition at line 540 of file FaceDirectionMng.cc.

inPatchFaces()

FaceGroup Arcane::FaceDirectionMng::inPatchFaces

(

)

const

Group of all faces within the patch in the direction.

These are all faces that do not have two overlap cells. (innerFaces() + outerFaces() or simply !overlapFaces())

Warning

Faces at the domain boundary (thus having only one "outer" cell) are included in this group. Therefore, one must not assume that there are two cells around every face in this group (for that, one must stick with the innerFaces() group).

Definition at line 531 of file FaceDirectionMng.cc.

operator[]() [1/3]

DirFace Arcane::FaceDirectionMng::operator[] ( Face f ) const

inline

Direction face corresponding to face f.

Definition at line 212 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

References Arcane::Item::localId().

operator[]() [2/3]

DirFace Arcane::FaceDirectionMng::operator[] ( FaceEnumerator iface ) const

inline

Direction face corresponding to the face iterator iface.

Definition at line 224 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

References Arcane::ItemEnumeratorBase::itemLocalId().

operator[]() [3/3]

DirFace Arcane::FaceDirectionMng::operator[] ( FaceLocalId f ) const

inline

Direction face corresponding to face f.

Definition at line 218 of file src/arcane/cartesianmesh/FaceDirectionMng.h.

outerFaces()

FaceGroup Arcane::FaceDirectionMng::outerFaces

(

)

const

Group of all external faces in the direction.

A face is considered external if its cell in front or behind is an overlap cell or is null (if at the domain boundary or if there are no layers of overlap cells).

Note

Faces between patches are not duplicated. Therefore, some faces in this group may also be in an outerFaces() of another patch.

Definition at line 549 of file FaceDirectionMng.cc.

overlapFaces()

FaceGroup Arcane::FaceDirectionMng::overlapFaces

(

)

const

Group of all overlap faces in the direction.

These are all faces that have two overlap cells around them.

0 1 2 3 4 ┌───┬──┬──┬──┬──┐ │ │ │ │ │ │ │ ├──┼──┼──┼──┤ │ │ │ │ │ │ └───┴──┴──┴──┴──┘

0 : level -1 1 and 2 : Overlap cells (overlapCells) 3 : Outer cells (outerCells) 4 : Inner cells (innerCells)

The layer of overlap cells refers to the layer of cells of the same level around the patch. These cells may belong to one or more patches.

Definition at line 522 of file FaceDirectionMng.cc.

---

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

• src/arcane/cartesianmesh/FaceDirectionMng.h
• FaceDirectionMng.cc