Arcane::CartesianPatch Class Reference

AMR Patch of a Cartesian mesh. More...

#include <arcane/cartesianmesh/CartesianPatch.h>

Public Member Functions
	CartesianPatch ()=default
	Null patch.
	CartesianPatch (ICartesianMeshPatch *patch_interface)
	Null patch.
CartesianPatch &	operator= (const CartesianPatch &)=default
CartesianPatch &	operator= (ICartesianMeshPatch *patch_interface)
CellGroup	cells () const
	Cell group of the patch (including overlap cells).
CellGroup	inPatchCells () const
	Cell group of the patch (excluding overlap cells).
CellGroup	overlapCells () const
	Overlap cell group of the patch.
Integer	index () const
	Index of the patch in the patch array.
Integer	level () const
	Patch level.
CellDirectionMng &	cellDirection (eMeshDirection dir)
	List of cells in direction dir.
CellDirectionMng &	cellDirection (Integer idir)
	List of cells in direction dir (0, 1 or 2).
FaceDirectionMng &	faceDirection (eMeshDirection dir)
	List of faces in direction dir.
FaceDirectionMng &	faceDirection (Integer idir)
	List of faces in direction dir (0, 1 or 2).
NodeDirectionMng &	nodeDirection (eMeshDirection dir)
	List of nodes in direction dir.
NodeDirectionMng &	nodeDirection (Integer idir)
	List of nodes in direction dir (0, 1 or 2).
void	checkValid () const
	Performs checks on the instance validity.
AMRPatchPosition	position () const
	Method to retrieve the patch position in the Cartesian mesh.
bool	isNull () const
	Indicates if the patch is null.
ICartesianMeshPatch *	patchInterface () const
	Interface associated with the patch (for compatibility with existing code).

Detailed Description

AMR Patch of a Cartesian mesh.

Definition at line 33 of file CartesianPatch.h.

Constructor & Destructor Documentation

CartesianPatch()

Arcane::CartesianPatch::CartesianPatch ( ICartesianMeshPatch * patch_interface )

inlineexplicit

Null patch.

Definition at line 41 of file CartesianPatch.h.

Member Function Documentation

cellDirection() [1/2]

CellDirectionMng & Arcane::CartesianPatch::cellDirection ( eMeshDirection dir )

inline

List of cells in direction dir.

Definition at line 86 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

cellDirection() [2/2]

CellDirectionMng & Arcane::CartesianPatch::cellDirection ( Integer idir )

inline

List of cells in direction dir (0, 1 or 2).

Definition at line 93 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

cells()

CellGroup Arcane::CartesianPatch::cells

(

)

const

Cell group of the patch (including overlap cells).

Definition at line 27 of file CartesianPatch.cc.

References ARCANE_CHECK_POINTER.

checkValid()

void Arcane::CartesianPatch::checkValid ( ) const

inline

Performs checks on the instance validity.

Definition at line 128 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

faceDirection() [1/2]

FaceDirectionMng & Arcane::CartesianPatch::faceDirection ( eMeshDirection dir )

inline

List of faces in direction dir.

Definition at line 100 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

faceDirection() [2/2]

FaceDirectionMng & Arcane::CartesianPatch::faceDirection ( Integer idir )

inline

List of faces in direction dir (0, 1 or 2).

Definition at line 107 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

index()

Integer Arcane::CartesianPatch::index

(

)

const

Index of the patch in the patch array.

Definition at line 47 of file CartesianPatch.cc.

References ARCANE_CHECK_POINTER.

Referenced by overlapCells().

inPatchCells()

CellGroup Arcane::CartesianPatch::inPatchCells

(

)

const

Cell group of the patch (excluding overlap cells).

Valid only with AMR type 3 (PatchCartesianMeshOnly).

Definition at line 37 of file CartesianPatch.cc.

References ARCANE_CHECK_POINTER.

isNull()

bool Arcane::CartesianPatch::isNull ( ) const

inline

Indicates if the patch is null.

Definition at line 147 of file CartesianPatch.h.

level()

Integer Arcane::CartesianPatch::level ( ) const

inline

Patch level.

Valid only with AMR type 3 (PatchCartesianMeshOnly).

Definition at line 79 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

nodeDirection() [1/2]

NodeDirectionMng & Arcane::CartesianPatch::nodeDirection ( eMeshDirection dir )

inline

List of nodes in direction dir.

Definition at line 114 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

nodeDirection() [2/2]

NodeDirectionMng & Arcane::CartesianPatch::nodeDirection ( Integer idir )

inline

List of nodes in direction dir (0, 1 or 2).

Definition at line 121 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

operator=()

CartesianPatch & Arcane::CartesianPatch::operator= ( ICartesianMeshPatch * patch_interface )

inline

Definition at line 46 of file CartesianPatch.h.

overlapCells()

CellGroup Arcane::CartesianPatch::overlapCells

(

)

const

Overlap cell group of the patch.

Valid only with AMR type 3 (PatchCartesianMeshOnly).

References index().

patchInterface()

ICartesianMeshPatch * Arcane::CartesianPatch::patchInterface ( ) const

inline

Interface associated with the patch (for compatibility with existing code).

Definition at line 150 of file CartesianPatch.h.

position()

AMRPatchPosition Arcane::CartesianPatch::position ( ) const

inline

Method to retrieve the patch position in the Cartesian mesh.

Returns

A copy of the position.

Definition at line 140 of file CartesianPatch.h.

References ARCANE_CHECK_POINTER.

---

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

• CartesianPatch.h
• CartesianPatch.cc