Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::CartesianMeshNumberingMng Class Reference

Numbering manager interface for Cartesian mesh. More...

#include <arcane/cartesianmesh/CartesianMeshNumberingMng.h>

Public Member Functions

 CartesianMeshNumberingMng (ICartesianMesh *mesh)
void printStatus () const
 Method allowing the description of the object's state.
Int64 firstCellUniqueId (Int32 level) const
 Method allowing retrieval of the first unique ID used by the cells of a level. Calling this method with level and level+1 allows retrieval of the unique ID interval for a level.
Int64 firstNodeUniqueId (Int32 level) const
 Method allowing retrieval of the first unique ID used by the nodes of a level. Calling this method with level and level+1 allows retrieval of the unique ID interval for a level.
Int64 firstFaceUniqueId (Int32 level) const
 Method allowing retrieval of the first unique ID used by the faces of a level. Calling this method with level and level+1 allows retrieval of the unique ID interval for a level.
CartCoord globalNbCellsX (Int32 level) const
 Method allowing retrieval of the global number of cells in X for a level.
CartCoord globalNbCellsY (Int32 level) const
 Method allowing retrieval of the global number of cells in Y for a level.
CartCoord globalNbCellsZ (Int32 level) const
 Method allowing retrieval of the global number of cells in Z for a level.
CartCoord globalNbNodesX (Int32 level) const
 Method allowing retrieval of the global number of nodes in X for a level.
CartCoord globalNbNodesY (Int32 level) const
 Method allowing retrieval of the global number of nodes in Y for a level.
CartCoord globalNbNodesZ (Int32 level) const
 Method allowing retrieval of the global number of nodes in Z for a level.
CartCoord globalNbFacesX (Int32 level) const
 Method allowing retrieval of the global number of faces in X for a level.
CartCoord globalNbFacesY (Int32 level) const
 Method allowing retrieval of the global number of faces in Y for a level.
CartCoord globalNbFacesZ (Int32 level) const
 Method allowing retrieval of the global number of faces in Z for a level.
CartCoord globalNbFacesXCartesianView (Int32 level) const
 Method allowing retrieval of the size of the "Cartesian grid" view containing the faces.
CartCoord globalNbFacesYCartesianView (Int32 level) const
 Method allowing retrieval of the size of the "Cartesian grid" view containing the faces.
CartCoord globalNbFacesZCartesianView (Int32 level) const
 Method allowing retrieval of the size of the "Cartesian grid" view containing the faces.
Int64 nbCellInLevel (Int32 level) const
 Method allowing retrieval of the total number of cells in a level.
Int64 nbNodeInLevel (Int32 level) const
 Method allowing retrieval of the total number of nodes in a level.
Int64 nbFaceInLevel (Int32 level) const
 Method allowing retrieval of the total number of faces in a level.
Int32 pattern () const
 Method allowing retrieval of the refinement pattern used in each cell. For example, if the pattern is 2, each parent cell will have 2*2 child cells (2*2*2 in 3D).
Int32 cellLevel (Int64 uid) const
 Method allowing retrieval of the level of a cell given its unique ID.
Int32 nodeLevel (Int64 uid) const
 Method allowing retrieval of the level of a node given its unique ID.
Int32 faceLevel (Int64 uid) const
 Method allowing retrieval of the level of a face given its unique ID.
CartCoord offsetLevelToLevel (CartCoord coord, Int32 level_from, Int32 level_to) const
 Method allowing retrieval of the position of the first child node/cell starting from the position of the parent node/cell.
CartCoord faceOffsetLevelToLevel (CartCoord coord, Int32 level_from, Int32 level_to) const
 Method allowing retrieval of the position of the first child face starting from the position of the parent face.
CartCoord3 cellUniqueIdToCoord (Int64 uid, Int32 level) const
 Method to retrieve the coordinates of a cell using its uniqueId.
CartCoord3 cellUniqueIdToCoord (Cell cell) const
 Method to retrieve the coordinates of a cell.
CartCoord cellUniqueIdToCoordX (Int64 uid, Int32 level) const
 Method to retrieve the X coordinate of a cell using its uniqueId.
CartCoord cellUniqueIdToCoordX (Cell cell) const
 Method to retrieve the X coordinate of a cell.
CartCoord cellUniqueIdToCoordY (Int64 uid, Int32 level) const
 Method to retrieve the Y coordinate of a cell using its uniqueId.
CartCoord cellUniqueIdToCoordY (Cell cell) const
 Method to retrieve the Y coordinate of a cell.
CartCoord cellUniqueIdToCoordZ (Int64 uid, Int32 level) const
 Method to retrieve the Z coordinate of a cell using its uniqueId.
CartCoord cellUniqueIdToCoordZ (Cell cell) const
 Method to retrieve the Z coordinate of a cell.
CartCoord nodeUniqueIdToCoordX (Int64 uid, Int32 level) const
 Method to retrieve the X coordinate of a node using its uniqueId.
CartCoord nodeUniqueIdToCoordX (Node node) const
 Method to retrieve the X coordinate of a node.
CartCoord nodeUniqueIdToCoordY (Int64 uid, Int32 level) const
 Method to retrieve the Y coordinate of a node using its uniqueId.
CartCoord nodeUniqueIdToCoordY (Node node) const
 Method to retrieve the Y coordinate of a node.
CartCoord nodeUniqueIdToCoordZ (Int64 uid, Int32 level) const
 Method to retrieve the Z coordinate of a node using its uniqueId.
CartCoord nodeUniqueIdToCoordZ (Node node) const
 Method to retrieve the Z coordinate of a node.
CartCoord faceUniqueIdToCoordX (Int64 uid, Int32 level) const
 Method to retrieve the X coordinate of a face using its uniqueId.
CartCoord faceUniqueIdToCoordX (Face face) const
 Method to retrieve the X coordinate of a face.
CartCoord faceUniqueIdToCoordY (Int64 uid, Int32 level) const
 Method to retrieve the Y coordinate of a face using its uniqueId.
CartCoord faceUniqueIdToCoordY (Face face) const
 Method to retrieve the Y coordinate of a face.
CartCoord faceUniqueIdToCoordZ (Int64 uid, Int32 level) const
 Method to retrieve the Z coordinate of a face using its uniqueId.
CartCoord faceUniqueIdToCoordZ (Face face) const
 Method to retrieve the Z coordinate of a face.
Int64 cellUniqueId (CartCoord3 cell_coord, Int32 level) const
 Method to retrieve the uniqueId of a cell from its position and level.
Int64 cellUniqueId (CartCoord2 cell_coord, Int32 level) const
 Method to retrieve the uniqueId of a cell from its position and level.
Int64 nodeUniqueId (CartCoord3 node_coord, Int32 level) const
 Method to retrieve the uniqueId of a node from its position and level.
Int64 nodeUniqueId (CartCoord2 node_coord, Int32 level) const
 Method to retrieve the uniqueId of a node from its position and level.
Int64 faceUniqueId (CartCoord3 face_coord, Int32 level) const
 Method to retrieve the uniqueId of a face from its position and level.
Int64 faceUniqueId (CartCoord2 face_coord, Int32 level) const
 Method to retrieve the uniqueId of a face from its position and level.
Int32 nbNodeByCell () const
 Method to retrieve the number of nodes in a cell.
void cellNodeUniqueIds (CartCoord3 cell_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the nodes in a cell from its coordinates.
void cellNodeUniqueIds (CartCoord2 cell_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the nodes in a cell from its coordinates.
void cellNodeUniqueIds (Int64 cell_uid, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the nodes in a cell from its uniqueId.
void cellNodeUniqueIds (Cell cell, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the nodes in a cell.
Int32 nbFaceByCell () const
 Method to retrieve the number of faces in a cell.
void cellFaceUniqueIds (CartCoord3 cell_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the faces in a cell from its coordinates.
void cellFaceUniqueIds (CartCoord2 cell_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the faces of a cell from its coordinates.
void cellFaceUniqueIds (Int64 cell_uid, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the faces of a cell from its uniqueId.
void cellFaceUniqueIds (Cell cell, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the faces of a cell.
void cellUniqueIdsAroundCell (CartCoord3 cell_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around a cell.
void cellUniqueIdsAroundCell (CartCoord2 cell_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around a cell.
void cellUniqueIdsAroundCell (Int64 cell_uid, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around the cell passed as a parameter.
void cellUniqueIdsAroundCell (Cell cell, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around the cell passed as a parameter.
void cellUniqueIdsAroundNode (CartCoord3 node_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around a node.
void cellUniqueIdsAroundNode (CartCoord2 node_coord, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around a node.
void cellUniqueIdsAroundNode (Int64 node_uid, Int32 level, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around the node passed as a parameter.
void cellUniqueIdsAroundNode (Node node, ArrayView< Int64 > uid) const
 Method to retrieve the uniqueIds of the cells around the node passed as a parameter.
Int64 parentCellUniqueIdOfCell (Int64 uid, Int32 level, bool do_fatal=true) const
 Method to retrieve the uniqueId of a cell's parent.
Int64 parentCellUniqueIdOfCell (Cell cell, bool do_fatal=true) const
 Method to retrieve the uniqueId of a cell's parent.
Int64 childCellUniqueIdOfCell (Cell cell, CartCoord3 child_coord_in_parent) const
 Method to retrieve the uniqueId of a child cell of a parent cell based on the child cell's position within the parent cell.
Int64 childCellUniqueIdOfCell (Cell cell, CartCoord2 child_coord_in_parent) const
 Method to retrieve the uniqueId of a child cell of a parent cell based on the child cell's position within the parent cell.
Int64 childCellUniqueIdOfCell (Cell cell, Int32 child_index_in_parent) const
 Method to retrieve the uniqueId of a child cell of a parent cell based on the child cell's index within the parent cell.
Cell childCellOfCell (Cell cell, CartCoord3 child_coord_in_parent) const
 Method to retrieve a child cell of a parent cell based on the child cell's position within the parent cell.
Cell childCellOfCell (Cell cell, CartCoord2 child_coord_in_parent) const
 Method to retrieve a child cell of a parent cell based on the child cell's position within the parent cell.
Int64 parentNodeUniqueIdOfNode (Int64 uid, Int32 level, bool do_fatal=true) const
 Method to retrieve the uniqueId of a node's parent.
Int64 parentNodeUniqueIdOfNode (Node node, bool do_fatal=true) const
 Method to retrieve the uniqueId of a node's parent.
Int64 childNodeUniqueIdOfNode (Int64 uid, Int32 level) const
 Method to retrieve the uniqueId of a child node of a parent node.
Int64 childNodeUniqueIdOfNode (Node node) const
 Method to retrieve the uniqueId of a child node of a parent node.
Int64 parentFaceUniqueIdOfFace (Int64 uid, Int32 level, bool do_fatal=true) const
 Method to retrieve the uniqueId of a face's parent.
Int64 parentFaceUniqueIdOfFace (Face face, bool do_fatal=true) const
 Method to retrieve the uniqueId of a face's parent.
Int64 childFaceUniqueIdOfFace (Int64 uid, Int32 level, Int32 child_index_in_parent) const
 Method to retrieve the uniqueId of a child face of a parent face based on the child face's index within the parent face.
Int64 childFaceUniqueIdOfFace (Face face, Int32 child_index_in_parent) const
 Method to retrieve the uniqueId of a child face of a parent face based on the child face's index within the parent face.
ICartesianMeshNumberingMngInternal * _internalApi () const

Detailed Description

Numbering manager interface for Cartesian mesh.

In these managers, it is assumed that there is an interval of unique IDs assigned to each mesh level.

Warning
The mesh must not be renumbered if this numbering is used.

Definition at line 49 of file CartesianMeshNumberingMng.h.

Constructor & Destructor Documentation

◆ CartesianMeshNumberingMng()

Arcane::CartesianMeshNumberingMng::CartesianMeshNumberingMng ( ICartesianMesh * mesh)
explicit

Definition at line 33 of file CartesianMeshNumberingMng.cc.

Member Function Documentation

◆ _internalApi()

ICartesianMeshNumberingMngInternal * Arcane::CartesianMeshNumberingMng::_internalApi ( ) const

Definition at line 797 of file CartesianMeshNumberingMng.cc.

◆ cellFaceUniqueIds() [1/4]

void Arcane::CartesianMeshNumberingMng::cellFaceUniqueIds ( CartCoord2 cell_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the faces of a cell from its coordinates.

The order in which the uniqueIds are placed corresponds to the enumeration order of the faces of an Arcane cell. -2- ^y 3 1 | -0- ->x

Parameters
cell_coordThe position of the cell.
levelThe level of the cell (and thus of the faces).
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbFaceByCell().

Definition at line 563 of file CartesianMeshNumberingMng.cc.

◆ cellFaceUniqueIds() [2/4]

void Arcane::CartesianMeshNumberingMng::cellFaceUniqueIds ( CartCoord3 cell_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the faces in a cell from its coordinates.

The order in which the uniqueIds are placed corresponds to the enumeration order of the faces of an Arcane cell. -2- ^y 3 1 | -0- ->x

Parameters
cell_coordThe position of the cell.
levelThe level of the cell (and thus of the faces).
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbFaceByCell().

Definition at line 554 of file CartesianMeshNumberingMng.cc.

◆ cellFaceUniqueIds() [3/4]

void Arcane::CartesianMeshNumberingMng::cellFaceUniqueIds ( Cell cell,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the faces of a cell.

The order in which the uniqueIds are placed corresponds to the enumeration order of the faces of an Arcane cell. -2- ^y 3 1 | -0- ->x

Parameters
cellThe cell.
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbFaceByCell().

Definition at line 581 of file CartesianMeshNumberingMng.cc.

◆ cellFaceUniqueIds() [4/4]

void Arcane::CartesianMeshNumberingMng::cellFaceUniqueIds ( Int64 cell_uid,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the faces of a cell from its uniqueId.

The order in which the uniqueIds are placed corresponds to the enumeration order of the faces of an Arcane cell. -2- ^y 3 1 | -0- ->x

Parameters
cell_uidThe uniqueId of the cell.
levelThe level of the cell (and thus of the faces).
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbFaceByCell().

Definition at line 572 of file CartesianMeshNumberingMng.cc.

◆ cellLevel()

Int32 Arcane::CartesianMeshNumberingMng::cellLevel ( Int64 uid) const

Method allowing retrieval of the level of a cell given its unique ID.

Parameters
uidThe unique ID of the cell.
Returns
The level of the cell.

Definition at line 221 of file CartesianMeshNumberingMng.cc.

◆ cellNodeUniqueIds() [1/4]

void Arcane::CartesianMeshNumberingMng::cellNodeUniqueIds ( CartCoord2 cell_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the nodes in a cell from its coordinates.

The order in which the uniqueIds are placed corresponds to the enumeration order of the nodes of an Arcane cell. 3–2 ^y | | | 0–1 ->x

Parameters
cell_coordThe position of the cell.
levelThe level of the cell (and thus of the nodes).
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbNodeByCell().

Definition at line 518 of file CartesianMeshNumberingMng.cc.

◆ cellNodeUniqueIds() [2/4]

void Arcane::CartesianMeshNumberingMng::cellNodeUniqueIds ( CartCoord3 cell_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the nodes in a cell from its coordinates.

The order in which the uniqueIds are placed corresponds to the enumeration order of the nodes of an Arcane cell. 3–2 ^y | | | 0–1 ->x

Parameters
cell_coordThe position of the cell.
levelThe level of the cell (and thus of the nodes).
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbNodeByCell().

Definition at line 509 of file CartesianMeshNumberingMng.cc.

◆ cellNodeUniqueIds() [3/4]

void Arcane::CartesianMeshNumberingMng::cellNodeUniqueIds ( Cell cell,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the nodes in a cell.

The order in which the uniqueIds are placed corresponds to the enumeration order of the nodes of an Arcane cell. 3–2 ^y | | | 0–1 ->x

Parameters
cellThe cell.
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbNodeByCell().

Definition at line 536 of file CartesianMeshNumberingMng.cc.

◆ cellNodeUniqueIds() [4/4]

void Arcane::CartesianMeshNumberingMng::cellNodeUniqueIds ( Int64 cell_uid,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the nodes in a cell from its uniqueId.

The order in which the uniqueIds are placed corresponds to the enumeration order of the nodes of an Arcane cell. 3–2 ^y | | | 0–1 ->x

Parameters
cell_uidThe uniqueId of the cell.
levelThe level of the cell (and thus of the nodes).
uid[OUT] The uniqueIds of the cell. The size of the ArrayView must be equal to nbNodeByCell().

Definition at line 527 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueId() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::cellUniqueId ( CartCoord2 cell_coord,
Int32 level ) const

Method to retrieve the uniqueId of a cell from its position and level.

Parameters
cell_coordThe position of the cell.
levelThe level of the cell.
Returns
The uniqueId of the cell.

Definition at line 455 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueId() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::cellUniqueId ( CartCoord3 cell_coord,
Int32 level ) const

Method to retrieve the uniqueId of a cell from its position and level.

Parameters
cell_coordThe position of the cell.
levelThe level of the cell.
Returns
The uniqueId of the cell.

Definition at line 446 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundCell() [1/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundCell ( CartCoord2 cell_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around a cell.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 9.

Parameters
cell_coordThe position of the cell.
levelThe level of the cell at the center.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 599 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundCell() [2/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundCell ( CartCoord3 cell_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around a cell.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 27.

Parameters
cell_coordThe position of the cell.
levelThe level of the cell at the center.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 590 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundCell() [3/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundCell ( Cell cell,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around the cell passed as a parameter.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 9 in 2D and 27 in 3D.

Parameters
cellThe cell at the center.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 608 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundCell() [4/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundCell ( Int64 cell_uid,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around the cell passed as a parameter.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 9 in 2D and 27 in 3D.

Parameters
cell_uidThe uniqueId of the cell at the center.
levelThe level of the cell at the center.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 653 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundNode() [1/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundNode ( CartCoord2 node_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around a node.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 4.

Parameters
node_coordThe position of the node.
levelThe level of the node.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 626 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundNode() [2/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundNode ( CartCoord3 node_coord,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around a node.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 8.

Parameters
node_coordThe position of the node.
levelThe level of the node.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 617 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundNode() [3/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundNode ( Int64 node_uid,
Int32 level,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around the node passed as a parameter.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 4 in 2D or 8 in 3D.

Parameters
node_uidThe uniqueId of the node.
levelThe level of the node.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 635 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdsAroundNode() [4/4]

void Arcane::CartesianMeshNumberingMng::cellUniqueIdsAroundNode ( Node node,
ArrayView< Int64 > uid ) const

Method to retrieve the uniqueIds of the cells around the node passed as a parameter.

If there is no cell in a surrounding location (e.g., if we are at the edge of the mesh), a uniqueId of -1 is set.

The passed view must have a size of 4 in 2D or 8 in 3D.

Parameters
nodeThe node.
uid[OUT] The uniqueIds of the surrounding cells.

Definition at line 644 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoord() [1/2]

CartCoord3 Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoord ( Cell cell) const

Method to retrieve the coordinates of a cell.

Parameters
cellThe cell.
Returns
The position of the cell.

Definition at line 275 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoord() [2/2]

CartCoord3 Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoord ( Int64 uid,
Int32 level ) const

Method to retrieve the coordinates of a cell using its uniqueId.

Parameters
uidThe uniqueId of the cell.
levelThe level of the cell.
Returns
The position of the cell.

Definition at line 266 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoordX() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoordX ( Cell cell) const

Method to retrieve the X coordinate of a cell.

Parameters
cellThe cell.
Returns
The X position of the cell.

Definition at line 293 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoordX() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoordX ( Int64 uid,
Int32 level ) const

Method to retrieve the X coordinate of a cell using its uniqueId.

Parameters
uidThe uniqueId of the cell.
levelThe level of the cell.
Returns
The X position of the cell.

Definition at line 284 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoordY() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoordY ( Cell cell) const

Method to retrieve the Y coordinate of a cell.

Parameters
cellThe cell.
Returns
The Y position of the cell.

Definition at line 311 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoordY() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoordY ( Int64 uid,
Int32 level ) const

Method to retrieve the Y coordinate of a cell using its uniqueId.

Parameters
uidThe uniqueId of the cell.
levelThe level of the cell.
Returns
The Y position of the cell.

Definition at line 302 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoordZ() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoordZ ( Cell cell) const

Method to retrieve the Z coordinate of a cell.

Parameters
cellThe cell.
Returns
The Z position of the cell.

Definition at line 329 of file CartesianMeshNumberingMng.cc.

◆ cellUniqueIdToCoordZ() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::cellUniqueIdToCoordZ ( Int64 uid,
Int32 level ) const

Method to retrieve the Z coordinate of a cell using its uniqueId.

Parameters
uidThe uniqueId of the cell.
levelThe level of the cell.
Returns
The Z position of the cell.

Definition at line 320 of file CartesianMeshNumberingMng.cc.

◆ childCellOfCell() [1/2]

Cell Arcane::CartesianMeshNumberingMng::childCellOfCell ( Cell cell,
CartCoord2 child_coord_in_parent ) const

Method to retrieve a child cell of a parent cell based on the child cell's position within the parent cell.

Parameters
cellThe parent cell.
child_coord_in_parentThe position of the child within the parent cell.
Returns
The requested child cell.

Definition at line 716 of file CartesianMeshNumberingMng.cc.

◆ childCellOfCell() [2/2]

Cell Arcane::CartesianMeshNumberingMng::childCellOfCell ( Cell cell,
CartCoord3 child_coord_in_parent ) const

Method to retrieve a child cell of a parent cell based on the child cell's position within the parent cell.

Parameters
cellThe parent cell.
child_coord_in_parentThe position of the child within the parent cell.
Returns
The requested child cell.

Definition at line 707 of file CartesianMeshNumberingMng.cc.

◆ childCellUniqueIdOfCell() [1/3]

Int64 Arcane::CartesianMeshNumberingMng::childCellUniqueIdOfCell ( Cell cell,
CartCoord2 child_coord_in_parent ) const

Method to retrieve the uniqueId of a child cell of a parent cell based on the child cell's position within the parent cell.

Parameters
cellThe parent cell.
child_coord_in_parentThe position of the child within the parent cell.
Returns
The uniqueId of the requested child cell.

Definition at line 689 of file CartesianMeshNumberingMng.cc.

◆ childCellUniqueIdOfCell() [2/3]

Int64 Arcane::CartesianMeshNumberingMng::childCellUniqueIdOfCell ( Cell cell,
CartCoord3 child_coord_in_parent ) const

Method to retrieve the uniqueId of a child cell of a parent cell based on the child cell's position within the parent cell.

Parameters
cellThe parent cell.
child_coord_in_parentThe position of the child within the parent cell.
Returns
The uniqueId of the requested child cell.

Definition at line 680 of file CartesianMeshNumberingMng.cc.

◆ childCellUniqueIdOfCell() [3/3]

Int64 Arcane::CartesianMeshNumberingMng::childCellUniqueIdOfCell ( Cell cell,
Int32 child_index_in_parent ) const

Method to retrieve the uniqueId of a child cell of a parent cell based on the child cell's index within the parent cell.

Parameters
cellThe parent cell.
child_index_in_parentThe index of the child within the parent cell.
Returns
The uniqueId of the requested child cell.

Definition at line 698 of file CartesianMeshNumberingMng.cc.

◆ childFaceUniqueIdOfFace() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::childFaceUniqueIdOfFace ( Face face,
Int32 child_index_in_parent ) const

Method to retrieve the uniqueId of a child face of a parent face based on the child face's index within the parent face.

Parameters
faceThe parent face.
child_index_in_parentThe index of the child within the parent face.
Returns
The uniqueId of the requested child face.

Definition at line 788 of file CartesianMeshNumberingMng.cc.

◆ childFaceUniqueIdOfFace() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::childFaceUniqueIdOfFace ( Int64 uid,
Int32 level,
Int32 child_index_in_parent ) const

Method to retrieve the uniqueId of a child face of a parent face based on the child face's index within the parent face.

Parameters
uidThe uniqueId of the parent face.
levelThe level of the parent face.
child_index_in_parentThe index of the child within the parent face.
Returns
The uniqueId of the requested child face.

Definition at line 779 of file CartesianMeshNumberingMng.cc.

◆ childNodeUniqueIdOfNode() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::childNodeUniqueIdOfNode ( Int64 uid,
Int32 level ) const

Method to retrieve the uniqueId of a child node of a parent node.

Parameters
uidThe uniqueId of the child node.
levelThe level of the child node.
Returns
The uniqueId of the requested child node.

Definition at line 743 of file CartesianMeshNumberingMng.cc.

◆ childNodeUniqueIdOfNode() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::childNodeUniqueIdOfNode ( Node node) const

Method to retrieve the uniqueId of a child node of a parent node.

Parameters
nodeThe parent node.
Returns
The uniqueId of the requested child node.

Definition at line 752 of file CartesianMeshNumberingMng.cc.

◆ faceLevel()

Int32 Arcane::CartesianMeshNumberingMng::faceLevel ( Int64 uid) const

Method allowing retrieval of the level of a face given its unique ID.

Parameters
uidThe unique ID of the face.
Returns
The level of the face.

Definition at line 239 of file CartesianMeshNumberingMng.cc.

◆ faceOffsetLevelToLevel()

CartCoord Arcane::CartesianMeshNumberingMng::faceOffsetLevelToLevel ( CartCoord coord,
Int32 level_from,
Int32 level_to ) const

Method allowing retrieval of the position of the first child face starting from the position of the parent face.

Note: The coordinates used here are the coordinates of the faces in the "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
coordThe X, Y, or Z position of the parent face.
level_fromThe parent level.
level_toThe child level.
Returns
The position of the parent face's first child.

Definition at line 257 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueId() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::faceUniqueId ( CartCoord2 face_coord,
Int32 level ) const

Method to retrieve the uniqueId of a face from its position and level.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
face_coordThe position of the face.
levelThe level of the face.
Returns
The uniqueId of the face.

Definition at line 491 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueId() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::faceUniqueId ( CartCoord3 face_coord,
Int32 level ) const

Method to retrieve the uniqueId of a face from its position and level.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
face_coordThe position of the face.
levelThe level of the face.
Returns
The uniqueId of the face.

Definition at line 482 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueIdToCoordX() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::faceUniqueIdToCoordX ( Face face) const

Method to retrieve the X coordinate of a face.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
faceThe face.
Returns
The X position of the face.

Definition at line 401 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueIdToCoordX() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::faceUniqueIdToCoordX ( Int64 uid,
Int32 level ) const

Method to retrieve the X coordinate of a face using its uniqueId.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
uidThe uniqueId of the face.
levelThe level of the face.
Returns
The X position of the face.

Definition at line 392 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueIdToCoordY() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::faceUniqueIdToCoordY ( Face face) const

Method to retrieve the Y coordinate of a face.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
faceThe face.
Returns
The Y position of the face.

Definition at line 419 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueIdToCoordY() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::faceUniqueIdToCoordY ( Int64 uid,
Int32 level ) const

Method to retrieve the Y coordinate of a face using its uniqueId.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
uidThe uniqueId of the face.
levelThe level of the face.
Returns
The Y position of the face.

Definition at line 410 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueIdToCoordZ() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::faceUniqueIdToCoordZ ( Face face) const

Method to retrieve the Z coordinate of a face.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
faceThe face.
Returns
The Z position of the face.

Definition at line 437 of file CartesianMeshNumberingMng.cc.

◆ faceUniqueIdToCoordZ() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::faceUniqueIdToCoordZ ( Int64 uid,
Int32 level ) const

Method to retrieve the Z coordinate of a face using its uniqueId.

Note: The coordinates used here are the coordinates of the faces in "Cartesian view" (see globalNbFacesXCartesianView ).

Parameters
uidThe uniqueId of the face.
levelThe level of the face.
Returns
The Z position of the face.

Definition at line 428 of file CartesianMeshNumberingMng.cc.

◆ firstCellUniqueId()

Int64 Arcane::CartesianMeshNumberingMng::firstCellUniqueId ( Int32 level) const

Method allowing retrieval of the first unique ID used by the cells of a level. Calling this method with level and level+1 allows retrieval of the unique ID interval for a level.

Parameters
levelThe level.
Returns
The first UID of the cells of the level.

Definition at line 50 of file CartesianMeshNumberingMng.cc.

◆ firstFaceUniqueId()

Int64 Arcane::CartesianMeshNumberingMng::firstFaceUniqueId ( Int32 level) const

Method allowing retrieval of the first unique ID used by the faces of a level. Calling this method with level and level+1 allows retrieval of the unique ID interval for a level.

Parameters
levelThe level.
Returns
The first UID of the faces of the level.

Definition at line 68 of file CartesianMeshNumberingMng.cc.

◆ firstNodeUniqueId()

Int64 Arcane::CartesianMeshNumberingMng::firstNodeUniqueId ( Int32 level) const

Method allowing retrieval of the first unique ID used by the nodes of a level. Calling this method with level and level+1 allows retrieval of the unique ID interval for a level.

Parameters
levelThe level.
Returns
The first UID of the nodes of the level.

Definition at line 59 of file CartesianMeshNumberingMng.cc.

◆ globalNbCellsX()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbCellsX ( Int32 level) const

Method allowing retrieval of the global number of cells in X for a level.

Parameters
levelThe level.
Returns
The number of cells in X.

Definition at line 77 of file CartesianMeshNumberingMng.cc.

◆ globalNbCellsY()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbCellsY ( Int32 level) const

Method allowing retrieval of the global number of cells in Y for a level.

Parameters
levelThe level.
Returns
The number of cells in Y.

Definition at line 86 of file CartesianMeshNumberingMng.cc.

◆ globalNbCellsZ()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbCellsZ ( Int32 level) const

Method allowing retrieval of the global number of cells in Z for a level.

Parameters
levelThe level.
Returns
The number of cells in Z.

Definition at line 95 of file CartesianMeshNumberingMng.cc.

◆ globalNbFacesX()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbFacesX ( Int32 level) const

Method allowing retrieval of the global number of faces in X for a level.

Let's assume we have the following faces: ┌─0──┬──2─┐ 4│ 6│ 8│ ├─5──┼─7──┤ 9│ 11│ 13│ └─10─┴─12─┘

So, we have 2x2 cells. In X, we have 3 faces.

For the number of faces in the Cartesian view, see globalNbFacesXCartesianView.

Parameters
levelThe level.
Returns
The number of faces in X.

Definition at line 131 of file CartesianMeshNumberingMng.cc.

◆ globalNbFacesXCartesianView()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbFacesXCartesianView ( Int32 level) const

Method allowing retrieval of the size of the "Cartesian grid" view containing the faces.

In 2D, we can have this view (for a 2x2 cell mesh): x = 0 1 2 3 4 ┌──┬──┬──┬──┬──┐ y = -1 │ 0│ │ 2│ │ 4│ ┌──┬──┬──┬──┬──┐ y │ │ 1│ │ 3│ │ ├──┼──┼──┼──┼──┤ y = 1 │ 5│ │ 7│ │ 9│ ├──┼──┼──┼──┼──┤ y = 2 │ │ 6│ │ 8│ │ ├──┼──┼──┼──┼──┤ y = 3 │10│ │12│ │14│ ├──┼──┼──┼──┼──┤ y = 4 │ │11│ │13│ │ └──┴──┴──┴──┴──┘ (in this view, the cells are located at odd X and Y (so here, [1, 1], [3, 1], [1, 3] and [3, 3])).

Note
In 2D, it is considered that we have an imaginary level y=-1.
Warning
To start the numbering at 0, in methods returning a 2D face unique ID, we use FaceUID-1.

And in 3D (for a 2x2x2 cell mesh): z │ z = 1 │ z = 2 │ z = 3 │ z = 4 x = 0 1 2 3 4 │ 0 1 2 3 4 │ 0 1 2 3 4 │ 0 1 2 3 4 │ 0 1 2 3 4 ┌──┬──┬──┬──┬──┐ │ ┌──┬──┬──┬──┬──┐ │ ┌──┬──┬──┬──┬──┐ │ ┌──┬──┬──┬──┬──┐ │ ┌──┬──┬──┬──┬──┐ y │ │ │ │ │ │ │ │ │24│ │25│ │ │ │ │ │ │ │ │ │ │ │30│ │31│ │ │ │ │ │ │ │ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ y = 1 │ │ 0│ │ 1│ │ │ │12│ │13│ │14│ │ │ │ 4│ │ 5│ │ │ │18│ │19│ │20│ │ │ │ 8│ │ 9│ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ y = 2 │ │ │ │ │ │ │ │ │26│ │27│ │ │ │ │ │ │ │ │ │ │ │32│ │33│ │ │ │ │ │ │ │ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ y = 3 │ │ 2│ │ 3│ │ │ │15│ │16│ │17│ │ │ │ 6│ │ 7│ │ │ │21│ │22│ │23│ │ │ │10│ │11│ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ │ ├──┼──┼──┼──┼──┤ y = 4 │ │ │ │ │ │ │ │ │28│ │29│ │ │ │ │ │ │ │ │ │ │ │34│ │35│ │ │ │ │ │ │ │ │ └──┴──┴──┴──┴──┘ │ └──┴──┴──┴──┴──┘ │ └──┴──┴──┴──┴──┘ │ └──┴──┴──┴──┴──┘ │ └──┴──┴──┴──┴──┘ │ │ │ │

(in this view, the cells are located at odd X, Y, and Z (so here, [1, 1, 1], [3, 1, 1], [1, 3, 1], &c)).

Parameters
levelThe level.
Returns
The size of the grid in X.

Definition at line 158 of file CartesianMeshNumberingMng.cc.

◆ globalNbFacesY()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbFacesY ( Int32 level) const

Method allowing retrieval of the global number of faces in Y for a level.

Let's assume we have the following faces: ┌─0──┬──2─┐ 4│ 6│ 8│ ├─5──┼─7──┤ 9│ 11│ 13│ └─10─┴─12─┘

So, we have 2x2 cells. In Y, we have 3 faces.

For the number of faces in the Cartesian view, see globalNbFacesYCartesianView.

Parameters
levelThe level.
Returns
The number of faces in Y.

Definition at line 140 of file CartesianMeshNumberingMng.cc.

◆ globalNbFacesYCartesianView()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbFacesYCartesianView ( Int32 level) const

Method allowing retrieval of the size of the "Cartesian grid" view containing the faces.

An example of this view is available in the documentation of globalNbFacesXCartesianView.

Parameters
levelThe level.
Returns
The size of the grid in Y.

Definition at line 167 of file CartesianMeshNumberingMng.cc.

◆ globalNbFacesZ()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbFacesZ ( Int32 level) const

Method allowing retrieval of the global number of faces in Z for a level.

Let's assume we have the following faces: ┌─0──┬──2─┐ 4│ 6│ 8│ ├─5──┼─7──┤ 9│ 11│ 13│ └─10─┴─12─┘

If we have 2x2x2 cells, we will have 3 faces in Z.

For the number of faces in the Cartesian view, see globalNbFacesZCartesianView.

Parameters
levelThe level.
Returns
The number of faces in Z.

Definition at line 149 of file CartesianMeshNumberingMng.cc.

◆ globalNbFacesZCartesianView()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbFacesZCartesianView ( Int32 level) const

Method allowing retrieval of the size of the "Cartesian grid" view containing the faces.

An example of this view is available in the documentation of globalNbFacesXCartesianView.

Parameters
levelThe level.
Returns
The size of the grid in Z.

Definition at line 176 of file CartesianMeshNumberingMng.cc.

◆ globalNbNodesX()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbNodesX ( Int32 level) const

Method allowing retrieval of the global number of nodes in X for a level.

Parameters
levelThe level.
Returns
The number of nodes in X.

Definition at line 104 of file CartesianMeshNumberingMng.cc.

◆ globalNbNodesY()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbNodesY ( Int32 level) const

Method allowing retrieval of the global number of nodes in Y for a level.

Parameters
levelThe level.
Returns
The number of nodes in Y.

Definition at line 113 of file CartesianMeshNumberingMng.cc.

◆ globalNbNodesZ()

CartCoord Arcane::CartesianMeshNumberingMng::globalNbNodesZ ( Int32 level) const

Method allowing retrieval of the global number of nodes in Z for a level.

Parameters
levelThe level.
Returns
The number of nodes in Z.

Definition at line 122 of file CartesianMeshNumberingMng.cc.

◆ nbCellInLevel()

Int64 Arcane::CartesianMeshNumberingMng::nbCellInLevel ( Int32 level) const

Method allowing retrieval of the total number of cells in a level.

Parameters
levelThe level.
Returns
The number of cells in the level.

Definition at line 185 of file CartesianMeshNumberingMng.cc.

◆ nbFaceByCell()

Int32 Arcane::CartesianMeshNumberingMng::nbFaceByCell ( ) const

Method to retrieve the number of faces in a cell.

Returns
The number of faces in a cell.

Definition at line 545 of file CartesianMeshNumberingMng.cc.

◆ nbFaceInLevel()

Int64 Arcane::CartesianMeshNumberingMng::nbFaceInLevel ( Int32 level) const

Method allowing retrieval of the total number of faces in a level.

Parameters
levelThe level.
Returns
The number of faces in the level.

Definition at line 203 of file CartesianMeshNumberingMng.cc.

◆ nbNodeByCell()

Int32 Arcane::CartesianMeshNumberingMng::nbNodeByCell ( ) const

Method to retrieve the number of nodes in a cell.

Returns
The number of nodes in a cell.

Definition at line 500 of file CartesianMeshNumberingMng.cc.

◆ nbNodeInLevel()

Int64 Arcane::CartesianMeshNumberingMng::nbNodeInLevel ( Int32 level) const

Method allowing retrieval of the total number of nodes in a level.

Parameters
levelThe level.
Returns
The number of nodes in the level.

Definition at line 194 of file CartesianMeshNumberingMng.cc.

◆ nodeLevel()

Int32 Arcane::CartesianMeshNumberingMng::nodeLevel ( Int64 uid) const

Method allowing retrieval of the level of a node given its unique ID.

Parameters
uidThe unique ID of the node.
Returns
The level of the node.

Definition at line 230 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueId() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::nodeUniqueId ( CartCoord2 node_coord,
Int32 level ) const

Method to retrieve the uniqueId of a node from its position and level.

Parameters
node_coordThe position of the node.
levelThe level of the node.
Returns
The uniqueId of the node.

Definition at line 473 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueId() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::nodeUniqueId ( CartCoord3 node_coord,
Int32 level ) const

Method to retrieve the uniqueId of a node from its position and level.

Parameters
node_coordThe position of the node.
levelThe level of the node.
Returns
The uniqueId of the node.

Definition at line 464 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueIdToCoordX() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::nodeUniqueIdToCoordX ( Int64 uid,
Int32 level ) const

Method to retrieve the X coordinate of a node using its uniqueId.

Parameters
uidThe uniqueId of the node.
levelThe level of the node.
Returns
The X position of the node.

Definition at line 338 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueIdToCoordX() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::nodeUniqueIdToCoordX ( Node node) const

Method to retrieve the X coordinate of a node.

Parameters
nodeThe node.
Returns
The X position of the node.

Definition at line 347 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueIdToCoordY() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::nodeUniqueIdToCoordY ( Int64 uid,
Int32 level ) const

Method to retrieve the Y coordinate of a node using its uniqueId.

Parameters
uidThe uniqueId of the node.
levelThe level of the node.
Returns
The Y position of the node.

Definition at line 356 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueIdToCoordY() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::nodeUniqueIdToCoordY ( Node node) const

Method to retrieve the Y coordinate of a node.

Parameters
nodeThe node.
Returns
The Y position of the node.

Definition at line 365 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueIdToCoordZ() [1/2]

CartCoord Arcane::CartesianMeshNumberingMng::nodeUniqueIdToCoordZ ( Int64 uid,
Int32 level ) const

Method to retrieve the Z coordinate of a node using its uniqueId.

Parameters
uidThe uniqueId of the node.
levelThe level of the node.
Returns
The Z position of the node.

Definition at line 374 of file CartesianMeshNumberingMng.cc.

◆ nodeUniqueIdToCoordZ() [2/2]

CartCoord Arcane::CartesianMeshNumberingMng::nodeUniqueIdToCoordZ ( Node node) const

Method to retrieve the Z coordinate of a node.

Parameters
nodeThe node.
Returns
The Z position of the node.

Definition at line 383 of file CartesianMeshNumberingMng.cc.

◆ offsetLevelToLevel()

CartCoord Arcane::CartesianMeshNumberingMng::offsetLevelToLevel ( CartCoord coord,
Int32 level_from,
Int32 level_to ) const

Method allowing retrieval of the position of the first child node/cell starting from the position of the parent node/cell.

Example: if we have a 2D mesh of 2*2 cells and a refinement pattern of 2, we know that the level 1 grid (for level 1 patches) will be 4*4 cells. The first child node/cell of the parent node/cell (Xp=1,Yp=0) will have the position Xf=Xp*Pattern=2 (same for Y).

Parameters
coordThe X, Y, or Z position of the parent node/cell.
level_fromThe parent level.
level_toThe child level.
Returns
The position of the first child of the parent node/cell.

Definition at line 248 of file CartesianMeshNumberingMng.cc.

◆ parentCellUniqueIdOfCell() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::parentCellUniqueIdOfCell ( Cell cell,
bool do_fatal = true ) const

Method to retrieve the uniqueId of a cell's parent.

If do_fatal is true, a fatal error is generated if the parent does not exist; otherwise, the returned uniqueId has the value NULL_ITEM_UNIQUE_ID.

Parameters
cellThe child cell.
Returns
The uniqueId of the parent cell of the cell passed as a parameter.

Definition at line 671 of file CartesianMeshNumberingMng.cc.

◆ parentCellUniqueIdOfCell() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::parentCellUniqueIdOfCell ( Int64 uid,
Int32 level,
bool do_fatal = true ) const

Method to retrieve the uniqueId of a cell's parent.

If do_fatal is true, a fatal error is generated if the parent does not exist; otherwise, the returned uniqueId has the value NULL_ITEM_UNIQUE_ID.

Parameters
uidThe uniqueId of the child cell.
levelThe level of the child cell.
Returns
The uniqueId of the parent cell of the cell passed as a parameter.

Definition at line 662 of file CartesianMeshNumberingMng.cc.

◆ parentFaceUniqueIdOfFace() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::parentFaceUniqueIdOfFace ( Face face,
bool do_fatal = true ) const

Method to retrieve the uniqueId of a face's parent.

If do_fatal is true, a fatal error is generated if the parent does not exist; otherwise, the returned uniqueId has the value NULL_ITEM_UNIQUE_ID.

Parameters
faceThe child face.
Returns
The uniqueId of the parent face of the face passed as a parameter.

Definition at line 770 of file CartesianMeshNumberingMng.cc.

◆ parentFaceUniqueIdOfFace() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::parentFaceUniqueIdOfFace ( Int64 uid,
Int32 level,
bool do_fatal = true ) const

Method to retrieve the uniqueId of a face's parent.

If do_fatal is true, a fatal error is generated if the parent does not exist; otherwise, the returned uniqueId has the value NULL_ITEM_UNIQUE_ID.

Parameters
uidThe uniqueId of the child face.
levelThe level of the child face.
Returns
The uniqueId of the parent face of the child face.

Definition at line 761 of file CartesianMeshNumberingMng.cc.

◆ parentNodeUniqueIdOfNode() [1/2]

Int64 Arcane::CartesianMeshNumberingMng::parentNodeUniqueIdOfNode ( Int64 uid,
Int32 level,
bool do_fatal = true ) const

Method to retrieve the uniqueId of a node's parent.

If do_fatal is true, a fatal error is generated if the parent does not exist; otherwise, the returned uniqueId has the value NULL_ITEM_UNIQUE_ID.

Parameters
uidThe uniqueId of the child node.
levelThe level of the child node.
Returns
The uniqueId of the parent node of the child node.

Definition at line 725 of file CartesianMeshNumberingMng.cc.

◆ parentNodeUniqueIdOfNode() [2/2]

Int64 Arcane::CartesianMeshNumberingMng::parentNodeUniqueIdOfNode ( Node node,
bool do_fatal = true ) const

Method to retrieve the uniqueId of a node's parent.

If do_fatal is true, a fatal error is generated if the parent does not exist; otherwise, the returned uniqueId has the value NULL_ITEM_UNIQUE_ID.

Parameters
nodeThe child node.
Returns
The uniqueId of the parent node of the node passed as a parameter.

Definition at line 734 of file CartesianMeshNumberingMng.cc.

◆ pattern()

Int32 Arcane::CartesianMeshNumberingMng::pattern ( ) const

Method allowing retrieval of the refinement pattern used in each cell. For example, if the pattern is 2, each parent cell will have 2*2 child cells (2*2*2 in 3D).

Returns
The refinement pattern.

Definition at line 212 of file CartesianMeshNumberingMng.cc.

◆ printStatus()

void Arcane::CartesianMeshNumberingMng::printStatus ( ) const

Method allowing the description of the object's state.

Definition at line 41 of file CartesianMeshNumberingMng.cc.


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